After setting up an integration in your workspace, the integration will start to sync data automatically. When a sync is in progress, you'll be able to view an estimated sync duration. Notifications of integration syncing errors will be visible on the integrations and plans pages, and you can also set-up automated email notifications as well.
Sync Steps
There are two steps in an integration syncing flow: Source Data Sync and Plan Data Refresh.
The Source Data Sync represents the syncing of data between your integration source data and QuotaPath. This sync allows QuotaPath to fetch new and updated data. The Plan Data Refresh represents the syncing of data between QuotaPath and your plan data mappings. This sync allows QuotaPath to refresh plan data mappings in order to update QuotaPath deal and payout eligibility information.
If a Source Data Sync is triggered, then a Plan Data Refresh will automatically be triggered too. However, a Plan Data Refresh can be triggered based on activity in your workspace, like editing of plans or mappings.
Sync Types
Integrations can by synced automatically and manually. In addition, a Source Data Sync and Plan Data Refresh can be triggered together or individually.
For 2.0 integration sources, syncs will be triggered automatically based on the sync schedule set during integration set up. In addition, syncs can be manually triggered from the integration card or integration detail pages. Both of these syncs will kick off a Source Data Sync and Plan Data Refresh.
For 1.0 integration sources, syncs will be triggered automatically based on activity in your QuotaPath workspace. In addition, syncs can be manually triggered from the integration card or integration detail pages. Both of these syncs will kick off a Plan Data Refresh sync only.
In addition, a Plan Data Refresh sync will be automatically kicked off based on changes to your workspace data, including:
Mappings are edited
Plans are duplicated
Members are aligned
Members assigned to plan
Plan assignment dates are edited
Estimated Sync Durations
Whenever a Source Data Sync is triggered, whether an automatic or manual sync, an estimated sync duration will appear next to the ‘Source Data Sync’ status on the integration card.
The very first sync in your workspace will default to an estimated duration of 21 mins, which is current average across all workspaces on our latest integration architecture.
Subsequent estimated sync durations will be based on the actual syncs times for your workspace. If sync runs longer than the estimate, the sync status will update accordingly.
Integration Error Messages
If there is an error detected when syncing an integration, a notification will be provided on the integrations and/or plans page. Integration errors can fall into the below categories:
Source Data Sync
Authentication Error
General Sync Error
Source Data Change
Plan Data Refresh
Plan Error
Member Error
Mapping Error
Field Error
Record Error
The integration error notification will provide the following information:
Error Category: Category of error, per the above
Error Message: Information about the error and why it occurred
Error Details: Details about the specific user, plan, record, etc. that is causing the error
Error CTA: Where to go to resolve issue
Integration Error Emails
If you would like to receive automated email notifications in addition to the in-app notifications, go to Settings, and then Notifications & Emails in order to turn on the Integration Error Emails. Email recipients will be defaulted to the workspace owner, but can be edited to any admins. Emails will be sent automatically whenever an integration error email is detected.