Workflow Task - Workflow Task-Related Records Properties

Owned by
Former user (Deleted)
Last updated: Jan 30, 2023 by
Stonebranch
16 min read

Workflow Vertices

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.
 
Example: <task sysId="true">a8756a120a00010357097d05fa5c558e</task>


Y


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


Workflow Edges

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).
 
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

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


points

n/a

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

For example:
 

Y


sourceId

n/a

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


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.
 
Example: <targetID taskName="Sleep 10"taskAlias="Sleep 10-alias">20</targetId>


Y


Variable Conditions

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

firstValue

First Value

First Value of the condition evaluation.


Default is an empty/blank string.

N


operator

Operator

Operator of the condition evaluation.

Valid values:

  • 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


Variable Condition: JSON and XML Examples

XML

JSON

 XML
<variableCondition>
       <firstValue>${_varToLowerCase('variableName')}</firstValue>
       <operator>=</operator>
       <secondValue>${var2}</secondValue>
</variableCondition>
 JSON

"condition": {
         "firstValue": "${_varToLowerCase('variableName')}",
         "operator": "=",
         "secondValue": "${var2}",
         "type": "Variable"
}


Step Conditions

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:

  • As String = Continue/Success, 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).

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

Step Actions

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:

  • 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


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


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:

  • 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


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:

  • 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


limit

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.


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:

  • 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


operation

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


overrideTriggerDateOffset

Override Date OffsetOverride 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 TimeOverride 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

  • 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

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


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

trigger

Trigger Reference

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


N

triggerVar

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

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 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


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


virtualResource

Virtual Resource

If operation is Set Virtual Resource Limit; Virtual resource for which a virtual resource limit is to be set.


N

virtualResourceVar

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

Run Criteria

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 complexAdjective, complexNouns, and complexQualifiers.

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

N


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:

  • 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


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


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:

<complexNouns>
  <complexNoun>Business Day</complexNoun>
</complexNouns>


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

<complexNouns>
  <complexNoun>Monday</complexNoun>
  <complexNoun>CustomDay1</complexNoun>
</complexNouns>

 
JSON

"complexNouns": [
  {
    "value": "Monday"
  },
  {
    "value": "CustomDay1"
  }
]


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

<complexNouns>
  <complexNoun local="true">CustomDay2</complexNoun>
</complexNouns>

 
JSON

"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 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


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:

<complexQualifiers>
  <complexQualifier>Month</complexQualifier>
</complexQualifiers>

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

<complexQualifiers>
  <complexQualifier>Jan</complexQualifier>
  <complexQualifier>CustomDay1</complexQualifier>
</complexQualifiers>

 
JSON

"complexQualifiers": [
  {
    "value": "Jan"
  },
  {
    "value": "CustomDay1"
  }
]


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

<complexQualifiers>
  <complexQualifier local="true">CustomDay2</complexQualifier>
</complexQualifiers>


 
JSON

"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:

  • As String = Trigger Time, As Value = 1
  • As String = Run Time, As Value = 2

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:

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

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:

  • 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


variableValue

Value

If variable is specified; Value or regular expression that the Controller should look for when evaluating the variable.

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:

  • 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

description

Task Critical Endpoint Description

User-defined description of this Critical Endpoint.


N


lfDayConstraint

Late Finish Day Constraint

If lfType = Time (1); Specification for whether or not to advance the late finish time to another day.

Valid values:

  • As String = None, As Value = 0

  • As String = Same Day, As Value = 1

  • As String = Next Day, As Value = 2

  • As String = Next Business Day, As Value = 3

  • As String = Sunday, As Value = 4

  • As String = Monday, As Value = 5

  • As String = Tuesday, As Value = 6

  • As String = Wednesday, As Value = 7

  • As String = Thursday, As Value = 8

  • As String = Friday, As Value = 9

  • As String = Saturday, As Value = 10

  • As String = Nth Day, As Value = 11

Default is None (0).


N


lfDuration

Late Finish Duration

If lfType = Duration (2); Longest amount of time this task instance should take to run.

Format = dd:hh:mm:ss

N


lfEnabled

Late Finish

Specification that if the task instance finishes after the specified lfDUration or lfTime, the task instance is flagged as late.

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

N


lfOffsetDuration

Late Finish Duration Offset ( + )

if lfOffsetType is Duration (2); Duration offset to add to the Average Duration.

Integer; Valid values are 0 or greater. Variables and Functions are supported.

Y (if lfOffsetType = Duration (2)).

lfOffsetPercentage

lfOffsetDurationUnit

Late Finish Duration Offset Unit

Used with the lfOffsetDuration; type of Late Finish Duration Offset.

For example, for a Late Finish Duration Offset of two minutes, specify 2 in lfOffsetDuration and Minutes in lfOffsetDurationUnit.

Valid Values:

  • As String = Seconds, As Value = 1

  • As String = Minutes, As Value = 2

  • As String = Hours, As Value = 3

Default is Minutes (2).

N


lfOffsetPercentage

Late Finish Percentage Offset ( + )

If lfOffsetType is Percentage (1); Percentage offset to add to the Average Duration.

Integer; Valid values are 0 to 100. Default is 0.

Y (if lfOffsetType = Percentage (1)).

lfOffsetDuration

lfOffsetType

Late Finish Offset Type

If lfType is Average Duration (5); Specification for the type of offset to apply to the Average Duration.

Valid Values:

  • As String = Percentage, As Value = 1

  • As String = Duration, As Value = 2

Default is Percentage (1).

N


lfTime

Late Finish Time

If lfType = Time (1); Time after which the task finish time is considered late.

Format = hh:mm. Default is 00:00.

N


lfType

Late Finish Type

Type of late finish.

Valid values:

  • As String = Time, As Value = 1

  • As String = Duration, As Value = 2

  • As String = Average Duration, As Value = 5

Default is Time (1).

Y
(if lfEnabled
is true)


lsDayConstraint

Late Start Day Constraint

If lsType = Time (1); Specification for whether or not to advance the late start time to another day.

Valid values:

  • As String = None, As Value = 0

  • As String = Same Day, As Value = 1

  • As String = Next Day, As Value = 2

  • As String = Next Business Day, As Value = 3

  • As String = Sunday, As Value = 4

  • As String = Monday, As Value = 5

  • As String = Tuesday, As Value = 6

  • As String = Wednesday, As Value = 7

  • As String = Thursday, As Value = 8

  • As String = Friday, As Value = 9

  • As String = Saturday, As Value = 10

  • As String = Nth Day, As Value = 11

Default is None (0).


N


lsDuration

Late Start Duration

If lsType = Duration (2); Duration (amount of relative time) after which the task is considered to have started late.

Format = dd:hh:mm:ss

N


lsEnabled

Late Start

Specification that if the task instance starts after the specified lsDuration or lsTime, the task instance is flagged as late.

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

N


lsTime

Late Start Time

If lsType = Time (1); Time after which the task start time is considered late.

Format = hh:mm. Default is 00:00.

N


lsType

Late Start Type

Type of late start.

Valid values:

  • As String = Time, As Value = 1

  • As String = Duration, As Value = 2

Default is Time (1).


Y
(if lsEnabled
is true)


task

Task

Task for which you are specifying critical endpoint


Y


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