Skip to main content

Run Revenue Sync jobs

Zuora

Run Revenue Sync jobs

Introduces the Revenue Sync job that can sync transaction data from Zuora Billing to Zuora Revenue and then do data transformation for data to be collected in Zuora Revenue.

The Revenue Sync job loads a specified range of Zuora Billing object data and then transforms the data to Zuora Revenue fields in the Line Staging tables. It combines the previous Data Sync and Data Transformation jobs into a single one.

We recommend that you run Revenue Sync jobs on a daily basis. You can manually start the Revenue Sync job whenever needed. Alternatively, you can schedule this job to automatically run on a regular basis.

Set up default mapping templates

Transaction data is synced and transformed based on the transaction type. Before running the Revenue Sync job, you must set up the default mapping template for each transaction type in Zuora Revenue. The following transaction types are supported by the Revenue Sync job:

  • Order
  • Invoice Item
  • Invoice Item Adjustment
  • Credit Memo Item
  • Debit Memo Item

Each transaction type can have multiple data mapping templates but only one template can be configured as the default for each type. Unlike the previous Data Sync jobs, the Revenue Sync job syncs and transforms transaction data based on the templates that are set to default. All objects contained in the default mapping templates will be synced and transformed, and you no longer have to manually select the data objects to be synced. Therefore, you must ensure that the data templates you want to use are set to default. 

Default Setting.png

Procedures

After the data mapping templates are correctly configured, you can either run one-off Revenue Sync jobs or create scheduled Revenue Sync jobs.

Revenue Sync UI

Run one-off Revenue Sync jobs

Take the following steps to configure and start a Revenue Sync job:

  1. Navigate to Data Interface > Revenue Sync. The Revenue Sync page is displayed.
  2. (Optional) To view or manage field mappings before running a Revenue Sync job, follow the instructions in Manage Revenue Sync field mapping.
  3. If you have multiple Zuora Billing entities, select an entity from the Entity dropdown list. Otherwise, the entity name is automatically populated.
  4. In the Last Updated Date Range section, select an end date for the date range where the data is synced. You can specify the start date when you run a Revenue Sync job for the first time in this org. Subsequently, the start date defaults from the last run end date and is unavailable for editing.
  5. In the Filters section, specify one or more filter conditions.
    1. In the Field dropdown list,  select the field to be used in the filter condition. The populated fields include both standard fields and custom fields.
    2. In the Operator dropdown list, select the operator for the filter. For example, =.
    3. Enter the field value in the value field.
    4. If multiple filter conditions are required, click + Add Filter to add more filter conditions. You can specify up to 5 filters.
  6. Click Start Revenue Data Sync. If the Revenue Sync job is successfully submitted, the corresponding item is displayed in the Revenue Data Sync History table.

Schedule Revenue Sync jobs

Take the following steps to schedule a Revenue Sync job:

  1. If you have the legacy scheduled RevPro3.0 Zuora Data Transformation programs running, terminate the existing programs.
  2. Navigate to Data Interface > Revenue Sync. The Revenue Sync page is displayed.
  3. (Optional) To view or manage field mappings before running a Revenue Sync job, follow the instructions in Manage Revenue Sync field mapping.
  4. Click Schedule a revenue data sync. The Schedule Revenue Sync Job dialog is then displayed.
  5. In the Schedule Program tab, complete the scheduler settings based on your needs. See Schedule jobs to understand what each configuration field means. If you just terminated a Data Transformation job scheduler, you can configure the fields based on the legacy job configuration.
  6. In the Program Parameters tab, specify the following information:
    • In the Last Updated Date Range section, select the date from the second dropdown list as the Revenue Sync job end date. You can select the current date or any date you like, and the subsequent job will start from this date.
    • In the Filters section, specify one or more filter conditions.
      1. In the Field dropdown list,  select the field to be used in the filter condition. The populated fields include both standard fields and custom fields.
      2. In the Operator dropdown list, select the operator for the filter. For example, =.
      3. Enter the field value in the value field.
      4. If multiple filter conditions are required, click + Add Filter to add more filter conditions. You can specify up to 5 filters.
  7. Click Submit Job. If the scheduled Revenue Sync job is successfully submitted, the corresponding item is displayed in the Revenue Data Sync History table.

Results

  • The Revenue Sync job is available since Zuora Revenue 37.002.02.00, and deprecates the previous Data Sync and Data Transformation jobs for Billing - Revenue Integration.
  • Data from the legacy program can also be displayed in the Revenue Data Sync History table. So if you scheduled or run the previous Data Transformation jobs, the historical data of the job will be listed in the Revenue Data Sync History table.

All data in the specified date range that meets the filter conditions are synced and transformed into the Line Staging tables. You can view all Line Staging data by navigating to Data Interface > Inbound. Note that duplicate records might exist in the Line Staging tables. The Data Collection job will remove duplicate lines during the collection process.

If the job encounters an error or completes with warnings, hover over the job item in the Revenue Data Sync History table and click icon-view.png to check the error details. The sub-jobs are categorized into different objects. To resolve errors, you can take measures based on the suggested action in the corresponding Action column.

Revenue Sync Error Dialog

What to do next

You can then start collecting data. See Collect data for Billing - Revenue Integration for more information.

Limitations

Currently, the following limitations are applicable to Revenue Sync jobs:

  • Canceling Revenue Sync jobs is not supported.
  • After you submit a Revenue Sync job, the Revenue Sync service will first load Zuora Billing object data into Zuora Revenue, then transform the loaded data into Line Staging tables. The real-time progress bar is currently not supported for loading Zuora Billing objects, and is only available after Zuora Revenue starts to transform the loaded data. Therefore, in the Revenue Data Sync History table, you will find the Progress column for Revenue Sync jobs is initially displayed as NA, then displays the actual processing progress.
  • Transaction-level re-sync is not supported.