Skip to content
mzuchowski edited this page Apr 2, 2015 · 1 revision

Introduction

Once report definition is uploded and configured by Aperte Reports Manager, users have a possibility to generate reports.

In this part we assume that you have completed the previous one and Liferay User Roles report is available for users.

Please note that in order to enable background reporting, messaging should be configured, otherwise this option will be disabled. Similarly, without a proper configuration, mailing wont't work.

Generating reports on demand

Aperte Reports Invoker is a basic tool for reports generation. It displays a filterable list of reports with description, available for users (with active flag set).

http://wiki.aperte-reports.googlecode.com/git/img/tutorial/invoker_hidden.png

In synchronous way

To generate a report, simply click Parameters button and enter input parameters and you can generate report clicking Generate button. After a while, file in selected format will pop-up for download.

http://wiki.aperte-reports.googlecode.com/git/img/tutorial/invoker_shown.png

In background

Generation of complex reports can be a time-consuming task. In such cases it is recommend to use Generate in background option, which will generate a report in another thread, avoiding interference with user's GUI interaction. User can also check Send email option, to get generated content directly on his liferay user's mailbox.

Status of background report can be verified in Aperte Reports Order Browser portlet.

http://wiki.aperte-reports.googlecode.com/git/img/tutorial/background_hidden.png

You can preview entered parameters, and, if generation was successful, download the report.

http://wiki.aperte-reports.googlecode.com/git/img/tutorial/background_shown.png

Publishing reports

Aperte Repors Dashboard allows to publish generated reports in the portal content by putting the portlet in desired place on the page. In order to place and configure it, you have to be signed in as an administrative user and enable Toggle edit controls option.

http://wiki.aperte-reports.googlecode.com/git/img/tutorial/edit_controls.png

To configure report to be displayed, click on the wrench icon on the portlet's bar and select Preferences from menu.

http://wiki.aperte-reports.googlecode.com/git/img/tutorial/dashboard_menu.png

In the edit mode, you can choose report definition and enter parameters. Additionally, you can set cache timeout value (in seconds), to avoid report generation each time user visits the page. You can also select Show export buttons in order to get export buttons and Show refresh button to get refresh button in the view mode.

http://wiki.aperte-reports.googlecode.com/git/img/tutorial/dashboard_edit.png

When setup is done, click Save button and return to portlet's view mode by clicking Return to full page and you will see generated report.

http://wiki.aperte-reports.googlecode.com/git/img/tutorial/dashboard_report.png