The runtime facilities of the Business Analysis and Reporting Component
are deployed as a Web application in the
The content of the carnot-reporting.war file are the following directories:
To add your license place the carnot.license file to the
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.
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.
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.
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:
In case you use a partition other than the default one, you also have to add the partition Id like in the following examples:
Please refer to the section Specifying Partitions of the chapter Installation for detailed information.
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:
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.
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>
To integrate default carnot-reporting.war with canot.ear on JBoss 5.1, perform the following steps:
<resource-env-ref> <resource-env-ref-name>jdbc/AuditTrail.DataSource</resource-env-ref-name> <jndi-name>java:/AuditTrail.DataSource</jndi-name> </resource-env-ref>
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
misses the prefix reports/carnot/. The correct link here should be:
To access the report link you can either: