Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Metadata packages location

The three packages are located in the Metadata folder in this repository. Click here to open the folder.

...

Requirements for installation: User

The minimum roles for a user to import the metadata packages are summarized in the tables below:

  1. For RDQA Server Attributes json file:

Metadata

Apps

Tracker

Import-Export

System

Add/Update Private
Attribute

Maintenance App
Import-Export app
Browser Cache Cleaner app
Dashboard App

NA

Export metadata
Import metadata

NA

2. For RDQA Program json file:

Metadata

Apps

Tracker

Import-Export

System

Add/Update Private
Category
Category option
Data Element
Data Element Groups
Option Group
Legend Set
Option Set
Program
Tracked Entity Attribute

Add/Update Public
Program Rule
Program Stage

Maintenance App
Import-Export app
Browser Cache Cleaner app
Dashboard App

Manage Program Rule

Export metadata
Import metadata

NA

3. For RDQA Program json file:

Metadata

Apps

Tracker

Import-Export

System

Add/Update Private
Legend Set
Program Indicator
Category Combo

Add/Update Public
Indicator
Indicator Group
Indicator Type

Maintenance App
Import-Export app
Browser Cache Cleaner app
Pivot Table app
Event Reports app
Dashboard App

Manage Program Rule

Export metadata
Import metadata

NA

Note

Also, data entry users can't have more than 30 organisation units. Having too many OUs can lead to performance issues using the Android App.

...

Installation

Download Packages

  1. Open the Metadata folder located in this repository.

...

2. Click on the file and then click on the context menu (three dots).

...

3. Click on Download option

...

Importing packages

The same process applies to the three json files but it is important to upload the files in the following order:

  1. RDQA Server Attributes

  2. RDQA Program

  3. RDQA Analytics - This package is optional. It does no affect the data capture behavior.

To import any file:

1. Open the Import/Export App

...

2. Select the Metadata Import button on the left side menu.

3. Select the correspondent json file.

4. Select JSON as the format.

...

5. Do a dry run before importing the file - This step will provide information if there is any incompatibility between your server and the file.

6. If the dry run is successful, start the import process.

...

7. Repeat the process for the next file.

Organisation unit assignment

Now that you have imported the files, it is necessary to add organisation units to the program to be able to capture data.

  1. Open maintenance app

...

2. Open program and select the RDQA Program

...

3. In the Access Menu, select the capture org units

...

Sharing

All the packages are configured to have public access to the metadata but to be able to capture information:

  1. Open the maintenance app.

...

2. Open program and select the RDQA Program.

...

3. Go to Access.

4. In the Roles and access section, click on the program’s name.

...

5. Click on Public access and change the DATA sharing to “Can capture and view” or add the users/user groups and change the data sharing to them.

...

6. Click on "Apply" and then click on "Apply to selected stages" to copy the sharing settings to all the stages.

...

7. Click on the save button to finish the process

Instead of having all the metadata public, it is highly recommended to create two user groups: The RDQA-Admin, which should have access to change metadata and the RDQA-User group, which will include all users that capture data.

To create a user group:

  1. Open the user app

  2. Select User group on the left side menu

  3. Click in the "+" button

  4. Write the name of the group and add all the users you need