BIRT ODA Plugin User Guide

[edit]

Overview

The BIRT ODA Plugin is the easiest way to use BIRT to build reports using the OpenMRS system.

[edit]

Installation

[edit]

Install the Logic Web Service Module

Access the Logic Web Service Module in the Module Repository and download the latest file (a .omod file). Install this module in OpenMRS (Administration --> Manage Modules --> Add Module).

[edit]

Install BIRT

To design reports, you need to have the latest version of Eclipse BIRT. If you are on Windows, you may want to stick with the dedicated report designer.

On Linux, OS X, or any other system that Eclipse runs on, you will have to install BIRT within an Eclipse install. To install within a normal Eclipse installation, follow these instructions to install BIRT via Eclipse's Update Manager.

Make sure you install at least version 2.3.1 of BIRT. Version 2.3.1 is required for the ODA Drivers to function properly.
[edit]

Install the plugin

There are two files that comprise the plug-in:

These need to be installed into a folder so that BIRT can recognize them.

  1. Find the folder where BIRT or Eclipse (with BIRT plugin) is installed.
  2. Enter that directory and find the folder inside that named plugins.
  3. Place the two jar files into plugins.
  4. Restart Eclipse.
[edit]

Workflow

[edit]

Create a new report

  1. Enter the Report Design perspective if you are not already in it.
  2. Create a new report by selecting File --> New --> Report.
Creating a new report
[edit]

Create a Data Source and Data Set

The following video walks through the creation of a data source and data set, showing the different wizard pages and options available.

[edit]

Design

A data set is now in the BIRT Report designer. You can use it to design reports as you would any other data set.

[edit]

Troubleshooting

I'm having trouble with the Logic Web Service.
Try the Logic Web Service User Guide first. If you can't solve your problem there, see "It doesn't work right!" below.
I'm having difficulty with the BIRT Report Module and/or the BIRT ODA Plugin.
See the Troubleshooting Guide for Eclipse BIRT
I'm stuck and don't know what else to do.
If you find anything wrong with this, please notify the developers of this, by posting in the forums, sending an email to the Implementer's list, or sending a direct e-mail to Justin Miranda, Rudd Zwolinski, and Kevin Peters. Make sure to note what went wrong, what you were doing when it happened, and any error messages if there are any.
Retrieved from "http://openmrs.org/wiki/BIRT_ODA_Plugin_User_Guide"