Stages Documentation

Creating Stages BIRT Reports: A Basic Example

This section explains how to create a basic BIRT report that extracts information from Stages.

Create a Report

  1. The BIRT RCP Designer is started by executing the birt.exe
  2. Select File –> New –> New Report from the drop-down menu
  3. Type the name for the report
  4. Select the path where the report file will be stored, and click Next
  5. Select Blank report, and click Finish

The new blank report will be opened on the right side.

Create a Stages Data Source

  1. Navigate to the Outline View on the lower left side and right-click on the Data Source entry and select New Data Source.
  2. Select Stages Data Source. Enter a name for the data source.
  3. Click Next.
  4. If you do not use the metrics.xml you need to specify the Stages server URL and enter a Stages username and password and click Finish.
    1. If you use the metrics.xml, it is necessary to insert a script for your Data Source. You will see the created Data Source in your BIRT Report Designer, click on Data Source and choose the “script tab” and the condition “beforeOpen”
  5. Insert the linked script and save it.

Create a Data Set

  1. Navigate to the Outline View on the lower left side and right-click on Data Set and select New Data Set.
  2. Select a name for the Data Set, and click Next.
  3. Enter the column names and data types
    1. Documentnamewith type string
    2. Statewith type String
  4. Click Next.
  5. Click Edit Script
  6. Enter the following script into the editor
var artifacts =
pkit.getCurrentProject().getEntities("containsProcess@SYSTEM")
[0].getEntities("containsArtifact@SYSTEM");
for (i = 0; i <artifacts.length; i++) {
 var artifacts_instances =
 artifacts[i].getEntities("containsInstance@SYSTEM");
 for (j = 0; j <artifacts_instances.length; j++) {
 var artifacts_revisions =
 artifacts_instances[j].getEntities("containsRevision@SYSTEM");
 if (artifacts_revisions.length == 0) {
dataset.setColumnValue("State", "no version");
 } else {
 dataset.setColumnValue("State",
 artifacts_revisions[0].getProperty("state"));
 }
 dataset.setColumnValue("DocumentName",
 artifacts_instances[j].getProperty("LogicalName"));
 dataset.storeResultRow();
 }
}

To finish the editing of the script, click OK.

Enter a Workspace Path in the text input field. The Workspace Path is the pipe separated path of workspace names in Stages. A report to be executed in the workspace Company –> Projects and Products –> System A –> Software Project A would need the Workspace Path to be set to Company|Projects and Products|System A|Software Project A.

  1. Note: The Workspace Path value is needed for the preview, if the script contains the statement pkit.getCurrentProject()…
  2. Click Finish to continue the data set configuration and click Preview Results to show a preview of the results.