Skip to main content

Recurring Task Properties

Task Properties: Recurring Task​

Property

UI Field Name

Description

Specifications

Required

Patchable (Instance Only)

indefiniteRecurrences

Indefinite Recurrences

Indication that the recurrence of runs for the specified targetTask will occur indefinitely.

Boolean

Y
(if recurrenceType
is Interval)

Y

intervalEndDayConstraint

Interval End Day Constraint

Specification for whether or not to advance the end day of the recurrence to another day.

String Value

Y
(if recurrenceType
is Interval and
timeWindow is true)

Y

intervalEndTime

Interval End Time (HH:MM)

Ending time of day that runs of the specified targetTask will occur.

String Value of time (HH:MM)

Y
(if recurrenceType
is Interval and
timeWindow is true)

Y

intervalStartDayConstraint

Interval Start Day Constraint

Specification for whether or not to advance the start day of the recurrence to another day.

String Value

Y
(if recurrenceType
is Interval and
timeWindow is true)

Y

intervalStartTime

Interval Start Time (HH:MM)

Starting time of day that runs of the specified targetTask will occur.

String Value of time (HH:MM)

Y (if recurrenceType
is Interval and
timeWindow is true)

Y

numberOfRecurrences

Number Of Recurrences

Number of times that runs of the specified targetTask will occur.

Integer value

Y (if recurrenceType
is Interval)

Y

overrideVariables

Override Variables

Override Variables

Format:

XML
XML
<overrideVariables>
        <variable>
                <name>var1</name>
                <resolution>res1</resolution>
                <value>val1</value>
        </variable>
        <variable>
                <name>var2</name>
                <resolution>res2</resolution>
                <value>val2</value>
        </variable>
</overrideVariables>
JSON
JSON
[ 
  {
    "name": "var1",
    "resolution": "res1", "value": "val1"
  },
  {
    "name": "var2",
    "resolution": "res2", "value": "val2"
  }
]

N

Y

rdExcludeBackupRt

Exclude Backup

Set only if retentionDurationPurgeRt 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

Y

recurrenceInterval

Recurrence Interval

Amount of time to wait - based on the time unit specified in recurrenceIntevalUnit - between runs of the specified targetTask.

Integer value

Y
(if recurrenceType
is Interval)

Y

recurrenceIntervalUnit

Recurrence Interval Unit

Units of time to wait - based on the time specified in recurrenceInterval - between runs of the specified targetTask.

String Value

Y
(if recurrenceType
is Interval)

Y

recurrenceTimeList

Recurrence Time List

List of Times and Days on which runs of the targetTask will reoccur.

Format:

XML
XML
<recurrenceTimeList>
  <recurrenceTime>
    <time>10:05</time> 
    <dayConstraint>None</dayConstraint>
  </recurrenceTime>
  <recurrenceTime>
    <time>11:05</time>    
    <dayConstraint>Sunday1</dayConstraint>
  </recurrenceTime> 
</recurrenceTimeList>

Y

(if recurrenceType
is On)

Y

recurrenceType

Recurrence Type

Type of recurrence

Valid values: One of the following (not case sensitive):

  • As String = Interval, As Value = 1
  • As String = On, As Value = 2

Y

Y

retentionDurationRt

Retention Duration

Set only if retentionDurationPurgeRt is selected; Minimum retention duration for the selected retentionDurationPurgeRt before triggered task instances can qualify for purge.

Positive Integer

N

Y

retentionDurationPurgeRt

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

Y

retentionDurationUnitRt

Retention Duration Unit

Set only if retentionDurationPurgeRt is selected; Retention duration unit.

Valid values:

  • As String = Hours, As Value = 3
  • As String = Days, As Value = 4

Default is Days (4).

N

Y

targetTask

Target Task

Name of the task for which you want to specify recurrence details.

String Value

Y

N

targetTaskStatusText

Status To Monitor

Status being monitored for. When the target task instance(s) being monitored go to the status specified here, the Recurring Task Instance will complete successfully.

Comma-separated list of task instance statuses.

Valid values:

  • Finished
  • Success
  • Skipped
  • Approved

Y
(if targetTaskMonitorCondition
is First Recurrence or Last Recurrence)

Y

timeWindow

Time Window

Specification for whether the targetTask will run within a specified time frame.

Boolean; Valid values: true/false. Default is false.

Y
(if recurrenceType
is Interval and indefiniteRecurrences is false)

Y