Managing Report Definitions

• Adding Report Definitions
• Editing Report Definitions
• Retrieving Reports via URI
• Adding a Report to your Favorite Reports
• Removing a Report from your Favorite Reports
• Saving Report Instances
• Saving Report Definitions

Adding Report Definitions

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

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

• define your data sources in the Data Sources tab,
• define the way data sets are retrieved from these data sources in the Data Set tab,
• specify the layout of the report in the Layout tab,
• (pre)view the result in the Preview tab,
• store the previous configurations as a Report Definition for future use in the Storage tab and
• schedule Report Definitions for repetitive execution in the Scheduling tab.

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.

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

• host is
• port is
• contextRoot is
• reportPath is
• parameterIdN is the path of the parameter, e.g.
• parameterValueN is the value to be used for the corresponding parameter in the report execution.

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.

Adding a Report to your Favorite Reports

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.

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.

Figure: Removing the report from your Favorite Reports

Saving Report Instances

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

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.

Figure: Saving a Report Instance

The storage location provides the following options:

• Personal Report - for
• Globally Available - for public location
• Report for Role/Organization

Saving Report Definitions

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

Figure: Click button to save the report

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. Refer to chapter Storing Report Definitions for details.

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.