Add fields to objects in the new UI

You can customize your CPQ workspace by adding custom fields to objects, such as quotes or products. Adding custom fields helps you track information important for your company, making your workflow more efficient.

Custom fields can store user-entered values (business data attributes) or reference existing objects (business relational attributes).

In the new UI, you can add custom fields at all object levels:

• List level (such as the list of agreements or quotes)

• Line items level (such as the Line Items tab in agreements)

• Header level (such as the Overview tab in agreements and quotes)

Prerequisites

You must enable the new UI and have the UI EXTENSIBILITY PERMISSION to add fields or columns to objects. For details on assigning permissions, read Role management.

Note

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

Add fields to the list level of an object

1. From the application left navigation area, select an object (such as Agreement or Quotes).

2. In the lower-right corner of the table, select Manage Columns.

3. In the lower-left corner of the new dialog, select Customize > Customize Table.

4. Above the list of columns, select + Add Column > Custom Column.

5. Define a custom column.

The following image shows how to perform the steps for agreements:

Add fields to the line items level of an object

1. From the application left navigation area, select an object (such as Agreement or Quotes).

2. Select an option from the list, then go to the tab with the line items table.

3. In the lower-right corner of the table, select Manage Columns.

4. In the lower-left corner of the new dialog, select Customize > Customize Table.

5. Above the list of columns, select + Add Column > Custom Column.

6. Define a custom column.

The following image shows how to perform the steps for agreements:

Add fields to the header level of an object

1. From the application left navigation area, select an object (such as Agreement or Quotes).

2. Select an option from the list, then go to the detailed information tab, such as the Overview tab in agreements and quotes.

3. In the upper-right corner of any field section, select .

4. In the new dialog, on the row of the section to which you want to add a field, select .

5. In the upper-right corner, select + Add > Custom Field.

6. Define a custom field.

The following image shows how to perform the steps for agreements:

Define a custom filed or column

1. On the Attributes tab, enter information or make selections to add a field or column:

   1. Name—Enter a display name for the field or column.

   2. Attribute Type—Select a value:

      • Business Data Attribute—Select to add a field or column that stores independent data. Users will manually enter the field value.

      • Business Relational Attribute—Select to link your field or column to a custom object with predefined values. Users will select a predefined field value from the dropdown list. To create a custom object, read Define a custom object.

   3. Type—Select a field or column type based on the selected attribute.

      • If you selected Business Data Attribute, select a standard field or column data type like String or Boolean.

      • If you selected Business Relational Attribute, select your custom object.

   4. (Optional.) Turn on the following switches to control the field or column properties: Mandatory, Hidden, Read Only, Enumerable, and Link.

   5. Groovy Script on Update—(Optional.) Select a Groovy script to run when users update the field or column value. For details on Groovy scripts, read About Groovy.

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

2. (Optional.) On the Localization tab, enter a translation of the field or column name.

   1. Select + Select Language, then select a language.

   2. In the Label field, enter a translation of the field or column name.

   3. (Optional.) In the Comment field, enter a comment for the translation.

3. In the upper-right corner, select Save.

4. (Optional.) Drag and drop your field or column in the desired position.

5. (Optional.) On the field row, turn on the Disable and Visibility switches to control the field or column behavior.

6. In the upper-right corner, select Publish.

Define a custom object

Note

Define a custom object only if you want to add a field with predefined values (business relational attribute). These values appear as options in the field dropdown list.

To define a custom 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 a 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 an object value:

      • Name—Enter an object value.

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

      • ERP Id—(Optional.) 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.