Property | UI Field Name | Description | Specifications | Required |
---|
Anchor |
---|
| eventTemplate - UM |
---|
| eventTemplate - UM |
---|
| eventTemplate
| Universal Event Template | Universal Event Template name. XML Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| <eventTemplate label="Test Event A">test_event_a</eventTemplate> |
JSON Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| "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 ) |
Anchor |
---|
| eventType - UM |
---|
| eventType - UM |
---|
| 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 |
Anchor |
---|
| expirationAction - UM |
---|
| expirationAction - UM |
---|
| expirationAction
| Expiration Action | If timeScope is 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 |
| n/a | Universal Event criteria to monitor. |
| N |
Anchor |
---|
| relativeTimeFrom - UM |
---|
| relativeTimeFrom - UM |
---|
| relativeTimeFrom
| 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 |
Anchor |
---|
| relativeTimeTo - UM |
---|
| relativeTimeTo - UM |
---|
| 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 |
Anchor |
---|
| taskUniversal - UM |
---|
| taskUniversal - UM |
---|
| taskUniversal
| Universal Task Publisher | Universal Extension-based Universal Task that will be: - Launched when the Universal Monitor task starts.
- Force Finished/Cancelled when the Universal Monitor task ends.
|
| N |
taskUniversalVariables | Universal Task Publisher Variables | List of variables to override. Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <taskUniversalVariables>
<variable>
<name>v_enabled</name>
<value>${var}</value>
<resolution>Enabled</resolution>
</variable>
<variable>
<name>v_disabled</name>
<value>${var}</value>
<resolution>Disabled</resolution>
</variable>
</taskUniversalVariables> |
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| "taskUniversalVariables": [
{
"name": "v_enabled",
"resolution": "Enabled",
"value": "${var}"
},
{
"name": "v_disabled",
"resolution": "Disabled",
"value": "${var}"
}
] |
| NameName of the variable to override. Value Value of the variable to override. Resolution Type of resolution for the override: Disabled Variable is passed to the launched Universal Task Publisher unresolved and will remain unresolved in the Universal Monitor Task Instance Details. Enabled Variable is resolved when the Universal Monitor Task Instance is started (running); therefore, it is passed to the launched Universal Task Publisher resolved and will remain resolved in the Universal Monitor Task Instance Details. If an Enabled variable cannot be resolved when the Universal Monitor Task Instance is being started, the Universal Monitor Task Instance will transition to a Start Failure with the following Status Description: Universal Task Publisher Variable "variable-name" with Resolution "variable-resolution" is unresolved.
| N |
Anchor |
---|
| template - UM |
---|
| template - UM |
---|
| template
| Universal Template | Universal Template name. |
| Y (if eventType is Local ) |
Anchor |
---|
| templateEventTemplate - UM |
---|
| templateEventTemplate - UM |
---|
| templateEventTemplate
| Universal Template Event Template | Universal Template Event Template name. XML
Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| <templateEventTemplate label="Test Event B">test_event_b</templateEventTemplate> |
JSON Code Block |
---|
language | text |
---|
linenumbers | true |
---|
| "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 )
|
Anchor |
---|
| timeScope - UM |
---|
| timeScope - UM |
---|
| timeScope
| 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 |