Layout editor
Learn how to use the layout editor to modify a layout without leaving CPQ.
The layout editor enables an admin to edit an layout without leaving CPQ.
- The layout variable name appears in parenthesis in the header. The layout name and description can be edited by clicking the pencil icon.
- Three actions are available: Replace, Export, and Save.
- Replace: Launches the file picker to select a CSV file to replace the current layout.
- Export: Exports and downloads a CSV file of the current layout
- Save: Save changes to the layout. This button will be disabled if no changes have been made to the layout.
- The layout editor provides three tabs for editing different aspects of the layout: Arrange Layout, Edit Field Info, and tier definition.
The Arrange Layout tab
The Arrange Layout tab provides a similar experience to the Layout Wizard. It lets you adjust various depths but does not allow for a change in the overall tier format.
- Tier labels can be edited inline by clicking the pencil icon that appears on hover.
- Extended properties of the element can be edited by clicking the gear icon, which will launch a window to update the values.
- The field label can be edited by clicking the pencil icon, and extended properties of the field can be edited by clicking the gear icon. Fields can also be edited in the Edit Field Info tab.
- Clicking the plus icon in a column set lets you search for fields to add to the column set.
- Additional column sets can be added to the layout by clicking the plus icon in the tier you want to add to.
- Tiers can be added to the layout by clicking the plus icon outside of the existing tiers.
Keyboard shortcuts
Mac:
PC:
Missing fields
If a layout contains fields that are no longer available appear slightly grayed out, with a dashed border.
Partially supported elements
Layout elements that are only partially supported appear with a darker gray background. Some properties can still be edited by clicking the gear icon.
Field information such as label, display type, and extended properties can be edited in the layout editor.
- Search and filter fields associated with the layout.
- The field label can be edited inline by clicking the label to edit.
- The field display type can be updated from a list of available options for the field type by clicking the display type value for the field you are updating.
- Extended properties of the field can be edited by clicking the gear icon and making the edits in a dialog box.
Edit extended field properties
- Class Name: Classes can be added to fields and searched for in the search bar. Classes appear as a pill once added. Classes that control the width and height of the field or align the field to a grid layout have built-in support.
- Raw Value: The value can also be edited directly, in the format of key:value pairs. This corresponds to the value column in the layout.csv file.
- Cancel and Save
- Number fields also have three values: Precision, Symbol, and Unit.
- Precision: Controls the decimal precision of the number field
- Symbol: Displays to the left of the number field
- Unit: Displays to the right of the number field
Tier definition
The overall structure of the layout tiers can be updated in the tier definition tab. This is similar to selecting the initial tier definition when using the Layout Wizard.
- Tier definition preview: Shows a simplified preview of the currently selected tier definition
- Tier definition menu: Provides a list of available tier definitions to select from
When you have made all the changes to the layout, don’t forget to save it, using the Save button in the header.
Additional considerations
Layouts that were uploaded by using API calls cannot be edited in the layout editor. A message will appear that lets you import a CSV file to replace the layout.
Modifications that cannot be made by using the layout editor can be made by exporting, adjusting, and importing layout CSV files.
The order of rows is not maintained as the layout editor parses the values.