Anchor
Task Properties -

...

Universal Monitor Task Task Properties -

...

Universal Monitor Task

Task Properties

...

eventType

Valid values: one of the following (not case sensitive):

As String = Global, As Value = 1

As String = Local, As Value = 2

Property	UI Field Name	Description	Specifications	Required
Anchor
eventType - UM	eventType - UM	Event Type	Type of Universal Event to monitor.		Y
Anchor eventTemplate - UM eventTemplate - UM eventTemplate	Universal Event Template	Universal Event Template name. XML Code Block language xmltext 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
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 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

Filter Properties

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

"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"
    }
]

Criteria Properties

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

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

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

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

Criterion Properties

<start>
    <value>5</value>
</start>

"start": {
     "value": "5"
}

<end>
    <value>6</value>
</end>

"end": {
     "value": "6"
}