Introduction
The task scheduler provides the capability to run tasks at scheduled times, optionally repeating them as required.
...
Tasks can be passed parameters in JSON form, and an error task can be scheduled to run if the task does not complete.
Configuration
The task scheduler can be configured via the menu item Routing ... Task Scheduler.
The following fields can be configured in a task:
| Field | Description |
|---|---|
| Name | The name of the task to be scheduled |
| Active | When set to checked (on), then the task is active. Only active tasks will be scheduled for running. |
| Type | The following types are supported:
|
| Destination | This value is provided in the variable $caller, and is used as the number to dial in telephony processes. For background (workflow) applications, this is not used. |
Task Control
The task scheduler uses the following fields to control how tasks are scheduled:
Field | Values | Comments |
|---|---|---|
dtNextSchedule | TIMESTAMP | When the task should next be scheduled for. Is updated when the task is rescheduled after running or repeating the max times. |
nState | INTEGER | 0 = READY to run (see dtNextSchedule for when) 10 = STARTING PROCESS (is in daemon being started) 20 = RUNNING (process is actually running) -1 = RESCHEDULE (needs checking whether a reschedule is required) -99 = DONE (job is finished and will not be rescheduled) |
nCurrentTries | INTEGER | The current number of tries of starting the job. |
dtStateChange | TIMESTAMP | Set when the state was changed, which enables recovery of abandoned / lost jobs. Jobs which remain in a state for more than 5 minutes will be recovered as follows:
|
nRepeatingTaskInterval | INTEGER | Number of minutes to wait to reschedule the task again (repeating task). |
State Diagram
Tasks are processed according to the following state diagram:
| draw.io Diagram | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|