Agent

For Agent-based task types only; Name of the Agent to use.

Y
(unless agentVar,
agentCluster,
agentClusterVar,
broadcastCluster, or
broadcastClusterVar
is specified)

agentVar,
broadcastCluster, and
broadcastClusterVar

Agent Cluster

For Agent-based task types only; Group of Agents, one of which the Controller will choose to run this task (compare with broadcastCluster).

Y
(unless agentClusterVar,
agent,
agentVar,
broadcastCluster, or
broadcastClusterVar
is specified)

agentClusterVar,
broadcastCluster, and
broadcastClusterVar

Agent Cluster Variable

For Agent-based task types only; Name of a variable that will be resolved at run time to the name of the Agent Cluster to use.

Format: ${variable name}.

Y
(unless agentCluster,
agent,
agentVar,
broadcastCluster, or
broadcastClusterVar
is specified)

agentCluster,
broadcastCluster, and
broadcastClusterVar

Agent Variable

For Agent-based task types only; Name of a variable that will be resolved at run time to the name of the Agent to use.

Format: ${variable name}.

Y
(unless agent,
agentCluster,
agentClusterVar,
broadcastCluster, or
broadcastClusterVar
is specified)

agent,
broadcastCluster, and
broadcastClusterVar

Average Instance Time

Average duration of all the runs of the task.

Long value of the current average run time (in seconds).

n/a

n/a

Easier to read version of Average Run Time.

String value of Average Run Time in human readable format

n/a

Cluster Broadcast

For Agent-based task types only; Group of Agents, all of which will run this task (compare with agentCluster). Each instance of the task running on its own Agent becomes a separate task instance record in the database and displays separately on the Activity Monitor.

Y
(unless broadcastClusterVar,
agent,
agentVar,
agentCluster, or
agentClusterVar,
is specified)

broadcastClusterVar,
agent,
agentVar,
agentCluster, and
agentClusterVar

Cluster Broadcast Variable

For Agent-based task types only; Name of a variable that will be resolved at run time to the name of the Cluster Broadcast to use.

Format: ${variable name}

Y
(unless broadcastCluster,
agent,
agentVar,
agentCluster, or
agentClusterVar,
is specified)

broadcastCluster,
agent,
agentVar,
agentCluster, and
agentClusterVar

CP Duration

Used with cpDurationUnit; Allows override of the estimated Critical Path Duration of the task when running in a Workflow. In most cases, cpDuration and cpDurationUnit are not used, which implies that the Controller will estimate the Critical Path Duration based on historical executions.

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

N

CP Duration Unit

Used with the cpDuration; type of Critical Path Duration. For example, for a Critical Path Duration of two minutes, specify 2 in cpDuration and Minutes in cpDurationUnit.

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

Credentials

For Agent-based task types only; Credentials under which an Agent runs this task. These credentials override any credentials provided in the Agent Details for any Agent running this task.

N

credentialsVar

Credentials Variable

For Agent-based task types only; Name of a variable that will be resolved at run time to the name of the Credentials to use.

N

credentials

n/a

User-Defined field.
 
Example: <customField1 label="Domain">web.com</customField1>

The label is included only if a value has been defined for the User Defined Task Field Label 1 Universal Controller system property.

N

n/a

User-Defined field.
 
Example: <customField2 label="Domain">web.com</customField2>

The label is included only if a value has been defined for the User Defined Task Field Label 2 Universal Controller system property.

N

Early Finish Day Constraint

If efType = Time (1); Specification for whether or not to advance the early 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

Early Finish Duration

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

Format = dd:hh:mm:ss

N

Early Finish

Specification that if the task instance finishes before the specified efDUration or efTime, the task instance is flagged as early.

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

N

Early Finish Duration Offset (-)

if efOffsetType is Duration (2); Duration offset to subtract from the Average Duration.

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

Y (if efOffsetType = Duration (2)).

efOffsetPercentage

Early Finish Duration Offset Unit

Used with the efOffsetDuration; Type of Early Finish Duration Offset. For example, for an Early Finish Duration Offset of two minutes, specify 2 in efOffsetDuration and Minutes in efOffsetDurationUnit.

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

Early Finish Offset Type

If efOffsetType is Percentage (1); Percentage offset to subtract from the Average Duration.

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

Y (if efOffsetType = Percentage (1)).

efOffsetDuration

Early Finish Offset Type

If efType = 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

Early Finish Time

If efType = Time (1); Time before which the task finish time is considered early. That is, the time at which the task should still be running.

Format = hh:mm, 24-hour time. Default is 00:00.

N

Early Finish Type

Type of early 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 efEnabled
is true)

enforceVariables

Enforce Variables

Specifies whether or not to enforce Launch with Variables... when launching a task using the User Interface. Not applicable for Web Service APIs.

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

N

n/a

For Modify task JSON web services; specification for whether or not to exclude related records (Actions, Mutually Exclusive Tasks, Notes, Variables in Tasks, Virtual Resources) from the update, even if they are provided in the request.
 

Valid values: true/false (default is false).

N

exclusiveWithSelf

Mutually Exclusive With Self

Specification for whether or not to allow the task to run concurrently with itself.

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

N

Execution Restriction

For tasks in a workflow; Specification for whether or not there is a restriction for this task to be run, skipped, or held.

Valid values:

• As String = -- None --, As Value = 0

• As String = Run, As Value = 1

• As String = Skip, As Value = 2

• As String = Hold, As Value = 3

Default is – None – (0).

N

n/a

Universal Controller release that the record was exported from.

read only

N

n/a

Record table information.

read only

N

First Execution

System-supplied; End Time of the first instance of this task to complete.

String value of the time that the task was first run.

n/a

Last Execution

System-supplied; End Time of the last instance of this task to complete.

String value of the time that the task was last run.

n/a

Last Instance Duration

Duration of the last run of the task.

Long value of the current last run time (in seconds).

n/a

lastRunTimeDisplay