Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 2

changes.mady.by.user Former user

Saved on

Key

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

Anchor
Task Properties - Variable Monitor Task
Task Properties - Variable Monitor Task
Task Properties: Universal Monitor Task


expirationAction - VMexpirationAction - VM

Property

UI Field Name

Description

Specifications

Required

Anchor

eventType

Event Type

Type of Universal Event to monitor.

Valid values: one of the following (not case sensitive):

  • As String = Global, As Value = 1

  • As String = Local, As Value = 2

Y

eventTemplate

Universal Event Template

Universal Event Template name.

XML


Code Block
languagetext
<eventTemplate label="Test Event A">test_event_a</eventTemplate>
 
JSON
"eventTemplate": {
    "label": "Test Event A",
    "value": "test_event_a"
}
The label is included when reading a Universal Monitor task; however, it is ignored when creating/updating a Universal Monitor task.
Y
(if eventType is Global)
expirationAction
Expiration Action
If timeScopeis Relative; Specify the 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
 AnchortimeLimit - VMtimeLimit - VMtimeLimit
Time Limit
If valueMonitorType is Change or Current/Change; Used for Variable 
template
Universal Template
Universal Template name.

Y(if eventType is Local)
templateEventTemplate
Universal Template Event Template
Universal Template Event Template name.
XML
<templateEventTemplate label="Test Event B">test_event_b</templateEventTemplate>
 
JSON
"templateEventTemplate": {
    "label": "Test Event B",
    "value": "test_event_b"
}
The label is included when reading a Universal Monitor task; however, it is ignored when creating/updating a Universal Monitor task.
Y(if eventType is Local)

timeScope
Time Scope
Used for Universal 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 
Used to create a window during which the Universal Monitor conditions must be met in order for the Universal Monitor to be satisfied. The timeScope window is always relative to the 
 start 
 time 
 of 
that the 
 Variable 
Universal Monitor 
 task instance.
N
 AnchortimeLimitUnit - VMtimeLimitUnit - VMtimeLimitUnit
Time Limit Unit
Unit of time to use for timeLimit.
Valid Values:
Default is Hours (3
launched. For example, if you specify -01:00 in relativeTimeFrom and 02:00 in relativeTimeTo, the window's begin time is one hour before the Universal Monitor is launched and its end time is two hours after it is launched.
Valid values:
  • As String = -- None --, As Value = 0
  • As String = Relative, As Value = 1
Default is – None – (0).
N
anchor
relativeTimeFrom
value - VMvalue - VMvalue
Value
If valueCondition is =, !=, >, >=, <, <=, or regex; Value of the variable being monitored.
N
 AnchorvalueCondition - VMvalueCondition - VMvalueCondition
Value Condition
Condition for the value of the variable being monitored.
Valid values:
Default is = (1)
N
 AnchorvalueMonitorType - VMvalueMonitorType - VMvalueMonitorType
Value Monitor Type
Type of monitoring to be done on the Variable value.
Valid values:
Default is Current (1).
N
 AnchorvariableName - VMvariableName - VMvariableName
Variable to Monitor
Name of the variable to monitor.
Variables are supported.
Y
From
If timeScope is Relative; Used for Universal Monitor tasks not associated with a trigger. Together with relativeTimeTo, it allows you to specify a window of time, relative to the time the Universal Monitor task launched, during which the criteria of the Universal Monitor must be met. If the critera is not met within the specified window, the Universal Monitor task goes to a FAILED status.
 
If you specify a past time in relativeTimeFrom, as soon as the Universal Monitor task launches, the Controller searches for past events that match the Universal Monitor criteria. If the criteria is satisfied already, the Universal Monitor task goes immediately to SUCCESS status. Otherwise, the Controller continues monitoring until the criteria is met or until the relativeTimeTo time has passed.
Format: [+/-]hh:mm. Default is 00:00.
N
relativeTimeTo
To
If timeScope is Relative; Used for Universal Monitor tasks not associated with a trigger. Together with relativeTimeFrom, it allows you to specify a window of time, relative to the time the Universal Monitor task launched, during which the criteria of the Universal Monitor must be met. If the criteria is not met within the specified window, the Universal Monitor task goes to a FAILED status.
 
If the criteria of the Universal Monitor task is met before the relativeTimeTo time arrives, the Universal Monitor task goes to SUCCESS. If the criteria is not met by the relativeTimeTo time, the Universal Monitor task goes to FAILED status.
Format: [+/-]hh:mm.
N
filter
N/A
Universal Event criteria to monitor.
See Universal Events - Web Service API - Translate Filter
N