Versions Compared

Key

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

Anchor
All Tasks Properties
All Tasks Properties
All Tasks Properties

...

efEnabledefDurationefOffsetDurationUnitefOffsetPercentageefTypeexportReleaseLevelfirstRunlastRunlastRunTimelastRunTimeDisplaylfOffsetPercentagelfOffsetTypelfTimelfDurationlfEnabledlfOffsetDurationlfOffsetDurationUnitlogLevel logLevel logLevellsDayConstraintlsDurationlsEnabledlsTimelsTypemaxRunTimemaxRunTimeDisplayminRunTimeminRunTimeDisplaynameopswiseGroups

List of Business Services that this task belongs to:
 
XML

 
JSON

resolveNameImmediatelyresPriorityrestrictionPeriodrestrictionPeriodAfterDaterestrictionPeriodBeforeDaterestrictionPeriodDateListretainSysIdsminRunTimeminRunTimeDisplayrunCountrunTime startHeld startHeldReason summarysysIdtwDelayAmounttwDelayDurationtwDelayType twWaitAmounttwWaitDayConstraint

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

Anchor
agent - All
agent - All
agent

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

Anchor
agentCluster - All
agentCluster - All
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 broadcastCluster).


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

agentClusterVar,
broadcastCluster, and
broadcastClusterVar

Anchor
agentClusterVar - All
agentClusterVar - All
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
(unless agentCluster,
agent,
agentVar,
broadcastCluster, or
broadcastClusterVar
is specified)

agentCluster,
broadcastCluster, and
broadcastClusterVar

Anchor
agentVar - All
agentVar - All
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
(unless agent,
agentCluster,
agentClusterVar,
broadcastCluster, or
broadcastClusterVar
is specified)

agent,
broadcastCluster, and
broadcastClusterVar

Anchor
avgRunTime - All
avgRunTime - All
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

Anchor
avgRunTimeDisplay - All
avgRunTimeDisplay - All
avgRunTimeDisplay

n/a

Easier to read version of Average Run Time.

String value of Average Run Time in human readable format

n/a

Anchor
broadcastCluster - All
broadcastCluster - All
broadcastCluster

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

Anchor
broadcastClusterVar - All
broadcastClusterVar - All
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
(unless broadcastCluster,
agent,
agentVar,
agentCluster, or
agentClusterVar,
is specified)

broadcastCluster,
agent,
agentVar,
agentCluster, and
agentClusterVar

Anchor
cpDuration - All
cpDuration - All
cpDuration

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


Anchor
cpDurationUnit - All
cpDurationUnit - All
cpDurationUnit

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:Default is Minutes (2

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

Default is Minutes (2).

N


Anchor
credentials - All
credentials - All
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

Anchor
credentialsVar - All
credentialsVar - All
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

Anchor
customField1 - All
customField1 - All
customField1

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


Anchor
customField2 - All
customField2 - All
customField2

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


Anchor
efDayConstraint - All
efDayConstraint - All
efDayConstraint

Early Finish Day Constraint

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

Anchor
efEnabled - AllefEnabled - All

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

Valid values:

Default is None (0).

N

Anchor
efDuration - AllefDuration - All

Early Finish Duration

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

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
efOffsetDuration efDuration - AllefOffsetDuration
efDuration - All
efOffsetDurationefDuration

Early Finish Duration Offset (-)if efOffsetType is

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

Anchor
efOffsetDurationUnit - AllefOffsetDurationUnit - 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 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
Anchor
efOffsetPercentage - AllefOffsetPercentage - All

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

Shortest amount of time this task instance should take to run.

Format = dd:hh:mm:ss

N


Anchor
efEnabled - All
efEnabled - All
efEnabled

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


Anchor
efOffsetDuration - All
efOffsetDuration - All
efOffsetDuration

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 = Percentage Duration (12)).

efOffsetDurationefOffsetPercentage

Anchor
efOffsetType efOffsetDurationUnit - AllefOffsetType
efOffsetDurationUnit - All
efOffsetTypeefOffsetDurationUnit

Early Finish Duration Offset Type

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

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 efOffsetDurationUnit.

Valid Values:
  • As String = PercentageSeconds, As Value = 1.
  • As String = DurationMinutes, As Value = 2.
  • As String = Hours, As Value = 3

Default is Percentage Minutes (12).

N


Anchor
efTime efOffsetPercentage - AllefTime
efOffsetPercentage - All
efTimeefOffsetPercentage

Early Finish TimeOffset Type

If efType = Time efOffsetType is Percentage (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

Anchor
efType - AllefType - 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)).

efOffsetDuration

Anchor
efOffsetType - All
efOffsetType - All
efOffsetType

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 =
Time
  • Percentage, As Value = 1.
  • As String = Duration, As Value = 2.
  • As String = Average Duration, As Value = 5.
  • Default is

    Time

    Percentage (1).

    Y
    (if efEnabled
    is true)

    N


    Valid values: true/false (default is false)

    Anchor
    excludeRelated efTime - AllexcludeRelated
    efTime - All
    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
    titleNote

    In XML web services, excludeRelated is specified as an attribute in the <task type> element.

    efTime

    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


    Universal Controller release that the record was exported from.

    Anchor
    executionRestriction efType - AllexecutionRestriction
    efType - All
    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

    Anchor
    exportReleaseLevel - AllexportReleaseLevel - Alln/a

    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 - All
    excludeRelated - All
    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
    titleNote

    In XML web services, exportReleaseLevel excludeRelated is specified as an attribute in the <task type> element.


    read only

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

    N


    n/a

    Easier to read version of Last Run Time

    String value of Last Run Time in human readable format

    Anchor
    exportTable executionRestriction - AllexportTable
    executionRestriction - All
    exportTable

    n/a

    Record table information.

    Note
    titleNote

    In XML web services, exportTable is specified as an attribute in the <task type> element.

    read onlyN
    Anchor
    firstRun - AllfirstRun - All

    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
    Anchor
    lastRun - AlllastRun - All

    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
    Anchor
    lastRunTime - AlllastRunTime - All

    Last Instance Duration

    Duration of the last run of the task.

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

    n/a
    Anchor
    lastRunTimeDisplay - AlllastRunTimeDisplay - All

    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 - All
    exportReleaseLevel - All
    exportReleaseLevel

    n/a

    Universal Controller release that the record was exported from.

    Note
    titleNote

    In XML web services, exportReleaseLevel is specified as an attribute in the <task type> element.


    read onlyN

    Anchor
    exportTable - All
    exportTable - All
    exportTable

    n/a

    Record table information.

    Note
    titleNote

    In XML web services, exportTable is specified as an attribute in the <task type> element.


    read onlyN

    Anchor
    firstRun - All
    firstRun - All
    firstRun

    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
    Anchor
    lfOffsetPercentage - AlllfOffsetPercentage - All

    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

    Anchor
    lfOffsetType - AlllfOffsetType - All

    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
    Anchor
    lfTime - AlllfTime - All

    Late Finish Time

    If lfType

    Anchor
    lfDayConstraint
    lastRun - All
    lfDayConstraint
    lastRun - All
    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

    Anchor
    lfDuration - AlllfDuration - All

    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 - AlllfEnabled - All

    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 - AlllfOffsetDuration - All

    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

    Anchor
    lfOffsetDurationUnit - AlllfOffsetDurationUnit - All

    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

    lastRun

    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

    Anchor
    lastRunTime - All
    lastRunTime - All
    lastRunTime

    Last Instance Duration

    Duration of the last run of the task.

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

    n/a

    Anchor
    lastRunTimeDisplay - All
    lastRunTimeDisplay - All
    lastRunTimeDisplay

    n/a

    Easier to read version of Last Run Time

    String value of Last Run Time in human readable format

    n/a

    Anchor
    lfDayConstraint - All
    lfDayConstraint - All
    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


    Anchor
    lfDuration - All
    lfDuration - All
    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 - All
    lfEnabled - All
    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 - All
    lfOffsetDuration - All
    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

    Anchor
    lfOffsetDurationUnit - All
    lfOffsetDurationUnit - All
    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


    Anchor
    lfOffsetPercentage - All
    lfOffsetPercentage - All
    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

    Anchor
    lfOffsetType - All
    lfOffsetType - All
    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


    Anchor
    lfTime - All
    lfTime - All
    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 - All
    lfType - All
    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 - All
    logLevel - All
    logLevel

    Log Level

    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
    N

    Anchor
    lsDayConstraint - All
    lsDayConstraint - All
    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


    Anchor
    lsDuration - All
    lsDuration - All
    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 - All
    lsEnabled - All
    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 - All
    lsTime - All
    lsTime

    Late Start Time

    If lsType = Time (1); Time after which the task finish start time is considered late.

    Format = hh:mm. Default is 00:00.

    N


    Anchor
    lfType lsType - AlllfType
    lsType - All
    lfTypelsType

    Late Finish Start Type

    Type of late finishstart.

    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 lsEnabled
    is true)


    Anchor

    maxRunTime - All

    maxRunTime - All

    Log Level

    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
    N
    Anchor
    lsDayConstraint - AlllsDayConstraint - All

    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

    Anchor
    lsDuration - AlllsDuration - All

    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 - AlllsEnabled - All

    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 - AlllsTime - All

    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 - AlllsType - All

    Late Start Type

    Type of late start.

    Valid values:

    Default is Time (1).

    Y
    (if lsEnabled
    is true)

    Anchor
    maxRunTime - AllmaxRunTime - All

    Highest Instance Time

    Longest duration that the task ran.

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

    n/a
    Anchor
    maxRunTimeDisplay - AllmaxRunTimeDisplay - All

    n/a

    Easier to read version of Maximum Run Time

    String value of Maximum Run Time in human readable format

    n/a
    Anchor
    minRunTime - AllminRunTime - All

    Lowest Instance Time

    Shortest duration that the task ran.

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

    n/a
    Anchor
    minRunTimeDisplay - AllminRunTimeDisplay - All

    n/a

    Easier to read version of Minimum Run Time

    String value of Minimum Run Time in human readable format

    n/a
    Anchor
    name - Allname - All

    Task Name

    Name of this task.

    Y

    Anchor
    opswiseGroups - AllopswiseGroups - All

    Member of Business Services

    Panel
    Panel

    N

    Anchor
    resolveNameImmediately - AllresolveNameImmediately - All

    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 - AllresPriority - All

    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 - AllrestrictionPeriod - All

    Restriction Period

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

    Valid values:

    Default is – None – (0).

    N

    Anchor
    restrictionPeriodAfterDate - AllrestrictionPeriodAfterDate - All

    After Date

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

    N

    Anchor
    restrictionPeriodBeforeDate - AllrestrictionPeriodBeforeDate - All

    Before Date

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

    N

    Anchor
    restrictionPeriodDateList - AllrestrictionPeriodDateList - All

    Date List

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

    N

    Anchor
    retainSysIds - AllretainSysIds - All

    n/a

    For Create web services; specification for whether or not the web service should persist the sysId property.

    Note
    titleNote

    In XML web services, retainSysIds is specified as an attribute in the <task type> element.

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

    Yes
    (for Read)

    Anchor
    minRunTime - AllminRunTime - All

    Lowest Instance Time

    Shortest duration that the task ran.

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

    n/a
    Anchor
    minRunTimeDisplay - AllminRunTimeDisplay - All

    n/a

    Easier to read version of Minimum Run Time

    String value of Minimum Run Time in human readable format

    n/a
    Anchor
    RunCount - AllRunCount - All

    Number of Instances

    Number of times that the task has run.

    Long value of the task run count

    n/a
    Anchor
    RunTime - AllRunTime - 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).

    n/a
    Anchor
    startHeld - AllstartHeld - All

    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 - AllstartHeldReason - All

    Hold Reason

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

    N

    Anchor
    summary - Allsummary - All

    Task Description

    User-defined description of this task.

    N

    Anchor
    sysId - AllsysId - All

    n/a

    System ID field in the database for this task.

    Persisted only if retainSysIds is set to true.

    N

    Anchor
    twDelayAmount - AlltwDelayAmount - All

    Delay Duration In Seconds

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

    N

    Anchor
    twDelayDuration - AlltwDelayDuration - All

    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 - AlltwDelayType - All

    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

    Anchor
    twWaitAmount - AlltwWaitAmount - All

    Wait Duration In Seconds

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

    N

    Anchor
    twWaitDayConstraint - AlltwWaitDayConstraint - All

    Wait Day Constraint

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

    Valid values:maxRunTime

    Highest Instance Time

    Longest duration that the task ran.

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

    n/a

    Anchor
    maxRunTimeDisplay - All
    maxRunTimeDisplay - All
    maxRunTimeDisplay

    n/a

    Easier to read version of Maximum Run Time

    String value of Maximum Run Time in human readable format

    n/a

    Anchor
    minRunTime - All
    minRunTime - All
    minRunTime

    Lowest Instance Time

    Shortest duration that the task ran.

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

    n/a

    Anchor
    minRunTimeDisplay - All
    minRunTimeDisplay - All
    minRunTimeDisplay

    n/a

    Easier to read version of Minimum Run Time

    String value of Minimum Run Time in human readable format

    n/a

    Anchor
    name - All
    name - All
    name

    Task Name

    Name of this task.


    Y


    Anchor
    opswiseGroups - All
    opswiseGroups - All
    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 - All
    resolveNameImmediately - All
    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 - All
    resPriority - All
    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 - All
    restrictionPeriod - All
    restrictionPeriod

    Restriction Period

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

    Valid values:

    • 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 - All
    restrictionPeriodAfterDate - All
    restrictionPeriodAfterDate

    After Date

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


    N


    Anchor
    restrictionPeriodBeforeDate - All
    restrictionPeriodBeforeDate - All
    restrictionPeriodBeforeDate

    Before Date

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


    N


    Anchor
    restrictionPeriodDateList - All
    restrictionPeriodDateList - All
    restrictionPeriodDateList

    Date List

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


    N


    Anchor
    retainSysIds - All
    retainSysIds - All
    retainSysIds

    n/a

    For Create web services; specification for whether or not the web service should persist the sysId property.

    • If retainSysIds is true and sysId is included in the request/response, sysId will be persisted to the database.
    • If retainSysIds is false and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.
    Note
    titleNote

    In XML web services, retainSysIds is specified as an attribute in the <task type> element.


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

    Yes
    (for Read)


    Anchor
    minRunTime - All
    minRunTime - All
    minRunTime

    Lowest Instance Time

    Shortest duration that the task ran.

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

    n/a

    Anchor
    minRunTimeDisplay - All
    minRunTimeDisplay - All
    minRunTimeDisplay

    n/a

    Easier to read version of Minimum Run Time

    String value of Minimum Run Time in human readable format

    n/a

    Anchor
    RunCount - All
    RunCount - All
    runCount

    Number of Instances

    Number of times that the task has run.

    Long value of the task run count

    n/a

    Anchor
    RunTime - All
    RunTime - All
    runTime

    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

    Anchor
    startHeld - All
    startHeld - All
    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 - All
    startHeldReason - All
    startHeldReason

    Hold Reason

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


    N


    Anchor
    summary - All
    summary - All
    summary

    Task Description

    User-defined description of this task.


    N


    Anchor
    sysId - All
    sysId - All
    sysId

    n/a

    System ID field in the database for this task.

    Persisted only if retainSysIds is set to true.

    N


    Anchor
    twDelayAmount - All
    twDelayAmount - All
    twDelayAmount

    Delay Duration In Seconds

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


    N


    Anchor
    twDelayDuration - All
    twDelayDuration - All
    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 - All
    twDelayType - All
    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:

    • 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 - All
    twWaitAmount - All
    twWaitAmount

    Wait Duration In Seconds

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


    N


    Anchor
    twWaitDayConstraint - All
    twWaitDayConstraint - All
    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.

    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 - All
    twWaitDuration - All
    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 - All
    twWaitTime - All
    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 - All
    twWaitType - All
    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 - All
    twWorkflowOnly - All
    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 - All
    userEstimatedDuration - All
    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 - All
    version - All
    version

    n/a

    For Read and List task web services; specification of the task version being read or listed.
     

    Note
    titleNote

    In XML web services, version is specified as an attribute in the <task type> element.



    Yes


    ...