Introduction

JasperReports is a page component 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


NameDescription
LabelMenu label. Mandatory field.
Menu 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
Default Output
  • HTML
Export OptionsEnable 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 default database settings for your installation of Joget DX can be found by going to Settings > System Settings > Datasource & Profile Settings

NameDescription
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


NameDescription
 Parameters

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

NameDescription
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


NameDescription
Custom HeaderCustom Header in HTML.
Custom FooterCustom Footer in HTML


Performance & Offline 

Figure 5: JasperReports 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.

Read more at Performance Improvement with UI Caching.

PWA Offline Settings

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

Name

Description

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

Read Progressive Web Application (PWA) for more information.


AJAX & Events

New Feature

This is a new feature in Joget DX 8.

Event Listening

Figure 6: JasperReports Properties - AJAX & Events - Event Listening

Name

Description

Component Object

The object that will be listening for an event.

This field will dynamically show selectable options depending on the page components used. e.g: if there is a page component called manage meeting in the page, it will automatically show up in this field's select box.

Event NameCustom Event Name.
Matched Action 

Action to be listened for.

  • Hide Component
  • Show Component
  • Show and Reload Component
  • Show and Change URL Component Parameters
  • Reload Page
  • Redirect Page
  • Show and Redirect Component
Add row Adds another row for another event

Event Triggering

Figure 7: JasperReports Properties - AJAX & Events - Event Triggering

Name

Description

Event NameCustom Event Name
Trigger Method

The method used to trigger an event.

  • GET Request
  • POST Request
  • Link Clicked
Parameter NameCustom Parameter Name.
Operator

Logical Operator to be used in evaluating "Parameter" against "Value"

  • Equals To
  • Not Equals To
  • Greater Than 
  • Greater Than
  • Greater Than or Equals To
  • Less than
  • Less than or equals to
  • Is True
  • Is False
  • Is Empty
  • Is Not Empty
  • Contains
  • In
  • Regex Match
ValueThe value that the Parameter will be compared to.
When Not Match Trigger Event NameEvent Name when/if the logical operation is not satisfied.
Add rowAdd another row for another event.


Related Documentation

  • No labels