Versions Compared

Key

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

Anchor
Task Properties -

...

Universal Monitor Task
Task Properties -

...

Universal Monitor Task
Task Properties

...


Property

UI Field Name

Description

Specifications

Required

Anchor
eventTemplate - UM
eventTemplate - UM
eventTemplate

Universal Event Template

Universal Event Template name.

XML

Code Block
languagetext
linenumberstrue
<eventTemplate label="Test Event A">test_event_a</eventTemplate>

 
JSON

Code Block
languagetext
linenumberstrue
"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

Anchor
filter - UM
filter - UM
filter

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

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
languagetext
linenumberstrue
<templateEventTemplate label="Test Event B">test_event_b</templateEventTemplate>

 
JSON

Code Block
languagetext
linenumberstrue
"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


Filter/Criteria Properties

Property

UI Field Name

Description

Specifications

Required


Anchor
logicalOperator - UMF
logicalOperator - UMF
logicalOperator

Match All

Match Any


Valid values:

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

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

Default is And (1).



N

Code Block
languagetext
linenumberstrue
        "criteria": [
            {
                "type": "criterion",
                "name": "int",
                "operator": "EQUALS",
                "value": "5"
            },
            {
                "type": "criteria",
                "criteria": [
                    {
                        "type": "criterion",
                        "name": "text",
                        "operator": "IS_NULL"
                    },
                    {
                        "type": "criterion",
                        "name": "bool",
                        "operator": "EQUALS",
                        "value": "true"
                    }
                ],
                "logicalOperator": "And"
            }
        ]


Anchor
criterion - UMF
criterion - UMF
criterion






N


Anchor
criteria - UMF
criteria - UMF
criteria




N


Anchor
type - UMF
type - UMF
type



For JSON only.

Valid values:

  • As String = criterion

  • As String = criteria

Default is criterion.

N

Anchor
name - UMF
name - UMF
name




Y

Anchor
operator - UMF
operator - UMF
operator



Valid values (case insensitive) :

  • As String = EQUALS

  • As String = NOT_EQUALS

  • As String = IN

  • As String = NOT_IN

  • As String = GREATER_THAN

  • As String = LESS_THAN

  • As String = GT_OR_EQUALS

  • As String = LT_OR_EQUALS

  • As String = STARTS_WITH

  • As String = ENDS_WITH

  • As String = CONTAINS

  • As String = DOES_NOT_START_WITH

  • As String = DOES_NOT_END_WITH

  • As String = DOES_NOT_CONTAIN

  • As String = IS_NULL

  • As String = IS_NOT_NULL

  • As String = BETWEEN

Y

Anchor
value - UMF
value - UMF
value




Y - if operator is either:

  • CONTAINS
  • DOES_NOT_CONTAIN
  • STARTS_WITH
  • DOES_NOT_START_WITH
  • ENDS_WITH
  • DOES_NOT_END_WITH
  • EQUALS
  • NOT_EQUALS
  • LESS_THAN
  • LT_OR_EQUALS
  • GREATER_THAN
  • GT_OR_EQUALS

Anchor
values - UMF
values - UMF
values




Y - if operator is either:

  • IN
  • NOT_IN

Anchor
start - UMF
start - UMF
start



start should be less than or equal to end.

Y - if operator is:

  • BETWEEN

Anchor
end - UMF
end - UMF
end



start should be less than or equal to end.

Y - if operator is:

  • BETWEEN