Skip to content

Schedules

A schedule links an instance to a recurring cadence so that the instance runs automatically without manual intervention. Each schedule targets one instance and one entity type. You can create multiple schedules for the same instance — one per entity type — to stagger or customize each entity’s run frequency.

When a schedule fires, it triggers a standard incremental pipeline run for the configured entity type. The sync cursor advances after each successful run, so the next scheduled run picks up only new or changed records.

In the left navigation, select Schedules. The list shows all schedules for your tenant.

Schedules list with populated rows

The list displays the following columns:

ColumnDescription
InstanceThe instance this schedule belongs to.
Entity TypeThe entity type this schedule syncs (e.g., item, bp, order).
Cron ExpressionThe schedule’s recurrence pattern in cron notation.
StatusEnabled (green) or Disabled (red). A schedule is also shown as Dependency Inactive (yellow) if its parent instance is inactive.
Last RunDate and time of the most recent run triggered by this schedule.
Next RunCalculated next fire time based on the cron expression.

You can search across instance name, entity type, and cron expression using the search bar above the list.

  1. On the Schedules page, click Create Schedule.
  2. Select the Instance to attach this schedule to (required).
  3. Select the Entity Type to sync on this schedule (required). The list is filtered to entity types configured in the selected instance’s mapping configs.
  4. Choose a Frequency using the schedule builder (see Cadence options below).
  5. Click Create Schedule.

Schedule create form

The schedule builder offers the following frequency modes. All modes generate a standard cron expression that is stored with the schedule.

ModeWhat it doesExample
Every X minutesRuns every N minutes (1–59).Every 15 minutes
Every X hoursRuns every N hours at a chosen minute offset (1–23).Every 6 hours at :00
DailyRuns once per day at a chosen hour and minute.Every day at 8:00 AM
WeeklyRuns on selected days of the week at a chosen time.Every Monday and Wednesday at 9:00 AM
MonthlyRuns on a chosen day of the month (1–28) at a chosen time.1st of each month at 8:00 AM
Advanced (raw cron)Enter a cron expression directly. The UI validates the expression and shows the next five scheduled occurrences.0 2 * * * (2:00 AM daily)

When using the guided modes (all except Advanced), the UI displays a plain-language summary of the schedule and a preview of the next run times after the expression is built.

FieldRequiredDescriptionDefault
InstanceYesThe instance this schedule triggers.
Entity TypeYesThe entity type to sync when this schedule fires.
Frequency / Cron ExpressionYesThe recurrence pattern. Set using the schedule builder or entered directly in Advanced mode.
ActiveNoToggle to enable or disable the schedule.Enabled
  1. On the Schedules list, click Edit next to the schedule.
  2. Update the Entity Type, Cron Expression, or Active state.
  3. Click Save.

The instance that owns the schedule cannot be changed on the edit page. To assign a schedule to a different instance, delete this schedule and create a new one.

  • Disabling (setting Active to off) pauses all future runs without removing the schedule. The schedule remains in the list and can be re-enabled at any time. The last run and next run fields are preserved.
  • Deleting removes the schedule permanently. This does not affect the instance or any past run history.

On the Schedules list, click the Trigger button next to a schedule to fire it immediately, regardless of its next scheduled time. This is equivalent to a manual run for that instance and entity type. The schedule’s next automatic run time is not affected.