Workbook templates

An Excel report template (.xlsx) exports header, line items, and configuration data from an order, quote, or agreement under negotiation into a structured spreadsheet. You can work offline in Excel. Then you can upload the edited workbook back to CPQ to apply your changes automatically.

An Excel export is useful when:

You need a data extract for analysis, sharing, or downstream processing
You want a simple, governed round‑trip (download > edit > upload) for specific fields
You prefer Excel formulas or filters to review or validate large quotes

To add and configure an Excel report template in CPQ:

Prerequisites

To configure Excel report templates, verify that you have the ADMIN PERMISSION. For details on assigning permissions, read Role management.

Upload an Excel report template

To enable report generation, upload an Excel (.xlsx) report template to CPQ.

From the application left navigation area, select Administration.
From the top navigation bar, select Content Management, then select excels.
Select , then select a .xlsx file to upload.

Register an Excel report template

After uploading the template file, register it in CPQ as an Excel report template.

From the application left navigation area, select Administration.
From the top navigation bar, select Master Data Management.
Move through or search to locate Workbook Template and select it from the list.
Select , then select the newly added row.
On the Configuration tab, enter information to define the template:
- Name—Enter the template name. Must match the name of the Excel template file that you uploaded into CPQ. For example, if the template file name is Quote.xlsx, you must enter Quote in this field.
- Primary Object—Select the object in which the template will be available for downloading, such as quotes or agreements.
  Note
  For agreements, select Quote.
- Turn on or off the Exclude loading all product data during workbook download switch. For details, read Exclude product metadata from workbook downloads.
Select Save.

Assign an Excel report template to a user role

Excel report templates are not automatically visible to users. To assign them to specific roles:

From the application left navigation area, select Administration.
From the top navigation bar, select Role Management, then select a role.
On the Access Management tab, select Workbook Template.
In the Workbook Template dialog, select Excel workbook templates.
Select Update.
Select Save.
Sign out of CPQ and then sign back in for the change to take effect.

Set default Excel report templates for individual users

To define a default Excel report template for each specific user:

From the application left navigation area, select Administration.
From the top navigation bar, select User Management.
On the Users tab, select a user.
In the Report Templates section, in the Excel Templates field, select a default Excel template.
Select Save.

Configure name format for Excel reports

Note
If you use both agreements management and quoting capabilities in Zilliant CPQ, the defined name format applies to reports in both agreements and quotes.

Configure the name of reports that users generate based on your templates to include important information, such as a quote or agreement ID, title, or template name.

To configure the name format for Excel reports:

From the application left navigation area, select Administration.
From the top navigation bar, select Master Data Management.
Move through or search to locate Setting String and select it from the list.
Select The format for quote excel report title. Valid parameters: {QUOTE_ID}, {QUOTE_TITLE}, {VERSION}, {TEMPLATE_NAME}.
In the Setting Value String field, use the following parameters to define the report name format:
- {QUOTE_ID}
- {QUOTE_TITLE}
- {VERSION}
- {TEMPLATE_NAME}
Select Save.

Exclude product metadata from workbook downloads

Use the Exclude loading all product data during workbook download setting to control whether product metadata is included when users download an Excel workbook template:

When this setting is enabled, Zilliant CPQ excludes product metadata from the workbook template. This can significantly reduce download time. However, any Excel-based validations that depend on product metadata are not available in the downloaded workbook.
When this setting is disabled, all product metadata is included and Excel validations continue to work as expected.

To configure the setting:

From the application left navigation area, select Administration.
From the top navigation bar, select Master Data Management.
Move through or search to locate Workbook Template and select it from the list.
Select a workbook template or create a template.
On the Configuration tab, set the Exclude loading all product data during workbook download switch to YES to enable the setting or NO to disable it.
Select Save.

Add a Groovy script for Excel workbook templates

You can integrate custom data from lookup tables or any external sources into Excel reports using a Groovy script:

From the application left navigation area, select Administration.
From Master Data Management, select Groovy Script.
Select Additional Data for Workbook Template Generation.
In the Script file, upload the Groovy script into the system.
In the Lookup Tables field, enter the names of relevant lookup tables.
Select Save.

Download an Excel report

From a quote or an agreement:

Open a quote or open an agreement.
From the button bar, select Reports > Download Excel Template.
In the Download templates dialog, select the template name.
From the Quote Language dropdown, select the language for the template.
(Optional.) To save the template on the Attachments tab in the quote, set the Save Workbook As Attachment switch to YES.
Select Next, then select the quote or agreement items from the list.
Select Download.

From an order:

From the left navigation area, select Orders.
Select an order
On the Overview tab, select Download > as Excel.
Select a template, then select Download.