Generating reports

The Zilliant CPQ reporting engine enables you to retrieve and print detailed quote information. Reports are available in two formats:

• Portable Document Format (PDF)—CPQ uses the JasperReports library to format and print reports in PDF format.
• Microsoft Excel Open XML Format (XLSX)—CPQ generates XLSX files by using the JXLS library .

Generate reports

Parameters to get information for reports

The reporting engine prepares and generates complete data about a quote, including its sales items and their configuration, and any other related information.

To get data attributes for the report, use the following JSONs.

JSON for a quote header is:

http://HOST/iss/webapp/quote/salesItemInstanceTreeForReportHeader?quoteId=<paramQuoteId>,

where paramQuoteId is the encoded URL.

data = {
    "value": {
        "- instance": {
            "id": "http://www.inmindcomputing.com/application/application-implementation.owl#d8032c5b7c1c44a0bd58796318b071f5"
        },
        "- type": {
            "id": "http://www.inmindcomputing.com/application/application-schema.owl#Quote"
        },
        "- attributes": [
            {
                "type": "data",
                "- attribute": {
                    "id": "http://www.inmindcomputing.com/application/application-schema.owl#quoteId"
                },
                "l10nKey": "Quote ID",
                "multiValued": False,
                "readOnly": False,
                "hidden": False,
                "mandatory": False,
                "enumerable": False,
                "position": 0,
                "- value": [
                    "0001/AHIL/FY15/0001"
                ],
                "valuetype": "string"
            }
        ]
    }
}

The .jrxml file has the following parameters that are used for PDF and Excel reports:

To access these parameters also in subreports, pass the REPORT_PARAMETERS_MAP from the main report to the subreport.

<subreport>
<reportElement x="6" y="11" width="545" height="200" uuid="190d17f1-ced8-4d82-a340-32c58ed18fff"/>
<parametersMapExpression><![CDATA[$P{REPORT_PARAMETERS_MAP}]]></parametersMapExpression>
<dataSourceExpression><![CDATA[new net.sf.jasperreports.engine.data.JRBeanCollectionDataSource($F{SalesItem}.getAttributeValues("includesPriceItem"))]]></dataSourceExpression>
<subreportExpression><![CDATA[$P{SUBREPORT_quotePriceItems}]]></subreportExpression>
<subreport>

Use the Groovy Additional Data for Proposal Generation endpoint to enhance the report by passing additional data.

Utility methods to get information for reports

Use the following utility methods to retrieve quote and sales item information.

Expressions to generate PDF and Excel reports

Images in reports

The reporting engine enables printing of images that are stored in the system.

• For PDF reports, the engine supports generating dynamic images.
• For XLSX reports, the engine supports generating only static images.

Expressions to generate images

• Fixed image—$P{CMIS} + "/logos/losgo.png"
• Line item image—$P{CMIS} + "/" + $F{SalesItem}.getAttributeValues("salesItemImage").get(0)
• Product image—$P{CMIS} + "/" + $F{SalesItem}.getAttributeValues("isProduct", "productImage").get(0)

Add product attribute range thumbnails to the quote proposal PDFs

In addition to the main product image in the quote proposal PDF, you might also include thumbnails of all product attribute images in that specific quote. This feature enables providing customers with a more rich visual content in the proposal.

To add attribute range thumbnails

1. From the application left navigation area, select Administration.
2. From the top navigation bar, select Content Management, then select jasperreports.
3. Add the image expression to the specific jasperreport template to pull the image information from the product configuration level.

Image expression example:

<imageExpression><![CDATA[$P{CMIS_ROOT} + "/" + $F{SalesItem}.getDSAValueThumbnails("Demo_Product_Country").get(0)]]></imageExpression>
</image>
<image>
    <reportElement x="160" y="45" width="25" height="20"/>
    <imageExpression><![CDATA[$P{CMIS_ROOT} + "/" + $F{SalesItem}.getDSAValueThumbnails("Demo_Product_Color").get(0)]]></imageExpression>
</image>

Custom fonts in reports

You can select custom fonts to use in your PDF reports. Follow these steps:

1. Package selected fonts into jasper-fonts.jar
2. From the application left navigation area, select Administration.
3. From the top navigation panel, select Content Management, then select fonts.
4. Upload the .jar file.

To generate the .jar file, follow these instructions .

Localization in reports

You can configure a PDF report to print in multiple languages. Follow these steps:

1. From the application left navigation area, select Administration.
2. From the top navigation panel, select Content Management.
3. Select localization, then select report-customization. Each message.properties file defines one language.