Skip to content

Home

Jump to bottom
Sergio Galan edited this page Sep 17, 2020 · 12 revisions

Overview

Welcome to the MetaData Synchronization (MDSync) user manual

If you work within the DHIS2 ecosystem, you are already aware that each instance of DHIS2 is a self-contained environment, and sharing data and metadata across multiple implementations can be a challenging and laborious process.

MetaData Sync is a DHIS2 application that has been conceived and designed to simplify and automate the process of sending data and metadata from one DHIS2 instance to one or several other DHIS2 implementations, however different they might be.

This tool will save you a lot of time and effort syncing data and metadata between diverse DHIS2 instances.

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/0670f832-f6db-483f-81cb-799fc49cb5da/eng.png

MD Sync can synchronize:

  • Metadata
  • Events
  • Aggregated data

Currently MetaData Sync is a "push-only" tool, this means that the instance that you configure will send data to remote instance, not retrieving data.

An instance running MD Sync can send data towards other instances (push) or retrieve data from other instances (pull). In this document we assume that we are configuring a the local instance to push data toward other instances.

Through this guide you will learn how to install and use it in your processes.

First, a quick overview of this guide:

  • Instance configuration you will learn how to setup the destination instance

  • Mapping is a great feature that allows you to synchronize data between instances with different metadata.

  • The synching chapter is a comprehensive guide to learn how to create synchronization processes for aggregated data, events and metadata.

  • Finally the rules section explains how to save and schedule synchronizations.

  • History is about keeping track of the synching operations you have made.

    The typical setup and use workflow with metadatasync involves these steps, and requieres different roles: Sysadmin, DHIS admin, MDSync configurator and MDSync run-only user

    https://s3-us-west-2.amazonaws.com/secure.notion-static.com/4cf3aa98-6503-4e5c-b3b2-33221af26c7e/workflow.png

With this information hopefully this main panel makes sense for you

https://s3-us-west-2.amazonaws.com/secure.notion-static.com/3ec8cb82-5e00-43f9-ad10-37c1e4eaf680/metaData_Sync_panel.png

Credits

This work has been funded by the Global Malaria Programme of WHO. If you like it, please contact them to say thanks ;)

Contributions

Like every other EyeSeeTea software, this is open source (GNU General Public License v3.0) Use it at your own responsibility as much as you want.

The source code is available at github We are very happy to receive any contribution, so please if you have yours, don't hesitate to send us your code.

DHIS2 Requirements

MetaData Synchronization is compatible with DHIS2 V2.30 to 2.34

eyeseeteadhis2suite_banner

mdsynclogo

English | Castellano | Français

See a video presentation of the app.

Clone this wiki locally