Skip to main content

Customize field sets for CPQ X

Zuora

Customize field sets for CPQ X

CPQ X provides a set of standard field sets for the Quote and Quote Rate Plan Charge objects. These field sets correspond to different sections on the Quote Studio page, while the fields are displayed as different settings or display fields. If you want to add more settings to the Quote Studio page, you can add new custom fields to the corresponding field set.

Note: The steps in this article are documented based on the Salesforce Lightning Experience.

Prerequisites

Before adding custom fields to a specific section on the Quote Studio page, you must ensure that the custom fields you want to add have been created. See Create a custom field from Salesforce for step-by-step instructions about how to create a new custom field.

Customize fields in Quote Studio

To add a custom field to the Quote Studio page:

  1. Click Setup icon and select Setup. The Setup homepage opens.
  2. Click the Object Manager tab. 
  3. Find the Quote (zqu__Quote__c), Quote Rate Plan Charge (zqu__QuoteRatePlanCharge__c), or Quote Amendment (zqu__QuoteAmendment__c) object, and click the object label. See Field set reference for a list of field sets specific to CPQ X.
  4. Click Field Sets in the left navigation menu.
  5. Find the field set to which you want to add fields, and click the field set name. For example, if you want to add a new column to the table of the selected rate plan charges, you must add the intended field to the Charge Display Metrics (zqu__CPQX_Charge_Display_Fields) field set. 
    Add custom fields example
  6. Drag and drop the field you want to add from the box at the top to the In the Field Set box.
  7. (Optional) Set required fields as needed, or drag the fields up and down in the In the Field Set box to adjust the display order. For
  8. Click Save. The new custom field is then added to the selected field set, which will be reflected in the corresponding section on the Quote Studio page.

Configure required fields in Quote Studio

CPQ X allows you to configure fields as required fields in the corresponding field sets. If a field is configured as a required field, Quote Studio displays an asterisk (*) next to its field label for highlighting, and provides validation on this field. Users cannot save or submit the quote until all required fields on the Quote Studio page are specified.

Take the following steps to set a field as required:

  1. Navigate to the target field set of one of the following objects. See Field set reference for a list of field sets specific to CPQ X.
    • Quote (zqu__Quote__c)
    • Quote Rate Plan Charge (zqu__QuoteRatePlanCharge__c)
    • Quote Amendment (zqu__QuoteAmendment__c)  
  2. In the In the Field Set box, hove over the field you want to set as a required field and click icon_configure_field.
  3. Select the Required check box for the selected field, then click OK.
  4. Click Save. The new custom field is then added to the selected field set, which will be reflected in the corresponding section on the Quote Studio page.

Field set reference

This section provides reference for the inclusion relationships between standard field sets and their contained fields or field sets in Quote Studio.

Standard fields 

The following table lists the newly introduced field sets and fields for CPQ X:

Object
(API Name)
Standard field set
(API Name)
Contained predefined fields

Quote
(zqu__Quote__c)

Billing 

(zqu__CPQX_Subscription_Billing)

  • Account
  • Bill To Contact
  • Sold To Contact
  • Bill Cycle Date
  • Currency
  • Billing Batch

Overview

(zqu__CPQX_Subscription_Overview)

  • Subscription Term Type

Quote Information

(zqu__CPQX_Quote_Information)

  • Quote Name
  • Account
  • Opportunity
  • Valid Until
  • Start Date
  • Primary

Quote Summary

(zqu__CPQX_Quote_Summary)

  • Account
  • Opportunity
  • Valid Until
  • Start Date

Subscription Summary

(zqu__CPQX_Subscription_Summary)

  • Initial Term
  • Initial Term Period Type
  • Term Start Date

Terms And Conditions

(zqu__CPQX_Subscription_Terms_And_Conditions)

  • Initial Term
  • Auto Renew
  • Renewal Settings
  • Renewal Term
  • Invoice Separately
  • Term Start Date

Quote Rate Plan Charge
(zqu__QuoteRatePlanCharge__c)

Charge Display Metrics

(zqu__CPQX_Charge_Display_Fields)

  • Quantity
  • List Price
  • Discount
  • Effective Price

Charge Display Metrics

(zqu__CPQX_Charge_Display_Metrics)

  • Quantity
  • List Price
  • Discount
  • Effective Price

Quote Amendment

(zqu__QuoteAmendment__c)

Trigger Dates

(zqu__CPQX_OrderAction_Details_TriggerDates)

  • Contract Effective Date
  • Service Activation Date
  • Customer Acceptance Date

Create Mid-Interval Update Required Fields

(zqu__CPQX_OrderAction_Create_DisplayFields)

  • Contract Effective Date

Custom fields 

In addition to the standard fields, you can also add custom fields to be displayed as Addition Fields in multiple display sections in Quote Studio. The following table shows the field sets displayed as sections on the Quote Studio page and their corresponding child field sets for custom fields.

Object
(API Name)
Standard field set
(API Name)
Child field set for custom fields
(API Name)

Quote
(zqu__Quote__c)

Billing 

(zqu__CPQX_Subscription_Billing)

Additional Fields

(zqu__CPQX_Quote_Information_CustomFields)

Overview

(zqu__CPQX_Subscription_Overview)

Additional Fields

(zqu__CPQX_Subscription_Overview_CustomFields)

Quote Information

(zqu__CPQX_Quote_Information)

Additional Fields

(zqu__CPQX_Quote_Information_CustomFields)

Terms And Conditions

(zqu__CPQX_Subscription_Terms_And_Conditions)

Additional Fields

(zqu__CPQX_Subscription_TAndC_CustomFields)

Quote Amendment

(zqu__QuoteAmendment__c)

Create Mid-Interval Update Required Fields

(zqu__CPQX_OrderAction_Create_DisplayFields)

Additional Fields

(zqu__CPQX_OrderAction_Details_CustomFields)