Report Spreadsheet

The Report Spreadsheet add-on connects the Reports add-on with the Vaadin Spreadsheet component, so that the XLS and XLSX output of a report opens in an interactive spreadsheet in the browser instead of being downloaded as a file. Users review the generated document, edit it, and download the edited version in its original format.

The add-on provides the following features:

  • The Run and open in spreadsheet action next to the usual run action in the reports views.

  • A spreadsheet viewer shown as a dialog or as a full page.

  • Editing of the generated document before it is downloaded.

  • A choice of only those templates and output types that the viewer can render.

  • A programmatic API for opening a report in the viewer from your own code.

Installation

This add-on requires the Enterprise subscription. If you don’t have the subscription, see the Enterprise Trial section for how to get a trial version.

It also builds on two other add-ons, and both must be present in the project:

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

For manual installation, follow the steps below.

  1. Configure access to the premium repository.

    • Add the premium repository to your build.gradle:

      repositories {
    // ...
    maven {
        url = 'https://global.repo.jmix.io/repository/premium'
        credentials {
            username = rootProject['premiumRepoUser']
            password = rootProject['premiumRepoPass']
        }
    }
}

    • Add premium repository credentials to ~/.gradle/gradle.properties:

      premiumRepoUser=123456123456
premiumRepoPass=abcdefabcdef

      Get the repository credentials from your license key: the first part of the key before dash is the repository user name, the part after dash is the password. For example, if your key is 123456123456-abcdefabcdef, then the user name is 123456123456 and the password is abcdefabcdef.

  2. Add dependencies of both add-ons to your build.gradle:

    implementation 'io.jmix.vcc:vaadin-spreadsheet-starter'
implementation 'io.jmix.reportsspreadsheet:jmix-reports-spreadsheet-flowui-starter'