Skip to main content

Configure Zuora Connector for Salesforce CPQ

Zuora

Configure Zuora Connector for Salesforce CPQ

Take the following steps to install and set up Zuora Connector for Salesforce CPQ.

We do not recommend you install Zuora Connector for Salesforce CPQ and Zuora Quotes in the same org. The configuration has not been certified.

  1. Install the following required packages:
    • Zuora CPQ 360, Version 5.2+
    • Salesforce CPQ, Version 214.12.10+
    • Salesforce CPQ to Zuora Connector
  2. In the Connection Setup tab, set up the connection information to your Zuora tenant.
    Your connection endpoint must include the Zuora WSDL, Version 75 or later, e.g. https://zforsf.zuora.com/apps/services/a/75.0.
  3. In Zuora, add the required custom fields.
  4. Configure any additional custom fields you want to synchronize from Salesforce to Zuora.
  5. In the Schema Setup tab, upload the Zuora WSDL. Include all the correct fields, such as tax fields and custom fields.
  6. After uploading the WSDL in Schema Setup, perform the following:
    1. Select Account and check to see if the TaxExemptCertificateID and TaxExemptStatus fields are included. If not, click Add New Fields and add the two fields.
    2. Select Product and check to see if the AllowFeatureChanges field is included. If not, click Add New Fields and add the field.
  7. Install the Zuora Connector for Salesforce CPQ package.
  8. Add any custom accounting codes.
  9. Configure the Salesforce CPQ package for Zuora Connector for Salesforce CPQ.
  10. Update the page layout assignments for the following objects:
  11. Add users to the Connector permission sets.
  12. Configure the Connector settings in the Zuora Connector Settings tab.
    Particularly, if you have the Taxation or the Zuora Finance enabled in your Zuora tenant, you need to select the corresponding setting in the Zuora Connector Settings tab.
  13. Perform a sync of Accounts and Related objects from Zuora.

Add Required Custom Fields in Zuora

In Zuora, add the following custom fields to the specified Zuora objects. See Manage Custom Fields in Z-Billing for the detail steps.

The custom fields must be added as indexed custom fields.

Object Name Custom Field API Name Field Type
Subscription sfdcContractNumber__c Text (100)
Subscription sfdcContractId__c Text (18)
Product sfdcId__c Text (18)
Product Rate Plan sfdcDiscScheduleID__c Text (18)
Product Rate Plan sfdcPricebookID__c Text (18)
Product Rate Plan sfdcProductID__c  Text (18)
Product Rate Plan sfdcPricingType__c

Picklist of the following values:

  • DISCOUNT_SCHEDULE
  • BLOCK_PRICE
  • PRICEBOOK_ENTRY
Product Rate Plan Charge sfdcDiscScheduleID__c Text (18)
Product Rate Plan Charge sfdcPricingType__c Text (18)
Product Rate Plan Charge sfdcPricebookID__c Text (18)
Product Rate Plan Charge sfdcProductID__c Text (18)
Subscription Rate Plan Charge sfdcSubscriptionId__c Text (18)

Configure Additional Custom Fields to be Synchronized

When managing the product catalog in Salesforce, you can send custom fields you need to Zuora as part of product catalog sync.

To sync a custom field in the catalog sync:

  1. Add the custom field to the Product2 object in Salesforce. The Product Charge, Product Rate Plan and Product objects in Zuora all map to Product2 in Salesforce.
  2. Create the custom field in Schema Setup tab.
  3. Create the corresponding custom field with the same API name in Zuora. The custom field must be created as an indexed custom field.

Because the Product2 object maps to multiple Zuora objects, the custom fields you add must be unique across the Product, the Product Rate Plan, and the Product Rate Plan Charge objects. For example, you can't have the Product.Type__c field and the ProductRatePlan.Type__c field in Zuora because the Product2.Type field would map to both of them.

When you send a Salesforce contract to Zuora for New Subscriptions, you can send custom fields on the subscription object to provide additional information about the subscription.

To send a subscription-related custom field to Zuora:

  1. Add the custom field to the Salesforce CPQ object. The mapping of the objects between Salesforce CPQ and Zuora are as below.
    Salesforce CPQ Object Zuora Object When Synced to Zuora
    Contract Subscription When a contract is sent to Zuora
    Subscription (SBQQ__Subscription__c) RatePlan or RatePlanCharge When a contract is sent to Zuora
    Quote (SBQQ__Quote__c) Account

    When a quote is contracted with a new billing account.

    The custom field values on existing billing accounts cannot not be updated with the new values from Salesforce.

  2. Create the corresponding custom field with the same API name in Zuora.
  3. Upload the Zuora WSDL in the Schema Setup tab. Include all the correct fields, including custom fields.
  4. After uploading the WSDL in Schema Setup, select the object you have custom fields and check to see if the custom fields are included. If not, click Add New Fields and add the custom fields.

Add Custom Accounting Codes

Zuora Finance provides a set of default accounting codes in Chart of Accounts. If you edited those out-of-the-box accounting codes or created additional accounting codes, you need to manually add the custom accounting codes.

  1. In Salesforce, navigate to Setup > Customize > Products > Fields.
  2. For each of the following fields, click the field label and edit the picklist values in the Values section. Click Save when done.
    • Accounting Code if Zuora Finance is NOT enabled in your Zuora tenant
    • Deferred Revenue Account if Zuora Finance is enabled in your Zuora tenant
    • Recognized Revenue Account if Zuora Finance is enabled in your Zuora tenant

Configure Salesforce CPQ for the Connector

In Salesforce CPQ, register Zuora Connector for Salesforce CPQ as a billing plugin and authorize the new calculation service.

  1. In Salesforce, navigate to Setup > Installed Packages.
  2. Click Configure for the Salesforce CPQ package.
  3. On the Settings page, click Plugins.
  4. In the Billing Plugin field, type ZSB.ZuoraBillingPlugin
  5. Click Save.

Update the Product Page Layout Assignment

Use the Product page layout provided by Zuora Connector for Salesforce CPQ for additional Zuora specific fields required.

  1. In Salesforce, navigate to Setup > Customize > Products > Page Layouts.
  2. Click Page Layout Assignment.
  3. Click Edit Assignment.
  4. Click the Page Layout column header to select all profiles.
  5. Click the Page Layout To Use field and select SteelBrick-Zuora Product Layout.
  6. Click Save.

Update the Contract Page Layout Assignment

Use the Contract page layout provided by Zuora Connector for Salesforce CPQ for additional Zuora specific fields required.

  1. In Salesforce, navigate to Setup > Customize > Contracts > Page Layouts.
  2. Click Page Layout Assignment.
  3. Click Edit Assignment.
  4. Click the Page Layout column header to select all profiles.
  5. Click the Page Layout To Use field and select SteelBrick-Zuora Contract Layout.
  6. Click Save.

Update the Salesforce CPQ Quote Page Layout Assignment

Use the Quote page layout provided by Zuora Connector for Salesforce CPQ for additional Zuora specific fields required.

  1. In Salesforce, navigate to Setup > Create > ObjectsQuote in the Salesforce CPQ package.
  2. In the Page Layouts section, click Page Layout Assignment.
  3. Click Edit Assignment.
  4. Click the Page Layout column header to select all profiles.
  5. Click the Page Layout To Use field and select SteelBrick-Zuora Quote Layout.
  6. Click Save.

Add Users to the Permission Sets

The Zuora Connector for Salesforce CPQ package provides two Salesforce permission sets with the permissions required to configure or use the Connector:

  • SteelBrick-Zuora CPQ Admin

For the admin user permissions needed by users managing the Product Catalog and Connector administrative settings.

  • SteelBrick-Zuora CPQ User

For the standard user permissions needed by users using the Salesforce CPQ quoting flow.

Assign the above permission sets to the users who will configure or use the Connector. See Assign Permission Sets to a User if you need a detail instruction.

Use Zuora for Salesforce CPQ Connector with Orders

As of Version 3.0, Zuora Connector for Salesforce CPQ supports Orders capabilities in the form of SubmitContractOrder Plugin.

See Set up the SubmitContractOrder Plugin for how to configure the plugin.