The Jasper Reports plugin provides a pixel-perfect way to export a pivot or table widgets into Excel or PDF files.
The Jasper Reports plugin sends the widget query results and some of the widget metadata to the Jasper library.
You can embed and use the following widget information in your Jasper template.
Note: You should be familiar with Jasper reports and Jaspersoft Studio in order to create Jasper templates.
For a complete reference on the Jasper Reports add-on please refer to the official manual
Installation
- Download and unzip the installation package.
- Upload the {installationPackageName}/Linux/{pluginName}.tar.gz to the root folder of Droppy (/opt/sisense/storage) or any other folder using SSH.
- Connect by SSH to the Linux server.
- Navigate to the archive file location and unarchive the file:
cd {path/to/archive} && tar -zxvf {pluginName}.tar.gz
- Navigate into the archive folder:
cd {pluginName}
- Run the installation script:
chmod +x install_plugin.sh && sh install_plugin.sh
- Refresh your dashboard.
Note: External-Plugins pod will be restarted in Kubernetes. Make sure the service is up and running.
Uninstall
- Repeat installation steps 1 thru 5 .
You can skip these stepts if they were completed during installation.
- Run the removal script:
chmod +x remove_plugin.sh && sh remove_plugin.sh
Note: External-Plugins pod will be restarted in Kubernetes. Make sure the service is up and running.
Limitations
- The plugin is supported only for pivot and table widgets.
- Formats that are set on the widget level are not presented in the exported file. If you need to apply formats, you can do it on the Jasper template itself.
Jasper Plugin Usage
For more information about using this plugin, see the Jasper Report Manual.
To create a Jasper template with widget information:
- To use the widget title or the widget description in your template, add a new parameter.
To show the widget title, add a new “WidgetTitle” parameter.
To show the widget description, add a new “WidgetDescription” parameter.
You can drag and drop the new parameters into the template.
- The widget query is applied to the report as fields.
To show the widget results, add a field and change the field title to match the widget field title, as defined in the widget metadata panel.
For example, you can create in the following widget’s Category and Cost fields in Jasper.
- Change the field class to match the type of the field in the cube.
For example, the Cost field is an integer field.
- After the fields are created, drag and drop the fields into the template.
This is a premium Sisense add-on. For pricing details please get in touch with
your CSM
Version 2.1.11 – October 23, 2024
- Added option to select export format for the uploaded template (PDF or XLS). Restored the ability to export to Excel via
Jasper Reports add-on.
- Bugfix: dashboard/widget date filter checkbox styles are broken when Jasper Reports add-on is enabled
- Bugfix: Incorrect displaying of null values when using the “When No Data Type” option in a Jasper template
Version 2.1.7 – March 14, 2024
- Compatibility with Jasper report templates created with version < 2.1.4 of the Jasper Report add-on
Version 2.1.5 – Sept. 18, 2023
- Bug fix: external-plugins pod constantly restarts after Sisense upgrade
Version 2.1.4 – July 19, 2023
- Added support for configuring multiple multiple widgets per template.
- Deprecated Excel export support
Version 2.1.0 – March 22, 2023
- Allow replacing native PDF download and Excel functionality with Jasper reporting functionality in dashboards and widgets.
Version 2.0.7 – Dec 22, 2022
- Support multiple tables using the same widget
Version 2.0.2 – July 26, 2022
- Improved performance for concurrent requests
Version 1.1.9 – Mar 11, 2022
- Added support for L2022.3
Version 1.1.9 – February 10, 2022
- Added support for L2022.2 and Report Manager 1.6.2
- Installation steps have been changed to support installation with scripts
Version 1.1.6 – January 20, 2022
- Added support for L2022.1 and Report Manager 1.6.1
Version 1.1.1 – December 14, 2021
- Fixed issue: export dashboard widget order is wrong
Version 1.1.0 – December 9, 2021
- Added support for L2021.12
Version 1.0.2 – October 29, 2021
- Added support for L2021.11
Version 1.0.2 – October 28, 2021
- Added support for L2021.10
Version 1.0.2 – October 20, 2021
- BloX widgets can be exported using Jasper reports.
Version 1.0.1 – 07 October, 2021
- Jasper Reports can be exported using the Report Manager. Compatibility with Report Manager version 1.5.4 and up.
Version 1.0.0 – 03-September, 2021