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

Easier to read version of Average Run Time.

String value of Average Run Time in human readable format

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.

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.

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.

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.

• As String = Seconds, As Value = 1
• As String = Minutes, As Value = 2
• As String = Hours, As Value = 3

Default is Minutes (2).

Early Finish Offset Type

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

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.

Y
(if efEnabled
is true)

n/a

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.

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.

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.

Last Instance Duration

Duration of the last run of the task.

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

n/a

Easier to read version of Last Run Time

String value of Last Run Time in human readable format

Late Finish Day Constraint

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

N

Late Finish Duration

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

Format = dd:hh:mm:ss

N

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

Late Finish Duration Offset ( + )

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

lfOffsetPercentage

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.

• As String = Seconds, As Value = 1
• As String = Minutes, As Value = 2
• As String = Hours, As Value = 3

Default is Minutes (2).

Late Finish Percentage Offset ( + )

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

lfOffsetDuration

Late Finish Offset Type

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

• As String = Percentage, As Value = 1
• As String = Duration, As Value = 2

Default is Percentage (1).

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

Late Finish Type

Type of late finish.

Y
(if lfEnabled
is true)

Applicable only to Extension-based Universal Tasks;, default is Inherited.

For all other task types, logLevel is not applicable.

Valid values:

• Inherited
• Trace
• Debug
• Info
• Warn
• Error
• Severe

Late Start Day Constraint

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

N

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

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

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

Late Start Type

Type of late start.

Y
(if lsEnabled
is true)

Highest Instance Time

Longest duration that the task ran.

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

n/a

Easier to read version of Maximum Run Time

String value of Maximum Run Time in human readable format

Lowest Instance Time

Shortest duration that the task ran.

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

n/a

Easier to read version of Minimum Run Time

String value of Minimum Run Time in human readable format

Task Name

Name of this task.

Y

Member of Business Services

N

Resolve Name Immediately

Specification for whether or not to resolve the Instance Name of the task instance at trigger//launch time.

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

N

Virtual Resource Priority

Priority for acquiring a resource when two or more tasks are waiting for the resource. This priority applies to all resources required by the task.

Integer; Valid values: 1 (high) - 20 (low). Default is 10.

N

Restriction Period

If [[executionRestriction}} = Run, Skip, or Hold; Period of time when the task is restricted.

N

After Date

If restrictionPeriod = After or Span; Date after which the restriction is valid.

N

Before Date

If restrictionPeriod = Before or Span; Date before which the restriction is valid.

N

Date List

If restrictionPeriod = On; Date(s) on which the restriction is valid.

N

n/a

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

Yes
(for Read)

Lowest Instance Time

Shortest duration that the task ran.

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

n/a

Easier to read version of Minimum Run Time

String value of Minimum Run Time in human readable format

Number of Instances

Number of times that the task has run.

Long value of the task run count

n/a

Total amount of time the task has ran.

Long value of the total amount of time that task has ran (in seconds).

Hold on Start

Specification for whether or not when the task is launched, it appears in the Activity Monitor with a status of Held. The task runs when the user releases it.

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

N

Hold Reason

Information about why the task will be put on hold when it starts.

N

Task Description

User-defined description of this task.

N

n/a

System ID field in the database for this task.

Persisted only if retainSysIds is set to true.

N

Delay Duration In Seconds

If twDelayType = Seconds (3); Number of seconds to delay after starting the task.

N

Delay Duration

If twDelayType = Duration (2); Number of days, hours, minutes, and seconds to delay after starting the task.

Format = dd:hh:mm:ss

N

Delay On Start

Amount of time to delay the start of a task, after it has been launched, from the time that it is eligible to start; that is, all dependencies have been met. For example: it is not being held, it is not waiting on any predecessors, or there is no wait time specified.

N

Wait Duration In Seconds

If twWaitType = Seconds (3); Number of seconds to wait before starting the task.

N

Wait Day Constraint

If twWaitType = Time (1) or Relative Time (4). Specification for whether or not to advance the wait time to another day.

N

Wait Duration

If twWaitType = Duration; Number of days, hours, minutes, and seconds to wait before starting the task.

Format = dd:hh:mm:ss

N

Wait Time

If twWaitType = Time (1) or Relative Time (4); Number of hours and minutes to wait before starting the task.

Format = hh:mm

N

Wait To Start

Amount of time to wait before starting a task from the time that it was launched.

N

Workflow Only

Specification for whether or not to apply the twWaitType and twDelayType specifications only if the task is in a Workflow.

N

User Estimated Duration

Estimated amount of time it should normally take to run this task.

Format = dd:hh:mm:ss

Y
(if efType = Average Duration (5) or lfType = Average Duration (5))

n/a

Yes