This document describes how to get the BIRT source from CVS and build it under Eclipse. If you simply want to use BIRT, it is easier to simply download an existing build.
Building BIRT 2.1.1 is described below.
For the latest instructions, see the BIRT Wiki.
Download the BIRT all in one designer. It is listed under "Report Designer Full Eclipse Install" on the download page. It is possible to build BIRT with an existing Eclipse install, but this method is the quickest, as all the required files, with the exception of iText.jar and iTextAsian.jar are present.
The BIRT source code uses some features that are only present in JDK 1.4.2 or later. In order for it to successfully build you need to set your compiler compliance to 1.4. Make sure this is not set to 5.0. You can set this for the entire workbench as follows:
|org.eclipse.birt.chart.device.extension||Extension classes for the device renderer framework for charts|
|org.eclipse.birt.chart.engine||Chart model and factory classes|
|org.eclipse.birt.chart.engine.extension||Extension classes for the model renderer framework for charts|
|org.eclipse.birt.chart.reportitem||Classes for the chart module to interact with the BIRT designer and runtime engine|
|org.eclipse.birt.chart.shared||Classes shared between different components of the chart module|
|org.eclipse.birt.chart.ui||Chart builder UI classes|
|org.eclipse.birt.chart.ui.extension||Extensions for the chart builder UI|
|org.eclipse.birt.chart.device.extension||Chart engine extension plugin containing device renderers implementations (Swing, SWT, PNG, GIF, JPG, BMP)|
|org.eclipse.birt.chart.device.svg||Chart engine extension plugin containing SVG device renderer's implementation|
|org.eclipse.birt.converters||Contains converters that can convert reports from other formats to the BIRT report format|
|org.eclipse.birt.core||Provides the framework for loading the plugins at run-time and contains other classes that can be used by any other module|
|org.eclipse.birt.data||Provides the data engine implementation and the ODA factory implementation. It also contains classes for applying transformations on the data.|
|org.eclipse.birt.data.oda||ODA public interface: the classes and interfaces used to create data extensions.|
|org.eclipse.birt.data.oda.adapter.dtp||Adapter for Data Tools project|
|org.eclipse.birt.report.data.oda.flatfile||The ODA driver for accessing flat file data sources|
|org.eclipse.birt.report.data.oda.flatfile.ui||The user interface for the ODA flat file driver|
|org.eclipse.birt.data.oda.jdbc||The ODA driver for accessing JDBC data sources|
|org.eclipse.birt.data.oda.jdbc.ui||The user interface for the ODA JDBC driver|
|org.eclipse.birt.report.data.oda.sampledb||The ODA driver for accessing the sample Derby data base|
|org.eclipse.birt.report.data.oda.sampledb.ui||The user interface for the ODA sample database driver|
|org.eclipse.birt.data.oda.xml||The ODA driver for accessing XML data sources|
|org.eclipse.birt.data.oda.xml.ui||The user interface for the ODA XML driver|
|org.eclipse.birt.report.debug.ui||Used for creating launch configuration when debugging reports that contain Java events|
|org.eclipse.birt.report.designer.core||The core classes of the BIRT report designer, including classes that interact with the BIRT model, and localization and other utility classes|
|org.eclipse.birt.report.designer.lib||The classes used for library manipulation|
|org.eclipse.birt.report.designer.lib.explorer||Handles browsing and exploring library contents|
|org.eclipse.birt.report.designer.ui||The BIRT report designer|
|org.eclipse.birt.report.designer.ui.rcp||The BIRT RCP report designer|
|org.eclipse.birt.report.engine||The BIRT reporting engine that generates the report from a report design|
|org.eclipse.birt.report.engine.emitter.fo||The emitter for generating report output using FO|
|org.eclipse.birt.report.engine.emitter.html||The emitter that generates report output in HTML|
|org.eclipse.birt.report.engine.emitter.pdf||The emitter that generates report output in PDF|
|org.eclipse.birt.report.model||The BIRT report model|
|org.eclipse.birt.report.viewer||The BIRT report viewer (BIRT web app)|
|org.eclipse.birt-feature||The BIRT feature|
|Use Default Port||Selected|
A new node appears in the CVS Repositories window.
If your Eclipse environment is not setup to build automatically, build the source now. This designer should build correctly. If you wish to build the Web Viewer proceed to the next section. Do this if you wish to make changes to the deployable Web Viewer Example.
The viewer project contains an ant build script that builds the Web Viewer. When executed it will create a birt_web directory in the root of the viewer project. This directory can then be exported and deployed in a similar fasion to the Web Viewer example in the Report Engine download. To use this script, perform the following steps.
Start BIRT by running it as an Eclipse Application. This can be done as follows: