Scheduling Exports

Regular exports can be configured using scheduling.

When will the export be processed when initiated by a schedule?

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.

Creating a new scheduled export

  1. Navigate to Data Management under the XForms Pro module, create a new export or choose an existing export and click on the Schedules tab.

  2. Click New Schedule.

  3. Give the schedule a name to help identify the schedule in the future

  4. Choose how often you want the export to run. Exports can run Hourly, Daily, Weekly and Monthly.

    Hourly

    Enter the interval required into the Every input field, to run the export every hour enter 1, to run every two hours enter 2 etc...

    Daily

    Enter the interval required into the Every input field, to run everyday enter 1, to run every other day enter 2 etc...

    Enter a time to add the export to the queue into the At field, 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.

    Weekly

    Enter the interval required into the Every input field, to run every week enter 1, to run fortnightly enter 2 etc...

    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, 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.

    Monthly

    Enter the interval required into the Every input field, to run every month enter 1, to run every other month enter 2 etc...

    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.

    Enter a time to add the export to the queue into the At field, 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.

  5. Choose a start date, this will be the 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.

  6. Toggle to enable the export. A schedule must be enabled for the export to be processed.
  7. Click Save.

Editing a scheduled export

  1. Navigate to Data Management under the XForms Pro module and choose the export you want to change the schedule for.
  2. Click on the Schedule tab.
  3. Click on the name of the schedule you want to edit.
  4. Make your changes.
  5. Click Save.

Disabling a scheduled export

  1. Navigate to Data Management under the XForms Pro module and choose the export you want to disable the schedule for.
  2. Click on the Schedule tab.
  3. Click on the name of the schedule you want to disable.
  4. Toggle the Enabled setting to its off position.
  5. Click Save.

Deleting a scheduled export

  1. Navigate to Data Management under the XForms Pro module and choose the export you want to delete the schedule for.
  2. Click on the Schedule tab.
  3. Click on checkbox next to the name of the schedule you want to delete.
  4. Click on the Actions button
  5. Click Delete.
  6. Confirm the deletion by clicking Delete in the popover or cancel to keep the schedule.

Exports associated to a deleted schedule

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

results matching ""

    No results matching ""