...

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 

...

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:

...

• 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:

...

The following privilege may be necessary for various activities.

• "Manage Reports " <-- Required to view lists of reports and to run reports(deprecated, but still used for the time-being)
• Edit Reports
• View Reports
• Delete Reports