Create new JBoss Tools Documentation Jira issue
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.
JBoss.orgCommunity Documentation
BIRT plugin is an Eclipse-based open source reporting system for web applications based on Java and J2EE. BIRT consists of two main components: a report designer based on Eclipse, and a runtime component that can be added to your app server. BIRT also offers a charting engine that lets you add charts to your own Web application.
With the help of BIRT you can generate a great number of reports to be used in your application:
Lists
Charts
Crosstabs, or cross-tabulation, or matrix
Letters and Documents
Compound Reports
You can find more detailed information on the BIRT plugin, its report types and anatomy on the BIRT Homepage.
To understand the basic BIRT concepts and to know how to create a basic BIRT report, refer to the Eclipse BIRT Tutorials. What extensions JBoss Tools provides for Eclipse BIRT you'll find out in the next sections.
For a start, we propose you to look through the table of main features of BIRT plugin:
Table 1.1. Key Functionality for BIRT Plugin
| Feature | Benefit | Chapter |
|---|---|---|
Integration with Seam | You can add a BIRT report to an .xhtml file or embed it in some Seam .xhtml page. | integration with Seam |
Hibernate ODA Data Source | Hibernate ODA Data Source for the JBoss BIRT Integration feature is completely integrated with Hibernate Tools. | Hibernate ODA data source |
This reference guide describes the one module of the JBoss Tools project which performs the integration with BIRT. The integration includes the following functionalities:
Hibernate ODA driver that includes a dialog to create HQL queries with syntax-highlighting, content-assist, formatting as well as other functionalities available in the HQL editor. There is also a possibility to add parameters.
possibility to add JBoss BIRT functionality to the standard Seam web project
BIRT JSF/Seam control
deployment of BIRT reports within web projects (Seam, JSF, etc.)
To enable JBoss Tools integration with BIRT you are intended to have the next:
Eclipse with JBoss Tools installed (how to install JBoss Tools on Eclipse, what dependences and versions requirements are needed reed in the JBoss Tools Installation section)
BIRT Report Designer (BIRT Report Designer 2.3.2 you can download from Eclipse downloads site)
BIRT Web Tools Integration ( BIRT WTP Integration 2.3.2 you can download from Eclipse downloads site)
Versions of BIRT framework and BIRT WTP integration should be no less than RC4 in order to the BIRT facet works correctly.
All JBoss Developer Studio/JBoss Tools release documentation you can find athttp://docs.jboss.org/tools in the corresponding release directory.
The latest documentation builds are available at http://download.jboss.org/jbosstools/nightly-docs.