Home > Store

Integrating and Extending BIRT, 2nd Edition

Register your product to gain access to bonus material or receive a coupon.

Integrating and Extending BIRT, 2nd Edition

eBook (Watermarked)

  • Your Price: $35.19
  • List Price: $43.99
  • Includes EPUB, MOBI, and PDF
  • About eBook Formats
  • This eBook includes the following formats, accessible from your Account page after purchase:

    ePub EPUB The open industry format known for its reflowable content and usability on supported mobile devices.

    MOBI MOBI The eBook format compatible with the Amazon Kindle and Amazon Kindle applications.

    Adobe Reader PDF The popular standard, used most often with the free Adobe® Reader® software.

    This eBook requires no passwords or activation to read. We customize your eBook by discreetly watermarking it with your name, making it uniquely yours.


  • Copyright 2009
  • Edition: 2nd
  • eBook (Watermarked)
  • ISBN-10: 0-13-279994-4
  • ISBN-13: 978-0-13-279994-2

The world-wide developer community has downloaded over three million copies of BIRT (Business Intelligence and Reporting Tools) from the Eclipse web site. Built on the open-source Eclipse platform, BIRT is a powerful reporting system that provides an end-to-end solution, from creating and deploying reports to integrating report capabilities in enterprise applications.

The second of a two-book series on business intelligence and reporting technology, Integrating and Extending BIRT, Second Edition introduces programmers to BIRT architecture and the reporting framework. BIRT technology makes it possible for a programmer to build a customized report using scripting and BIRT APIs. A programmer can also extend the BIRT framework by creating a new plug-in using the Eclipse Plug-in Development Environment. This book provides extensive examples on how to build plug-ins to extend the features of the BIRT framework. The source code for these examples is available for download.

The topics discussed include

  • Installing and deploying BIRT
  • Deploying a BIRT report to an application server
  • Understanding BIRT architecture
  • Scripting in a BIRT report design
  • Integrating BIRT functionality into applications
  • Working with the BIRT extension framework

This second edition, revised and expanded, adds the following new content
  • Updated architectural diagrams
  • Expanded scripting examples
  • Tag library descriptions
  • In-depth description of BIRT Web Viewer
  • Configuring BIRT to use a JNDI connection
  • XML report rendering plug-in example
  • Fragment plug-in localization example
  • Open Data Access (ODA) plug-in example implementing the new Data Tools Platform (DTP) design and run-time wizards

Sample Content

Table of Contents

Foreword               xix
Preface                   xxi
Acknowledgments               xxix

Part I: Installing and Deploying BIRT               1
Chapter 1: Prerequisites for BIRT                    3

Downloading Eclipse BIRT components             3
BIRT Report Designer software requirements            5
About types of BIRT builds              7

Chapter 2: Installing a BIRT Report Designer                9
Installing BIRT Report Designer Full Eclipse Install             9
Installing BIRT RCP Report Designer                  10
Troubleshooting installation problems                   11
Installing a language pack                 13
Updating a BIRT Report Designer installation              14
Updating BIRT RCP Report Designer installation                15

Chapter 3: Installing Other BIRT Packages                     17
Installing Chart Engine                      17
Installing BIRT Data Tools Platform Integration            19
Installing BIRT Demo Database                  19
Installing Report Engine                  21
Installing BIRT Samples                  23
Installing BIRT Source Code                23

Chapter 4: Deploying a BIRT Report to an Application Server           27
About application servers               27
Placing the BIRT report viewer on an application server               28
Placing fonts on the application server                     33
Viewing a report using a browser                    33
Using connection pooling on Tomcat                    34

Chapter 5: Using Eclipse BIRT Web Viewer                     39
Understanding Eclipse BIRT Web Viewer                        39
Understanding Web Viewer architecture                            44
Using the Web Viewer Deployment wizard                    61

Part II: Understanding the BIRT Framework                   81
Chapter 6: Understanding the BIRT Architecture           83

Understanding the BIRT integration                     83
About the BIRT applications                     87
About the BIRT engines and services                88
About the types of BIRT report items               90
About the Report Object Model (ROM)                  91
About the types of BIRT files                   91
About custom Java applications                93
About extensions to BIRT                       93

Chapter 7: Understanding the Report Object Model            95
About the ROM specification              95
About the ROM schema                       98
About the rom.def file                           98
About the primary ROM elements         101
About the report item elements               102
About the data elements                  103

Part III: Scripting in a Report Design                        105
Chapter 8: Using Scripting in a Report Design               107

Overview of BIRT scripting                        107
Events overview                   108
Event order sequence              115

Chapter 9: Using JavaScript to Write an Event Handler                        127
Using BIRT Report Designer to enter a JavaScript event handler                 127
Using the reportContext object                130
Using the this object                   135
Using the row object                   138
Getting column information                139
Getting and altering the query string                     140
Changing the connection properties of a data source                  140
Getting a parameter value                       141
Determining method execution sequence                    142
Tutorial 1: Writing an event handler in JavaScript                      144
JavaScript event handler examples                    149
Calling Java from JavaScript                        151
Calling the method of a class that resides in a plug-in               153

Chapter 10: Using Java to Write an Event Handler                              155
Writing a Java event handler class                    155
Writing a Java event handler                     161
Understanding the BIRT interfaces                      166
Java event handler example                    173
Debugging a Java event handler                  180

Chapter 11: Working with Chart Event Handlers                          183
Chart events overview                183
Understanding when chart events trigger                   185
Writing a Java chart event handler                   204
Writing a JavaScript chart event handler                   208
Using the simplified charting API                         211

Chapter 12: Accessing Data Programmatically                    217
Using a Scripted Data Source                     217
Tutorial 2: Creating and scripting a scripted data source                    219
Creating a web services data source using a custom connection class                   228

Part IV: Integrating BIRT Functionality into Applications                233
Chapter 13: Understanding the BIRT APIs                     235

Package hierarchy diagrams                    236
About the BIRT Report Engine API                      237
About the Design Engine API                244
About the BIRT Chart Engine API                         .257

Chapter 14: Programming using the BIRT Reporting APIs               275
Building a reporting application                   276
Generating reports from an application                   279
Programming with a report design                    302

Chapter 15: Programming using the BIRT Charting API                    321
About the chart engine contents                   321
About the environment for charting application                322
Using the charting API to modify an existing chart            324
Using the charting APIs to create a new chart                330
Using a chart item in a report design                   336
Using the BIRT charting API in a Java Swing application                 345
Understanding the chart programming examples                      351

Part V: Working with the Extension Framework                    359
Chapter 16: Building the BIRT Project                      361

About building the BIRT project                       361
Installing a working version of BIRT                 362
Configuring the Eclipse workspace to compile BIRT                  362
Downloading and extracting the correct version of the BIRT source code             364
Importing, building, and testing the BIRT project                   364
Building new JAR files to display BIRT output                  367

Chapter 17: Extending BIRT                      369
Overview of the extension framework                      369
Understanding the structure of a BIRT plug-in                       370
Working with the Eclipse PDE                         377
Creating the structure of a plug-in extension                     381
Creating the plug-in extension content                      385
Building a plug-in extension                       390
Deploying the extension plug-in                      393
Downloading the code for the extension examples                     398

Chapter 18: Developing a Report Item Extension                       399
Understanding a report item extension                      399
Developing the sample report item extension                   401
Understanding the rotated label report item extension                     418
Deploying and testing the rotated label report item plug-in                  428

Chapter 19: Developing a Report Rendering Extension               433
Understanding a report rendering extension                433
Developing a CSV report rendering extension                   434
Developing an XML report rendering extension                    462

Chapter 20: Developing an ODA Extension                 477
Understanding an ODA extension                     478
Developing the CSV ODA driver extensions                   479
Implementing the CSV ODA driver plug-in                      481
Understanding the sample CSV ODA driver extension                    491
Developing the CSV ODA UI extension                         500
Understanding the sample CSV ODA UI extension                     509
Testing the CSV ODA UI plug-in                    519
Developing a Hibernate ODA extension                      524

Chapter 21: Developing a Fragment                         571
Understanding a fragment                571
Developing the sample fragment                572
Creating a fragment project                573
Understanding the sample fragment                  576
Building, deploying, and testing a fragment                577

Glossary                                 583

Index                                       645


Submit Errata

More Information

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information

To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.


Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.


If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information

Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.


This site is not directed to children under the age of 13.


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information

If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information

Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents

California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure

Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact

Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice

We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020