Schedule
The details of the schedule, in the form of an XML string.
IMPORTANT: The AddSchedule action requires you to provide the schedule information. You can provide the schedule by setting Schedule
, or by setting ScheduleStart and ScheduleInterval (optionally with ScheduleEnd or ScheduleCount).
The XML that you specify must have an <schedule>
parent tag. The following table describes the attributes that you can use in the schedule
tag to specify the schedule to use.
Attribute name | Required | Description |
---|---|---|
Start
|
Yes | The time and date to start running the schedule. For the available date formats, see ScheduleStart. |
Interval
|
Yes | The interval to wait between schedules |
End
|
No | The time and date to stop running the schedule. For the available date formats, see ScheduleEnd. |
Count
|
No | The number of times to run the schedule. |
Paused
|
No | A Boolean value to specify whether the schedule is paused. Set this attribute to true to add the schedule in the paused state. The default value is false (not paused). |
The following XML fragments show example schedules:
<schedule start="2017-Feb-07 00:00:00" interval="4 seconds" end="2019-Feb-07 00:00:00"/>
<schedule start="2017-Feb-07 00:00:00" interval="4 seconds" count=100 paused=True/>
Actions: | AddSchedule EditSchedule |
Type: | XML string |
Default: | None |
Required: | Yes |
Example: | schedule=<schedule start="2017-Feb-07 00:00:00" interval="4 seconds" end="2019-Feb-07 00:00:00"/>
|
See Also: |