...
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 |
|
|
|
|
|
|
<opswiseGroups
|
|
|
|
<restrictionNoun>Day</restrictionNoun>
<restrictionNthAmount />
<restrictionQualifier>Year</restrictionQualifier>
<restrictionSimple>false</restrictionSimple>
<retentionDuration>1</retentionDuration>
<retentionDurationPurge>true</retentionDurationPurge>
<retentionDurationUnit>Days</retentionDurationUnit>
<simulationOption>-- System Default --</simulationOption>
<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>
<taskMonitor>uc - Windows Set Variable Monitor</taskMonitor>
<tasks> <task>Sleep 30</task> </tasks>
<timeZone />
<enabledEnd>00:00</enabledEnd>
<enabledStart>00:00</enabledStart>
<restrictedTimes>false</restrictedTimes>
</triggerTm>
Expand | ||
---|---|---|
| ||
{ "type": "triggerTm", "action": "Do Not Trigger", "calendar": "System Default", "description": "description", |
Variables
Expand | ||
---|---|---|
| ||
<variables> <variable> <description /> <name>testVar</name> <value>value</value> </variable> </variables> |
Notes
Expand | ||
---|---|---|
| ||
<notes> <note> <sysId>76ad570c64b84f84aeaf281403856b10</sysId> <text>testNoteText</text> <title>testNoteTitle</title> </note> </notes> |
Variables
Expand | ||
---|---|---|
| ||
"variables": [ { "description": "description", "name": "var1", "value": "value1" } ] |
Notes
Expand | ||
---|---|---|
| ||
"notes": [ { "sysId": "76ad570c64b84f84aeaf281403856b10", "text": "testNoteText", "title": "testNoteTitle" } ] |
...
Note | ||
---|---|---|
| ||
In the XML web services, the exportReleaseLevel and exportTable properties are specified as attributes in the <trigger> element. |
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:
Default is Do Not Trigger (1).
Note | ||
---|---|---|
| ||
The following values are valid only for Cron and Time triggers: |
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
.
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
Example: <customField2 label="Domain">web.com</customField2>
|
| |||||||||||||||||||||
Examples for Trigger-Related Records | Variables
Notes
| Variables
Notes
|
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
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 2 1 Label Universal Controller system property. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
description customField2 | Description | Description of this triggern/a | User-Defined field. | N | Anchor | | disabledBy - All | 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.
Anchor | exportTable - All | exportTable -
| 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | restriction - All | restriction - All | 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 | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | rdExcludeBackup - All | rdExcludeBackup - All | Exclude Backup | Set only if | Boolean; Valid values: true/false. Default is false. | N |
| 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | restrictionAdjective - All | restrictionAdjective - All | Restriction Adjective | Type of selection for | Valid values: Default is Every (0). | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | restrictionComplex - All | restrictionComplex - All | Complex Restriction | Set only if | Boolean; Valid values: true/false. Default is false. | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | restrictionMode - All | restrictionMode - All | Restriction Mode | Set only if | Valid values: Default is Or (2). | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | restrictionNoun - All | restrictionNoun - All | Restriction Noun | Day ; 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 | Deprecated. 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 | Deprecated. Period to restrict the trigger to.
| Valid values:
| Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictionNthAmount restrictionQualifiers | Restriction Nth Amount | Set only if | Integer | Y | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | restrictionQualifier - All | restrictionQualifier - All | Restriction Qualifier | Period to restrict the trigger to. Qualifier(s) | Period to restrict the trigger to. Used with Example:
To specify a Custom Day Period, use the name of the Custom Day Period. For example: XML
JSON
To specify a Locala Local Custom Day Period, use thethe local attributeattribute. For example: XML <restrictionQualifier XML
JSON "restrictionQualifier": {
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 | 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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Name of the task(s) being triggered when this trigger is satisfied. Panel |
tasks | Tasks |
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 |
...