Panel | |
---|---|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
alias | n/a | Alias used for the task to be inserted within the workflow; specifically, the value of ops_exec_workflow_vertex.name. | N | ||||||||
task | Task Name | Name of the task to be inserted within the workflow. | Y | ||||||||
vertexId | 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 |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
condition | n/a | Dependency condition between the source and target tasks of this edge (connector). | Valid values:
Default is Success. Anchor | points - WE | points - WE | points
| Y |
| Y | |||||||||||||
points | n/a | If | For example:
| Y | ||||||||||||||||||
sourceId | n/a | Vertex ID of the source task. | Y | |||||||||||||||||||
straightEdge | n/a | Specification for whether the edge is straight or bent. | Boolean; Valid values: true/false. Default is true. | N | ||||||||||||||||||
targetId | n/a | Vertex ID of the target task. | Y |
...
...
Variable Conditions
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
|
programName
Program
Program name to match.
Valid values:
Default is Continue/Success
| First Value | First Value of the condition evaluation. | Default is an empty/blank string. | N | ||||||
|
pstepName
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
stepAction
Action
Action to take and the task status to set if the Step Condition matches.
Property
UI Field Name
Description
Specifications
Required
Mutually Exclusive With
actionCriteriaTask
Task
Name of a task. In combination with the vertexId
, it specifies a specific task within the Workflow to which the step action applies; if no task is specified, the step action applies to all z/OS tasks within the Workflow.
N
agent
Agent
If operation
is Suspend Agent, Resume Agent, Suspend Cluster Membership, Resume Cluster Membership, or Set Agent Task Execution Limit; Agent for which the system operation is to be performed.
N
agentVar
agentCluster
Agent Cluster
If operation
is Suspend Agent Cluster, Resume Agent Cluster, Suspend Cluster Membership, Resume Cluster Membership, or Set Cluster Task Execution Limit; Agent Cluster for which the system operation is to be performed.
N
agentClusterVar
agentClusterVar
Agent Cluster Variable
Name of a variable that will be resolved at run time to the name of the Agent Cluster to use.
N
agentCluster
agentVar
Agent Variable
Name of a variable that will be resolved at run time to the name of the Agent to use.
N
agent
description
Description
Description of this System Operation Step Action.
N
execCommand
Command
If operation
is Run Task Instance Command; Type of task instance command to run.
Valid values:
Default value is Cancel (1).
N
execCriteria
Instance Criteria
If operation
is Run Task Instance Command; Additional criteria for selecting a specific task instance if multiple task instances have matching names.
Valid values:
Default is Oldest Active Instance (1).
N
execId
Instance ID
If execLookupOption
is Instance Id; ID of task instance to run the command against.
N
execLookupOption
Instance Lookup Option
If operation
is Run Task Instance Command; Specification for how to search for the task instance to run a command against.
Valid values:
Default is Instance Name (1).
N
execName
Instance Name
If execLookupOption
is Instance Name; Name of the task instance to run the command against.
N
execWorkflowName
Workflow Instance Name
If operation
is Run Task Instance Command; Name of the parent workflow task instance that contains the task on which to perform the specified action.
N
execWorkflowNameCond
Workflow Instance Name Condition
If operation
is Run Task Instance Command; Type of condition for the name of the parent workflow task instance that contains the task on which to perform the specified action. If you select a condition type, enter a value for that condition. The action will be performed only on a task instance in a parent workflow task instance meeting the specified condition value.
Valid values:
Default is Equals (1).
N
limit
Limit
- If
operation
is Set Agent Task Execution Limit or Set Cluster Task Execution Limit, andtaskLimitType
is Limited; Number of tasks that can be run concurrently by the specified Agent / Agent Cluster. - If
operation
is Set Virtual Resource Limit; Virtual resource limit to be set for the specified virtual resource.
N
name
Name
Name of a variable to override.
N
notificationOption
System Notification
Status of the specified operation
that will trigger a system notification.
Valid values:
Default is Operation Failure
operator | Operator | Operator of the condition evaluation. | Valid values:
Default is =(1). | N | |||||
|
stepCodes
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
stepName
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
stepOrder
Evaluation Order
Order for step condition evaluation.
Step conditions with a lower order are evaluated before step conditions with a higher order.
N
sysId
n/a
sys_id used within the Controller to identify this Step Condition.
N
...
| Second Value | Second Value of the condition evaluation. | Default is an empty/blank string. | N |
Variable Condition: JSON and XML Examples
XML | JSON | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | ||||||
---|---|---|---|---|---|---|---|---|---|---|---|
programName | 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 | |||||||
pstepName | 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 | |||||||
stepAction | Action | Action to take and the task status to set if the Step Condition matches. | Valid values:
Default is Continue/Success (1). | N | |||||||
stepCodes | 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 | |||||||
stepName | 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 | |||||||
stepOrder | Evaluation Order | Order for step condition evaluation. | Step conditions with a lower order are evaluated before step conditions with a higher order. | N | |||||||
sysId | n/a | sys_id used within the Controller to identify this Step Condition. | N |
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
actionCriteriaTask | Task | Name of a task. In combination with the | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
agent | Agent | If | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
agentCluster | Agent Cluster | If | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
agentClusterVar | Agent Cluster Variable | Name of a variable that will be resolved at run time to the name of the Agent Cluster to use. | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
agentVar | Agent Variable | Name of a variable that will be resolved at run time to the name of the Agent to use. | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | Description | Description of this System Operation Step Action. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execCommand | Command | If | Valid values:
Default value is Cancel (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
operation execCriteria | System Operation | Specific system operation to performInstance Criteria | If | Valid values: Default is Suspend Agent (1). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | overrideTriggerDateOffset - SA | overrideTriggerDateOffset - SA | Override Date Offset | Override date offset. | Date Offset value of trigger to fire. | N (unless overrideTriggerDateTime is true) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | overrideTriggerDateTime - SA | overrideTriggerDateTime - SA | Override Trigger Date/Time | Request parameter to enable/disable override functionality. | Boolean value (true / false). Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | overrideTriggerTime - SA | overrideTriggerTime - SA | Override Time | Override time. | Time of the trigger to fire. | Y (if overrideTriggerDateTime is true) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | programName - SA | programName - SA | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | pstepName - SA | pstepName - SA | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | stepCodes - SA | stepCodes - SA | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | stepName - SA | stepName - SA | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | task - SA | task - SA | Task Reference |
| N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | taskLimitType - SA | taskLimitType - SA | Task Execution Limit | If | Valid values: Default is Unlimited. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | taskVar - SA | taskVar - SA | Task Reference Variable |
| N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | trigger - SA | trigger - SA | Trigger Reference | If | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | triggerVar - SA | triggerVar - SA | Trigger Reference Variable | If | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | value - SA | value - SA | Value | Value of a variable to override. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | variables - SA | variables - SA | Override Variables | List of variables to override. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | variablesUnresolved - SA | variablesUnresolved - SA | Override Variables Resolution Disabled | Specification for whether or not
| Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | vertexId - SA | vertexId - SA | Vertex Id | Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow. | Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | virtualResource - SA | virtualResource - SA | Virtual Resource | If | N |
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | virtualResourceVar - SA | virtualResourceVar - SA | Virtual Resource Variable | Name of a variable that will be resolved at run time to the name of the Virtual Resource to use. | N |
|
Variable Condition
Note |
---|
For workflow edge variable conditions that use functions to evaluate STDOUT, STDERR, FILE, or JOBLOG output, you must enable Wait For Output when setting up Automatic Output Retrieval. |
...
Property
...
UI Field Name
...
Description
...
Specifications
...
Required
...
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:
As String = , As Value 1.
As String != , As Value 2.
As String > , As Value 3.
As String >= , As Value 4.
As String <, As Value 5.
As String <= , As Value 6.
As String regex , As Value 7.
As String contains , As Value 8.
Default is =(1).
...
N
...
secondValue
...
Second Value
...
Second Value of the condition evaluation.
...
Default is an empty/blank string.
...
N
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Anchor | businessDays - RC | businessDays - RC | Business Day | Specification for whether the task runs or skips on all business days. |
Default is Oldest Active Instance (1).
| N | ||||||||||||||||||||||||
execId | Instance ID | If | N | |||||||||||||||||||||||||||
execLookupOption | Instance Lookup Option | If | Valid values:
Default is Instance Name (1). | N | ||||||||||||||||||||||||||
execName | Instance Name | If | N | |||||||||||||||||||||||||||
execWorkflowName | Workflow Instance Name | If | N | |||||||||||||||||||||||||||
execWorkflowNameCond | Workflow Instance Name Condition | If | Valid values:
Default is Equals (1). | N | ||||||||||||||||||||||||||
limit | Limit |
| N | |||||||||||||||||||||||||||
name | Name | Name of a variable to override. | N | |||||||||||||||||||||||||||
notificationOption | System Notification | Status of the specified | Valid values:
Default is Operation Failure (1). | N | ||||||||||||||||||||||||||
operation | System Operation | Specific system operation to perform. | Valid values:
Default is Suspend Agent (1). | N | ||||||||||||||||||||||||||
overrideTriggerDateOffset | Override Date Offset | Override date offset. | Date Offset value of trigger to fire. | N (unless overrideTriggerDateTime is true) | ||||||||||||||||||||||||||
overrideTriggerDateTime | Override Trigger Date/Time | Request parameter to enable/disable override functionality. | Boolean value (true / false). Default is false. | N | ||||||||||||||||||||||||||
overrideTriggerTime | Override Time | Override time. | Time of the trigger to fire. | Y (if overrideTriggerDateTime is true) | ||||||||||||||||||||||||||
programName | 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 | ||||||||||||||||||||||||||
pstepName | 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 | ||||||||||||||||||||||||||
stepCodes | 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 | |||||||||||||||||||||||||||
stepName | 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 | Task Reference |
| N |
| ||||||||||||||||||||||||||
taskLimitType | Task Execution Limit | If | Valid values:
Default is Unlimited. | N | ||||||||||||||||||||||||||
taskVar | Task Reference Variable |
| N |
| ||||||||||||||||||||||||||
trigger | Trigger Reference | If | N |
| ||||||||||||||||||||||||||
triggerVar | Trigger Reference Variable | If | N |
| ||||||||||||||||||||||||||
value | Value | Value of a variable to override. | N | |||||||||||||||||||||||||||
variables | Override Variables | List of variables to override. | N | |||||||||||||||||||||||||||
variablesUnresolved | Override Variables Resolution Disabled | Specification for whether or not
| Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||
complex vertexId | Complex | Specification for whether the task runs or skips on the day(s) indicated in the | Boolean; Valid values: true/false. Default is falseVertex Id | Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow. | Valid values:
| N | ||||||||||||||||||||||||
complexAdjective virtualResource | AdjectiveVirtual Resource | If For example, to specify "the 15th business day of the month," select | Valid values: Default is Every (0). | N | ||||||||||||||||||||||||||
Anchor | complexNoun - RC | complexNoun - RC | Noun | Deprecated (used only for single-value Nouns) If
| Valid values:
| N | ||||||||||||||||||||||||
Anchor | complexNouns - RC | complexNouns - RC | Noun(s) | If complex is specified; Used with complexAdjective , complexQualifiers , and complexNthAmount (if complexAdjective is Nth) to specify the type
| N |
| ||||||||||||||||||||||||
virtualResourceVar | Virtual Resource Variable | Name of a variable that will be resolved at run time to the name of the Virtual Resource to use. | N |
|
Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
businessDays | Business Day | Specification for whether the task runs or skips on all business days. | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complex | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexAdjective | Adjective | If For example, to specify "the 1st15th business day of the month," selectcomplexAdjective as 1st, complexNouns as select
is Month, and | ExampleValid values:
To specify a Custom Day, use the name of the Custom Day. For example:
XML
| Valid values:
| N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | complexNthAmount - RC | complexNthAmount - RC | Nth Amount | If | Integer. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | complexQualifier - RC | complexQualifier - RC | Qualifier | Deprecated (used only for single-value Qualifiers) If
| Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | complexQualifiers - RC | complexQualifiers - RC | Qualifier(s) |
Code Block | ||||
---|---|---|---|---|
| ||||
<complexQualifiers>
<complexQualifier>Month</complexQualifier>
</complexQualifiers> |
To specify a Custom Day, use the name of the Custom Day. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<complexQualifiers>
<complexQualifier>Jan</complexQualifier>
<complexQualifier>CustomDay1</complexQualifier>
</complexQualifiers> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"complexQualifiers": [
{
"value": "Jan"
},
{
"value": "CustomDay1"
}
] |
To specify a Local Custom Day, use the local attribute. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<complexQualifiers>
<complexQualifier local="true">CustomDay2</complexQualifier>
</complexQualifiers> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"complexQualifiers": [
{
"local": true,
"value": "CustomDay1"
}
] |
Valid values:
- Month
- Year
- January through December
- Custom Period
N
complexAdjustment
Adjustment
Specification for adjusting a complex day by a less or plus number of days or business days.
Valid values:
As String = None, As Value = 0
As String = Less, As Value = 1
As String = Plus, As Value = 2
Default is None (0).
N
complexAdjustmentAmount
Adjustment Amount
Number of days or business days to adjust a complex day.
Integer; Default is 1.
- Minimum is 1 if
complexAdjustmentType
is Day (1). - Minimum is 0 if
complexAdjustmentType
is Business Day (2).
Maximum is 366.
Y
(if complexAdjustment
is Less (1) or Plus (2) )
complexeAdjustmentType
Adjustment Type
Type of day by which to adjust a complex day.
Valid values:
As String = Day, As Value = 1
As String = Business Day, As Value = 2
Default is Day (1).
N
customDay
Custom Day
Specification that the task runs or skips on the day you select in the customDayChoice
.
N
customDayChoice
Custom Day Choice
If customDay
is specified; Custom day for which you are specifying run or skip criteria.
N
description
Description
Description of this record.
N
evaluateAt
Evaluate At
If variable
is specified; When you want the Controller to evaluate the variable.
Valid values:
Default is Trigger Time (1).
N
holiday
Holiday
Specification for whether or not the task runs or skips on holidays.
Boolean; Valid values: true/false. Default is false.
N
holidayAdjustment
Adjustment
Specification for adjusting a holiday by a less or plus number of days or business days.
Valid values:
As String = None, As Value = 0
As String = Less, As Value = 1
As String = Plus, As Value = 2
Default is None (0).
N
holidayAdjustmentAmount
Adjustment Amount
Number of days or business days to adjust a holiday.
Integer; Default is 1.
- Minimum is 1.
- Maximum is 366.
N
holidayAdjustmentType
Adjustment Type
Type of day by which to adjust a holiday.
Valid values:
As String = Day, As Value = 1
As String = Business Day, As Value = 2
Default is Day (1).
N
specificDay
Specific Day(s)
Specification for whether or not the task runs or skips on the day(s) you select in the specificDayFri
to specificDayWed
.
Boolean; Valid values: true/false. Default is false.
N
specificDayFri
Friday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
specificDayMon
Monday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
specificDaySat
Saturday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
specificDaySun
Sunday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
specificDayThu
Thursday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
specificDayTue
Tuesday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
specificDayWed
Wednesday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
task
Task
Task for which you are specifying run or skip criteria.
Y
type
Type
Specification for whether this criteria is for running or skipping the specified task.
Valid values:
Default is Run Criteria (1).
N
variable
Variable
Used with evaluateAt
, variableName
, variableOp
, and variableValue
; Instructs the Controller to run or not run the task, depending on the value of a specific variable.
N
variableName
Name
If variable
is specified; Name of the variable being evaluated.
N
variableOp
Operator
If variable
is specified; Operator to be used in the evaluation.
Valid values:
Default is (1).
N
variableValue
Value
If variable
is specified; Value or regular expression that the Controller should look for when evaluating the variable.
Maximum 40 alphanumerics.
N
- As String = Every, As Value = 0
- As String = 1st, As Value = 1
- As String = 2nd, As Value = 2
- As String = 3rd, As Value = 3
- As String = 4th, As Value = 4
- As String = 5th, As Value = 5
- As String = 6th, As Value = 6
Default is Every (0).
N
Anchor | ||||
---|---|---|---|---|
|
complexNoun
Noun
Deprecated (used only for single-value Nouns)
If complex
is specified; Used with complexAdjective
, complexQualifier
, and complexNthAmount
(if complexAdjective
is Nth) to specify the type of day you want to select. For example, to specify "the 1st business day of the month," select complexAdjective
is 1st, complexNoun
is Business Day, and complexQualifier
is Month.
Example: <complexNoun local="true">LCD1</complexNoun>
To specify a Custom Day, use the name of the Custom Day. For example:
XML
<complexNoun>CustomDay1</complexNoun>
JSON
"complexNoun": {
"value": "CustomDay1"
}
To specify a Local Custom Day, use the local attribute. For example:
XML
<complexNoun local="true">CustomDay2</complexNoun>
JSON
"complexNoun": {
"local": "true",
"value": "CustomDay2"
}
Note | ||
---|---|---|
| ||
The Default Calendar for the Workflow task is used to verify Custom Day references. |
Valid values:
- Sunday through Saturday
- Day (any day)
- Business Day (The business days specified in the calendar selected in the Workflow Calendar.)
- Custom Days specified in the calendar selected in the Workflow Calendar.
N
Anchor | ||||
---|---|---|---|---|
|
complexNouns
Noun(s)
If complex
is specified; Used with complexAdjective
, complexQualifiers
, and complexNthAmount
(if complexAdjective
is Nth) to specify the type of days you want to select.
For example, to specify "the 1st business day of the month," select complexAdjective
as 1st, complexNouns
as Business Day, and complexQualifiers
as Month.
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
<complexNouns>
<complexNoun>Business Day</complexNoun>
</complexNouns> |
To specify a Custom Day, use the name of the Custom Day. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<complexNouns>
<complexNoun>Monday</complexNoun>
<complexNoun>CustomDay1</complexNoun>
</complexNouns> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"complexNouns": [
{
"value": "Monday"
},
{
"value": "CustomDay1"
}
] |
To specify a Local Custom Day, use the local attribute. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<complexNouns>
<complexNoun local="true">CustomDay2</complexNoun>
</complexNouns> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"complexNouns": [
{
"local": true,
"value": "CustomDay1"
}
] |
Valid values:
- Sunday through Saturday
- Day (any day)
- Business Day (The business days specified in the calendar selected in the Workflow Calendar.)
- Custom Days specified in the calendar selected in the Workflow Calendar.
N
Anchor | ||||
---|---|---|---|---|
|
complexNthAmount
Nth Amount
If complexAdjective
is Nth; Sequential occurrence of the day selected in complexNouns
within the selected complexQualifiers
.
Integer.
N
Anchor | ||||
---|---|---|---|---|
|
complexQualifier
Qualifier
Deprecated (used only for single-value Qualifiers)
If complex
is specified; Used with the complexAdjective
, complexNoun
, and complexNthAmount
(if complexAdjective
is Nth) to specify the period for your selection formula. For example, to specify "the 1st business day of the month," select complexAdjective
is 1st, complexNoun
is Business Day, complexQualifier
is Month.
Example: <complexQualifier local="true">Year</complexQualifier>
To specify a Custom Day Period, use the name of the Custom Day Period. For example:
XML
<complexQualifier>CustomDayPeriod1</complexQualifier>
JSON
"complexQualifier": {
"value": "CustomDayPeriod1"
}
To specify a Local Custom Day Period, use the local attribute. For example:
XML
<complexQualifier local="true">CustomDayPeriod2</complexQualifier>
JSON
"complexQualifier": {
"local": "true",
"value": "CustomDayPeriod2"
}
Note | ||
---|---|---|
| ||
The Default Calendar for the Workflow task is used to verify Custom Day references. |
Valid values:
- Month
- Year
- January through December
- Custom Period
N
Anchor | ||||
---|---|---|---|---|
|
complexQualifiers
Qualifier(s)
If complex
is specified; Used with complexAdjective
, complexQualifiers
, and complexNthAmount
(if complexAdjective
is Nth) to specify the type of days you want to select.
For example, to specify "the 1st business day of the month," select complexAdjective
as 1st, complexNouns
as Business Day, and complexQualifiers
as Month.
Example:
Code Block | ||||
---|---|---|---|---|
| ||||
<complexQualifiers>
<complexQualifier>Month</complexQualifier>
</complexQualifiers> |
To specify a Custom Day, use the name of the Custom Day. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<complexQualifiers>
<complexQualifier>Jan</complexQualifier>
<complexQualifier>CustomDay1</complexQualifier>
</complexQualifiers> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"complexQualifiers": [
{
"value": "Jan"
},
{
"value": "CustomDay1"
}
] |
To specify a Local Custom Day, use the local attribute. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<complexQualifiers>
<complexQualifier local="true">CustomDay2</complexQualifier>
</complexQualifiers> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"complexQualifiers": [
{
"local": true,
"value": "CustomDay1"
}
] |
Valid values:
- Month
- Year
- January through December
- Custom Period
N
Anchor | ||||
---|---|---|---|---|
|
complexAdjustment
Adjustment
Specification for adjusting a complex day by a less or plus number of days or business days.
Valid values:
As String = None, As Value = 0
As String = Less, As Value = 1
As String = Plus, As Value = 2
Default is None (0).
N
Anchor | ||||
---|---|---|---|---|
|
complexAdjustmentAmount
Adjustment Amount
Number of days or business days to adjust a complex day.
Integer; Default is 1.
- Minimum is 1 if
complexAdjustmentType
is Day (1). - Minimum is 0 if
complexAdjustmentType
is Business Day (2).
Maximum is 366.
Y
(if complexAdjustment
is Less (1) or Plus (2) )
Anchor | ||||
---|---|---|---|---|
|
complexeAdjustmentType
Adjustment Type
Type of day by which to adjust a complex day.
Valid values:
As String = Day, As Value = 1
As String = Business Day, As Value = 2
Default is Day (1).
N
Anchor | ||||
---|---|---|---|---|
|
customDay
Custom Day
Specification that the task runs or skips on the day you select in the customDayChoice
.
N
Anchor | ||||
---|---|---|---|---|
|
customDayChoice
Custom Day Choice
If customDay
is specified; Custom day for which you are specifying run or skip criteria.
N
Anchor | ||||
---|---|---|---|---|
|
description
Description
Description of this record.
N
Anchor | ||||
---|---|---|---|---|
|
evaluateAt
Evaluate At
If variable
is specified; When you want the Controller to evaluate the variable.
Valid values:
- As String = Trigger Time, As Value = 1
- As String = Run Time, As Value = 2
Default is Trigger Time (1).
N
Anchor | ||||
---|---|---|---|---|
|
holiday
Holiday
Specification for whether or not the task runs or skips on holidays.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
holidayAdjustment
Adjustment
Specification for adjusting a holiday by a less or plus number of days or business days.
Valid values:
As String = None, As Value = 0
As String = Less, As Value = 1
As String = Plus, As Value = 2
Default is None (0).
N
Anchor | ||||
---|---|---|---|---|
|
holidayAdjustmentAmount
Adjustment Amount
Number of days or business days to adjust a holiday.
Integer; Default is 1.
- Minimum is 1.
- Maximum is 366.
N
Anchor | ||||
---|---|---|---|---|
|
holidayAdjustmentType
Adjustment Type
Type of day by which to adjust a holiday.
Valid values:
As String = Day, As Value = 1
As String = Business Day, As Value = 2
Default is Day (1).
N
Anchor | ||||
---|---|---|---|---|
|
specificDay
Specific Day(s)
Specification for whether or not the task runs or skips on the day(s) you select in the specificDayFri
to specificDayWed
.
Boolean; Valid values: true/false. Default is false.
N
Anchor | ||||
---|---|---|---|---|
|
specificDayFri
Friday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
Anchor | ||||
---|---|---|---|---|
|
specificDayMon
Monday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
Anchor | ||||
---|---|---|---|---|
|
specificDaySat
Saturday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
Anchor | ||||
---|---|---|---|---|
|
specificDaySun
Sunday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
Anchor | ||||
---|---|---|---|---|
|
specificDayThu
Thursday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
Anchor | ||||
---|---|---|---|---|
|
specificDayTue
Tuesday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
Anchor | ||||
---|---|---|---|---|
|
specificDayWed
Wednesday
If specificDay
is selected; Specification for whether or not the task runs or skips on this day of the week.
Boolean; Valid values: true/false. Default value is false.
N
Anchor | ||||
---|---|---|---|---|
|
task
Task
Task for which you are specifying run or skip criteria.
Y
Anchor | ||||
---|---|---|---|---|
|
type
Type
Specification for whether this criteria is for running or skipping the specified task.
Valid values:
- As String = Run Criteria, As Value = 1
- As String = Skip Criteria, As Value = 2
Default is Run Criteria (1).
N
Anchor | ||||
---|---|---|---|---|
|
variable
Variable
Used with evaluateAt
, variableName
, variableOp
, and variableValue
; Instructs the Controller to run or not run the task, depending on the value of a specific variable.
N
Anchor | ||||
---|---|---|---|---|
|
variableName
Name
If variable
is specified; Name of the variable being evaluated.
N
Anchor | ||||
---|---|---|---|---|
|
variableOp
Operator
If variable
is specified; Operator to be used in the evaluation.
Valid values:
- As String = =, As Value = 1
- As String = !=, As Value = 2
- As String = >, As Value = 3
- As String = >=, As Value = 4
- As String = <, As Value = 5
- As String = <=, As Value = 6
- As String = regex, As Value = 7 Default is (1).
Default is (1).
N
Anchor | ||||
---|---|---|---|---|
|
variableValue
Value
If variable
is specified; Value or regular expression that the Controller should look for when evaluating the variable.
Maximum 40 alphanumerics.
N
Anchor | ||||
---|---|---|---|---|
|
vertexId
Vertex ID
Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow.
Valid values:
- Any - The action applies to any instance of the specified task in the Workflow.
- <number> - The action applies only to this instance of the task in the Workflow.
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 |