Introduction
The JasperReports Userview Menu is a userview plugin 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 userview with optional export to PDF and Excel.
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 userview.
What is JasperReports?
JasperReports is one of the most popular open source reporting engine. 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
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, depending on your needs.
How to Use JasperReports Userview Menu
1. Design Report using the iReport Designer.
- Download and install iReport Designer fromhttp://community.jaspersoft.com/project/ireport-designer
- Get started with iReport Designer to design your report.
http://community.jaspersoft.com/wiki/getting-started-ireport-designer - Once the report has been designed, switch to the XML View to view the source XML definition. Copy this XML. You can also save the report as a .jrxml file and open the file to copy the contents.
2. Configure the JasperReports Menu
- In the Joget Workflow web console, launch the Userview Builder for the desired userview in your app.
- Drag the JasperReports Menu element into the desired menu location in the userview.
- Click on Edit, and configure the properties in the property dialog as follows:
Configure JasperReports
Custom ID |
Optional ID to represent this element, else a system generated ID will be created. Recommended that this is entered as this ID will be seen in the userview URL. |
Label |
Label displayed in the userview menu |
Default Output |
Only HTML is available at this time |
Export Options |
Check to allow the report to be exported into PDF and/or Excel formats |
JasperReports Definition (JRXML) |
The XML definition of the report designed using iReport Designer. Copy the XML from the “XML View” tab in iReport, or directly from the .jrxml file contents. |
Configure Datasource
Datasource |
This is an option of either Default Datasource which uses the current Joget database, or Custom Datasource which allows you to key in custom database connection details. |
Configure Custom Database
JDBC Driver |
The JDBC driver for the desired database |
JDBC URL |
The JDBC connection URL to the desired database |
JDBC Username |
The database connection username |
JDBC Password |
The database connection password |
UI
Custom Header |
Optional custom header content to be displayed at the top of the report. |
Custom Footer |
Optional custom footer content to be displayed at the bottom of the report. |
Once the configuration has been done, the report will be generated when the userview menu page is accessed.