Jasper Reporting Overview
  • 07 Jan 2022
  • 5 Minutes To Read
  • Dark
    Light
  • PDF

Jasper Reporting Overview

  • Dark
    Light
  • PDF

Jasper reports allow you to create custom reports that contain data from different Mambu database tables.

To create Jasper reports, you use Jaspersoft Studio. For more information, see Creating Jasper reports.

Once your reports have been created in Jaspersoft Studio and you have the appropriate JRXML template, you may import this file to Mambu to display the Jasper report using data from various entities in Mambu. For more information, see Importing Jasper report templates in Mambu.

Please be Aware

As the Mambu database may undergo changes, a Jasper report that was built on a previous Mambu database may not work if a database change affects the data included in the template. To keep track of database changes, please follow our Release Notes in Community.

Please Note

You can only import Jasper reports using the Mambu UI, you cannot import using the API.

Jasper report templates and permissions

There are five permissions related to viewing, creating, editing, and deleting reports in Mambu:

  • View Historical Data (VIEW_INTELLIGENCE)
  • View Reports (VIEW_REPORTS)
  • Create Reports (CREATE_REPORTS)
  • Edit Reports (EDIT_REPORTS)
  • Delete Reports (DELETE_REPORTS)

With regards to reports, there is a Reports tab under the Administration menu item and there is a Reporting menu item on the main menu.

To view the Reports tab under Administration, you need at least one of the aforementioned permissions assigned to your user, either directly or via a role.

To view the Reporting menu item on the main menu you need the View Historical Data and the View Reports permissions assigned to your user, either directly or via a role.

Please Note

These permissions do not affect whether your user is able to view a particular Jasper report when they have been embedded in the relevant entities. This is managed by the Visibility section when you manage a specific Jasper report template. For more information, see Controlling access to reports below.

Creating Jasper reports

To create your Jasper report templates, you will need to:

  1. Install Jaspersoft Studio and mySQL server. For more information on this setup, see Software Requirements.
  2. Link the mySQL database to Jaspersoft Studio so that all the data is available in Jaspersoft Studio. For more information on how to create an adapter between Jaspersoft Studio and MySql Server, see Data Adapter.
  3. Download your current Mambu database and then import it into mySQL. For more information, see Database clone and Import Database clone.
Interested in more details?
Check out our developer handbook.
Examples
Explore some examples as part of our starting kit.
Please be Aware
Jasper reports cannot handle more than 10,000 rows when imported in Mambu since this is the batch limit. Reports based on more than 10,000 rows will therefore appear differently when run in Jaspersoft Studio as opposed to in Mambu.

Importing Jasper report templates in Mambu

To import a Jasper report template in Mambu, you must first export the JRXML file from Jaspersoft Studio. Once you have this file:

  1. On the main menu, go to Administration > Reports.
  2. Using the Reports Type dropdown, select the entity for which you would like to create a report.
  3. Select Add Report.
  4. In the Importing New Report dialog, enter all the necessary information. For more information on the fields, see Fields for reports below.

Importing New Report dialog to import a Jasper report

Fields for reports

Name Description Required
Report Name The name for the report. Maximum length of 255 characters. If no name is entered, the field will be automatically filled with the name of the JRXML file you upload.
Report Type The entity where the report will be displayed. The entity is chosen when using the Reports Type dropdown. There is an additional Other option. For more information, see Viewing reports with report type other.
File The JRXML file to upload. After selecting the file, select Send in order to complete the file upload process.
Visibility The user roles that will have access to view the reports. For more information, see Controlling access to reports below.
Description Additional notes about the report.

Controlling access to reports

Please Note
Access is controlled at the role level, not at the user level. For more information, see Access managed by role.

Access to a report is controlled by the Visibility settings you select when creating or editing the report.

If you select the All Users checkbox, then all roles will be selected and any user that has the appropriate permissions assigned to them either directly, or through a role will have access to the report.

If you do not select the All User checkbox then users will need to be assigned a role with appropriate permissions to allow them access to the Jasper report template. This role needs to also be selected in the list of roles. Users will not have access to the report if they have the permissions directly assigned to them.

Editing, deleting, and rearranging reports

To edit, delete, or rearrange report templates:

  1. On the main menu, go to Administration > Reports.
  2. Using the Reports Type dropdown, select the entity for which you have created the report you want to edit, delete, or rearrange.
  3. To edit or delete a report, find the report in the list and select Actions and then either Edit or Delete. To rearrange the reports, select Rearrange Reports, and then drag and drop the reports into the order you prefer and select Save Changes.

List of jasper report templates to edit, delete, or rearrange

Downloading and previewing the report template

Jasper Reports templates are compiled before they are stored in the database, but Jasper SDK is able to decompile reports into JRXML files. A Jasper report template will be decompiled before it is downloaded so that you can open it in Jasper Studio directly.

To download a report template:

  1. On the main menu, go to Administration > Reports.
  2. Using the Reports Type dropdown, select the entity for which you have created the report you want to download.
  3. Select the name of the report, which is a link, in order to go to the report detail page.
  4. Select either Download Report Template or Preview Report.

Report detail page where you can download the report template

Viewing reports

In order to view a report you have to go to the entity under which you created the report.

For example, if you create a report for the Clients entity, then to view the report:

  1. Go to the client detail page of any client.
  2. In the top right-hand corner select Reports, then select the name of the report you would like to view.

Where to find reports on client detail page

Viewing reports with report type Other

There is an additional Other report type option. To view reports with the Other report type:

  1. On the main menu, select Reporting > Other Reports
  2. In the list of reports, select the report you want to view.

Ask the Mambu Community

If you have a question about how anything works or have come across something you haven't seen explained here, get in touch with our community of fellow users and Mambuvians where someone will lend a hand.


Was This Article Helpful?