Extend the application schema through UI

You can customize your CPQ workspace by extending the application schema (data model) with custom attributes and adding them as fields or columns to key business objects like Quote or Agreement. This helps you track information important to your workflows and business processes.

The CPQ schema contains:

• Standard attributes that are already available in the application schema. You can’t edit or delete them, but you can add them as fields to the UI.

• Custom attributes that you define in the schema yourself. Then you can add them as fields to the UI.

Attributes are of two types, which define how the related fields behave in the UI:

• Business Data Attribute (BDA)—Creates fields where users manually enter independent values, such as a custom delivery note or internal reference number.

• Business Relation Attribute (BRA)—Creates dropdown fields with predefined selectable values. BRAs are linked to lightweight objects (lists of values) that populate the field’s dropdown list. For example, you can use a BRA to capture a delivery cadence with options like Weekly, Monthly, or Yearly.

To extend the application schema and add custom fields to objects in the new UI, follow these steps:

1. Complete the prerequisites.

2. Add a custom attribute.

3. (Optional.) Add an attribute as a field to the UI.

Note

We are gradually rolling out the new UI in CPQ. To verify which objects support the new UI, read the release updates.

Prerequisites

To access and extend the application schema, verify that you have the SCHEMA EXTENSIBILITY PERMISSION. For details on assigning permissions, read Role management.

Add a custom attribute

To add a custom attribute capturing business-specific data:

1. From the application left navigation area, select Schema Extensibility.

2. From the top navigation bar, select the object where you want to add the attribute.

   Note

   • To add an attribute for agreements under negotiation, select the Quote object.

   • To add an attribute for published agreements, select the Agreement object.

3. Select an option to proceed:

   • To add a custom attribute to the header level, on the leftmost panel, select + Add Custom Attribute.

   • To add a custom attribute to the child level, such as line items, on the leftmost panel, locate the related parent attribute and select Next. Then select + Add Custom Attribute.

4. On the New Custom Attribute panel, enter information or make selections to define the attribute:

   1. Name—Enter a name for the attribute.

   2. Attribute Type—Select a type:

      • Business Data Attribute

      • Business Relation Attribute

   3. Data Type—(Available for business data attributes.) Select the field data type, such as integer or string.

   4. Range—(Available for business relation attributes.) Select an attribute source—a lightweight object that stores values users can select from the field’s dropdown list. To create this object, read Define a business relation attribute source.

   5. Decimal Places—(Optional, available for numeric attributes.) Enter the number of digits to show after the decimal point.

   6. Precision—(Optional, available for numeric attributes.) Enter the total number of digits in a number.

   7. Rounding Mode—(Optional, available for numeric attributes.) Select how to round the number when it can’t be stored exactly.

   8. Default Value—(Optional.) Select or enter a default value for the field.

   9. Groovy Script on Update—(Optional.) Select a Groovy script to run when users update the field value. For example, you can run a script that triggers a validation or sends a notification. For details on Groovy scripts, read About Groovy.

   10. (Optional.) Turn on the following switches to control the field properties: Mandatory, Hidden, and Read-Only.

5. Select Add.

Define a business relation attribute source

To add a field with predefined selectable values (a business relation attribute), create an attribute source. An attribute source is a lightweight object that stores values users can select from the dropdown list of a field related to your BRA.

To define a custom lightweight object:

1. From the application left navigation area, select Administration.

2. From the top navigation bar, select Master Data Management.

3. Select .

4. In the Create New Custom Business Type dialog, enter information to define a field type:

   • Name—Enter a system name for the object.

   • Label—Enter a display name for the object to display in the UI.

5. Select Create.

6. Define object values that will appear in the field dropdown list. Follow these steps for each object value you want to add:

   1. On the Master Data Management tab, select the object.

   2. Select , then select the newly added row.

   3. On the Configuration tab, enter information to define the object value:

      • Name—Enter a value name.

      • External Id—(Optional.) Enter the ID of the value.

      • ERP Id—(Optional.) Enter the ERP ID of the value.

   4. Select Save.

   5. (Optional.) On the Localisation tab, in the Label field next to the needed languages, enter a translation of the value name. Then select to save the changes.

Add an attribute as a field to the UI

To add an attribute as a field to the UI, read Add fields and columns to the UI.