Deploying Reports

Runtime Environment

The runtime facilities of the Business Analysis and Reporting Component are deployed as a Web application in the carnot-reporting.war file. This Web application can be deployed to any Java EE complaint Web application server (e.g. JBoss, Tomcat or WebLogic). The WAR file can be achieved via predefined deployment configurations provided by Stardust. For details on these configurations refer to section Preconfigured Deployment Configurations of chapter Installation Packages in the Installation Guide.

WAR File

The content of the carnot-reporting.war file are the following directories:

war content

To add your license place the carnot.license file to the WEB-INF/classes folder of the carnot-reporting.war.

The reports directory may contain arbitrary report designs and report libraries. The directory contains the subdirectory carnot, containing all sample reports of the Stardust Business Analysis and Reporting Component. You may add arbitrary report designs and libraries of your own to the report directory (see below).

After deploying this WAR file to your Web application server, you will be able to retrieve reports via a Web browser or any other HTTP client.

Data Source Definition

While defining a Stardust Process Database data source, you may specify a data source JNDI name in addition to the regular JDBC database connection parameters (driver class name, database URL, user, password). This data source JNDI name is used in a managed environment like a Web application server to bind predefined data sources and this way obtain the management services for such a data source (e.g. pooling) from the Web application server.

Process Database Data Source

Note, that your data source JNDI name has to be the fully qualified name of the data source. For example on JBoss for the data source definition

<local-tx-datasource>
   <jndi-name>TestDB</jndi-name>
   <connection-url>jdbc:derby:net://localhost/carnot</connection-url>
   <driver-class>com.ibm.db2.jcc.DB2Driver</driver-class>
   <user-name>carnot</user-name>
   <password>ag</password>
   <min-pool-size>5</min-pool-size>
</local-tx-datasource>

you must use the data source name java:/TestDB. Please consider the documentation of your Web application server for details.

If the data source with the specified name cannot be bound, the regular JDBC connection parameters are used instead without further error messages or warnings except notification in the carnot-reporting.log file.

Adding User-Defined Reports

To add your own reports to a runtime environment, unpack the carnot-reporting.war file and place your reports in an arbitrary subdirectory of the report directory. (Re)pack your carnot-reporting.war file and (re)deploy it to your Web application server. The added report designs can now be accessed by the report retrieval URLs.

When deploying with defaults, your Web context will be carnot-reporting. To call your first default report, you must use a URL as shown in the following examples:

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

or

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

Using Non-Default Partitions

In case you use a partition other than the default one, you also have to add the partition Id like in the following examples:

http://localhost:8080/carnot-reporting/frameset/<partition-id>?__report=reports/carnot/MonitoringOverview.rptdesign

or

http://localhost:8080/carnot-reporting/run/<partition-id>?__report=reports/carnot/MonitoringOverview.rptdesign

Please refer to the section Specifying Partitions of the chapter Installation for detailed information.

Accessing the Reporting URL after Deployment in an External Environment

Download one of the Maven archetype templates from the Stardust artifactory matching your requirements. Refer to chapter Creating a Stardust Runtime Environment with Apache Maven in the Stardust Installation Guide for details.

To access the reporting URL after a deployment in an external environment, you have to integrate the carnot-reporting.war file into the ipp-portal.war file. Therefore perform the following steps:

  1. Unzip the carnot-reporting.war file.
  2. Unzip the ipp-portal.war.
  3. Copy all files and folders from the unpacked carnot-reporting.war file to the ipp-portal.war except the following:
  4. Additionally copy all files residing in the WEB-INF/lib folder of the carnot-reporting.war except commons-discovery-0.2.jar to the WEB-INF/lib folder of the portal war file.
  5. Now copy the following complete folders:
  6. Also copy the following files:
  7. Finally merge the web.xml file, residing in the WEB-INF folder of the reporting war with the web.xml file in your portal war file. Therefore copy all context parameters except <display-name>: Also, change the document type definition in the DOCTYPE to version 2.4 (web-app_2_4.dtd).

Note that if the database user is other than 'carnot', then edit the user in the "CARNOT-ds-library.rptlibrary" file found at "ipp-portal.war\reports\carnot".

For example: The database user is 'carnot01', then the HOME property of datasource should be edited as shown in the following section:

<property name="HOME">;;java:comp/env/jdbc/AuditTrail.DataSource;;;carnot01;;;
org.eclipse.stardust.reporting.common.calendarBasedWorktimeCalculator;</property>

Note that to deploy in EJB environment, perform the above steps in carnot.ear/ipp-portal.war file.

WebLogic Deployment

In case of a WebLogic deployment you need to merge the weblogic.xml from the ipp-reporting.war file with your weblogic.xml file. Copy the following parameter:

<reference-descriptor>
      <resource-description>
        <res-ref-name>jdbc/AuditTrail.DataSource</res-ref-name>
        <jndi-name>AuditTrail.DataSource</jndi-name>
      </resource-description>
    </reference-descriptor>
<container-descriptor>
    <prefer-web-inf-classes>true</prefer-web-inf-classes>
</container-descriptor>    

JBoss Deployment

To integrate default carnot-reporting.war with canot.ear on JBoss 5.1, perform the following steps:

  1. Copy the following code snip in the carnot.ear/ipp-portal.war/WEB-INF/jboss-web.xml:
    	<resource-env-ref> 
    	<resource-env-ref-name>jdbc/AuditTrail.DataSource</resource-env-ref-name> 
        <jndi-name>java:/AuditTrail.DataSource</jndi-name> 
      	</resource-env-ref> 
    	
  2. Add jcl-over-slf4j-1.5.3.jar to carnot.ear/ipp-portal.war/WEB-INF/lib

Reporting URL access problems

In case you have deployed your report in an external environment, problems might occur in accessing the reporting URL. The relative links to reports are not generated correctly by Birt when using standalone servers and thus cannot be found.

For example, the generated link

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

misses the prefix reports/carnot/. The correct link here should be:

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

To access the report link you can either: