BIRT ODA Plugin Developer Guide

Developers

Rudd Zwolinski

To get involved in working on the BIRT ODA Plugin, see the Reporting Framework Integration Project.

OpenMRS ODA Plugin

The easiest way to build the plugins as of now is using Eclipse and Subclipse.

1. Make sure you have Subclipse installed.
2. Install the Plug-in Development perspective if you do not already have it though the Eclipse update manager.
3. Install the latest version of BIRT (2.2+) as a plugin to Eclipse, also through the update manager (instructions here).
4. In Eclipse, enter the SVN Repository Exploring perspective, and add a new repository location (Right click in SVN Repository view, New --> Repository location).
5. Enter the Url: http://svn.openmrs.org/openmrs-contrib/birt_oda_plugin/ and click finish.
6. Expand the tree for this repository and select both org.eclipse.datatools.connectivity.oda.openmrs and org.eclipse.datatools.connectivity.oda.openmrs.ui and right click on them, selecting "Checkout...".
7. At the prompt, just click finish.
8. Switch perspectives to the Plug-in Development perspective.
9. Go to File --> Export and select "Deployable plug-ins and fragments" from the box, under Plug-in Development and click next.
10. In the Available Plug-ins and Fragments box, select both org.eclipse.datatools.connectivity.oda.openmrs and org.eclipse.datatools.connectivity.oda.openmrs.ui. Select the Destination tab on the bottom and select the Directory option. Type a directory where you wish the plugins to be created.
11. Click finish and wait for the export to finish. Navigate to the folder that you chose on the last prompt.
12. In that folder, there should be a folder called "plugins" which will now contain the files org.eclipse.datatools.connectivity.oda.openmrs_x.x.x.jar and org.eclipse.datatools.connectivity.oda.openmrs.ui_x.x.x.jar.

OpenMRS logicws Module

In Eclipse :

1. Select New > Project > Checkout Projects from SVN
2. Enter repository location (http://svn.openmrs.org/openmrs-modules)
3. Select logicws
4. Click Next
5. Enter project name
6. Select Head Revision
7. Click Finish

The code will be downloaded to a new project directory in Eclipse. When the download is complete, check to make sure that the Project Properties (namely, the classpath or build path) is set up correctly.

Next, we'll build the new logicws module by running the "package-module" Ant target. Once this process has finished, there should be an .omod file in the module dist directory. This .omod can be uploaded/deployed to OpenMRS through the Manage Module Admin page.