Property | UI Field Name | Description | Specifications | Required |
---|
Anchor |
---|
| adjustInterval - Time |
---|
| adjustInterval - Time |
---|
| adjustInterval | Adjust Interval To Enable Start | Set only if restrictedTimes is true; Specification for whether to always begin at the enabledStart (true) or based upon the actual interval (false). | Boolean; Valid values: true/false. Default is true. | N |
Anchor |
---|
| adjustmentAmount - Time |
---|
| adjustmentAmount - Time |
---|
| adjustmentAmount | Adjustment Amount | Set only if dayStyle is Complex; Number of Days or Business Days to adjust your date setting. | Integer. | Y (if dateAdjustment is less (1) or plus (2) ) |
Anchor |
---|
| adjustmentType - Time |
---|
| adjustmentType - Time |
---|
|
adjustmentType | Adjustment Type | Set only if dayStyle is Complex; Type of day by which to adjust your date setting. | Valid values: Default is Day (1). | Y (if dateAdjustment is less (1) or plus (2) ) |
Anchor |
---|
| dateAdjective - Time |
---|
| dateAdjective - Time |
---|
| dateAdjective | Date Adjective | Which in a series of days to select. Used in conjunction with dateNoun and dateQualifier . For example, to specify "the 15th business day of the month," select dateAdjective = Nth, dateNoun = Business Day, dateQualifier = Month, and nthAmount = 15. | Valid values: Default is Every (0). | Y (if dayStyle is Complex) |
Anchor |
---|
| dateAdjustment - Time |
---|
| dateAdjustment - Time |
---|
| dateAdjustment | Date Adjustment | Set only if dayStyle is Complex; Specification for adjusting your date setting by a less or plus number of Days or Business Days. For example, to specify the 2nd to last day of the month (last day of the month less one day), select dateAdjective = Last, dateNouns = Day, dateQualifier s = Month, dateAdjustment = Less, adjustmentAmount = 1, and adjustmentType = Day. | Valid values: Default is None (0). | N |
Anchor |
---|
| dateNouns - Time |
---|
| dateNouns - Time |
---|
| dateNouns | Date Noun | If dayStyle is Complexe; Type of day you want to select. Used in conjunction with dateAdjective and dateQualifiers . For example, to specify "the 2nd Monday and Tuesday or January and December," select dateAdjective = Nth, nthAmount = 2, dateNouns = Monday, Friday, and dateQualifiers = Jan, Dec. To specify a Custom Day, use the name of the Custom Day. For example: XML <dateNouns>
<dateNoun>Monday</dateNoun>
<dateNoun>CustomDay1</dateNoun>
</dateNouns>
JSON "dateNouns": [
{
"value": "Monday"
},
{
"value": "CustomDay1"
}
]
To specify a Local Custom Day, use the local attribute. For example: XML <dateNouns>
<dateNoun local="true">CustomDay2</dateNoun>
</dateNouns>
JSON "dateNouns": [
{
"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
| Y (if dayStyle is Complex) |
Anchor |
---|
| dateQualifiers - Time |
---|
| dateQualifiers - Time |
---|
| dateQualifiers | Date Qualifier | If dayStyle is Complexe; Period for your date selection. Used in conjunction with dateNouns and dateAdjective . For example, to specify "the 2nd Monday and Tuesday or January and December," select dateAdjective = Nth, nthAmount = 2, dateNouns = Monday, Friday, and dateQualifiers = Jan, Dec. To specify a Custom Day, use the name of the Custom Day. For example: XML <dateQualifiers>
<dateQualifier>Jan</dateQualifier>
<dateQualifier>CustomDay1</dateQualifier>
</dateQualifiers>
JSON "dateQualifiers": [
{
"value": "Monday"
},
{
"value": "CustomDay1"
}
]
To specify a Local Custom Day, use the local attribute. For example: XML <dateQualifiers>
<dateQualifier local="true">CustomDay2</dateQualifier>
</dateQualifiers>
JSON "dateQualifiers": [
{
"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
| Y (if dayStyle is Complex) |
Anchor |
---|
| dayInterval - Time |
---|
| dayInterval - Time |
---|
| dayInterval | Day Interval | Interval (number of days) at which this trigger will run. | Integer. | Y (if dayStyle \ is Every) |
Anchor |
---|
| dayStyle - Time |
---|
| dayStyle - Time |
---|
| dayStyle | Day Style | Indication of when this trigger will be run. | Valid values: Default is Simple (1). | Y |
Anchor |
---|
| enabledEnd - Time |
---|
| enabledEnd - Time |
---|
| enabledEnd | Enabled End | End time of the period during which the trigger should be active. | Use 24-hour time; format is hh:mm | Y (if restrictedTimes is true) |
Anchor |
---|
| enabledStart - Time |
---|
| enabledStart - Time |
---|
| enabledStart | Enabled Start | Start time of the period during which the trigger should be active. | Use 24-hour time; format is hh:mm | Y (if restrictedTimes is true) |
| Friday | Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Friday. | Boolean; Valid values: true/false. Default is false. | N |
Anchor |
---|
| intervalStartingDate - Time |
---|
| intervalStartingDate - Time |
---|
| intervalStartingDate | Interval Start | First day of the interval on which this trigger will run. | Format: yyyy-mm-dd | Y (if dayStyle is Every) |
| Monday | Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Monday. | Boolean; Valid values: true/false. Default is false. | N |
Anchor |
---|
| nthAmount - Time |
---|
| nthAmount - Time |
---|
| nthAmount | Nth Amount | Value of N. | Integer | Y (if dateAdjective is Nth) |
Anchor |
---|
| restrictedTimes - Time |
---|
| restrictedTimes - Time |
---|
| restrictedTimes | Restrict Times | If timeStyle is Interval; Indication that the trigger is active only during the period specified by enabledStart and enabledEnd . | Boolean; Valid values: true/false. | N |
| Saturday | Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Saturday. | Boolean; Valid values: true/false. Default is false. | N |
Anchor |
---|
| simpleDateType - Time |
---|
| simpleDateType - Time |
---|
| simpleDateType | n/a | Indication of when this trigger will be run. | Valid values: Default is Daily (1). | Y (if dayStyle is Simple) |
Anchor |
---|
| startingAt - Time |
---|
| startingAt - Time |
---|
| startingAt | Initial Time Offset | Set only if timeStyle is Interval; Starting time, in minutes offset from the hour. | Format is hh:mm | Y (if startTimeEnable is true) |
Anchor |
---|
| startTimeEnable - Time |
---|
| startTimeEnable - Time |
---|
| startTimeEnable | Enable Offset | Set only if timeStyle is Interval; Indication of whether you want to specify (in startingAt ) a starting time, in minutes offset from the hour, for the trigger to run. | Boolean; Valid values: true/false. Default is false. | N |
| Sunday | Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Sunday. | Boolean; Valid values: true/false. Default is false. | N |
| Thursday | Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Thursday. | Boolean; Valid values: true/false. Default is false. | N |
| Time | Time when the trigger will be run. | Format is hh:mm, using 24-hour time. | Y (if timeStyle is Absolute) |
Anchor |
---|
| timeInterval - Time |
---|
| timeInterval - Time |
---|
| timeInterval | Time Interval | Number of timeIntervalUnits . | Integer | Y (if timeStyle is Interval) |
Anchor |
---|
| timeIntervalUnits - Time |
---|
| timeIntervalUnits - Time |
---|
| timeIntervalUnits | Time Interval Units | Type of time interval. | Valid values: Default is Hours (3). | Y (if timeStyle is Interval) |
Anchor |
---|
| timeStyle - Time |
---|
| timeStyle - Time |
---|
| timeStyle | Time Style | Indicates whether this trigger is for a specific time or a series of times. | Valid values: Default is Absolute (1). | N |
| Tuesday | Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Tuesday. | Boolean; Valid values: true/false. Default is false. | N |
| Wednesday | Set only if simpleDateType is Specific Days; Indicates that the this trigger will be run on Wednesday. | Boolean; Valid values: true/false. Default is false. | N |