- Source repository: https://svn.jboss.org/repos/jbpm/projects/report-server/trunk
Anonymous access: http://anonsvn.jboss.org/repos/jbpm/projects/report-server/trunk/
- Forum: jBPM Developer Forum , JBoss GWT Developer
- BIRT Homepage: http://www.eclipse.org/birt
- BIRT version: The report server depends on BIRT 2.2.2
The report server is a small integration layer for the BIRT runtime. The project is used to embed BIRT reports in the jBPM GWT console, but could used with other projects as well.
Dependency on the BIRT ReportEngine
The report server is actually just a thin integration layer. It depends on the BIRT ReportEngine, which has to be installed along with the server. The report engine can either be picked from the BIRT website or retrieved as a maven artifact from the JBoss repository:
<dependency> <groupId>org.eclipse.birt</groupId> <artifactId>report-engine</artifactId> <type>zip</type> <version>2.2.2</version> </dependency>
JBoss AS integration
The main server module (report-server.war) can just be dropped into the AS deploy folder. Report templates, the ReportEngine and other resources go into the BIRT working directory (refered to as $WORK_DIR):
Working directory layout and contents
$WORK_DIR/ |_ ReportEngine/ (the BIRT report engine) |_ output/ (report results, *.html, *.pdf) |_ *.rptdesign (report templates)
NOTE: Since jBPM 3.3.1.GA the report server, including templates and the report engine is setup through the jBPM installer. In previous version you may need to do that manually.
The report server offers access to reports through HTTP. The default web context is '/report-server/' and reports can be retrieved using the '/view/<report_template_name>.rptdesign' resource, i.e:
Passing report parameters
The '/view' resource accepts an arbitrary list of url encoded HTTP GET parameters, which will be passed to the BIRT runtime upon report generation:
NOTE: A complete list of available resources and options can be seen at /report-server/index.html
Developing report templates
Report templates are developed and customized using the BIRT designer (eclipse tool). For further information see BIRT webpage.
Here are some quickstart links:
Customizing the default reports
The default report templates that are used with the GWT console reside with the GWT console server module. If you want to extend or customize the default reports that ship with jBPM you could as well retrieve them from the JBoss maven repository:
<dependency> <groupId>org.jbpm.jbpm3</groupId> <artifactId>gwt-console-server</artifactId> <classifier>report</classifier> <version>1.0.0-SNAPSHOT</version> <type>zip</type> </dependency>
How do I change the datasource configuration?
If your report design contains a JDBC data source defined with both JDBC Driver URL and JNDI name, then JNDI service will be used first and JDBC driver will be used as fallback. The username and password properties, if specified, are used in both cases. When you need to ensure that JNDI service is really used, increase logging level of BIRT engine; in case of JDBC fallback you will see JNDI lookup errors in the logs.
(Taken from BIRT FAQ)
How to replace the default report templates?