Home > Store

Integrating and Extending BIRT, 3rd Edition

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

Integrating and Extending BIRT, 3rd Edition

eBook (Watermarked)

  • Your Price: $38.39
  • List Price: $47.99
  • Includes EPUB 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.

    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 2012
  • Dimensions: 7" x 9-1/4"
  • Pages: 880
  • Edition: 3rd
  • eBook (Watermarked)
  • ISBN-10: 0-13-273253-X
  • ISBN-13: 978-0-13-273253-6

<>The world-wide developer community has downloaded over ten million copies of BIRT (Business Intelligence and Reporting Tools). 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.

Integrating and Extending BIRT, Third Edition, introduces programmers to BIRT architecture and the reporting framework. BIRT technology makes it possible for programmers to build customized reports using scripting and BIRT APIs. This book also includes extensive examples of how to use the Eclipse Plug-in Development Environment to build plug-ins to extend the features of the BIRT framework. The source code for these examples is available for download at www.eclipse.org/birt.

Key topics covered 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 revised and expanded third edition features the following new content

  • Updated architectural diagrams
  • Expanded scripting examples
  • Debugging event handlers
  • Developing an advanced report item with data binding
  • Developing a data extraction extension
  • Developing a charting extension

Readers may also be interested in this book’s companion volume. BIRT: A Field Guide, Third Edition, is the authoritative guide to using BIRT Report Designer, the graphical tool that enables users of all levels to build reports, from simple to complex, without programming.

Sample Content

Table of Contents

Foreword        xix

Preface          xxi

Acknowledgments          xxix

Part 1: Installing and Deploying BIRT         1

Chapter 1: Introducing BIRT Report Designers         3

Understanding BIRT components     3

Understanding Eclipse BIRT packages     4

About types of BIRT builds     5

Chapter 2: Installing a BIRT Report Designer         7

Installing BIRT Report Designer Full Eclipse Install     7

Installing BIRT RCP Report Designer     8

Troubleshooting installation problems     9

Installing a language pack     10

Updating a BIRT Report Designer installation     11

Updating BIRT RCP Report Designer installation    12

Chapter 3: Installing Other BIRT Packages          15

Installing Chart Engine     15

Installing BIRT Data Tools Platform Integration     17

Installing BIRT Demo Database     17

Installing Report Engine   19

Installing BIRT Samples   21

Installing BIRT Source Code    21

Installing BIRT Web Tools Integration     22

Chapter 4: Deploying a BIRT Report to an Application Server          25

About application servers      25

Placing the BIRT report viewer on an application server     26

Placing fonts on the application server     31

Viewing a report using a browser     31

Using connection pooling on Tomcat     32

Part 2: Understanding the BIRT Framework          37

Chapter 5: Understanding the BIRT Architecture         39

Understanding the BIRT integration      39

About the BIRT applications     43

About the types of BIRT report items     46

About the Report Object Model (ROM)      47

About the types of BIRT files      47

About custom Java applications     49

About extensions to BIRT     50

Chapter 6: Understanding the Report Object Model       51

About the ROM specification    51

About the ROM schema    53

About the rom.def file     53

Understanding ROM elements     58

Part 3: Scripting in a Report Design          61

Chapter 7: Using Scripting in a Report Design         63

Overview of BIRT scripting     63

Events overview     64

Event order sequence     71

Chapter 8: Using JavaScript to Write an Event Handler         83

Using BIRT Report Designer to enter a JavaScript event handler     83

Using the reportContext object     86

Using the this object     93

Using the row object     96

Getting column information     97

Getting and altering the query string     98

Changing data source connection properties     99

Getting a parameter value     100

Determining script execution sequence     101

Tutorial 1: Writing an event handler in JavaScript     103

JavaScript event handler examples     107

Calling external JavaScript functions    111

Calling Java from JavaScript     112

Calling the method of a class in a plug-in     114

Chapter 9: Using Java to Write an Event Handler        117

Writing a Java event handler class     117

Writing a Java event handler    123

Understanding the BIRT interfaces    128

Java event handler example    135

Debugging a Java event handler    142

Chapter 10: Working with Chart Event Handlers    143

Chart events overview    143

Understanding the Chart script context    145

Understanding when chart events fire    150

Writing a Java chart event handler     164

Writing a JavaScript chart event handler     167

Using the simplified charting API     169

Chapter 11: Using Scripting to Access Data         173

Using a Scripted Data Source     173

Tutorial 2: Creating a scripted data source     175

Creating a web services data source using a custom connection class     184

Chapter 12: Debugging Event Handlers          187

Checking the syntax of JavaScript expressions     188

Debugging JavaScript event handlers code     190

Debugging Java event handler code     194

Debugging report execution exceptions    194

Creating a debug configuration     196

Tutorial 3: Debugging a report that contains Java and JavaScript code     198

Part 4: Integrating BIRT into Applications           215

Chapter 13: Understanding the BIRT APIs          217

Package hierarchy diagrams      218

About the BIRT Report Engine API      219

About the Design Engine API   226

About the BIRT Chart Engine API         239

Chapter 14: Programming Using the BIRT Reporting APIs            257

Building a reporting application    258

Generating reports from an application    262

Programming the structure of a report design   289

Chapter 15: Programming Using the BIRT Charting API          307

About the chart engine contents    307

About the environment for a charting application    308

About the charting API and the chart structure    310

Using the charting API to create a new chart    312

Modifying chart properties    312

Using a chart item in a report design     321

Using the BIRT charting API in a Java Swing application    334

Understanding the chart programming examples     340

Part 5: Working with the Extension Framework          347

Chapter 16: Building the BIRT Project         349

About building the BIRT project     349

Installing a working version of BIRT     350

Configuring Eclipse to compile BIRT and build the viewer JAR files     350

Downloading and extracting the correct version of the BIRT source code     353

Importing, building, and testing the BIRT project     354

Building new JAR files to display BIRT output     356

Chapter 17: Extending BIRT         359

Overview of the extension framework     359

Understanding the structure of a BIRT plug-in     359

Working with the Eclipse PDE     366

Creating the structure of a plug-in extension    370

Creating the plug-in extension content    373

Building a plug-in extension    377

Deploying the extension plug-in   381

Downloading the code for the extension examples    384

Chapter 18: Developing a Report Item Extension           387

Understanding a report item extension    387

Developing the sample report item extension    389

Understanding the rotated label report item extension     404

Deploying and testing the rotated label report item plug-in     412

Developing an advanced report item    416

Chapter 19: Developing a Report Rendering Extension          465

Understanding a report rendering extension     465

Developing a CSV report rendering extension     466

Developing an XML report rendering extension     494

Chapter 20: Developing an ODA Extension           509

Understanding an ODA extension     510

Developing the CSV ODA driver extensions    511

Implementing the CSV ODA driver plug-in    513

Understanding the sample CSV ODA driver extension    522

Developing the CSV ODA user interface extension    530

Understanding the sample CSV ODA user interface extension    537

Testing the CSV ODA user interface plug-in    548

Developing a Hibernate ODA extension    554

Chapter 21: Developing a Data Extraction Extension          601

Understanding a data extraction extension    601

Developing an XML data extraction extension    602

Chapter 22: Developing a Fragment          635

Understanding a fragment     635

Developing the sample fragment     636

Creating a fragment project     637

Understanding the sample fragment     640

Building, deploying, and testing a fragment     641

Chapter 23: Developing a Charting Extension             647

About BIRT charting extension points   648

Setting up the build environment    650

Extending the chart model      652

Glossary             707

Index            779


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