Source processor that triggers an event message at configurable times.

The schedule processor is a singleton source, so only one instance of it will be deployed across the cluster.


Name Summary


The schedule expression (written as a Quartz Cron Trigger).


The tz database name of the time zone to execute the scheduleExpression in. Optional and defaults to UTC.


Optional, descriptive name for the processor.


Required identifier of the processor, unique across all processors within the flow. Must be between 3 and 30 characters long; contain only lower and uppercase alphabetical characters (a-z and A-Z), numbers, dashes ("-"), and underscores ("_"); and start with an alphabetical character. In other words, it adheres to the regex pattern [a-zA-Z][a-zA-Z0-9_-]{2,29}.


Optional set of custom properties in a simple jdk-format, that are added to the message exchange properties before processing the incoming payload. Any existing properties with the same name will be replaced by properties defined here.


Whether the incoming payload is available for error processing on failure. Defaults to false.


Name Summary


Strategy for describing how a processor’s message is logged on the server.


Strategy for archiving payloads.


Strategy that customizes the conversion of an incoming payload by a processor (e.g., string to object). Should be used when the processor’s default conversion logic cannot be used.


Schedule Format

The schedule flow source provides a way to schedule flow executions using the Quartz Cron Trigger format. For example, a scheduleExpression of 0 15 10 ? * * would execute the flow every day at 10:15am.

Quartz cron expressions can be difficult to construct. There are online resources available to help translating from human-readable formats to quartz cron expressions. Examples can be found by googling "quartz cron formatter".


Each time the schedule triggers, a message with the following payload will be delivered to the flow:

  "jobName": "my-flow-d20cef-086d70f3-adbb-43a9-94a9-d5704ad3bd56",
  "creationDateTime": "2022-01-18T15:18:36.44646"

The creationDateTime property will be in the UTC timezone.