📔Import Social Registry Data into PBMS
Last updated
Last updated
Copyright © 2024 OpenG2P. This work is licensed under Creative Commons Attribution International LicenseCC-BY-4.0 unless otherwise noted.
This document provides instructions to import data from the Social Registry (SR) into Program Beneficiary Management Systems' (PBMS) individual/group registries.
A user must have an Administrator role to access the OpenG2P systems.
You must follow the procedures listed below to import data from the SR into the PBMS.
Click the main icon and select Settings.
Settings screen is displayed.
Click the Data Source tab.
Data Source screen is displayed.
Click the New button.
Data Source New screen is displayed.
The fields and their descriptions are given below.
Table 1: New data source
Field | Description |
---|---|
Data Source Name | Enter the source name from where the data is imported. |
Target URL | Enter the URL for the API request from where the data is retrieved. |
Auth Type | Select the type of authentication from the drop-down. It is used to verify the legitimacy of the user. The valid values are:
|
Click the URL Paths tab.
Click the Add a line link.
Enter the Data Source Path Name and the associated URL Path.
Table 2: Icons and their functions
Icon | Click to |
---|---|
Select the appropriate value. The available values are:
| |
Save manually the individual data and exit from the screen. | |
Discard changes and exit from the screen. |
Sample data source screen
You can find the newly created data source listed in the Data Source screen.
After configuring SR into PBMS, follow the below procedure.
Programs screen is displayed.
Click the Import From Registry from the menu bar.
Previous Search Criterias screen is displayed.
Click the New button.
Previous Search Criterias New screen is displayed.
The fields and their description are given below.
Field | Description |
---|---|
Name | Enter the name of the new search criterias. |
Data Source | Enter the name of the data source name as mentioned in Table 1 in the preceding section. |
Import Registrant without ID | Check the box to import registrant without ID, if required. |
Target Registry | Select the target registry from the drop-down. The valid values are:
|
Target Program | Select the target program from the drop-down. Note: You can also use the Search More or Start typing options from the drop-down, to select the desired program. |
Query | Enter the GraphQL query to import only the required data from the SR. |
Last synced on | Enter the previous date of SR's PBMS synchronization to import data. Note: You can also use the calendar widget feature to select the date. |
Imported Registrants | Shows the imported registrants' information. Registrant - Displays the name of the group/individual Is Group - Shows if the registrant belongs to a group Created - Shows Updated - Shows if the registrant is updated. |
Click the Fetch button to import the data from SR into relevant individual/group registries of PBMS based on the GraphQL.
Icon | Click to |
---|---|
Select the appropriate value. The available values are:
| |
Save manually the entered data and exit from the screen. | |
Discard changes and exit from the screen. |
Sample previous search criterias screen
You can find the newly created one listed in the previous search criterias screen.
Click the main icon and select Programs.