Bulk Load is a DHIS2 Web Application part of EyeSeeTea's DHIS2 Suite designed to ease the integration of data from excel into DHIS2 and generate templates for datasets and programs.
You can find a detailed user and developer guide at the wiki and also our road map You can download User Extended from the DHIS2 App Hub
For more links, see the Bulk Load App website
We’d like to hear your thoughts on the app in general, improvements, new features or any of the technologies being used. Just drop as a line at community@eyeseetea.com and let us know! If you prefer, you can also create a new issue on our GitHub repository. Note that you will have to register and be logged in to GitHub to create a new issue.
Bulk Load App development is sustainable thanks to the partners for which we build customized DHIS2 solutions. This application has been funded by the WHO Global Malaria Programme, Samaritan’s Purse, Medecins Sans Frontières (MSF), the Norwegian Refugee Council (NRC) and the Clinton Health Access Initiative (CHAI) to support countries in strengthening the collection and use of health data by using DHIS2.
Also, the WHO Integrated Data Platform (WIDP), where several WHO departments and units share a dedicated hosting and maintenance provided by EyeSeeTea, back some specific new features. The Long Term Agreement EyeSeeTea holds with WHO for this maintenance includes maintenance of this application, ensuring that it will always work at least with the last version of WIDP. We are passionate about both DHIS2 and open source, so giving back to the community through dedicated open-source development is and will always be part of EyeSeeTea’s commitment.
You can also support our work through a one-time contribution or becoming a regular github sponsor
- Settings are only visible for superusers (
ALLauthority) or users that belong to the settings groups. - The generation box is only visible for users that belong to the configurable
Template Generationgroups (initial value:HMIS Officers). - Imported files are stored as documents (and can be downloaded later from the history) only for users with the
ALLorF_DOCUMENT_PRIVATE_ADDauthority. Users without them see a warning in the import page: their data is imported as usual and the import is still recorded in the history, but without the file.
Install dependencies:
$ yarn install
Start the development server:
$ PORT=8081 VITE_DHIS2_BASE_URL="http://localhost:8080" VITE_DHIS2_AUTH="" yarn start
Now in your browser, go to http://localhost:8081.
Notes:
-
Requests to DHIS2 will be transparently proxied from
http://localhost:8081/dhis2/pathtohttp://localhost:8080/path(seevite.config.ts) to avoid CORS and cross-domain problems. -
The optional environment variable
VITE_DHIS2_AUTH=USERNAME:PASSWORDforces some credentials to be used by the proxy. This variable is usually not set, so the app has the same user logged in atVITE_DHIS2_BASE_URL. -
The optional environment variable
VITE_PROXY_LOG_LEVELcan be helpful to debug the proxied requests (accepts: "warn" | "debug" | "info" | "error" | "silent") -
Create a file
.env.local(copy it from.env) to customize environment variables so you can simply runyarn start. -
why-did-you-render is loaded in development to help debug re-renders.
$ yarn test
$ yarn build
$ yarn localize
The file src/webapp/contexts/app-context.ts holds some general context so typical infrastructure objects (api, d2, ...) are readily available. Add your own global objects if necessary.
You can use the script import-multiple-files.ts to import multiple xlsx files:
#!/bin/bash
npx ts-node src/scripts/import-multiple-files.ts \
--dhis2-url="http://admin:district@localhost:8080" \
--results-path="/path/to/folder/for/json_results" \
file1.xlsx file2.xlsxYou can use the script regenerate-metadata.ts to refresh only the Metadata
sheet of an existing template from fresh DHIS2 metadata, leaving every other sheet
(custom form, dropdowns, VBA) untouched:
yarn regenerate-metadata \
--dhis2-url="https://play.dhis2.org" \
--auth="user:pass" \
--input=template.xlsm \
--output=template.regenerated.xlsm \
--form-id=U6z7eJniNfL \
--form-type=trackerPrograms \
--include-codes| Flag | Required | Description |
|---|---|---|
--dhis2-url / -u |
yes | DHIS2 base URL (auth can be embedded here or via --auth). |
--auth / -a |
— | "username:password" (special characters are handled). |
--input / -i |
yes | Path to the input template (.xlsm/.xlsx). |
--output / -o |
yes | Path where the regenerated template is written. |
--form-id |
yes | DHIS2 program/dataSet id whose metadata is used. |
--form-type |
— | trackerPrograms | programs | dataSets (default trackerPrograms). |
--language |
— | Metadata name language (default en). |
--include-codes |
— | Write the Code column in the Metadata sheet (default off). |
--use-codes |
— | Use item codes instead of names for org units, data elements, options… (default off). |
--org-unit-short-name |
— | Use each org unit's short name instead of its regular name (default off). |
The same operation is available in the app, under Settings → Maintenance → Regenerate template metadata.
