BIRT Reporting Module

The BIRT module provides a number of pre-built reports that are used to provide facility level metrics as well as MoH HMIS reports

Before starting to use birt reporting make sure that the birt module is running

To check that module is running

  1. Select legacy ui on home Select legacy ui from home
  2. You will see the birt reporting section on the administration page Highlight the birt section on the admin legacy ui If the Birt reporting does not appear on the administration page, it means that the birt module is not started If the module is not started, try to start it Birt legacy admin manage modules Birt module not started Birt module start birt

If the module is not administration module's page, that means the module is not installed, please refer to birt module installation instructions section

If the module fails to start refer to configuration section

Birt module start error page Click on the error detail to see the details of the error Birt module show detailed error select Birt module show detailed error


What you will need

  • Birt module version
  • Birt report engine vs 2.3_2 (birt.home)
  • You also need to create the following directories (will be used in the birt configuration)
    • Directory the will hold data sets (birt.datasetDir)
    • Directory where birt logs will dumped (birt.loggingDir)
    • Directory where generated output will be stored (birt.outputDir)
    • Directory where report designs will be stored (birt.reportDir)


  1. Go to manage modules on the legacy administration ui and then add or update module Admin page add module
  2. Click choose and then browse where the birt omod file is located
  3. Click upload, this will upload and try to start the birt module which will fail. Refer to the configuration section to configure birt Admin choose and upload birt module Error page Birt 404 page


To configure birt,

  1. Go to legacy ui administration page, then click on advanced settings Admin page advanced settings
  2. Look for birt related configurations and change them accordingly (based on the directories you created above) Birt configuration page
  3. After configuring birt accordingly, start birt again

To add run or edit reports make go to home and then click generate birt reports Birt reports home page If you get this page, means that birt is not running refer to the above on making sure that birt reports run birt 404

Adding reports

  1. Click add new report in the main birt reports main page Birt add
  2. The form for entering new report appears which you then fill and click save. This brings another page for adding the report design Birt new form Birt upload report Birt select report design Birt save report Birt add saved report Birt home

Editing and deleting reports

  1. To edit or delete a report go to birt home and click the edit button, This create report, but which allows you to edit or delete Birt reports home choose edit

Running reports

  1. To run reports you click the run button Birt reports home choose run
  2. This take you a page where you can input any parameters if required Birt reports example run page
  3. You can also choose how you want the report to be rendered Birt reports choose download format before run
  4. You then click generate to run, display,download the report

results matching ""

    No results matching ""