...
- Create a Composite Trigger
- List Component Events for a Composite Trigger
- Modify a Composite Trigger
- Read a Composite Trigger
...
| Note | ||
|---|---|---|
| ||
For information on Trigger web services that are applicable to all trigger types, see: |
| Anchor | ||||
|---|---|---|---|---|
|
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 | ||||||
| |||||||
Trigger Properties | |||||||
Trigger Component Properties |
| ||||||
Trigger-Related Record Properties | |||||||
Example Response |
|
...
List Component Events for a Composite
...
Description
Trigger
Description | |||
|---|---|---|---|
Consumes Content-Type | Application/XML & Application/JSON | ||
Description | List component events | ||
Authentication | HTTP Basic | ||
URI | Description | http://host_name/uc/resources/trigger/listcomponentevents | |
HTTP Method | PUT | ||
Modifies the trigger specified by the sysId in the Example Request. | |||
HTTP Method | GET | ||
Example URI | |||
Consumes Content-Type | application/xml, application/json | ||
Produces Content-Type | n/a | ||
| Anchor | | Example Request | Example Request | Example Request
| Example Response | See List Component Events: XML and JSON Examples | .||
| Trigger Properties | SeeSee Read a Composite Trigger | Properties: | All Triggers.|
Trigger Component Properties |
| ||
Trigger-Related Record Properties | |||
Example Response |
|
...
Description | URI | http://URI Parameters. |
|---|---|---|
Produces Content-Type | application/xml, application/json |
| Anchor | ||||
|---|---|---|---|---|
|
Modify a Composite Trigger
Description | |||||||
|---|---|---|---|---|---|---|---|
URI | http://host_name/uc/resources/trigger | ||||||
HTTP Method | GETPUT | ||||||
Description | Retrieves information for Modifies the specified triggertrigger specified by the sysId in the Example Request. | URI Parameters | See Read a Composite Trigger: URI Parameters | ||||
Example URI | http://localhost:8080/uc/resources/trigger?triggername=testTrigger | ||||||
Consumes Content-Type | application/xml, application/json | ||||||
Produces Content-Type | n/a | Produces Content-Type | application/xml, application/json | ||||
| |||||||
Trigger Properties | |||||||
Trigger Component Properties |
| ||||||
Trigger-Related Record Properties | |||||||
Example Response |
|
| Anchor | ||
|---|---|---|
|
...
|
...
Read a Composite Trigger
...
NameDescription | Description | Specifications | Required | Mutually Exclusive With |
| Unique ID for this trigger. | Y |
| |
|---|---|---|---|---|---|---|---|---|---|
| Name used within the Controller to identify this trigger. | Maximum 40 alphanumerics. | Y |
|
...
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 |
Anchor | | Example for Trigger-Related Records | Example for Trigger-Related Records | Example for Trigger-Related Records
| Expand | ||
|---|---|---|
| ||
<variables> <variable> <description /> <name>testVar</name> <value>value</value> </variable> </variables> |
| Expand | ||
|---|---|---|
| ||
"variables": [ { "description": "description", "name": "var1", "value": "value1", } ] |
| title | XML |
|---|
<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>
<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>
<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>
<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>
<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>
<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>
| title | 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
{ "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": [
{
URI
HTTP Method
GET
Description
Retrieves information for the specified trigger.
URI Parameters
Example URI
Consumes Content-Type
n/a
Produces Content-Type
application/xml, application/json
Trigger Properties
Trigger Component Properties
- See Trigger Properties: All Composite Trigger Components.
- See Trigger Properties: Composite Trigger Time Component.
- See Trigger Properties: Composite Trigger File Monitor Component.
- See Trigger Properties: Composite Trigger Task Monitor Component.
- See Trigger Properties: Composite Trigger Variable Monitor Component.
- See Trigger Properties: Composite Trigger Email Monitor Component.
- See Trigger Properties: Composite Trigger Universal Monitor Component.
Trigger-Related Record Properties
Example Response
- Status 200 /OK
(See Composite Trigger: XML and JSON Examples.) - Status 404 /Not Found
A trigger with id "f87848b00a0001037f43e7c81c8ec969" does not exist.
| Anchor | ||||
|---|---|---|---|---|
|
Read a Composite Trigger: URI Parameters
Name | Description | Specifications | Required | Mutually Exclusive With |
|---|---|---|---|---|
| Unique ID for this trigger. | Y |
| |
| Name used within the Controller to identify this trigger. | Maximum 40 alphanumerics. | Y |
|
| Anchor | ||||
|---|---|---|---|---|
|
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 |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
List Component Events - Response |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
}
|
]
Composite Trigger: Universal Monitor Component
"universalMonitorComponents":
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
"restrictedTimes": false,
"restriction": false,
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
"restrictionQualifiers": [
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
]
| Examples for Trigger-Related Records | Variables
Notes
| Variables
Notes
|
| Anchor | ||||
|---|---|---|---|---|
|
Properties
| Anchor | ||||
|---|---|---|---|---|
|
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 | Valid values:
Default is Do Not Trigger (1).
| Y | ||||||||||||||||||||||||||||||||||||||||||||||
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. | Default is System Default. | Y | ||||||||||||||||||||||||||||||||||||||||||||||
customField1 | n/a | User-Defined field. | 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. | 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 By | System-supplied. If Status = Enabled, ID of the user who most recently disabled this trigger. | Read-only. | N | ||||||||||||||||||||||||||||||||||||||||||||||
disabledTime | Disabled Time | System-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 | ||||||||||||||||||||||||||||||||||||||||||||||
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.
| Valid values: true/false (default is false). | N | ||||||||||||||||||||||||||||||||||||||||||||||
exportReleaseLevel | n/a | Universal Controller release that the record was exported from.
| read only | N | ||||||||||||||||||||||||||||||||||||||||||||||
exportTable | n/a | Record table information.
| read only | N | ||||||||||||||||||||||||||||||||||||||||||||||
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 | ||||||||||||||||||||||||||||||||||||||||||||||
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.
| N | |||||||||||||||||||||||||||||||||||||||||||||||
rdExcludeBackup | Exclude Backup | Set only if | 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 | Boolean; Valid values: true/false. Default is false. | N | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionAdjective | Restriction Adjective | Type of selection for | Valid values:
Default is Every (0). | Y | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionComplex | Complex Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionMode | Restriction Mode | Set only if | Valid values:
Default is Or (2). | Y | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionNoun | Restriction Noun | Day to restrict the trigger to.
| Valid values:
| Y | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionNouns | Restriction Noun(s) | Day to restrict the trigger to. Used with Example:
To specify a Custom Day, use the name of the Custom Day. For example: XML
JSON
To specify a Local Custom Day, use the local attribute. For example: XML
JSON
| Valid values:
| Y (if restrictionComplex is true) | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionNthAmount | Restriction Nth Amount | Set only if | Integer | Y | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionQualifier | Restriction Qualifier | Period to restrict the trigger to.
| Valid values:
| Y | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionQualifiers | Restriction Qualifier(s) | Period to restrict the trigger to. Used with Example:
To specify a Custom Day, use the name of the Custom Day. For example: XML
JSON
To specify a Local Custom Day, use the local attribute. For example: XML
JSON
| Valid values:
| Y (if restrictionComplex is true) | ||||||||||||||||||||||||||||||||||||||||||||||
restrictionSimple | Simple Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y | ||||||||||||||||||||||||||||||||||||||||||||||
retainSysIds | n/a | Specification for whether or not the web service will persist the sysId property.
| Valid values: true/false (default is true). | N | ||||||||||||||||||||||||||||||||||||||||||||||
retentionDuration | Retention Duration | Set only if | 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 | Valid values:
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 | Valid values:
Default is --System Default – (0). | N | ||||||||||||||||||||||||||||||||||||||||||||||
situation | Situation | Type of day that causes the Controller to initiate the specified | Valid values:
Default is Holiday (1). | Y | ||||||||||||||||||||||||||||||||||||||||||||||
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 Date | Date after which the trigger will be skipped. | N | |||||||||||||||||||||||||||||||||||||||||||||||
skipAfterTime | Skip After Time | Time after which the trigger will be skipped. | N | |||||||||||||||||||||||||||||||||||||||||||||||
skipBeforeDate | Skip Before Date | Date before which the trigger will be skipped. | N | |||||||||||||||||||||||||||||||||||||||||||||||
skipBeforeTime | Skip Before Time | Time before which the trigger will be skipped. | N | |||||||||||||||||||||||||||||||||||||||||||||||
skipCondition | Task Launch Skip Condition | Controls when launching a task for the trigger will be skipped.
| Valid values:
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 List | Date(s) on which the trigger will be skipped. | ||||||||||||||||||||||||||||||||||||||||||||||||
skipRestriction | Skip Restriction | Specification for when the trigger should skip and not launch the task(s). | Valid values:
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.
| 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.
| Y |
| Anchor | ||||
|---|---|---|---|---|
|
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 | ||||||
enabledStart | Enabled Start | Start time of the period during which the trigger should be active. | Use 24-hour time; format is hh:mm | Y | ||||||
queueDepth | Queue Depth | Number of events that are maintained in the queue for each component at any time. To maintain | Integer; Valid values: 1-100. Default is 100. | N | ||||||
restrictedTimes | Restrict Times | Indication that the trigger is active only during the period specified by | Boolean; Valid values: true/false. | N | ||||||
timeLimit | Time Limit | Amount of time (in | Integer | N | ||||||
timeLimitUnits | Time Limit Unit | Unit of time specified in the | Valid Values:
Default is Minutes (2). | N |
| Anchor | ||||
|---|---|---|---|---|
|
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 | Valid values:
Default is Do Not Trigger (1).
| Y | |||||||||||
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 | |||||||||||
enabledStart | Enabled Start | Start time of the period during which the component should be active. | Use 24-hour time; format is hh:mm | Y | |||||||||||
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 | 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 | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
restrictionAdjective | Restriction Adjective | Type of selection for | Valid values:
Default is Every (0). | Y | |||||||||||
restrictionComplex | Complex Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y | |||||||||||
restrictionMode | Restriction Mode | Set only if | Valid values:
Default is Or (2). | Y | |||||||||||
restrictionNoun | Restriction Noun | Day to restrict the trigger to.
| Valid values:
| Y | |||||||||||
restrictionNthAmount | Restriction Nth Amount | Set only if | Integer | Y | |||||||||||
restrictionQualifier | Restriction Qualifier | Period to restrict the trigger to.
| Valid values:
| Y | |||||||||||
restrictionSimple | Simple Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y | |||||||||||
situation | Situation | Type of day that causes the Controller to initiate the specified | Valid values:
Default is Holiday (1). | Y | |||||||||||
variablePrefix | Built-in Variable Prefix | Prefix that enables built-in variables to be propagated up to the Composite trigger. | N |
| Anchor | ||||
|---|---|---|---|---|
|
Trigger Properties - Composite Trigger Time Component
Property | UI Field Name | Description | Specifications | Required | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
adjustInterval | Adjust Interval To Enable Start | Set only if | Boolean; Valid values: true/false. Default is true. | N | |||||||||||
adjustmentAmount | Adjustment Amount | Set only if | Integer. | Y | |||||||||||
adjustmentType | Adjustment Type | Set only if | Valid values:
Default is Day (1). | Y | |||||||||||
dateAdjective | Date Adjective | If For example, to specify the 2nd to last day of the month (last day of the month less one day), select | Valid values:
Default is Every (0). | Y | |||||||||||
dateAdjustment | Date Adjustment | If For example, to specify the 2nd to last day of the month (last day of the month less one day), select | Valid values:
Default is None (0). | N | |||||||||||
dateNoun | Date Noun | Type of day you want to select. Used in conjunction with XML To specify a Local Custom Day, use the local attribute. For example:
| Valid values:
| Y | |||||||||||
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:
To specify a Local Custom Day, use the local attribute. For example:
| Valid values:
| Y | |||||||||||
dayInterval | Day Interval | Interval (number of days) at which this trigger will run. | Integer. | Y | |||||||||||
dayStyle | Day Style | Indication of when this trigger will be run. | Valid values:
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:
Default is Single (1).
| N | |||||||||||
fri | Friday | Set only if | 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 | |||||||||||
mon | Monday | Set only if | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
nthAmount | Nth Amount | Value of N. | Integer | Y | |||||||||||
sat | Saturday | Set only if | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
simpleDateType | n/a | Indication of when this trigger will be run. | Valid values:
Default is Daily (1). | Y | |||||||||||
startingAt | Initial Time Offset | Set only if | Format is hh:mm | Y | |||||||||||
startTimeEnable | Enable Offset | Set only if | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
sun | Sunday | Set only if | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
thu | Thursday | Set only if | 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 | |||||||||||
timeInterval | Time Interval | Number of | Integer | Y | |||||||||||
timeIntervalUnits | Time Interval Units | Type of time interval. | Valid values:
Default is Hours (3). | Y | |||||||||||
timeStyle | Time Style | Indicates whether this trigger is for a specific time or a series of times. | Valid values:
Default is Absolute (1). | N | |||||||||||
tue | Tuesday | Set only if | Boolean; Valid values: true/false. Default is false. | N | |||||||||||
wed | Wednesday | Set only if | Boolean; Valid values: true/false. Default is false. | N |
| Anchor | ||||
|---|---|---|---|---|
|
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 |
| Anchor | ||||
|---|---|---|---|---|
|
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 |
| Anchor | ||||
|---|---|---|---|---|
|
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 |
| Anchor | ||||
|---|---|---|---|---|
|
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 |
| Anchor | ||||
|---|---|---|---|---|
|
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 |
| Anchor | ||||
|---|---|---|---|---|
|
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 |
| Anchor | ||||
|---|---|---|---|---|
|
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 |
...