Difference between revisions of "Hornbill Automation"
Jump to navigation
Jump to search
| (8 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | This document can now be found at its new location in the [https://docs.hornbill.com/servicemanager-config/customize/workflows/automation-overview Hornbill Document Library]. | ||
| + | |||
| + | [[file:hornbill-document-library.png|Hornbill Automation Overview|link=https://docs.hornbill.com/servicemanager-config/customize/workflows/automation-overview]] | ||
| + | <!-- | ||
| + | |||
| + | |||
| + | {{breadcrumb|[[Main Page|Home]] > [[Configuration]] > [[Business Processes]] > [[Business Process Designer]]|Configuration}} | ||
== Introduction == | == Introduction == | ||
A Hornbill Automation is a definable automated task that will occur within the workflow. The available Hornbill Automations are provided by each application that utilizes Business Process Workflows. | A Hornbill Automation is a definable automated task that will occur within the workflow. The available Hornbill Automations are provided by each application that utilizes Business Process Workflows. | ||
| Line 6: | Line 13: | ||
{{bullet1|Add after existing node|Drag an arrow from an existing workflow node. When you let go of the mouse button, you are presented with a list of nodes that you can select from. Select Hornbill Automation}} | {{bullet1|Add after existing node|Drag an arrow from an existing workflow node. When you let go of the mouse button, you are presented with a list of nodes that you can select from. Select Hornbill Automation}} | ||
| − | {{bullet1|Add between existing nodes|Click on an arrow between two existing nodes. Once the arrow is selected, right click on the arrow and select Add node between connected nodes. Select Hornbill Automation from the list of available nodes. | + | {{bullet1|Add between existing nodes|Click on an arrow between two existing nodes. Once the arrow is selected, right-click on the arrow and select Add node between connected nodes. Select Hornbill Automation from the list of available nodes.}} |
Hornbill Automations can be easily identified in a workflow as a light blue rectangular node. | Hornbill Automations can be easily identified in a workflow as a light blue rectangular node. | ||
| − | + | <br> | |
==Properties== | ==Properties== | ||
| − | The properties of a Hornbill Automation can be accessed by either hovering the mouse pointer over the node and then clicking on the cog icon or you can simply double click on the node. | + | The properties of a Hornbill Automation can be accessed by either hovering the mouse pointer over the node and then clicking on the cog icon or you can simply double-click on the node. |
{{bullet1|Language|This will default to the language of the user that is adding the node. After the node has been added, you may consider adding translations for other languages by selecting a language from this list.}} | {{bullet1|Language|This will default to the language of the user that is adding the node. After the node has been added, you may consider adding translations for other languages by selecting a language from this list.}} | ||
| − | {{bullet1|Display|This is the name of the node that will be displayed in the node when viewing the workflow. This is also displayed when using the variable picker. The display should easily identify the node and its purpose. | + | {{bullet1|Display|This is the name of the node that will be displayed in the node when viewing the workflow. This is also displayed when using the variable picker. The display should easily identify the node and its purpose.}} |
===Process=== | ===Process=== | ||
| Line 37: | Line 44: | ||
{{bullet1|Mandatory|Options that are mandatory display a vertical red bar on the left-hand side.}} | {{bullet1|Mandatory|Options that are mandatory display a vertical red bar on the left-hand side.}} | ||
| − | {{bullet1|Information|Each option has an information icon where you can read some basic information about that option. Additional information can be found in the help by clicking on the ? icon. | + | {{bullet1|Information|Each option has an information icon where you can read some basic information about that option. Additional information can be found in the help by clicking on the ? icon.}} |
| − | {{bullet1|Auto/Manual/Variable/Ignore|Each option allows you to select how it will be populated. | + | {{bullet1|Auto/Manual/Variable/Ignore|Each option allows you to select how it will be populated.}} |
{{bullet2|Auto|This will use a default value for the option. Not all options have a default value and you will have to refer to the documentation for each individual automation to confirm if this can be used.}} | {{bullet2|Auto|This will use a default value for the option. Not all options have a default value and you will have to refer to the documentation for each individual automation to confirm if this can be used.}} | ||
{{bullet2|Manual|Use this to manually type in the text or select from a drop-down box if provided.}} | {{bullet2|Manual|Use this to manually type in the text or select from a drop-down box if provided.}} | ||
| − | {{bullet2|Variable|Use this to allow for the use of a variable | + | {{bullet2|Variable|Use this to allow for the use of a variable that can be selected using the Variable Picker.}} |
| − | {{bullet2|Ignore|This is only available when an option is not mandatory. | + | {{bullet2|Ignore|This is only available when an option is not mandatory. This ensures that no value is used with this option when the automation is run. Non-mandatory options will default to Ignore.}} |
===Set Stage Checkpoints=== | ===Set Stage Checkpoints=== | ||
You can select one or more checkpoints to be set when this node is reached. | You can select one or more checkpoints to be set when this node is reached. | ||
| − | ===Output Params / Context Reference== | + | ===Output Params / Context Reference=== |
| − | + | Hornbill Automation nodes provide output parameters which can be accessed through [[Variable Picker|Variable Picker]] or [[Custom Expression Builder|Decision]] node in a Business Process. The value in '''Result Reference''' of a node is appended to the reference of each output parameter. | |
| + | [[File:output-params.png|400px]] | ||
| + | |||
| + | [[Category:Configuration]] | ||
| − | |||
| − | |||
| − | + | HDOC reference - /bpm-workflow/hornbill-automation | |
=== Result Reference === | === Result Reference === | ||
| Line 67: | Line 75: | ||
=== Output Params / Context Variable === | === Output Params / Context Variable === | ||
| − | |||
| − | |||
| − | |||
--> | --> | ||
| + | [[Category:HDOC]] | ||
Latest revision as of 21:58, 23 May 2024
This document can now be found at its new location in the Hornbill Document Library.
