4.2.2. Reveal
4.2.2.1. Registration
The following steps describe how to register a Reveal external system. A Reveal external system enables the ability to import Geo-Object data with identifiers from a Reveal system and to read data using the REST API that includes the Reveal external identifiers:
Navigate to the Settings page.
Find the External Systems section and click the + button to open the Registration modal.\
Select 'Reveal' from the Type dropdown and fill out the modal fields.\
| GPR data type | Appropriate Reveal value types | Required |
|---|---|---|
Type | The type of external system. | Yes |
Organization | The organization you belong to. An external system will only be available to data and users within this organization. | Yes |
ID | The identifier for this external system. | Yes |
Label | The label of the external system. | Yes |
Description | The description of the external system. | No |
4.2.2.2. Import
If Geo-Object data is already present in a Reveal instance, it must first be imported to GeoPrism Registry using the ‘Import from an external system’ option in the Import module after the Reveal external system has been registered (see section 6.5.1.1). Uploading data from a Reveal system in this way stores the identifiers from the Reveal system data on the Geo-Objects that are imported/created in GeoPrism Registry. These Reveal identifiers will be used during synchronization to match GeoPrism Registry Geo-Objects with data in Reveal.
4.2.2.3. Synchronization
The Reveal external system registration enables the GeoPrism Registry REST API to be used to query Geo-Objects with Reveal identifiers in a Reveal format. Reveal external systems do not have a configurable interface for pushing data like DHIS2 systems, but automated synchronizations could be made with external programs that utilize the GeoPrism Registry REST API.
Last updated
