Skip to main content

Upgrade Zuora Quotes

Zuora

Upgrade Zuora Quotes

This article explains how to upgrade Zuora Quotes to the latest version. The article covers all the required upgrade tasks from the earliest supported version of Zuora Quotes.

Even if you are upgrading from a later version of Zuora Quotes, we recommend that you review all the required tasks and upgrade as it applies to the current state and version of your Zuora Quotes org.

If Zuora Quotes has never been installed in your Salesforce org, perform the standard installation as described in Install the Zuora Quotes Package.

If you have made any customizations to the out-of-the-box Zuora Quotes, you may run into issues upon upgrade. In some cases, code changes may be required upon upgrade across versions. Refer to the release notes for the new or updated features in this release and determine if your customization needs to be revisited.

Notable changes, in this release and previous releases, that may affect your customization are:

  • In 6.54, the Quote Charge object was migrated to the Quote Rate Plan Charge object.
  • Starting from 7.x, the Product2 object is used for products instead of ZProduct.

Prepare to Upgrade Zuora Quotes

Before you upgrade Zuora Quotes, perform the following tasks:

  1. Successfully install or upgrade Zuora 360 to the latest version. Refer to Upgrade Zuora 360 for the detailed steps.
  2. Determine the currently installed version of Zuora Quotes.
    Check the version of Zuora Quotes installed in your org, and perform the required upgrade steps based on the current version:

    1. In Salesforce, navigate to Setup > Installed Packages.

    2. Note the Version Number of the Zuora Quotes package.

High-level Upgrade Steps

Follow the below steps to upgrade Zuora Quotes to the latest version:

  1. Install the Zuora Quotes Managed Package in Salesforce.

    Request the Zuora Quotes package installation link from Zuora Global Support, click on the link, and follow the prompts. See Install the Zuora Quotes Package for detailed information. Return to the upgrade steps when the installation completes.

  2. This step is required if you upgrade to Quotes Release 8.10.2 and later releases. Clone the relevant permission set and add the zqu__Z_Quote app to the cloned set manually. For earlier versions than 8.10.2, when you install Quotes and assign the permission to users, it grants users access to the zqu__Z_Quote app. Starting from the 8.10.2 release, you must clone the relevant permission set and add the app to it manually, and assign the cloned set to your users. See Step 9 in Install Zuora Quotes.
  3. Assign users to permission sets.
  4. Recreate the Product custom fields.

    If you added any custom field on the ZProduct object in a version 6.61 or earlier, recreate the custom field on the Salesforce Product2 object.

  5. Check the post-installation job status.
  6. Run Manual Syncs from Zuora.

    To ensure that your Salesforce org has the latest Zuora data, log into your Zuora tenant and perform a manual sync of the following. See Synchronize Data from Z-Billing for detail instruction.

    • Accounts and Related Objects
    • Product Catalog
  7. Update object field sets.
  8. Update picklists.
  9. Check and refresh the Zuora tenant settings.

    Follow the additional steps in Enable Bundling in Zuora Quotes if you want to enable Bundling in your org. You will need to have performed a successful Product Catalog Sync to enable Bundling.

  10. Update Zuora Config settings.
  11. Assign page layouts to profiles.
  12. Edit Quote Wizard settings.
  13. Edit search layouts.

  14. Edit page layouts.

  15. Review the Time Zone support.
  16. Review the Rev Rec changes.
  17. Update Entity Ids.
  18. Download the new default quote template from Zuora, and use it to adjust your own customized templates for new fields if required.

  19. Review the Scheduled Jobs for Refresh Custom Settings.
  20. Review the below settings:

Assign Users to Permission Sets

Assign the following permission sets to appropriate users to automatically grant the required permissions at the object, field, and Apex class levels:

  • Zuora Quotes Product Admin: The product admin users create and manage the product catalog in Salesforce. The users in this permission set also have to be assigned to the Zuora Quotes End User permission set.
  • Zuora Quotes End User: The quote users create, manage, and send quotes to Zuora.
  • Zuora Rules End User: The rules users create, update, and execute Zuora Rules Engine.

To assign users to a permission set:

  1. Navigate to Setup > Manage Users > Permission Sets.
  2. Click one of the above permission sets.
  3. Click Manage Assignments.
  4. Click Add Assignments.
  5. Select the users and click Assign
  6. Click Done.

Update Field Sets

The table below summarizes the changes needed in Zuora Quotes field sets. Review the field sets in your org and make changes as necessary. If you have customized these field sets in previous releases, e.g., modified the field set names, added/removed fields, follow the steps below to update your customized field sets. 

If you are upgrading from a version higher than what is specified in the Changed in Version column, you do not need to update the particular field set.

Object Field Set Changed
in
Version
Field Change
Quote zqu__Amend_Quote_Subscription_Terms 6.0

Remove:

  • Special Terms and Notes
    (zqu__Terms__c)

Add:

  • Generate Invoice
    (zqu__GenerateInvoice__c)
  • Invoice Processing Options
    (zqu__
    InvoiceProcessingOptions__c)
Quote zqu__Renewal_Quote_Subscription_Terms 6.0

Remove:

  • Special Terms and Notes
    (zqu__Terms__c)

Add:

  • Generate Invoice
    (zqu__GenerateInvoice__c)
  • Invoice Processing Options
    (zqu__
    InvoiceProcessingOptions__c)
Quote zqu__Detail_Quote_Information 6.0

Add:

  • Valid Until 
    (zqu__ValidUntil__c)
Quote

zqu__Amend_Edit_Subscription_Terms

zqu__Amend_Quote_Subscription_Terms

zqu__Detail_Subscription_Terms

 

 

6.1

Field set renamed to:

  • Subscription Terms and Conditions

Add:

  • Start Date 
    (zqu__StartDate__c)
  • Subscription Version
    (zqu__SubscriptionVersion__c)
  • Subscription Term Type 
    (zqu__Subscription_Term_Type
    __c)
  • Initial Term 
    (zqu__IntialTerm__c)
  • Renewal Term 
    (zqu__RenewalTerm__c)
  • Subscription Term Start Date 
    (zqu__
    SubscriptionTermStartDate__c)
  • Subscription Term End Date 
    (zqu__
    SubscriptionTermEndDate__c)
  • Auto Renew 
    (zqu__AutoRenew__c)
  • Generate Invoice
    (zqu__GenerateInvoice__c)
  • Invoice Processing Option
    (zqu__
    InvoiceProcessingOpton__c)
  • Process Payment
    (zqu__ProcessPayment__c)
Quote zqu__Renewal_Quote_Subscription_Terms 6.1

Field set renamed to:

  • Subscription Terms and Conditions

Add:

  • Start Date 
    (zqu__StartDate__c)
  • Subscription Version
    (zqu__SubscriptionVersion__c)
  • Subscription Term Type 
    (zqu__Subscription_Term_Type
    __c)
  • Renewal Term 
    (zqu__RenewalTerm__c)
  • Subscription Term Start Date 
    (zqu__
    SubscriptionTermStartDate__c)
  • Subscription Term End Date 
    (zqu__
    SubscriptionTermEndDate__c)
  • Auto Renew 
    (zqu__AutoRenew__c)
  • Generate Invoice
    (zqu__GenerateInvoice__c)
  • Invoice Processing Option
    (zqu__
    InvoiceProcessingOpton__c)
  • Process Payment
    (zqu__ProcessPayment__c)
Quote zqu__Subscription_Terms 6.1

Field set renamed to:

  • Subscription Terms and Conditions

Add:

  • Start Date 
    (zqu__StartDate__c)
  • Subscription Term Type 
    (zqu__Subscription_Term_Type
    __c)
  • Initial Term 
    (zqu__IntialTerm__c)
  • Renewal Term 
    (zqu__RenewalTerm__c)
  • Auto Renew 
    (zqu__AutoRenew__c)
  • Generate Invoice
    (zqu__GenerateInvoice__c)
  • Invoice Processing Option
    (zqu__
    InvoiceProcessingOpton__c)
Quote zqu__Amend_Quote_Detail_Metrics 8.7

If Order is enabled, add:

  • Delta Discount MRR
    (zqu__DeltaDiscountMRR__c)
  • Delta Discount TCB
    (
    zqu__DeltaDiscountTCB__c)
  • Delta Discount TCB Tax
    (zqu__DeltaDiscountTCBTax__c)
  • Delta Discount TCV
    (zqu__DeltaDiscountTCV__c)
  • Deta TCB Tax
    (zqu__DeltaTCBTax__c)
  • Discount MRR
    (zqu__DiscountMRR__c)
  • Discount TCB
    (zqu__DiscountTCB__c)
  • Discount TCB Tax
    (zqu__DiscountTCBTax__c)
  • Discount TCV
    (zqu__DiscountTCV__c)
  • Delta TCB
    (zqu__Previewed_Delta_TCB
    __c)
  • Delta TCV
    (zqu__Previewed_TCV__c)
  • Delta TCB Tax
    (zqu__TCBTax__c)
Quote zqu__Quote_Detail_Metrics 8.7

If Order is enbled, add:

  • Delta Discount MRR
    (zqu__DeltaDiscountMRR__c)
  • Delta Discount TCB
    (
    zqu__DeltaDiscountTCB__c)
  • Delta Discount TCB Tax
    (zqu__DeltaDiscountTCBTax__c)
  • Delta Discount TCV
    (zqu__DeltaDiscountTCV__c)
  • Deta TCB Tax
    (zqu__DeltaTCBTax__c)
  • Discount MRR
    (zqu__DiscountMRR__c)
  • Discount TCB
    (zqu__DiscountTCB__c)
  • Discount TCB Tax
    (zqu__DiscountTCBTax__c)
  • Discount TCV
    (zqu__DiscountTCV__c)
  • Delta TCB
    (zqu__Previewed_Delta_TCB
    __c)
  • Delta TCV
    (zqu__Previewed_TCV__c)
  • Delta TCB Tax
    (zqu__TCBTax__c)
Quote Rate Plan Charge zqu__DisplayChargeFields

7.1

Add:

  • Product Name
    (zqu__ProductName__c)
    This field must be the first in the field set.
  • Included Units
    (zqu__IncludedUnits__c)

 

To update a field set:

The Order metrics are only available if you have the Orders feature enabled. We are actively soliciting feedback from a small set of early adopters. If you wish to have access to the feature, submit a request at Zuora Global Support

  1. Navigate to Setup > App Setup > Create > Objects and click the object.
  2. In the Field Sets section, click Edit for the field set.
  3. Add or remove fields from the field set as specified in the above table.
  4. Clock Save.

Update Picklists 

The table below summarizes the changes in picklists. Review the changes against what you have set up in your org and update the picklists as necessary. 

If you are upgrading from a version higher than what is specified in the Changed in Version column, you do not need to update the picklist of that particular field.

Object Field Changed
in
Version
Record Types Picklist Values
Quote Billing Batch 6.40 All

Add:

  • Batch21
  • ...
  • Batch50
Quote Quote Business Type 6.54 All Add or remove picklist values based on the Record Type and business needs. 
Quote Initial Term Period Type (new) 7.4

Default

Amendment

Renewal

Move all in the Available Values list to Selected Values list.

Default: Month

Quote Ramp Frequency (new) 8.4

Default

Amendment

Renewal

Move all in the Available Values list to Selected Values list.
Quote Renewal Term Period Type (new) 8.4

Default

Amendment

Renewal

Move all in the Available Values list to Selected Values list.
Product Rate Plan Charge
  • Accounting Code
  • Tax Code
  • Deferred Revenue Account
  • Recognized Revenue Account 
7.1 n/a Add or update the picklist options based on the settings in your Zuora tenant.
Product Rate Plan Charge Model 7.1 n/a

Add:

  • Discount-Fixed Amount
  • Discount-Percentage
  • Flat Fee Pricing
  • Per Unit Pricing
  • Overage Pricing
  • Tiered Pricing
  • Tiered with Overage Pricing
  • Volume Pricing
Product Rate Plan Charge Rev Rec Code (zqu__RevRecCode2__c) 7.1 n/a

Add the same Rev Rec Codes that you have in your Zuora tenant. See Add Revenue Recognition Codes to see the revenue recognition codes defined in your Zuora tenant.

Product Rate Plan Charge Bill Cycle Type 7.4 n/a

Add:

Specific Day of Week

Product Rate Plan Charge List Price Base 7.4 n/a

Add:

Per Week

Product Rate Plan Charge Billing Period 7.4 n/a

Add:

  • Week
  • Specific Weeks
Quote Rate Plan Charge Bill Cycle Type 7.4 n/a

Add:

SpecificDayofWeek

Quote Rate Plan Charge List Price Base 7.4 n/a

Add:

Per Week

Quote Rate Plan Charge Period 7.4 n/a

Add:

  • Week
  • Specific Weeks
Quote Wizard Step Subscription Type 7.3 n/a

Add:

  • Edit Subscription
  • Edit Amendment
  • Edit Renewal
Quote Amendment Type 8.2 n/a

Add:

Original

Product Rate Plan Charge Rating Group 9.5 n/a

Add:

ByGroupId

 

To add new picklist options to an existing field:

  1. Navigate to Setup > Create > Objects.
  2. Click the object name.
  3. In the Custom Fields & Relationships section, click the field.
  4. In the Picklist Values section, click New.
  5. Type the new options values.
  6. Select the Record Type Names specified in the table above.
  7. Click Save.
  8. Check if the new options are listed in the Picklist Values section.

To add new picklist options to a new field:

  1. Navigate to Setup > Create > Objects.
  2. Click the object name.
  3. In the Record Types section, perform the following for each record type:
    1. Click the record type.
    2. Click Edit for the field.
    3. Add all Available Values to Selected Values list.
    4. In the Default field, click and select the option values.
    5. Click Save.

Enable Zuora Tenant Settings

If you do not intend to use the following features in Zuora, you do NOT need to perform these steps.

The following settings are enabled in your Zuora tenant first and propagated to {{zquote}}. Once a day, the Zuora settings are checked, and the settings in {{zquote}} are refreshed based on the Zuora settings. If you want to manually refresh the settings before the next scheduled, you can execute the corresponding method on the RefreshCustomSettingSchedulable class as described below the table:

Setting Method Introduced in Version
Feature refreshEntitlementPermission 6.2
Bundling refreshCpqPermissions

7.0

See Enable Bundling in Zuora Quotes for additional steps required to use Bundling in your org.

Rules Engine refreshRulesEnginePermissions

7.0
Only applicable if you remain on Quotes 7.x. In 8.x and later this can be enabled on Salesforce directly.

See Enable Rules Engine for additional steps required to use Rules Engine.

Multi-Entity refreshMultiEntityPermission 7.40
Order refreshOrdersPermission

8.1

warning.png This feature is only available if you have the Orders feature enabled.

 

To immediately update a Zuora setting before the next schedule permission check happens, run the following to force the permission check:

  1. In Salesforce, open Developer Console.
  2. Navigate to Debug > Open Execute Anonymous Window.
  3. In the Enter Apex Code window, type:

    zqu.RefreshCustomSettingSchedulable.method_in_the_table_above();

  4. Click Execute.
  5. In Zuora Quotes, click the Zuora Config tab and verify that the setting is correctly updated in the Advanced Quoting Configuration Settings.

See Advanced Quoting Configuration Settings for more information about the above settings.

Update Zuora Quotes Config Settings

The table below lists the Zuora Configuration settings that were introduced, updated, or deprecated. Configure these settings according to your organization's needs. Click the link in the Config Page column for detail information about the field in the specific config page. 

Config Page Setting Field Changed
in
Version
Change Description
Zuora Connection Settings

API URL

n/a n/a

Update the URL to point to the latest supported Zuora WSDL version.

The minimum supported version is 80.

Default Value Settings Calculate Quote Metrics Through 6.0 Added

Used to calculate quote metrics –including Total, Tax, and Discount.

Once this value is set, it must always have a value.

Quote Configuration 
Settings

Auto-fill Dates for Quote Metrics Preview 

6.10 Added

If you want to set Service Activation Date and Customer Acceptance Date in addition to Contract Effective Date after the quote is sent to Z-Billing, enable this setting in Zuora Config.  Once enabled, the setting will set a default value to Service Activation Date and Customer Acceptance Date when calculating the quote metrics.

Quote Configuration 
Settings
Get Tiers From Zuora 6.30 Added

Select to align quote tiers and subscription tiers in Amendment quotes.

We recommend that you enable this setting.

Quote Configuration 
Settings
Get Billing Accounts From 360 6.30 Added We recommend that you enable this setting with Real-time Sync also enabled.
Quote Configuration 
Settings
Store Data in Quote Charge 6.50 Added

Only select this option if you need to use the deprecated Quote Charge object for backward compatibility.

When this option is selected, the data in Quote Rate Plan Charge will be copied to Quote Charge for New Subscription Quotes.

The setting only affects data created after this option is enabled, and it does not trigger any data migration.

Quote Configuration 
Settings
Apply Credit Balance 6.50 Added Select to automatically apply any credit balance on a customer account to invoices.
Quote Configuration 
Settings
Enable Consolidated Charge-level Reports 6.50 Deprecated  
Quote Configuration 
Settings
Enable Amendment Functionality 6.50 Deprecated

Now to disallow users from creating quotes for Amendments, follow the steps in this article.

Quote Configuration 
Settings
Enforce Unique Subscription Quote Number 7.43 Added  
Quote Configuration 
Settings
Whitelist FieldSet Name 8.2 Added See below.
Advanced Quoting Configuration Settings Maximum Rate Plans Added To Quote 6.50 Added

The maximum number of rate plans can be added to Quotes in the Product Selector.

Display Scale Settings

List Price for Charge

List Total for Charge

Effective Price for Charge

Total for Charge

Discount for Charge

6.30 Added Use the setting to define the decimal scale for displaying charges.
Display Scale Settings

Discount for Tier

Effective Price for Tier

List Price for Tier

6.40 Added Use the setting to define the decimal scale for displaying tiers.

Invoice Template Settings

All fields 6.30 Added Add invoice template records in your Zuora tenant.
Communication Profile Settings All fields 6.30 Added Click the Refresh Profiles From Zuora button to automatically add communication profiles defined in your Zuora tenant.
Hosted Payment Pages Settings All fields 6.30 Added This setting page appears after the scheduled job runs. The job checks if the Hosted Payment Pages is enabled in your Zuora tenant.
Payment Pages Settings All fields 6.30 Added This setting page appears after the scheduled job runs. The job checks if the Payment Pages 2.0 is enabled in your Zuora tenant.

 

To edit Zuora Config settings: 

  1. Click the Config Page you want to edit in the Zuora Config tab.
  2. Click Edit Settings.
  3. Update the settings.
  4. Click Save.

Add Custom Fields to the White List Field Set

If there are any customizations that use global methods to refer to Zuora Quotes custom fields, add those custom fields to the white list field set.

Starting in Version 8.2, Zuora Quotes tracks the custom fields in the following ways:

  • Tracks the standard fields and the custom fields included in the field sets of the managed package. 
  • Other custom fields included in the field set specified by the whitelist field set name in Quote Configuration Settings.

If there are any customizations that use global methods to refer to Zuora Quotes custom fields, review the customization to determine whether code changes are required before upgrading to this version.

Assign Page Layouts to User Profiles

Assign the latest page layouts listed in the following table to your quoting user profiles.

Object Record Type Page Layout to Use
Quote Master Quote Layout - Default V8.0
Quote Amendment Quote Layout - Amendment v8.0
Quote Amendment ReadOnly Quote Layout - Amendment Read-Only v8.0
Quote Default Quote Layout - Default V8.0
Quote ReadOnly Quote Layout - Read Only v8.0
Quote Renewal Quote Layout - Renewal V8.0
Quote Renewal ReadOnly Quote Layout - Renewal Read-Only V8.0
Product
(Salesforce object)
n/a Product Layout (Installed Package: Zuora for Salesforce Quotes)
Product Rate Plan n/a Rate Plan Layout v7.0
Product Rate Plan Charge n/a Product Rate Plan Charge Z-Force Layout v7.0

 

To assign the page layouts to user profiles:

  1. Navigate to Setup > Create > Objects.
  2. Click the object
  3. In the Page Layouts section, click Page Layout Assignment.
  4. Click Edit Assignment.
  5. For the Quote object, click the record type column heading, such as Master, Amendment, etc.
  6. For the other objects, click the Page Layout column header.
  7. With the profile and the record type highlighted (only for Quotes), click the Page Layout To Use field, and select the page layout of each record type as shown in the above table.
  8. Click Save.

To update the page layout assignment for the Salesforce Product object:

  1. Navigate to Setup > Customize > Products > Page Layouts.
  2. Click Page Layout Assignment.
  3. Click Edit Assignment.
  4. On the Edit Page Layout Assignment page, click the profile.
  5. Click the Page Layout To Use field and select Product Layout (Installed Package: Zuora for Salesforce Quotes).
  6. Click Save.

Edit Quote Wizard Configuration

If you customized quoting flows and want to support Bundling and Zuora Rules Engine in the quoting process, you must use the Lightning Guided Product Selector. To use the Lightning Guided Product Selector, the quoting steps need to be assigned as below.

Subscription Type Step # Visualforce Page to be Assigned
New Subscription 1 zqu__quoteEnhancement
  2 zqu__CreateQuote
  3 zqu__EditQuoteProducts
Amend Subscription 1 zqu__quoteEnhancement
  2 zqu__CreateQuote
  3 aqu__EditQuoteProducts
Renew Subscription 1 zqu__quoteEnhancement
  2 zqu__CreateQuote
  3 zqu__EditQuoteProducts
Cancel Subscription 1 zqu__quoteEnhancement
  2 zqu__ZQCancellation
Edit Subscription 1 zqu__quoteEnhancement
  2 zqu_CreateQuote
Edit Amendment 1 zqu_CreateQuote
Edit Renewal 1 zqu_CreateQuote

 

Make the following changes in the Quote Wizard Configuration for each subscription type:

  1. Click Quote Wizard Settings in the Zuora Config tab.
  2. Click Edit to update the Quote Wizard Configuration for each subscription type as below. 
  3. Click Restore to Defaults to use the new pages.
  4. Select the Display Progress Bar check box to enable the progress bar.
  5. Click Save after making changes to each subscription type.

If you need to continue using the old product selector, follow the steps below to revert to the old product selector.

Edit Search Layouts

Add the New Quote Button to Quote List View

In Q1 '14 release, we introduced the ability to create a new quote without an opportunity.  Add the New Quote button to the Quote List Layout to provide the functionality to your quoting users.

  1. Navigate to Setup > Create > Objects > Quote.
  2. In the Search Layouts section, click Edit next to Quote List View.
  3. In the Custom Buttons section, move New Quote from the Available Buttons list to Selected Buttons list.
  4. Click Save.

Edit Page Layouts

Object Page Layout Field

Quote

(zqu__Quote__c)

  • Quote Layout - Default V8.0
  • Quote Layout - Amendment v8.0
  • Quote Layout - Amendment Read-Only v8.0
  • Quote Layout - Default V8.0
  • Quote Layout - Read Only v8.0
  • Quote Layout - Renewal V8.0
  • Quote Layout - Renewal Read-Only V8.0

Add:

  • zqu__DeltaDiscountMRR__c
  • zqu__DeltaDiscountTCB__c
  • zqu__DeltaDiscountTCBTax__c
  • zqu__DeltaDiscountTCV__c
  • zqu__DeltaTCB__c
  • zqu__DeltaTCBTax__c
  • zqu__DiscountMRR__c
  • zqu__DiscountTCB__c
  • zqu__DiscountTCBTax__c
  • zqu__DiscountTCV__c
  • zqu__TCB__c
  • zqu__TCBTax__c
Quote Charge Summary
(zqu__QuoteChargeSummary__c) 
  • QuoteChargeSummary Layout

Add:

  • zqu__DeltaDiscountTCBTax__c
  • zqu__DeltaTCBTax__c

Remove: 

  • zqu__previewedMRR__c
  • zqu__previewedTCV__c
  • zqu__BiilingTotal__c
  • zqu__BillingSubTotal__c
  • zqu__BillingTax__c
  • zqu__BillingDiscount__c
Quote Rate Plan Charge
(zqu__QuoteRatePlanCharge__c)
  • Quote Rate Plan Charge Layout

Add:

  • zqu__DeltaDiscountTCBTax__c
  • zqu__DeltaTCBTax__c

Remove:

  • zqu__previewedMRR__c
  • zqu__previewedTCV__c
  • zqu__BiilingTotal__c
  • zqu__BillingSubTotal__c
  • zqu__BillingTax__c
  • zqu__BillingDiscount__c

 

Add the new metrics fields to the Quote Detail pages if you have the Order permission enabled in your org:

If you are an existing Zuora Subscribe and Amend customer, we recommend you enable Orders Harmonization to access the Orders feature. With Orders, you can access both existing functions for subscription and billing management and the new features on Zuora Billing.

  1. Navigate to Setup > Create > Quote.
  2. In the Page Layouts section, click Edit next to the page.
  3. In the Related Lists section, drag and drop Quote Charge Details to the Related Lists section.
  4. In the Related Lists section, click the wrench icon for Quote Charge Details.
  5. In the Related List Properties dialog, add the new charge metrics fields to the Selected Fields list. 
  6. Click OK.
  7. Click Save.
  8. Repeat Step #2 - #7 for each Quote pages listed in the table above.

Check Post-installation Job Status

After the installation has completed, post-installation scripts automatically start. The following table contains those post-installation jobs and the version they are introduced in. 

If you are upgrading from a version higher than what is specified in the Introduced in Version column, you do not need to review the particular Apex job.

Post-installation Apex Job Introduced in Version Comment
TermsAndConditionsMigration 6.1 See below.
QuoteRatePlanChargeMigration 6.1  
QuoteChargesSummaryMigration 6.1  
QuoteMigration 6.1

Populates the two new fields introduced in 6.1:

  • zqu__Quote__c.zqu__Account__c
  • zqu__Quote__c.zqu__ProcessPayment__c
PopulateGuidedSellingFlows 6.2  
PopulateGuidedSellingFlowsMigration 6.3  
ZuoraQuotesUpgradeConversion6_51 6.52 See below.
QuoteRatePlanChargeProductNameMigration 7.4

Populates the Product Name and Rate Plan Name fields in the Quote Rate Plan Charge objects if the fields are empty.

See below.

 

To check the status of the post-installation jobs:

  1. Navigate to Setup > Administration Setup > Monitoring > Apex Jobs and verify that the jobs have completed.
  2. The above post-installation jobs will be listed as ChainedJob in the Apex Jobs table.
  3. If ChainedJob failed, navigate to Setup > Administration Setup > Monitoring >  Debug Logs to see detailed information of the failure or error.
  4. If you cannot find any helpful information in Debug Logs, contact Zuora Global Support for assistance.

When you fix the error, manually run the script in the Developer Console:

  1. Click your username and select Developer Console.
  2. In Developer Consoler, navigate to Debug > Open Execute Anonymous Window.
  3. In the Enter Apex Code window, get the Apex job name from the table above, enter the following Apex, and click Execute:
    Database.executeBatch(new zqu.Apex_job_name());
    For example:
    Database.executeBatch(new zqu.QuoteRatePlanChargeProductNameMigration());
  4. Navigate to Setup > Administration Setup > Monitoring > Apex Jobs and verify that the specific job is running.

Terms and Conditions Migration 

The TermsAndConditionsMigration job populates the new terms and conditions fields that were added to all Amendment and Renewal quotes. The new fields are used to support the new Terms and Conditions amendment enhancement. Because the migration job uses the terms and conditions values from Zuora 360 for the existing Amendment and Renewal subscription quotes,  for this migration job to work successfully, a Zuora 360 sync session must be completed prior to upgrading.

Quote Rate Plan Charge Product Name Migration

The QuoteRatePlanChargeProductNameMigration migration script populates the Product Name and Rate Plan Name fields in the Quote Rate Plan Charge objects if the fields are empty.

  • If you are upgrading from the Version 7.x, you need to manually execute the migration script in Developer Console as described above.
  • If you are upgrading from the Version 6.x or earlier, after the installation completes, the post-installation script will automatically start to migrate quote rate plan charges. 

Quote Charge Data Migration

You only need to run this migration job if you need to maintain a backward compatibility with the deprecated Quote Charge object.

Due to the Quote object refactoring, the New Subscription quotes that were saved in previous versions of Zuora Quotes will not be accessible in this version. The ZuoraQuotesUpgradeConversion6_51 job migrates the New Subscription quote data from the Quote Charge object to the Quote Rate Plan Charge object. You must run the script as a System Administrator.

This migration script will temporarily disable the Store Data in Quote Charge configuration setting while the script is running. You should not enable this setting while the migration script is running.  

  1. Disable any custom triggers or validations in your org.
  2. Open Developer Console.
  3. Navigate to Debug > Open Execute Anonymous Window.
  4. Enter the following Apex code in the Enter Apex Code window:
       zqu.ZuoraQuotesUpgradeConversion6_51 zuc =
          new zqu.ZuoraQuotesUpgradeConversion6_51();
       ID batchprocessid = Database.executeBatch(zuc);
  5. Click Execute.
  6. Navigate to Setup > Administration Setup > Monitoring > Apex Jobs and verify that the above job is running.
  7. Disabled customer triggers or validations can now be re-enabled.

If all of the following conditions apply to a quote, the quote will not be migrated by the script:
1. A product, a rate plan, or a rate plan charge was removed from the Product Catalog in Zuora.
2. The Product Catalog was rebuilt in Zuora CPQ by a Sync Cleanup followed by a fresh Product Catalog Sync from Zuora.
3. The Quote and Quote Charges include the product, the rate plan, or the charge removed in Step #1.

If your current version is 6.50, 6.60, or 7.1.x, you must manually run the migration script in the following scenario:

  • You have not run the migration script introduced in Version 6.51.
  • Your migration script failed with an error. 

Review for Time Zone Support

If you have made any customization in Zuora Quotes, you need to perform the following for the dateTime type fields changes and time zone support in Zuora.

Rev Rec Changes

The Rev Rec Code field on the Product Rate Plan Charge object was changed as below to be compatible with the Rev Rec Code in Zuora:

  • The old Rev Rec Code field (zqu__RevRecCode__c) was deprecated.
  • A new Rev Rec Code field (zqu__RevRecCode2__c) was added as the Picklist type.

If you are using the Rev Rec feature in Zuora and Zuora Quotes, perform a Product Catalog Sync from Zuora to Salesforce to apply the Rev Rec Code field changes.

If you are using Bundling, you need to temporarily disable the Enable Bundling setting in your tenant, perform a Product Catalog Sync, and turn back the setting on after the sync completes. Contact Zuora Global Support to disable and re-enable Bundling.

Update Entity Id

Starting in Zuora Quotes, Version 7.4, the Entity Ids, namely EntityID and ParentEntityID, on the Entity object use the 32-character UUID.

If you are upgrading from a version between 7.2 and 7.32 of Zuora Quotes, remove the records with the old entity Id format as below:

  1. Delete any Billing Entity record with the 4-digit entity id with the following query in Developer Console:
    SELECT Id, zqu__EntityId__c FROM zqu__BillingEntity__c
  2. Perform both the Product Catalog Sync and the Accounts and Related Objects Sync to sync over the new Entity ID values to the corresponding object fields in Zuora for Salesforce.

Review the Scheduled Jobs for Refresh Custom Settings

If you upgrade to Quotes 9.8 or a later version, the Refresh Custom Settings job in the Setup > Jobs > Scheduled Jobs will be deleted. If you still want to start the scheduled job that recurringly refreshes the custom settings, you can set it up manually:

  1. Open Developer Console.
  2. Navigate to Debug > Open Execute Anonymous Window.
  3. Enter the following Apex code in the Enter Apex Code window: zqu.RefreshCustomSettingSchedulable refreshSchedulable = new zqu.RefreshCustomSettingSchedulable();
    System.schedule('Refresh Custom Settings', '0 0 0 * * ?', refreshSchedulable);
  4. Click Execute.
  5. Navigate to Setup > Jobs > Scheduled Jobs and verify that the above job is running.