Managing Report Definitions

The Reporting perspective provides a launch panel as well as toolbar options for managing report definitions. Tabs can be selected for specific tasks.

Adding Report Definitions

To add a report definition, click the Add ad hoc Report Add Report icon in the My Reports toolbar.

Add Report
Figure: Add ad hoc Report

Once a new report definition is created, the Report Definition View opens.


Figure: Report Definition View

Hereby, the Report Definition will be given a default name (e.g. Report Definition 1) until it is discarded or stored as a Template.

You can look at the tabs being displayed as a wizard you can step through to

However, you can step back and forth between all tabs at your convenience.

New Report Definitions are added to the tree after they are saved.

Editing Report Definitions

Clicking a report definition opens it in the Report Definition view where it can be modified and saved by clicking the Save icon in the view toolbar.

Note that you cannot select the Personal Report Template / Public / Role Definition for Role/Organization radio buttons in the Storage tab for already saved report definitions.

Retrieving Reports via URI

After defining a report and saving this report definition for repetitive use, you may invoke reports based on that report definition via a URI interface, to embed the report with your web pages.

http://host:port/contextRoot/plugins/bpm-reporting/views/reportPanel.html?path=reportPath&parameter_parameterId1=parameterValue1&parameter_parameterId2=parameterValue2 ...

Hereby

For examples, the following URI

http://localhost:9090/server/plugins/bpm-reporting/views/reportPanel.html?path=/reports/Process%20Instances%20over%20Time.bpmrpt

executes and retrieves the public Report Definition Process Instances over Time.

Uploading Report Definitions

To upload a report definition to one of the report folders, right-click the folder and select Upload.

Upload report
Figure: Upload a report

A dialog opens, where you can browse to the report definition to upload.

Upload Report dialog
Figure: Upload Report dialog

Browse to the report definition and click Upload. Optionally add a file description and version comments.

If the file upload was successful, choose if you like to open the report document and click OK to close the dialog.

Upload the selected report
Figure: Upload the selected report

Using the Report Definition Context Menu

If you right-click a report definition, a context menu opens with the options to rename, delete, download or clone the report definition.

Report context menu
Figure: Report context menu

Renaming Report Definitions

You can rename a report definition by right-clicking it in the tree and selecting Rename.

Rename
Figure: Renaming a report definition

Deleting Report Definitions

To delete a report definition, right-click and select Delete.

Delete
Figure: Deleting a report definition

Downloading Report Definitions

Click Download to download a report definition.

Download
Figure: Downloading a report definition

Cloning Report Definitions

You can copy a report definition by right-clicking it and selecting the Clone option.

Clone
Figure: Cloning a report definition

A report definition with the same settings opens. Now you can edit and modify the report definition and change the name. The default proposed name for a cloned report definition is Copy <Report Definition Name>.

Cloned report definition
Figure: Cloned report definition

Viewing the Report Definition Description

Mouse over of the report definition entry in the tree to view the description of the report definition (if present) as tooltip. This displays the description which was added to a report in the Storage tab.

Description
Figure: Report definition tooltip

Adding a Report to your Favorite Reports

In case your report instance is already saved, you can add the currently open report to your Favorite Reports selection. Click the Add to Favorite Reports icon in the toolbar on the upper right side of the Report Definition view.

Add to Favorite Reports
Figure: Adding the report to your Favorite Reports

Removing a Report from your Favorite Reports

To remove the currently open report from your Favorite Reports, click the Remove from Favorite Reports icon in the toolbar on the upper right side of the Report Definition view.

Remove from Favorite Reports
Figure: Removing the report from your Favorite Reports

Creating Report Instances

To save report instance, click the Save Report Instance Save Report Instance Button icon in the toolbar on the upper right side of the Report Definition view.

Save Report Instance Button
Figure: Click button to save the report instance

A dialog opens to specify the name and the storage location for the report instance. This dialog does not open for already saved report definitions as specifying a new storage location is not supported.

Save Report Instance
Figure: Saving a Report Instance

The storage location provides the following options:

Click Save to save the report instance with the given settings. A success notification displays on top of the dialog if the save process was successful.

Success Notification
Figure: Success Notification

If the save process is completed, close the dialog by clicking Close. If you choose Close without saving the report instance before, the process is canceled.

The runtime timestamp will be appended to the file name to insure unique file names. The report is added to the Ad Hoc Reports folder in the location specified. Note that creating report instances does not affect the report definition!

Saving Report Definitions

To save the currently open report, click the Save Save Report Instance Button icon in the toolbar on the upper right side of the Report Definition view.

Save Report Button
Figure: Click button to save the report

A success notification displays on top of the view if the save process was successful.

Success Notification
Figure: Success Notification

If an already existing report is saved with modifications, a new version of the report is created and it is saved to the original location.

The report definition is saved to a specific folder in the document repository. By default, report definitions are stored globally. You can change how your report definition is stored in the Storage tab view. Please refer to chapter Storing Report Definitions for details on the provided storage settings.

Note
Report definitions that are not explicitly saved are considered as "ad hoc" reports and will be discarded at the end of the browser session.