Compatibility

• BIRT Report Module 2.5.2.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

Download & Install

1. BIRT RCP Designer (click RCP Designer)
2. BIRT Runtime Engine (click Runtime)
3. BIRT Report Module

Installation Instructions

Step 1. Install BIRT Report Designer (optional)

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

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

Step 2.  Install BIRT Runtime Engine (required)

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. /var/lib/birt-runtime-x.y.z)
3. Note the path to the BIRT Runtime Engine (e.g. this is your BIRT home directory /var/lib/birt-runtime-x.y.z/ReportEngine)

Step 3.  Install MySQL Driver (optional)

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_<version>\drivers

To Install MySQL Driver into BIRT Report Designer

1. Open BIRT Report Designer
2. Create New Data Source > JDBC Data Source
3. Manage Drivers ...
4. Add ...
5. Locate the appropriate MySQL driver
6. Click Open
7. Click Ok

To create a new SQL Data Source in the BIRT Report Designer

1. Open BIRT Report Designer
2. Create New Data Source > JDBC Data Source
3. Enter properties
   • Driver Class: com.mysql.jdbc.Driver (v3.1)
   • Database URL: jdbc:mysql://localhost:3306/openmrs?autoReconnect=true
   • User Name: your db username
   • Password: your db password
4. Click 'Test Connection ...'
5. Click 'Finish'

Step 4.  Install BIRT Report Module to OpenMRS

a.  Install BIRT Report Module

1. Download the latest BIRT Report Module (click the Download button).
2. Login to OpenMRS as an administrator
3. Navigate to Administration > Manage Modules
4. Browse for .omod file that you downloaded
5. Click the Add Module button

b.  Edit Global Properties

Assuming you are logged in as an Administrator:

1. Navigate to Administration > Manage Global Properties
2. Enter values for the BIRT global properties
3. Click Save at the bottom of the page

• birt.birtHome
  Specifies the absolute path to the BIRT Report Engine. Must include ReportEngine subdirectory.
  Example: /var/lib/birt-runtime-x_y_z/ReportEngine

• birt.datasetDir
  Specifies the absolute path to the reports dataset directory (for CSV/XML data sources).
  Example: <user_home>/.OpenMRS/reports/datasets

• birt.defaultReportDesignFile
  Specifies the name of the default report design file. Not implemented yet.
  Example: default.rptdesign

• birt.imageDir
  Specifies the absolute path to the image directory where BIRT will find generated charts and graphs. Not implemented yet.
  Example: C:/Documents and Settings/Justin Miranda/Application Data/OpenMRS/reports/output/images

• birt.loggingDir
  Specifies the absolute path for log files written by BIRT Engine.
  Example: C:/Documents and Settings/Justin Miranda/Application Data/OpenMRS/reports/logs

• birt.outputDir
  Specifies the absolute path to the report output file when reports are generated.
  Example: C:/Documents and Settings/Justin Miranda/Application Data/OpenMRS/reports/output

• birt.reportDir
  Specifies the absolute path where report design files are uploaded.
  Example: C:/Documents and Settings/Justin Miranda/Application Data/OpenMRS/reports

• birt.reportOutputFile
  Specifies the absolute path to the reports output file.
  Example: C:/Documents and Settings/Justin Miranda/Application Data/OpenMRS/reports/output/ReportOutput.pdf

• birt.reportOutputFormat
  Default output format.
  Example: pdf

• birt.reportPreviewFile
  Specifies the absolute path to the report preview file.
  Example: C:/Documents and Settings/Justin Miranda/Application Data/OpenMRS/reports/ReportPreview.pdf

c. Start BIRT Report Module

Assuming you are logged in as an Administrator:

1. Naviagate to the Administration > Manage Modules
2. Click the green arrow next to the BIRT Report Module

Required Privilege

The following privilege may be necessary for various activities.

• Manage Reports (deprecated, but still used for the time-being)
• Edit Reports
• View Reports
• Delete Reports