Panel | ||||
---|---|---|---|---|
|
...
To create a Workflow, you enter task Details just as you would for any task, and then design the Workflow on the Workflow Editor, where you add, connect, and organize the tasks that will comprise the Workflow.
...
Step 1 | From the Automation Center navigation pane, select Tasks > Workflow Tasks. The Workflow Tasks list displays a list of all currently defined Workflow tasks. |
---|---|
Step 2 | Enter/select Details for a new Workflow task, using the field descriptions below as a guide.
To display more of the Details fields on the screen, you can either:
|
Step 3 | Click the button. The Workflow task is added to the database, and all buttons and tabs in Workflow Task Details are enabled. |
Step 4 | Click the Edit Workflow button to display a blank Workflow Editor canvas. |
Step 5 | Follow the instructions provided below for designing the Workflow in the Workflow Editor. |
Note | ||
---|---|---|
| ||
To open an existing record on the list, either:
|
...
Depending on the values that you enter / select for these fields, and whether or not the Workflow task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the Workflow Task Details.
...
Field Name | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
General | This section contains general information about the Workflow task. | ||||||||||||||
Name |
| ||||||||||||||
Version |
| ||||||||||||||
Description |
| ||||||||||||||
Member of Business Services |
| ||||||||||||||
Resolve Name Immediately |
| ||||||||||||||
Time Zone Preference |
| ||||||||||||||
Hold on Start |
| ||||||||||||||
Hold Reason |
| ||||||||||||||
Virtual Resource Priority |
| ||||||||||||||
Mutually Exclusive With Self |
| ||||||||||||||
|
| ||||||||||||||
Override Previous Instance Wait |
| ||||||||||||||
Workflow Details | This section contains assorted detailed information about the Workflow task. | ||||||||||||||
|
| ||||||||||||||
Auto Layout | If Show/Hide Skipped Tasks = Hide Skipped; specification for the layout of the Workflow Monitor.
| ||||||||||||||
| Default calendar used by the Workflow. If the Workflow is launched by a trigger, the trigger calendar overrides this default calendar. | ||||||||||||||
| If enabled, uses the selected Default Calendar for this Workflow instead of the calendar used in the trigger or parent Workflow. | ||||||||||||||
|
| ||||||||||||||
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. | ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
Time Options | This section contains time-related specifications for the task. | ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
Critical Path Options | This section contains Critical Path-related specifications for the task. | ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. | ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
Self-Service Options | This section contains Self-Service specifications for the task. | ||||||||||||||
Enforce Variables |
| ||||||||||||||
Lock Variables |
| ||||||||||||||
Statistics | This section contains time-related statistics for task instances of the task. | ||||||||||||||
First Execution |
| ||||||||||||||
Last Execution |
| ||||||||||||||
Last Instance Duration |
| ||||||||||||||
Lowest Instance Time |
| ||||||||||||||
Average Instance Time |
| ||||||||||||||
Highest Instance Time |
| ||||||||||||||
Number of Instances |
| ||||||||||||||
Metadata | This section contains Metadata information about this record. | ||||||||||||||
UUID | Universally Unique Identifier of this record. | ||||||||||||||
Updated By | Name of the user that last updated this record. | ||||||||||||||
Updated | Date and time that this record was last updated. | ||||||||||||||
Created By | Name of the user that created this record. | ||||||||||||||
Created | Date and time that this record was created. | ||||||||||||||
Buttons | This section identifies the buttons displayed above and below the Workflow Task Details that let you perform various actions. | ||||||||||||||
Save | Saves a new task record in the Controller database. | ||||||||||||||
Save & New | Saves a new record in the Controller database and redisplays empty Details so that you can create another new record. | ||||||||||||||
Save & Edit | Saves a new record in the Controller database and opens the workflow editor. | ||||||||||||||
Save & View | Saves a new record in the Controller database and continues to display that record. | ||||||||||||||
New | Displays empty (except for default values) Details for creating a new task. | ||||||||||||||
Update |
| ||||||||||||||
View Parents |
| ||||||||||||||
Launch With Variables... | Opens a Launch With Variables... dialog. Optionally, you can:
| ||||||||||||||
Launch |
| ||||||||||||||
Edit Workflow | Displays the Workflow Editor for this task. | ||||||||||||||
Copy | Creates a copy of this task, which you are prompted to rename. | ||||||||||||||
Delete |
| ||||||||||||||
Refresh | Refreshes any dynamic data displayed in the Details. | ||||||||||||||
Close | For pop-up view only; closes the pop-up view of this task. | ||||||||||||||
Tabs | This section identifies the tabs across the top of the Workflow Task Details that provide access to additional information about the task. | ||||||||||||||
Workflow Task | Displays details about this Workflow task. | ||||||||||||||
Task Run Criteria |
| ||||||||||||||
Step Conditions |
| ||||||||||||||
Variables |
| ||||||||||||||
Actions |
| ||||||||||||||
Virtual Resources |
| ||||||||||||||
Mutually Exclusive |
| ||||||||||||||
Critical Endpoints | Lists all critical endpoints defined for this task. | ||||||||||||||
Step Actions | Lists all step actions created for this task. | ||||||||||||||
| Lists all instances of this Workflow. | ||||||||||||||
Triggers |
| ||||||||||||||
Notes |
| ||||||||||||||
|
|
...
Field Name | Description | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
General | This section contains general information about the task instance. | ||||||||||||||
| Name of this task instance. | ||||||||||||||
Instance Number |
| ||||||||||||||
Description |
| ||||||||||||||
Member of Business Services |
| ||||||||||||||
Task |
| ||||||||||||||
Source Version |
| ||||||||||||||
Launch Source |
| ||||||||||||||
Source Instance |
| ||||||||||||||
Invoked by |
| ||||||||||||||
|
| ||||||||||||||
Calendar |
| ||||||||||||||
Time Zone Preference |
| ||||||||||||||
Virtual Resource Priority |
| ||||||||||||||
Mutually Exclusive With Self |
| ||||||||||||||
Simulate |
| ||||||||||||||
Previous Instance Wait Resolved |
| ||||||||||||||
Status | This section contains information about the current status of the task instance. | ||||||||||||||
Status |
| ||||||||||||||
Exit Code |
| ||||||||||||||
Status Description |
| ||||||||||||||
Operational Memo |
| ||||||||||||||
Evaluation Time |
| ||||||||||||||
Critical |
| ||||||||||||||
Wait Until Time |
| ||||||||||||||
Queued Time |
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
End Time |
| ||||||||||||||
Duration |
| ||||||||||||||
Progress | Number of tasks in the Workflow that are in Success, Skipped, or Finished status / Total number of tasks in the Workflow. | ||||||||||||||
Workflow Details | This section contains assorted detailed information about the task instance. | ||||||||||||||
Show/Hide Skipped Tasks |
| ||||||||||||||
Previous Instance Wait |
| ||||||||||||||
Wait / Delay Options | This section contains specifications for waiting to start and/or delaying on start the task. | ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
Time Options | This section contains information on time-related specifications for the task instance. | ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
Critical Path Options | This section contains Critical Path-related specifications for the task. | ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
Workflow Execution Options | This section contains Execution Restriction specifications for the task if it is within a Workflow. | ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
|
| ||||||||||||||
Statistics | This section contains time-related statistics for the task instance. | ||||||||||||||
|
| ||||||||||||||
Lowest Estimated End Time |
| ||||||||||||||
Average Estimated End Time |
| ||||||||||||||
Highest Estimated End Time |
| ||||||||||||||
Projected Start Time |
| ||||||||||||||
Projected End Time | System-supplied; projected end time of the task instance, calculated by the Controller based on the projected end time of its predecessor (or the maximum projected end time of all its predecessors, if more than one path exists to that task instance) plus its estimated critical path duration. | ||||||||||||||
Metadata | This section contains Metadata information about this record. | ||||||||||||||
UUID | Universally Unique Identifier of this record. | ||||||||||||||
Updated By | Name of the user that last updated this record. | ||||||||||||||
Updated | Date and time that this record was last updated. | ||||||||||||||
Created By | Name of the user that created this record. | ||||||||||||||
Created | Date and time that this record was created. | ||||||||||||||
Status History | History of all statuses that the task instance has gone through. | ||||||||||||||
Operational Memo History | History of all Operational Memos for the task. | ||||||||||||||
Buttons | This section identifies the buttons displayed above and below the Workflow Task Instance Details that let you perform various actions. | ||||||||||||||
Update |
| ||||||||||||||
Force Finish |
| ||||||||||||||
Hold |
| ||||||||||||||
Skip |
| ||||||||||||||
Release Recursive |
| ||||||||||||||
View Parent |
| ||||||||||||||
View Workflow |
| ||||||||||||||
Delete |
| ||||||||||||||
Refresh | Refreshes any dynamic data displayed in the Details. | ||||||||||||||
Close | For pop-up view only; closes the pop-up view of this task instance. | ||||||||||||||
Tabs | This section identifies the tabs across the top of the Workflow Task Instance Details that provide access to additional information about the task instance. | ||||||||||||||
Workflow Task Instance | Displays details about this Workflow task instance. | ||||||||||||||
Actions |
| ||||||||||||||
Virtual Resources |
| ||||||||||||||
Exclusive Requests |
| ||||||||||||||
Step Conditions |
| ||||||||||||||
Notes |
|
...
The Workflow Editor has three modes. Each mode, which you select by clicking the appropriate icon in the Workflow Editor toolbar, allows you to use one or more specific Workflow Editor tools.
Icon | Mode | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Clicking the Select icon on the Workflow Editor toolbar places the Workflow Editor in Select mode, which allows you to use all Workflow Editor tools except Connect and Pan. The Select mode is the default mode for the Workflow Editor. | ||||||||||||
| Clicking a Connect icon on the Workflow Editor toolbar places the Workflow Editor in Connect mode, which allows you to create connections between tasks. | ||||||||||||
| Clicking the Pan icon on the Workflow Editor toolbar places the Workflow Editor in Pan mode, which allows you to scroll around in the Workflow. (You also can use the Outline tool in any mode) to scroll around in the Workflow.
|
...
A shadowed outline around the icon in the toolbar indicates the currently selected Workflow Editor mode.
The following example shows that the Workflow Editor is in Select mode.
You also can perform all task actions and connector actions in any mode.
Anchor | ||||
---|---|---|---|---|
|
...
The following table describes the tools used to define Workflows, including the tools associated with the three Workflow Editor modes. The tools are listed by icon, as they appear - left to right - in the Workflow Editor toolbar.
Icon | Tool | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Go to Parent | If this Workflow is embedded in another Workflow, navigates to the parent. If this Workflow has more than one parent, clicking this icon displays a list of all parent Workflows; in this case, to navigate to a parent Workflow, double-click the Workflow's icon. To return to your original Workflow, click its name. (The current Workflow name displays in the lower right corner of the editor.)
| |||||||||||
| Open Workflow | Displays an Open Workflow pop-up dialog from which you can select a Workflow to replace the Workflow currently displayed in the Workflow Editor. (Make sure to save the current Workflow before replacing it.)
| |||||||||||
| Save | Saves the current Workflow. | |||||||||||
| Prints the current Workflow. | ||||||||||||
| Add Task | Displays the Task Find dialog, which allows you to search for and select tasks for the Workflow from a searchable list of defined tasks. (The Workflow Search Result Limit Universal Controller system property defines how many tasks display on the list.)
| |||||||||||
| Select | Places the Workflow Editor in Select mode. | |||||||||||
| Pan | Places the Workflow Editor in Pan mode. | |||||||||||
| Connect (bent) | Places the Workflow Editor in Connect mode.
| |||||||||||
| Undo | Click to undo the most recent change. | |||||||||||
| Redo | Click to redo the most recent change that you undid by clicking Undo. | |||||||||||
| Cut | Deletes the selected element(s): tasks, connectors, or both. Use Ctrl+Click to select and cut multiple elements. You can paste cut tasks into the same Workflow Editor or into the Workflow Editor of any other Workflow. If you cut a connector, and include its source and target tasks in the cut, you can paste the cut connector (and the tasks) into the same Workflow Editor or into the Workflow Editor of any other Workflow.
| |||||||||||
| Copy | Copies the selected element(s): tasks, connectors, or both. Use Ctrl+Click to select and copy multiple elements. You can paste copied tasks into the same Workflow Editor or into the Workflow Editor of any other Workflow. If you copy a connector, and include its source and target tasks in the copy, you can paste the copied connector (and the tasks) into the same Workflow Editor or into the Workflow Editor of any other Workflow. | |||||||||||
| Paste | Pastes the copied or cut element(s) into the currently open Workflow Editor or into the Workflow Editor of any other Workflow. If you want to paste a cut or copied connector, you must include the source and target tasks of the connector in the cut or copy. | |||||||||||
| Delete | Permanently deletes the selected elements. Delete does not keep a copy of the deleted elements in memory. | |||||||||||
| Fit | Fits the Workflow into the display. If necessary, this shrinks the icons and size of the Workflow in order to make it fit. You can undo a Fit by clicking the Actual Size icon. | |||||||||||
| Zoom In | Zooms in (enlarges) the Workflow. To return the Workflow to its default size, click the Actual Size icon. | |||||||||||
| Zoom Out | Zooms out (diminishes) the Workflow. To return the Workflow to its default size, click the Actual Size icon. | |||||||||||
| Actual Size | Returns the Workflow to its default size after a Fit or Zoom. | |||||||||||
| Zoom | Opens a window that allows you to specify a zoom ratio. For example, to double the size of the Workflow, enter 200 and click OK. To return the Workflow to its default size, click the Actual Size icon. | |||||||||||
| Horizontal Layout | Reformats the Workflow into a horizontal layout. | |||||||||||
| Vertical Layout | Reformats the Workflow into a vertical layout. | |||||||||||
| Toggle Vertex Style | For running Workflows, switches the icon display between status-related icons and task-related icons (see Monitoring Workflows). This icon only appears on the icon bar when you are monitoring a running Workflow. | |||||||||||
| Outline | For large Workflows, the outline provides a way of positioning a specific area of the Workflow in the display, without using the Pan mode.
| |||||||||||
| Help | Displays help documentation for Workflows. | |||||||||||
| Console | While a Workflow is running, you can click the Console icon to display processing messages. |
...
For each task in a Workflow, the Controller provides a menu of actions that you can take on that task. You can perform task actions in any Workflow Editor mode.
To display the menu of task actions, right-click a task.
...
Action | Description |
---|---|
View/Edit | Allows you to view and edit the Task Details for this task. |
View/Edit In Tab | Allows you to view and edit the Task Details for this task in a new tab. |
Cut | Cuts the task from its location in the Workflow. You can paste a cut task back into the same Workflow Editor or into the Workflow Editor of any other Workflow. |
Copy | Creates a copy of the task for inclusion in the same Workflow Editor or for inclusion in the Workflow Editor of any other Workflow. |
Paste | Pastes a copy of the task into the Workflow or into the Workflow Editor of any other Workflow. |
Delete | Deletes the task from the Workflow. You cannot paste a deleted task back into the Workflow. |
View/Edit Run Criteria | Allows you to view and edit any run criteria that has been created for this task. |
View/Edit Critical Endpoint | Allows you to view and edit any critical endpoint that has been created for this workflow. |
View/Edit z/OS Step Actions | z/OS Tasks only; Allows you to view and edit any z/OS step actions that have been created for this task. |
View Predecessors/Successors | Allows you to view all predecessors and successors of this task in the Workflow. |
Details > Show Details | Allows you to display complete database details for this task. |
Properties | Displays a menu of properties for the task. |
Anchor | ||||
---|---|---|---|---|
|
Task Properties
One of the task actions available for any task in a Workflow is to display a list of properties for that task.
...
For the workflow displayed in the Workflow Editor, the Controller provides a menu of actions that you can take on that workflow. You can perform task actions in any Workflow Editor mode.
To display the menu of workflow task actions, right-click any white space in the Workflow Editor canvas.
...
Action | Description |
---|---|
New Task... | Allows you to create and insert a new task into a Workflow and connect it to other tasks in the Workflow. |
View/Edit | Allows you to view and edit the Task Details for this workflow task. |
View/Edit In Tab | Allows you to view and edit the Task Details for this workflow task in a new tab. |
View Children | Allows you to view a list of child tasks of this workflow task. |
Paste | Allows you to paste cut or copied elements from this workflow or any other workflow into the Workflow Editor. |
Launch Workflow | Allows you to launch this workflow task |
Find In Workflow... | Allows you to find a task in this workflow task. |
Pan To Top | Allows you to restore the displayed Workflow Editor for this workflow task to its default, top-left position. |
Details > Show Details | Allows you to display complete database details for this workflow task. |
...
Create and Insert Task
One of the task actions available for a Workflow displayed in the Workflow Editor is New Task..., which lets you create and insert a new task into the the Workflow Editor.
...
Step 1 | Click one of the Connect icons to place the Workflow Editor in Connect mode. |
---|---|
Step 2 | Click the predecessor task; that is, the task whose status will trigger the next task.
|
Step 3 | Drag your mouse to the successor task; that is, the task that will be triggered. As you drag your mouse, a red line display. Drag your mouse all the way to the center of the successor task; the red line becomes a dotted, green line - the connector between the tasks - and the successor task is highlighted. |
Step 4 | Release the mouse button. The connector becomes a highlighted, solid green line (identifying it as a default Success condition).. Optionally, you can reposition the connection by dragging it to a new location. Arrows on the connectors indicate the direction of the Workflow. |
Step 5 | Repeat this process for other connectors to be added. |
...
For each connector in a Workflow, the Controller provides a menu of actions that you can take on that connector. You can perform connector actions in any Workflow Editor mode.
To display the menu of connector actions, right-click a connection.
...
Action | Description |
---|---|
Conditions | Allows you to select a dependency condition for the connection. |
Go To Source | Highlights the predecessor task for the connector and moves it to the center of the Workflow Editor display. |
Go To Target | Highlights the successor task for the connector and moves it to the center of the Workflow Editor display. |
Cut | Cuts the connector from its location in the Workflow. If you include the source and target tasks of a connector in the cut, you can paste the cut connector (and the tasks) into the same Workflow Editor or into the Workflow Editor of any other Workflow. |
Copy | Creates a copy of the connector for inclusion in the Workflow if you include the source and target tasks of the connector in the copy. You can paste the copied connector (and the tasks) into the same Workflow Editor or into the Workflow Editor of any other Workflow. |
Paste | Pastes a copy of the connector (if you also copied the source and target tasks of the connector) into the Workflow. |
Delete | Deletes the connector from the Workflow. You cannot paste a deleted connector back into the Workflow. |
Properties | Displays a menu of properties for the connector. |
Anchor | ||||
---|---|---|---|---|
|
Connector Properties
One of the connector actions available for any connector in a Workflow is to display a list of properties for that connector.
...
Task Type | Success | Failure | Success/Failure | Step Condition(s) | Variable | Exit Code(s) |
---|---|---|---|---|---|---|
IBM i | ||||||
Recurring | ||||||
Universal Monitor | ||||||
z/OS Monitor | ||||||
Anchor | ||||
---|---|---|---|---|
|
...
Step 1 | Hover your mouse over the connection to view the currently selected condition. If you want to change the condition, right-click the connection to display a Connector Actions menu. |
---|---|
Step 2 | Select Conditions. The Conditions dialog displays. |
Step 3 | Specify a condition (as supported for each task type). |
Step 4 | If you selected Step Condition(s) for a connection to a predecessor z/OS task, click the View/Edit... button to display a Step Conditions dialog that lets you define the step conditions. |
Step 5 | Click OK on the Conditions dialog. |
Step 6 | To see the condition that is specified for a connection, hover your cursor over the connector (see Connector Graphics for All Condition Types, below). |
...
Step 1 | Hover your mouse over the connection to view the currently selected condition. To change the condition, right-click the connection to display a Connector Actions menu. |
---|---|
Step 2 | Select Conditions. The Conditions dialog displays. |
Step 3 | Select Variable and click View/Edit... button to display a Variable dialog that lets you define the Variable Condition. |
Step 4 | Using the field descriptions below as a guide, complete the fields and click OK.
|
Step 5 | Click OK on the Conditions dialog. |
Step 6 | To see the condition that is specified for a connection, hover your cursor over the connector (see Connector Graphics for All Condition Types, below). |
...
The following illustration shows the connector formats for all condition types and the details that displays for each condition type (in this case, Success/Failure) when you hover your cursor over the connector.
...
The status of the tasks in the conditional paths leading to the immediate predecessor tasks do not affect whether or not the successor tasks will run. All tasks leading to an immediate predecessor tasks do not have to have run in order for the successor task to run. Anchor
Moving Workflow Elements
...
Specifying a Condition Expression
In the Workflow Editor canvas, you can move these elements as needed.
Move a Single Task
specify a Condition Expression for the direct predecessor dependencies of a Task vertex.
An incoming edge from a vertex denotes a predecessor condition. By default, all predecessor conditions must be satisfied before a task can start.
To change the default behavior, you can specify a custom Condition Expression by clicking View/Edit Condition Expression.
You can then use the Condition Expression builder to specify your desired expression.
For the Condition Expression above, the predecessor dependencies of Task D will be satisfied when the following conditions have been met.
(Task A is Success, Finished or Skipped) and ((Task B is Success, Finished or Skipped) or (Task C is Success, Finished or Skipped))
Condition Expressions
A Condition Expression consists of conditions and/or subexpressions joined by a logical operator.
Valid logical operator values are:
All Satisfied (And)
Any Satisfied (Or)
The Condition Expression tree will always have a root node for the top-level expression. The root node cannot be deleted. By default, the root node will have the vertex’s predecessors as children and the logical operator will be set to “All Satisfied”. This represents the default behavior prior to UC 7.7.0.0.
Info |
---|
The Condition Expression window will only support editing for the Workflow editor. The tree will be marked read-only for the version and monitor views. When viewing an existing Condition Expression, the Condition Expression may be altered based on the following rules:
|
Conditions
You can copy a condition by clicking the icon if you need to include it in more than one subexpression.
You can delete a condition by clicking the icon. Prohibited if last remaining condition for the predecessor.
You can drag a condition under a new subexpression to make it a child of the subexpression.
You can drag a condition to a change its position.
Subexpressions
You can add a subexpression by clicking the icon.
You can delete a subexpression by clicking the icon. Prohibited if the subexpression has children.
Clicking the icon on a condition will insert the subexpression below the condition.
Clicking the icon on a subexpression will add the subexpression to the end of the children list.
You can drag a subexpression under a new subexpression to make it a child of the subexpression.
You can drag a subexpression to a change its position.
Cluster Broadcast
There are 3 scenarios to consider whenusing cluster broadcast.
Task with cluster broadcast.
Predecessor task with cluster broadcast.
Task and predecessor task with cluster broadcast.
Task With Cluster Broadcast
In the following Workflow task, WT1 is the task with cluster broadcast.
The Condition Expression for WT1 is shown below.
After launching the Workflow task, 2 dynamic vertices will be generated for WT1 as shown below since there are 3 agents in the cluster.
When launching the Workflow task, the server will copy the Condition Expression to the dynamic vertices when they are created. All 3 vertices for WT1 should have the following Condition Expression.
Predecessor Task With Cluster Broadcast
In the following Workflow task, WT1 is the predecessor task with the cluster broadcast.
The Condition Expression for MT1 is shown below.
Info |
---|
You can create a subexpression with a single condition. This is useful if you want to join the conditions for the vertex and its dynamic vertices with a logical operator. |
When launching the Workflow task, the server will modify the Condition Expression for MT1 to insert a condition for the dynamic vertices wherever the original vertex is specified. Since dynamic vertices have a negative vertex ID, it is easy to identify them when viewing the Condition Expression.
The Condition Expression for MT1 should include original vertex and the dynamic vertices for WT1 under the subexpression.
Task and Predecessor Task With Broadcast Cluster
In the following Workflow task, WT2 is the task with the cluster broadcast and WT1 is the predecessor task with cluster broadcast.
WT1 has the default Condition Expression shown below.
The Condition Expression for WT2 is shown below.
Launching the Workflow task, results in the following.
All the WT1 vertices should have the default Condition Expression.
All the WT2 vertices should have the following Condition Expression. The Condition Expression will be copied from the original WT2 vertex to its dynamic vertices and modified to add the dynamic vertices of WT1.
Inheritance
Condition Expressions are defined against direct dependencies. Leave the Condition Expression as All Satisfied (default) to keep the dependency evaluation behavior unchanged.
The predecessor dependencies of a Skipped vertex in a Condition Expression are not applicable if a Condition Expression is specified as anything other than All Satisfied (default), specifically, when a vertex specified in the Condition Expression is Skipped, this is equivalent to the vertex being Success or Finished with respect to Condition Expression evaluation.
An example is provided below.
In the example above, if you need to be able to skip B and still inherit the dependencies of B, you can add a NOOP task (i.e. Timer 0) between B and E, accordingly.
Info |
---|
The example above demonstrated using the Skip command, however, there are other ways a task can be skipped, such as task run/skip criteria. The same would apply, regardless of how the task instance is skipped. You could also use runtime run/skip criteria to defer skipping B until all of its predecessor dependencies have been satisfied. |
Anchor | ||||
---|---|---|---|---|
|
Moving Workflow Elements
After you have positioned tasks and connectors on the Workflow Editor canvas, you can move these elements as needed.
Move a Single Task
Click a task and drag it to a new location. If the task has any connectors attached, they remain connected, and lengthen or shorten as necessary. |
...
Note | ||
---|---|---|
| ||
You also can move to different areas of a Workflow by using the Find in Workflow... tool. |
Anchor | ||||
---|---|---|---|---|
|
Workflow Coordinates
If you use Pan mode (or Find in Workflow...) to view different areas of a Workflow, the Controller preserves the coordinates of the last area that you viewed. If you leave the Workflow and return to it in the same browser session, the last viewed area of the Workflow displays.
...
Saving/Updating a Workflow
Click the icon.
Info |
---|
The Controller checks if other users have made changes before updating the workflow. If other modifications were made, a dialog box will appear, giving you options to proceed with the update and overwrite the modifications, cancel the update and return to the workflow editor, or cancel and discard your changes. The Automatically Create Versions system property must be true for the Controller to check for changes made by other users. |
Switching Between Workflows
...
Step 1 | Display the Details of the Workflow for which you want to specify skip/run criteria. |
---|---|
Step 2 | Click the Task Run Criteria tab. The Task Run Criteria list displays a list of any existing skip/run criteria for that task. |
Step 3 | Click New. Task Run Criteria Details displays: |
Step 4 | Using the field descriptions, below, as a guide, complete the fields as needed. For example, to tell the Controller not to run a specific task on business days or holidays, select Skip Criteria in the Type field, select the task and enable Business Day and Holiday. |
Step 5 | Click the Save button to save the record. |
...
Field Name | Description | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Type | User-defined; indicates whether this is providing instructions on when to run or not run the task.
| |||||||||||
Description |
| |||||||||||
Task | User-defined; task for which you are specifying run or skip criteria. Select a task from the drop-down list of all tasks in this Workflow. | |||||||||||
Vertex ID | Vertex ID of the task selected in the Task field. Each task within a Workflow has a unique Vertex ID, which distinguishes it from other tasks of the same name, if any. | |||||||||||
Business Day | If enabled, the task runs or skips on all business days. | |||||||||||
| If enabled, the task runs or skips on holidays. | |||||||||||
| If Holiday is enabled; Specification for adjusting a Holiday by a less or plus number of days or business days. Options:
Default is – None -- | |||||||||||
| If Adjustment is Less or Plus; Number of days or business days to adjust a Holiday. Default is 1. | |||||||||||
| If Adjustment is Less or Plus; Type of day by which to adjust a Holiday. Options:
Default is Day. | |||||||||||
Specific Day(s) – Sunday through Saturday | If enabled, the task runs or skips on the day(s) you select in the right-hand column. | |||||||||||
| If enabled, the task runs or skips on the day you select in the Custom Day Choice field.
| |||||||||||
| If Custom Day is enabled, select the custom day for which you are specifying run or skip criteria. Enter the name of an existing Custom Day, select a Custom Day from the drop-down list of all existing Custom Days, or click the Details icon to create a new Custom Day.
| |||||||||||
| If enabled, the task runs or skips on the day(s) indicated in the Adjective, Noun, and Qualifier fields. | |||||||||||
| If Complex is enabled, you can use this field to specify which in a series of days you want to select. Used in conjunction with the Noun, Qualifier, and Nth Amount (if Adjective = Nth) fields. For example, to specify "the 15th business day of the month," select Adjective: Nth, Noun: Business Day, Qualifier: Month, Nth Amount: 15.
| |||||||||||
| If Complex is enabled, you can use this field to specify the type of day(s) you want to select. Used in conjunction with the Adjective, Qualifier, and Nth Amount (if Adjective = Nth) fields. For example, to specify "the 1st business day of the month," select Adjective: 1st, Noun: Business Day, Qualifier: Month.
| |||||||||||
| If Complex is enabled, you can use this field to specify the period(s) for your selection formula. Used in conjunction with the Adjective, Noun, and Nth Amount (if Adjective = Nth) fields. For example, to specify "the 1st business day of the month," select Adjective: 1st, Noun: Business Day, Qualifier: Month.
| |||||||||||
| If Adjective = Nth; Sequential occurrence of the day selected in Noun within the selected Qualifier. | |||||||||||
| If Complex is enabled; Specification for adjusting a complex day by a less or plus number of days or business days. Options:
Default is – None -- | |||||||||||
| If Adjustment is Less or Plus; Number of days or business days to adjusting a complex day. Default is 1. | |||||||||||
| If Adjustment is Less or Plus; Type of day by which to adjust a complex day. Options:
Default is Day. | |||||||||||
| If enabled, instructs the Controller to run or not run the task, depending on the value of a specific variable. Used in conjunction with fields: Evaluate At, Name, Operator, and Value. | |||||||||||
| If Variable = enabled; Allows you to specify when you want the Controller to evaluate the variable.
| |||||||||||
| If Variable = enabled; Specifies the name of the variable being evaluated. The variable does not need to exist when this record is created. | |||||||||||
| If Variable = enabled; Allows you to select the operator to be used in the evaluation. Options: =, !=, >, >=, <, <=, regex (regular expression). | |||||||||||
| If Variable = enabled; Allows you to specify the value or regular expression (up to 255 alphanumeric characters) that the Controller should look for when evaluating the variable. | |||||||||||
Buttons | This section identifies the buttons displayed above and below the Task Run Criteria that let you perform various actions. | |||||||||||
Save | Saves a new record in the Controller database. | |||||||||||
Update |
| |||||||||||
New | Displays empty (except for default values) Details for creating a new Database Connection. | |||||||||||
Delete |
| |||||||||||
Refresh | Refreshes any dynamic data displayed in the Details. | |||||||||||
Close | For pop-up view only; closes the pop-up view of this Database Connection. |
...
As with other task types, you can run a Workflow manually or specify triggers that run the Workflow task automatically based on times or events.
You also can specify skip and run criteria for specific tasks within the Workflow.
...
Step 1 | From the Automation Center navigation pane, select Tasks > Workflow Tasks. The Workflow Tasks list displays. |
---|---|
Step 2 | Click the Task Name of the Workflow task that you want to modify. Workflow Task Details for that task displays. |
Step 3 | Click Edit Workflow to display the Workflow Editor. |
Step 4 | Modify the Workflow and click the Save icon. |
...
Step 1 | From the Automation Center navigation pane, select Tasks > Workflow Tasks. The Workflow Tasks list displays. |
---|---|
Step 2 | Right-click the Workflow that you want to clone, or open the Workflow and right-click anywhere in the Details, to display an action menu for that Workflow. |
Step 3 | Click Clone... in the Action menu to display the Clone Workflow Task pop-up: |
Step 4 | Enter a Prefix and/or Suffix, which will be applied to the Workflow clone and all of its tasks. |
Step 5 | If you want to clone all Virtual Resources of the Workflow, click the Clone Virtual Resources check box. |
Step 6 | Click Submit to clone the Workflow. The Workflow clone will display in the Workflows list. In the Workflow Editor, each task clone will have the same prefix and/or suffix as the Workflow clone, and the task clones will display in the task lists for those task types. |
...
Step 1 | From the Automation Center navigation pane, select Tasks > Workflow Tasks. The Workflow Tasks list displays. |
---|---|
Step 2 | Right-click the Workflow that you want to delete to display an Action menu. (If you want to delete multiple Workflows, use Ctrl+click to select each one and then right-click any of the selected Workflows.) |
Step 3 | Click Delete. |
...
For any Workflow task, or any Workflow task instance (running or complete), you can find the location of any task (or multiple tasks) within that Workflow:
Step 1 | On the Workflow Tasks list, right-click a Workflow task to display an Action menu. | ||||||
---|---|---|---|---|---|---|---|
Step 2 | Click Edit Workflow to display the Workflow Editor for that Workflow. | ||||||
| Right-click any white space in the Workflow Editor canvas. A pop-up menu displays. | ||||||
Step 4 | Click Find in Workflow... to display a Find in Workflow dialog. | ||||||
Step 5 | Select an operator for the search (contains, starts with, or equals), enter the full or partial name of the task(s) that you want to find, and press enter. The Controller locates and displays the first task within the Workflow that matches the search criteria. Click the Next and/or Previous buttons to find any other tasks that match the search criteria. |
...
Workflow Coordinates
If you use Find in Workflow... (or Pan mode) to view different areas of a Workflow, the Controller preserves the coordinates of the last area that you viewed. If you leave the Workflow and return to it in the same browser session, the last viewed area of the Workflow displays.
...
Note | ||
---|---|---|
| ||
You also can view any predecessor or successor task instance of a task instance in a Workflow from the View Predecessors/Successors pop-up dialog. |
Anchor | ||||
---|---|---|---|---|
|
...
You can insert the task as a predecessor or successor of another task instance within the Workflow instance using the Insert Task as Predecessor or Insert Task as Successor command, respectively. Alternatively, you can use the Insert Task... command to insert a task with any number of predecessors and successors.
...
Step 1 | In the Workflow Monitor, right-click a task instance. |
---|---|
Step 2 | Click Insert Task As Predecessor.... The Task Insert > Task Selection dialog displays. |
Step 3 | Find the task you want to insert (see Searching For and Adding Tasks) and drag the task's icon onto the Workflow Editor canvas where you would like it to be inserted. |
Step 4 | By default, the inserted task will inherit the Trigger Time of the parent Workflow. If the Trigger Time of the parent Workflow is undefined, the Launch Time will be inherited as the Trigger Time instead. |
...
Step 1 | In the Workflow Monitor, right-click a task instance. |
---|---|
Step 2 | Click Insert Task As Successor.... The Task Insert > Task Selection dialog displays. |
Step 3 | Find the task you want to insert (see Searching For and Adding Tasks) and drag the task's icon onto the Workflow Editor canvas where you would like it to be inserted. |
Step 4 | By default, the inserted task will inherit the Trigger Time of the parent Workflow. If the Trigger Time of the parent Workflow is undefined, the Launch Time will be inherited as the Trigger Time instead. |
...
Step 1 | In the Workflow Monitor, right-click any white space in the Workflow Editor canvas. | |||||
---|---|---|---|---|---|---|
Step 2 | Click Insert Task.... The Task Insert > Task Selection dialog displays. | |||||
Step 3 | Find the task you want to insert (see Searching For and Adding Tasks 794510219) and drag the task's icon onto the Workflow Editor canvas where you would like it to be inserted. | |||||
Step 4 | The Task Insert > Predecessor/Successor Selection dialog displays. | |||||
Step 5 | Select zero or more predecessors and zero or more Successors for the inserted task. | |||||
Step 6 | By default, the inserted task will inherit the Trigger Time of the parent Workflow. If the Trigger Time of the parent Workflow is undefined, the Launch Time will be inherited as the Trigger Time instead. For task instances within an inserted Workflow, Run Criteria will be evaluated using the inherited Trigger Time. | |||||
Step 7 | Click OK. The Controller inserts the task as a successor to the selected predecessor task instance(s) and as a predecessor to the selected successor task instance(s).
|
...
Step 1 | Display the Activity Monitor, Task Instances List, Workflow Task Instance Details, or Workflow Monitor. |
---|---|
Step 2 | Right-click to display an Action menu. |
Step 3 | Click View Timeline... to display the View Timeline... pop-up dialog. |
Step 4 | Use the Instance Name Filter and Type Filter fields to reduce the number of task instances that are included in the Timeline. Instance Name Filter supports wildcard characters (* and ?) to specify Instance Name patterns. If specified, only task instances that match both the Instance Name Filterand the Type Filter will be included. |
Step 5 | Click Submit. The Timeline for the Workflow task instance displays. |
Step 6 | Use the toolbar along the top of the Timeline View to specify the resolution of the timeline.
|
...
Step 1 | Open the Workflow Editor. |
---|---|
Step 2 | Right-click a task to display an Action menu. |
Step 3 | Right-click View Predecessors/Successors to display the View Predecessors/Successors pop-up.
|
Step 4 | Click Edit if you want to edit the predecessors and successors of this task in the workflow. |
...
Step 1 | Open the Workflow Editor. | |||||
---|---|---|---|---|---|---|
Step 2 | Right-click a Task to display an Action menu. | |||||
Step 3 | Click Edit Predecessors/Successors to display the Edit Predecessors/Successors pop-up dialog. To resize the pop-up, hover over the window resize icon at the bottom right of the pop-up and drag the icon up or down.
| |||||
Step 4 | To add a task as a predecessor or successor to the selected task, hold the Ctrl key and click the name of that task. To remove a task as a predecessor or successor to the selected task, hold the Ctrl key and click the name of that task. | |||||
Step 5 | To add a task as a predecessor or successor to the selected task and remove all other predecessors or successors, click the name of that task. |
...