Task Properties

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

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

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

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

Criteria Properties

Property

UI Field Name

Description

Specifications

Required

type

n/a

Specifies the type of an element in the criteria list.

For JSON only.

Valid values:

As String = criterion
As String = criteria

Default is criterion.

N

criterion

n/a

A single condition composed of name, operator, value(s).

For example:

“attribute1 EQUALS value1“ where attribute1 is a attribute of the selected Universal Event Template.

XML

XML

<criterion>
    <name>attribute1</name>
    <operator>EQUALS</operator>
    <value>value1</value>
</criterion>

JSON

JSON

    {
        "type": "criterion",
        "name": "attribute1",
        "operator": "EQUALS",
        "value": "value1"
    },

N

criteria

n/a

Composed of multiple elements and a logical operator And or Or.

An element can be a criterion or a inner criteria.

XML

XML

<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

JSON

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

N

Criterion Properties

Property	UI Field Name	Description	Specifications	Required
`name`	n/a	Name of the attribute	Input data will be converted to lowercase.	Y
`operator`	n/a		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
`value`	n/a			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
`value`s	n/a			Y - if operator is either: IN NOT_IN
`start`	n/a		start should be less than or equal to end. XML XML <start> <value>5</value> </start> JSON JSON "start": { "value": "5" }	Y - if operator is: BETWEEN
`end`	n/a		start should be less than or equal to end. XML XML <end> <value>6</value> </end> JSON JSON "end": { "value": "6" }	Y - if operator is: BETWEEN

Universal Controller 7.3.x

Universal Monitor Task Properties

Task Properties

Filter Properties

Criteria Properties

Criterion Properties