Workflow Vertices
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| n/a | Alias used for the task to be inserted within the workflow; specifically, the value of ops_exec_workflow_vertex.name. | N | ||
| Task Name | Name of the task to be inserted within the workflow. | Y | ||
| n/a | Vertex ID of the task to be inserted within the workflow. | Y | ||
| n/a | x-coordinate of the task to be inserted within the workflow. | Default is 0. | N | |
| n/a | y-coordinate of the task to be inserted within the workflow. | Default is 0. | N |
Workflow Edges
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| n/a | Dependency condition between the source and target tasks of this edge (connector). | Valid values:
Default is Success. Note The type attribute (type=) is optional for Exit Code and Step Condition. Based on the format of the condition, in most cases it is easily determined if the condition is Exit Code and Step Condition. If the condition cannot be determined, the type attribute can be checked. For JSON, the type attribute is required for Variable Condition. If type = Variable(case sensitive), it will be detected as a Variable Condition. | Y | |
| n/a | If | For example:
| Y | |
| n/a | Vertex ID of the source task. | Y | ||
| n/a | Specification for whether the edge is straight or bent. | Boolean; Valid values: true/false. Default is true. | N | |
| n/a | Vertex ID of the target task. | Y |
Variable Conditions
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
firstValue | First Value | First Value of the condition evaluation. | Default is an empty/blank string. | N | |
operator | Operator | Operator of the condition evaluation. | Valid values:
Default is =(1). | N | |
secondValue | Second Value | Second Value of the condition evaluation. | Default is an empty/blank string. | N |
Variable Condition: JSON and XML Examples
XML | JSON |
---|---|
Step Conditions
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| Program | Program name to match. | A blank value or an asterisk ( * ) will match any program name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | N | |
| Procedure | Procedure step name to match. | A blank value or an asterisk ( * ) will match any procedure step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | N | |
| Action | Action to take and the task status to set if the Step Condition matches. | Valid values:
Default is Continue/Success (1). | N | |
| Condition Codes | Integer return codes from the program or ABEND codes. | Integer return codes are specified as a comma-separated list of integer values or ranges. Ranges are specified with a dash ( - ) separating the lower and upper bounds of the range. The z/OS job step return code range is 0-4095. ABEND codes are specified directly as either a user ABEND or a system ABEND. The ABEND code must be specified verbatim including leading zeroes. | Y | |
| Step | Job step name to match. | A blank value or an asterisk ( * ) will match any job step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | N | |
| Evaluation Order | Order for step condition evaluation. | Step conditions with a lower order are evaluated before step conditions with a higher order. | N | |
| n/a | sys_id used within the Controller to identify this Step Condition. | N |
Step Actions
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| Task | Name of a task. In combination with the | N | ||
| Agent | If | N |
| |
| Agent Cluster | If | N |
| |
| Agent Cluster Variable | Name of a variable that will be resolved at run time to the name of the Agent Cluster to use. | N |
| |
| Agent Variable | Name of a variable that will be resolved at run time to the name of the Agent to use. | N |
| |
| Description | Description of this System Operation Step Action. | N | ||
| Command | If | Valid values:
Default value is Cancel (1). | N | |
| Instance Criteria | If | Valid values:
Default is Oldest Active Instance (1).
| N | |
| Instance ID | If | N | ||
| Instance Lookup Option | If | Valid values:
Default is Instance Name (1). | N | |
| Instance Name | If | N | ||
| Workflow Instance Name | If | N | ||
| Workflow Instance Name Condition | If | Valid values:
Default is Equals (1). | N | |
| Limit |
| N | ||
| Name | Name of a variable to override. | N | ||
| System Notification | Status of the specified | Valid values:
Default is Operation Failure (1). | N | |
| System Operation | Specific system operation to perform. | Valid values:
Default is Suspend Agent (1). | N | |
| Override Date Offset | Override date offset. | Date Offset value of trigger to fire. | N (unless overrideTriggerDateTime is true) | |
| Override Trigger Date/Time | Request parameter to enable/disable override functionality. | Boolean value (true / false). Default is false. | N | |
| Override Time | Override time. | Time of the trigger to fire. | Y (if overrideTriggerDateTime is true) | |
| Program | Program name to match. | A blank value or an asterisk ( * ) will match any program name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | N | |
| Procedure | Procedure step name to match. | A blank value or an asterisk ( * ) will match any procedure step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | N | |
| Condition Codes | Conditions codes are integer return codes from the program or ABEND codes. Integer return codes are specified as a comma-separated list of integer values or ranges. Ranges are specified with a dash ( - ) separating the lower and upper bounds of the range. The z/OS job step return code range is 0-4095. ABEND codes are specified directly as either a user ABEND or a system ABEND. The ABEND code must be specified verbatim including leading zeroes. | N | ||
| Step | Job step name to match. | A blank value or an asterisk ( * ) will match any job step name. Generic matching characters asterisk ( * ) and question mark ( ? ) match zero or more characters and one character, respectively. | N | |
| Task Reference |
| N |
| |
| Task Execution Limit | If | Valid values:
Default is Unlimited. | N | |
| Task Reference Variable |
| N |
| |
| Trigger Reference | If | N |
| |
| Trigger Reference Variable | If | N |
| |
| Value | Value of a variable to override. | N | ||
| Override Variables | List of variables to override. | N | ||
| Override Variables Resolution Disabled | Specification for whether or not
| Boolean; Valid values: true/false. Default is false. | N | |
| Vertex Id | Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow. | Valid values:
| N | |
| Virtual Resource | If | N |
| |
| Virtual Resource Variable | Name of a variable that will be resolved at run time to the name of the Virtual Resource to use. | N |
|
Run Criteria
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| Business Day | Specification for whether the task runs or skips on all business days. | Boolean; Valid values: true/false. Default is false. | N | |
| Complex | Specification for whether the task runs or skips on the day(s) indicated in the | Boolean; Valid values: true/false. Default is false. | N | |
| Adjective | If For example, to specify "the 15th business day of the month," select | Valid values:
Default is Every (0). | N | |
| Noun | Deprecated (used only for single-value Nouns) If Note The Default Calendar for the Workflow task is used to verify Custom Day references. | Valid values:
| N | |
| Noun(s) | If For example, to specify "the 1st business day of the month," select Example: <complexNouns> <complexNoun>Business Day</complexNoun> </complexNouns> To specify a Custom Day, use the name of the Custom Day. For example: <complexNouns> <complexNoun>Monday</complexNoun> <complexNoun>CustomDay1</complexNoun> </complexNouns> "complexNouns": [ { "value": "Monday" }, { "value": "CustomDay1" } ]
<complexNouns> <complexNoun local="true">CustomDay2</complexNoun> </complexNouns> "complexNouns": [ { "local": true, "value": "CustomDay1" } ] | Valid values:
| N | |
| Nth Amount | If | Integer. | N | |
| Qualifier | Deprecated (used only for single-value Qualifiers) If Note The Default Calendar for the Workflow task is used to verify Custom Day references. | Valid values:
| N | |
| Qualifier(s) | If For example, to specify "the 1st business day of the month," select Example: <complexQualifiers> <complexQualifier>Month</complexQualifier> </complexQualifiers> <complexQualifiers> <complexQualifier>Jan</complexQualifier> <complexQualifier>CustomDay1</complexQualifier> </complexQualifiers> "complexQualifiers": [ { "value": "Jan" }, { "value": "CustomDay1" } ]
<complexQualifiers> <complexQualifier local="true">CustomDay2</complexQualifier> </complexQualifiers>
"complexQualifiers": [ { "local": true, "value": "CustomDay1" } ] | Valid values:
| N | |
| Adjustment | Specification for adjusting a complex day by a less or plus number of days or business days. | Valid values:
Default is None (0). | N | |
| Adjustment Amount | Number of days or business days to adjust a complex day. | Integer; Default is 1.
Maximum is 366. | Y | |
| Adjustment Type | Type of day by which to adjust a complex day. | Valid values:
Default is Day (1). | N | |
| Custom Day | Specification that the task runs or skips on the day you select in the | N | ||
| Custom Day Choice | If | N | ||
| Description | Description of this record. | N | ||
| Evaluate At | If | Valid values:
Default is Trigger Time (1). | N | |
| Holiday | Specification for whether or not the task runs or skips on holidays. | Boolean; Valid values: true/false. Default is false. | N | |
| Adjustment | Specification for adjusting a holiday by a less or plus number of days or business days. | Valid values:
Default is None (0). | N | |
| Adjustment Amount | Number of days or business days to adjust a holiday. | Integer; Default is 1.
| N | |
| Adjustment Type | Type of day by which to adjust a holiday. | Valid values:
Default is Day (1). | N | |
| Specific Day(s) | Specification for whether or not the task runs or skips on the day(s) you select in the | Boolean; Valid values: true/false. Default is false. | N | |
| Friday | If | Boolean; Valid values: true/false. Default value is false. | N | |
| Monday | If | Boolean; Valid values: true/false. Default value is false. | N | |
| Saturday | If | Boolean; Valid values: true/false. Default value is false. | N | |
| Sunday | If | Boolean; Valid values: true/false. Default value is false. | N | |
| Thursday | If | Boolean; Valid values: true/false. Default value is false. | N | |
| Tuesday | If | Boolean; Valid values: true/false. Default value is false. | N | |
| Wednesday | If | Boolean; Valid values: true/false. Default value is false. | N | |
| Task | Task for which you are specifying run or skip criteria. | Y | ||
| Type | Specification for whether this criteria is for running or skipping the specified task. | Valid values:
Default is Run Criteria (1). | N | |
| Variable | Used with | N | ||
| Name | If | N | ||
| Operator | If | Valid values:
Default is (1). | N | |
| Value | If | Maximum 40 alphanumerics. | N | |
| Vertex ID | Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow. | Valid values:
| N |
Workflow Forecasts
Property | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|
| ID used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
| Name used within the Controller to identify the workflow. | String; URI parameter. | Y |
|
| Unique ID for the Calendar. | N |
| |
| Name used within the Controller to identify the Calendar. | Maximum 100 alphanumeric. | N |
|
| Unique ID for this trigger. | N |
| |
| Name used within the Controller to identify this trigger. | Maximum 255 alphanumeric. | N |
|
| Date of the forecast. | Date (yyyy-mm-dd) | N | |
| Time of the forecast. | Time(HH:mm) | N | |
| Timezone. | N | ||
| Forecast Timezone. | N | ||
| Exclude the forecast types in the response. | Valid values:
| N | |
| Override the variables. | List of name: value variables | N |
Critical Endpoint
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| Task Critical Endpoint Description | User-defined description of this Critical Endpoint. | N | ||
| Late Finish Day Constraint | If | Valid values:
Default is None (0). | N | |
| Late Finish Duration | If | Format = dd:hh:mm:ss | N | |
| Late Finish | Specification that if the task instance finishes after the specified | Boolean; Valid values: true/false. Default is false. | N | |
| Late Finish Duration Offset ( + ) | if | Integer; Valid values are 0 or greater. Variables and Functions are supported. | Y (if |
|
| Late Finish Duration Offset Unit | Used with the For example, for a Late Finish Duration Offset of two minutes, specify 2 in | Valid Values:
Default is Minutes (2). | N | |
| Late Finish Percentage Offset ( + ) | If | Integer; Valid values are 0 to 100. Default is 0. | Y (if |
|
| Late Finish Offset Type | If | Valid Values:
Default is Percentage (1). | N | |
| Late Finish Time | If | Format = hh:mm. Default is 00:00. | N | |
| Late Finish Type | Type of late finish. | Valid values:
Default is Time (1). | Y | |
| Late Start Day Constraint | If | Valid values:
Default is None (0). | N | |
| Late Start Duration | If | Format = dd:hh:mm:ss | N | |
| Late Start | Specification that if the task instance starts after the specified | Boolean; Valid values: true/false. Default is false. | N | |
| Late Start Time | If | Format = hh:mm. Default is 00:00. | N | |
| Late Start Type | Type of late start. | Valid values:
Default is Time (1). | Y | |
| Task | Task for which you are specifying critical endpoint | Y | ||
| Vertex ID | Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow. | Valid values:
| N |