Composite Trigger Web Services

Owned by Stonebranch (Deactivated)
Last updated: Jul 18, 2023
43 min read

Overview

Universal Controller supports the following RESTful-based web services for Composite Trigger operations, which are listed alphabetically on this page.

Formatting specifications for each web service, including details about parameter requirements, are provided.
 

Note

For information on Trigger web services that are applicable to all trigger types, see:

Create a Composite Trigger


Description

URI

http://host_name/uc/resources/trigger

HTTP Method

POST

Description

Retrieves information for the specified trigger.

Example URI

http://localhost:8080/uc/resources/trigger

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Composite Trigger: XML and JSON Examples.

Trigger Properties

Trigger Component Properties

Trigger-Related Record Properties

Example Response

  • Status 200 /OK
    Successfully created the <trigger type> trigger.

List Component Events for a Composite Trigger 


 Description

Consumes Content-Type

Application/XML & Application/JSON

Description

List component events

Authentication

HTTP Basic

URI

http://host_name/uc/resources/trigger/listcomponentevents

http://host_name/uc/resources/trigger/listComponentEvents

HTTP Method

GET

Example URI

http://localhost:8080/uc/resources/trigger/listcomponentevents?triggername=test

http://localhost:8080/uc/resources/trigger/listComponentEvents?triggername=test

http://localhost:8080/uc/resources/trigger/listcomponentevents?triggerid=123456789

http://localhost:8080/uc/resources/trigger/listComponentEvents?triggerid=123456789

Example Response See List Component Events: XML and JSON Examples
Trigger PropertiesSee Read a Composite Trigger: URI Parameters.

Produces Content-Type

 application/xml, application/json


Modify a Composite Trigger


Description

URI

http://host_name/uc/resources/trigger

HTTP Method

PUT

Description

Modifies the trigger specified by the sysId in the Example Request.
 
To modify Composite Trigger properties without modifying related records, use the excludeRelated property.

Example URI

http://localhost:8080/uc/resources/trigger

Consumes Content-Type

application/xml, application/json

Produces Content-Type

n/a

Example Request

See Composite Trigger: XML and JSON Examples.

Trigger Properties

Trigger Component Properties

Trigger-Related Record Properties

Example Response

  • Status 200 /OK
    Successfully updated the <trigger type> trigger to version <version>.

Read a Composite Trigger


Description

URI

http://host_name/uc/resources/trigger

HTTP Method

GET

Description

Retrieves information for the specified trigger.

URI Parameters

See Read a Composite Trigger: URI Parameters.

Example URI

Consumes Content-Type

n/a

Produces Content-Type

application/xml, application/json

Trigger Properties

Trigger Component Properties

Trigger-Related Record Properties

Example Response

Read a Composite Trigger: URI Parameters

Name

Description

Specifications

Required

Mutually Exclusive With

triggerid

Unique ID for this trigger.


Y
(unless triggername
is specified)

triggername

triggername

Name used within the Controller to identify this trigger.

Maximum 40 alphanumerics.

Y
(unless triggerid
is specified)

triggerid

Composite Trigger: XML and JSON Examples

In the XML web service, the exportReleaseLevel, exportTable, retainSysIds, and version properties are specified as attributes in the <trigger> element.


Examples

XML

JSON

Example for Trigger

 XML
<triggerComposite exportReleaseLevel="7.2.0.0" exportTable="ops_trigger_composite" retainSysIds="true" version="1"> 
   <variables /> 
   <action>Do Not Trigger</action>
   <notes /> 
   <calendar>System Default</calendar> 
   <description />
   <disabledBy />
   <disabledTime />
   <enabled>true</enabled>
   <enabledBy>ops.admin</enabledBy>
   <enabledEnd>00:00</enabledEnd>
   <enabledStart>05:00</enabledStart>
   <enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
   <name>test composite trigger</name>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <opswiseGroups />
   <queueDepth>100</queueDepth
   <rdExcludeBackup>true</rdExcludeBackup
   <restriction>false</restriction>
   <restrictionAdjective>Every</restrictionAdjective>
   <restrictionComplex>false</restrictionComplex>
   <restrictionMode>Or</restrictionMode>
   <restrictionNouns>
      <restrictionNoun>Day</restrictionNoun>
   </restrictionNouns>
   <restrictionNthAmount />
   <restrictionQualifiers>
      <restrictionQualifier>Year</retsrictionQualifier>
   </restrictionQualifiers>
   <restrictionSimple>false</restrictionSimple>
   <retentionDuration>1</retentionDuration>
   <retentionDurationPurge>true</retentionDurationPurge>
   <retentionDurationUnit>Days</retentionDurationUnit>
   <situation>Holiday</situation>
   <skipAfterDate>2020-05-28</skipAfterDate>
   <skipAfterTime>02:15</skipAfterTime>
   <skipBeforeDate>2020-05-30</skipBeforeDate>
   <skipBeforeTime>17:30</skipBeforeTime>
   <skipCondition>None</skipCondition>
   <skipCount>0</skipCount>
   <skipDateList />
   <skipRestriction>Span</skipRestriction>
   <sysId>0fc6b7d9c0a801c9017b6c27c259937e</sysId>
   <tasks> <task>Sleep 30</task> </tasks>
   <timeLimit />
   <timeLimitUnits>Minutes</timeLimitUnits>
   <timeZone />
</triggerComposite>
 JSON
{ 
   "type": "triggerEm", 
   "action": "Do Not Trigger", 
   "calendar": "System Default", 
   "description": null,
   "disabledBy": "",
   "disabledTime": "",
   "enabled": true,
   "enabledBy": "ops.admin",
   "enabledEnd": "00:00",
   "enabledStart": "00:00",
   "enabledTime": "2021-03-03 12:46:11 -0500",
   "exportReleaseLevel": "7.2.0.0",
   "exportTable": "ops_trigger_composite",
   "name": "test composite trigger",
   "nextScheduledTime": "2021-03-04 00:00:00 -0500",
   "notes": [ ],
   "opswiseGroups": [ ],
   "queueDepth": 100,
   "rdExcludeBackup": true,
   "restriction": false,
   "restrictionAdjective": "Every",
   "restrictionComplex": false,
   "restrictionMode": "Or",
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "value": "Year"
      }
   ],
   "restrictionSimple": false, "retainSysIds": true,
   "retentionDuration": 1,
   "retentionDurationPurge": true,
   "retentionDurationUnit": "Days",
   "situation": "Holiday",
   "skipAfterDate": "2020-05-28",
   "skipAfterTime": "02:15",
   "skipBeforeDate": "2020-05-30",
   "skipBeforeTime": "17:30",
   "skipCondition": "None",
   "skipCount": 0,
   "skipDateList": [ ],
   "skipRestriction": "Span",
   "sysId": "9c659c9c2c72460c9a2057663257b0be",
   "tasks": [ "Sleep 30" ],
   "timeLimit": null,
   "timeLimitUnits": "Minutes",
   "timeZone": null,
   "variables": [ ],
   "version": 1 
}

Example for Trigger-Related Records

 XML
<variables>
   <variable>
         <description />
         <name>testVar</name>
         <value>value</value>
   </variable>
</variables>
 JSON
"variables": [ {
  "description": "description",
  "name": "var1",
  "value": "value1",
} ]

Example for Composite Trigger Components

 XML
 Composite Trigger: Time Component
<timeComponent> 
   <action>Do Not Trigger</action> 
   <description />
   <disabledBy></disabledBy>
   <disabledTime></disabledTime>
   <enabled>true</enabled>
   <enabledBy>ops.admin</enabledBy>
   <enabledEnd>00:00</enabledEnd> 
   <enabledStart>05:00</enabledStart>
   <enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
   <name>test special day</name>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <restrictionAdjective>Every</restrictionAdjective>
   <restrictionComplex>false</restrictionComplex
   <restrictionMode>Or</restrictionMode>
   <restrictionNouns>
      <restrictionNoun>Day</restrictionNoun>
   </restrictionNouns>
   <restrictionNthAmount />
   <restrictionQualifiers>
      <restrictionQualifier>Year</retsrictionQualifier>
   </restrictionQualifiers>
   <restrictionSimple>false</restrictionSimple>
   <situation>Holiday</situation>
   <sysId>0fc6b7d9c0a801c9017b6c27c259937e</sysId>
   <variablePrefix />
   <adjustInterval>false</adjustInterval>
   <adjustmentAmount>1</adjustmentAmount>
   <adjustmentType>Day</adjustmentType>
   <dateAdjective>Every</dateAdjective>
   <dateAdjustment>None</dateAdjustment>
   <dateNoun>Saturday1</dateNoun>
   <dateQualifier>Year</dateQualifier>
   <dayInterval>2</dayInterval>
   <dayStyle>Complex</dayStyle> 
   <eventMatchType>Single</eventMatchType>
   <fri>false</fri>
   <intervalStartingDate>2015-06-17</intervalStartingDate>
   <mon>false</mon>
   <nthAmount>5</nthAmount>
   <sat>false</sat>
   <simpleDateType>Daily</simpleDateType>
   <startTimeEnable>false</startTimeEnable>
   <startingAt>*:00</startingAt>
   <sun>false</sun>
   <thu>false</thu>
   time>00:00</time>
   <timeInterval />
   <timeIntervalUnits>Hours</timeIntervalUnits>
   <timeStyle>Absolute</timeStyle>
   <tue>false</tue>
   <wed>false</wed>
</timeComponent>


Composite Trigger: File Monitor Component

<fileMonitorComponent>
   <action>Do Not Trigger</action>
   <description />
   <disabledBy></disabledBy>
   <disabledTime></disabledTime>
   <enabled>true</enabled>
   <enabledBy>ops.admin</enabledBy>
   <enabledEnd>00:00</enabledEnd> 
   <enabledStart>05:00</enabledStart>
   <enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
   <name>test file monitor component</name>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <restrictedTimes>false</restrictedTimes>
   <restriction>false</restriction>
   <restrictionAdjective>Every</restrictionAdjective>
   <restrictionComplex>false</restrictionComplex>
   <restrictionMode>Or</restrictionMode>
   <restrictionNoun>Day</restrictionNoun>
   <restrictionNthAmount />
   <restrictionQualifier>Year</restrictionQualifier>
   <restrictionSimple>false</restrictionSimple>
   <situation>Holiday</situation>
   <sysId>5d2ac48e2dd64b5894bef1809a0e4d33</sysId>
   <variablePrefix />
   <fileMonitor>file monitor 1</fileMonitor>
</fileMonitorComponent>


Composite Trigger: Task Monitor Component

<taskMonitorComponent>
   <action>Do Not Trigger</action>
   <description />
   <disabledBy></disabledBy>
   <disabledTime></disabledTime>
   <enabled>true</enabled>
   <enabledBy>ops.admin</enabledBy>
   <enabledEnd>00:00</enabledEnd> 
   <enabledStart>05:00</enabledStart>
   <enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <restrictionComplex>false</restrictionComplex>
   <restrictionMode>Or</restrictionMode>
   <restrictionAdjective>Every</restrictionAdjective>
   <restrictionNoun>Day</restrictionNoun>
   <restrictionNthAmount />
   <restrictionQualifier>Year</restrictionQualifier>
   <restrictedTimes>false</restrictedTimes>
   <restriction>false</restriction>
   <restrictionComplex>false</restrictionComplex>
   <restrictionMode>Or</restrictionMode>
   <restrictionSimple>false</restrictionSimple>
   <situation>Holiday</situation>
   <sysId>2445dbd9e58546b69e5d5032f12646a4</sysId>
   <variablePrefix />
   <taskMonitor>test task monitor</taskMonitor
</taskMonitorComponent>



Composite Trigger: Variable Monitor Component

<variableMonitorComponent>
   <action>Do Not Trigger</action>
   <description />
   <disabledBy></disabledBy>
   <disabledTime></disabledTime>
   <enabled>true</enabled>
   <enabledBy>ops.admin</enabledBy>
   <enabledEnd>00:00</enabledEnd> 
   <enabledStart>05:00</enabledStart>
   <enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
   <name>test variable monitor component</name>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <restrictedTimes>false</restrictedTimes>
   <restriction>false</restriction>
   <restrictionAdjective>Every</restrictionAdjective>
   <restrictionComplex>false</restrictionComplex>
   <restrictionMode>Or</restrictionMode>
   <restrictionNoun>Day</restrictionNoun>
   <restrictionNthAmount />
   <restrictionQualifier>Year</restrictionQualifier>
   <restrictionSimple>false</restrictionSimple>
   <situation>Holiday</situation>
   <sysId>2445dbd9e58546b69e5d5032f12646a4</sysId>
   <variablePrefix />
   <variableMonitor>mon-1</variableMonitor> </variableMonitorComponent>


 
Composite Trigger: Email Monitor Component

<emailMonitorComponent>
   <action>Do Not Trigger</action>
   <description />
   <disabledBy></disabledBy>
   <disabledTime></disabledTime>
   <enabled>true</enabled>
   <enabledBy>ops.admin</enabledBy>
   <enabledEnd>00:00</enabledEnd> 
   <enabledStart>05:00</enabledStart>
   <enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
   <name>test email monitor component</name>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <restrictedTimes>false</restrictedTimes> 
   <restriction>false</restriction> 
   <restrictionAdjective>Every</restrictionAdjective> 
   <restrictionComplex>false</restrictionComplex> 
   <restrictionMode>Or</restrictionMode> 
   <restrictionNoun>Day</restrictionNoun> 
   <restrictionNthAmount /> 
   <restrictionQualifier>Year</restrictionQualifier> 
   <restrictionSimple>false</restrictionSimple> 
   <situation>Holiday</situation> 
   <sysId>2445dbd9e58546b69e5d5032f12646a4</sysId> 
   <variablePrefix /> 
   <emailMonitor>test-EM</emailMonitor> 
</emailMonitorComponent>

Composite Trigger: Universal Monitor Component

<universalMonitorComponent>
   <action>Do Not Trigger</action>
   <description />
   <disabledBy></disabledBy>
   <disabledTime></disabledTime>
   <enabled>true</enabled>
   <enabledBy>ops.admin</enabledBy>
   <enabledEnd>00:00</enabledEnd> 
   <enabledStart>05:00</enabledStart>
   <enabledTime>2021-03-03 12:46:11 -0500</enabledTime>
   <name>test universal monitor component</name>
   <nextScheduledTime>2021-03-04 00:00:00 -0500</nextScheduledTime>
   <restrictedTimes>false</restrictedTimes>
   <restriction>false</restriction>
   <restrictionAdjective>Every</restrictionAdjective>
   <restrictionComplex>false</restrictionComplex>
   <restrictionMode>Or</restrictionMode>
   <restrictionNoun>Day</restrictionNoun> 
   <restrictionNthAmount /> 
   <restrictionQualifier>Year</restrictionQualifier>
   <restrictionSimple>false</restrictionSimple>
   <situation>Holiday</situation>
   <sysId>2445dbd9e58546b69e5d5032f12646a4</sysId> 
   <variablePrefix /> 
   <universalMonitor>test-UM</universalMonitor> 
</universalMonitorComponent>


 JSON

Composite Trigger: Time Component

"timeComponents": [ 
   {
   "action": "Do Not Trigger",
   "adjustInterval": false,
   "adjustmentAmount": 1,
   "adjustmentType": "Day",
   "dateAdjective": "Every",
   "dateAdjustment": "None",
   "dateNoun": 
      {
         "value": "Day"
      },
   "dateQualifier": 
      {
         "value": "Year"
      },
   "dayInterval": 2,
   "dayStyle": "Simple",
   "description": null,
   "disabledBy": "",
   "disabledTime": "",
   "enabled": true,
   "enabledBy": "ops.admin",
   "enabledEnd": "00:00",
   "enabledStart": "00:00",
   "enabledTime": "2021-03-03 12:46:11 -0500",
   "eventMatchType": "Single", 
   "fri": false, 
   "intervalStartingDate": "2017-12-15", 
   "mon": false, 
   "name": "test special day",
   "nextScheduledTime": "2021-03-04 00:00:00 -0500",
   "nthAmount": 5, 
   "restrictedTimes": false, 
   "restriction": false, 
   "restrictionAdjective": "Every",
   "restrictionComplex": false, 
   "restrictionMode": "Or", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "value": "Year"
      }
   ],
   "restrictionSimple": false, 
   "sat": false, 
   "simpleDateType": "Daily", 
   "situation": "Holiday", 
   "startTimeEnable": false, 
   "startingAt": "*:00", 
   "sun": false, 
   "sysId": "b9c462f58a624a41a9a5ed824339cc00",
   "thu": false, 
   "time": "00:00", 
   "timeInterval": null, 
   "timeIntervalUnits": "Hours", 
   "timeStyle": "Absolute", 
   "tue": false, 
   "variablePrefix": null, 
   "wed": false 
   } 
],

 
Composite Trigger: File Monitor Component

"fileMonitorComponents": [ 
   {
   "action": "Do Not Trigger",
   "description": null,
   "disabledBy": "",
   "disabledTime": "",
   "enabled": true,
   "enabledBy": "ops.admin", 
   "enabledEnd": "00:00", 
   "enabledStart": "00:00",
   "enabledTime": "2021-03-03 12:46:11 -0500",
   "fileMonitor": "file monitor 1", 
   "name": "test file monitor component",
   "nextScheduledTime": "2021-03-04 00:00:00 -0500", 
   "restrictedTimes": false, 
   "restriction": false, 
   "restrictionAdjective": "Every",
   "restrictionComplex": false, 
   "restrictionMode": "Or", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "value": "Year"
      }
   ],
   "restrictionSimple": false, 
   "situation": "Holiday",
   "sysId": "4908349365b34c49998ff2a051163fa5",
   "variablePrefix": null } ],

 
Composite Trigger: Task Monitor Component

"taskMonitorComponents": [ 
   {
   "action": "Do Not Trigger",
   "description": null,
   "disabledBy": "",
   "disabledTime": "",
   "enabled": true,
   "enabledBy": "ops.admin",
   "enabledEnd": "00:00",
   "enabledStart": "00:00",
   "enabledTime": "2021-03-03 12:46:11 -0500",
   "name": "test task monitor component",
   "nextScheduledTime": "2021-03-04 00:00:00 -0500",
   "restrictedTimes": false, 
   "restriction": false, 
   "restrictionAdjective": "Every",
   "restrictionComplex": false, 
   "restrictionMode": "Or", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "value": "Year"
      }
   ],
   "restrictionSimple": false, 
   "situation": "Holiday", 
   "sysId": "4a557c7d82974960a1c9a45457b12eb8",
   "taskMonitor": "test task monitor",
   "variablePrefix": null 
   }
],

 
Composite Trigger: Variable Monitor Component

"variableMonitorComponents": [ 
   {
   "action": "Do Not Trigger",
   "description": null,
   "disabledBy": "",
   "disabledTime": "",
   "enabled": true,
   "enabledBy": "ops.admin",
   "enabledEnd": "00:00",
   "enabledStart": "00:00",
   "enabledTime": "2021-03-03 12:46:11 -0500",
   "name": "test variable monitor component",
   "nextScheduledTime": "2021-03-04 00:00:00 -0500",
   "restrictedTimes": false, 
   "restriction": false, 
   "restrictionAdjective": "Every",
   "restrictionComplex": false, 
   "restrictionMode": "Or", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "value": "Year"
      }
   ],
   "restrictionSimple": false, 
   "situation": "Holiday", 
   "sysId": "4ccf4458aa834b11a3f24dfe994c1c44",
   "variableMonitor": "mon-1", 
   "variablePrefix": null } ]


 
Composite Trigger: Email Monitor Component

"emailMonitorComponents": [ 
   {
   "action": "Do Not Trigger",
   "description": null,
    emailMonitor": "test-EM",
   "disabledBy": "",
   "disabledTime": "",
   "enabled": true,
   "enabledBy": "ops.admin",
   "enabledEnd": "00:00",
   "enabledStart": "00:00",
   "enabledTime": "2021-03-03 12:46:11 -0500",
   "name": "test email monitor component",
   "nextScheduledTime": "2021-03-04 00:00:00 -0500",
   "restrictedTimes": false, 
   "restriction": false, 
   "restrictionAdjective": "Every",
   "restrictionComplex": false, 
   "restrictionMode": "Or", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "value": "Year"
      }
   ],
   "restrictionSimple": false, 
   "situation": "Holiday",
   "sysId": "2c6f4ece771b44ec858e3c2df917e9ba",
   "variablePrefix": null 
    } 
]


Composite Trigger: Universal Monitor Component

"universalMonitorComponents": [ 
   {
   "action": "Do Not Trigger",
   "description": null,
   "universalMonitor": "test-UM",
   "disabledBy": "",
   "disabledTime": "",
   "enabled": true,
   "enabledBy": "ops.admin",
   "enabledEnd": "00:00",
   "enabledStart": "00:00",
   "enabledTime": "2021-03-03 12:46:11 -0500",
   "name": "test universal monitor component",
   "nextScheduledTime": "2021-03-04 00:00:00 -0500",
   "restrictedTimes": false, 
   "restriction": false, 
   "restrictionAdjective": "Every",
   "restrictionComplex": false, 
   "restrictionMode": "Or", 
   "restrictionNouns": [
      {
         "value": "Day"
      }
   ], 
   "restrictionNthAmount": null, 
   "restrictionQualifiers": [
      {
         "value": "Year"
      }
   ],
   "restrictionSimple": false, 
   "situation": "Holiday",
   "sysId": "2c6f4ece771b44ec858e3c2df917e9ba",
   "variablePrefix": null 
    } 
]

List Component Events - Response 

 XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<triggerComponentEvents>
    <components>
        <component>
            <events>
                <event>
                    <variables>
                        <variable>
                            <name>ops_agent_hostnametrigger_task_type</name>
                            <value>Timer</value>
                        </variable>
                        <variable>
                            <name>ops_agent_hostnametrigger_task_id</name>
                            <value>1667584757059011268LVS3MYPI4DTHN</value>
                        </variable>
                        <variable>
                            <name>ops_agent_hostnametrigger_component_event_time</name>
                            <value>2022-11-04 14:01:38 -0400</value>
                        </variable>
                        <variable>
                            <name>ops_agent_hostnametrigger_task_name</name>
                            <value>Sleep 15</value>
                        </variable>
                        <variable>
                            <name>ops_agent_hostnametrigger_task_status</name>
                            <value>SUCCESS</value>
                        </variable>
                    </variables>
                    <created>2022-11-04 14:01:38 -0400</created>
                    <position>1</position>
                </event>
            </events>
            <eventCount>1</eventCount>
            <name>task-mon-comp</name>
            <type>Task Monitor</type>
        </component>
        <component>
            <events>
                <event>
                    <variables>
                        <variable>
                            <name>ops_agent_hostnametrigger_component_event_time</name>
                            <value>2022-11-04 14:00:35 -0400</value>
                        </variable>
                    </variables>
                    <created>2022-11-04 14:00:35 -0400</created>
                    <position>1</position>
                </event>
                <event>
                    <variables>
                        <variable>
                            <name>ops_agent_hostnametrigger_component_event_time</name>
                            <value>2022-11-04 14:01:35 -0400</value>
                        </variable>
                    </variables>
                    <created>2022-11-04 14:01:35 -0400</created>
                    <position>2</position>
                </event>
                <event>
                    <variables>
                        <variable>
                            <name>ops_agent_hostnametrigger_component_event_time</name>
                            <value>2022-11-04 14:02:35 -0400</value>
                        </variable>
                    </variables>
                    <created>2022-11-04 14:02:35 -0400</created>
                    <position>3</position>
                </event>
                <event>
                    <variables>
                        <variable>
                            <name>ops_agent_hostnametrigger_component_event_time</name>
                            <value>2022-11-04 14:04:32 -0400</value>
                        </variable>
                    </variables>
                    <created>2022-11-04 14:04:32 -0400</created>
                    <position>4</position>
                </event>
                <event>
                    <variables>
                        <variable>
                            <name>ops_agent_hostnametrigger_component_event_time</name>
                            <value>2022-11-04 14:04:35 -0400</value>
                        </variable>
                    </variables>
                    <created>2022-11-04 14:04:35 -0400</created>
                    <position>5</position>
                </event>
            </events>
            <eventCount>5</eventCount>
            <name>time-comp-1</name>
            <type>Time</type>
        </component>
        <component>
            <events/>
            <eventCount>0</eventCount>
            <name>var-mon-comp</name>
            <type>Variable Monitor</type>
        </component>
    </components>
    <description />
    <name>comp-trig-1</name>
    <queueDepth>100</queueDepth>
    <timeLimit>5</timeLimit>
    <timeLimitUnits>Minutes</timeLimitUnits>
</triggerComponentEvents>
 JSON
{
    "components": [
        {
            "description": null,
            "eventCount": 1,
            "events": [
                {
                    "created": "2022-11-04 14:01:38 -0400",
                    "position": 1,
                    "variables": [
                        {
                            "name": "ops_agent_hostnametrigger_task_type",
                            "value": "Timer"
                        },
                        {
                            "name": "ops_agent_hostnametrigger_task_id",
                            "value": "1667584757059011268LVS3MYPI4DTHN"
                        },
                        {
                            "name": "ops_agent_hostnametrigger_component_event_time",
                            "value": "2022-11-04 14:01:38 -0400"
                        },
                        {
                            "name": "ops_agent_hostnametrigger_task_name",
                            "value": "Sleep 15"
                        },
                        {
                            "name": "ops_agent_hostnametrigger_task_status",
                            "value": "SUCCESS"
                        }
                    ]
                }
            ],
            "name": "task-mon-comp",
            "type": "Task Monitor"
        },
        {
            "description": null,
            "eventCount": 5,
            "events": [
                {
                    "created": "2022-11-04 14:01:35 -0400",
                    "position": 1,
                    "variables": [
                        {
                            "name": "ops_agent_hostnametrigger_component_event_time",
                            "value": "2022-11-04 14:01:35 -0400"
                        }
                    ]
                },
                {
                    "created": "2022-11-04 14:02:35 -0400",
                    "position": 2,
                    "variables": [
                        {
                            "name": "ops_agent_hostnametrigger_component_event_time",
                            "value": "2022-11-04 14:02:35 -0400"
                        }
                    ]
                },
                {
                    "created": "2022-11-04 14:04:32 -0400",
                    "position": 3,
                    "variables": [
                        {
                            "name": "ops_agent_hostnametrigger_component_event_time",
                            "value": "2022-11-04 14:04:32 -0400"
                        }
                    ]
                },
                {
                    "created": "2022-11-04 14:04:35 -0400",
                    "position": 4,
                    "variables": [
                        {
                            "name": "ops_agent_hostnametrigger_component_event_time",
                            "value": "2022-11-04 14:04:35 -0400"
                        }
                    ]
                },
                {
                    "created": "2022-11-04 14:05:35 -0400",
                    "position": 5,
                    "variables": [
                        {
                            "name": "ops_agent_hostnametrigger_component_event_time",
                            "value": "2022-11-04 14:05:35 -0400"
                        }
                    ]
                }
            ],
            "name": "time-comp-1",
            "type": "Time"
        },
        {
            "description": null,
            "eventCount": 0,
            "events": [],
            "name": "var-mon-comp",
            "type": "Variable Monitor"
        }
    ],
    "description": null,
    "name": "comp-trig-1",
    "queueDepth": 100,
    "timeLimit": 5,
    "timeLimitUnits": "Minutes"
}
Examples for Trigger-Related Records

Variables

 XML
<variables>
   <variable>
         <description />
         <name>testVar</name>
         <value>value</value>
   </variable>
</variables>

Notes

 XML
<notes>
   <note>
         <sysId>76ad570c64b84f84aeaf281403856b10</sysId>
         <text>testNoteText</text>
         <title>testNoteTitle</title>
   </note>
</notes>

Variables

 JSON
"variables": [ {
  "description": "description",
  "name": "var1",
  "value": "value1"
} ]

Notes

 JSON
"notes": [ {
  "sysId": "76ad570c64b84f84aeaf281403856b10",
  "text": "testNoteText",
  "title": "testNoteTitle"
} ]

Properties

Trigger Properties - All Triggers


Property

UI Field Name

Description

Specifications

Required

action

Action

For all trigger types except Manual and Temporary; Action to take on a non-business day or holiday (see situation).

Valid values:

  • As String = Do Not Trigger, As Value = 1
  • As String = Next Day, As Value = 2
  • As String = Next Business Day, As Value = 3
  • As String = Previous Day, As Value = 4
  • As String = Previous Business Day, As Value = 5

Default is Do Not Trigger (1).
 

Note

The following values are valid only for Cron and Time triggers:

  • Next Day (2)
  • Next Business Day (3)
  • Previous Day (4)
  • Previous Business Day (5)

Y
(if restriction
is true.)

calendar

Calendar

Calendar that defines the business days, holidays, and other special days that determine the run dates for the task(s) specified in the trigger.
 
The Calendar will be used to verify any Custom Day references in restrictionNoun and dateNoun.

Default is System Default.

Y

customField1

n/a

User-Defined field.
 
Example: <customField1 label="Domain">web.com</customField1>

The label is included only if a value has been defined for the User Defined Trigger Field 1 Label Universal Controller system property.

N

customField2

n/a

User-Defined field.
 
Example: <customField2 label="Domain">web.com</customField2>

The label is included only if a value has been defined for the User Defined Trigger Field 2 Label Universal Controller system property.

N

description

Description

Description of this trigger.


N

disabledBy

Disabled BySystem-supplied. If Status = Enabled, ID of the user who most recently disabled this trigger.Read-only.N

disabledTime

Disabled TimeSystem-supplied. If Status = Enabled, Date and time that the trigger was disabled.Read-only.N

enabled

Status

System-defined; Specification for whether or nor the trigger is enabled. Only enabled triggers are processed by the Controller.

Read-only.N

enabledBy

Enabled By

System-supplied. If Status = Enabled, ID of the user who most recently enabled this trigger.

Read-only.N

enabledTime

Enabled Time

System-supplied. If Status = Enabled, Date and time that the trigger was enabled.

Read-only.N
enforceVariablesEnforce VariablesSpecifies whether or not to enforce Override Trigger Variables when using Trigger Now... from the User Interface. Not applicable for Web Service APIs.Valid values: true/false. Default is false.N

excludeRelated

n/a

For Modify Trigger web services; specification for whether or not to exclude related records from the update, even if they are provided in the request.
 

Note

In XML web services, excludeRelated is specified as an attribute in the <trigger> element.

Valid values: true/false (default is false).

N

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

Note

In XML web services, exportReleaseLevel is specified as an attribute in the <trigger> element.

read onlyN

exportTable

n/a

Record table information.

Note

In XML web services, exportTable is specified as an attribute in the <trigger> element.

read onlyN

forecast

Forecast

For Cron, Temporary, and Time triggers only; Date and time when this trigger will be satisfied for the next number days, as specified in the Forecast Period In Days Universal Controller system property. The Controller writes the forecasting entries to the Forecasts List.

Boolean; Valid values: true/false. Default is false.

N

lockVariablesLock Variables

Specifies whether or not to prevent editing variables when using Trigger Now... from the User Interface. Not applicable for Web Service APIs.

Boolean; Valid values: true/false. Default is false.N

name

Name

Name used within the Controller to identify this trigger.

Maximum 255 alphanumerics.

Y

nextScheduledTime

Next Scheduled Time

System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information.

Read-only.N

opswiseGroups

Member of Business Services

List of Business Service(s) that this trigger belongs to.
 
XML

 
JSON


N

rdExcludeBackup

Exclude Backup

Set only if retentionDurationPurge is selected; Specification for whether qualifying task instances can be excluded from the backup when being purged by retention duration.

Boolean; Valid values: true/false. Default is false.

N

restriction

Special Restriction

Indication of whether or not you want to specify additional parameters that tell the Controller how to handle exceptions, such as when the trigger is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a simpleRestriction that disables the trigger if it is satisfied on a holiday identified in the calendar and/or a restrictionComplex that disables the trigger on the last business day of every month.

Boolean; Valid values: true/false. Default is false.

N

restrictionAdjective

Restriction Adjective

Type of selection for restrictionNoun.

Valid values:

  • As String = Every, As Value = 0
  • As String = 1st, As Value = 1
  • As String = 2nd, As Value = 2
  • As String = 3rd, As Value = 3
  • As String = 4th, As Value = 4
  • As String = Last, As Value = 5
  • As String = Nth, As Value = 6

Default is Every (0).

Y
(if restrictionComplex
is enabled)

restrictionComplex

Complex Restriction

Set only if restriction is true; Set of parameters that determine one or more situations when this trigger should not be satisfied. Used in conjunction with restrictionMode, restrictionAdjective, restrictionNoun, and restrictionQualifier. For example, you can specify that you do not want to satisfy this trigger on the last business day of the year or the first day of each month.

Boolean; Valid values: true/false. Default is false.

Y
(if restrictionSimple
is false.)

restrictionMode

Restriction Mode

Set only if restrictionSimple is true; Specification for whether you want to use restrictionSimple- and/or restrictionComplex-related values.

Valid values:

  • As String = And, As Value = 1
  • As String = Or, As Value = 2

Default is Or (2).

Y
(if restrictionSimple
and restrictionComplex
are true.)

restrictionNoun

Restriction Noun

Day to restrict the trigger to.
 
To specify a Custom Day, use the name of the Custom Day. For example:
 
XML
<restrictionNoun>CustomDay1</restrictionNoun>
 
JSON
"restrictionNoun": {
    "value": "CustomDay1"
}
 
To specify a Local Custom Day, use the local attribute. For example:
 
XML
<restrictionNoun local="true">CustomDay2</restrictionNoun>
 
JSON
"restrictionNoun": {
    "local": "true",
    "value": "CustomDay2"
}
 

Note

The Calendar for the trigger is used to verify Custom Day references.

Valid values:

  • As String = Sunday, As Value = 1
  • As String = Monday, As Value = 2
  • As String = Tuesday, As Value = 3
  • As String = Wednesday, As Value = 4
  • As String = Thursday, As Value = 5
  • As String = Friday, As Value = 6
  • As String = Saturday, As Value = 7
  • As String = Day, As Value = 8
  • As String = Business Day, As Value = 9

Y
(if restrictionComplex
is true.)

restrictionNouns

Restriction Noun(s)

Day to restrict the trigger to.

Used with restrictionAdjective, restrictionQualifiers, and restrictionNthAmount (if restrictionAdjective is Nth) to specify the type of days you want to select. For example, to specify "the 1st business day of the month," select restrictionAdjective as 1st, restrictionNouns as Business Day, and restrictionQualifiers as Month.

Example:

<restrictionNouns>
  <restrictionNoun>Business Day</restrictionNoun>
</restrictionNouns>


To specify a Custom Day, use the name of the Custom Day. For example:

XML

<restrictionNouns>
  <restrictionNoun>Monday</restrictionNoun>
  <restrictionNoun>CustomDay1</restrictionNoun>
</restrictionNouns>

JSON

"restrictionNouns": [
  {
    "value": "Monday"
  },
  {
    "value": "CustomDay1"
  }
]


To specify a Local Custom Day, use the local attribute. For example:

XML

<restrictionNouns>
  <restrictionNoun local="true">CustomDay2</restrictionNoun>
</restrictionNouns>

JSON

"restrictionNouns": [
  {
    "local": true,
    "value": "CustomDay1"
  }
]

Note

The Calendar for the trigger is used to verify Custom Day references.

Valid values:

  • As String = Sunday, As Value = 1
  • As String = Monday, As Value = 2
  • As String = Tuesday, As Value = 3
  • As String = Wednesday, As Value = 4
  • As String = Thursday, As Value = 5
  • As String = Friday, As Value = 6
  • As String = Saturday, As Value = 7
  • As String = Day, As Value = 8
  • As String = Business Day, As Value = 9
  • Custom Days specified in the calendar selected in a Workflow calendar.
Y
(if restrictionComplex
is true)

restrictionNthAmount

Restriction Nth Amount

Set only if restrictionAdjective is Nth (6); value of N.

Integer

Y
(if restrictionAdjective
is Nth.)

restrictionQualifier

Restriction Qualifier

Period to restrict the trigger to.
 
To specify a Custom Day Period, use the name of the Custom Day Period. For example:
 
XML
<restrictionQualifier>CustomDayPeriod1</restrictionQualifier>
 
JSON
"restrictionQualifier": {
    "value": "CustomDayPeriod1"
}
 
To specify a Local Custom Day Period, use the local attribute. For example:
 
XML
<restrictionQualifier local="true">CustomDayPeriod2</restrictionQualifier>
 
JSON
"restrictionQualifier": {
    "local": "true",
    "value": "CustomDayPeriod2"
}
 

Note

The Calendar for the trigger is used to verify Custom Day references.

Valid values:

  • As String = Jan, As Value = 0
  • As String = Feb, As Value = 1
  • As String = Mar, As Value = 2
  • As String = Apr, As Value = 3
  • As String = May, As Value = 4
  • As String = Jun, As Value = 5
  • As String = Jul, As Value = 6
  • As String = Aug, As Value = 7
  • As String = Sep, As Value = 8
  • As String = Oct, As Value = 9
  • As String = Nov, As Value = 10
  • As String = Dec, As Value = 11
  • As String = Month, As Value = 12
  • As String = Year, As Value = 13

Y
(if restrictionComplex
is true.)

restrictionQualifiers

Restriction Qualifier(s)

Period to restrict the trigger to.

Used with restrictionAdjective, restrictionQualifiers, and restrictionNthAmount (if restrictionAdjective is Nth) to specify the type of days you want to select. For example, to specify "the 1st business day of the month," select restrictionAdjective as 1st, restrictionNouns as Business Day, and restrictionQualifiers as Month.

Example:

<restrictionQualifiers>
  <restrictionQualifier>Month</restrictionQualifier>
</restrictionQualifiers>


To specify a Custom Day, use the name of the Custom Day. For example:

XML

<restrictionQualifiers>
  <restrictionQualifier>Jan</restrictionQualifier>
  <restrictionQualifier>CustomDay1</restrictionQualifier>
</restrictionQualifiers>

JSON

"restrictionQualifiers": [
  {
    "value": "Jan"
  },
  {
    "value": "CustomDay1"
  }
]

To specify a Local Custom Day, use the local attribute. For example:

XML

<restrictionQualifiers>
  <restrictionQualifier local="true">CustomDay2</restrictionQualifier>
</restrictionQualifiers>

JSON

"restrictionQualifiers": [
  {
    "local": true,
    "value": "CustomDay1"
  }
]

Note

The Calendar for the trigger is used to verify Custom Day references.

Valid values:

  • As String = Jan, As Value = 0
  • As String = Feb, As Value = 1
  • As String = Mar, As Value = 2
  • As String = Apr, As Value = 3
  • As String = May, As Value = 4
  • As String = Jun, As Value = 5
  • As String = Jul, As Value = 6
  • As String = Aug, As Value = 7
  • As String = Sep, As Value = 8
  • As String = Oct, As Value = 9
  • As String = Nov, As Value = 10
  • As String = Dec, As Value = 11
  • As String = Month, As Value = 12
  • As String = Year, As Value = 13
  • As String = Week, As Value = 14
  • As String = Quarter, As Value = 15
Y
(if restrictionComplex
is true)

restrictionSimple

Simple Restriction

Set only if restriction is true; Specification to set a simple restriction based on a specific situation.

Boolean; Valid values: true/false. Default is false.

Y
(if restrictionComplex
is false.)

retainSysIds

n/a

Specification for whether or not the web service will persist the sysId property.

  • If retainSysIds="true" and sysId is included in the request/response, sysId will be persisted to the database.
  • If retainSysIds="false" and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.

Note

In XML web services, retainSysIds is specified as an attribute in the <trigger> element.

Valid values: true/false (default is true).

N

retentionDuration

Retention Duration

Set only if retentionDurationPurge is selected; Minimum retention duration for the selected retentionDurationUnit before triggered task instances can qualify for purge.

Integer

N

retentionDurationPurge

Purge By Retention Duration

Specification for whether triggered task instances can be purged by retention duration.

Boolean; Valid values: true/false. Default is false.

N

retentionDurationUnit

Retention Duration Unit

Set only if retentionDurationPurge is selected; Retention duration unit.

Valid values:

  • As String = Hours, As Value = 3
  • As String = Days, As Value = 4

Default is Days (4).

N

simulationOption

Simulate

For Cron, Temporary, and Time triggers only; Enables the override of the Enable Trigger Simulation Universal Controller system property specification for whether or not to simulate the launching of tasks when triggers are eligible to fire. (If simulationOption is enabled, only the scheduled launch of the task by the trigger is inhibited.)

Valid values:

  • --System Default --, As Value = 0
  • As String = True, As Value = 1
  • As String = False, As Value = 2

Default is --System Default – (0).

N

situation

Situation

Type of day that causes the Controller to initiate the specified action.

Valid values:

  • As String = Holiday, As Value = 1
  • As String = Non Business Day, As Value = 2

Default is Holiday (1).

Y
(if restrictionSimple
is true)

skipActive

Skip Trigger if Active

Deprecated. Indication for whether or not the Controller should skip the next run of the specified task(s) if the previous run has not gone to a Complete status (that is, it is still active).

Boolean; Valid values: true/false. Default is false.

N

skipAfterDate

Skip After DateDate after which the trigger will be skipped.
N

skipAfterTime

Skip After TimeTime after which the trigger will be skipped.
N

skipBeforeDate

Skip Before DateDate before which the trigger will be skipped.
N

skipBeforeTime

Skip Before TimeTime before which the trigger will be skipped.
N

skipCondition

Task Launch Skip Condition

Controls when launching a task for the trigger will be skipped.
 

Note

When reading a Trigger, both skipActive and skipCondition are returned. When creating/updating a Trigger, skipCondition is used if present. If skipCondition is not present, skipActive is used. If both skipActive and skipCondition are present, skipActive can be set to true only if skipCondition is Active (1).

Valid values:

  • As String = None, As Value = 0
  • As String = Active, As Value = 1
  • As String = Active By Trigger, As Value = 2

Default is None (0).

N

skipCount

Skip Count

Specification that the Controller should skip the next N times that this task is triggered.

Integer; Default is 0.

N

skipDateList

Skip Date ListDate(s) on which the trigger will be skipped.

skipRestriction

Skip RestrictionSpecification for when the trigger should skip and not launch the task(s).

Valid values:

  • As String = None, As Value = 0
  • As String = Before, As Value = 1
  • As String = After, As Value = 2
  • As String = Span, As Value = 3
  • As String = On, As Value = 4

Default is None (0).


sysId

n/a

System ID field in the database for this trigger.

Persisted only if retainSysIds is set to true.

N

tasks

Tasks

Name of the task(s) being triggered when this trigger is satisfied.
 
XML

 
JSON


Y

timeZone

Time Zone

Name of the time zone that will be applied to the time(s) specified in the trigger.


Y

version

n/a

For Read and List web services; specification of the version being read or listed.
 

Note

In XML web services, version is specified as an attribute in the <trigger> element.


Y

Trigger Properties - Composite Trigger

Property

UI Field Name

Description

Specifications

Required

enabledEnd

Enabled End

End time of the period during which the trigger should be active.

Use 24-hour time; format is hh:mm

Y
(if restrictedTimes
is true)

enabledStart

Enabled Start

Start time of the period during which the trigger should be active.

Use 24-hour time; format is hh:mm

Y
(if restrictedTimes
is true)

queueDepth

Queue Depth

Number of events that are maintained in the queue for each component at any time. To maintain queueDepth, the Controller discards the oldest events.

Integer; Valid values: 1-100. Default is 100.

N

restrictedTimes

Restrict Times

Indication that the trigger is active only during the period specified by enabledStart and enabledEnd.

Boolean; Valid values: true/false.

N

timeLimit

Time Limit

Amount of time (in timeLimitUnits) that component events will remain in their queue before being removed.

Integer

N

timeLimitUnits

Time Limit Unit

Unit of time specified in the timeLimit.

Valid Values:

  • As String = Seconds, As Value = 1
  • As String = Minutes, As Value = 2
  • As String = Hours, As Value = 3
  • As String = Days, As Value = 4

Default is Minutes (2).

N

Trigger Properties - All Composite Trigger Components

Property

UI Field Name

Description

Specifications

Required

action

Action

For all trigger types except Manual and Temporary; Action to take on a non-business day or holiday (see situation).

Valid values:

  • As String = Do Not Trigger, As Value = 1
  • As String = Next Day, As Value = 2
  • As String = Next Business Day, As Value = 3
  • As String = Previous Day, As Value = 4
  • As String = Previous Business Day, As Value = 5

Default is Do Not Trigger (1).
 

Note

The following values are valid only for Cron and Time triggers:

  • Next Day (2)
  • Next Business Day (3)
  • Previous Day (4)
  • Previous Business Day (5)

Y
(if restriction
is true)

description

Description

Description of this component.


N

enabledEnd

Enabled End

End time of the period during which the component should be active.

Use 24-hour time; format is hh:mm

Y
(if restrictedTimes
is true)

enabledStart

Enabled Start

Start time of the period during which the component should be active.

Use 24-hour time; format is hh:mm

Y
(if restrictedTimes
is true)

name

Name

Name used within the Controller to identify this component.

Maximum 255 alphanumerics.

Y

restrictedTimes

Restrict Times

Indication that the trigger is active only during the period specified by enabledStart and enabledEnd.

Boolean; Valid values: true/false.

N

restriction

Special Restriction

Indication of whether or not you want to specify additional parameters that tell the Controller how to handle exceptions, such as when the trigger is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a simpleRestriction that disables the trigger if it is satisfied on a holiday identified in the calendar and/or a restrictionComplex that disables the trigger on the last business day of every month.

Boolean; Valid values: true/false. Default is false.

N

restrictionAdjective

Restriction Adjective

Type of selection for restrictionNoun.

Valid values:

  • As String = Every, As Value = 0
  • As String = 1st, As Value = 1
  • As String = 2nd, As Value = 2
  • As String = 3rd, As Value = 3
  • As String = 4th, As Value = 4
  • As String = Last, As Value = 5
  • As String = Nth, As Value = 6

Default is Every (0).

Y
(if restrictionComplex}}
is enabled)

restrictionComplex

Complex Restriction

Set only if restriction is true; Set of parameters that determine one or more situations when this trigger should not be satisfied. Used in conjunction with restrictionMode, restrictionAdjective, restrictionNoun, and restrictionQualifier. For example, you can specify that you do not want to satisfy this trigger on the last business day of the year or the first day of each month.

Boolean; Valid values: true/false. Default is false.

Y
(if restrictionSimple
is false.)

restrictionMode

Restriction Mode

Set only if restrictionSimple is true; Specification for whether you want to use restrictionSimple- and/or restrictionComplex-related values.

Valid values:

  • As String = And, As Value = 1
  • As String = Or, As Value = 2

Default is Or (2).

Y
if restrictionSimple
and restrictionComplex
are true.

restrictionNoun

Restriction Noun

Day to restrict the trigger to.
 
To specify a Custom Day, use the name of the Custom Day. For example:
 
XML
<restrictionNoun>CustomDay1</restrictionNoun>
 
JSON
"restrictionNoun": {
    "value": "CustomDay1"
}
 
To specify a Local Custom Day, use the local attribute. For example:
 
XML
<restrictionNoun local="true">CustomDay2</restrictionNoun>
 
JSON
"restrictionNoun": {
    "local": "true",
    "value": "CustomDay2"
}
 

Note

The Calendar for the Composite trigger is used to verify Custom Day references.

Valid values:

  • As String = Sunday, As Value = 1
  • As String = Monday, As Value = 2
  • As String = Tuesday, As Value = 3
  • As String = Wednesday, As Value = 4
  • As String = Thursday, As Value = 5
  • As String = Friday, As Value = 6
  • As String = Saturday, As Value = 7
  • As String = Day, As Value = 8
  • As String = Business Day, As Value = 9

Y
(if restrictionComplex
is true)

restrictionNthAmount

Restriction Nth Amount

Set only if restrictionAdjective is Nth (6); value of N.

Integer

Y
(if restrictionAdjective
is Nth)

restrictionQualifier

Restriction Qualifier

Period to restrict the trigger to.
 
To specify a Custom Day Period, use the name of the Custom Day Period. For example:
 
XML
<restrictionQualifier>CustomDayPeriod1</restrictionQualifier>
 
JSON
"restrictionQualifier": {
    "value": "CustomDayPeriod1"
}
 
To specify a Local Custom Day Period, use the local attribute. For example:
 
XML
<restrictionQualifier local="true">CustomDayPeriod2</restrictionQualifier>
 
JSON
"restrictionQualifier": {
    "local": "true",
    "value": "CustomDayPeriod2"
}
 

Note

The Calendar for the Composite trigger is used to verify Custom Day references.

Valid values:

  • As String = Jan, As Value = 0
  • As String = Feb, As Value = 1
  • As String = Mar, As Value = 2
  • As String = Apr, As Value = 3
  • As String = May, As Value = 4
  • As String = Jun, As Value = 5
  • As String = Jul, As Value = 6
  • As String = Aug, As Value = 7
  • As String = Sep, As Value = 8
  • As String = Oct, As Value = 9
  • As String = Nov, As Value = 10
  • As String = Dec, As Value = 11
  • As String = Month, As Value = 12
  • As String = Year, As Value = 13
  • As String = Week, As Value = 14

Y
(if restrictionComplex
is true)

restrictionSimple

Simple Restriction

Set only if restriction is true; Specification to set a simple restriction based on a specific situation.

Boolean; Valid values: true/false. Default is false.

Y
(if restrictionComplex
is false)

situation

Situation

Type of day that causes the Controller to initiate the specified action.

Valid values:

  • As String = Holiday, As Value = 1
  • As String = Non Business Day, As Value = 2

Default is Holiday (1).

Y
(if restrictionSimple
is true)

variablePrefix

Built-in Variable Prefix

Prefix that enables built-in variables to be propagated up to the Composite trigger.


N

Trigger Properties - Composite Trigger Time Component

Property

UI Field Name

Description

Specifications

Required

adjustInterval

Adjust Interval To Enable Start

Set only if restrictedTimes is true; Specification for whether to always begin at the enabledStart (true) or based upon the actual interval (false).

Boolean; Valid values: true/false. Default is true.

N

adjustmentAmount

Adjustment Amount

Set only if dayStyle is Complex; Number of Days or Business Days to adjust your date setting.

Integer.

Y
(if dateAdjustment
is less (1)
or plus (2) )

adjustmentType

Adjustment Type

Set only if dayStyle is Complex; Type of day by which to adjust your date setting.

Valid values:

  • As String = Day, As Value = 1
  • As String = Business Day, As Value = 2

Default is Day (1).

Y
(if dateAdjustment
is less (1)
or plus (2) )

dateAdjective

Date Adjective

If dayStyle is Complex; Which in a series of days to select. Used in conjunction with dateNouns and dateQualifiers.

For example, to specify the 2nd to last day of the month (last day of the month less one day), select dateAdjective = Last, dateNouns = Day, dateQualifiers = Month, dateAdjustment = Less, adjustmentAmount = 1, and adjustmentType = Day.

Valid values:

  • As String = Every, As Value = 0
  • As String = 1st, As Value = 1
  • As String = 2nd, As Value = 2
  • As String = 3rd, As Value = 3
  • As String = 4th, As Value = 4
  • As String = Last, As Value = 5
  • As String = Nth, As Value = 6

Default is Every (0).

Y
(if dayStyle
is Complex)

dateAdjustment

Date Adjustment

If dayStyle is Complex; Specification for adjusting your date setting by a less or plus number of Days or Business Days.

For example, to specify the 2nd to last day of the month (last day of the month less one day), select dateAdjective = Last, dateNouns = Day, dateQualifiers = Month, dateAdjustment = Less, adjustmentAmount = 1, and adjustmentType = Day.

Valid values:

  • As String = None, As Value = 0
  • As String = Less, As Value = 1
  • As String = Plus, As Value = 2

Default is None (0).

N

dateNoun

Date Noun

Type of day you want to select. Used in conjunction with dateAdjective and dateQualifier. For example, to specify "the 15th business day of the month," select dateAdjective = Nth, dateNoun = Business Day, dateQualifier = Month, and nthAmount = 15.
 
To specify a Custom Day, use the name of the Custom Day. For example:
 

 XML
<dateNoun>CustomDay1</dateNoun>
 
JSON
"dateNoun": {
    "value": "CustomDay1"
}


To specify a Local Custom Day, use the local attribute. For example:
 
XML
<dateNoun local="true">CustomDay2</dateNoun>
 
JSON
"dateNoun": {
    "local": "true",
    "value": "CustomDay2"
}


Note

The Calendar for the Composite trigger is used to verify Custom Day references.

Valid values:

  • As String = Sunday, As Value = 1
  • As String = Monday, As Value = 2
  • As String = Tuesday, As Value = 3
  • As String = Wednesday, As Value = 4
  • As String = Thursday, As Value = 5
  • As String = Friday, As Value = 6
  • As String = Saturday, As Value = 7
  • As String = Day, As Value = 8
  • As String = Business Day, As Value = 9

Y
(if dayStyle
is Complex)

dateQualifier

Date Qualifier

Period for your date selection. Used in conjunction with dateNoun and dateAdjective. For example, to specify "the 15th business day of the month," select dateAdjective = Nth, dateNoun = Business Day, dateQualifier = Month, and nthAmount = 15.

To specify a Custom Day, use the name of the Custom Day. For example:
 

XML
<dateQualifier>CustomDayPeriod1</dateQualifier>
 
JSON
"dateQualifier": {
    "value": "CustomDayPeriod1"
}


To specify a Local Custom Day, use the local attribute. For example:
 
XML
<dateQualifier local="true">CustomDayPeriod2</dateQualifier>
 
JSON
"dateQualifier": {
    "local": "true",
    "value": "CustomDayPeriod2"
}


Note

The Calendar for the Composite trigger is used to verify Custom Day references.

Valid values:

  • As String = Jan, As Value = 0
  • As String = Feb, As Value = 1
  • As String = Mar, As Value = 2
  • As String = Apr, As Value = 3
  • As String = May, As Value = 4
  • As String = Jun, As Value = 5
  • As String = Jul, As Value = 6
  • As String = Aug, As Value = 7
  • As String = Sep, As Value = 8
  • As String = Oct, As Value = 9
  • As String = Nov, As Value = 10
  • As String = Dec, As Value = 11
  • As String = Month, As Value = 12
  • As String = Year, As Value = 13
  • As String = Week, As Value = 14

Y
(if dayStyle
is Complex)

dayInterval

Day Interval

Interval (number of days) at which this trigger will run.

Integer.

Y
(if dayStyle \
is Every)

dayStyle

Day Style

Indication of when this trigger will be run.

Valid values:

  • As String = Simple, As Value = 1
  • As String = Complex, As Value = 2
  • As String = Every, As Value = 3

Default is Simple (1).

Y

eventMatchType

Event Match Type

Controls whether events from the Time component will be used for a single match or multiple matches at the Composite trigger level.

Valid values:

  • As String = Single, As Value = 1
  • As String = Multiple, As Value = 2

Default is Single (1).
 

Note

You can select Multiple only if timeLimit is specified in the Composite Trigger Details.

N

fri

Friday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Friday.

Boolean; Valid values: true/false. Default is false.

N

intervalStartingDate

Interval Start

First day of the interval on which this trigger will run.

Format: yyyy-mm-dd

Y
(if dayStyle
is Every)

mon

Monday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Monday.

Boolean; Valid values: true/false. Default is false.

N

nthAmount

Nth Amount

Value of N.

Integer

Y
(if dateAdjective
is Nth)

sat

Saturday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Saturday.

Boolean; Valid values: true/false. Default is false.

N

simpleDateType

n/a

Indication of when this trigger will be run.

Valid values:

  • As String = Daily, As Value = 1
  • As String = Business Days, As Value = 2
  • As String = Specific Days, As Value = 3

Default is Daily (1).

Y
(if dayStyle
is Simple)

startingAt

Initial Time Offset

Set only if timeStyle is Interval; Starting time, in minutes offset from the hour.

Format is hh:mm

Y
(if startTimeEnable
is true)

startTimeEnable

Enable Offset

Set only if timeStyle is Interval; Indication of whether you want to specify (in startingAt) a starting time, in minutes offset from the hour, for the trigger to run.

Boolean; Valid values: true/false. Default is false.

N

sun

Sunday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Sunday.

Boolean; Valid values: true/false. Default is false.

N

thu

Thursday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Thursday.

Boolean; Valid values: true/false. Default is false.

N

time

Time

Time when the trigger will be run.

Format is hh:mm, using 24-hour time.

Y
(if timeStyle
is Absolute)

timeInterval

Time Interval

Number of timeIntervalUnits.

Integer

Y
(if timeStyle
is Interval)

timeIntervalUnits

Time Interval Units

Type of time interval.

Valid values:

  • As String = Seconds, As Value = 1
  • As String = Minutes, As Value = 2
  • As String = Hours, As Value = 3

Default is Hours (3).

Y
(if timeStyle
is Interval)

timeStyle

Time Style

Indicates whether this trigger is for a specific time or a series of times.

Valid values:

  • As String = Absolute, As Value = 1
  • As String = Interval, As Value = 2

Default is Absolute (1).

N

tue

Tuesday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Tuesday.

Boolean; Valid values: true/false. Default is false.

N

wed

Wednesday

Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Wednesday.

Boolean; Valid values: true/false. Default is false.

N

Trigger Properties - Composite Trigger File Monitor Component

Property

UI Field Name

Description

Specifications

Required

fileMonitor

File Monitor

Name of the File Monitor task to be triggered.


Y

Trigger Properties - Composite Trigger Task Monitor Component

Property

UI Field Name

Description

Specifications

Required

taskMonitor

Name

Name of the Task Monitor task to be triggered.


Y

Trigger Properties - Composite Trigger Variable Monitor Component

Property

UI Field Name

Description

Specifications

Required

variableMonitor

Name

Name of the Variable Monitor task to be triggered.


Y

Trigger Properties - Composite Trigger Email Monitor Component

Property

UI Field Name

Description

Specifications

Required

emailMonitor

Name

Name of the Email Monitor task to be triggered.


Y

Trigger Properties - Composite Trigger Universal Monitor Component

Property

UI Field Name

Description

Specifications

Required

universalMonitor

Name

Name of the Universal Monitor task to be triggered.


Y

Trigger-Related Records Properties: Variables

Property

UI Field Name

Description

Specifications

Required

description

Description

Description of the variable.


N

name

Name

Name of the variable.


Y

value

Value

Value of the variable.


Y

Trigger-Related Records Properties: Notes

Property

UI Field Name

Description

Specifications

Required

sysId

n/a

System ID field in the database for the Note.


N

text

Text

Text of the Note.


N

title

Title

Title of the Note.


N