The workflow editor presents the workflow schema elements in menus on the Schema tab. You can use the schema elements available in the Schema tab to build a workflow.
Generic Schema Elements
Element | Description | Icon |
---|---|---|
Start | The starting point of the workflow. All workflows contain this element. Always present on the Schema tab. A workflow can have only one start element. Start elements have one output and no input, and cannot be removed from the workflow schema. | |
Scriptable task | General-purpose tasks you define. You write JavaScript functions in this element. | |
Decision | A boolean function. Decision elements take one input parameter and return either true or false. The type of decision that the element makes depends on the type of the input parameter. Decision elements let the workflow branch into different directions, depending on the input parameter the decision element receives. If the received input parameter corresponds to an expected value, the workflow continues along a certain route. If the input is not the expected value, the workflow continues on an alternative path. | |
Decision activity | A boolean function. A decision activity runs a workflow and binds its output parameters to a true or a false path. | |
User interaction | Lets users pass new input parameters to the workflow. You can design how the user interaction element presents the request for input parameters and place constraints on the parameters that users can provide. When a running workflow arrives at a user interaction element, it enters a passive state and prompts the user for input. You can set a timeout period within which the users must provide input. The workflow resumes according to the data the user passes to it, or returns an exception if the timeout period expires. While it is waiting for the user to respond, the workflow token is in the waiting state. | |
Waiting timer | Used by long-running workflows. When a running workflow arrives at a Waiting Timer element, it enters a passive state. You set an absolute date at which the workflow resumes running. While it is waiting for the date, the workflow token is in the waiting-signal state. | |
Waiting event | Used in long-running workflows. When a running workflow arrives at a Waiting Event element, it enters a passive state. You define a trigger event that the workflow awaits before it resumes running. While it is waiting for the event, the workflow token is in the waiting-signal state. | |
End workflow | The end point of a workflow. You can have multiple end elements in a schema, to represent the various possible outcomes of the workflow. End elements have one input with no output. When a workflow reaches an End Workflow element, the workflow token enters the completed state. | |
Thrown exception | Creates an exception and stops the workflow. Multiple occurrences of this element can be present in the workflow schema. Exception elements have one input parameter, which can only be of the String type, and have no output parameter. When a workflow reaches an Exception element, the workflow token enters the failed state. | |
Workflow note | Lets you annotate sections of the workflow. You can stretch notes to delineate sections of the workflow. You can change the background color of the notes to differentiate workflow zones. Workflow notes provide only visual information, to help you understand the schema. | |
Action element | Calls on an action from the Orchestrator libraries of actions. When a workflow reaches an action element, it calls and runs that action. | |
Workflow element | Starts another workflow synchronously. When a workflow reaches a Workflow element in its schema, it runs that workflow as part of its own process. The original workflow continues only after the called workflow completes its run. | |
Foreach element | Runs a workflow on every element from an array. For example, you can run the Rename Virtual Machine workflow on all virtual machines from a folder. | |
Asynchronous workflow | Starts a workflow asynchronously. When a workflow reaches an asynchronous workflow element, it starts that workflow and continues its own run. The original workflow does not wait for the called workflow to complete. | |
Schedule workflow | Creates a task to run the workflow at a set time, and then the workflow continues its run. | |
Nested workflows | Starts several workflows simultaneously. You can decide to nest local workflows and remote workflows that are in a different Orchestrator server. You can also run workflows with different credentials. The workflow waits for all the nested workflows to complete before continuing its run. | |
Default error handler | Handles workflow errors that are not caught by standard error handlers. You can use any available schema elements to handle errors. | |
Switch | Switches to alternative workflow paths, based on a workflow variable or parameter. | |
Pre-Defined Task Schema Elements
Menu | Elements |
---|---|
Basic |
|
Log |
|
Network |
|
Schema Element Properties
Schema elements have properties that you define and edit in the Schema tab of the workflow palette. You access the properties of a schema element by clicking an element that you have dragged into the workflow schema. The properties of the element appear in tabs on the right-hand side of the workflow editor. The following table provides more information about each tab.
Certain workflow schema elements, like the Decision element, do not include multiple tabs to manage their properties.
Tab | Description | Applies to which Schema Elements |
---|---|---|
General | Provide general information about the schema element.
Details options:
Action options:
Exception handling options:
|
|
Scripting | Enter the JavaScript script used in the schema element. |
|
Info | The Info tab has the same function as the General tab.
Details options:
|
|
Cases | Define which other element the Switch element switches to. |
|