Managing Schedules

You are looking at an older version of the documentation. The latest version is found here.

Enabling/Disabling a Schedule

SQL

SYSADMIN.EnableSchedule(<IN biginteger id>, <IN boolean enabled>)

This procedure takes the following parameters:

Parameter	Description
`id`	ID of the schedule to be enabled or disabled
`enabled`	Specifies if the schedule should be enabled or disabled; may be either `TRUE` or `FALSE`

Deleting a Schedule

SQL

SYSADMIN.DeleteSchedule( <IN biginteger id> )

This procedure takes the following parameter:

Parameter	Description
`id`	ID of the schedule to be deleted

Modifying a Schedule

SQL

SYSADMIN.UpdateSchedule( <IN biginteger id>, <IN string type>, <IN biginteger intervl>, <IN biginteger startDelay>, <IN string cronExpression>, <IN boolean enabled>, <IN biginteger chainedToScheduleId>, <IN string chainCondition>, <IN string chainString>, <IN string queueHandler> )

This procedure takes the following parameters:

To view the full table, click the expand button in its top right corner

Parameter	Description
`id`	ID of the schedule to be modified
`type`	Can take one of four possible values; depending on the value, some other parameters are required or disregarded: `interval`: `intervl` and `startDelay` parameters are used, `cronExpression`, `chainedToScheduleId`, and `chainCondition` are disregarded `cron`: `cronExpression` and `startDelay` parameters are used, `intervl`, `chainedToScheduleId`, and `chainCondition` are disregarded `once`: only `startDelay` and the enabled parameters are used `chained`: only `chainedToScheduleId` and `chainCondition` parameters are used
`intervl`	How often to repeat the job in minutes. If this parameter is used, the `cronExpression` parameter is disregarded
`startDelay`	Initial delay before running the job (only before the 1st iteration, all subsequent iterations are fired in accordance with interval/cron schedule settings)
`cronExpression`	Provides the Quartz Cron Expression to specify the schedule. If this parameter is used, the `intervl` parameter is disregarded, but the `startDelay` parameter is used. This means that depending on the actual configuration, the event may or may not fire at this specific time; however, the trigger will not fire before this time. If we start a schedule at 17:59 with cron string having '18:00' and set the start delay to 2 minutes, the event will actually fire at 18:00 of the following day
`enabled`	Enables the execution of the schedule according to `interval` or `cronExpression` parameters
`chainedToScheduleId`	ID of the parent schedule, i.e. this schedule will be executed after the parent schedule if `chainCondition` is fulfilled
`chainCondition`	Can take the following possible values: `UNCONDITIONAL`: this schedule is always executed after the parent schedule) `SUCCESS`: this schedule is only executed if the parent schedule succeeds `FAILURE`: this Schedule is only executed if the parent Schedule fails If `NULL` is provided, `UNCONDITIONAL` is set as default
`chainString`	Expression string when complex dependencies are used; see the section further down for a detailed explanation. If the created schedule depends only on one other schedule then either `chainedToScheduleId` is not `NULL` and `chainString` is `NULL`, or `chainedToScheduleId` is `NULL`, `chainCondition` is `NULL`, and `chainString` is not `NULL`
`queueHandler`	Name of queue handler

Resetting a Schedule

SYSADMIN.resetSchedule

This procedure resets both atomic and non-atomic chained schedules.

SQL

SYSADMIN.resetAtomicSchedule( <IN biginteger id> )

This procedure takes the following parameter:

Parameter	Description
`id`	ID of the schedule to be reset

Please note that it creates the mark so that the schedule counts its conditions from that point in time.

`SYSADMIN.resetSchedule` is available since v3.12

SYSADMIN.resetAtomicSchedule

deprecated