Skip to main content

Upgrade Zuora Quotes to Q4 2013 (Version 6.0)

Zuora

Upgrade Zuora Quotes to Q4 2013 (Version 6.0)

This document explains how to upgrade to Zuora Quotes Titanium (Q4 '2013) version 6.0 from one of the following Zuora Quotes versions:

  • 5.100 or higher
  • Any version higher than 5.0 but lower than 5.100

If {{zquote}] is not installed on your {{sfdc}} org, follow the standard initial installation.

Determine which version of Zuora Quotes is installed

To upgrade Zuora Quotes, determine the version of Zuora Quotes that you have installed, and then perform the upgrade process if necessary.  

  1. In Salesforce, click user name > Setup
  2. In the left navigation bar, click Installed Packages
  3. Verify the version number for Zuora Quotes
  4. To upgrade, contact Zuora Support to request an installation link, then follow the instructions below.

How to upgrade

The instructions on this page assume that you already have a previous version of Zuora Quotes installed in your Salesforce org and that you have followed these setup procedures.

Install the managed package on Salesforce

Request the Zuora Quotes package installation link from Zuora Support, click the link, and follow the prompts.

See Install the Zuora Quotes Package for detailed steps and then return to the upgrade steps.

Grant record type access to selected user profiles

Upgrade path: Pre-5.100 only

To configure page layouts through the new Layout Configuration Settings page, you must grant record type access to the user profiles of users who can configure the page layouts. 

  1. Navigate to Setup > Administration Setup > Manage Users > Profiles.
  2. Select a profile where you want to add the record type accesses in order to configure the page layouts. 
  3. On the profile details page, go to the Record Type Settings section. If you do not see the section, clear the Enable Enhanced Profile User Interface setting on the User Interface page under Setup > App Setup > Customize.
  4. In the Custom Record Type Settings sub-section, click Edit next to the Quotes object.
  5. Push all record types to the Selected Record Types column. The default record type continues to be Default.
  6. Click Save.
  7. Repeat these steps for all user profiles where you want to grant record type access.

Assign page layouts v6.0 for the Quote object

Upgrade path: All

We have added new page layouts for each record type in Zuora Quotes Q4 '13 release. These page layouts include new field layouts and new buttons.

To assign the new page layouts to user profiles, complete the following steps:

  1. Navigate to Setup > Administration Setup > Manage Users > Profiles.
  2. Click the profile where you want to add the record type accesses in order to configure the page layouts. 
  3. On the Profile page, go to the Page Layouts section, and in the Custom Object Layouts sub-section, click the View Assignment link next to the Quote object.
  4. On the Page Layout Assignment page for Quote, select the user profiles, and click Edit Assignment.
  5. Assign the Quote page layout v6.0 of each record type to all applicable user profiles. 

Update field sets

Upgrade path: 5.100.x only

In the Q2 '13 release (5.100), field sets were introduced and used to render configurable layouts. In the Q4 '13 release (6.0), some field sets were changed.  You must update these field sets.  

  1. Navigate to Setup > App Setup > Create > Objects and select Quote.
  2. Click in the Field Sets section, and locate the field set zqu__Amend_Quote_Subscription_Terms and click Edit.
  3. Drag Special Terms and Notes out of the field set.  This field is now in a separate field set that is rendered in a double-column layout.
  4. Drag Generate Invoice and Invoice Processing Options into the field set. These fields are now supported for Amendment Quotes. Optionally, you can drag other fields, including custom fields into the field set.
  5. Click Save.
  6. Locate field set zqu__Renewal_Quote_Subscription_Terms and click Edit.
  7. Drag Special Terms and Notes out of the field set. This field is now in a separate field set that is rendered in a double-column layout.
  8. Drag Generate Invoice and Invoice Processing Options into the field set.  These fields are now supported for Renewal Quotes. Optionally you can drag other fields, including custom fields into the field set.  
  9. Click Save.

Set default values

Upgrade path: All

Set the Calculate Quote Metrics Through Value

In the Q4 '13 release, we added a new configuration setting Calculate Quote Metrics Through. This setting is used to calculate quote metrics – including Total, Tax, and Discount. Once this value is set, it must always have a value

To set the default value for the Calculate Quote Metrics Through setting, complete the following steps:

  1. Navigate to Zuora Config > Default Value Settings. Click Edit Settings.
  2. In the Quote Default Settings section, set the default values for Calculate Quote Metrics Through as shown:
     Set Default Values
  3. Select either End of Term or specify a number for the Billing Periods for the organization default value.  
  4. Click Save.  
  5. After saving, the Calculate Quote Metrics Through  value is required (that is must always have a value).

Enable the Progress Bar on the Quote Wizard

In the Q4 '13 release, we introduced the Quote Wizard. This wizard has a new progress bar that is displayed on each page in the Quote Wizard.

To enable the progress bar on the Quote Wizard:

  1. Navigate to Zuora Config > Quote Wizard Settings.
  2. Click Edit.
  3. Select the Display Progress Bar check box to enable the progress bar.
  4. Click Save.

Configure the Electronic Payment Method Setting

Upgrade path: Pre-5.100 only

In the Q2 '13 release, we supported electronic payment methods on the quoting flow.

To configure a default Electronic Payment Method Setting: 

  1. Navigate to  Zuora Config  > Quote Configuration Settings.
  2. Click Edit Settings.
  3. In the Payment Method Settings field, select the appropriate setting for your organization. 

Update Layout Configuration Settings

Upgrade path: 5.100.x only

In the Q4 '13 release, we enhanced the layout configuration settings for Amendment and Renewal quotes. You must upgrade to the latest layout if you have customized the layout.  Use these steps to upgrade to the latest amendment and renewal layout – while preserving your own configurations.

To upgrade to the latest layout:

  1. Navigate to Zuora Config > Layout Configuration Settings.
  2. Select the following:
    • Object type: Quote
    • View type: Create
    • Record type: Amendment
  3. If the layout has been customized, a hint This layout has been customized is displayed in the Field Set Configuration section. If you do not see this hint text, skip this section.
  4. Click Restore to Default. This will restore the layout configuration for Amendment Quote Create page to the default configuration of the latest version.  
  5. Push your custom field sets into the right column again, and re-order the field sets as needed.
    Layout Configuration Setting with Confirmation
  6. Repeat these steps for the Renewal Create View and Cancellation Create View

  • For Renewal Create View, select:

    • Object type: Quote

    • View type: Create

    • Record type: Renewal

  • For Cancellation Create View, select:

    • Object type: Quote

    • View type: Create

    • Record type: Cancellation

Rename the Quote application label

Upgrade path: All

In the Q4 '13 release, we rebranded the product as Zuora Quotes.

To update the application labels:

  1. Navigate to Setup > App Setup > Create > Apps.  
  2. Click Edit next to the Zuora Quotes app.
  3. In App Label, enter Zuora Quotes.
  4. Pre-5.100 Only: Remove Quote Templates from the Selected Tabs column and move it back to Available Tabs column. The Quote Templates tab is now deprecated.  Quote Templates configuration is now through Zuora Config > Quote Template Settings
Grant Access to New Apex Classes and Visualforce Pages to User Profiles

Upgrade path: All

To add access to new Apex classes and Visualforce pages to user profiles:

  1. Navigate to Setup > Administration Setup > Manage Users > Profiles
  2. Select a profile where you want to add the record type accesses in order to configure the page layouts. 
  3. On the resulting Profile page, go to the Enabled Apex Class section, and click Edit.
  4. Move all Apex classes with the 'zqu.' namespace prefix from the Available Apex Classes column to the Enabled Apex Classes column and click Save.
  5. On the Profile page, go to the Enabled Visualforce Page Access section and click Edit.
  6. Move all Visualforce pages with the "zqu__" namespace prefix from the Available Visualforce Pages column to  the Enabled Visualforce Pages column. 
  7. Click Save.

Set object-level and field-level permissions for new objects

Upgrade path: All

Starting in the Q4 '13 release, Zuora Quotes includes the following new objects: 

  • Field Set Config
  • Hosted Page Settings
  • Quote Charge Tiers
  • Quote Wizard Step
  • Unit of Measure

To grant object-level security on the new objects: 

  1. Navigate to Setup > Administration Setup > Manage Users > Profiles.
  2. Select a user profile to whom you need to grant object-level accesses on the new custom objects, Field Set Config, Hosted Page Settings, Quote Charge Tiers, Quote Wizard Step, and Unit of Measure. Refer to the table below to see which profiles need to have an access to the new custom objects.
  3. On the Profile page of the user you selected, click Edit.
  4. On the Profile Edit page, go to the Custom Object Permissions section.
  5. Select appropriate permission check boxes next to the new objects to grant the required object-level access to the user. See the table below to see which user needs which permission.
  6. Click Save.
  7. Repeat steps #1 to #6 for each user profile listed in the table below.
Object Description User Profile and Permissions

Field Set Config

Hosted Page Settings

Quote Wizard Step

These objects are used for quote configurations.
  • The profile who will change related configurations need to have the full access to these objects.
  • Other profiles need to have, at least, the "Read" access.

 

Quote Charge Tiers This object is used for the customizable tiers feature.  Every user profile who will customize tiers need to have the full access to this object. 
Unit of Measure The records of this object are synced from Zuora. 
  • The user profile who do sync must have the full access to this object.
  • Other user profiles need to have at least the "Read" access for the product selector to work correctly.

To grant field-level security on the new objects: 

  1. Navigate to Setup > Administration Setup > Manage Users > Profiles.
  2. Select a user profile to whom you need to grant field-level accesses on the new custom objects.
  3. On the Profile page of the user you selected, go to the Field-Level Security section.
  4. In the Custom Field-level Security  sub-section, click View next to the above custom object, e.g. Field Set Config, and click Edit.
  5. Grant the required field-level access for this object to the user profile and click Save.
  6. Repeat the steps #4 and #5 for each new custom object, Field Set Config, Hosted Page Settings, Quote Charge Tiers, Quote Wizard Step, and Unit of Measure.
  7. Repeat the steps #1 to #6 for each user profile listed in the table above.

Set field-level security for new fields on the Quote object

Upgrade path: All

To grant field-level security to the new fields added on the Quote object: 

  1. Navigate to Setup > Administration Setup > Manage Users > Profiles.
  2. Select a profile where you want to add the record type accesses in order to configure the page layouts. 
  3. On user profile properties page, go to the Field-level Security section.
  4. In the Custom Field-level Security sub-section, click View next to the Quote object.
  5. On the Quote Field-level Security page, click Edit.  Grant the required field-level security for the following newly added fields:
    • For Pre-5.100 Only:
      • Cancellation Date
      • Cancellation Effective Date
      • Electronic Payment Method Id
      • Quote Template
      • Zuora Parent Billing Account ID
      • Zuora Parent Billing Account Name
    • For All upgrade paths:
      • Calculate Quote Metrics Through
      • Delta MRR
      • Delta TCV
      • Discount
      • Is Charge Expired
      • MRR
      • Sub-Total
      • Tax
      • TCV
      • Total
  6. Click Save.
  7. In the Custom Field-level Security sub-section, click View next to the Quote Charge Tier object.
  8. On the Quote Charge Tier Field-level Security page, click Edit. Grant the required field-level security for the following new fields:
    • Currency
    • Deleted
    • Discount
    • Effective Price
    • EndingUnit
    • IsOveragePrice
    • Price
    • Price Format
    • ProductRatePlanChargeId
    • Quote Charge
    • Quote Rate Charge
    • Rate Plan Charge
    • StartingUnit
    • Tier
    • ZuoraId
  9. In the Custom Field-level Security sub-section, click View next to the Quote Wizard Step object. 
  10. On the Quote Wizard Step Field-level Security page, click Edit.  Grant the required field-level security for the following field:
    • Subscription Type
  11. In the Custom Field-level Security sub-section, click View next to the Unit of Measure object. 
  12. On the Unit of Measure Field-level Security page, click Edit. Grant the required field-level security for the following fields:
    • Active
    • Decimal Places
    • Rounding Mode
  13. Repeat these steps for all user profiles as required. 

Sync unit of measure (UOM) objects from Zuora

Upgrade path: All

In the Q4 '13 release, we added support for non-integer quantities. You must synchronize Unit of Measure objects from Zuora before you can start using the new product selector page.  

To sync UOM objects from Zuora:

  1. Login to your Zuora tenant.
  2. Navigate to Zuora CPQ > Data Synchronization and Select Product Catalog.
  3. Click Sync.
  4. Refresh the Sync History until the Product Catalog sync has completed.

Set up the lookup field set

Upgrade path: Required only if you have Zuora CPQ version earlier than 2.61 installed

Check your current version of Zuora 360 in Salesforce by navigating to user name > Setup > Installed Packages.

Zuora recommends upgrading to Zuora 360 version 2.70 to use with Zuora Quotes version 6.0 (Q4 '13 release). See Configure Zuora 360 or Upgrade Zuora 360.

If you are not using Zuora 360 or prefer not to upgrade to version 2.70, then follow the steps below to add the necessary field sets for the lookup configurations, and assign these field sets to the lookup layouts. 

  1. Navigate to Setup > App Set > Create > Objects.
  2. Select the Billing Account object associated with the Zuora 360 Managed Package.
  3. In the Field Set section, click New to create a new custom field set.  
  4. Enter the following information on the New Field Set page, and click Save:
    • Field Set Label: MyBillingAccountSet
    • Field Set Name: MyBillingAccountSet
    • Where used: Billing Account Lookup in Zuora Quotes
  5. Drag the following fields to the In the Field Set section, and click Save:
    • Billing Account Name
    • Account
    • Currency
    • Parent 
  6. Navigate to Zuora Config > Layout Configuration Settings.
  7. Select the following values.
    • View Type: Lookup
    • Record Type: Master
  8. Select MyBillingAccountSet and click SaveMyBillingAccountSet is shown as an available field set in the Field Sets dropdown list

Update Zuora connection URL

Upgrade path: All

Update your Zuora Connection URL to map the API version required to use the new features.

  1. Navigate to Zuora Config > Zuora Connection Settings.
  2. Update the URL to point to latest supported WSDL version. For example:
    https://apisandbox-zforsf.zuora.com/...ervices/a/52.0
  3. Click Save.

This completes the upgrade to Zuora CPQ Q4 2013.