Variable Monitor Task Properties

Variable Monitor Task Properties

Task Properties: Variable Task Monitor Task

Property

 

UI Field Name

Description

Specifications

Required

Property

 

UI Field Name

Description

Specifications

Required

expirationAction

Expiration Action

Expiration Action to specify the timeout Execution status.

Valid values:

  • As String = Failed, As Value = 1

  • As String = Finished, As Value = 2

Default is Failed (1).

N

 

timeLimit

 

Time Limit

If valueMonitorType is Change or Current/Change; Used for Variable Monitor tasks not associated with a trigger; Amount of time (in units specified by timeLimitUnit) to monitor for the Variable Monitor conditions to be met.

The timeLimit duration is always relative to the start time of the Variable Monitor task instance.

N

timeLimitUnit

 

Time Limit Unit

Unit of time to use for timeLimit.

Valid Values:

  • As String = Minutes, As Value = 2

  • As String = Hours, As Value = 3

  • As String = Days, As Value = 4

Default is Hours (3).

N

value

 

Value

If valueCondition is =, !=, >, >=, <, <=, or regex; Value of the variable being monitored.

 

N

valueCondition

 

Value Condition

Condition for the value of the variable being monitored.

Valid values:

  • As String = -- None --, As Value = 0

  • As String = =, As Value = 1

  • As String = !=, As Value = 2

  • As String = >, As Value = 3

  • As String = >=, As Value = 4

  • As String = <, As Value = 5

  • As String = <=, As Value = 6

  • As String = regex, As Value = 7

  • As String = undefined, As Value = 8

Default is = (1)

N

valueMonitorType

 

Value Monitor Type

Type of monitoring to be done on the Variable value.

Valid values:

  • As String = Current, As Value = 1

  • As String = Change, As Value = 2

  • As String Current/Change, As Value = 3

Default is Current (1).

N

variableName

 

Variable to Monitor

Name of the variable to monitor.

Variables are supported.

Y