workbookreport

This configuration is required when using the plugin WorkbookReport.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<workbookReportConfiguration
>
required

This configuration sets up the PDF report export functionality in Cadenza using WebDriver technology. More information see Exporting PDF Reports.

Choice: Choose only ONE of the following
<localWebDriver
>
required
<webDriverExecutable
>
required
string

The path to the web driver executable (e.g.ChromeDriver for Chrome).

</webDriverExecutable>
<webDriverBrowserExecutable
>
required
string

The path to the browser executable (e.g. chrome.exe on Windows for Chrome).

</webDriverBrowserExecutable>
<webDriverPort
>
optional
int

Override the default web driver port allocation, which uses any free port, with a fixed port.

The web driver port is only used internally by Cadenza and bound to localhost, so there should be no external communication with the web driver. Setting a fixed port may be necessary in environments with security policies that require open ports to be listed explicitly, such as SELinux configured restrictively.

When in doubt, do not specify.

</webDriverPort>
</localWebDriver>
<remoteWebDriverUrl
>
required
string

URL of remote web driver. This should point to load balancer or kubernetes service, if multiple web driver instances are part of the deployment.

</remoteWebDriverUrl>
Choice End
<webDriverWaitTimeout
>
optional
duration

ISO 8601 Duration Format

Format: P[n]Y[n]M[n]DT[n]H[n]M[n]S

  • P is the duration designator (period) placed at the start of the duration representation
  • Y is the number of years
  • M is the number of months
  • D is the number of days
  • T is the time designator that precedes the time components
  • H is the number of hours
  • M is the number of minutes
  • S is the number of seconds

Examples:

  • PT5M - 5 minutes
  • PT1H30M - 1 hour and 30 minutes
  • P1D - 1 day
  • P1Y2M3DT4H5M6S - 1 year, 2 months, 3 days, 4 hours, 5 minutes, and 6 seconds

The maximum time Cadenza will wait for a report to finish loading. The timeout is specified according to ISO 8601 in the PnYnMnDTnHnMnS format. Loading may take some time, especially when complex data queries are involved. That's why the default timeout is PT5M. If you know that your reports only use faster queries, then you may want to decrease the timeout to avoid unnecessary waiting in case of an error.

Default: PT5M

</webDriverWaitTimeout>
<threadCount
>
optional
int

The maximum number of reports that may be generated in parallel.

Default: 1

</threadCount>
<cadenzaUrl
>
optional
string

Address of Cadenza server which should be used for generating PDFs. Should be used in multi-node environments. This enables Cadenza to delegate compute-intensive report generation to other instances in the cluster. This can be any URL which allows access as long as it ensures session stickyness. The default Kubernetes service generated by the Cadenza Helmchart MUST NOT be used because it does not support session stickyness.

</cadenzaUrl>
</workbookReportConfiguration>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
cadenzaconfig:
  settings:
    workbookreport:
      localWebDriver:
        webDriverExecutable: "text"
        webDriverBrowserExecutable: "text"
        webDriverPort: 15
      remoteWebDriverUrl: "text"
      webDriverWaitTimeout: "P2DT3M"
      threadCount: 15
      cadenzaUrl: "text"

Filename: workbookreport-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not. 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<workbookReportConfiguration>
  <localWebDriver>
    <webDriverExecutable>text</webDriverExecutable>
    <webDriverBrowserExecutable>text</webDriverBrowserExecutable>
    <webDriverPort>15</webDriverPort>
  </localWebDriver>
  <remoteWebDriverUrl>text</remoteWebDriverUrl>
  <webDriverWaitTimeout>P2DT3M</webDriverWaitTimeout>
  <threadCount>15</threadCount>
  <cadenzaUrl>text</cadenzaUrl>
</workbookReportConfiguration>