Versions Compared

Key

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

...

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:

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 complexAdjectivecomplexQualifiers, 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 complexAdjectivecomplexQualifiers, 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:

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:

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:

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


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