All Tasks Properties
All Tasks Properties
Property | UI Field Name | Description | Specifications | Required | Mutually Exclusive With |
---|---|---|---|---|---|
| Agent | For Agent-based task types only; Name of the Agent to use. | Y |
| |
| 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 |
| |
| 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 |
|
| 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 |
|
| 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 | Y |
| |
| 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 |
|
| CP Duration | Used with | Integer; Valid values are 0 or greater. Variables and Functions are supported. | N | |
| CP Duration Unit | Used with the | Valid Values:
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 |
| |
| 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 |
| |
| 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 | |
| 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 | |
| Early Finish Day Constraint | If | Valid values:
Default is None (0). | N | |
| Early Finish Duration | If | Format = dd:hh:mm:ss | N | |
| Early Finish | Specification that if the task instance finishes before the specified | Boolean; Valid values: true/false. Default is false. | N | |
| Early Finish Duration Offset (-) | if | Integer; Valid values are 0 or greater. Variables and Functions are supported. | Y (if efOffsetType = Duration (2)). |
|
| 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 | |
| Early Finish Offset Type | If | Integer; Valid values are 0 to 100. Default is 0. | Y (if efOffsetType = Percentage (1)). |
|
| Early Finish Offset Type | If | Valid values:
Default is Percentage (1). | N | |
| Early Finish Time | If | Format = hh:mm, 24-hour time. Default is 00:00. | N | |
| Early Finish Type | Type of early finish. | Valid values:
Default is Time (1). | Y | |
| 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 | |
| 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:
Default is – None – (0). | N | |
| n/a | Universal Controller release that the record was exported from. Note In XML web services, | read only | N | |
| n/a | Record table information. Note In XML web services, | 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 | |
| n/a | Easier to read version of Last Run Time | String value of Last Run Time in human readable format | n/a | |
| Late Finish Day Constraint | If | Valid values:
Default is None (0). | N | |
| Late Finish Duration | If | Format = dd:hh:mm:ss | N | |
| Late Finish | Specification that if the task instance finishes after the specified | Boolean; Valid values: true/false. Default is false. | N | |
| Late Finish Duration Offset ( + ) | if | Integer; Valid values are 0 or greater. Variables and Functions are supported. | Y (if lfOffsetType = Duration (2)). |
|
| 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 | Valid Values:
Default is Minutes (2). | N | |
| Late Finish Percentage Offset ( + ) | If | Integer; Valid values are 0 to 100. Default is 0. | Y (if lfOffsetType = Percentage (1)). |
|
| Late Finish Offset Type | If | Valid Values:
Default is Percentage (1). | N | |
| Late Finish Time | If | Format = hh:mm. Default is 00:00. | N | |
| Late Finish Type | Type of late finish. | Valid values:
Default is Time (1). | Y | |
| Log Level | Applicable only to Extension-based Universal Tasks;, default is Inherited. For all other task types, | Valid values:
| N | |
| Late Start Day Constraint | If | Valid values:
Default is None (0). | N | |
| Late Start Duration | If | Format = dd:hh:mm:ss | N | |
| Late Start | Specification that if the task instance starts after the specified | Boolean; Valid values: true/false. Default is false. | N | |
| Late Start Time | If | Format = hh:mm. Default is 00:00. | N | |
| Late Start Type | Type of late start. | Valid values:
Default is Time (1). | Y | |
| Highest Instance Time | Longest duration that the task ran. | Long value of the current longest run time (in seconds). | n/a | |
| n/a | Easier to read version of Maximum Run Time | String value of Maximum Run Time in human readable format | n/a | |
| Lowest Instance Time | Shortest duration that the task ran. | Long value of the current shortest run time (in seconds). | n/a | |
| n/a | Easier to read version of Minimum Run Time | String value of Minimum Run Time in human readable format | n/a | |
| Task Name | Name of this task. | Y | ||
| Member of Business Services | List of Business Services that this task belongs to:
| 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. | Valid values:
Default is – None – (0). | N | |
| After Date | If | N | ||
| Before Date | If | N | ||
| Date List | If | N | ||
| n/a | For Create web services; specification for whether or not the web service should persist the sysId property.
Note In XML web services, | Valid values: true/false (default is true). | Yes | |
| Lowest Instance Time | Shortest duration that the task ran. | Long value of the current shortest run time (in seconds). | n/a | |
| n/a | Easier to read version of Minimum Run Time | String value of Minimum Run Time in human readable format | n/a | |
| Number of Instances | Number of times that the task has run. | Long value of the task run count | n/a | |
| n/a | Total amount of time the task has ran. | Long value of the total amount of time that task has ran (in seconds). | n/a | |
| 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 | N | ||
| Delay Duration | If | 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. | Valid values:
Default is None (0). | N | |
| Wait Duration In Seconds | If | N | ||
| Wait Day Constraint | If | Valid values:
Default is None (0). | N | |
| Wait Duration | If | Format = dd:hh:mm:ss | N | |
| Wait Time | If | Format = hh:mm | N | |
| Wait To Start | Amount of time to wait before starting a task from the time that it was launched. | Valid values:
Default is None (0). | N | |
| Workflow Only | Specification for whether or not to apply the | Valid values:
Default is – System Default – (0). | N | |
| User Estimated Duration | Estimated amount of time it should normally take to run this task. | Format = dd:hh:mm:ss | Y | |
| n/a | For Read and List task web services; specification of the task version being read or listed. Note In XML web services, | Yes |