Table of Contents

Import New Reports

Stages supports metrics and reports by integrating the BIRT system. Typically these reports are designed and sent by the Method Park team. However, if desired there is also report training available.

Create Report element

To upload a new report navigate to Reports.

To add a new report element, you can either click on ‘Add Report’ or the + symbol.

Upload Report Design File

Click on the new Report element. Either the ADD button is pressed and a new rptdesign-file can be uploaded or the drag and drop feature can be used.

Reporting (Advanced)

Security restrictions

Access to persistent global variables is not allowed for reports in Stages, due to security implications. E.g.

reportContext.setPersistentGlobalVariable(name, value)
reportContext.getPersistentGlobalVariable(name)
reportContext.deletePersistentGlobalVariable(name)

Use global variables instead:

reportContext.setGlobalVariable(name, value)
reportContext.getGlobalVariable(name) 
reportContext.deleteGlobalVariable(name)

The access of custom event handler scripts to BIRT and other Java classes is highly restricted to keep the Stages server secure. In case additional classes need to be whitelisted there are errors logged that the system does not allow the access to those classes.

In case the security implications are acceptable, add the following parameter to the reporting context in the server.xml and adapt the value accordingly.

<Context path="/reporting" [...]>
   [...]  
   <Parameter name="metrics.script.class.whitelist" value="java.time.Instant,java.time.Duration" override="false"/>
</Context>

To whitelist additional classes for Stages data source scripts add the following config property to config.xml.

<property name="metrics.script.class.whitelist" value="java.time.Instant,java.time.Duration"/>

Direct database access in reports

The database driver that is installed in
<Stages Installation Folder>/lib/

must also be installed in
<Stages Installation Folder>/tomcat/webapps/reporting/WEB-INF/lib/

In the report (.rptdesign file), the database connection properties should be equal to those in database.properties (JDBC connection string, user name, password)