User interface for Upload Reference Data tool

Description

Create a mechanism for implementors to upload reference data CSV files during the initial setup of the OpenLMIS deployment.

Benefits/Goals:

  • Menu driven intuitive interface will enable new implementer to setup and configure OpenLMIS quickly and easily

  • Bulk upload will save time when loading sizable reference data such as facilities, products, geographic zones, etc.

  • UI will provide visual feedback (e.g. number of records processed)

  • Dependency on programmers will be reduced when this upload feature is made accessible with an easy to use user interface

Scope:
User Interface (UI) added to Administration menu to enable users to initiate upload of reference data from CSV files.

Approach:

The Reference Data Seed tool is a simple yet configurable tool that allows CSVs to be mapped to API calls of the Reference Data Service transforming the CSVs into Reference Data which a new instance of OpenLMIS can use.

Improving Reference Data Seed Tool

Adding a UI to accept the upload of the Reference Data Seed tool's CSVs and show a visual progress of the transformation of those CSVs into Reference Data created in the Reference Data Service is the primary approach.

This entails:

  • Writing a headless web UI which leverages the Reference Data Seed Tool.

  • Enhancing the Reference Data Seed Tool to accept data uploaded to it through HTTP

Leveraging Resource Map **

Resource Map is a graphical web-application which allows a nation to curate and visualize their resources (e.g. Facilities, services, etc) graphically. It also has bulk uploads via CSV however after the upload the data may be shown on a map and then refined as needed. Additionally Resource Map is the Reference Implementation of a National Facility Register, and is often found in countries (including Tanzania).

When starting an OpenLMIS instance, bulk uploading of Facilities (and administrative hierarchies), can be first done by launching Resource Map, uploading to Resource Map in its format (CSV), curating and refining the quality of the list using Resource Map's UI, and then finally as a last step launch a simple OpenLMIS tool to import the data from Resource Map, to OpenLMIS Reference Data.

This entails:

  • Writing OpenLMIS documentation to link to or describe how to launch Resource Map

  • Writing best practices / guidelines on importing Facilities and administrative hierarchies that OpenLMIS will find useful, into Resource Map.

  • Building an OpenLMIS ResourceMap Importer.

Component Architecture diagram.

Participants: JSI

History:

  • Originally this was an epic on OpenLMIS 3.0.0 which was later de-prioritized.

  • Split out from epic OLMIS-566.

Query issues in this epic

Activity

Show:
Josh Zamor
June 7, 2018, 10:14 PM

, and : I've updated the epic description to include the approach we discussed with Resource Map yesterday(June 6, 2018). I added basic high level acceptance criteria for each item as well as a basic Component Architecture diagram of the systems involved. I'd propose this as a starting point that we can iterate on as needed.

One final administrative note here is I noticed that while the issues in this epic (at the time of this note) are useful to get a sense of the different pieces of Reference Data, it appears as if these jira issues:

  • are from the original re-architecture kickoff and therefore a couple years old. Reference Data today might be different than it was thought it would be then.

  • many of these jira issues could be construed as needing a CSV import tool to be built, whereas I've updated the epic's approach to ensure we leverage the existing CSV import tool (Reference Data Seed Tool) and putting a UI in-front of it. I think we all understand that but I wanted to formalize it in the proposed architecture.

Mary Jo Kochendorfer
September 21, 2018, 1:59 PM

I forgot to mention that has been awarded a small amount of money to implement this epic. It will help us moving forward to getting the configuration uploads completed. could you update us with the timing to complete this? I assume you've received the money by now....

Mary Jo Kochendorfer
November 20, 2018, 3:14 PM

, is this work underway? If so, please mark the epic as In Progress.

Wesley Brown
April 5, 2019, 12:34 PM

With all the Gap-related work for v3.6 I think that this has gotten lost. How is this work going and what is the plan for this going forward?

Sam Im
April 16, 2019, 9:38 AM

Removed 3.6 label since this is no longer part of the release.

Assignee

Ashraf

Reporter

Brandon Bowersox-Johnson

Components

Priority

Major

Epic Name

Upload Reference Data