Reports

The Reports add-on allows developers and end users to design and generate various reports by formatting data from the Jmix application using templates created in user-friendly office applications or HTML.

The add-on provides the following features:

  • Creating reports at design time using annotated Java classes or at runtime using the admin UI, or a step-by-step wizard.

  • Generating reports in DOCX, XLSX, HTML, CSV, PDF, arbitrary text format, or display as table within the application.

  • Creating advanced XLSX reports with grouping, data aggregation, and cross-tabs.

  • Using diagrams and formulas in XLSX reports.

  • Managing report access, REST API usage, and execution history.

Refer to the Report Generation guide for practical examples that demonstrate report design.

Installation

For automatic installation through Jmix Marketplace, follow instructions in the Add-ons section.

For manual installation, add the following dependencies to your build.gradle:

implementation 'io.jmix.reports:jmix-reports-starter'
implementation 'io.jmix.reports:jmix-reports-flowui-starter'

To access reports through the REST API, also add the following dependencies:

implementation 'io.jmix.reports:jmix-reports-rest-starter'

The Reports add-on uses the LibreOffice package to output reports in PDF and DOC formats. Install LibreOffice to support PDF and DOC output.

Important Note for Single Menu Mode Applications

If your application uses Single menu mode, you should manually add menu items after installing an add-on.

  1. Open Menu Designer in Jmix Studio.

  2. Navigate to the Structure tab.

  3. Available menu items are displayed in the left panel.

    add menu items

  4. To add items:

    • Select the desired items and click the > (Add Selected) button.

    • Or, drag-and-drop them from the left panel into the current menu structure on the right.

This step is required because applications in Single menu mode do not automatically merge add-on menus with the existing structure.