📔Configure and Import ODK Form
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 for configuring the ODK central into the Social Registry (SR) and importing the ODK form. After importing the ODK form, only the fields and their values customised using the JSON formatter are included in the individual/group registries of the SR.
Note:
Every ODK form must have its own ODK importer.
A user must have an Administrator role to access ODK Central in SR.
A user must know the pyjq syntax to customise the value in the JSON Formatter fields.
Click the main icon and select ODK.
ODK screen is displayed. You can find two tabs.
By default, ODK -> ODK Import page is displayed.
Click the New button.
ODK Import New screen is displayed.
The fields and their descriptions are given below.
Customize the ODK Importer based on the ODK form fields
| Parameters | Description |
|---|---|
ODK CONFIGURATION | |
ODK Config | The name of the ODK configuration |
TARGET SETTINGS | |
Target Registry | Specifies whether imported records should be associated with individual or group registries within the SR. Select the appropriate value from the drop-down. The valid values are:
|
JSON Formatter | Enables users to define a custom JSON formatter for transforming retrieved data before importing it into the SR. Refer to relevant documentation for details on utilizing the JSON formatter using PYJQ library. |
TIME INTERVAL | |
Interval in Hours (Optional) | Defines the interval (in hours) at which the import process should be automatically triggered. This allows for scheduled data updates. |
| |
| |
Start/Stop | Start executes the scheduled job to run periodically at fixed times, dates, or intervals. Stop terminates the scheduled job. |
| 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. |
Click the tab Configuration in the menu bar.
Configuration screen is displayed.
Click the New button.
Configuration New screen is displayed.
The fields and their descriptions are given below.
| Field | Description |
|---|---|
ODK Configuration | |
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 log in ODK Central |
Password | Enter the password which is used to login ODK Central |
Project details | |
Project | Enter the project number. For example, 3 |
Form ID | Enter the ID of the form. For example, Safety-Net-Program |
Sample ODK form URL
Test Connection feature establishes the connection between ODK Central and SR.
Click the Test Connection button.
If the Test Connection feature connects the ODK Central and SR successfully, a successful message pop ups.
If the Test Connection feature unable to connect the ODK Central and SR, an error message pop ups.
Click the OK button to exit the dialog box.
Import Records feature imports and stores the records in SR.
Click the Import Records button.
If the ODK form is imported successfully, a success message pops up.
If no new ODK forms are submitted, ODK form records will not be imported.
You can find the configuration details in the ODK Configuration screen and imported ODK forms' status in the ODK Import screen.
This completes the process of importing an ODK form from ODK Central into the SR.
Configure the required fields based on the ODK form field using pyjq JSON formatter.
Sample JSON Formatter
