---
title: "Workbook templates"
slug: "excel-report-templates"
description: "Learn how to work with Excel report templates in Zilliant CPQ."
updated: 2026-07-22T14:13:47Z
published: 2026-07-31T10:00:05Z
canonical: "docs.zilliant.com/excel-report-templates"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zilliant.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Excel report 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:

1. [Complete the prerequisites.](/main/docs/excel-report-templates#prerequisites)
2. [Upload an Excel report template.](/main/docs/excel-report-templates#upload-a-proposal-report-template)
3. [Register an Excel report template.](/main/docs/excel-report-templates#register-a-proposal-report-template)
4. [Assign an Excel report template to a user role.](/main/docs/excel-report-templates#assign-excel-workbook-templates-to-a-user-role)
5. (Optional.) Configure additional settings:
  - [Set default Excel report templates for individual users](/main/docs/excel-report-templates#set-default-excel-report-templates-for-individual-users)
  - [Configure name format for Excel reports](/main/docs/excel-report-templates#configure-name-format-for-excel-reports)
  - [Exclude product metadata from workbook downloads](/main/docs/excel-report-templates#exclude-product-metadata-from-workbook-dow)
  - [Add a Groovy script for Excel workbook templates](/main/docs/excel-report-templates#add-a-groovy-script-for-excel-workbook-templates)
6. [Download an Excel report.](/main/docs/excel-report-templates#download-excel-report)

---

## Prerequisites

To configure Excel report templates, verify that you have the ADMIN PERMISSION. For details on assigning permissions, read [Role management](/v1/docs/role-management#define-permissions-for-a-role).

---

## Upload an Excel report template

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

1. From the application left navigation area:
  - In the classic view, select **Administration**.
  - In the new UI, select **Settings** > **Administration**.
2. From the top navigation bar, select **Content Management**, then select **excels**.
3. Select ![](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/CPQ-icon_Upload-file%281%29.png?sv=2026-02-06&spr=https&st=2026-10-29T03%3A59%3A30Z&se=2026-10-29T04%3A59%3A30Z&sr=c&sp=r&sig=5Kn%2BEwIygERh8OeUsg7IcZa3Jy6TaL4Tr1HubyhkJac%3D), 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.

1. From the application left navigation area:
  - In the classic view, select **Administration**.
  - In the new UI, select **Settings** > **Administration**.
2. From the top navigation bar, select **Master Data Management**.
3. Move through or search to locate **Workbook Template** and select it from the list.
4. Select ![](https://cdn.document360.io/24f960e8-3c1c-4c18-a2c6-83b6ae4aab84/Images/Documentation/CPQ-icon_add.png?sv=2026-02-06&spr=https&st=2026-10-29T03%3A59%3A30Z&se=2026-10-29T04%3A59%3A30Z&sr=c&sp=r&sig=5Kn%2BEwIygERh8OeUsg7IcZa3Jy6TaL4Tr1HubyhkJac%3D), then select the newly added row.
5. 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](/main/docs/excel-report-templates#upload-a-proposal-report-template). 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.

> [!WARNING]
> 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](/main/docs/excel-report-templates#exclude-product-metadata-from-workbook-dow).
6. 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:

1. From the application left navigation area:
  - In the classic view, select **Administration**.
  - In the new UI, select **Settings** > **Administration**.
2. From the top navigation bar, select **Role Management**, then select a role.
3. On the **Access Management** tab, select **Workbook Template**.
4. In the **Workbook Template** dialog, select Excel workbook templates.
5. Select **Update**.
6. Select **Save**.
7. 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:

1. From the application left navigation area:
  - In the classic view, select **Administration**.
  - In the new UI, select **Settings** > **Administration**.
2. From the top navigation bar, select **User Management**.
3. On the **Users** tab, select a user.
4. In the **Report Templates** section, in the **Excel Templates** field, select a default Excel template.
5. Select **Save**.

---

## Configure name format for Excel reports

> [!WARNING]
> Note
> 
> If you use both [agreements management](/main/docs/agreements) and [quoting](/main/docs/manage-quotes) 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:

1. From the application left navigation area:
  - In the classic view, select **Administration**.
  - In the new UI, select **Settings** > **Administration**.
2. From the top navigation bar, select **Master Data Management**.
3. Move through or search to locate **Setting String** and select it from the list.
4. Select **The format for quote excel report title. Valid parameters: {QUOTE_ID}, {QUOTE_TITLE}, {VERSION}, {TEMPLATE_NAME}**.
5. In the **Setting Value String** field, use the following parameters to define the report name format:
  - {QUOTE_ID}
  - {QUOTE_TITLE}
  - {VERSION}
  - {TEMPLATE_NAME}
6. 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:

1. From the application left navigation area:
  - In the classic view, select **Administration**.
  - In the new UI, select **Settings** > **Administration**.
2. From the top navigation bar, select **Master Data Management**.
3. Move through or search to locate **Workbook Template** and select it from the list.
4. Select a workbook template or [create a template](/main/docs/excel-report-templates#register-a-proposal-report-template).
5. 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.
6. 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:

1. From the application left navigation area:
  - In the classic view, select **Administration**.
  - In the new UI, select **Settings** > **Administration**.
2. From **Master Data Management**, select **Groovy Script**.
3. Select **Additional Data for Workbook Template Generation**.
4. In the **Script** file, upload the Groovy script into the system.
5. In the **Lookup Tables** field, enter the names of relevant lookup tables.
6. Select **Save**.

---

## Download an Excel report

#### From a quote or an agreement:

1. [Open a quote](/main/docs/manage-quotes#open-quotes) or [open an agreement](/main/docs/manage-agreements-under-negotiation#access-agreements-under-negotiation).
2. From the button bar, select **Reports > Download Excel Template**.
3. In the **Download templates** dialog, select the template name.
4. From the **Quote Language** dropdown, select the language for the template.
5. (Optional.) To save the template on the **Attachments** tab in the quote, set the **Save Workbook As Attachment** switch to **YES**.
6. Select **Next**, then select the quote or agreement items from the list.
7. Select **Download**.

#### From an order:

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