Customize the ODK Importer Configuration based on the ODK Form Fields
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 step-by-step instructions to customize the ODK Importer configuration based on the ODK form fields to cater to the needs of the stake holders.
Note
Every ODK form must have its own ODK importer.
A user must have Administrator role to access ODK Central in OpenG2P systems.
A user must know the pyjq syntax to customize the value in the JSON Formatter fields.
Login to OpenG2P systems
ODK configuration screen is displayed.
Click the Create button.
ODK Configuration/New screen is displayed.
Enter the valid values to access ODK Central in OpenG2P systems and customize the ODK Importer configuration based on the ODK Form Fields
| Field | Description |
|---|---|
Start | Click the Start link to execute the schedule job to run periodically at fixed times, dates, or intervals. |
Restart | Click the Restart link to re-execute the schedule job to run periodically at fixed times, dates, or intervals. |
Stop | Click the Stop link to stop the execution of the schedule job. |
ODK Central | |
Name | Enter the name for the ODK importer. |
Base URL | Enter the URL of the ODK Central. |
Username | Enter the username which is used to login ODK Central |
Password | Enter the password which is used to login ODK Central |
Project details | |
Enter the project number. For example, 5 | |
**Form ID | Enter the ID of the form. For example, Household_data_collection |
Target settings | |
Target Registry | Select the appropriate option. The valid values are:
|
Use the pyjq library to manipulate JSON, based on the required fields in OpenG2P system. | |
Time interval | |
Interval in hours | Enter the time duration in hours to run the job automatically. |
Program details | |
ODK Program ID | Enter the program ID |
Save | Click the Save button to save the data |
Discard | Click the Discard to clear the data |
Test Connection feature establishes the connection between ODK Central and OpenG2P systems.
Click the Test Connection button.
If the Test Connection feature connects the ODK Central and OpenG2P systems successfully, a successful message pop ups.
If the Test Connection feature unable to connect the ODK Central and OpenG2P systems, an error message pop ups. Click the OK
Click the OK button to exit the dialog box.
Import Records feature imports and stores the records in Social Registry.
Click the Import Records button.
If the ODK form is imported successfully, a success message pops up.
If there is no new ODK form submitted, then ODK form records will not be imported.
A view of the ODK form recorded in Social Registry.
The below image shows the specific ODK form record.
The Household Data tab shows only the fields which are configured using pyjq JSON formatter in ODK importer. The fields are populated while the ODK form is imported to the Social Registry.
You can find the created ODK form below the name column in ODK Configuration screen.
This completes process of importing a ODK form into Social registry by customizing the ODK Importer configuration based on the ODK Form Fields.
---------------------------------------------------------------------------------------------------------------------
Follow the below steps to know the project ID taken from ODK Central.
Login to ODK Central.
ODK Central home page is displayed.
Here, for example, click the Household data collection form below the program Test.
The Household data collection form's overview screen is displayed.
In the URL , the number which is after the project is the project Id (5) (highlighted in yellow).
Follow the below steps to know the form ID taken from ODK Central.
Login to ODK Central.
ODK Central home page is displayed.
Here, for example, click the Household data collection form below the program Test.
The Household data collection form's overview form is displayed.
In the URL , the word which is after the forms is the form Id (Household_data_collection) (highlighted in yellow).
Configure the required fields based on the ODK form field using pyjq JSON formatter.
For example, ODK importer configures the required fields from Household data collection form present in ODK central in JSON Formatter box.
In the menu bar, click the icon and select ODK.
