Scheduler

Introduction

The Scheduler module creates scheduled jobs. Its module alias is Scheduler.

Configuration

Note

Module name: Scheduler

Properties

Name	Description	Default	Mandatory
jobs	List of job definitions.	[]

Example

{
  "name": "Scheduler",
  "enabled": true,
  "config": {
    "jobs": [
      {
        "id": "job01",
        "type": "Pipes",
        "schedule": "0 0 9 ? * MON-FRI",
        "params": {
          "pipe": "pipe01",
          "params": {
            "param01": "value01",
            "param02": "value02"
          }
        }
      }
    ]
  }
}

Job definitions

Name	Description	Default	Mandatory
id	Unique job identifier.
type	Registered action type. The built-in default is NoOp.	"NoOp"
schedule	Quartz cron expression or one of the schedule constants. An empty value creates the job without a recurring trigger.
params	JSON object passed to the action.	{}
run_on_start	Trigger a one-off execution when the module starts.	false
run_on_start_delay_secs	Delay before the startup execution.	30

Note

Although schedule is required by the configuration schema, an empty string is accepted and means that no recurring trigger is created. run_on_start can still trigger the job once.

Cron expressions

Schedules use six or seven Quartz cron fields: seconds, minutes, hours, day of month, month, day of week and optional year. Use ? for the day-of-month or day-of-week field that is not specified.

Schedule constants

Constant	Value
EVERYDAY_AT_MIDNIGHT	"0 0 0 ? * * *"
EVERY_HOUR	"0 0 * ? * * *"
EVERY_30_MINUTES	"0 */30 * ? * * *"
EVERY_5_MINUTES	"0 */5 * ? * * *"

The built-in job types are Pipes, Http and Exec. See the examples for additional cron expressions.

In this section

• Examples
• Job types