...
Examples | XML | JSON | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Example for Trigger |
| |||||||||||||||||||||
Examples for Trigger-Related Records | Variables
Notes
| Variables
Notes
|
...
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
Note |
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 |
| 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 |
| 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 | Anchor |
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 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| restrictionNthAmount
| restrictionNthAmount
|
| Restriction | Nth AmountSet only if | Integer | Y | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | restrictionQualifier - All | restrictionQualifier - All | Restriction Qualifier | Period Noun(s) |
Note | ||
---|---|---|
| ||
The Calendar for the trigger is used to verify Custom Day references. |
Valid values:
Day 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"
}
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 | ||||
---|---|---|---|---|
| ||||
<restrictionNouns>
<restrictionNoun>Business Day</restrictionNoun>
</restrictionNouns> |
To specify a Custom Day, use the name of the Custom Day. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<restrictionNouns>
<restrictionNoun>Monday</restrictionNoun>
<restrictionNoun>CustomDay1</restrictionNoun>
</restrictionNouns> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"restrictionNouns": [
{
"value": "Monday"
},
{
"value": "CustomDay1"
}
] |
To specify a Local Custom Day, use the local attribute. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<restrictionNouns>
<restrictionNoun local="true">CustomDay2</restrictionNoun>
</restrictionNouns> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"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.
(if
restrictionComplex
is true)
Anchor | ||||
---|---|---|---|---|
|
restrictionNthAmount
Restriction Nth Amount
Set only if restrictionAdjective
is Nth (6); value of N.
Integer
Y
(if restrictionAdjective
is Nth)
Anchor | ||||
---|---|---|---|---|
|
restrictionQualifier
Restriction Qualifier
Deprecated. 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)
Anchor | ||||
---|---|---|---|---|
|
restrictionQualifiers
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 | ||||
---|---|---|---|---|
| ||||
<restrictionQualifiers>
<restrictionQualifier>Month</restrictionQualifier>
</restrictionQualifiers> |
To specify a Custom Day, use the name of the Custom Day. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<restrictionQualifiers>
<restrictionQualifier>Jan</restrictionQualifier>
<restrictionQualifier>CustomDay1</restrictionQualifier>
</restrictionQualifiers> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"restrictionQualifiers": [
{
"value": "Jan"
},
{
"value": "CustomDay1"
}
] |
To specify a Local Custom Day, use the local attribute. For example:
XML
Code Block | ||||
---|---|---|---|---|
| ||||
<restrictionQualifiers>
<restrictionQualifier local="true">CustomDay2</restrictionQualifier>
</restrictionQualifiers> |
JSON
Code Block | ||||
---|---|---|---|---|
| ||||
"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
Y
(if restrictionComplex
is true)
retainSysIds
n/a
- As String = Week, As Value = 14
- As String = Quarter, As Value = 15
Anchor | ||||
---|---|---|---|---|
|
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, |
Valid values: true/false (default is true).
N
Anchor | ||||
---|---|---|---|---|
|
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
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
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
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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)
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
skipAfterTime
Anchor | ||||
---|---|---|---|---|
|
skipBeforeDate
Anchor | ||||
---|---|---|---|---|
|
skipBeforeTime
Anchor | ||||
---|---|---|---|---|
|
skipCondition
Task Launch Skip Condition
Controls when launching a task for the trigger will be skipped.
Note | ||
---|---|---|
| ||
When reading a Trigger, both |
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
Skip Count
Specification that the Controller should skip the next N times that this task is triggered.
Integer; Default is 0.
N
Anchor | ||||
---|---|---|---|---|
|
skipDateList
Anchor | ||||
---|---|---|---|---|
|
skipRestriction
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
n/a
System ID field in the database for this trigger.
Persisted only if retainSysIds is set to true.
N
Anchor | ||||
---|---|---|---|---|
|
tasks
Tasks
Name of the task(s) being triggered when this trigger is satisfied.
XML
Panel | ||
---|---|---|
|
tasks
Tasks
Name of the task(s) being triggered when this trigger is satisfied.
XML
JSON
|
JSON
Panel | ||
---|---|---|
|
Y
Anchor | ||||
---|---|---|---|---|
|
timeZone
Time Zone
Name of the time zone that will be applied to the time(s) specified in the trigger.
Y
Anchor | ||||
---|---|---|---|---|
|
version
n/a
For Read and List web services; specification of the version being read or listed.
Note | ||
---|---|---|
| ||
In XML web services, |
Y
...