OpenSRP Concept Dictionary Synchronization
OpenSRP uses OpenMRS`s Metadata Sharing module for sharing concept data across implementation sites. For sharing data between central and implementation server both sites must have installed Metadata Sharing module module.
The Metadata Sharing Module allows all kinds of metadata (concepts, htmlforms, locations, roles, programs, etc.) to be exchanged between different OpenMRS installations. It supports metadata defined in the core as well as in modules provided appropriate handlers are registered. Conflicts between local and incoming metadata can be identified and resolved. The module can be used both through an API and a web interface.
Any dependent metadata will be packaged along with the selected item. For example, if you select a concept which has coded answers, it will package the initial concept along with all the coded answer concepts, class and datatype. If you select an htmlform, it will package the form along with the encounter type, all concepts used on that form, etc.
Below is a pictorial guide on the metadata sharing functionality..
Central server configuration:
- Set an implementation ID in http://yourcentralserver/openmrs/admin/maintenance/implementationid.form . OpenSRP central server implementation ID is opensrp and name is OpenSRP.
- Add a new concept source with name "OpenSRP" and HL7 Code "opensrp" from http://yourcentralserver/openmrs/admin/concepts/conceptSource.form.
- Add concept source to metadata mapping configuration from http://yourcentralserver/openmrs/module/metadatamapping/configure.form.
- Check the box "Add local concept mappings?" and Choose OpenSRP from dropdown.
- Check the box "Add local concept mappings?" and Choose OpenSRP from dropdown.
- Now configure your public url for publishing the exportable metadata created by this central server in http://yourcentralserver/openmrs/module/metadatasharing/configure.form in section "Publishing".
- Specify public url of central server like http://yourcentralserver/openmrs.
- Now to export an iteration of modified data "Create Package" from here http://yourcentralserver/openmrs/module/metadatasharing/export/list.form.
- Specify a name for export like OpenSRP-yyyyMMdd
- Check the box "Publish package". Note that if not checking this you will not be able to share the package with URL
- Add metadata to package, Select Concepts to export, and Export
- Wait patiently until task finishes. If you are exporting huge number of concepts then it may take a long time
- Once Completed "See Package", At the top you would get a URL for sharing with implementation server to import data.
Implementation server configuration:
- Configure server and add OpenSRP central server in trusted concept sources from http://yourchildserver/openmrs/module/metadatasharing/configure.form in section "Importing"
- Configure Notifications from server any updates in package
- Import package from http://yourchildserver/openmrs/module/metadatasharing/import/upload.form and provide the url shared for the package in "Package URL". Alternatively you can upload zip file if shared by team.
- Move "Next" and wait until data is analyzed
- Choose "Master" from source type since you are importing metadata from master server.
- Make sure that all options selected are "Prefer theirs"
- Assess and choose "Prefer theirs for all existing concepts"
- Once imported "Subscribe to package" so that any updates could be notified
This site is no longer maintained. Please visit docs.opensrp.io for current documentation.