Synchronization schedule
Gain a better understanding of how our Sync scheduler works with the settings provided via the Sync Flow.
Synchronization schedule configuration
The schedule of regular data syncsSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. depend on the following values:
- Start date (selected by the merchant in the SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. Flow UI)
- SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. hour (set by the SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. Flow to the client default if available, otherwise it defaults to 00:00 am in the merchant's time zone)
- Time zone (specified by the merchant in the SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. Flow UI)
- Frequency (currently only daily)
"schedule": {
"selectedFrequency": "Daily",
"frequencyOptions": [
"Daily",
"Monthly"
],
"startDate": "2022-06-15",
"syncHour": 0,
"timeZone": "Europe/London"
}
Despite the monthly option being present in the configuration file, currently we only surface the daily option in the SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. Flow UI.
| Property | Type | Description | Required |
|---|---|---|---|
Selected frequency (selectedFrequency) | string | The syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. frequency selected by the merchant. | Required |
Frequency options (frequencyOptions) | string | The available options for syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. frequency provided by Codat. In the SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. Flow UI, only the daily option is available for a merchant to select. | Required |
Start date (startDate) | ISO 8601 datetime | The date from which commerce data syncing should start (only applies to the first syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule.). | Required |
SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. hour (syncHour) | Number Integers from 0 to 23 inclusive | The hour of the day that will mark the start/end of any syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. period. The SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. Flow sets this value automatically to the client default if available, otherwise it defaults to midnight (00:00am) in the merchant's time zone. | Optional, set to the client default if available, otherwise to 0 |
Time zone (timeZone) | string of IANA time zones or null (defaults to Etc/UTC) | The time zone applied to the start date and syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. hour. | Optional, set to ETC/Utc by default |
Once the Sync Flow is completed and Codat receives the configuration, we use it to determine the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. period – the period for which commerce data will be synced in one run of the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. service.
To determine the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. period, we first establish the following values internally:
-
The syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. due date: the datetime a syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. becomes due based on the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. hour. It will mark the end of one syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. period and the beginning of the next.
Note that the SyncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. Flow sets the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. hour for you, and it's the client default if available, otherwise it's 00:00 am in the merchant's time zone. This means that the due date is at the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. hour on the next day to the day we receive the configuration.
-
The syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. run date which is the datetime of the next syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. execution.
Due date and the run date are not similar. Codat manages the run date according to the system load and other factors. The time gap between the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. due date and the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. run date depends on multiple factors and may differ from one syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. to another.
The start date and syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. hour determine the beginning of the first syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. period.
Starting from the second one, every syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. starts at the due date of the previous successful syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule..
Here is an example of a typical first syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule.:
- Now it’s July 13, 4 pm
- The start date is set to May 1
- The syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. hour is set to 00:00 am with the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. frequency set to daily
- The syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. due date (determined by Codat) is 00:00 am on July 14
- The syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. run date (determined by Codat) may be several hours later, for example, at 03:00 am on July 14
- The first syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. period will be from the start date May 1 (00:00 am) to the syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. due date July 14 (00:00 am)
- The next syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. period will be from July 14 (00:00 am), or the last successful syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. date to July 15 (00:00 am), the next syncSync The process of fetching the latest data from a connected data source. Syncs can be triggered manually or run automatically on a schedule. due date.