View source | Discuss this page | Page history | Printable version   
Toolbox
Main Page
Upload file
What links here
Recent changes
Help

PDF Books
Add page
Show collection (0 pages)
Collections help

Search

Reporting Server/Reporting Functionalities

Contents


The Openbravo backoffice is integrated with the Jasper Reports Server in various ways: providing access to the reports server without relogin, report bursting and retrieving reports from the jasper reports server directly through the Openbravo backoffice user. These integration topics are described in detail in this document.

Openbravo Reporting Configuration

The Openbravo server needs to know how to access the required Jasper Server installation. The Jasper server information is configured in the 'Reporting Configuration' window.


Openbravo Jasper Reporting Config.png


Note: although it is possible to define different reporting configuration for different organizations the only currently support configuration is one Jasper Server installation per Openbravo installion. This means that there should only be one reporting configuration record.

Navigate from the backoffice directly to the Reports Server

When single sign on is configured it is possible to navigate directly from the Openbravo backoffice to the Reports Server.


Openbravo Open Jasper server.png


The user will be automatically logged in into the reports server and the relevant role will be selected. To support more specific role alignment between reporting and the reports server, define the role mapping explicitly. Note:


Openbravo Jasper Reporting Role Mapping.png


Openbravo Jasper Roles.png


Report Bursting

Jasper Reports Server allows you to schedule reports to be send by email or generated on designated file locations. The reports bursting functionality of Openbravo allows you to use this functionality for a large set of users. The main features of our report bursting functionality: report bursting is operated from the the Openbravo backoffice it uses the Openbravo role and user definitions to assign schedules to users. the receivers of reports (by email) do not have to login to Jasper or have a user defined within Jasper. each user can receive a report with his/her specific data, personalized content based on the properties of the receiving user.

Report Bursting Main Steps

The main steps in the report definition are:

The report schedules can easily be regenerated from the Openbravo backoffice when new users have been introduced or roles change.

Create a template job within Jasper/Openbravo Reports Server

The first step is to create a report schedule in Jasper. This report schedule is the template for the report schedule for each individual user. Set the timing, the type of output (pdf, xls etc.) and the email subject and body text. After saving the template schedule check the schedule id. Note: the template report job does not have to be enabled.


Openbravo Jasper Report Schedule.png

Note: one not-yet-supported feature is to geenrate the report on different file locations for different users. In this release the main idea is to send reports by email.

Create Report Bursting Definition in Openbravo Backoffice

The report bursting definition in the Openbravo backoffice has several parts:

Each of these parts is discussed here.

The Report Bursting Definition Header

The report bursting definition header allows you to specify a name and description and then two additional important fields:


Openbravo Jasper Report Burst Definition.png
The Report Bursting Variables

A main feature of report bursting is that each receiver of a report will get a report with his/her own personalized content. For example, a sales rep will only get the sales data for the tickets which he/she created, a store manager will only get a report for his/her store. To accomplish this the assumption is that the report has parameters to customize the content. For example as shown below.


Openbravo Jasper Report Parameters.png


The idea is that in the report bursting definition you can generate specific values for these parameters based on the user which will receive the report. The parameters are generated/set using the Report Bursting Variables tab which links Openbravo user specific variables to report parameters.


Openbravo Jasper Report Burst Variables.png


The variable name should correspond to the technical name of the parameter in Jasper. To find out the name you can just try one and press save, the error message will show you the available parameter names (see below) and you should be able to see what name correspond to what parameter.

Within the Jasper report template check also what value Jasper uses for the parameter, this depends on the report definition. This can be for example the name or the search key for a record.

With this knowledge you can then select which value of the user can be used to set the relevant parameter in the report schedule. You can use a so-called property path through the entity model starting from the user. The entity model is described here. The format of the parameter is always: '${user.[PROPERTY_PATH]}'. See the examples in the screenshot above.


Openbravo Jasper Report Burst Variables Name.png
Updating Report Schedules

Updating the report schedules is done by clicking the 'Update Report Schedules' button in the top. This action will create new report jobs for new users and remove report jobs of non-included users.

Note: check the paragraph, discussing a common error, further below.

To regenerate all report jobs, first remove them with the remove report jobs and then regenerate.

Remove and update report jobs are comparatively light actions so you can do them several times without issues.

Generated jobs will be prefixed with the template job name and suffixed with the user name.


Openbravo Jasper Report Burst Report Jobs.png


The resulting report jobs within Jasper:


Jasper Report Burst Report Jobs Generated.png


When you would go into the jasper report job you will find that several parameters are now set to the user specific values making the content personalized for the receiving user.


Jasper Report Burst Report Jobs Generated Variables.png


A possible error message when generating schedules is shown below. This error message occurs when the start date of the interval definition of the template job is in the past. Login into the jasper reports server to update the template schedule start date on the schedule tab.


Jasper Report Burst Report Jobs Generate Error.png

Retrieved from "http://wiki.openbravo.com/wiki/Reporting_Server/Reporting_Functionalities"

This page has been accessed 1,514 times. This page was last modified on 15 October 2019, at 18:27. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.