JasperReports Menu

The JasperReports Menu in Joget DX 8 is a powerful UI element that facilitates complex reporting capabilities by integrating with JasperReports, an open-source reporting engine. Here are the key aspects and functionalities of the JasperReports Menu:

1. Purpose: The JasperReports Menu is designed to handle more intricate reporting requirements within the Joget DX platform. It leverages the capabilities of JasperReports to create and display sophisticated reports with custom layouts, graphs, and data visualizations directly within the user interface.

2. Integration with JasperReports: This menu seamlessly integrates with JasperReports report definitions, allowing you to generate pixel-perfect documents that can be viewed, printed, or exported in various formats, such as HTML, PDF, Excel, OpenOffice, and Word.

3. Cross-Platform Compatibility: JasperReports is written in Java, making it cross-platform compatible. This means reports can be generated and viewed on different operating systems without compatibility issues.

4. Export Options: The JasperReports Menu provides options for exporting reports to PDF and Excel formats, enhancing the versatility and usability of the generated reports.

5. Not a Replacement for JasperReport Server: It's important to note that the JasperReports Menu is not intended to replace full-function reporting servers like JasperReport Server (http://community.jaspersoft.com/project/jasperreports-server). Instead, it complements the Joget DX platform by offering embedded reporting capabilities for scenarios without advanced reporting features.

6. iReport Designer: iReport is a graphical design tool built explicitly for report designers and power users to create and define reports for execution using the JasperReports engine (http://community.jaspersoft.com/project/ireport-designer). It provides a user-friendly interface for designing and customizing reports per specific requirements.

7. Community and Enterprise Versions: JasperReports and iReport Designer have community and enterprise versions available, catering to different user needs and requirements based on licensing and feature sets.

Overall, the JasperReports Menu in Joget DX expands the platform's reporting capabilities by integrating with JasperReports, allowing users to create and display sophisticated reports directly within the UI environment.

Configure Jasper Reports

To configure Jasper Reports properties, in UI Builder, drag and drop the Jasper Reports element onto the canvas and click on it.

When adding Jasper Reports, you will see the following fields available for configuration:

• Label: Provide a descriptive label for the JasperReports menu (mandatory field).
• Menu ID: Item link slug. Optional field.
  
  Unique field
  The 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: Use the default datasource configured in Joget DX 8.
  • Custom Datasource: Specify a custom datasource for your JasperReports integration.
• Default Output: HTML
• Export Options: Enable export options like PDF and Excel at the bottom of the generated report.
• Jasper Report Definition (JRXML): Paste your JRXML definition in XML format here for report generation.
• Use virtualizer for large report: Enable this option if you encounter issues generating extensive reports.

Configure custom database

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

Fields to configure:

• JDBC Driver: Enter the JDBC Driver Name for your custom database.
• JDBC URL: Specify the JDBC URL to connect to your custom database.
• JDBC Username: Enter the username for your JDBC profile.
• JDBC Password: Enter the password for your JDBC profile.

Advanced

The Advanced section contains settings for more specialized configurations in the JasperReports menu.

Report parameters

The Report Parameters allows you to map parameters expected by your JasperReports.

Fields to configure:

• Parameters: Map parameters expected by your JasperReports.
  • Name: JasperReports parameter name. For example, group.
    
    
    
  • Value: Hardcoded value or use hash variables like #requestParam.groupName#.
    

UI

The UI allows for customization of the appearance and behavior of the JasperReports menu.

Fields to configure:

• Custom Header: Add custom HTML for the header section of the JasperReports UI.
• Custom Footer: Include custom HTML for the footer section of the JasperReports UI.

Performance & offline settings

Configure caching and offline support for enhanced performance:

Cache settings

Cache settings allow you to define how content will be stored to improve performance.

Fields to Configure:

• Scope:
  Options include 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.

For more information, see Performance Improvement with UI Caching.

PWA offline settings

The PWA offline settings enable caching for offline support, which is especially useful for mobile browsers.

Field to Configure:

• Enable cache for offline support: This is usually set for mobile browsers. See Progressive Web Application (PWA) documentation for more details.