BIRT Integration

Business Intelligence and Reporting Tools (BIRT) is an open-source reporting system based on the Eclipse Platform. BIRT allows you to create reports, data visualizations and dashboards that can be integrated into web applications.

The following versions of BIRT are available for download:

Model RealTime Version BIRT Update Site Installation Instructions Notices
Model RealTime 12.1.X birt-12.1.1-v20250210_1050.zip Installation instructions 12.1.X Notices 12.1.X
Model RealTime 11.1 birt-11.1-v20220124.zip Installation instructions 11.1 Notices 11.1
Model RealTime 11.0 birt-11.0-v20220124.zip Installation instructions 11.0 Notices 11.0


Installation

The BIRT update sites listed above contain BIRT itself and the BIRT integration for Model RealTime. Once you have installed Model RealTime in Eclipse, follow the steps below for installing the BIRT update site too:

  1. In Eclipse, choose the Install New Software… command from the Help menu.

  2. Press the Add… button and enter the location of the BIRT update site. Add repository

  3. In the Install dialog, select BIRT Functionality from the list. Press Next.

Available software dialog

  1. You can review the BIRT selections before proceeding to the Install Details step of the wizard. Press Next.

Install details dialog

Note: If you encounter errors at this step, please verify that you have the necessary privileges to make updates to the system and files. On Windows, you may need to launch Model RealTime using the "Run as Administrator" option, and on Linux, ensure you're running with root privileges.

  1. Finally, the Review Licenses page will be shown. If you accept the license agreements, click the appropriate radio button, and then click Finish.

Review licenses dialog

  1. The Installation will now start. This may take a few minutes, depending on the system. You can check the progress in the status bar.

  2. Once the installation is completed, you will be asked to restart Eclipse. Answer Restart Now to restart Eclipse.

To verify that BIRT was installed successfully, consider the following steps:.

  1. After restarting Eclipse, invoke the Open Perspective selection dialog to check that the Report Design perspective is available.

Open perspective pane

  1. In the UML perspective, the Run menu should contain Report menu item.

Report context menu

View Reports

  1. Open UML Development perspective.
  2. Go to the Project Explorer view, right-click on the .rptdesign file and select Report As -> BIRT Report command. Report as option
  3. Please note that the Location field in Report Configurations dialog should be pointing to the .rptdesign file. Report configurations
  4. After you configure the Report Data and the Report Output, click on the Report button to generate the report.

Known limitations

When you use the View Report or Generate Document commands from the main toolbar or the Run menu, report generation will currently fail for the xlsx and xls_spudsoft formats. However, you will still be able to view reports in web viewer, docx, html, odp, ods, odt, pdf, postscript, pptx, and xls formats.

Run context menu

Refer to the following video to learn how to generate reports with BIRT: