Anchor | ||||
---|---|---|---|---|
|
Property | UI Field Name | Description | Specifications | Required |
---|
eventType | Event Type | Type of Universal Event to monitor. | Valid values: one of the following (not case sensitive):
| Y | |||||
eventTemplate | Universal Event Template | Universal Event Template name. XML
| The | Y | |||||
expirationAction | Expiration Action | If timeScopeis Relative; Specify the Expiration Action to specify the timeout Execution status. | Valid values:
Default is Failed (1). | N |
timeLimit
Time Limit
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
| 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; |
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 |
time |
that the |
Universal Monitor |
N
timeLimitUnit
Time Limit Unit
Unit of time to use for timeLimit
.
Valid Values:
Default is Hours (3launched. 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:
Default is – None – (0). | N |
relativeTimeFrom |
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:
Default is = (1)
N
valueMonitorType
Value Monitor Type
Type of monitoring to be done on the Variable value.
Valid values:
Default is Current (1).
N
variableName
Variable to Monitor
Name of the variable to monitor.
Variables are supported.
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. | 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. | Format: [+/-]hh:mm. | N |
filter | N/A | Universal Event criteria to monitor. | N |