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.2 of BIRT. Version 2.2 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.
[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]

Add a new Data Source

  1. Data --> New Data Source
    Data menu --> New Data Source
  2. Select OpenMRS Data Source and enter a name.
    Selecting OpenMRS Database and giving a name
  3. 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.
  4. Test the connection.
    Click the "Test Connection" button to make sure the server is responding correctly and that you have entered the properties correctly. If everything is fine, you will receive a pop-up message saying "Ping succeeded!"
    With entered properties and the Test Connection button
  5. Click finish.
[edit]

Add a new Data Set

  1. Data --> New Data Set
    Data menu --> New Data Set
  2. Enter a name and click next.
    Entering a name and clicking next
  3. Select a Filter (a simple set of patients or group of patients defined in the Cohort Builder) from the drop down box for filter.
    Choosing a filter from the drop down box
  4. 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.
    All tokens are filled in
  5. 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.
    Choosing columns from the left box
  6. Pressing the right-arrow button adds the chosen columns to the right box. Repeat steps 5 and 6 as many times as necessary.
    Columns that are chosen appear in the right box.
  7. If you wish to remove a column, select it and press the left-arrow button.
    Selecting a column from the right box.
  8. Pressing the left-arrow button removes it from the list of selected tokens.
    Columns that are removed disappear from the right box
  9. Click finish. A data set with your selected columns will be constructed.
[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.
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.
Retrieved from "http://openmrs.org/wiki/BIRT_ODA_Plugin_User_Guide"