Schedules
A schedule starts a flow with a new data record at a configured date and time. You can run it once or repeat it at a selected interval.
In your project workspace, open Triggers → Schedules.
To delay a data record that is already moving through a flow, use the Scheduler app.
Before you start
- Your access rights must allow you to open and save schedules. New Schedule, Save, and Run can be unavailable because of access restrictions. See Roles and restrictions.
- Publish the target flow before running its schedule. If the latest flow version is a draft, the schedule uses the latest published version.
- To test execution, move the project to an environment. You can pause or run the schedule there.
- Where schedules are restricted by the project's package, Run is unavailable and the page asks you to upgrade.
- If you plan to use an Interface, configure its payload and mapping first. See Interfaces.
Create a Schedule
- Open Triggers → Schedules and select New Schedule.
- In Schedule details, enter a Name and, optionally, a Description. The name can contain up to 255 characters.
- Configure the start time, timezone, recurrence, and optional stop time under How to run the schedule, as described below.
- Under Select the flow that will be triggered, select the target Flow. Use the refresh button beside the list if you have created or published a flow while the editor is open.
- Under Select the data to start the flow, choose the starting data.
- Select Show execution dates to check the planned dates and times.
- Select Save.
Saving creates or updates the schedule in PAUSED status. Select Run and confirm when you are ready to enable execution according to its configuration.
Set the start time and timezone
In How to run the schedule, complete:
- When will the schedule start?: Select the start date using the date picker.
- At what time will it start?: Enter the time in 24-hour
HH:MMformat. - Select a timezone: Choose the timezone for the schedule's start and stop times and execution calculations.
For a new schedule, the editor attempts to select your browser's timezone. Check this field before saving, especially when your working timezone differs from the timezone you want the schedule to use.
Configure recurrence
Under Do you need it to repeat?, select No for a single execution or Yes to show the recurrence settings.
For a repeating schedule, set It will run every to a number from 1 to 300 and choose the unit:
| Unit | Additional selection |
|---|---|
| Seconds, Minutes, Hours | Set the interval between executions. |
| Days | Set the interval in days. Optional additional repetition settings appear. |
| Weeks | Use On each to select weekdays or Every day. |
| Months | Use On day to select days of the month or Every day. |
| Years | Use On each to select months or Every month. |
For Days, Weeks, Months, and Years, Repeat every lets you add repeated executions within the selected period:
- Choose No repeat if you do not need these additional executions.
- Otherwise, choose an interval from 1 to 300 and a unit: Seconds, Minutes, or Hours. Yearly schedules also offer Days.
- When additional repetition is enabled, Number of repetitions offers 1 to 100 or No stop. This setting controls repetitions within the selected period; it is not the total number of executions over the schedule's lifetime.
Use Show execution dates to check the result of the combined settings.
Set when repetition stops
For a repeating schedule, When will the schedule stop? offers:
- Never: Do not set a stop date.
- On a specific date: Complete On what date will the schedule stop? and At what time will it stop?. Enter the time in 24-hour
HH:MMformat.
The stop time uses the selected schedule timezone.
Preview execution dates
Select Show execution dates to display up to 15 future executions calculated from the current timing settings. A one-time schedule shows one future execution if its start time is valid.
The preview does not save or start the schedule. After changing the configuration, close and reopen the preview to recalculate it, then select Save to keep your changes.
If no future execution is available, it shows With the configuration selected, the schedule won't run. and Please check that the dates to start/finish are correctly set. Review the start time, timezone, recurrence, and stop time. A one-time start time in the past does not produce a future execution.
Choose the starting data
In Select the data to start the flow, answer Do you want to start the flow with data?:
| Choice | Result |
|---|---|
| No, I want an empty Data Structure | Start the flow without supplying starting data. |
| Yes | Show the choices for the current Data Structure or an Interface. |
Use the current Data Structure
Select Yes under Do you want to use your current Data Structure?. The schedule uses the project's current Data Structure as its starting data.
Use an Interface payload
- Select No, I will use an Interface under Do you want to use your current Data Structure?.
- Select an Interface. The list initially contains JSON and XML interfaces that support individual data records. Use the refresh button beside the list if you have created an interface while the editor is open.
- Under Do you need to modify the interface payload?, select:
- No to use the saved payload for an Interface with a custom structure.
- Yes to show Data to send and edit the payload for this schedule.
- Select Save after completing the schedule configuration.
For an Interface that uses the global Data Structure, leaving payload modification set to No uses the project's current Data Structure.
For an Interface with a custom structure, custom payloads must match its format and mapping. Editing Data to send stores the payload on the schedule; it does not update the interface's saved payload or mapping. Review the editor after changing the selected Interface, because selecting an interface or enabling payload editing reloads its example data.
For payload setup and mapping instructions, see Interfaces.
Schedules created from a flow
You can also create schedules from a flow's start configuration:
- Open the flow's start configuration and select Schedule.
- Select New to create a schedule and open its configuration, or use Edit Schedule beside an existing schedule.
- Configure its timing and starting data, then select Save.
When you open the schedule from this configuration, Flow and its refresh button are disabled. The editor explains that the schedule was generated by the flow and is linked to it. You cannot change the target flow in this view.
These schedules create new data records to start the flow.
Overview
A schedule can have one of the following statuses:
| Status | Description |
|---|---|
| PAUSED | The schedule is saved but is not enabled to execute. Saving a configuration sets this status. |
| RUNNING | The schedule is enabled and can execute when its next configured time is due. |
| FINISHED | The schedule has no further executions, for example after its one-time execution or after reaching its stop date. |
| F.ERRORS | The schedule encountered an execution error. Open Log to inspect the message. |
FINISHED describes the schedule's execution period. It does not confirm that every step of the triggered flow completed successfully. Use the data record's report to inspect flow processing.
Schedule information
Open a schedule's actions menu to see the actions available for your access rights and its current status.
| Action | Description |
|---|---|
| Open | Open the schedule configuration and log. |
| Duplicate | Create a separate copy of the configuration in PAUSED status. Review its timing and starting data before running it. |
| Run | Enable a paused schedule. Review and confirm the action. |
| Pause | Pause a running schedule. Review and confirm the action. |
| Delete | Delete a schedule that is not running. |
To change a running schedule's configuration, select Pause first. Save is hidden while the schedule is running. After saving your changes, select Run again when ready.
If the selected flow has no published version, the editor asks you to publish it before running the schedule. If a newer draft exists, execution uses the latest published version.
Review execution logs
After saving a schedule, open Log to review configuration changes, status changes, execution results, and errors.
The table contains Time, Message, and Data Record, with icons identifying success, information, warning, or error entries. Entries are grouped by date.
- Select Refresh to load the latest entries.
- Select Time to change the sort order. Use the page controls and items-per-page selector to browse longer logs.
- When a data record is linked, use the link beside it to open its report. Select the displayed UUID to copy it.
A Data Record correctly inserted message confirms that the schedule created a data record. Check its report for the outcome of the flow itself.
Validation and errors
Before saving, check that:
- Name, Flow, and the start date are filled in. The editor blocks an empty name and a missing flow.
- Enter times in
HH:MMformat. - Both stop fields are filled in when On a specific date is selected.
- An Interface is selected when you choose to use one.
For execution errors, open Log. Messages can identify a flow that is missing or unpublished, payload parsing or mapping problems, or a failure to insert a data record. If the log shows API is not enabled in this project, check the project's access to API processing before running the schedule again.
After correcting the configuration, select Save, check Show execution dates, and select Run when ready.
Was this article helpful?