Versions Compared

Key

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

...

Property

UI Field Name

Description

Specifications

Required

Anchor
hold - TaT
hold - TaT
hold

Hold on Start

Indication of whether or not to launch the task in Held status. The task runs when the user releases it.

Boolean; Valid values: Yes, Y, true.

N

Anchor
holdReason - TaT
holdReason - TaT
holdReason

Hold Reason

Information about why the task instances will be put on hold when the tasks start.


N

launchReasonLaunch ReasonReason for the task launch

(Y if Task Launch Reason Required system  system property is True.)

Anchor
name - TaT
name - TaT
name

Name

Name of the trigger to trigger the task.


Y

Anchor
overrideDate - TaT
overrideDate - TaT
overrideDate

DateDate of the override execution.YYY-MM-DDN
(Y if overrrideTriggerDateTime
is true.)

Anchor
overrideTime - TaT
overrideTime - TaT
overrideTime

TimeTime of the override execution.HH:MMN
(Y if overrrideTriggerDateTime
is true.)

Anchor
overrideTimeZone - TaT
overrideTimeZone - TaT
overrideTimeZone

Time ZoneTime zone of the override execution.
N
(Y if overrrideTriggerDateTime
is true.)

Anchor
overrideTriggerDateTime - TaT
overrideTriggerDateTime - TaT
overrideTriggerDateTime

Override Trigger Date/TimeSpecification for whether to enable or disable override functionality.

Boolean; Valid values: true/false.

Default is false.

N

Anchor
timeZone - TaT
timeZone - TaT
timeZone

Time Zone

Time zone in which task is triggered.


N

Anchor
variables - TaT
variables - TaT
variables

n/a


Panel
  <variables>
        <variable>
            <name>testVariable</name>
            <value>Hello</value>
        </variable>
    </variables>

 
See Trigger Task(s) (Trigger Now): Request Variable Properties.


N

Anchor
virtualResourcePriority - TaT
virtualResourcePriority - TaT
virtualResourcePriority

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-20 (1 is high priority, 20 is low priority). Default is 10.

N

Anchor
virtual-resources - TaT
virtual-resources - TaT
virtual-resources

n/a


Panel
    <virtual-resources> 
        <virtual-resource>
            <name>uc - Solo</name>
            <limit>2</limit>
        </virtual-resource>
    </virtual-resources>

 
See Triger Task(s) (Trigger Now): Request Virtual Resource Properties.

The virtual resource dependencies specified in virtual-resources are merged with the default virtual resource dependencies.

  • If a default virtual resource dependency already exists for a specified virtual resource amount, the virtual resource dependency is updated.
  • Any virtual resource specified with an amount of 0 is dropped from the default virtual resource dependencies; if the virtual resource did not exist as a default dependency, the command will fail.
  • If a default virtual resource dependency does not already exist for a specified virtual resource amount, the virtual resource dependency is added.

N

...