...
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.
<condition type="
Default is Success.
| 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 |
...
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. | stepCodes - SC | 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. Valid values: Default is Continue/Success (1). | N | |||||||||||||
Anchor | stepCodes - SC |
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 |
...
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | execId - SA | execId - SA | Instance ID | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | execLookupOption - SA | execLookupOption - SA | Instance Lookup Option | If | Valid values: Default is Instance Name (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | execName - SA | execName - SA | Instance Name | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | execWorkflowName - SA | execWorkflowName - SA | Workflow Instance Name | If | N | Anchor | | execWorkflowNameCond - SA | execWorkflowNameCond - SA | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | execCriteria - SA | execCriteria - SA | Instance Criteria | If | Valid values: Default is Oldest Active Instance (1). | N |
Default value is Cancel (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execCriteria | Instance Criteria | If | Valid values: Default is Equals (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | limit - SA | limit - SA | Limit |
| N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | name - SA | name - SA | Name | Name of a variable to override. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | notificationOption - SA | notificationOption - SA | System Notification | Status of the specified | Valid values: Default is Operation Failure (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | operation - SA | operation - SA | System Operation | Specific system operation to perform. | Valid values: Default is Suspend AgentAdditional 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 | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
execLookupOption | Instance Lookup Option | If | Valid values:
Default is Instance Name (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
overrideTriggerDateOffset | 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 |
|
...
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. | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | complex - RC | complex - RC | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | complexAdjective - RC | complexAdjective - RC | Adjective | 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) |
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"
}
] |
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
complexNthAmount
Nth Amount
If complexAdjective
is Nth; Sequential occurrence of the day selected in complexNouns
within the selected complexQualifiers
.
Integer.
N
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 execName
Instance Name
If execLookupOption
is Instance Name; Name of the task instance to run the command against.
N
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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:
Html bobswift |
---|
<ul>
<li> As String = Equals, As Value = 1
<li> As String = Starts With, As Value = 2
<li> As String = Contains, As Value = 3
<li> As String = Ends With, As Value = 4
</ul> |
Default is Equals (1).
N
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
name
Name
Name of a variable to override.
N
Anchor | ||||
---|---|---|---|---|
|
notificationOption
System Notification
Status of the specified operation
that will trigger a system notification.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = -- None --, As Value = 0
<li> As String = Operation Failure, As Value = 1
<li> As String = Operation Success/Failure, As Value = 2
<li> As String = Operation Success, As Value = 3
</ul> |
Default is Operation Failure (1).
N
Anchor | ||||
---|---|---|---|---|
|
operation
System Operation
Specific system operation to perform.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = Suspend Agent, As Value = 1
<li> As String = Resume Agent, As Value = 2
<li> As String = Suspend Agent Cluster , As Value = 3
<li> As String = Resume Agent Cluster, As Value = 4
<li> As String = Suspend Cluster Membership, As Value = 5
<li> As String = Resume Cluster Membership, As Value = 6
<li> As String = Set Agent Task Execution Limit, As Value = 7
<li> As String = Set Cluster Task Execution Limit, As Value = 8
<li> As String = Set Virtual Resource Limit, As Value = 9
<li> As String = Task Instance Command, As Value = 10
<li> As String = Launch Task, As Value = 11
<li> As String = Trigger Now, As Value = 12
<li> As String = Enable Trigger, As Value = 13
<li> As String = Disable Trigger, As Value = 14
</ul> |
Default is Suspend Agent (1).
N
Anchor | ||||
---|---|---|---|---|
|
overrideTriggerDateOffset
Date Offset value of trigger to fire.
(unless
overrideTriggerDateTime
is true)Anchor | ||||
---|---|---|---|---|
|
overrideTriggerDateTime
Request parameter to enable/disable override functionality.
Boolean value (true / false). Default is false.
Anchor | ||||
---|---|---|---|---|
|
overrideTriggerTime
Time of the trigger to fire.
(if
overrideTriggerDateTime
is true)Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
task
Task Reference
- If
execLookupOption
is Instance Name/Task or Task; Name of the task for which the task instance was run. - If
operation
is Launch Task; Name of the task to launch.
N
taskVar
Anchor | ||||
---|---|---|---|---|
|
taskLimitType
Task Execution Limit
If operation
is Set Agent Task Execution Limit or Set Cluster Task Execution Limit; Specification for whether a limited or unlimited number of task instances can be run concurrently on the specified Agent / Agent Cluster.
Valid values:
Html bobswift |
---|
<ul>
<li> As String = Unlimited, As Value = 1
<li> As String = Limited, As Value = 2
</ul> |
Default is Unlimited.
N
Anchor | ||||
---|---|---|---|---|
|
taskVar
Task Reference Variable
- If
execLookupOption
is Instance Name/Task or Task; Name of a variable that will be resolved at run time to the name of the task for which the task instance was run. - If
operation
is Launch Task; Name of a variable that will be resolved at run time to the name of the task to launch.
N
task
Anchor | ||||
---|---|---|---|---|
|
trigger
Trigger Reference
If operation
is Trigger Now, Enable Trigger, or Disable Trigger; Name of the trigger.
N
triggerVar
Anchor | ||||
---|---|---|---|---|
|
triggerVar
Trigger Reference Variable
If operation
is Trigger Now, Enable Trigger, or Disable Trigger; Name of a variable that will be resolved at run time to the name of the trigger.
N
trigger
Anchor | ||||
---|---|---|---|---|
|
value
Value
Value of a variable to override.
N
Anchor | ||||
---|---|---|---|---|
|
variables
Override Variables
List of variables to override.
N
Anchor | ||||
---|---|---|---|---|
|
variablesUnresolved
Override Variables Resolution Disabled
Specification for whether or not variables
resolution should be disabled to allow for passing unresolved variable values.
- If
variables
resolution is disabled, any unresolved variables will be resolved in the context of the launched or triggered task instance. - If
variables
resolution is not disabled,variables
will be resolved prior to the execution of the Launch Task or Trigger Nowoperation
.
Boolean; Valid values: true/false. Default is false.
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
Anchor | ||||
---|---|---|---|---|
|
virtualResource
Virtual Resource
If operation
is Set Virtual Resource Limit; Virtual resource for which a virtual resource limit is to be set.
N
virtualResourceVar
Anchor | ||||
---|---|---|---|---|
|
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
virtualResource
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 15th business day of the month," select Nth, complexNoun complexQualifier 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" }
| Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | complexQualifiers - RC | complexQualifiers - RC | Qualifier(s) | If
Default is Every (0). | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexNoun | Noun | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | holidayAdjustmentAmount - RC | holidayAdjustmentAmount - RC | Adjustment Amount | Number of days or business days to adjust a holiday. | Integer; Default is 1.
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | holidayAdjustmentType - RC | holidayAdjustmentType - RC | Adjustment Type | Type of day by which to adjust a holiday. | Valid values:
Default is Day (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | specificDay - RC | specificDay - RC | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | specificDayFri - RC | specificDayFri - RC | Friday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | specificDayMon - RC | specificDayMon - RC | Monday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | specificDaySat - RC | specificDaySat - RC | Saturday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | specificDaySun - RC | specificDaySun - RC | Sunday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | specificDayThu - RC | specificDayThu - RC | Thursday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | specificDayTue - RC | specificDayTue - RC | Tuesday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | specificDayWed - RC | specificDayWed - RC | Wednesday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | task - RC | task - RC | Task | Task for which you are specifying run or skip criteria. | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | type - RC | type - RC | Type | Specification for whether this criteria is for running or skipping the specified task. | Valid values: Default is Run Criteria (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | variable - RC | variable - RC | Variable | Used with | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | variableName - RC | variableName - RC | Name | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | variableOp - RC | variableOp - RC | Operator | If | Deprecated (used only for single-value Nouns) If Code Block |
<complexNoun local="true">LCD1</complexNoun> Code Block |
<complexNoun>CustomDay1</complexNoun> Code Block |
"complexNoun": { Code Block |
<complexNoun local="true">CustomDay2</ complexQualifier> </complexQualifiers>complexNoun> Code Block |
"complexNoun": { " CustomDay1CustomDay2"
| Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | holidayAdjustment - RC | holidayAdjustment - RC | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | complexAdjustmentAmount - RC | complexAdjustmentAmount - RC | Adjustment Amount | Number of days or business days to adjust a complex day. | Integer; Default is 1.
Maximum is 366. | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | complexeAdjustmentType - RC | complexeAdjustmentType - RC | Adjustment Type | Type of day by which to adjust a complex day. | Valid values:
Default is Day (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | customDay - RC | customDay - RC | Custom Day | Specification that the task runs or skips on the day you select in the | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | customDayChoice - RC | customDayChoice - RC | Custom Day Choice | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | description - RC | description - RC | Description | Description of this record. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | evaluateAt - RC | evaluateAt - RC | Evaluate At | If | Valid values: Default is Trigger Time (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | holiday - RC | holiday - RC | Holiday | Specification for whether or not the task runs or skips on holidays. | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | holidayAdjustment - RC | holidayAdjustment - RC | Adjustment | Specification for adjusting a holiday by a less or plus number of days or business days. | Valid values:
Default is None (0). | N |
| Valid values:
| N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexNouns | Noun(s) | If For example, to specify "the 1st business day of the month," select Example:
To specify a Custom Day, use the name of the Custom Day. For example:
| Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexNthAmount | Nth Amount | If | Integer. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexQualifier | Qualifier | Deprecated (used only for single-value Qualifiers) If
| Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexQualifiers | Qualifier(s) | If For example, to specify "the 1st business day of the month," select Example:
| Valid values:
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexAdjustment | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexAdjustmentAmount | Adjustment Amount | Number of days or business days to adjust a complex day. | Integer; Default is 1.
Maximum is 366. | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
complexeAdjustmentType | Adjustment Type | Type of day by which to adjust a complex day. | Valid values:
Default is Day (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customDay | Custom Day | Specification that the task runs or skips on the day you select in the | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
customDayChoice | Custom Day Choice | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description | Description | Description of this record. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
evaluateAt | Evaluate At | If | 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:
Default is None (0). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
holidayAdjustmentAmount | Adjustment Amount | Number of days or business days to adjust a holiday. | Integer; Default is 1.
| N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
holidayAdjustmentType | Adjustment Type | Type of day by which to adjust a holiday. | Valid values:
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 | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specificDayFri | Friday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specificDayMon | Monday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specificDaySat | Saturday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specificDaySun | Sunday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specificDayThu | Thursday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specificDayTue | Tuesday | If | Boolean; Valid values: true/false. Default value is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
specificDayWed | Wednesday | If | 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 | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
variableName | Name | If | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
variableOp | Operator | If | Valid values:
Default is (1). | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
variableValue | Value | If | Maximum 40 alphanumerics. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
vertexId | Vertex ID | Numerical ID of the task that identifies it uniquely from other tasks of the same type in the Workflow. | Valid values:
| N |