Skip to main content

Export schedules

Exports that are initiated by a schedule are added to the queue at the time the scheduler runs (every 10 minutes). The export will be processed when the next available slot in the queue becomes available after the scheduler has added the export to the queue.

For example, setting up a schedule to initiate an export every Monday at 01:00 will add the export to the queue when the scheduler runs at 01:00 but the export won't be processed until the next run of the queue at 01:10 or later if there are exports ahead of it already in the queue.

tip

Files and associated logs for exports that were run via a schedule will be retained after the schedule has been deleted.

Creating a new scheduled export

  1. Navigate to the Data Export management area and open the export record.
  2. Click the Schedules tab and then click the New Schedule button.
  3. Complete the schedule details and toggle to enable the export. A schedule must be enabled for the export to be processed.
  4. Click the Save button to save your changes.

Scheduled export fields

FieldNotesRequired?
NameA name to help identify the schedule in the future.
RepeatHow often you want the export to run.
  • Hourly: Run the export every X hours.
  • Daily: Run the export every X days. Enter a time to add the export to the queue into the At field.
  • Weekly: Run the export every X weeks. Choose the day to run the export by selecting it from the On drop down. Enter a time to add the export to the queue into the At field.
  • Monthly: Run the export every X months. Choose the day of the month to to run the export by selecting a day of the month from the On the drop down. Months that do not contain the selected day will instead use the last day of that month.
The scheduler runs every 10 minutes, if the time entered isn't on a 10 minute interval (00, 10, 20, 30, 40 or 50) the export will be added to the queue at the interval closest to the 10 minute interval. For example, setting the schedule time to 10:04, the export will be added to the queue at 10:00.
Starts onThe date when the export is first scheduled. For example, choosing to export weekly on a Monday and setting the start date to Tuesday 18th February 2020 the first export will be Monday 24th February.
EnabledThe status of the schedule.