Installation

BIRT Installation

Please refer to the Stardust Release Notes for details on the Birt version the current release of the Stardust Reporting Component relies on. If you do not use the pre-installed BIRT version of Stardust, please refer to the corresponding Birt Installation Guide.

Distribution Content

The distribution of the Stardust Reporting Component contains:

Installing the Design Environment

Please install the Stardust components as described in the Stardust Installation Guide. The features and the corresponding plug-ins should be listed in your Eclipse plug-in details after restarting Eclipse with the -clean option.

Installing the Runtime Environment

To create, preview, generate, view or export reports from within the design environment, it is not necessary to install a runtime environment.

The runtime environment is provided as a Web application archive carnot-reporting.war. This WAR is placed in the directory %CARNOT_HOME%/webapps/deploy, in case you set up a working environment, as described in the Stardust Installation Guide. Deploy this file to your application server.

To load your license file, place it in the classpath of the carnot-reporting.war. You can either put it in WEB-INF/classes inside the war, or in some application server directory that is also visible in the classpath.

The file web.xml in the WEB-INF folder inside the carnot-reporting.war provides additional options:

Depending on your configuration and your application sever it can be necessary to configure the class loading mechanism to load the WAR's classes first, e.g. on IBM WebSphere 7 set the application's class loader mode to "PARENT LAST" and its class loading policy to "application").

To run reports from inside your application server the Stardust Audit Trail database should be accessible via a JNDI name. If you already have installed the Stardust Process Engine (carnot.ear) and thus have configured the corresponding data sources for your application server, no further configuration is required. Otherwise, please refer to your application server's manuals on how to register a data source with the JNDI naming service.

The chapter Report Viewing explains how to view reports inside your browser. To check whether the deployment of the WAR has been successful, you can use one of the Stardust sample reports. These sample reports are deployed inside the WAR file in the directory /reports/carnot. In order to run sample reports, you have to adapt some settings inside the library file CARNOT-ds-library.rptlibrary which can be found in the same location as the reports. For more information on this task, read the section The Stardust libraries in the chapter Sample Reports.

After you have changed the CARNOT-ds-library.rptlibrary file, make sure you publish the CARNOT-ds-library.rptlibrary and the CARNOT-library.rptlibrary file to the library and refresh the library afterwards. To do this go to the Report Design perspective in your Eclipse workbench. Then proceed as described here:

Specifying Partitions

There are different possibilities to specify partition IDs. You can specify them explicitly for the reporting datasources, but you also have the option to define them by setting an init parameter CARNOT_PARTITION in the web.xml file. The URL will be handled differently then.

The URL

http://localhost:8080/carnot-reporting/frameset?__report=....

will be processed with the following servlet and servlet-mapping, specified in the web.xml file residing in your WEB-INF folder:

<servlet>
   <servlet-name>ViewerServlet</servlet-name>
   <servlet-class>org.eclipse.stardust.reporting.app.web.servlet.ViewerServlet</servlet-class>
   <init-param>
      <param-name>INFINITY_REPORTING_DIAGRAM_BASE_URL</param-name>
      <param-value>..${LIVE_DIAGRAMS_URL}</param-value>
   </init-param>
</servlet>

<servlet-mapping>
   <servlet-name>ViewerServlet</servlet-name>
   <url-pattern>/frameset/*</url-pattern>
</servlet-mapping>

<servlet-mapping>
   <servlet-name>ViewerServlet</servlet-name>
   <url-pattern>/run/*</url-pattern>
</servlet-mapping>

Please make sure that the URL patterns set for the ViewerServlet end with /*, so that it is possible to use an extended URL when calling your report.

With this configuration the partitions defined in the reporting data sources will be used.

The URL pattern:

<url-pattern>/frameset/*</url-pattern>

offers the possibility to define the partition in the URL. For example:

http://localhost:8080/carnot-reporting/frameset/partition1?__report=....

In this case "partition1" will be used as ID of the partition to work with, if there is no partition explicitly set for the reporting datasources.

To specify partitions in the web.xml file, there is also the option to use a servlet init parameter, as shown in the following snippet:

<servlet>
   <servlet-name>ViewerServletForPartitionX</servlet-name>
   <servlet-class>org.eclipse.stardust.reporting.app.web.servlet.ViewerServlet</servlet-class>
   <init-param>
      <param-name>CARNOT_PARTITION</param-name>
      <param-value>PartitionX</param-value>
   </init-param>
</servlet>

<servlet-mapping>
   <servlet-name>ViewerServletForPartitionX</servlet-name>
   <url-pattern>/frameset/Application123</url-pattern>
</servlet-mapping>

Here the partition ID "PartitionX" is used in the following URL:

http://localhost:8080/carnot-reporting/frameset/Application123?__report=....

This is only the case, if there is no partition set explicitly for the reporting datasources.

It is possible to configure several servlets in such a way.

The specification of the partition ID works with the following rules:

The same proceeding is done for run:

http://localhost:8080/carnot-reporting/run?__report=....