openmrs-module-mirebalaisreports

This module leverages the OpenMRS Reporting Module to define reports.

Defining Reports

There are several ways to define a report.

1. FullDataExport: Allows defining, a CSV report. Requires some Java and some SQL.
2. DataReportManager with SQL: Allows defining a CSV report, or can fill in an XML template. Requires Java and SQL.
3. DataReportManager with only Java: Allows defining a CSV report, or can fill in an XML template. Requires Java, lots of it.
4. SQL Only You can't do this yet. But someday, hopefully someday soon.

1. Using FullDataExport

See FullDataExportBuilder.java and ncd.sql for reference.

• add a new sql file to api/src/main/resources/org/openmrs/module/mirebalaisreports/sql/fullDataExport
• enable the report by modifying org/openmrs/module/mirebalaisreports/definitions/FullDataExportBuilder.java
  • For country (ie. HAITI, LIBERIA, MEXICO, etc)
  • For site (ie. MIREBALAIS, CHIAPAS, etc)
  • For component (ie. visits, ncd, etc)
• for report definitions (variables used for reports), modify org/openmrs/module/mirebalaisreports/definitions/BasePihReportManager.java and/or org/openmrs/module/mirebalaisreports/MirebalaisReportsProperties.java
• for setting/translating labels, modify api/src/main/resources/messages.properties (English). For adding other language translations (fr, ht, es)
  • push the file to Transifex (cd mirebalaisreport; tx push -s)
  • add translations to the mirebalaisreport module using Transifex
  • pull the translations back into the mirebalaisreport module from Transifex (cd mirebalaisreport; tx pull; git [add/commit/push])

2. Using DataReportManager with SQL

See MorbidityRegisterReportManager.java, morbidityRegister.sql, and MorbidityRegisterTemplate.xls for reference.

• Make your own versions of the above three files. You can skip the XLS file if you just want to create a CSV.
• If not using a template, copy the constructReportDesigns function used in NonCodedDiagnosesReportManager.java
• The report will be included based on
  • whether your implementation's country is in the getCountries list
  • whether your PIH site config has the correct component enabled for the category returned by getCategory. For example, if your report's category is DATA_EXPORT, then you must have the dataExports component enabled for it to show up.

3. Using DataReportManager with only Java

See DailyCheckInsReportManager.java and the associated files for an example of how to do this.

But really, it would be better if you didn't use this method. Write some SQL. It'll be fine.

4. Using SQL Only

As mentioned above, you can't do this yet. The code supporting this needs to be pulled in from openmrs-module-pihmalawi.

But take a quick look at patientWeightChange.sql to whet your appetite for it. No Java had to be added to support this particular report.