Add and configure proposal report templates

Prev Next

Proposal report templates define the layout and structure of generated proposals in Zilliant CPQ. Administrators upload, register, and assign these templates so users can generate consistent, branded proposals for quotes and agreements.

To add and configure a proposal report template in CPQ, follow these steps:

  1. Complete the prerequisites.

  2. Upload a proposal report template.

  3. Register a proposal report template.

  4. Assign proposal report templates to user roles.

  5. (Optional.) Replace a proposal report template.

  6. (Optional.) Set default templates for individual users.

  7. (Optional.) Configure name format for proposals.

  8. (Optional.) Enable a plain text editor on the Proposal tab.

Tip

To learn how to create a proposal in quotes and agreements, read:


Prerequisites

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


Upload a proposal report template

To enable proposal generation, upload a PDF (.jrxml) or Excel (.xlsx) proposal template to CPQ.

Upload a PDF proposal template

  1. From the application left navigation area, select Administration.

  2. From the top navigation bar, select Content Management, then select jasperreports.

  3. Select , then select a .jrxml file to upload.

Upload an Excel proposal template

  1. From the application left navigation area, select Administration.

  2. From the top navigation bar, select Content Management, then select excels.

  3. Select , then select a .xlsx file to upload.


Register a proposal report template

After uploading the template file, register it in CPQ as a proposal report template.

Register a PDF proposal template

  1. From the application left navigation area, select Administration.

  2. From the top navigation bar, select Master Data Management.

  3. Move through or search to locate Report Template and select it from the list.

  4. Select , then select the newly added row.

  5. On the Configuration tab, enter information to define the template:

    • Name—Enter the template name. It must match the name of the Jaspersoft template file that you uploaded into CPQ. For example, if the template file name is Quote.jrxml, you must enter Quote in this field.

    • Primary Object—Select the associated object.

      Note

      For agreements, select Quotes.

    • Default in CPQ—Set to YES to make the template a default option in CPQ.

    • Default in commerce—Set to YES to make the template a default option in eCommerce.

    • Sub Report Template—Add subreport templates, if configured. For more information, read Additional report and subreport templates.

  6. Select Save.

Register an Excel proposal template

  1. From the application left navigation area, select Administration.

  2. From the top navigation bar, select Master Data Management.

  3. Move through or search to locate Excel Report Template and select it from the list.

  4. Select , 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 Jaspersoft template file that you uploaded into CPQ. For example, if the template file name is Quote.xlsx, you must enter Quote in this field.

    • Default in CPQ—Set to YES to make the template a default option in CPQ.

  6. Select Save.


Assign proposal report templates to user roles

Proposal report templates are not automatically visible to users. To assign PDF and Excel proposal templates to specific roles:

  1. From the application left navigation area, select Administration.

  2. From the top navigation bar, select Role Management, then select a role.

  3. On the Access Management tab, select Report Template.

  4. In the Report Template dialog, select PDF and Excel proposal templates.

  5. Select Update.

  6. Select Save.

  7. Sign out of CPQ and then sign back in for the change to take effect.


Replace a proposal report template

If you need to iterate on a proposal template design without changing roles, adding new templates, or modifying master data, you can replace an existing, registered proposal template.

You can replace a template in one of the following ways:

  • From the Administration screen

  • Directly from a quote or agreement (PDF templates only)

From the Administration screen

Follow the steps in Upload a proposal report template.

Before uploading a new file, delete the existing file. The updated file name must match the deleted template name.

Directly from a quote or agreement

Note

This option is available only for PDF proposal templates.

You can quickly update and test an existing, registered PDF proposal template directly from a quote or agreement.

To replace a PDF proposal template:

  1. Open a quote or open an agreement.

  2. From the top button bar, select Reports > Replace PDF Template.

  3. In the Select PDF Template field, select a template.

  4. (Optional.) Select Download to download the current .jrxml source file. Open it in Jaspersoft Studio, make your changes, and save the updated file.

  5. Select Choose file to upload your updated .jrxml file. The new file name must match the original file name.

  6. (Optional.) Select Test PDF Template to generate a temporary PDF for the current quote or agreement using your uploaded .jrxml. Review the layout, bindings, images, and totals. If further changes are needed, update the file and upload it again.

    Tip

    In this step, the replacement is not system-wide. The update is visible only in the preview.

  7. Select Replace PDF Template to replace the existing registered template file with your updated .jrxml.


Set default proposal report templates for individual users

To define a default PDF or Excel proposal template for each specific user:

  1. From the application left navigation area, select 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 Proposal Templates field, select a default PDF or Excel template.

  5. Select Save.


Configure name format for proposals

Note

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

Configure the name of proposals 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 PDF and Excel proposals:

  1. From the application left navigation area, select 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 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 proposal name format:

    • {QUOTE_ID}—Quote or agreement ID.

    • {QUOTE_TITLE}—Quote or agreement title.

    • {QUOTE_REFERENCE}—Quote or agreement reference.

    • {VERSION}—Quote or agreement version.

    • {TEMPLATE_NAME}—Name of the proposal template.

  6. Select Save.


Enable a plain text editor on the Proposal tab

Zilliant CPQ allows you to choose an editor type for the Proposal tab in quotes and agreements:

  • Rich text editor—Enables advanced styling options to format proposal text. This is the default editor.

  • Plain text editor—Supports unformatted text.

To use the plain text editor:

  1. From the application left navigation area, select Administration.

  2. From the top navigation bar, select Master Data Management.

  3. Move through or search to locate Setting Boolean and select it from the list.

  4. Select Setting User Plain Text Editor.

  5. Set the Setting Value Boolean switch to YES.

  6. Select Save.