Scheduled syncs

Introduction to scheduled syncs

While data can be manually synced at the data mapping or data source level, you can also create schedules that will perform syncs automatically. Scheduled syncs make it easier to keep your data up to date and allow you to optimize performance by scheduling syncs during non-peak hours.

Administration > Data Integration > Schedules will take you to the Manage Scheduled Syncs page, which displays a list view of all scheduled syncs of data sources.

Table 1: List view contents

Columns Description
Title Title of scheduled sync. The title will be displayed wherever the schedule appears in the UI.
Run When the sync runs
Data Source Data source being synced
Data Mapping Data mapping(s) from the selected data source that will be synced
Last Run When the sync was last run
Next Run When the sync will run next
Active Whether the scheduled sync is active. Inactive scheduled syncs will not run.
Last Updated When the scheduled sync was last updated

Create a scheduled sync

  1. Navigate to Administration > Data Integration > Schedules.
  2. Click the Create Scheduled Sync button
  3. Fill in the following, then click Create

Table 2: New scheduled sync properties

Option Description
Title Title of scheduled sync. The title will be displayed wherever the data server appears in the UI.
Name Reference name for queries and scripts. The name can contain only letters, numbers, and underscores.
Data Source Data source that will be synced.
Data Mappings Data mappings on the selected data source that should be synced.
Sync data from Time period of data to sync. Default option will sync all new data since the last sync.
Run As Allows you to select who the sync will be run as.
Active Sets whether the scheduled sync is active. Inactive scheduled syncs will not run.
Conditional Allows you to enter a Groovy script that specifies additional conditions for running the sync
Execute pre-sync script Allows you to enter a Groovy script to be run before the sync is started
Execute post-sync script Allows you to enter a Groovy script to be run after the sync is completed
Run Sets how often the sync will run (e.g. hourly, daily, weekly). The options below will change depending on what frequency is set, allowing you to specify exact times.
Accessible from Specifies whether data gathered from this sync will be available to all Brinqa applications or only the application you are currently administrating.

Edit or delete a scheduled sync

Existing scheduled syncs can be edited or deleted by clicking the Actions button that appears to the right on mouseover of the entry on the list view.

TUTORIAL: Chained syncs

Syncs should be scheduled to run non-concurrently for best performance. However, this can be difficult to guarantee since syncs take variable lengths of time to complete according to how much data is being imported. An effective way of avoiding overlap is to chain the sync schedules together, making the starting time of one sync the ending time of another. This tutorial will describe how to build this sort of sync chain.

  1. Navigate to Administration > Data Integration > Schedules
  2. Click Create Scheduled Sync
  3. Enter a Title. The title is a good place to call out which data source and mapping are synced by this schedule.
  4. Select a Data Source
  5. (Optional) Select a Data Mapping. A scheduled sync can sync all mappings on that data source, or only one. If all mappings are selected, mappings will be synced according to the order specified in the order field on the mapping.
  6. (Optional) Modify the Run as and Options fields. The default values are acceptable for most cases.
  7. Enter the desired start time of the first sync (and therefore the entire chain) in Run. The first sync in the chain must have a fixed start time.
  8. Select an option in the Accessible from field, making data from the sync available to all applications or only the application you are currently administrating.
  9. Click Create and return to the scheduled syncs list view (Administration > Data Integration > Schedules)
  10. Click Create Scheduled Sync to create the second sync in the chain
  11. Repeat steps 3 - 6, entering a title and other general settings for the second sync.
  12. For the time settings, select "After" for Run and the name of the first sync you created as the Parent. This tells the schedule to start this sync after the parent sync is complete.
  13. Select an option in the Accessible from field, making data from the sync available to all applications or only the application you are currently administrating.
  14. Click Create
  15. Repeat steps 10-14, selecting the second sync created as the Parent for the third sync, and so on.

The final result is that sync 1 has a definite start time, sync 2 starts when sync 1 has completed, and sync 3 starts when sync 2 has completed. This method can be used to chain together as many syncs as desired.