...
Property | UI Field Name | Description | Specifications | Required | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Event Type | Type of Universal Event to monitor. | Valid values: one of the following (not case sensitive):
| Y |
| Universal Event Template | Universal Event Template name. XML
| The | Y | |||||||||||||||||||||||||||||
| Event Type | Type of Universal Event to monitor. | Valid values: one of the following (not case sensitive):
| Y | ||||||||||||||||||||||||||||||||||
| Expiration Action | If | Valid values:
Default is Failed (1). | N | ||||||||||||||||||||||||||||||||||
The | ||||||||||||||||||||||||||||||||||||||
Anchor | timeScope - UM | timeScope - UM | timeScopeTime Scope | For Universal Monitor tasks not associated with a trigger; Used to create a window during which the Universal Monitor conditions must be met in order for the Universal Monitor to be satisfied. The For example, if you specify -01:00 in | Valid values:
| Universal Template | Universal Template name. | Y | ||||||||||||||||||||||||||||||
Anchor | templateEventTemplate - UM | templateEventTemplate - UM | templateEventTemplateUniversal Template Event Template |
Code Block | ||||
---|---|---|---|---|
| ||||
<templateEventTemplate label="Test Event B">test_event_b</templateEventTemplate> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"templateEventTemplate": {
"label": "Test Event B",
"value": "test_event_b"
} |
filter
n/a
Universal Event criteria to monitor.
N
relativeTimeFrom Anchor relativeTimeFrom - UM relativeTimeFrom - UM
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 criteria 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 Anchor relativeTimeTo - UM relativeTimeTo - UM
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
Anchor
taskUniversal - UM
taskUniversal - UM
N/A
taskUniversal
Universal Extension-based Universal Task that will be:
- Launched when the Universal Monitor task starts.
- Force Finished/Cancelled when the Universal Monitor task ends.
template Anchor template - UM template - UM
Universal Template
Universal Template name.
Y
(if eventType
is Local
)
templateEventTemplate Anchor templateEventTemplate - UM templateEventTemplate - UM
Universal Template Event Template
Universal Template Event Template name.
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<templateEventTemplate label="Test Event B">test_event_b</templateEventTemplate> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"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 Anchor timeScope - UM timeScope - UM
Time Scope
For Universal Monitor tasks not associated with a trigger; 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 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