CMIS Connector 24.3

# Schedule

The `Schedule` action configures CMIS Connector to run an action automatically on a defined schedule, and is used to manage schedules.

The schedules you define are saved so that they continue to run after the server is restarted. If the server is offline when an action is due to begin, the action is skipped and does not run until the start time for the next cycle.

Type: Synchronous

Parameter | Description | Required
--- | --- | ---
`ScheduleAction` | The action to perform: `add` - add a new schedule. `addHoliday` - prevent actions being started by a named schedule for a specified time period. `cancel` - cancel (delete) a schedule. `cancelHoliday` - cancel a holiday created with `ScheduleAction=addHoliday`. `clear` - clear (delete) all schedules. `list` - list schedules. `pause` - pause a schedule. Actions do not run when a schedule is paused. `resume` - resume a schedule that was paused. `update` - update an existing schedule. | Yes
`Name` | The name of the schedule. Names are case-sensitive and cannot begin with an underscore. | Required unless `ScheduleAction` is `clear` or `list`.

When you set `ScheduleAction=add` or `ScheduleAction=update`, use the following parameters to define the schedule:

Parameter | Description | Required
--- | --- | ---
`_action` | The name of the action to schedule. | Required to add a schedule.
`_parameter` | A parameter to pass to the scheduled action each time it runs (replace `parameter` with the actual parameter name). | No
`AllowParallel` | A Boolean value that specifies whether to run the scheduled action if the previous occurrence is still running or queued. This parameter has a default value of `false` for new schedules. | No
`Cycles` | The maximum number of times to run the action. If you do not set this parameter when adding a new schedule, there is no limit on how many times the action can run. | No
`End` | The date and time at which to end the schedule. Specify the value in the format `YYYY-SHORTMONTH-DD HH:NN:SS`. If you do not set this parameter when adding a new schedule, the schedule runs indefinitely. | No
`Intervals` | A comma-separated list of time durations, to specify how long the server waits before running the action again. If the number of `cycles` exceeds the number of `intervals`, the server returns to the start of the list. The default interval for new schedules is 24 hours. The units you can use for setting time durations are: `years`, `months`, `weeks`, `days`, `hours`, `minutes`, and `seconds`. Each unit can be abbreviated to its first letter, for example `3h` instead of `3hours`. Months abbreviates to `m` and minutes to `n`. | No
`Start` | The date and time at which to start the schedule. Specify the value in the format `YYYY-SHORTMONTH-DD HH:NN:SS`. If you do not set this parameter when adding a new schedule, the schedule starts immediately. | Required when updating the `intervals` for a schedule.

When you set `ScheduleAction=addHoliday` or `ScheduleAction=cancelHoliday`, use the following parameters to define the holiday:

Parameter | Description | Required
--- | --- | ---
`End` | The date and time at which to end the holiday. Specify the value in the format `YYYY-SHORTMONTH-DD HH:NN:SS`. | Required when `ScheduleAction` is `addHoliday` or `cancelHoliday`.
`Start` | The date and time at which to start the holiday. Specify the value in the format `YYYY-SHORTMONTH-DD HH:NN:SS`.

## Examples

The following example runs the `BackupServer` action at midday on weekdays, starting on Monday 27th January 2020, for 10 weeks:

    /action=schedule&scheduleaction=add
                    &name=WeekdayBackups
                    &start=2020-JAN-27 12:00:00
                    &intervals=24h, 24h, 24h, 24h, 72h
                    &cycles=50
                    &_action=BackupServer
                    &_path=./backups/

The following action specifies that the schedule should not run any actions between the specified times:

    /action=schedule&scheduleaction=addHoliday
                    &name=WeekdayBackups
                    &start=2020-FEB-03 11:00:00
                    &end=2020-FEB-07 13:00:00

The following example lists schedules that you have defined:

    /action=schedule&scheduleaction=list

The following example updates the number of cycles in the `WeekdayBackups` schedule:

    /action=schedule&scheduleaction=update
                    &name=WeekdayBackups
                    &cycles=100

The following example removes the `WeekdayBackups` schedule:

    /action=schedule&scheduleaction=cancel
                    &name=WeekdayBackups

The following example removes all schedules:

    /action=schedule&scheduleaction=clear

## Response

The following is an example response from `/action=schedule&scheduleaction=list`

    <autnresponse xmlns:autn="http://schemas.autonomy.com/aci/">
      <action>SCHEDULE</action>
      <response>SUCCESS</response>
      <responsedata>
        <schedule>
          <name>WeekdayBackups</name>
          <action>
            <name>backupserver</name>
            <parameter name="path">./backups</parameter>
            <parameter name="scheduledTask">true</parameter>
          </action>
          <holiday>
            <start>2020-Feb-03 11:00:00</start>
            <end>2020-Feb-07 13:00:00</end>
          </holiday>
          <start>2020-Jan-27 12:00:00</start>
          <intervals>1 day, 1 day, 1 day, 1 day, 3 days</intervals>
          <cycles>50</cycles>
          <cyclesRun>2</cyclesRun>
          <cyclesSkipped>1</cyclesSkipped>
          <allowParallel>true</allowParallel>
          <paused>true</paused>
        </schedule>
      </responsedata>
    </autnresponse>

- One or more `holiday` elements might be present if you define holiday periods using `scheduleaction=addholiday`.
- The `cyclesRun` element describes the number of times the scheduled action has run and only appears if the value is greater than zero.
- The `cyclesSkipped` element describes the number of times the scheduled action has been skipped. Actions can be skipped when the server is down or when you schedule a holiday period. This element only appears if the value is greater than zero.
- The `allowParallel` element specifies whether a scheduled action occurs if the previous occurrence is still running or queued, and only appears if the value is `true`.
- The `paused` element indicates whether the schedule is paused and only appears if the value is `true`.

Copyright 2024 Open Text
Version 24.3 | Last updated June 2024

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL CMIS Connector 24.3

Topic Title: Schedule