---
sourceDocument: Brazil Sales Customer Relationship Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/order-management

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Sales Customer Relationship Management

ft:clusterId :

    - omgmt

bundleId :

    - omgmt

workflow :

    - Customer and Industry


---

# The sidebar

# The sidebar {#ariaid-title1}

Release version: Brazil  
Updated March 12, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read
Summarize  
![AI sparkle icon](https://servicenow.com/docs/portal-asset/ai-sparkle-icon) Summarized using AI  
This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.  

## Summary of The sidebar

The sidebar element in ServiceNow CPQ allows you to display persistent information such as visualizations, product details, or alternate shopping carts across multiple tiers in a product configuration.
It is defined within the layout CSV file and appears consistently on the left or right side of the configurator screen.
Note that this feature is not available in the ServiceNow CPQ layout editor and requires CSV file import for setup.
Show full answer Show less  

## Setup and Configuration

* **Placement:** The sidebar must be defined as a child of the entire layout in the CSV file, specifying its location as either left or right using the `location` property.
* **Content Structure:** The sidebar can only contain a `tierdef` object as its child. Adding tiers or columnsets directly under the sidebar invalidates the layout. After defining the tierdef, you can add tiers, columnsets, and fields as usual.
* **Single Instance:** Only one sidebar can exist in a layout. Multiple sidebars are merged into a single tier upon deployment.
* **Pinning Control:** Use the `pinned` property in the sidebar's value JSON to control whether the sidebar is pinned or unpinned by default, and whether the pin button is visible to end users. Options include pinned, unpinned, or default behavior (pin button shown with sidebar pinned).
* **Width Settings:** Customize the sidebar's width with `width`, `minWidth`, and `maxWidth` properties in pixels or viewport width units to control its appearance on the screen.

## Practical Use Cases

* **3D Visualizer:** The sidebar can host 3D visualization tools that reflect real-time changes across configuration tiers, improving user experience and interaction.
* **Product Information:** Display detailed product or quote data, including system or partner fields, throughout the configuration process for better customer insights.
* **Alternate Shopping Cart:** Present a different product list in the sidebar, separate from the default shopping cart. For example, show a manufacturing BOM in the sidebar while displaying sales BOM types in the main shopping cart.

## Key Considerations for ServiceNow Customers

To utilize the sidebar, customers must prepare and import a correctly structured layout CSV file defining the sidebar element and its properties. This approach provides persistent, customizable information display that enhances the configurator interface without relying on the CPQ layout editor. Proper configuration ensures consistent placement, controlled pinning behavior, and tailored width, all contributing to a better end-user configuration experience.  
Use the sidebar element to display persistent information, such as visualizations, product details, or alternate shopping carts, across tiers in a configuration. Define its position and content in the layout CSV
file.
In a layout, the sidebar element can be used to show persistent information to the end user across multiple tiers.


Note:  
This feature is not available in the ServiceNow CPQ layout editor. You must create the sidebar element in the layout CSV and then import the CSV file.

## Setup {#layout_sidebar__section_vbw_ytg_phc}

When setting up the sidebar, define the sidebar element as a child of the entire layout. The following table lists the cells to fill in, with an example of the sidebar section of the CSV file.

* Type: sidebar
* Path: /layout/sidebar
* Value: `{"location":"right"}` or `{"location":"left"}`

{#layout_sidebar__ul_ysd_x2z_chc} {#layout_sidebar__table_wbw_ytg_phc__entry__6}

| type | path | label | variablename | component display type | value |
|-|-|-|-|-|-|
| sidebar | /layout/sidebar |   |   |   | `{"location":"right"}` |
| tierdef | /layout/sidebar/tiers |   |   | BasicContainer |   |
| tier | /layout/sidebar/tiers | Tier | tier |   |   |
[Table 1. Sidebar element]

{#layout_sidebar__table_wbw_ytg_phc}

The location property determines whether the sidebar appears to the user on the left or right of the screen. The sidebar appears in this position during configuration and, unlike the shopping cart,
cannot be placed at the bottom of the configurator or moved during configuration.

The child of the sidebar can only be a tierdef object. If you add a tier or a columnset element as a child, the layout is invalid. After a tierdef is defined in
the CSV, you can then add the necessary tiers, columnsets, and fields as children as in any other tier.

Only one sidebar can exist in a layout. If you add another, both are combined into the same tier upon deployment.

## Control the sidebar pin {#layout_sidebar__section_sidebar_pin}

Add the pinned property to the sidebar value to control whether the pin button appears to the end user and whether the sidebar is pinned or unpinned by default. Set this property in the
`value` cell of the sidebar element in the layout CSV file.
{#layout_sidebar__table_sidebar_pin__entry__2}

| Value | Description |
|-|-|
| `{"pinned":"PINNED"}` | Hides the pin button and renders the sidebar as pinned. |
| `{"pinned":"UNPINNED"}` | Hides the pin button and renders the sidebar as unpinned. |
| `{"pinned":"DEFAULT"}` | Shows the pin button and renders the sidebar as pinned. The sidebar also uses this behavior when you omit the pinned property. |
[Table 2. Values for the pinned property]

{#layout_sidebar__table_sidebar_pin}

## Set the sidebar width {#layout_sidebar__section_sidebar_width}

Add width properties to the sidebar value to define how wide the sidebar component appears to the end user. Specify each width value in pixels (`px`) or viewport width (`vw`) units, and set the
properties in the `value` cell of the sidebar element in the layout CSV file.
{#layout_sidebar__table_sidebar_width__entry__2}

| Property | Description |
|-|-|
| width | Sets the default width of the sidebar component. For example, `{"width":"400px"}`. |
| minWidth | Sets the minimum width of the sidebar component. For example, `{"minWidth":"300px"}`. |
| maxWidth | Sets the maximum width of the sidebar component. For example, `{"maxWidth":"600px"}`. |
[Table 3. Properties for the sidebar width]

{#layout_sidebar__table_sidebar_width}

## Use case: 3D visualizer {#layout_sidebar___3d_visualizer}

The sidebar can host 3D visualization tools used during configuration. Any changes to fields tied to the visualization are visible to end users regardless of the tier they are on. For more information, see [Integrating ServiceNow CPQ with visualization tools](https://servicenow-prod.fluidtopics.net/Pt6Yq5uiScBaZoIYl0agzg "Learn how ServiceNow CPQ connects to third-party visualization engines—CDS, kBridge, and Threekit—to render 2D/3D product views that respond to configuration inputs in real time.").

## Use case: product information {#layout_sidebar__product_information}


The sidebar can display product or quote information --- including system or partner fields --- throughout the configuration process.

[Example CSV file](https://drive.google.com/file/d/1lXUD_rRKlUub7Airg21tvHQfBuH3AYZD/view?usp=sharing)

## Use case: shopping cart {#layout_sidebar__shopping_cart}


To show a product list other than the shopping cart to the end user, you can host it in the sidebar. Use this option to list a separate manufacturing BOM type while showing only sales BOM types in the shopping cart.

[Example CSV](https://drive.google.com/file/d/1uB6SjfiHTjff-cI54zdffaEf6bUzSuNy/view?usp=sharing)

