Difference between revisions of "Cloud Automation"

Latest revision as of 20:47, 7 April 2020

Home > Integration > Business Process Automation & Orchestration > Cloud Automation

Introduction

The Cloud Automation node can be invoked from the business process designer and is used to call either iBridge automations, HP Operations Orchestration Flows. or Microsoft Orchestrator Runbooks

Adding the Cloud Automation Node

From an existing Node within your workflow, place your mouse pointer over this node to expose the connection arrows.
From a connection arrow, drag out a new connection line
Release you left mouse button to display the Node Selection menu
Select Cloud Automation

Cloud Automation Nodes are displayed in yellow to help differentiate these from other node types.

Configuration

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.

Cloud Automation

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.

Display

Give the Cloud Automation node a display name for how it will appear on the business process design canvas

Request

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.

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

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.

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

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 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 KeySafe and create a set of credentials for the type of method you are trying to use.

Examples

You would need to define in 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.
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.

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.

Documentation

Click on the icon to view information relating to the input and output parameters for the method.

More information is also available on each solution via the iBridge page

@@ Line 1: / Line 1: @@
-{{bluebanner|[[Main Page|Home]] > [[Integration]] > [[Business Process Automation & Orchestration]] > Cloud Automation|[[:Category:Integration}}
+{{bluebanner|[[Main Page|Home]] > [[Integration]] > [[Business Process Automation & Orchestration]] > Cloud Automation|[[:Category:Integration|Index]]}}
 {|style="width: 100%"
 |- valign="top"
@@ Line 18: / Line 18: @@
 |}
-==Using the Cloud Automation Node==
+==Adding the Cloud Automation Node==
 [[File:Bpmnodelist1.png|right|link=https://wiki.hornbill.com/images/4/4d/BPMNodeList2.png]]
-===Adding a Cloud Automation Node===
 :# From an existing Node within your workflow, place your mouse pointer over this node to expose the connection arrows.
 :# From a connection arrow, drag out a new connection line
@@ Line 26: / Line 25: @@
 :# Select ''Cloud Automation''
-Cloud Automation Nodes displayed in yellow to help differentiate these from other node types.
+{{infobox|Cloud Automation Nodes are displayed in yellow to help differentiate these from other node types.}}
-===Configuration ===
-:* Click on the '''Cog''' icon to open the configuration options
-:* '''Display''' - Give the Cloud Automation a display name for how it will appear on the business process design canvas
 <br>
+==Configuration ==
+[[File:HornbillCloudProperties.png|right|350px|link=https://wiki.hornbill.com/images/d/d8/HornbillCloudProperties.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.
-===Connector===
+=== Cloud Automation ===
-[[File:HornbillCloudProperties.png|right|350px|link=https://wiki.hornbill.com/images/d/d8/HornbillCloudProperties.png]]
+{{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.}}
-By Default the '''Hornbill Integration Bridge''' connector will be present.
+{{Bullet1|Display|Give the Cloud Automation node a display name for how it will appear on the business process design canvas}}
-* If you have configured any Business Process Connectors using '''Microsoft Orchestrator''' or '''HP Operations Orchestration''', these will also be available from the drop down.
-* Select the connector you wish to use
-<br>
-<br>
-<br>
 <br>
-===Method===
+=== Request ===
 [[File:Integration-Call-3.png|right|350px|link=https://wiki.hornbill.com/images/b/b6/Integration-Call-3.png]]
-* Clicking the ellipsis on '''Method''' allows you to browse the content catalogue for the given '''Integration Connector''', and then to select a method to use within your Business Process.
+{{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.}}
-* In the example shown the content catalogue of the '''Hornbill Integration Bridge''' is listed.
+{{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}}
-:* Click to expand each solution, to see the available '''Methods''' for each solution
+{{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.}}
-:* Select the '''Method''' you wish to use
-* '''Result Reference''' - Where you are using multiple '''Cloud Automation''' Nodes in your business process, it is good practise to give each Cloud Automation and '''Result Reference''' a unique name.  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.
+{{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.}}
-:* If a unique name is not given, every result reference option in the variable picker will be represented with the default '''Integration''' name.
-* '''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.
+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'''
+:'''Examples'''
-* 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.
+:* 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.
-* 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.
+:* 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.
 ===Parameters===
-[[File:Integration-Call-4.png|right|350px|link=https://wiki.hornbill.com/images/2/27/Integration-Call-4.png]]
 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
+:* 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.
+:* 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.
+:* 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.
+:* The Response Parameters will be available to use from the '''Variable Picker''' and will be listed under each '''Result Reference''' name.
+<br>
-===Documentation===
+==Documentation==
 Click on the [[File:documentation.png]] icon to view information relating to the input and output parameters for the method.