/
Universal Monitor Task Properties

Universal Monitor Task Properties

Jul 10, 2024

Task Properties

 

Property

UI Field Name

Description

Specifications

Required

Property

UI Field Name

Description

Specifications

Required

eventTemplate

Universal Event Template

Universal Event Template name.

XML

<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)

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

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

filter

n/a

Universal Event criteria to monitor.

 

N

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

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

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.

 

 

<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>
"taskUniversalVariables": [ { "name": "v_enabled", "resolution": "Enabled", "value": "${var}" }, { "name": "v_disabled", "resolution": "Disabled", "value": "${var}" } ]

N

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

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

 

Filter Properties

Property

UI Field Name

Description

Specifications

Required

Property

UI Field Name

Description

Specifications

Required

logicalOperator

Match All

Match Any

Specifies that the Universal Monitor task instance should go to SUCCESS status when ALL or ANY of the criteria is met.

Valid values:

  • As String = And (case insensitive), and As Value = 1

  • As String = Or (case insensitive), As Value = 2

Default is And (1).

N

criteria

n/a

Criteria list.

An element in the list is of type criterion or criteria.

The following example represent a criteria list consisted of two elements:

  • One element of type criterion.

  • One element of type criteria.

Note

In JSON, the two elements are wrapped in the “criteria“:[] property.

However, in XML, there is no additional <criteria></criteria> tag to wrap the two elements.

XML

<criterion> <name>int</name> <operator>EQUALS</operator> <value>5</value> </criterion> <criteria> <criterion> <name>ifield</name> <operator>IS_NULL</operator> </criterion> <criterion> <name>bool</name> <operator>EQUALS</operator> <value>true</value> </criterion> <logicalOperator>And</logicalOperator> </criteria>

JSON

"criteria": [ { "type": "criterion", "name": "int", "operator": "EQUALS", "value": "5" }, { "type": "criteria", "criteria": [ { "type": "criterion", "name": "ifield", "operator": "IS_NULL" }, { "type": "criterion", "name": "bool", "operator": "EQUALS", "value": "true" } ], "logicalOperator": "And" } ]

N

eventBusinessServiceCriteria

Event Business Service Criteria

Specifies the type of business service filtering to apply when monitoring on Universal Events.

Valid values (case-insensitive):

  • As String = Member of Any Business Service or Unassigned, As Value = 1

  • As String = Member of Specific Business Services or Unassigned, As Value = 2

  • As String = Member of Specific Business Services, As Value = 3

  • As String = Unassigned, As Value = 4

Default is Member of Any Business Service or Unassigned (1).

N

eventBusinessServices

Event Member of Business Services

Specifies one or more business services to filter on when Event Business Service Criteria is one of the following.

  • Member of Specific Business Services or Unassigned

  • Member of Specific Business Services

XML

<eventBusinessServices> <businessService>A</businessService> <businessService>B</businessService> </eventBusinessServices>

JSON

"eventBusinessServices": ["A, "B"]

N