Schedule

Triggers a Workflow on a daily, weekly, monthly, or cron-based schedule.

Revision History

0.0.0.9 - Current release.

You can add this Node to a Workflow without configuring a Connection.

Schedule times are evaluated in the Environment's local time zone.

Use SingleInstance when you want Flowgear to skip a scheduled run while an earlier run is still in progress.

The Schedule Node provides trigger methods for common recurring patterns and cron expressions.

Triggers a Workflow on a recurring daily schedule within a time window.

Parameter	Type	Description
`StartTime`	DateTime	The time of day at which the schedule window starts.
`EndTime`	DateTime	The time of day at which the schedule window ends.
`Interval`	Integer	The number of interval units between trigger events.
`IntervalType`	ScheduleIntervalType	The interval unit to use, such as `Minutes` or `Hours`.
`SingleInstance`	Boolean	When `true`, Flowgear skips the trigger if the Workflow is already running.

Return	Type	Description
`ScheduledTimeUtc`	DateTime	The scheduled fire time in UTC.
`ScheduledTimeLocal`	DateTime	The scheduled fire time in the Environment's local time zone.
`TriggerKey`	String	The trigger identifier for the scheduled run.
`FireId`	String	The unique identifier for the specific trigger event.

Triggers a Workflow on selected days of the week within a time window.

Parameter	Type	Description
`DaysOfWeek`	Array	The days on which the schedule can fire, e.g. `Mon` through `Sun`.
`StartTime`	DateTime	The time of day at which the schedule window starts.
`EndTime`	DateTime	The time of day at which the schedule window ends.
`Interval`	Integer	The number of interval units between trigger events.
`IntervalType`	ScheduleIntervalType	The interval unit to use, such as `Minutes` or `Hours`.
`SingleInstance`	Boolean	When `true`, Flowgear skips the trigger if the Workflow is already running.

Return	Type	Description
`ScheduledTimeUtc`	DateTime	The scheduled fire time in UTC.
`ScheduledTimeLocal`	DateTime	The scheduled fire time in the Environment's local time zone.
`TriggerKey`	String	The trigger identifier for the scheduled run.
`FireId`	String	The unique identifier for the specific trigger event.

Triggers a Workflow on selected days of the month, and optionally selected months, within a time window.

Parameter	Type	Description
`DaysOfMonth`	Array	The days of the month on which the schedule can fire, using values such as `1` to `31` or `Last`.
`Months`	Array	Optional month values, using numbers such as `1` to `12` or names such as `Jan` to `Dec`.
`StartTime`	DateTime	The time of day at which the schedule window starts.
`EndTime`	DateTime	The time of day at which the schedule window ends.
`Interval`	Integer	The number of interval units between trigger events.
`IntervalType`	ScheduleIntervalType	The interval unit to use, such as `Minutes` or `Hours`.
`SingleInstance`	Boolean	When `true`, Flowgear skips the trigger if the Workflow is already running.

Return	Type	Description
`ScheduledTimeUtc`	DateTime	The scheduled fire time in UTC.
`ScheduledTimeLocal`	DateTime	The scheduled fire time in the Environment's local time zone.
`TriggerKey`	String	The trigger identifier for the scheduled run.
`FireId`	String	The unique identifier for the specific trigger event.

Triggers a Workflow by using a cron expression.

Parameter	Type	Description
`CronExpression`	String	The cron expression in `sec min hour day month dow` format.
`SingleInstance`	Boolean	When `true`, Flowgear skips the trigger if the Workflow is already running.

Return	Type	Description
`ScheduledTimeUtc`	DateTime	The scheduled fire time in UTC.
`ScheduledTimeLocal`	DateTime	The scheduled fire time in the Environment's local time zone.
`TriggerKey`	String	The trigger identifier for the scheduled run.
`FireId`	String	The unique identifier for the specific trigger event.

Set EndTime earlier than StartTime when you want the active window to span midnight.
Manual or debug runs synthesize schedule metadata by using the current time, setting TriggerKey to manual, and generating a new FireId.
Use Cron when the daily, weekly, or monthly methods do not match the cadence you need.