Administrator Administrator [http://community.jboss.org/people/admin] modified the document: "BPM Console - Reporting" To view the document, visit: http://community.jboss.org/docs/DOC-13191 -------------------------------------------------------------- h1. Project information * Source repository: https://svn.jboss.org/repos/jbpm/projects/report-server/trunk https://svn.jboss.org/repos/jbpm/projects/report-server/trunk Anonymous access: http://anonsvn.jboss.org/repos/jbpm/projects/report-server/trunk/ http://anonsvn.jboss.org/repos/jbpm/projects/report-server/trunk/ * Forum: http://www.jboss.com/index.html?module=bb&op=viewforum&f=219 jBPM Developer Forum , JBoss GWT Developer (http://www.jboss.com/index.html?module=bb&op=viewforum&f=295) * BIRT Homepage: http://www.eclipse.org/birt http://www.eclipse.org/birt * BIRT version: The report server depends on *BIRT 2.2.2* h3. Overview 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. *http://community.jboss.org/servlet/JiveServlet/showImage/102-13191-15-1099/rendering.jpg http://community.jboss.org/servlet/JiveServlet/downloadImage/102-13191-15... h2. 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>    h2. *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): $JBOSS_HOME/server/<config>/data/birt h3. Working directory layout and contents $WORK_DIR/ |_ ReportEngine/          (the BIRT report engine) |_ output/                    (report results, *.html, *.pdf) |_ *.rptdesign               (report templates)  h2. Rendering reports 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: GET http://localhost:8080/report-server/rs/view/process_activity.rptdesign h3. 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: GET /report-server/rs/view/definition_report.rptdesign&name=MySampleProcess h2. Developing report templates Report templates are developed and customized using the BIRT designer (eclipse tool). For further information see http://www.eclipse.org/birt BIRT webpage. Here are some quickstart links: * *http://www.eclipse.org/birt/phoenix/intro/ BIRT introduction* * *http://download.eclipse.org/birt/downloads/examples/reports/2.1/tutorial/tutorial.html Tutorial (Flash movie)* * *http://www.eclipse.org/birt/phoenix/build/ Installation of the BIRT tools* h3. 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> h2. *FAQ* h4. 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 http://wiki.eclipse.org/index.php/BIRT/FAQ/Data_Access#Q:_What_data_sourc... BIRT FAQ) h4. How to replace the default report templates? -------------------------------------------------------------- Comment by going to Community [http://community.jboss.org/docs/DOC-13191] Create a new document in jBPM at Community [http://community.jboss.org/choose-container!input.jspa?contentType=102&am...]