Versions Compared

Old Version 16

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
alias - WV
alias - WV
alias

n/a

Alias used for the task to be inserted within the workflow; specifically, the value of ops_exec_workflow_vertex.name.


N


Anchor
task - WV
task - WV
task

Task Name

Name of the task to be inserted within the workflow.
 
Example: <task sysId="true">a8756a120a00010357097d05fa5c558e</task>


Y


Anchor
vertexId - WV
vertexId - WV
vertexId

n/a

Vertex ID of the task to be inserted within the workflow.
 
Each task within a Workflow must have a unique Vertex ID to distinguish it from other tasks, if any, of the same name.


Y


vertexX

n/a

x-coordinate of the task to be inserted within the workflow.

Default is 0.

N


vertexY

n/a

y-coordinate of the task to be inserted within the workflow.

Default is 0.

N


...

sourceId

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
condition - WE
condition - WE
condition

n/a

Dependency condition between the source and target tasks of this edge (connector).
 
Example: <condition type="Exit Code">123</condition>

Valid values:

  • Success
  • Failure
  • Success/Failure
  • Exit Code; Format: Numeric. Use commas to list a series of exit codes; use hyphens to specify a range. Example: 1,5, 22-30
  • Step Conditions; Format: Step:Procedure:Program:Condition codes. Example: *:*:*:JCLERR
  • Variable

Default is Success.
 
For example:
 
   <condition>Success</condition>
   <condition>Failure</condition>
   <condition>Success/Failure</condition>
   <condition>1,5,22-30</condition>
   <condition>*:*:*:JCLERR</condition>
   <condition>S1:PROC1:PGM1:U016</condition>
   <condition type="Exit Code">1,5,22-30</condition>
   <condition type="Step Condition">*:*:*:JCLERR</condition>
   <condition type="Step Condition">*:*:*:S0C4</condition>
   <condition type="Step Condition">S1:PROC1:PGM1:U016</condition>
   <variableCondition>
           <firstValue>${_varToLowerCase('variableName')}</firstValue>
           <operator>=</operator>
           <secondValue>${var2}</secondValue>
   </variableCondition>

Step Condition is valid for z/OS tasks only.
 
Success/Failure and Failure are not valid for Workflow, Timer, and Manual tasks.
 

Note
titleNote

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


Anchor
points - WE
points - WE
points

n/a

If straightEdge is false; x and y coordinates of the Edge angles.

For example:
 

Anchor
sourceId - WEsourceId - WE
Panel

Y


Html bobswift
<pre>
&lt;points&gt;
	&lt;point x="280" y="300" /&gt;
&lt;/points&gt;
</pre>



Y


Anchor
sourceId - WE
sourceId - WE
sourceId

n/a

Vertex ID of the source task.
 
Example: <sourceId taskName="Sleep 10"taskAlias="Sleep 10-alias">20</sourceId>


Y


Anchor
straightEdge - WE
straightEdge - WE
straightEdge

n/a

Specification for whether the edge is straight or bent.

Boolean; Valid values: true/false. Default is true.

N


Anchor
targetId - WE
targetId - WE
targetId

n/a

Vertex ID of the target task.
 
Example: <targetID taskName="Sleep 10"taskAlias="Sleep 10-alias">20</targetId>


Y


...

stepCodes - SC
  • , As Value = 1
  • As String = Continue/Failed, As Value = 2
  • As String = Halt/Failed, As Value = 3
  • As String = Askoper, As Value = 4

Default is Continue/Success (1).

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
programName - SC
programName - SC
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 - SC
pstepName - SC
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
stepAction - SC
stepAction - SC
stepAction

Action

Action to take and the task status to set if the Step Condition matches.

Valid values:Default is

  • As String = Continue/Success
(1).

N

Anchor

N


Anchor
stepCodes - SC
stepCodes - SC
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


Anchor
stepName - SC
stepName - SC
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
stepOrder - SC
stepOrder - SC
stepOrder

Evaluation Order

Order for step condition evaluation.

Step conditions with a lower order are evaluated before step conditions with a higher order.

N


Anchor
sysId - SC
sysId - SC
sysId

n/a

sys_id used within the Controller to identify this Step Condition.


N

...

execCriteriaexecIdexecLookupOptionInstance Lookup Option

Valid values:

Default value is Cancel (1).

execNamenotificationOptionoperation

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
actionCriteriaTask - SA
actionCriteriaTask - SA
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


Anchor
agent - SA
agent - SA
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

Anchor
agentCluster - SA
agentCluster - SA
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

Anchor
agentClusterVar - SA
agentClusterVar - SA
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

Anchor
agentVar - SA
agentVar - SA
agentVar

Agent Variable

Name of a variable that will be resolved at run time to the name of the Agent to use.


N

agent

Anchor
description - SA
description - SA
description

Description

Description of this System Operation Step Action.


N


Anchor
execCommand - SA
execCommand - SA
execCommand

Command

If operation is Run Task Instance Command; Type of task instance command to run.

execCriteria - SA

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

Anchor
execId - SAexecId - SA

Instance ID

If execLookupOption is Instance Id; ID of task instance to run the command against.

N

Anchor
execLookupOption - SAexecLookupOption - SA

N

Anchor
execCriteria - SA
  • As String = Cancel, As Value = 1
  • As String = Force Finish, As Value = 2
  • As String = Force Finish (Halt), As Value = 3
  • As String = Force Finish/Cancel, As Value = 4
  • As String = Force Finish/Cancel (Halt), As Value = 5
  • As String = Skip, As Value = 6
  • As String = Hold, As Value = 7
  • As String = Release, As Value = 8
  • As String = Release Recursive, As Value = 9
  • As String = Clear All Dependencies, As Value = 10
  • As String = Clear Exclusive, As Value = 11
  • As String = Clear Predecessors, As Value = 12
  • As String = Clear Resources, As Value = 13
  • As String = Unskip, As Value = 14
  • As String = Clear Timewait, As Value = 15
  • As String = Re-run, As Value = 16

Default value is Cancel (1).

N


Anchor
execCriteria - SA
execCriteria - SA
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:

  • As String = Oldest Active Instance, As Value = 1
  • As String = Newest Active Instance, As Value = 2
  • As String = Oldest Instance, As Value = 3
  • As String = Newest Instance, As Value = 4

Default is Oldest Active Instance (1).

  • An Active task instance is an instance that is not in any of these statuses: Skipped, Finished, Success.
  • An Unskip command can use only the Newest Instance and Oldest Instance criteria; an active instance cannot be unskipped.

N


Anchor
execId - SA
execId - SA
execId

Instance ID

If execLookupOption is Instance Id; ID of task instance to run the command against.


N


Anchor
execLookupOption - SA
execLookupOption - SA
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:

  • As String = Instance Name, As Value = 1
  • As String = Instance Name/Task, As Value = 2
  • As String = Instance Id, As Value = 3
  • As String = Task, As Value = 4

Default is Instance Name (1).

N


Anchor
execName - SA
execName - SA
execName

Instance Name

If execLookupOption is Instance Name; Name of the task instance to run the command against.


N


Anchor
execWorkflowName - SA
execWorkflowName - SA
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 - SA
execWorkflowNameCond - SA
execWorkflowNameCond

Workflow Instance Name Condition

If operation is Run Task Instance Command; Specification for how to search for the task instance to run a command againstType 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.

execName - SA

Instance Name

If execLookupOption is Instance Name; Name of the task instance to run the command against

Valid values:

Default is Instance Name (1).

N

Anchor
execName - SA
  • As String = Equals, As Value = 1
  • As String = Starts With, As Value = 2
  • As String = Contains, As Value = 3
  • As String = Ends With, As Value = 4

Default is Equals (1).

N


Anchor
execWorkflowName limit - SAexecWorkflowName
limit - SA
execWorkflowNamelimit

Workflow Instance NameLimit

  • 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
  • Set Agent Task Execution Limit or Set Cluster Task Execution Limit, and taskLimitType 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
execWorkflowNameCond name - SAexecWorkflowNameCond
name - SA
execWorkflowNameCondname

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)

Name of a variable to override.


N


Anchor
limit notificationOption - SAlimit
notificationOption - SA
limitnotificationOption

Limit

  • If operation is Set Agent Task Execution Limit or Set Cluster Task Execution Limit, and taskLimitType 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

    System Notification

    Status of the specified operation that will trigger a system notification.

    Valid values:

    • As String = -- None --, As Value = 0
    • As String = Operation Failure, As Value = 1
    • As String = Operation Success/Failure, As Value = 2
    • As String = Operation Success, As Value = 3

    Default is Operation Failure (1).

    N


    Anchor
    name operation - SAname
    operation - SA
    nameoperation

    Name

    Name of a variable to override.

    N

    Anchor
    notificationOption - SAnotificationOption - SA

    System Notification

    Status of the specified operation that will trigger a system notification.

    Valid values:

    Default is Operation Failure (1).

    N

    Anchor
    operation - SAoperation - SA

    System Operation

    Specific system operation to perform.

    Valid values:

    System Operation

    Specific system operation to perform.

    Valid values:

    • As String = Suspend Agent, As Value = 1
    • As String = Resume Agent, As Value = 2
    • As String = Suspend Agent Cluster , As Value = 3
    • As String = Resume Agent Cluster, As Value = 4
    • As String = Suspend Cluster Membership, As Value = 5
    • As String = Resume Cluster Membership, As Value = 6
    • As String = Set Agent Task Execution Limit, As Value = 7
    • As String = Set Cluster Task Execution Limit, As Value = 8
    • As String = Set Virtual Resource Limit, As Value = 9
    • As String = Task Instance Command, As Value = 10
    • As String = Launch Task, As Value = 11
    • As String = Trigger Now, As Value = 12
    • As String = Enable Trigger, As Value = 13
    • As String = Disable Trigger, As Value = 14

    Default is Suspend Agent (1).

    N


    Anchor
    overrideTriggerDateOffset - SA
    overrideTriggerDateOffset - SA
    overrideTriggerDateOffset

    		Override Date OffsetOverride date offset.

    Date Offset value of trigger to fire.

    		N
    (unless overrideTriggerDateTime is true)

    Anchor
    overrideTriggerDateTime - SA
    overrideTriggerDateTime - SA
    overrideTriggerDateTime

    		Override Trigger Date/Time

    Request parameter to enable/disable override functionality.

    Boolean value (true / false).  Default is false.

    		N

    Anchor
    overrideTriggerTime - SA
    overrideTriggerTime - SA
    overrideTriggerTime

    		Override TimeOverride time.

    Time of the trigger to fire.

    		Y
    (if overrideTriggerDateTime is true)

    Anchor
    programName - SA
    programName - SA
    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 - SA
    pstepName - SA
    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 - SA
    stepCodes - SA
    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 - SA
    stepName - SA
    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 - SA
    task - SA
    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 - SA
    taskLimitType - SA
    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:

    • As String = Unlimited, As Value = 1
    • As String = Limited, As Value = 2

    Default is Unlimited.

    N


    Anchor
    taskVar - SA
    taskVar - SA
    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 - SA
    trigger - SA
    trigger

    Trigger Reference

    If operation is Trigger Now, Enable Trigger, or Disable Trigger; Name of the trigger.


    N

    triggerVar

    Anchor
    triggerVar - SA
    triggerVar - SA
    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 - SA
    value - SA
    value

    Value

    Value of a variable to override.


    N


    Anchor
    variables - SA
    variables - SA
    variables

    Override Variables

    List of variables to override.


    N


    Anchor
    variablesUnresolved - SA
    variablesUnresolved - SA
    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 Now operation.

    Boolean; Valid values: true/false. Default is false.

    N


    Anchor
    vertexId - SA
    vertexId - SA
    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 - SA
    virtualResource - SA
    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 - SA
    virtualResourceVar - SA
    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

    ...

    Property

    UI Field Name

    Description

    Specifications

    Required

    Mutually Exclusive With

    Anchor
    businessDays - RC
    businessDays - RC
    businessDays

    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

    Complex

    Specification for whether the task runs or skips on the day(s) indicated in the complexAdjective, complexNouns, and complexQualifiers.

    Boolean; Valid values: true/false. Default is false.

    N


    Anchor
    complexAdjective - RC
    complexAdjective - RC
    complexAdjective

    Adjective

    If complex is specified; Used with complexNouns, complexQualifiers, and complexNthAmount (if complexAdjective is Nth) to specify which in a series of days you want to select.

    For example, to specify "the 15th business day of the month," select complexAdjective is Nth, complexNouns is Business Day, complexQualifiers is Month, and complexNthAmount is 15.

    Valid values:

    is Nth, complexNouns is Business Day, complexQualifiers is Month, and complexNthAmount is 15.

    Valid values:

    • 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 - RC
    complexNoun - RC
    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
    titleNote

    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 - RC
    complexNouns - RC
    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
    languagetext
    linenumberstrue
    <complexNouns>
  <complexNoun>Business Day</complexNoun>
</complexNouns>


    To specify a Custom Day, use the name of the Custom Day. For example:
     
    XML

    Code Block
    languagetext
    linenumberstrue
    <complexNouns>
  <complexNoun>Monday</complexNoun>
  <complexNoun>CustomDay1</complexNoun>
</complexNouns>

     
    JSON

    Code Block
    languagetext
    linenumberstrue
    "complexNouns": [
  {
    "value": "Monday"
  },
  {
    "value": "CustomDay1"
  }
]


    To specify a Local Custom Day, use the local attribute. For example:
     
    XML

    Code Block
    languagetext
    linenumberstrue
    <complexNouns>
  <complexNoun local="true">CustomDay2</complexNoun>
</complexNouns>

     
    JSON

    Code Block
    languagetext
    linenumberstrue
    "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 - RC
    complexNthAmount - RC
    complexNthAmount

    Nth Amount

    If complexAdjective is Nth; Sequential occurrence of the day selected in complexNouns within the selected complexQualifiers.

    Integer.

    N


    Anchor
    complexQualifier - RC
    complexQualifier - RC
    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
    titleNote

    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 - RC
    complexQualifiers - RC
    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
    languagetext
    linenumberstrue
    <complexQualifiers>
  <complexQualifier>Month</complexQualifier>
</complexQualifiers>

     
    To specify a Custom Day, use the name of the Custom Day. For example:
     
    XML

    Code Block
    languagetext
    linenumberstrue
    <complexQualifiers>
  <complexQualifier>Jan</complexQualifier>
  <complexQualifier>CustomDay1</complexQualifier>
</complexQualifiers>

     
    JSON

    Code Block
    languagetext
    linenumberstrue
    "complexQualifiers": [
  {
    "value": "Jan"
  },
  {
    "value": "CustomDay1"
  }
]


     
    To specify a Local Custom Day, use the local attribute. For example:
     
    XML

    Code Block
    languagetext
    linenumberstrue
    <complexQualifiers>
  <complexQualifier local="true">CustomDay2</complexQualifier>
</complexQualifiers>


     
    JSON

    Code Block
    languagetext
    linenumberstrue
    "complexQualifiers": [
  {
    "local": true,
    "value": "CustomDay1"
  }
]


    Valid values:

    • Month
    • Year
    • January through December
    • Custom Period

    N


    Anchor
    holidayAdjustment - RC
    holidayAdjustment - RC
    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 - RC
    complexAdjustmentAmount - RC
    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 - RC
    complexeAdjustmentType - RC
    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 - RC
    customDay - RC
    customDay

    Custom Day

    Specification that the task runs or skips on the day you select in the customDayChoice.


    N


    Anchor
    customDayChoice - RC
    customDayChoice - RC
    customDayChoice

    Custom Day Choice

    If customDay is specified; Custom day for which you are specifying run or skip criteria.


    N


    Anchor
    description - RC
    description - RC
    description

    Description

    Description of this record.


    N


    Anchor
    evaluateAt - RC
    evaluateAt - RC
    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 - RC
    holiday - RC
    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 - RC
    holidayAdjustment - RC
    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 - RC
    holidayAdjustmentAmount - RC
    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 - RC
    holidayAdjustmentType - RC
    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 - RC
    specificDay - RC
    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 - RC
    specificDayFri - RC
    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 - RC
    specificDayMon - RC
    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 - RC
    specificDaySat - RC
    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 - RC
    specificDaySun - RC
    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 - RC
    specificDayThu - RC
    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 - RC
    specificDayTue - RC
    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 - RC
    specificDayWed - RC
    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 - RC
    task - RC
    task

    Task

    Task for which you are specifying run or skip criteria.


    Y


    Anchor
    type - RC
    type - RC
    type

    Type

    Specification for whether this criteria is for running or skipping the specified task.

    Valid values:

    Valid values:

    • As String = Run Criteria, As Value = 1
    • As String = Skip Criteria, As Value = 2

    Default is Run Criteria (1).

    N


    Anchor
    variable - RC
    variable - RC
    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 - RC
    variableName - RC
    variableName

    Name

    If variable is specified; Name of the variable being evaluated.


    N


    Anchor
    variableOp - RC
    variableOp - RC
    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 - RC
    variableValue - RC
    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
    vertex - RC
    vertex - RC
    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


    ...