Create reports using JasperSoft Studio - Revision history

Mbozem at 17:23, 16 August 2026

2026-08-16T17:23:45Z

Diego.ruiz: purge wiki 2022

2022-07-14T10:30:41Z

purge wiki 2022

GeraldScott: New reference

2017-08-27T17:45:05Z

New reference

GeraldScott: Load into iDempiere

2017-08-27T17:38:55Z

Load into iDempiere

GeraldScott: Pront format

2017-08-27T17:25:37Z

Pront format

GeraldScott: Report& Process

2017-08-27T17:10:32Z

Report& Process

GeraldScott: New heading

2017-08-27T15:23:57Z

New heading

GeraldScott: Compilation

2017-08-27T15:22:09Z

Compilation

GeraldScott: Create report

2017-08-27T15:01:12Z

Create report

GeraldScott: First draft

2017-08-27T14:11:37Z

First draft

@@ Line 70: / Line 70: @@
 * Find the field ''Jasper Report'' and use the dropdown to select the Report that you created above
 * Save the updated Print Format and reprint the document with the new report layout.
 =References=

← Older revision		Revision as of 10:30, 14 July 2022
Line 80:		Line 80:
	[[Category: Development\|P]]		[[Category: Development\|P]]
	[[Category: Developer documentation‏‎]]		[[Category: Developer documentation‏‎]]
		+	[[Category: Updated2022]]
		+	[[Category: How-To]]

@@ Line 75: / Line 75: @@
 * [https://www.youtube.com/watch?v=qupDLprUoJE Evenos video about JasperSoft Studio]
 * [https://community.jaspersoft.com/documentation/v640/tibco-jaspersoft-studio-user-guide JasperSoft Studio Guide]
+* [[Making fonts available to your JasperReports]]
 [[Category: JasperReports]]
 [[Category: Development|P]]
 [[Category: Developer documentation‏‎]]

@@ Line 7: / Line 7: @@
 =How to do it=
 ==JasperSoft Studio==
-If you have not already done so, you must install the JasperSoft Studio:
+If you have not already done so, install JasperSoft Studio:
 * Download and install the Community Edition of JasperSoft Studio from the [https://community.jaspersoft.com/project/jaspersoft-studio download page] ('''note:''' don't download the older iReport Designer as this has been deprecated in favour of JasperSoft Studio);
 * Follow the installation instructions [https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v640/installing-jaspersoft-studio here]. JasperSoft Studio is built on the same framework as the Eclipse IDE so the [https://community.jaspersoft.com/documentation/v640/tibco-jaspersoft-studio-user-guide installation and usage is the same].
@@ Line 31: / Line 31: @@
 * Click on the ''New JasperReport'' icon
 * Select a Report Template (e.g. Blank Format A4)
-** Parent directory: MyReports (in the JaspersoftWorkspace), or create a new JasperReports Project
+** '''Parent directory:''' MyReports (in the JaspersoftWorkspace), or create a new JasperReports Project
-** File name: Invoice.jrxml (JRXML is the XML format used by JasperReports)
+** '''File name:''' Invoice.jrxml (JRXML is the XML format used by JasperReports)
 * Open the ''adempiere (CURRENT)'' schema to see all the tables and views that can be used in the report (note that you can also create additional database views in the schema for your own reports)
-* In the Texts box (to the right of the schemas, write a SQL SELECT statement to assemble the items for the report, for example:
+* In the Texts box (to the right of the schemas), write a SQL SELECT statement to assemble the items for the report, for example:
    SELECT a.documentno, a.docstatus, b.name, b.logo_id FROM adempiere.c_invoice a, adempiere.c_bpartner b  WHERE a.c_bpartner_id=b.c_bpartner_id
 * The SELECT can be as detailed and as complex as you require
@@ Line 48: / Line 48: @@
 * Click on the ''Compile Report'' button (above the report design)
-This will generate the report binary file ''Invoice.jasper'' from the resource ''Invoice.jrxml''. This is the file that you will upload to iDempiere (see below). Note that you can use either as iDempiere understands both, but the binary may be more efficient, and it may avoid version inconsistencies between the JasperReports compiler in iDempiere and the one in JasperSoft Studio.
+This will generate the report binary file ''Invoice.jasper'' from the resource ''Invoice.jrxml''. This is the file that you will upload to iDempiere (see below). Note that you can upload either the binary ''.jasper'' or the XML description ''.JRXML'' because iDempiere understands both, but the binary may be more efficient, and it may avoid version inconsistencies between the JasperReports compiler in iDempiere and the one in JasperSoft Studio.
 ==Installing the report==
 Once you are happy with the report, you can install it in iDempiere as follows:
 * Login as System/System
-* Select ''Report&Process'' and create a new entry
+* Select ''Report & Process'' and create a new entry:
 ** '''Search Key:''' InvoiceJasperReport
 ** '''Name:''' InvoiceJasperReport
 ** '''Data Access Level:''' Client+Organisation (it is not useful to the System user)
-** '''Report:''' check this for completeness
+** '''Report:''' check the box for completeness
 ** '''Class Name:''' org.compiere.report.ReportStarter (note that this is case sensitive)
 ** '''Jasper Report:''' attachment:Invoice.jasper (this is the binary that was created above)
 * Save the record
-* Now click on the Attachment icon (the paperclip on the toolbar) and load the binary from the JaspersoftWorkspace. This ensures that the binary is stored in the database with the Report Process record
+* Now click on the Attachment icon (the paperclip on the toolbar) and load the binary from the JaspersoftWorkspace. This ensures that the binary is stored in the database with the Report Process record and will get backed up with the database.
 To try out the report:
@@ Line 69: / Line 69: @@
 * When the preview opens, click on ''Customize Report'' to open the Print Format Window
 * Find the field ''Jasper Report'' and use the dropdown to select the Report that you created above
-* Save the Print Format and reprint the document with the new report layout
+* Save the updated Print Format and reprint the document with the new report layout.

@@ Line 52: / Line 52: @@
 ==Installing the report==
 Once you are happy with the report, you can install it in iDempiere as follows:
-* Login as Syste/System
+* Login as System/System
 * Select ''Report&Process'' and create a new entry
 ** '''Search Key:''' InvoiceJasperReport
@@ Line 59: / Line 59: @@
 ** '''Report:''' check this for completeness
 ** '''Class Name:''' org.compiere.report.ReportStarter (note that this is case sensitive)
-** '''Jasper Report:'''
+** '''Jasper Report:''' attachment:Invoice.jasper (this is the binary that was created above)

@@ Line 1: / Line 1: @@
-This guide explains how to use JasperSoft Studio to create complex reports and print-outs for use by the JasperReports engine embedded in iDempiere.
+This guide explains how to use JasperSoft Studio to create complex reports and print-outs for use by the JasperReports engine embedded in iDempiere. This is an alternative to using the standard built-in reports [[Creating reports using JasperReports| described here]].
 =Introduction=
@@ Line 48: / Line 48: @@
 * Click on the ''Compile Report'' button (above the report design)
-This will generate the report binary file ''Invoice.jasper'' from the resource ''Invoice.jrxml''. This is the file that you will upload to iDempiere (note that you can use either as iDempiere understands both, but the binary may be more efficient).
+This will generate the report binary file ''Invoice.jasper'' from the resource ''Invoice.jrxml''. This is the file that you will upload to iDempiere (see below). Note that you can use either as iDempiere understands both, but the binary may be more efficient, and it may avoid version inconsistencies between the JasperReports compiler in iDempiere and the one in JasperSoft Studio.
-==Upload report==
+==Installing the report==

← Older revision		Revision as of 15:23, 27 August 2017
Line 48:		Line 48:
	* Click on the ''Compile Report'' button (above the report design)		* Click on the ''Compile Report'' button (above the report design)

−	This will generate the report binary file ''Invoice.jasper'' from the resource ''Invoice.jrxml''. This is the file that you will upload to iDempiere.	+	This will generate the report binary file ''Invoice.jasper'' from the resource ''Invoice.jrxml''. This is the file that you will upload to iDempiere (note that you can use either as iDempiere understands both, but the binary may be more efficient).
		+
		+	==Upload report==

@@ Line 27: / Line 27: @@
 This only has to be done once. Thereafter you will use the same adapter to develop your reports.
-===JasperReport===
+===Design the report===
 Now you can create the JasperReport:
 * Click on the ''New JasperReport'' icon
@@ Line 36: / Line 36: @@
 * In the Texts box (to the right of the schemas, write a SQL SELECT statement to assemble the items for the report, for example:
    SELECT a.documentno, a.docstatus, b.name, b.logo_id FROM adempiere.c_invoice a, adempiere.c_bpartner b  WHERE a.c_bpartner_id=b.c_bpartner_id
-* Follow the video to create the report, or see the [https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v640/getting-started-jaspersoft-studio JasperSoft Studio documentation]
+* The SELECT can be as detailed and as complex as you require

@@ Line 2: / Line 2: @@
 =Introduction=
-The standard reporting mechanism is suitable for simple reports, but creating complex reports with sophisticated layouts can be difficult and time-consuming using the built-in Print Format tools.
+The standard reporting mechanism is suitable for simple reports, but creating complex reports with sophisticated layouts can be difficult and time-consuming using the built-in Print Format tools, so rather use JasperSoft Studio to do the design of sophisticated reports and print-outs with professionally designed layouts, fonts, colours and logos, then load the JRXML report definition into iDempiere for execution by the JasperReports engine.
-Use JasperSoft Studio to do the design of sophisticated reports and print-outs with professionally designed layouts, fonts, colours and logos, then load the JRXML report definition into iDempiere for execution by the JasperReports engine.
+The guide is based on [https://www.youtube.com/watch?v=qupDLprUoJE this video] by Evenos.
 =How to do it=
-==Install JasperSoft Studio==
+==JasperSoft Studio==
 * Download and install the Community Edition of JasperSoft Studio from the [https://community.jaspersoft.com/project/jaspersoft-studio download page] ('''note:''' don't download the older iReport Designer as this has been deprecated in favour of JasperSoft Studio);
 * Follow the installation instructions [https://community.jaspersoft.com/documentation/tibco-jaspersoft-studio-user-guide/v640/installing-jaspersoft-studio here]. JasperSoft Studio is built on the same framework as the Eclipse IDE so the [https://community.jaspersoft.com/documentation/v640/tibco-jaspersoft-studio-user-guide installation and usage is the same].
 ==Create a report==
-===Data Adapter===
+===Database Adapter===
-* Start up JasperSoft Studio;
+The first step is to create a database adapter to connect JasperSoft Studio to your instance of the iDempiere database server:
-* Delete the two unnecessary Data Adapters (called ''One Empty Record'' and ''Sample DB'');
 * Create a new Data Adapter to connect to the iDempiere database: '''Create Data Adapter > Database JDBC Connection > Next > '''
 ** '''Name:''' iDempiere Data Adapter
 ** '''JDBC Driver:''' org.postgresql.Driver
-** '''JDBC URL:''' jdbc:postgresql://localhost:5432/idempiere (use ''localhost'' if the database is on the same machine as JasperSoft Studio, otherwise replace ''localhost'' with the name of the database server);
+** '''JDBC URL:''' jdbc:postgresql://localhost:5432/idempiere (use ''localhost'' if the database is on the same machine as JasperSoft Studio, otherwise replace ''localhost'' with the name of the database server)
 ** '''Username:''' adempiere (the same username that was used when iDempiere was installed)
 ** '''Password:''' *********
-* Click on '''Test''' to test the connection parameters;
+* Click on '''Test''' to test the connection parameters
-* Click '''Finish''' if all is well.
+* Click '''Finish''' if all is well
 ===JasperReport===