Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • BIRT Report Module 2.5.2.1 x requires BIRT Runtime 2.5.2
  • BIRT Report Module 2.3.2.x requires BIRT Runtime 2.3.2
  • BIRT Report Module 2.3.1.x requires BIRT Runtime 2.3.1

Older versions no longer supported

  • BIRT Report Module 2.1 requires BIRT Runtime 2.3.2
  • BIRT Report Module 2.0 requires BIRT Runtime 2.3.1
  • BIRT Report Module 1.9 requires BIRT Runtime 2.2.2
  • BIRT Report Module 1.8 requires BIRT Runtime 2.2.2
  • BIRT Report Module 1.7 requires BIRT Runtime 2.2.2
  • BIRT Report Module 1.6 requires BIRT Runtime 2.2.2
  • BIRT Report Module 1.5 requires BIRT Runtime 2.2.2
  • BIRT Report Module 1.4 requires BIRT Runtime 2.2.1.1 (can be compiled from source)
  • BIRT Report Module 1.3 requires BIRT Runtime 2.2.1 (can be compiled from source)
  • BIRT Report Module 1.2 requires BIRT Runtime 2.2.0
  • BIRT Report Module 1.1 requires BIRT Runtime 2.2.0 (can be compiled from source)
  • BIRT Report Module 0.6 requires BIRT Runtime 2.2.0
  • BIRT Report Module 0.3 requires BIRT Runtime 2.2.0 (can be compiled from source)
  • BIRT Report Module 0.2 requires BIRT Runtime 2.2.0

...

Installation Instructions

Install

...

BIRT Report Designer

If you plan to design reports locally, you need to install the BIRT Report Designer.

  1. Download the latest version of the BIRT RCP Designer (click RCP Designer button).Report Designer
  2. Extract the BIRT RCP Designer Engine to your local file system (i.e. c:/birt-rcp-report-designer-2_2_0)

Install BIRT Runtime Engine

If you want to run the BIRT Module on a server, you MUST first install the BIRT Runtime Engine.

  1. Download the latest compatible BIRT Runtime Engine (click Runtime button).
  2. Extract the BIRT Runtime Engine to your local file system (i.e. c:/var/lib/birt-runtime-2_2_0x.y.z)
  3. Note the path to the BIRT Runtime Engine (it will be used later)e.g. this is your BIRT home directory /var/lib/birt-runtime-x.y.z/ReportEngine)

Install MySQL Driver

If you

...

plan to

...

design reports that use the SQL dataset to make calls to a MySQL database, you will need to install a MySQL driver.  OpenMRS uses a MySQL driver, so you can simply copy that 

To install the MySQL Driver into BIRT Runtime Engine

  1. Download the MySQL driver from OpenMRS source
  2. Copy file to BIRT Runtime Plugin directory
    • For example, PATH_TO_BIRT_RUNTIME\ReportEngine\plugins\org.eclipse.birt.report.data.oda.jdbc_2.3.1.v20080827<version>\drivers

To Install MySQL Driver into BIRT Report Designer

...

  • birt.birtHome
    Specifies the absolute path to the BIRT Report Engine. Must include ReportEngine subdirectory.
    Example: C:/var/Javalib/birt-runtime-2x_2y_2z/ReportEngine
  • birt.datasetDir
    Specifies the absolute path to the reports dataset directory (for CSV/XML data sources).
    Example: C:/Documents and Settings/Justin Miranda/Application Data/<user_home>/.OpenMRS/reports/datasets
  • birt.defaultReportDesignFile
    Specifies the name of the default report design file. Not implemented yet.
    Example: default.rptdesign

...