Sample Reports and Library

Installation Location

The Stardust sample reports, the Stardust libraries and the file sampleReports.properties are installed in the following Stardust Eclipse plugin:

eclipse/plugins/org.eclipse.stardust.reporting.reports.core_x.x.x.x/reports/carnot

To preview the sample reports, copy the contents of this directory to your Eclipse Report Project Directory.

The Stardust Libraries

The main purpose of a library is to provide report developers with a shared repository of pre-designed report elements. The Stardust sample reports often use similar report elements (especially data sources). Thus they all make use of two libraries: CARNOT-ds-library.rptlibrary and CARNOT-library.rptlibrary.

The data sources used by the sample reports are defined in the file CARNOT-ds-library.rptlibrary. This file has to be adapted to your individual configuration.

Note that the JNDI name has to be set properly according to the application server you use. For example JBoss requires java:/<name>, whereas WebSphere directly uses the JNDI name.

CARNOT-library.rptlibrary contains a collection of predefined data sets, report parameters, report items and the Stardust theme. The data sources defined in this library are extensions of the data sources in CARNOT-ds-library.rptlibrary. These data sources should not be altered as changes will override the settings in CARNOT-ds-library.rptlibrary.

Predefined Data Sources

The Stardust Library contains three predefined data sources:

Stardust Parameters

The data source Stardust Parameters provides a row with the URL to the diagram servlet.

This value can be overwritten by Java parameters, for example with the -vm option when starting Eclipse:

-DINFINITY_REPORTING_DIAGRAM_BASE_URL=http://domain/eclipse/servlet/DiagramServlet

or by setting the servlet-init-parameter INFINITY_REPORTING_DIAGRAM_BASE_URL in the web.xml file.

This servlet init parameter is evaluated and stored. The key is the same as the java parameter mentioned above.

You can use pattern to be evaluated when using the parameter, for example:

..${LIVE_DIAGRAMS_URL}

The context parameter ag.carnot.processportal.integration.LIVE_DIAGRAMS_URL is read and used to replace ${LIVE_DIAGRAMS_URL} with the value of the servlet-init-parameters.

Using Report Parameters in Data Set Parameters and Filters

Configuration of Data Sources

To use the sample reports with your own Stardust Model and Audit Trail, the data source settings inside the library CARNOT-ds-library.rptlibrary must be adapted to your specific configuration.

Now adapt the library setting to your individual configuration:

Read the chapter Configuring Stardust ODA Data Sources for closer information on the settings in these dialogs.

Exploring and Using the Stardust Library for your own Reports

The Eclipse view Resource Explorer can be used to explore the elements of the CARNOT Library without opening the library file itself. If no entry CARNOT Library is available, make sure the files CARNOT-library.rptlibrary and CARNOT-ds-library.rptlibrary are inside the library resource folder and visible inside the Resource Explorer.

To use the CARNOT Library:


Figure: Use the Stardust Library.

To use a library element, simply drag it from the Resource Explorer to the Outline view of your report. Report items can be dragged and dropped directly on the desired position of your report.

Data Sets

The library contains a collection of predefined data sets. Many of these data sets are used in the sample reports. As their parameters can be overwritten inside a particular report, they provide an easy way to quickly make the desired data available in a report. Data sets can either be dragged and dropped to the Data Sets section of a report or on the report itself. When dropped onto a report, a table for the data set is generated and the data set is added to the outline automatically.

Report Parameters

The predefined report parameters from the Stardust Library can be used like other parameters. To add a parameter to your report, simply drag it from the Resource Explorer to the Report Parameters section of a report's outline.

Report Objects

The Stardust Library contains some predefined reports objects you might find useful for your own reports. They can be used by dragging them from the Resource Explorer onto a report.The data sets used by the report objects will be imported automatically but will not become visible inside the Outline view of the using report. Report parameters used by a report object and respectively its data sets are not automatically added to the report. Thus, when using a report object from the Stardust Library in your own reports, make sure all parameters accessed by it and its data sets are available inside your report. You can either import the report parameters provided by the library or create your own.

Themes

The Stardust Library includes one theme containing all cascading style sheets used in the Stardust sample reports. To use this theme in a report, the report has to use the Stardust Library (select report, open view Resource Explorer, right-click on library - use library). To add the theme to the report:


Figure: Apply a Theme to the Report.

After the theme has been applied to a report, all its styles become available in this report.

Sample Reports

The Stardust Sample Reports are organized in three categories:

Each category includes an overview report accessible from every sample report in the collection via links in its header.


Figure: The Stardust sample reports and their hierarchical arrangement.

Setting Report Parameters

Model, Process OID and Activity Instance OID

To set your report parameters for Model, ProcessOID and Activity Instance OID, use the wildcards presented as default:

Wildcard for Parameters

ProcessID

The entry field for the ProcessID provides you with a drop-down list to choose the process or the predefined wildcard .* mentioned in the previous section.

Parameter entry field for ProcessID

You also have the option to enter a process ID directly:

Parameter entry field for ProcessID

ActivityID

The entry field for the ActivityID provides you with a drop-down list to choose the activity or the predefined wildcard .*.

Parameter entry field for ActivityID

You also have the option to enter an activity ID directly:

Parameter entry field for ActivityID

RoleID

The entry field for the Role ID provides you with a drop-down list to choose the role or the predefined wildcard .*.

Parameter entry field for Role ID

You also have the option to enter a Role ID directly:

Parameter entry field for Role ID

DataID

The entry field for the Data ID provides you with a drop-down list to choose the data or the predefined wildcard .*.

Parameter entry field for Data ID

You also have the option to enter a Data ID directly:

Parameter entry field for Data ID

Date Time Parameters

Use the date format YYYY-MM-dd hh:mm:ss.

Wildcard for Parameters

Quality Assurance Report Parameters

Quality Assurance report specific parameters are:

Wildcard for Parameters

User account

In the Select user account section, you can either:

The Quality Assurance Report now considers the activity instances performed by these users.

Process

In the Select process you can select a process in the drop-down list, where all processes where quality assurance was performed are provided.

Activity

In the Select activity you can select an activity in the drop-down list, where all quality assurance activities are provided.

Interval

The Select interval drop-down list provides a list to filter for specific periods like:

Select Interval
Figure: Select Interval