BIRT ODA Plugin User Guide
Contents |
Overview
The BIRT ODA Plugin is the easiest way to use BIRT to build reports using the OpenMRS system.
Installation
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).
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.
Install the plugin
There are two files that comprise the plug-in:
- org.eclipse.datatools.connectivity.oda.openmrs_1.0.0.jar
- org.eclipse.datatools.connectivity.oda.openmrs.ui_1.0.0.jar
These need to be installed into a folder so that BIRT can recognize them.
- Find the folder where BIRT or Eclipse (with BIRT plugin) is installed.
- Enter that directory and find the folder inside that named plugins.
- Place the two jar files into plugins.
Workflow
Create a new report
- Enter the Report Design perspective if you are not already in it.
- Create a new report by selecting File --> New --> Report.
Add a new Data Source
- Data --> New Data Source
- Select OpenMRS Data Source and enter a name.
- Fill in properties:
- OpenMRS URL: This is dependent on your installation. For instance, http://demo.openmrs.org/openmrs points to where the installation would be on the Demo installation. It should contain http or https, the server with an optional port number (e.g., localhost:8080), and the context (e.g, openmrs, amrs).
- Username: This is your username that you use to access OpenMRS via the web interface.
- The user should have a role with privileges that allow them to access the data they wish to access in the report (e.g., View Observations for CD4 Count).
- Password: This is your password that is associated to your username for the web interface.
- Test the connection.
- Click finish.
Add a new Data Set
- Data --> New Data Set
- Enter a name and click next.
- Select a Filter (a simple set of patients or group of patients defined in the Cohort Builder) from the drop down box for filter.
- Selecting a Filter will fill in the set of tokens and token tags. If you wish you may select a particular token tag to narrow down the choices of tokens. All tokens are shown by default.
- Select one or more tokens and move them to the selected tokens box on the right. Each token is a column in the resulting data set.
- Pressing the right-arrow button adds the chosen columns to the right box. Repeat steps 5 and 6 as many times as necessary.
- If you wish to remove a column, select it and press the left-arrow button.
- Pressing the left-arrow button removes it from the list of selected tokens.
- Click finish. A data set with your selected columns will be constructed.
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.
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.
- It doesn't work right!
- 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 Rudd Zwolinski. Make sure to note what went wrong, what you were doing when it happened, and any error messages if there are any.












