Synchronize Data from Zuora
This article explains how to set sync options and trigger various types of Zuora Data Sync for Salesforce CRM operations to synchronize data from Zuora to Salesforce.
See Set up Credentials to Connect to Salesforce for more information on authentication options. You must have an established connection before you can sync data.
Synchronize Data from Zuora to Salesforce
In Zuora, you can trigger or schedule the following types of synchronization:
- Manual Sync
- Scheduled Recurring Sync
- Real-time Sync
The objects that you can sync from Zuora to Salesforce are:
- Accounts & Related Objects
When you set an account status to be cancelled in Zuora, the corresponding account in Salesforce is deleted during the next sync session.
- Product Catalog
By default, the deleted products in Zuora are synchronized to Salesforce. The deleted products are flagged in Salesforce and will not be used in quotes.
For detail information on objects and fields synchronized, see Sync Field Reference.
Before synchronizing data, you need to install and configure Zuora Data Sync for Salesforce CRM, and associate your accounts in Zuora with your accounts in Salesforce, as described in Configuration.
To manage synchronization:
- In the Zuora application, click the down arrow next to your user name.
- Select Settings > Commerce and click Synchronize Salesforce.com Data.
- On the Zuora for Salesforce - 360 Sync page, specify the sync settings in each section as described below.
If the Multi-entity feature is enabled in your tenant, you must add a unique entity prefix to every rate plan charge object, before synchronization.
Manual Sync
To start a Manual Sync job:
- In the Manual Sync section, click the Sync arrow and select the objects to sync from the list. Accounts & Related Objects and Product Catalog are available for sync.
If you select Accounts & Related Objects, note that only the subscriptions in the Active, Pending, and Cancelled state are synced to Salesforce. Draft and Deleted subscriptions are not synced to Salesforce. - Click Sync. The Sync Started pop-up window appears to confirm that the sync request was queued. When the sync is completed, your data can be viewed from Salesforce for the object you selected to sync.
- See Sync Cleanup if you want to run sync cleanup that is available via the clean up button.
Be aware that quotes created using the existing product catalog in Salesforce may not work properly after you run Product Catalog Cleanup.
Scheduled Sync
To set up Scheduled Syncs:
- In the Recurring Sync section, click edit next to the Sync Mode field.
- Click the Sync Mode arrow and select Scheduled Sync from the drop-down list.
- For Objects, click and select the Objects you want to sync.
If you select Accounts & Related Objects, note that only the subscriptions in the Active, Pending, and Cancelled states are synced to Salesforce. Draft and Deleted subscriptions are not synced to Salesforce. - For Sync Interval, click and select the sync interval, such as Daily or Every 2 hours.
If you selected Product Catalog in the Objects field, you can only select Daily in the Sync Interval field. - For Start first recurring sync, click and select how many hours to wait before starting the first recurring sync.
- Click Save. The sync will occur automatically based on the schedule you set.
Near Real-Time Sync
Refer to Near Real-Time Sync for detail information about this sync mode.
Depending on your data volume, it can take up to a few hours for Zuora Data Sync to synchronize all data to Salesforce.=
To set up Real-time Syncs:
- In the Recurring Sync section, click edit next to the Sync Mode field.
- Click the Sync Mode arrow and select Near Real-Time Sync from the drop-down list.
- For Objects, click and select Accounts & Related Objects. You can only sync the Accounts & objects using Near Real-Time Sync.
Only the subscriptions in the Active, Pending, and Cancelled state are synced to Salesforce. Draft and Deleted subscriptions are not synced to Salesforce. - Click Save. The sync will occur automatically.
View Sync Results
To view sync results:
- In the Zuora application, click the down arrow next to your user name.
- Select Settings > Commerce.
- Click Data Connect Results/Retry page.
On the page above, you can view the list of records that are unsuccessfully synced.
- View the complete error message for a certain failure record by hovering your mouse over the specific error message.
Three categories of error codes are available as shown in the following reference table:
Error Code Description DACO-01 Known SFDC Exception DACO-02 Missing CRM ID DACO-99 Unknown Exception
Retry Sync Failures
Zuora Data Sync for Salesforce CRM's daily retry job to sync objects that were failed to sync is triggered twice a day, at 11:30 AM and 11:30 PM UTC. It only picks up records from the past 7 days for scheduled retry jobs.
To retry a sync failure:
- On the OBJECTS TO RETRY page, select the checkboxes before the failure records you are to retry the sync.
You can quickly select all the records by selecting the checkbox in the header row.
Also, you can select the records by object type using the object type filter, as shown in the following steps:
-
Click the
icon at the top right of the OBJECTS TO RETRY page to display the object type filer.
-
Click the object type you are to re-sync.
When you select a parent object type to re-sync, its child object type will also be re-synced. For example, if you select the Invoice objects to re-sync, the Invoice Item and Taxation Item objects will also be re-synced.
-
Click Apply.
-
- Click Retry Selected.
If a failure record is successfully re-synced, it will be removed from the OBJECTS TO RETRY page automatically.
If a failure record is failed to be re-synced, the record will remain on the OBJECTS TO RETRY page with the same ZUORA ID field, but with the SYNC DATE field being updated to the latest time.
Delete Sync Failures
To delete a sync failure:
- On the OBJECTS TO RETRY page, select the checkboxes before the failure records you are to delete.
You can quickly select all the records by selecting the checkbox in the header row.
Also, you can select the records by object type using the object type filter, as shown in the following steps:
-
Click the
icon at the top right of the OBJECTS TO RETRY page to display the object type filer.
-
Click the object type you are to delete.
-
Click Apply.
-
- Click Delete Selected.
The selected records will be deleted from Zuora and removed from the OBJECTS TO RETRY page.
Account Audit
The Audit Account page lists the first 40 accounts that have a CRM ID but were not synchronized to Salesforce. Review each account and resolve the discrepancy by syncing the account to Salesforce.
In the Sync History section, click account audit to open the Audit Account page.
Sync Retry
If there are records which failed to be synchronized, Zuora Data Sync for Salesforce CRM will retry syncing those failed records, in subsequent sync sessions. The retry rules consist of the following:
- If the previous operation was a Sync Cleanup, all object records will be synchronized.
- If there has been a cancelled Sync Cleanup since the latest finished sync, all object records will be synchronized.
- If this object type has not been synchronized since the last finished Sync Cleanup, all object records of this type will be synchronized.
-
If there was a sync and the sync was cancelled, all objects records will be re-synched.
- If the last sync ended with errors before this object type was synchronized, the object records with errors will be re-synchronized.
- If the previous sync ended with errors due to a field migration job for an upgrade of the Salesforce package, the sync session will start from where the last sync stopped.
Sync Cleanup
The Zuora Data Sync Cleanup operation removes all Zuora data from Salesforce, forcing the next sync operation to perform a full synchronization.
A Zuora Data Sync brings data over from Zuora to Salesforce in the following manner:
- The initial sync brings over all data in a full sync.
- After the first sync, subsequent syncs bring over new and updated data in an incremental sync.
- After a sync clean up, the next sync is always a full sync.
If you are considering a Sync Cleanup operation simply to do a forced full sync, instead of running the Cleanup, we recommend that you contact Zuora Support for helping with a full sync.
Zuora Data Sync Cleanup
The Zuora Data Sync Cleanup removes your Zuora data from Salesforce.
- For the Accounts & Related Objects that are used with Zuora Data Sync, the Customer Accounts, Customer Hierarchies, Subscriptions, Subscription Product Charges, and Invoices data are removed.
- For the Product Catalog that is used with Zuora Quotes), the entire Zuora Product Catalog data is removed from Salesforce.
Zuora recommends that you use the Zuora Data Sync Cleanup only when necessary. The following points should be considered before a Cleanup operation on Account & Related Objects:
- The number of records: If the number of records is large, e.g., over 1,000,000, the Sync Cleanup is not recommended.
- The execution time needed: During the Cleanup, the Zuora Data Sync service will be stopped.
- The broken linkage of these records with other Salesforce objects, if the customer has created Lookup relationships in their organization to Zuora Data Sync for Salesforce CRM objects.
Zuora Quotes version 3.x and later includes a migration utility that prevents the cleanup process from removing products from existing quotes.
Performing a cleanup in version 3.x and later is safe, but it is not safe to perform a cleanup using any version of Zuora Quotes prior to 3.x.
Be aware that quotes created using the existing product catalog in Salesforce may not work properly after you run Product Catalog Cleanup.
To perform Sync Cleanup in the Zuora UI:
- In the Zuora application, navigate to Settings > Commerce and click Synchronize Salesforce.com Data.
- In the Manual Sync section on the Zuora for Salesforce - Zuora Data Sync page, click the Sync arrow and select what you want to clean up.
- Click clean up, and click yes in the confirmation window.