This repository contains the metadata configurations and scripts for Program Indicators. These program indicators are designed for tracking and monitoring health data within the DHIS2 system. Below are the steps to get started with cloning the repository, making necessary changes in the dev environment, and moving the updates to the test and production environments.
- Getting Started
- Development Environment Setup
- Importing Metadata to DHIS2
- Testing Changes
- Promoting to Test and Production Environments
- Contributing
To start working on the DHIS2 program indicators, follow these steps to clone the repository and set up your local environment.
- Ensure you have Git installed.
- Access to a DHIS2 instance (Development, Test, and Production environments should be configured separately).
Open your terminal and run the following command to clone the repository:
git clone https://github.com/msfwaca/dhis2-program-indicators.git
cd dhis2-program-indicators
After cloning the repository, you need to configure your local DHIS2 environment where you will import the metadata. Follow these steps:
- Log in to your DHIS2 development instance.
- Navigate to Import/Export App.
- Select Metadata Import.
- Upload the appropriate metadata file from the cloned repository (
metadata.json
or other relevant files) to import it to the DHIS2 instance. - Review the import summary for any errors or warnings.
Once the metadata is successfully imported, you can begin editing program indicators, data elements, or other metadata. This can be done within the DHIS2 interface or via scripts if needed.
- Editing Program Indicators: Use the DHIS2 interface to update expressions, filters, or other configurations related to the program indicators.
- Testing Changes: Make sure to review the changes using the Analytics App and run tests to ensure that the indicators are working as expected.
After making the required changes in the dev environment, test the functionality of the program indicators by following these steps:
- Run Analytics: Run analytics within the Analytics App to verify that data is being aggregated correctly.
- Test Reports: Verify that the changes reflect accurately in reports or dashboards.
- Log Errors: If any errors or issues arise, capture the logs and address them in the dev environment.
Once all changes are verified and functional, proceed to the next step.
- Log in to your DHIS2 development instance.
- Navigate to Import/Export App and select Metadata Export.
- Choose the necessary objects (program indicators, data elements, etc.) for export.
- Download the metadata export file.
- Log in to the DHIS2 test environment.
- Navigate to the Import/Export App.
- Select Metadata Import and upload the metadata file you exported from the dev environment.
- Run tests to verify that the indicators and metadata are working as expected.
Once the testing is complete and validated in the test environment:
- Log in to the DHIS2 production environment.
- Import the metadata using the Import/Export App following the same steps as before.
- Monitor the production instance to ensure smooth deployment and no issues post-import.
If you want to contribute to this project:
- Fork the repository.
- Make your changes on a new branch.
- Open a pull request for review.
Please adhere to the coding standards and best practices mentioned in the contribution guidelines.