BIRT: The Eclipse Reporting Framework Jason Weathersby, BIRT PMC

1 Agenda What is BIRT? BIRT Features and Report Gallery Scripting BIRT Deploying BIRT Reports BIRT APIs Extension Points

What Is BIRT?

3 What is the BIRT Project? Business Intelligence and Reporting Tools based on Eclipse Initially focused on embedded reporting for Java developers Three initial components as part of BIRT project Data Report Engine Generation Services Presentation Services Eclipse Report Designer Report Design Engine Custom Report Designer… XML Report Design Report Document HTML PDF Print … Data Transform. Services Charting Services Custom Services… 1 2 3

4 BIRT What is available birt-report-designer-all-in-one-2_0_1 BIRT Designer and most required plug-ins birt-report-framework- 2_0_1 BIRT Designer Eclipse plug-in birt-rcp-report-designer- 2_0_1 RCP Version of the BIRT Designer birt-runtime- 2_0_1 BIRT web application report engine runtime and examples chart engine runtime. birt-charts- 2_0_1 Stand alone chart engine plug-ins. Samples

5 BIRT Designer WYSIWYG Drag and Drop

6 BIRT Views Extendable Palette Graphical outline of Report Multiple Data Sources Static and Dynamic parameters including cascaded Reuse work with Libraries and Templates Import Style sheets

7 BIRT Editor Layout and Scripting Views Quick access to graphical components or edit XML Directly

8 Property Editor View Simple Property Editor Mapping and Highlighting Sorting and Filters

9 Previewing BIRT Reports Preview Reports while building View Data in HTML or PDF Cached Data

10 Chart Builder Simple Wizard Seven Chart types Many Sub types SVG PNG GIF JPG BMP Filtering

BIRT Features and Report Gallery

12 BIRT Features Palette of report components - Text (CLOBs, HTML), data, images (BLOBs), tables, grids, lists, labels Sorting, grouping, filtering, conditional highlighting, mapping Scripting in JavaScript/Java Cascading & dynamic report parameters Hyperlinking, bookmarks TOC, Paging Direct XML source editor for report design Multi-pass processing (top N/bottom N) Data sources: POJOs, JDBC, CSV, XML WYSIWYG Editor Integrated Chart Wizard Report Component Libraries Report Templates Styles, import CSS, themes Wizards for guided development Report outline Preview within report designer for iterative development Context pass through to data source Call stored procedure

13 BIRT Designer Demo

14 Sales Invoice Report Computed column Comprehensive aggregation functions Layout flexibility Rich formatting control (Including conditional formatting) Embedded images (including BLOBS)

15 Stock Price & Volume Report Integrated Charting as a child of parent table Parent table Grouping & sorting

16 Organization Report Table level filter for Office Code 1 Table level filter for Office Code 4 Parallel layout

17 Orders Summary Drill through from Orders Summary Order details report for specific Order Number

Scripting BIRT

19 BIRT Pipeline RptDocument Report Document JavaScript Events Optional Java Events RptDesign XML Design File Generation PhasePresentation Phase Paginated HTML PDF CSV Report Designer Design Engine Report Engine optional JDBC XML FlatFile Scripted

20 Scripting BIRT JavaScript Based on Mozilla Rhino - This is Server Side Scripting not Browser Based Scripting Two types of Scripting Expression Scripts - Scripts that return a data value. Available in the Expression Builder. Element Scripts – JavaScript methods that are called on events. Customize the behavior of the Report. Available in the Script view. Context of when the event occurs is important.

21 Expression Scripting

22 Expression Scripting - Locations Creating the display value for a report item Creating a computed field in Data Explorer Specifying a filter condition Specifying a data series for a chart Specifying a map condition Specifying a highlight condition Specifying a group key Specifying a hyperlink Specifying the URI for an image Specifying dynamic data in a text control

23 BIRT Event Model JavaScript Event Handlers Generation Phase Report Level Initialize beforeFactory afterFactory Data Source/Set beforeOpen afterOpen onFetch beforeClose afterClose Report Element onPrepare onCreate Report Level Initialize beforeRender afterRender Presentation Phase Report Element onRender Optional Java Event Handlers

24 Element Scripting

25 Element Event Handlers using Java A set of Adapters are supplied that allow all event handlers to be built in Java. The class is a property of the element. Can be debugged with JDT using the BIRT Report Configuration.

26 BIRT Scripting Demo

Deploying BIRT Reports

28 Deploying Options Deploy the Web Viewer Example Deploy BIRT Under an RCP application Build your own Servlet using the BIRT Engine Use the BIRT Engine in your own Java Application (Discussed in APIs)

29 Deploying BIRT Reports J2EE ASEclipse Plugin RptDesign XML Design File RptDesign XML Design File RptDesign XML Design File RptDocument Report Document RptDocument Report Document RptDocument Report Document Web Viewer ReportEngine Web Viewer ReportEngine Java Application ReportEngine Paginated HTML, PDF, TOC, Bookmarks, CSV J2EE AS Custom Servlet ReportEngine

30 BIRT Web Application Generate report and return as PDF or HTML. Supports Paginated HTML. Export to CSV. Retrieves Images and Chart Output. Supports TOC and Bookmark Functionality. Parameter Entry.

31 BIRT Viewer

32 BIRT Deployment Examples Demo

BIRT APIs

34 BIRT APIs Report Engine API – Loads and executes design files. Design Engine API – Creates and modifies report designs. Charting API – Builds and renders charts.

35 Report Engine API Used to integrate run-time portion of BIRT into your application. Used to discover and set parameters. Run a report and output PDF/HTML. Combine or Split Run and Render Task Save to Intermediate format. Extract data. Fetch an image or chart for a report. 2.0 Engine supports additional features for paging, cascaded and dynamic parameters, etc. Example in the runtime download.

36 Design Engine API Create and modify report designs. Create and delete report elements.. Put report elements into slots. Retrieve metadata from report elements, properties and slots Undo/Redo. Semantic Checks on report designs.

37 BIRT Chart Engine API Stand Alone Chart Generator Does not require the use of the Chart User Interface Does not require the use of the Report Engine API Data is provided in a static data structure –When Charts render in Reports, Report Engine builds static structure from the specified ODA data and creates the static structure –Charts running stand-alone require a data feed org.eclipse.birt.chart.datafeed-Custom User Data Set Interface org.eclipse.birt.chart.model.data-Interfaces defines data structure JavaScript events support addition of custom business logic

Extension Points

39 BIRT Extensions Points BIRT is not just a tool but a framework. Predominant Extension Points. Emitter – Used to create additional output formats. ODA – DTP – Used to add customized Data Source Drivers Report Item – Used to extend the Palette with additional items. Chart Types – Used to add or extend chart types

40 BIRT API Demo

41 More on BIRT Source code for examples will be posted to the Eclipse site after the conference

42 Questions?