Difference between revisions of "IT Automation"

Latest revision as of 14:43, 15 December 2020

Home > Administration > ITOM > [[{{{1}}}]] > IT Automation

Introduction

The IT Automation node is used to execute an ITOM package operation in a similar way to that of creating an IT Automation Job. Each time the node is used, a new Job will appear in the Job queue where it can be monitored/managed in the same manner as other ITOM jobs.

Adding the IT Automation Node

From an existing Node within a Business Process

Place the mouse pointer over the node to expose the connection arrows.
From a connection arrow, drag out a new connection line
Select IT Automation

From a Connection Line between to nodes

Select the Connection Line and Right Click
Select Add node between connected nodes from the context menu
Select IT Automation

IT Automation nodes are displayed in Tan; to help differentiate from other node types.

Configuration

Two options are available to expose the properties of the IT Automation process node, place the mouse pointer over the node to expose the Cog icon and click on this icon or double click anywhere on the node.

IT Automation

Language

Select the language to work in, this defaults to the language set in the user's profile. If other users require viewing the workflow in a different language, translations can be provided by selecting the language and entering the appropriate translations.

Display

Provide the node with a display name that will appear on the business process design canvas

Description

Optional text area that can be used to provide a description detailing the node's function

Job Request

Package

Package used to provide the IT Automation payload

Run Operation

Operation to perform using the package

Site Target

Specify the SIS Server or Group that will facilitate the Automation Job

Target Device

Select the Device(s) that the Operation will target

List

Target Devivces are sourced from a pre-created Inventory List

Inventory

Select a Device from the ITOM Inventory

Manual

Manually entered device name, that must already exist in the ITOM Inventory and is marked as a Managed device

Credentials

Sourced from the KeySafe, provides the security context to be used for package deployment and execution

Admin Credentials

Security Context used to deploy the package onto the target device(s)

Run As Credentials

Security Context used to execute the package on the target device(s) (if not provided then Admin Credentials are used)

Extra Credentials

Optional credentials used as part of the functionality within the package

Operation Parameters

Once a package and a Run Operation has been selected, any related parameters will be displayed; mandatory fields are highlighted and hints may be provided in the input box.

Result Reference

A variable that refers to an object that enables access to the output parameters returned by a node anywhere within a process. Each node can be given a unique variable name allowing for the output of multiple nodes to be accessed. Where a unique name is not given, the output from the current node will overwrite all output from a previously executed node with the same result reference variable.

Continue on Error

When this option set to No (default), the business process will not continue if the IT Automation fails. Setting the option to Yes enables the business process to continue execution after the failed IT Automation node.

@@ Line 1: / Line 1: @@
-{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT Operations Management|ITOM]] > [[Runbooks]] > IT Automation|[[:Category:ITOM|Index]]}}
+{{bluebanner|[[Main_Page|Home]] > [[Administration]] > [[IT Operations Management|ITOM]] > [[{{{1}}}]] > IT Automation |[[:Category:ITOM|Index]]}}
 {|style="width: 100%"
 |- valign="top"
@@ Line 18: / Line 19: @@
 ==Adding the IT Automation Node==
-[[File:BPMITAutomationNode.png|right]]
+[[File:BPMITAutomationNode.png|right|350px|link=https://wiki.hornbill.com/images/9/94/BPMITAutomationNode.png]]
 * From an existing Node within a Business Process
 :# Place the mouse pointer over the node to expose the connection arrows.
@@ Line 28: / Line 29: @@
 :# Select ''IT Automation''
-{{infobox|IT Automation Nodes are displayed in Tan; to help differentiate from other node types.}}
+{{infobox|IT Automation nodes are displayed in Tan; to help differentiate from other node types.}}
 <br>
 ==Configuration ==
-[[File:HornbillCloudProperties.png|right|350px|link=https://wiki.hornbill.com/images/d/d8/HornbillCloudProperties.png]]
+<!-- [[File:ITAutomationPropertiesBlur.png|right|350px|link=https://wiki.hornbill.com/images/b/bc/ITAutomationProperties.png]] -->
-Two options are available to expose the properties of the Hornbill Cloud Automation Node. You can either place your mouse pointer over the Cloud Automation node to expose the '''Cog''' icon and click on this icon or double click anywhere on the Could Automation Node.
+Two options are available to expose the properties of the IT Automation process node,  place the mouse pointer over the node to expose the '''Cog''' icon and click on this icon or double click anywhere on the node.
-=== Cloud Automation ===
-{{Bullet1|Language|Select the language that you want to work in.  This will default to the language set in your profile.  If you have other users that will be viewing the workflow that operate in a different language, you may want to provide translations for them by selecting their language and providing the appropriate translations.}}
-{{Bullet1|Display|Give the Cloud Automation node a display name for how it will appear on the business process design canvas}}
-<br>
-=== Request ===
-[[File:Integration-Call-3.png|right|350px|link=https://wiki.hornbill.com/images/b/b6/Integration-Call-3.png]]
-{{Bullet1|Connector|This drop down list displays the list of available connectors. By default the ''Hornbill Integration Bridge'' connector will be available. If you have configured any Business Process Connectors using ''Microsoft Orchestrator'' or ''HP Operations Orchestration'', these will also be available.}}
-{{Bullet1|Method|Clicking on the edit icon allows you to browse the content catalog for the selected ''Connector''.  Click and expand each item to see the available ''Methods'' and then select the ''Method'' that you would like to use}}
-{{Bullet1|Result Reference|If you are using multiple '''Cloud Automation''' Nodes in your business process, it is good practice to give each Cloud Automation Node a unique '''Result Reference'''. With each Method having the ability to return '''Output''' parameters such as an ID, Reference number etc you may want to use these ''Output'' parameters in other business process nodes, and they will be identified in your variable picker by their '''Result Reference''' name.If a unique name is not given, every result reference option in the variable picker will be represented with the default '''Integration''' name.}}
-{{Bullet1|Continue on Error|By default this is set to ''No'' and the business process will not continue if the Cloud Automation fails. Change this to ''Yes'' if you wish the business process to continue even if the Cloud Automation fails.}}
-===Request Credentials===
-[[File:Integration-Call-4.png|right|350px|link=https://wiki.hornbill.com/images/2/27/Integration-Call-4.png]]
-If using the ''Hornbill Integration Bridge'', once a method has been selected you will need to select a credential from the Request Credentials list.
-:* The available credentials are populated via [[Hornbill KeySafe | KeySafe]] , the list is filtered based on the Authentication '''Type''' required by the Integration method.
-:* If the list is empty the '''type''' of credential is shown by hovering the mouse over the '''i''' against the credential.  You can go to '''[[Hornbill_KeySafe|KeySafe]]''' and create a set of credentials for the '''type''' of method you are trying to use.
-:'''Examples'''
+=== IT Automation ===
+{{Bullet1|Language|Select the language to work in, this defaults to the language set in the user's profile.  If other users require viewing the workflow in a different language, translations can be provided by selecting the language and entering the appropriate translations.}}
-:* You would need to define in '''[[Hornbill_KeySafe|KeySafe]]''' the Twitter account credentials you want to tweet from, or the ServiceNow instance you want to create an Incident on, and which user account you want to create the Incident in the context of.
+{{Bullet1|Display|Provide the node with a display name that will appear on the business process design canvas}}
-:* You can create multiple set's of credentials for the same Methods, for example if you wanted to tweet from different Twitter Accounts, you can create different request credentials for each Twitter account in '''KeySafe''' and then select which one to use from the '''Request Credentials''' for the Twitter Methods in each Cloud Automation node you configure.
+{{Bullet1|Description|Optional text area that can be used to provide a description detailing the node's function}}
-===Parameters===
-Each Method will have a set of specific request parameters (Inputs).  These are the inputs which you can pass to the solution you are integrating too.
-:* Request Parameters marked with the red Mandatory marker must be populated
-:* You can use the '''Variable Picker''' on request parameter fields to pass in variable values from request attributes such as Progressive Capture Answers, Custom Field Values, Task Outcomes, Request Service, Customer attributes.
-:* Depending on the method chosen, the request parameter fields may contain '''Data Provider''' values from the solution you are integrating too, for example in ServiceNow LogIncident, the actual '''State''', '''Impact''', '''Urgency''' values from the ServiceNow Instance specified in the chosen '''Request Credentials''' will be available to you to choose from.
-===Response Parameters===
-Most methods will return Response Parameters (Outputs) once they complete.  You may wish to use these later or further down your business process.  For example if you chose to create a new '''Board''' using the '''Trello''' '''CreateBoard''' method, one of the response parameters will be the newly created boards id. This id can then be used as a request(input) parameter for another Cloud Automation,  or example if you wanted to add a '''List''' or '''Card''' to the '''Trello''' Board.
-:* The Response Parameters will be available to use from the '''Variable Picker''' and will be listed under each '''Result Reference''' name.
 <br>
-==Documentation==
+=== Job Request ===
+{{Template:IT Automation Job Properties}}
-Click on the [[File:documentation.png]] icon to view information relating to the input and output parameters for the method.
+{{Bullet1|Result Reference|A variable that refers to an object that enables access to the output parameters returned by a node anywhere within a process.  Each node can be given a unique variable name allowing for the output of multiple nodes to be accessed.  Where a unique name is not given, the output from the current node will overwrite all output from a previously executed node with the same result reference variable.}}
+{{Bullet1|Continue on Error|When this option set to ''No'' (default), the business process will not continue if the IT Automation fails.  Setting the option to ''Yes'' enables the business process to continue execution after the failed IT Automation node.}}
-More information is also available on each solution via the [[Hornbill_iBridge|iBridge]] page
 [[Category:Integration]]