Configure Reports App

Purpose and Benefits

Reporting is an essential feature of any EMR. The data that is stored in the EMR needs to be exported and analyzed. Bahmni provides a reporting module for the same. There are some standard reports that come as a part of the reporting module and the implementer also has the ability to define some custom reports.

Configuring the Reports Module

To configure multiple reports module refer here.

Follow these steps to configure the reporting module and then run reports in Bahmni

1. Configure reports app on home page:

Home page of user

Go to openmrs/apps/home/extension.json of your config and add the code snippet below:

"reports": {
  "id": "bahmni.reports",
  "extensionPointId": "org.bahmni.home.dashboard",
  "type": "link",
  "translationKey": "MODULE_LABEL_REPORTS_KEY",
  "url": "../reports/#/dashboard",
  "icon": "fa-user",
  "order": 8,
  "requiredPrivilege": "app:reports"
}

Key Fields

These are the attributes of the above configuration

Key	Use	Mandatory
"id"	Specific Id for reports app.	Yes
"extensionPointId"	Needed for configuring the reports.	Yes
"type"	Making reports app link on home page.	Yes
"translationKey"	Show name in particular locale used by app.	Yes
"url"	To redirect to reports page.	Yes
"icon"	To display icon.	No
"order"	Display in specific order.	No
"requiredPrivilege"	This is needed privilege for displaying reports module.	Yes

When two factor authentication is enabled, add 'bypass2fa' role to reports-user in openmrs to aviod authentication problems while running reports.

Reports SSL certificate configuration:

This configures reports application to accept trusted or untrusted SSL certificates when fetching reports.json file from httpd server.

Default Behaviour

By default, all the SSL certificates are trusted.

Overriding the default behaviour

Default behaviour of reports can be overriden by reconfiguring the following property in bahmni-reports.properties file located at /etc/bahmni-reports/ directory

Example

reports.json.ssl.accept-untrusted-certificates=false

In this case if the ssl certificate is untrusted, reports will be queued, but will not be generated, instead shows status as "Error"

Reports Queue

More information of Report Queue feature can be found at Report Management

Default Behaviour

By default, Report Queue feature is disabled.

Overriding the default behaviour

Default behaviour of reports can be overridden by reconfiguring following property value from app.json file found in /bahmni_config/openmrs/apps/reports folder

Example

"enableReportQueue": true