Anchor | ||||
---|---|---|---|---|
|
...
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
agent | Agent | For Agent-based task types only; Name of the Agent to use. | Y |
| |||||||||||||||||||||||||||||||||||||||||
agentCluster | Agent Cluster | For Agent-based task types only; Group of Agents, one of which the Controller will choose to run this task (compare with | Y |
| |||||||||||||||||||||||||||||||||||||||||
agentClusterVar | 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 |
| ||||||||||||||||||||||||||||||||||||||||
agentVar | 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 |
| ||||||||||||||||||||||||||||||||||||||||
avgRunTime | 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 | |||||||||||||||||||||||||||||||||||||||||
broadcastCluster | Cluster Broadcast | For Agent-based task types only; Group of Agents, all of which will run this task (compare with | Y |
| |||||||||||||||||||||||||||||||||||||||||
broadcastClusterVar | 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 |
| ||||||||||||||||||||||||||||||||||||||||
cpDuration | CP Duration | Used with | Integer; Valid values are 0 or greater. Variables and Functions are supported. | N | |||||||||||||||||||||||||||||||||||||||||
cpDurationUnit | CP Duration Unit | Used with the | Valid Values:Default is Minutes (2
Default is Minutes (2). | N | |||||||||||||||||||||||||||||||||||||||||
credentials | 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 |
| |||||||||||||||||||||||||||||||||||||||||
customField1 | n/a | User-Defined field. | The label is included only if a value has been defined for the User Defined Task Field Label 1 Universal Controller system property. | N | |||||||||||||||||||||||||||||||||||||||||
customField2 | n/a | User-Defined field. | The label is included only if a value has been defined for the User Defined Task Field Label 2 Universal Controller system property. | N | |||||||||||||||||||||||||||||||||||||||||
efDayConstraint | Early Finish Day Constraint | If | |||||||||||||||||||||||||||||||||||||||||||
Anchor | efEnabled - All | efEnabled - All | Early Finish | Specification that if the task instance finishes before the specified | Boolean; Valid values: true/false. Default is false Valid values: Default is None (0). | N | |||||||||||||||||||||||||||||||||||||||
Anchor | efDuration - All | efDuration - All | Early Finish Duration | If | Format = dd:hh:mm:ss | N |
Default is None (0). | N | |||||||||||||||||||||||||||||||||||||
efOffsetDuration efDuration | Early Finish Duration Offset (-)if | If | Integer; Valid values are 0 or greater. Variables and Functions are supported. | Y (if efOffsetType = Duration (2)). |
| ||||||||||||||||||||||||||||||||||||||||
Anchor | efOffsetDurationUnit - All | efOffsetDurationUnit - All | 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 e | Valid Values:
Default is Minutes (2). | N | |||||||||||||||||||||||||||||||||||||||
Anchor | efOffsetPercentage - All | efOffsetPercentage - All | Early Finish Offset Type | If | Integer; Valid values are 0 to 100. Default is 0 Shortest amount of time this task instance should take to run. | Format = dd:hh:mm:ss | N | ||||||||||||||||||||||||||||||||||||||
efEnabled | Early Finish | Specification that if the task instance finishes before the specified | Boolean; Valid values: true/false. Default is false. | N | |||||||||||||||||||||||||||||||||||||||||
efOffsetDuration | Early Finish Duration Offset (-) | if | Integer; Valid values are 0 or greater. Variables and Functions are supported. | Y (if efOffsetType = Percentage Duration (12)). |
| ||||||||||||||||||||||||||||||||||||||||
efOffsetType efOffsetDurationUnit | Early Finish Duration Offset Type | If | Valid valuesUnit | 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 e | Valid Values:
Default is Percentage Minutes (12). | N | |||||||||||||||||||||||||||||||||||||||
efTime efOffsetPercentage | Early Finish TimeOffset Type | If | Format = hh:mm, 24-hour time. Default is 00:00. | N | |||||||||||||||||||||||||||||||||||||||||
Anchor | efType - All | efType - All | Early Finish Type | Type of early finishPercentage offset to subtract from the Average Duration. | Integer; Valid values are 0 to 100. Default is 0. | Y (if efOffsetType = Percentage (1)). |
| ||||||||||||||||||||||||||||||||||||||
efOffsetType | Early Finish Offset Type | If | Valid values:
Default is TimePercentage (1). | Y | N | ||||||||||||||||||||||||||||||||||||||||
Valid values: true/false (default is false)
excludeRelated | 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.
|
| Early Finish Time | If | Format = hh:mm, 24-hour time. Default is 00:00. | N | ||||||||||||||||||||||||||||||||||||||
Anchor | | lastRun - All | lastRun - All | lastRunLast
Anchor | ||||
---|---|---|---|---|
|
executionRestriction
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:
Default is – None – (0).
N
exportReleaseLevel
exportTable
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.
holdResources
Hold Resources on Failure
Specification for the task instance to continue to hold Renewable resources if the task instance fails. Renewable resources will be returned only if the task instance status is either Complete, Finished, or Skipped.
Deprecated for Workflow tasks.
Boolean; Valid values: true/false. Default is false.
N
efType
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)
Anchor | ||||
---|---|---|---|---|
|
excludeRelated
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.
Note | ||
---|---|---|
| ||
In XML web services, |
Valid values: true/false (default is false).
N
Anchor | ||||
---|---|---|---|---|
|
executionRestriction
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
Anchor | ||||
---|---|---|---|---|
|
exportReleaseLevel
Universal Controller release that the record was exported from.
Note | ||
---|---|---|
| ||
In XML web services, |
Anchor | ||||
---|---|---|---|---|
|
exportTable
Record table information.
Note | ||
---|---|---|
| ||
In XML web services, |
firstRun Anchor firstRun - All firstRun - All
First Execution
System-supplied; End Time of the last first instance of this task to complete.
String value of the time that the task was last first run.
lastRunTimelastRun Anchor lastRunTime lastRun - AlllastRunTime lastRun - All
Last Instance DurationDuration of the last run 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.
lastRunTime Anchor lastRunTime - All lastRunTime - All
Last Instance Duration
Duration of the last run of the task.
Long value of the current last run time (in seconds).
lastRunTimeDisplay Anchor lastRunTimeDisplay - All lastRunTimeDisplay - All
n/a
Easier to read version of Last Run Time
String value of Last Run Time in human readable format
Anchor | ||||
---|---|---|---|---|
|
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:
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
- 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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
lfOffsetDuration
Late Finish Duration Offset ( + )
if lfOffsetType
is Duration (2); Duration offset to add to the Average Duration.
lfOffsetType
= Duration (2)).lfOffsetPercentage
Anchor | ||||
---|---|---|---|---|
|
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
.
- As String = Seconds, As Value = 1
- As String = Minutes, As Value = 2
- As String = Hours, As Value = 3
Default is Minutes (2).
Anchor | ||||
---|---|---|---|---|
|
lfOffsetPercentage
Late Finish Percentage Offset ( + )
If lfOffsetType
is Percentage (1); Percentage offset to add to the Average Duration.
lfOffsetType
= Percentage (1)).lfOffsetDuration
Anchor | ||||
---|---|---|---|---|
|
lfOffsetType
Late Finish Offset Type
If l
fType
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).
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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)
Anchor | ||||
---|---|---|---|---|
|
logLevel
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
Anchor | ||||
---|---|---|---|---|
|
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:
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
- 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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
lsType
Late Start Type
Type of late start.
Valid values:
Default is Time (1).
(
- As String = Time, As Value = 1
- As String = Duration, As Value = 2
Default is Time (1).
Y
(if lsEnabled
is true)
maxRunTime Anchor maxRunTime - All maxRunTime - All
Highest Instance Time
Longest duration that the task ran.
Long value of the current longest run time (in seconds).
maxRunTimeDisplay Anchor maxRunTimeDisplay - All maxRunTimeDisplay - All
n/a
Easier to read version of Maximum Run Time
String value of Maximum Run Time in human readable format
minRunTime Anchor minRunTime - All minRunTime - All
Lowest Instance Time
Shortest duration that the task ran.
Long value of the current shortest run time (in seconds).
minRunTimeDisplay Anchor minRunTimeDisplay - All minRunTimeDisplay - All
n/a
Easier to read version of Minimum Run Time
String value of Minimum Run Time in human readable format
Anchor | ||||
---|---|---|---|---|
|
name
Task Name
Name of this task.
Y
Anchor | ||||
---|---|---|---|---|
|
opswiseGroups
Member of Business Services
List of Business Services that this task belongs to:
XML
Panel |
---|
<opswiseGroups>
<opswiseGroup>test</opswiseGroup>
</opswiseGroups> |
JSON
Panel |
---|
"opswiseGroups" : ["1","2"] |
N
Anchor | ||||
---|---|---|---|---|
|
resolveNameImmediately
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
Anchor | ||||
---|---|---|---|---|
|
resPriority
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
Anchor | ||||
---|---|---|---|---|
|
restrictionPeriod
Restriction Period
If [[executionRestriction}} = Run, Skip, or Hold; Period of time when the task is restricted.
Valid values:
Default is – None – (0).
N
- As String = -- None --, As Value = 0
- As String = Before, As Value = 1
- As String = After, As Value = 2
- As String = Span, As Value = 3
- As String = On, As Value = 4
Default is – None – (0).
N
Anchor | ||||
---|---|---|---|---|
|
restrictionPeriodAfterDate
After Date
If restrictionPeriod
= After or Span; Date after which the restriction is valid.
N
Anchor | ||||
---|---|---|---|---|
|
restrictionPeriodBeforeDate
Before Date
If restrictionPeriod
= Before or Span; Date before which the restriction is valid.
N
Anchor | ||||
---|---|---|---|---|
|
restrictionPeriodDateList
Date List
If restrictionPeriod
= On; Date(s) on which the restriction is valid.
N
Anchor | ||||
---|---|---|---|---|
|
retainSysIds
n/a
For Create web services; specification for whether or not the web service should persist the sysId property.
title | Note |
---|
retainSysIds
is specified as an attribute in the - If
retainSysIds
is true andsysId
is included in the request/response,sysId
will be persisted to the database. - If
retainSysIds
is false andsysId
is included in the request/response,sysId
will be ignored; it will be autogenerated by the Controller.
Note | ||
---|---|---|
| ||
In XML web services, |
Valid values: true/false (default is true).
Yes
(for Read)
minRunTime Anchor minRunTime - All minRunTime - All
Lowest Instance Time
Shortest duration that the task ran.
Long value of the current shortest run time (in seconds).
minRunTimeDisplay Anchor minRunTimeDisplay - All minRunTimeDisplay - All
n/a
Easier to read version of Minimum Run Time
String value of Minimum Run Time in human readable format
runCount Anchor RunCount - All RunCount - All
Number of Instances
Number of times that the task has run.
Long value of the task run count
runTime Anchor RunTime - All RunTime - All
n/a
Total amount of time the task has ran.
Long value of the total amount of time that task has ran (in seconds).
Anchor | ||||
---|---|---|---|---|
|
startHeld
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
Anchor | ||||
---|---|---|---|---|
|
startHeldReason
Hold Reason
Information about why the task will be put on hold when it starts.
N
Anchor | ||||
---|---|---|---|---|
|
summary
Task Description
User-defined description of this task.
N
Anchor | ||||
---|---|---|---|---|
|
sysId
n/a
System ID field in the database for this task.
Persisted only if retainSysIds is set to true.
N
Anchor | ||||
---|---|---|---|---|
|
twDelayAmount
Delay Duration In Seconds
If twDelayType
= Seconds (3); Number of seconds to delay after starting the task.
N
Anchor | ||||
---|---|---|---|---|
|
twDelayDuration
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
Anchor | ||||
---|---|---|---|---|
|
twDelayType
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.
Valid values:Default
- As String = None, As Value = 0
- As String = Duration, As Value = 1
- As String = Seconds, As Value = 2
Default is None (0).
N
Anchor | ||||
---|---|---|---|---|
|
twWaitAmount
Wait Duration In Seconds
If twWaitType
= Seconds (3); Number of seconds to wait before starting the task.
N
Anchor | ||||
---|---|---|---|---|
|
twWaitDayConstraint
Wait Day Constraint
If twWaitType
= Time (1) or Relative Time (4). Specification for whether or not to advance the wait time to another day.
to advance the wait 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
Default is None (0).
N
Anchor | ||||
---|---|---|---|---|
|
twWaitDuration
Wait Duration
If twWaitType
= Duration; Number of days, hours, minutes, and seconds to wait before starting the task.
Format = dd:hh:mm:ss
N
Anchor | ||||
---|---|---|---|---|
|
twWaitTime
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
Anchor | ||||
---|---|---|---|---|
|
twWaitType
Wait To Start
Amount of time to wait before starting a task from the time that it was launched.
Valid values:wait before starting a task from the time that it was launched.
Valid values:
- As String = None, As Value = 0
- As String = Time, As Value = 1
- As String = Duration, As Value = 2
- As String = Seconds, As Value = 3
- As String = Relative Time, As Value = 4
Default is None (0).
N
Anchor | ||||
---|---|---|---|---|
|
twWorkflowOnly
Workflow Only
Specification for whether or not to apply the twWaitType
and twDelayType
specifications only if the task is in a Workflow.
Valid values:
- As String = -- System Default --, As Value = 0
- As String = Yes, As Value = 1
- As String = No, As Value = 2
Default is – System Default – (0).
N
Anchor | ||||
---|---|---|---|---|
|
userEstimatedDuration
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))
Anchor | ||||
---|---|---|---|---|
|
version
n/a
For Read and List task web services; specification of the task version being read or listed.
Note | ||
---|---|---|
| ||
In XML web services, |
Yes
...