Reporting: Eclipse BIRT Driver

Table of Contents

39.1. Overview
39.2. How to use it
39.3. Tomcat integration HOWTO

39.1. Overview

BIRT is an open source Eclipse-based reporting system that integrates with Java/J2EE application to produce compelling reports. The BIRT driver for Nuxeo enables BIRT to be used as reporting engine for the Nuxeo Content Repository. It basically gives an easy way to query the repository and create report from the results. Thanks to BIRT, reports can be run inside Eclipse or as servlets on the server side.

39.2. How to use it

In a Eclipse instance with Business Intelligence and Reporting Tools installed (http://www.eclipse.org/birt/phoenix/), deploy the following Nuxeo plugins:

  • org.nuxeo.common

  • org.nuxeo.ecm.client

  • org.nuxeo.ecm.core.api

  • org.nuxeo.ecm.core.query

  • org.nuxeo.ecm.core.schema

  • org.nuxeo.ecm.jboss_connector

  • org.nuxeo.ecm.platform.search.api

  • org.nuxeo.ecm.platform.usermanager.api

  • org.nuxeo.logging

  • org.nuxeo.runtime

  • org.nuxeo.runtime.config

  • org.nuxeo.birt.oda.nuxeoep

  • org.nuxeo.birt.oda.nxueoep.ui

When eclipse is restarted a new "Data Source Should be available"

In the Data Source Type screen, select "Nuxeo Data Source":

Figure 39.1. In the Data Source Type screen, select "Nuxeo Data Source":


Fill login information

Figure 39.2. Fill login information


In the Data Set dialog, type NXQL query and select fields & schemas you would like to use in the report

Figure 39.3. In the Data Set dialog, type NXQL query and select fields & schemas you would like to use in the report


Data set is ready to be used in report

Figure 39.4. Data set is ready to be used in report


Figure 39.5. 


39.3. Tomcat integration HOWTO

The new created report can be deployed in Tomcat to be available online:

  1. Install the birt-viewer application following instruction from http://www.eclipse.org/birt/phoenix/deploy/viewerSetup.php

  2. Deploy the plugins listed in previous section (except org.nuxeo.birt.oda.nxueoep.ui) in $TOMCAT_HOME/webapps/birt-viewer/WEB-INF/platform/plugins

  3. Just copy the report file from workspace to $TOMCAT_HOME/webapps/birt-viewer/report

  4. The report is available with an URL similar to http://localhost:13000/birt-viewer/frameset?__report=report/dummy.rptdesign

    Figure 39.6.