...
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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | customField2 - All | customField2 - All | 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | description - All | description - All | Description | Description of this trigger. | N | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | disabledBy - All | disabledBy - All | Disabled By | System-supplied. If Status = Enabled, ID of the user who most recently disabled this trigger. | Read-only. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | disabledTime - All | disabledTime - All | Disabled Time | System-supplied. If Status = Enabled, Date and time that the trigger was disabled. | Read-only. | N | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Anchor | enabled - All | enabled - All | 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 |
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
Html bobswift |
---|
<ul>
<li> 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).
Note | ||
---|---|---|
| ||
The following values are valid only for Cron and Time triggers:
|
Y
(if restriction
is true.)
Anchor | ||||
---|---|---|---|---|
|
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
Anchor | ||||
---|---|---|---|---|
|
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
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
Description
Description of this trigger.
N
Anchor | ||||
---|---|---|---|---|
|
disabledBy
Anchor | ||||
---|---|---|---|---|
|
enabledTime
disabledTime
Anchor | ||||
---|---|---|---|---|
|
excludeRelated
enabled
n/a
System-defined; Specification for whether or
not to exclude related records from the update, even if they are provided in the request.Note | ||
---|---|---|
| ||
In XML web services, |
nor the trigger is enabled. Only enabled triggers are processed by the Controller.
Anchor | ||||
---|---|---|---|---|
|
enabledBy
System-supplied. If Status = Enabled, ID of the user who most recently enabled this trigger.
exportTable
Record table information.
Anchor | ||||
---|---|---|---|---|
|
exportReleaseLevel
Universal Controller release that the record was exported from.
Note | ||
---|---|---|
| ||
In XML web services, |
enabledTime
System-supplied. If Status = Enabled, Date and time that the trigger was enabled.
Anchor | ||||
---|---|---|---|---|
|
excludeRelated
n/a
For Modify Trigger web services; specification for whether or not to exclude related records from the update, even if they are provided in the request.
Note | ||
---|---|---|
| ||
In XML web services, |
Valid values: true/false (default is false).
N
Anchor | ||||
---|---|---|---|---|
|
forecast
exportReleaseLevel
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.
Universal Controller release that the record was exported from.
Note | ||
---|---|---|
| ||
In XML web services, |
Anchor | ||||
---|---|---|---|---|
|
name
exportTable
Name
Name used within the Controller to identify this trigger.
Maximum 255 alphanumerics.
Y
nextScheduledTime
System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information.
opswiseGroups
Member of Business Services
List of Business Service(s) that this trigger belongs to.
XML
JSON
N
rdExcludeBackup
Exclude Backup
Set only if retentionDurationPurge
is selected; Specification for whether qualifying task instances can be excluded from the backup when being purged by retention duration.
Boolean; Valid values: true/false. Default is false.
N
restriction
Special Restriction
Indication of whether or not you want to specify additional parameters that tell the Controller how to handle exceptions, such as when the trigger is satisfied on a holiday or non-business day. You can specify simple and/or complex restrictions. For example, you can specify a simpleRestriction
that disables the trigger if it is satisfied on a holiday identified in the calendar and/or a restrictionComplex
that disables the trigger on the last business day of every month.
Boolean; Valid values: true/false. Default is false.
N
restrictionAdjective
Restriction Adjective
Type of selection for restrictionNoun
.
Valid values:
n/aRecord table information.
Note | ||
---|---|---|
| ||
In XML web services, |
Anchor | ||||
---|---|---|---|---|
|
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
Name
Name used within the Controller to identify this trigger.
Maximum 255 alphanumerics.
Y
Anchor | ||||
---|---|---|---|---|
|
nextScheduledTime
System-supplied; for time-based triggers. If Status = Enabled, the next date and time this trigger will be satisfied. See Displaying Trigger Forecast Information.
Anchor | ||||
---|---|---|---|---|
|
opswiseGroups
Member of Business Services
List of Business Service(s) that this trigger belongs to.
XML
Panel | ||
---|---|---|
|
JSON
Panel | ||
---|---|---|
|
N
Anchor | ||||
---|---|---|---|---|
|
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
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
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 = 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
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
Restriction Mode
Set only if restrictionSimple
is true; Specification for whether you want to use restrictionSimple
- and/or restrictionComplex
-related values.
Valid values:
to use restrictionSimple
- and/or restrictionComplex
-related values.
Valid values:
Html bobswift |
---|
<ul>
<li> 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
Restriction Noun
Deprecated. Day to restrict the trigger to.
To specify a Custom Day, use the name of the Custom Day. For example:
XML
<restrictionNoun>CustomDay1</restrictionNoun>
JSON
"restrictionNoun": {
"value": "CustomDay1"
}
To specify a Local Custom Day, use the local attribute. For example:
XML
<restrictionNoun local="true">CustomDay2</restrictionNoun>
JSON
"restrictionNoun": {
"local": "true",
"value": "CustomDay2"
}
Note | ||
---|---|---|
| ||
The Calendar for the trigger is used to verify Custom Day references. |
Valid values:
- As String = Sunday, As Value = 1
- As String = Monday, As Value = 2
- As String = Tuesday, As Value = 3
- As String = Wednesday, As Value = 4
- As String = Thursday, As Value = 5
- As String = Friday, As Value = 6
- As String = Saturday, As Value = 7
- As String = Day, As Value = 8
- As String = Business Day, As Value = 9
Y
(if restrictionComplex
is true.
Anchor | ||||
---|---|---|---|---|
|
restrictionNouns
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 | ||||
---|---|---|---|---|
| ||||
<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 | ||||
---|---|---|---|---|
|
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
- As String = Week, As Value = 14
- As String = Quarter, As Value = 15
- As Value = 13
- As String = Week, As Value = 14
- As String = Quarter, As Value = 15
(if
restrictionComplex
is true)
Anchor | ||||
---|---|---|---|---|
|
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
restrictionSimple
Simple Restriction
Set only if restriction
is true; Specification to set a simple restriction based on a specific situation
.
Boolean; Valid values: true/false. Default is false.
Y
(if restrictionComplex
is false.
retainSysIds
n/a
false.
Anchor | ||||
---|---|---|---|---|
|
retainSysIds
n/a
Specification for whether or not the web service will persist the sysId property.
Html bobswift |
---|
<ul>
<li> If <b>retainSysIds</b>="true" and <code>sysId</code> is included in the request/response, <code>sysId</code> will be persisted to the database.
<li> If <b>retainSysIds</b>="false" and <code>sysId</code> is included in the request/response, <code>sysId</code> will be ignored; it will be autogenerated by the Controller.
</ul> |
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:
Html bobswift |
---|
<ul>
<li> As String = Hours, As Value = 3
<li> As String = Days, As Value = 4
</ul> |
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.)
the task by the trigger is inhibited.)
Valid values:
Html bobswift |
---|
<ul>
<li> --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
Situation
Type of day that causes the Controller to initiate the specified action
.
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
Skip Trigger if Active
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 | ||||
---|---|---|---|---|
|
skipCount
Skip Count
Specification that the Controller should skip the next N times that this task is triggered.
Integer; Default is 0.
N
Anchor | ||||
---|---|---|---|---|
|
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.
XML
JSON
Anchor | |||
---|---|---|---|
|
tasks
Tasks
|
tasks
Tasks
Name of the task(s) being triggered when this trigger is satisfied.
XML
Panel | ||
---|---|---|
|
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
...