Scheduling an automated sync

Owned by Anand Manian (Unlicensed)
Last updated: Jan 31, 2022 by Christine Gross
3 min read

This document steps through the process of scheduling an automated sync for API and CSV integrations.

Note Automated syncs are not supported for Browser Extension based integrations at this time.

Steps to schedule an automated sync

  1. To configure an automated schedule for an application, go to the application instance’s details page and click on the gear icon beside Sync now in the top right.

     

  2. For the Enabled API Integration or CSV File Upload (SFTP) you will see a Frequency option with On-demand pre selected.

     

  3. Clicking on the Frequency dropdown will reveal the scheduling options.

     

  4. Selecting an option other than On-demand will reveal a Start Sync On field. Click on it to open the date picker from which you can choose the start date for the automated scheduled syncs to begin.

     

  5. The following summarizes how the scheduling works:

    1. On-demand : Choosing this option will ensure that syncs are only executed on-demand. This essentially means you are choosing to take care of executing the sync manually whenever you want. Selecting this option will also clear any previous schedules that you may have set.

    2. Daily : Choosing this option will execute your sync every day during non-business hours beginning on the specified start date. For example, if you chose 02/01/2022 as the start date, then the scheduled sync will be first executed on 1st of February and every day after that.

    3. Weekly : Choosing this option will execute your sync every 7 days during non-business hours beginning on the specified start date and every 7 days after that. For example, if you chose 02/01/2022 as the start date, then the scheduled sync will be first executed on 1st of February and every Tuesday after that.

    4. Monthly : Choosing this option will execute your sync every month during non-business hours beginning on the specified start date For example, if you chose 02/01/2022 as the start date, then the scheduled sync will be first executed on 1st of February and 1st of very month after that.

Note: In case of Monthly, if you choose a start day of the month greater than 28, i.e., 29, 30 or 31, then Zilla will execute the sync on the last day of the month. For example, if you chose 01/29/2022 as the start date, then Zilla will execute the sync on:

01/31/2022 → 02/28/2022 → 03/31/2022 → 04/30/2022 → etc.

6. Fill in the rest of the configuration fields and click Sync Now to execute the sync manually for the first time. This is required to ensure the integration is configured correctly and the scheduled syncs can run.

7. Click Next.

8. Click Close.