Knowledge Center

Knowledge Center > Commerce > Zuora 360 > Synchronize Data from Zuora

Synchronize Data from Zuora

This article explains how to set sync options and trigger various types of Zuora 360 sync 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
    note.png When you set an account status to be cancelled in Zuora, the corresponding account in Salesforce is deleted during the next sync session. If you want to sync cancelled account data to Salesforce, contact  Zuora Global Support to set the special permission to synchronize cancelled accounts.
  • Product Catalog

For detail information on objects and fields synchronized, see Sync Field Reference.

Before synchronizing data, you need to install and configure Zuora 360, and associate your accounts in Zuora with your accounts in Salesforce, as described in Configuring Zuora 360.

To manage Zuora 360 synchronization:

  1. In the Zuora application, click the down arrow next to your user name.
  2. Select Settings > Commerce and click Synchronize Salesforce.com Data
  3. On the Zuora for Salesforce - 360 Sync page, specify the sync settings in each section as described below.

Manual Sync

To start a Manual Sync job:

  1. 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.
  2. 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.
  3. 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:

  1. In the Recurring Sync section, click edit next to the Sync Mode field.
  2. Click the Sync Mode arrow and select Scheduled Sync from the drop-down list.
  3. 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.
  4. 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.
  5. For Start first recurring sync, click and select how many hours to wait before starting the first recurring sync.
  6. For Email Notifications, click and select the event types of which you want to be notified via email. Notifications are sent to the Tenant Admin email address specified in the Tenant Profile. This setting is available only to Recurring Sync jobs. The options are:
    • None - No email notification
    • Errors Only - Email notifications only when sync errors occur
    • All (Excluding Zero Records) - Email notifications when at least one record is successfully synchronized to Salesforce
    • All (Including Zero Records) - Email notifications after all sync jobs. This is the default option for all other types of Zuora 360 syncs, such as On-demand or Manual Syncs.
  7. Click Save. The sync will occur automatically based on the schedule you set.

Real-Time Sync

Refer to Real-time Sync for detail information about this sync mode.

You must have the version 2.70 or later of Zuora 360 in order to use Real-time Sync.

To set up Real-time Syncs:

  1. In the Recurring Sync section, click edit next to the Sync Mode field.
  2. Click the Sync Mode arrow and select Real-time Sync from the drop-down list.

    Turbo Sync automatically runs Full Sync, first, when changing from Scheduled Sync to Real-time Sync or when changing from None to Real-time Sync.

  3. For Objects, click and select Accounts & Related Objects. You can only sync the Accounts & Related objects using 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.
  4. In the Real-time Sync Trigger Conditions section, set the trigger settings. The Real-time Sync trigger settings determine when the next Real-time Sync job is automatically triggered. A sync job occurs when either of the following trigger condition is met, whichever comes first.
    • Maximum Data Change Events Before Sync - Specifies how many data change events occur before the next sync happens. The possible values are: 1, 5, 10, 20, 30, 40, 50, 100, 200, 300, 400, 500. The default value is 10 if you do not set this condition. See Real-Time Sync for a list of data change events monitored to trigger a Real-time Sync.

      We recommend that you set this to 10 or higher.  The lower the Maximum Data Change Events Before Sync trigger value is set, the more API limits will be consumed. You should configure the trigger value according to the number of API limits of your Salesforce org.  

    • Maximum Time Between Sync - Specifies the maximum time between two Real-time sync sessions. If the Maximum Data Change Events Before Sync has not occurred, a sync session will be automatically triggered when the Maximum Time Between Sync duration has elapsed since the last sync session. For example, with Maximum Data Change Events set to 50 and Maximum Time Between Sync set to 30 minute, if there are only 49 data change events accumulated since the last sync session occurred at 10:00 AM, the next sync session will still be automatically started at 10:30 AM. The default interval is 120 minutes.
  5. For Email Notifications, click and select the event types of which you want to be notified via email.
    Notifications are sent to the Tenant Admin email address specified in the Tenant Profile. This setting is available only to Recurring Sync jobs. The options are:
    • None - No email notification
    • Errors Only - Email notifications only when sync errors occur
    • All (Excluding Zero Records) - Email notifications when at least one record is successfully synchronized to Salesforce
    • All (Including Zero Records) - Email notifications after all sync jobs. This is the default option for all other types of Zuora 360 syncs, such as On-demand or Manual Syncs.
  6. Click Save. The sync will occur automatically based on the trigger conditions you set.
  7. You can monitor the status of the Real-time Sync you just scheduled. After you click Save, a status message appears. The message indicates how many more data change events need to be accumulated, or how many minutes longer in maximum, in order for the next sync session to be triggered.
    Real-Time_Sync_Status.png

Advanced Sync Settings

By default, Zuora configures Turbo Sync for optimal performance. For heavy users of custom triggers on 360 objects, Advanced Sync Settings provides options for managing and reducing the possibility of errors during parallel batch processing.

Zuora strongly recommends that you do not change the defaults. Changing the Batch Mode and Batch Size default values will affect sync performance.

Navigate to the Advanced Sync Settings section and click edit to configure.

Zuora 360 Advanced Sync Settings

The following fields are available to configure:

  • Batch Mode Available options:
    • Default.  Sync batches are submitted in a mix of Parallel and Serial mode for optimal performance.
    • Serial Only. Choose this option if you deploy custom triggers in your Salesforce org that could have a high possibility of errors during parallel batch processing. Turbo Sync will submit all sync batches in serial mode and run slower.
  • Batch Size

Choose a smaller batch size if you deploy custom triggers in your Salesforce org that could have high possibility of errors during parallel batch processing. Turbo Sync with a smaller batch size will consume more daily batch limits in your Salesforce org and run slower. Values are:

  • 9000 (default)
  • 8000
  • 7000
  • 6000
  • 5000
  • 4000
  • 3000
  • 2000
  • 1000

Sync History

To see the progress and status of all sync jobs:

  1. In the Sync History section, click clear to remove any view filter.
  2. Click refresh in the Status column heading to refresh the list.
  3. To see a detail status of a job, click the status link in the Status column of the job.
  4. Review the detail status in the Show Result page.
  5. If there is any failure, click [more...] in the Failed column cell. The .csv file with error information opens.
  6. Click close to close the Show Result page.

To narrow the results, filter by a sync date range and by sync operations, i.e., all, Manual Sync, Scheduled Sync, Real-time Sync, On-demand Sync, and Sync Clean-up.

To filter sync jobs:

  1. In the Sync History section, select the From and To dates to filter on.
  2. Click the Operation arrow and select the type of operations you want to monitor.
  3. Click filter to apply the filter. 
  4. Follow the steps 3 - 6 above to see the status of sync jobs.

As of Zuora 360 version 2.70, a job runs automatically to delete entries older than 30 days. For each synchronization, entries with a Finished on date that is lower than or equals today's date minus 30 days will be deleted. The same cleanup logic applies to the Crm Id Change Result table. Entries in this table have a Master-Detail relationship with the Sync History entries.

Sync Status

Zuora 360 returns the following types of status:

Finished

The sync session has completed successfully.

Finished with Errors

The sync session has completed but there is one or more record having sync error(s). These errors will be retried in the next sync session. Some errors, e.g. Unable to lock row, are automatically retry-able, and other errors, e.g. Invalid CRM Account ID, requires a manual fix. We recommend that the errors are addressed as soon as possible.

Failure

Some system failure, such as a database connection failure, a storage failure, or Salesforce connection failure, occurred and caused the sync session finished prematurely. In the next sync cycle, the entire session will be retried instead of only the records in error.

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 Notification

For Recurring Sync jobs, your tenant admin will receive email notifications for the event type specified in the sync setting. Notifications are sent to the Tenant Admin email address specified in the Tenant Profile and include the following information:

  • Tenant Id
  • Tenant Name
  • Entity Id if Multi-entity is enabled
  • Entity Name if Multi-entity is enabled

Sync Retry

If there are records which failed to be synchronized, Zuora 360 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.

Real-time Sync does not retry the sync failures happened in Turbo Sync or Manual Sync. The sync failures in Manual or Turbo Syncs would be retried in the next Manual or Turbo sync session. 

Last modified
18:38, 7 Feb 2017

Tags

Classifications

(not set)