Introduction

JasperReports UI Menu is a UI element that allows more complex reporting requirements through integration with JasperReports.

By using JasperReports report definitions, sophisticated reports with custom layouts and graphs can be generated and viewed directly within a UI, with optional export to PDF and Excel.

JasperReports is one of the most popular open source reporting engines. It is written in Java to be cross-platform, and it is able to use data coming from any kind of data source and produce pixel-perfect documents that can be viewed, printed or exported in a variety of document formats including HTML, PDF, Excel, OpenOffice and Word.
http://community.jaspersoft.com/project/jasperreports-library

Note

This feature is not meant to be a replacement for full-function reporting servers like JasperReport Server (http://community.jaspersoft.com/project/jasperreports-server). However, in many cases you do not need such advanced reporting features, and this plugin allows for easy embedding of sophisticated reports directly within a UI.

What is iReport Designer?

iReport is a powerful graphical design tool for report designers and power users to define reports for execution using the JasperReports engine.
http://community.jaspersoft.com/project/ireport-designer
There are community and enterprise versions for both JasperReports and iReport Designer, depending on your needs.

JasperReports Menu Properties

Configure Jasper Reports

Figure 1: Jasper Reports Properties

Name	Description
Custom ID	Item link slug. Optional field. Unique field Value defined here must be unique to the rest of the UI Menus as the first matching name will be called upon.
Datasource	Default Datasource Custom Datasource
Label	Menu label. Mandatory field.
Default Output	HTML
Export Options	Enable export options at the bottom of the generated report.
Jasper Report Definition (JRXML)	Paste your JRXML definition in XML here.
Use virtualizer for large report?	If you are experiencing issues in generating of report, try checking this option.

Configure Custom Database

Figure 2: Jasper Reports Properties - Configure Custom Database

Tip

The custom database settings for your installation of Joget DX can be found by going to Settings > System Settings > Datasource & Profile Settings

Name	Description
JDBC Driver	Enter your JDBC Drive Name
JDBC URL	Enter your JDBC URL
JDBC Username	Enter your JDBC profile's username
JDBC Password	Enter your JDBC profile's password

Advanced

Figure 3: Jasper Reports Properties - Advanced

Name

Description

Parameters

If your Jasper Reports is expecting parameters, here's where you can map there.

Name	Description
Name	Jasper Reports parameter name. Example group
Value	Hardcoded value and Hash variable is accepted here. Example #requestParam.groupName#

UI

Figure 4: Jasper Reports Properties - UI

Name	Description
Custom Header	Custom Header in HTML.
Custom Footer	Custom Footer in HTML

Performance & Offline

Figure 5: Jasper Reports Properties - Performance & Offline Settings

Name

Description

Scope

Caching options are:

None: No caching.
Application: Cache content by application where all users will see the same content.
User: Cache by username

Duration (s)

Duration in seconds to cache content, defaults to 20 seconds if applicable.

PWA Offline Settings

Note: PWA Offline support is dependent on the theme used.

Name	Description
Enable cache for offline support	Check this to enable caching for offline support, usually set for use on mobile browsers.

Read Progressive Web Application (PWA) for more information.

Performance

You can configure the Performance settings in this UI Element which allows one to cache existing content for improved performance and loading speed. Read more at Performance Improvement with UI Caching.

Name	Description
Enable cache for offline support	Check this to enable caching for offline support, usually set for use on mobile browsers.