Page Comparison

...

Examples

XML

JSON

Example for Trigger

Expand

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

Expand

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

Anchor

	Example for Trigger-Related Records
	Example for Trigger-Related Records

Example for Trigger-Related Records

Expand

title	XML

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

Expand

title	JSON

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

Anchor

	Example for Composite Trigger Components
	Example for Composite Trigger Components

Example for Composite Trigger Components

Expand

title	XML

 Anchor
Composite Trigger - Time Component Example
Composite Trigger - Time Component Example
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>

Anchor

	Composite Trigger - File Monitor Component Example
	Composite Trigger - File Monitor Component Example

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>

Anchor

	Composite Trigger - Task Monitor Component Example
	Composite Trigger - Task Monitor Component Example

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>

Anchor

	Composite Trigger - Variable Monitor Component Example
	Composite Trigger - Variable Monitor Component Example

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>

Anchor

	Composite Trigger - Email Monitor Component Example
	Composite Trigger - Email Monitor Component Example

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>

 Anchor
Composite Trigger - Universal Monitor Component Example
Composite Trigger - Universal Monitor Component Example

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>

Expand

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

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

Examples for Trigger-Related Records

Variables

Expand

title	XML

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

Notes

Expand

title	XML

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

Variables

Expand

title	JSON

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

Notes

Expand

title	JSON

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

...

As

String

=

Do

Not

Trigger,

As

Value

=

1

<li>

As

String

=

Next

Day,

As

Value

=

2

<li>

As

String

=

Next

Business

Day,

As

Value

=

3

<li>

As

String

=

Previous

Day,

As

Value

=

4

<li>

As

String

=

Previous

Business

Day,

As

Value

=

5

</ul>

Default is Do Not Trigger (1).

Property

UI Field Name

Description

Specifications

Required

Anchor

	action - All
	action - All

action

Action

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

Valid values:

Html bobswift

Next

Day

(2)

<li>

Next

Business

Day

(3)

<li>

Previous

Day

(4)

<li>

Previous

Business

Day

(5)

</ul>

Note

title	Note

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

Html bobswift

Y
(if restriction
is true.)

Anchor

	calendar - All
	calendar - All

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

Anchor

	customField1 - All
	customField1 - All

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

Anchor

	customField2 - All
	customField2 - All

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

Anchor

	description - All
	description - All

description

Description

Description of this trigger.

N

Anchor

	disabledBy - All
	disabledBy - All

disabledBy

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

Anchor

	disabledTime - All
	disabledTime - All

disabledTime

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

Anchor

	enabled - All
	enabled - All

enabled

Status

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

Read-only.N

Anchor

	enabledBy - All
	enabledBy - All

enabledBy

Enabled By

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

Read-only.N

Anchor

	enabledTime - All
	enabledTime - All

enabledTime

Enabled Time

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

Read-only.N

Anchor

	excludeRelated - All
	excludeRelated - All

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

title	Note

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

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

N

Anchor

	exportReleaseLevel - All
	exportReleaseLevel - All

exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

Note

title	Note

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

read onlyN

Anchor

	exportTable - All
	exportTable - All

exportTable

n/a

Record table information.

Note

title	Note

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

read onlyN

Anchor

	forecast - All
	forecast - All

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

Anchor

	name - All
	name - All

name

Name

Name used within the Controller to identify this trigger.

Maximum 255 alphanumerics.

Y

Anchor

	nextScheduledTime - All
	nextScheduledTime - All

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

Anchor

	opswiseGroups - All
	opswiseGroups - All

opswiseGroups

Member of Business Services

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

XML

Panel

Html bobswift
<pre> <opswiseGroups> <opswiseGroup>test</opswiseGroup> </opswiseGroups> </pre>

JSON

Panel

Html bobswift
<pre> "opswiseGroups": [ "test" ] </pre>

N

Anchor

	rdExcludeBackup - All
	rdExcludeBackup - All

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

Anchor

	restriction - All
	restriction - All

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

Anchor

	restrictionAdjective - All
	restrictionAdjective - All

restrictionAdjective

Restriction Adjective

Type of selection for restrictionNoun.

Valid values:

Html bobswift<ul> <li>

As

String

=

Every,

As

Value

=

0

<li>

As

String

=

1st,

As

Value

=

1 <li> As String =

1
As String = 2nd,

As

Value

=

2

<li>

As

String

=

3rd,

As

Value

=

3

<li>

As

String

=

4th,

As

Value

=

4

<li>

As

String

=

Last,

As

Value

=

5

<li>

As

String

=

Nth,

As

Value

=

6

</ul>

Default is Every (0).

Y
(if restrictionComplex
is enabled)

Anchor

	restrictionComplex - All
	restrictionComplex - All

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

Anchor

	restrictionMode - All
	restrictionMode - All

restrictionMode

Restriction Mode

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

Valid values:

html-bobswift

As

String

=

And,

As

Value

=

1

<li>

As

String

=

Or,

As

Value

=

2

</ul>

Default is Or (2).

Y
(if restrictionSimple
and restrictionComplex
are true.)

Anchor

	restrictionNoun - All
	restrictionNoun - All

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

title	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.)

Anchor

	restrictionNouns - All
	restrictionNouns - All

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:

Code Block

language	text
linenumbers	true

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

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

XML

Code Block

language	text
linenumbers	true

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

JSON

Code Block

language	text
linenumbers	true

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

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

XML

Code Block

language	text
linenumbers	true

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

JSON

Code Block

language	text
linenumbers	true

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

Note

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

Anchor

	restrictionNthAmount - All
	restrictionNthAmount - All

restrictionNthAmount

Restriction Nth Amount

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

Integer

Y
(if restrictionAdjective
is Nth.)

Anchor

	restrictionQualifier - All
	restrictionQualifier - All

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

title	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.)

Anchor

	restrictionQualifiers - All
	restrictionQualifiers - All

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:

Code Block

language	text
linenumbers	true

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

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

XML

Code Block

language	text
linenumbers	true

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

JSON

Code Block

language	text
linenumbers	true

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

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

XML

Code Block

language	text
linenumbers	true

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

JSON

Code Block

language	text
linenumbers	true

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

Note

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

Anchor

	restrictionSimple - All
	restrictionSimple - All

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

Anchor

	retainSysIds - All
	retainSysIds - All

retainSysIds

n/a

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

Html bobswift<ul> <li> If <b>retainSysIds</b>

If retainSysIds="true"

and <code>sysId</code> is included in the

and sysId is included in the request/response,

<code>sysId</code> will be persisted to the database. <li> If <b>retainSysIds</b>

sysId will be persisted to the database.
If retainSysIds="false"

and <code>sysId</code> is included in the

and sysId is included in the request/response,

<code>sysId</code> will be

sysId will be ignored;

it

will

be

autogenerated

by

the

Controller.

</ul>

Note

title	Note

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

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

N

Anchor

	retentionDuration - All
	retentionDuration - All

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

Anchor

	retentionDurationPurge - All
	retentionDurationPurge - All

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

Anchor

	retentionDurationUnit - All
	retentionDurationUnit - All

retentionDurationUnit

Retention Duration Unit

Set only if retentionDurationPurge is selected; Retention duration unit.

Valid values:

html-bobswift

As

String

=

Hours,

As

Value

=

3

<li>

As

String

=

Days,

As

Value

=

4

</ul>

Default is Days (4).

N

Anchor

	simulationOption - All
	simulationOption - All

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:

html-bobswift

--System

Default

--,

As

Value

=

0

<li>

As

String

=

True,

As

Value

=

1

<li>

As

String

=

False,

As

Value

=

2

</ul>

Default is --System Default – (0).

N

Anchor

	situation - All
	situation - All

situation

Situation

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

Valid values:

Html bobswift<ul> <li>

As

String

=

Holiday,

As

Value

=

1

<li>

As

String

=

Non

Business

Day,

As

Value

=

2

</ul>

Default is Holiday (1).

Y
(if restrictionSimple
is true)

Anchor

	skipActive - All
	skipActive - All

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

Anchor

	skipAfterDate - All
	skipAfterDate - All

skipAfterDate

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

Anchor

	skipAfterTime - All
	skipAfterTime - All

skipAfterTime

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

Anchor

	skipBeforeDate - All
	skipBeforeDate - All

skipBeforeDate

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

Anchor

	skipBeforeTime - All
	skipBeforeTime - All

skipBeforeTime

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

Anchor

	skipCondition - All
	skipCondition - All

skipCondition

Task Launch Skip Condition

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

Note

title	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

Anchor

	skipCount - All
	skipCount - All

skipCount

Skip Count

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

Integer; Default is 0.

N

Anchor

	skipDateList - All
	skipDateList - All

skipDateList

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

Anchor

	skipRestriction - All
	skipRestriction - All

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

Anchor

	sysId - All
	sysId - All

sysId

n/a

System ID field in the database for this trigger.

Persisted only if retainSysIds is set to true.

N

Anchor

	tasks - All
	tasks - All

tasks

Tasks

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

XML

Panel

Html bobswift
<pre> <tasks> <task>uc - Demo</task> </tasks> </pre>

JSON

Panel

Html bobswift
<pre> "tasks": [ "uc - Demo" ] </pre>

Y

Anchor

	timeZone - All
	timeZone - All

timeZone

Time Zone

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

Y

Anchor

	version - All
	version - All

version

n/a

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

Note

title	Note

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

Y

Versions Compared

Old Version 74

New Version Current

Key

Anchor
Trigger Properties - All Composite Trigger Components
Trigger Properties - All Composite Trigger Components
Trigger Properties - All Composite Trigger Components

Page Comparison

Versions Compared

Old Version 74

New Version Current

Key

AnchorTrigger Properties - All Composite Trigger ComponentsTrigger Properties - All Composite Trigger ComponentsTrigger Properties - All Composite Trigger Components

Anchor
Trigger Properties - All Composite Trigger Components
Trigger Properties - All Composite Trigger Components
Trigger Properties - All Composite Trigger Components