Storing Report Definitions

In the Storage Tab you can save the Report Definition for repetitive use.

Storage Tab
Figure: Storage Tab

A name must be supplied when saving the Report Definition. Enter a report name in the Save this Report Definition with name entry field. Note that the / character is not supported for Report Definition names!

Optionally, a description may be supplied in the Description text area.

To save the report definition, click the Save Save Report Instance Button icon in the toolbar. Please refer to section Saving Report Definitions of chapter Managing Report Definitions for details on saving report definitions.

How Report Definitions are stored

Once the Save button in the Report Definition view is clicked, the Report Definition is saved to a specific folder in the document repository.

By default, Report Definitions are made available globally. For example, everyone with access to the Reporting perspective has access. This access may be limited to the logged-in user only, or to a specific organization, role, or department.

Note that the storage selection section only appears for not yet saved report definitions.

Personal Report Definition Storage

When the Personal Report Definition storage option is selected, the Report Definition is limited to this user and it will appear in the Personal Report Definitions folder in the My Reports tree.

It will also be accessible in the Personal Reports folder in the Report Manager view.

Public Report Definition Storage

The Global Report Template storage option provides unrestricted access. For example everyone with access to the Reporting perspective has access.

The Report Definition will appear in the Public Report Definitions folder in the My Reports tree and also in the Public Reports folder in the Report Manager.

Participant-Specific Report Definition Storage

The Report Definition for Role/Organization storage option allows you to specify the organization, role or department to limit access to.

Select Role or Organization
Figure: Select Role or Organization

Note that if limiting the access by a participant, only one organization, role or department may be selected.

The Report Definition will appear as top level folder in the My Reports tree named for each participant. e.g., Role1 Report Definitions.

In the Report Manager, these reports will appear in separate folders under the top level Reports folder.

Report Definition Format

Report Definitions are stored in ASCII files with serialized JSON content. The file extension is .bpmrptdesign (BPM Report).

Report and Report Instance Storage Locations

Report and report instances Report definitions are stored with the file extension .bpmrptdesign (BPM Report). The file extension for report instances is .bpmrpt.

Viewing saved Reports and Report Instances

The following sections of the portal provide access to saved reports or report definitions:

See the following table for an overview on which reports and report definitions are displayed in which views and folders accordingly:

Type Storage Option Reporting - My Reports Control Center - Report Manager Workflow Execution - My Documents

Report Definition

Personal Report Definition

Personal Report Definitions/report_definition_name.bpmrptdesign Reports/Report Definitions/Personal Report Definitions/report_definition_name.bpmrptdesign My Documents/Reports/Private Report Definitions/report_definition_name.bpmrptdesign
 

Public Report Definition

Public Report Definitions/report_definition_name.bpmrptdesign

Reports/Report Definitions/Public Report Definitions/report_definition_name.bpmrptdesign

Not Shown
 

Role / Org Report Definition

participant_name Report Definitions/report_definition_name.bpmrptdesign Reports/Report Definitions/participant_name/report_definition_name.bpmrptdesign Not Shown

Report Instance

Personal Report Definition

Not Shown

Reports/Saved Reports/Private Reports/report_definition_name/ report_definition_name-timestamp.bpmrpt

Ad Hoc:

Reports/Saved Reports/Private Reports/Ad Hoc Reports/ report_definition_name-timestamp.bpmrpt

My Documents/Reports/Saved Reports/report_definition_name/ report_definition_name-timestamp.bpmrpt
 

Public Report Definition

Not Shown

Reports/Saved Reports/Public Reports/report_definition_name/report_definition_name-timestamp.bpmrpt

Ad Hoc:

Reports/Saved Reports/Public Reports/Ad Hoc Reports/report_definition_name-timestamp.bpmrpt

Not Shown
 

Role / Org Report Definition

Not Shown

Reports/Saved Reports/{modelID}participant_name/report_definition_name/report_definition_name-timestamp.bpmrpt

Ad Hoc:

Reports/Saved Reports/participant_name/Ad Hoc Reports/>report_definition_name-timestamp.bpmrpt

Not Shown

Repository Location

The following table gives an overview on the repository location of stored reports and report instances:

Type Storage Option JCR Location 

Report Definition

Personal Report Definition

/realms/<realmId>/users/<account>/documents/reports/designs/<report_definition_name>.bpmrptdesign
 

Public Report Definition

/reports/designs/<report_definition_name>.bpmrptdesign
 

Role / Org Report Definition

/reports/<{modelID}participantId>/designs/<report_definition_name>.bpmrptdesign

Report Instance

Personal Report Definition

/realms/<realmId>/users/<accountId>/documents/reports/saved-reports/<report_definition_name>/<report_definition_name-YYYYMMdd-hhmmss>.bpmrpt

Ad Hoc:

/realms/<realmId>/users/<accountId>/documents/reports/saved-reports/ad-hoc/<report_definition_name-YYYYMMdd-hhmmss>.bpmrpt
 

Public Report Definition

/reports/saved-reports/<report_definition_name>/<report_definition_name-YYYYMMdd-hhmmss>.bpmrpt

Ad Hoc:

/reports/saved-reports/ad-hoc/<report_definition_name-YYYYMMdd-hhmmss>.bpmrpt
 

Role / Org Report Definition

/reports/<{modelID}participantId>/saved-reports/<report_definition_name>/<report_definition_name-YYYYMMdd-hhmmss>.bpmrpt

Ad Hoc:

/reports/<{modelID}participantId>/saved-reports/ad-hoc/<report_definition_name-YYYYMMdd-hhmmss>.bpmrpt

These repository locations can be viewed in the Document Repository view in the Administration Perspective. Refer to chapter Viewing and Managing Document Repository Resources for details on the according folders.