DEFINITIONS:
Authorities refers to
User Groups refers to
User refers to
(authorities) and User Groups (sharing) and User Setup
In order to keep DHIS2 as clean and organised as possible, User Groups and Roles should be defined to limit access to the features available in DHIS2.
User Roles
Several DHIS2 Authorities are required in order to be able to interact with the H2 Metadata and Data. The authorities will grant the users permission to different DHIS2 configurations and features.
Please Note
If you’re using the PCA, you probably already have the necessary User Roles available in the server. Some are installed as the initial setup of the PCA, while others are installed as part of the HNQIS2 Metadata Package.
For Data Capture (Web and Android App)
A User Role for Data Capture should include the following Authorities:
Web data capture | Android data capture |
---|---|
|
Note: as of DHIS2 Android 2.6.2 a user do not needs any authority to capture DHIS2 tracker data |
For Program Administration
Program Administration requires several Authorities depending on the needs of the Administrator. All the recommended Authorities are listed below:
Metadata authorities
Authority required to create edit metadata objects in the DHIS2 server.
*Denote:
The Public access should only be provided for analyses such as Dashbaord. Maps and Visualisation.
Avoid providing Public access for Program-related Metadate, this function is reserved for HNQIS Administrators only.
The use of Public sharing: we normally recommend limiting the use of Public sharing only for analyses (Dashboard, Maps and Visualizations). We do not recommend the use of public sharing for program-related metadata, so editing of it is limited to the official HNQIS administrators.
Metadata Object | Authority |
---|---|
Dashboard (for H2 Metadata Generation) |
|
Data Element |
|
Legend Set |
|
Map (for H2 Metadata Generation) |
|
Option Set |
|
Program |
|
Program Indicator |
|
Program Rule |
|
Program Stage |
|
ProgramStageSection |
|
Visualization (For H2 Metadata Generation) |
|
Other authorities
App access authority is required to administer H2 programs in a DHIS2 server.
App |
|
Tracker |
|
Import/Export |
|
System |
|
User Groups setup (DHIS2 sharing)
User Groups in H2 are used to define the users that will be able to perform maintenance to the different H2 Programs (referred to as Admins) and the users that will be able to interact with said Programs (referred to simply as Users).
By default, the HNQIS2 Metadata Package includes two User Groups that can be used as templates for other groups: HNQIS2 - Admins and HNQIS2- Users.
Please Note
If you’re using the PCA, the HNQIS2 Metadata Package (that also includes the base User Groups) can be installed/updated easily.
It is recommended to that a pair of Groups for Admins and Users is created for each use case. For instance, it is a common practice to separate Checklists by country, meaning that a group of three countries: Kenya, Zimbabwe and Angola; should have the following sets of User Groups:
Kenya (KE) | Zimbabwe (ZW) | Angola (AO) |
---|---|---|
|
|
|
If your server includes a multi-country setup, it is a good practice to include the ISO code of the country as a prefix for each User Group.
After the User Groups are created, the Sharing Settings of the H2 Programs should include a configuration as follows:
User Group | Metadata Settings | Data Capture Settings |
---|---|---|
Admins | Can Edit and View | Can Capture and View |
Users | Can View only | Can Capture and View |
Not all of the authorities listed above are required, some are mainly used by the PCA features.