Panel | ||||
---|---|---|---|---|
|
...
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 |
| ||||||||||||||
|
|
...
Task Type | Success | Failure | Success/Failure | Step Condition(s) | Variable | Exit Code(s) |
---|---|---|---|---|---|---|
IBM i | ||||||
Recurring | ||||||
Universal Monitor | ||||||
z/OS Monitor | ||||||
Anchor | ||||
---|---|---|---|---|
|
...
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. |
...
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
You can switch between Workflows without using the navigation pane (see 794510219 Designing, Modifying, or Viewing Multiple Workflows.
Anchor | ||||
---|---|---|---|---|
|
...
Note | ||
---|---|---|
| ||
Calendar-based criteria are always evaluated using the task instance 794510219 Trigger Time (or the task instance Created time, if the workflow was launched manually). |
...
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 794510219 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 794510219 Custom Day Choice field.
| |||||||||||
| If 794510219 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 794510219 Adjective, 794510219 Noun, and 794510219 Qualifier fields. | |||||||||||
| If 794510219 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 794510219 Noun, 794510219 Qualifier, and Nth Amount (if 794510219 Adjective = Nth) fields. For example, to specify "the 15th business day of the month," select 794510219 Adjective: Nth, 794510219 Noun: Business Day, 794510219 Qualifier: Month, 794510219 Nth Amount: 15.
| |||||||||||
| If 794510219 Complex is enabled, you can use this field to specify the type of day(s) you want to select. Used in conjunction with the 794510219 Adjective, 794510219 Qualifier, and 794510219 Nth Amount (if 794510219 Adjective = Nth) fields. For example, to specify "the 1st business day of the month," select 794510219 Adjective: 1st, 794510219 Noun: Business Day, 794510219 Qualifier: Month.
| |||||||||||
| If 794510219 Complex is enabled, you can use this field to specify the period(s) for your selection formula. Used in conjunction with the 794510219 Adjective, 794510219 Noun, and 794510219 Nth Amount (if 794510219 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. |
...