Set up visual analytics integration

Prev Next

To integrate visual analytics through Tableau, follow these steps:

  1. Set up your AWS environment.

  2. Enable visual analytics in CPQ.

  3. Open visual analytics in CPQ.

Set up your AWS environment

The integration uses Zilliant Report API External link indicator to securely retrieve Tableau report URLs and embed them in CPQ. To enable CPQ to authenticate against Report API, add your credentials in the AWS environment where your CPQ application is running.

  1. Sign in to the AWS access portal with your administrator credentials.

  2. On the top navigation bar, ensure that the correct region is selected.

  3. Select your system.

  4. Select Elastic Beanstalk, then select your environment.

  5. Select Configuration, then in the Environment properties section, enter the following values:

    • ZORG_API_URL—Report API URL with your API hostname.

    • ZORG_CLIENT_ID—OAuth client ID for authentication.

    • ZORG_CLIENT_SECRET—OAuth client secret.

    • ZORG_USERNAME—Username.

    • ZORG_PASSWORD—Password.

Enable visual analytics in CPQ

Define which Tableau reports and where in the CPQ UI you want to display.

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

  2. From the top navigation bar, select Destination Configuration.

  3. Select to add a destination, defining where to enable visual analytics.

  4. In the Create New Destination dialog, enter values to define a destination:

    • Destination Name—Enter one of the following values to define where in the CPQ UI to enable analytics:

      • QT_HEADER_CVA_CONFIG—Quote header level.

      • QT_LINE_CVA_CONFIG—Quote line item level.

      • AG_NEG_HEADER_CVA_CONFIG—Header level of agreements under negotiation.

      • AG_NEG_LINE_CVA_CONFIG—Line item level of agreements under negotiation.

      • PUB_AG_HEADER_CVA_CONFIG—Header level of published agreements.

      • PUB_AG_LINE_CVA_CONFIG—Line item level of published agreements.

    • URL—Enter the Report API URL without path and query parameters. For details on the URL syntax, read How View URLs Are Structured External link indicator in Tableau’s documentation.

  5. Select Create.

  6. Select the new destination from the list.

  7. In the Additional Properties section, select to define path and query parameters for the URL. In the new row, define each parameter using the leftmost field for the key and the rightmost field for the value:

    • WorkbookName—Name of the Tableau workbook.

    • WorksheetName—Name of the Tableau worksheet.

    • (Optional.) Add standard Tableau query parameters to control how the analytics view looks and behaves. For example, you can pass the :showDataDetails parameter with the value yes to display additional information in the analytics view. For details on the query parameter syntax, read How View URLs Are Structured External link indicator and Embed Code Parameters for Views External link indicator  in Tableau’s documentation.

    • (Optional.) Add query parameters to dynamically filter the Tableau report data. These parameters fetch live data from the currently opened quote or agreement in CPQ and pass it to Tableau at runtime. Use these parameters to automatically filter the Tableau report by context, such as the account or sales region linked to the agreement or quote.

      Each parameter value must correspond to the names in the CPQ schema model. To access live data, follow the CPQ application metadata path.

      Tip

      To pass data from the quote header, start the parameter value with Quote.. To pass data from line items, start with SalesItem.. For example, to pass the account ID as a query parameter, add the account_id : Quote.quoteContainedBy.objectERPId key-value pair.

  8. On the bottom button bar, select Save.

  9. Repeat Steps 1–8 for each CPQ UI destination where you want to enable visual analytics.

Open visual analytics in CPQ

After you enable the integration, users can open visual analytics in agreements or quotes. For details, read: