BreakBy Export to PDF – QBeeQ

BreakBy Export to PDF simplifies this by letting you export multiple PDFs in one click. Just choose a "break-by" dimension—like client, country, or product—and the plugin will automatically generate a separate PDF for each value in that list. In simple terms, take one dashboard and split it up into separate reports for every item in a category.

Installation and configuration

The BreakBy Export to PDF plugin can be installed by an Admin, following the directions in Installing QBeeQ Plugins.

Operating system and version support:

Linux - Latest

Windows - Latest

BreakBy Export to PDF uses a config.js file to control the plugin’s global behavior.

To locate this file:

Go to the Admin tab > App Configurations > File Management

Continue to the plugins folder > QBeeQBreakByExportToPDF > select the config.js file

`exportSettings`

The exportSettings object controls the layout, metadata, and export behavior when generating PDFs. This object can be defined to customize how dashboards are exported, including format, orientation, and display options for dashboard metadata.

Property	Description	Type	Value
paperFormat	Specifies the paper size for the PDF.	`string`	Common values include `"A4"` (default), `"Letter"`, etc.
paperOrientation	Page orientation for the PDF.	`string`	`portrait` , `landscape`
elasticubeBuiltValue	Optional value that will be shown to indicate the build timestamp or ID of the Elasticube powering the dashboard If not provided, that section will be omitted from the footer	`string`	`true`, `false`
layout	Determines the layout strategy.	`string`	Currently `asis` is the only supported value.
showDashboardTitle	Includes the dashboard title in the exported PDF	`boolean`	`true`, `false`
showDashboardFilters	Displays the active dashboard filters at the top of the PDF	`boolean`	`true`, `false`
showDatasourceInfo	Includes data source details such as Elasticube name and version info	`boolean`	`true`, `false`

`supportedRoles`

An array of roles that can set a filter as a break-by. Roles can be added or removed from the allow list by an Admin.

ℹ️

Users with a Viewer role will not be allowed to set filters as a break-by.

Role	Value
Sys. Admin	`'super'`
Tenant Admin	`'tenantAdmin'`
Data Admin	`'dataAdmin'`
Data Designer	`'dataDesigner'`
Designer	`'contributor'`

Defining BreakBy filters

To define the BreakBy filters that are shown to dashboard Viewers as options for PDF export:

Navigate to the Filter Panel

Select a filter

Click the three-dot menu

Click Set as break-by

Repeat on other filter dimensions as required for your use case

⚠️

.This plugin supports standard dashboard-level filters. It does not work with cascading (dependent) filters at this time.

Using BreakBy Export to PDF

Once enabled by a Designer, Viewers can export the dashboard to PDF by the selected dimension.

ℹ️

Dimensions that return null values will not be exported.

Open the dashboard menu

Navigate to Download PDF by

Select a dimension to begin the export

Completed downloads can be found in your local Downloads folder.

⚠️

PDF generation, especially when many dimensions are present, may have an increased wait time for download.