Skip to content

Latest commit

 

History

History
84 lines (50 loc) · 4.01 KB

README.md

File metadata and controls

84 lines (50 loc) · 4.01 KB
Raw

DHIS2 Visualization Navigator

Repo Owner: Ben Guaraldi @benguaraldi

Overview

The Visualization Navigator is a DHIS2 app that allows you to view all pivot tables, data visualizations, and dashboards in a DHIS2 instance.

You can search, filter, and get information about each visualization, such as view counts, the user that created it, the user groups and users it has been shared with, the last date it was viewed, its data dimensions (type, name, item, uid, layout, etc.), and even a handy "preview" window of the visualization.

You can also delete each visualization, view it via the API, or change its sharing settings, allowing quick and easy maintenance all in one place.

Installation on DHIS2

  1. Install the app via the App Hub or by uploading into the DHIS2 App Management app the zip either from our releases or from npm run build
  2. By default, only superusers will be able to use the app. If you wish for other users to be able to access the Visualization Navigator, please add the app to a role that these users have and then share the Visualization Navigator App Search SQL view (uid VisNavgSrch) with a group that these users are in.
  3. By default, the Visualization Navigator cannot show the usernames of the owners of DHIS2 visualizations. If you have administrative access to your postgres database, you can change that by following these instructions.

Development

The code of Visualization Navigator is split into two modules: search and view

Search

The search module is a REACT app built on CRA1. In order to serve the app locally in dev-mode follow these steps:

  1. Add address of your DHIS2 instance to the following lines of package.json
    "start": "REACT_APP_BASE_URL=https://my-instance.com/ craco start",
    "test": "REACT_APP_BASE_URL=https://my-instance.com/ react-scripts test",

  1. Run the dev-server npm start

  2. Log into the DHIS2 instance in Chrome

  3. Open http://localhost:3000

Inserting test user accounts

  1. Change name of your server instance inside testData/loadTestUsers.js
loadUsers([superUser], 'your-instance.com', 'Basic xxxx')

  1. Generate a Base64 hash for your DHIS2 account. For example, from Chrome DevTools, run: btoa('username:password')

  2. Insert the hash to the same line of testData/loadTestUsers.js

loadUsers([superUser], 'your-instance.com', 'Basic btoa-hash==')
  1. Run the load script node testData/loadTestUsers.js

Running tests

Start the tests by:

npm test

During the first run, the test suite will query your DHIS2 instance using the provided credentials. The API responses will be cached as JSON inside cachedApiCalls folder. Subsequent runs should be faster, since API responses will be served from the cache.

View

The view module is built on DHIS2 App Platform2. The dev-server can be started via npm start and accessed from http://localhost:3001. After entering the URL you will be prompted to provide your DHIS2's instance address and login credentials. There are no tests attached to this part of the project.

Build

The app is built via build.sh script. The script will build both modules of the app separately and then merge the result into a single Visualization-Navigator.zip file. The zip file can be then deployed to a DHIS2 instance.

Issues, Features, etc.

Please create an issue or a pull request.

Credits

Developed by @jakub-bao and @tomzemp.

References

  1. Create React App
  2. DHIS2 App Platform