Skip to main content

Run Revenue Sync jobs

Zuora

Run Revenue Sync jobs

Beginning from version 37.002.02.00, the Revenue Sync job is introduced to replace the previous Data Sync job and Data Transformation job. 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.

Prerequisites

Before the Revenue Sync job can be started for the first time, the field mapping definitions and transaction mapping templates must be present in Zuora Revenue. You need to complete the following configurations only once. Then, the Revenue Sync job can be run on a regular basis.

Manage field mapping for data sync

The Billing - Revenue Integration data flow begins on the data sync layer where Zuora Billing object data is imported into Zuora Revenue Pre-staging tables. The one-to-one field mapping needs to defined to determine how each Zuora Billing object field is mapped to the appropriate Zuora Revenue field, which will be used for the subsequent data transformation layer.

Complete the following steps to configure field mapping as a prerequisite for the Revenue Sync job:

  1. Navigate to Data Interface > Revenue Sync.
  2. Expand the side menu and then click Data Mapping. The Data Mapping page opens.
  3. Select your Zuora entity from the Entity dropdown list. The standard field mappings are populated.
  4. To add a new field, click add-icon-green.png. A new line is created.
  5. Specify the following information for the new field mapping item:
    • Billing Object Name: The Zuora Billing object name. 
    • Source Object Column Name: The name of the field in the specified Zuora Billing object. For example, AccountNumber.
    • Revenue Object Column Name: The corresponding field name in Zuora Revenue Line Staging tables. For example, ACCOUNT_NUMBER.
  6. (Optional): To modify an existing field mapping item, directly click the value that you want to modify and specify the new value.
  7. Click save-icon-green.png. The field mapping item is then created or updated.

Configure templates for data transformation

On the data transformation layer, the Billing object data in Pre-staging tables are transformed into Zuora Revenue transaction lines in Staging tables based on the mapping templates. At least one default template is required for each transaction type that will be processed in Zuora Revenue. You can have more than one mapping template for each transaction type. However, only the default one will be used by the Revenue Sync job for data transformation.

The following table lists the supported transaction types by the Revenue Sync job and the corresponding seeded mapping templates.

Supported transaction type Seeded (Pre-configured) mapping template name
Order  Subscription Order Template
Invoice Subscription Invoice Template
Invoice Item Adjustment Subscription Invoice Item Adjustment Template
Credit Memo  Subscription Credit Memo Template
Debit Memo Subscription Debit Memo Template

The seeded mapping templates are initially set to default. To create custom templates, create a copy of the seeded template and then make changes in the copy.

  1. Navigate to File Upload > Transactions/Cost.
  2. Locate the seeded mapping template that you want to customize, hover the mouse over the line, and then click icon-copy.png.
  3. Confirm your selection by clicking OK.
  4. In the Copy Template window, specify a unique template name and click Copy. A line under the specified name is created.
  5. Hover the mouse over the line and click icon-edit.png.
  6. Customize the template details on the Template Definition and the Field Mapping tabs as necessary.
  7. To set this mapping template as the default, toggle the Is this a default template? switch to Yes.
  8. Save your changes and close the Edit Upload Transaction Template window.
  9. (Optional): To avoid any further changes to the Field Mapping tab in this template, hover the mouse over the line and click icon-freeze.png.

Procedures

After the data mapping templates are correctly configured, you can either run ad hoc Revenue Sync jobs or create scheduled Revenue Sync jobs. Ad hoc Revenue Sync jobs and scheduled Revenue Sync jobs are independent of each other, which means that ad hoc jobs and scheduled jobs can be run simultaneously.

Revenue Sync UI

Run ad hoc 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. If you have multiple Zuora Billing entities, select an entity from the Entity dropdown list. If not, the entity name is automatically populated. The timezone for the selected entity is displayed as well.
  3. 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, and the default time for the start date is 12:00 am. Subsequently, the start date defaults from the last run end date and becomes unavailable for editing.
    Note that a maximum of 1 year is allowed for the date range.
  4. 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.
  5. 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. Click Schedule a revenue data sync. The Schedule Revenue Sync Job dialog is then displayed.
  4. 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.
  5. In the Program Parameters tab, specify the following information:
    • If you have multiple Zuora Billing entities, select an entity from the Entity dropdown list. If not, the entity name is automatically populated.
    • 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 becomes unavailable for editing.
    • 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 Submit Job. If the scheduled Revenue Sync job is successfully submitted, the corresponding item is displayed in the Revenue Data Sync History table.

If you want to change the start date or filter condition after a Revenue Sync job is already scheduled, you must first cancel this job. To cancel a scheduled Revenue Sync job, hover over the job listed on the Schedule Jobs page and click icon-reject.png.

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

To check the filter used for the job, hover over the job item in the Revenue Data Sync History table and click icon-toggle-filter.png . Note that the filter format for configured Revenue Sync jobs is different from the filter format for migrated Data Sync jobs:

  • For configured Revenue Sync jobs, the filter format is the filter condition you specified in the Filters field. For example, Account.AccountNumber = 'A-S00000142'.
  • For migrated Data Sync and Data Transformation jobs, apart from the specified filter condition, it also includes the transaction type and the template name. For example, ORDER~Booking Template~Subscription.Name in (''''A-S00000144'''', ''''A-S00000145'''')~~.

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 ad hoc Revenue Sync jobs is not supported.
  • Transaction-level re-sync is not supported.