# Configure and Import ODK Form This document provides step-by-step instructions for configuring the ODK central into the PBMS 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 PBMS. Note: Every ODK form must have its own ODK importer. ## Prerequisites * A user must have an Administrator role to access ODK Central in OpenG2P systems. * A user must know the pyjq syntax to customise the value in the JSON Formatter fields. ## Procedure 1. Click the main icon ![](https://1895884874-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FnKdOHLbjDdIln1QDNwSx%2Fuploads%2Fgit-blob-04035215d78b73c4cc8238ae5303c552b094ec15%2Fmenu-icon.png?alt=media) and select ODK.
***ODK*** screen is displayed. You can find two tabs. * [ODK Import](#odk-import) * [Configuration](#odk-configuration) ### ODK Import By default, ODK -> ODK Import page is displayed.
2. Click the **New** button. ***ODK Import New*** screen is displayed.
The fields and their descriptions are given below. 3. Customize the ODK Importer based on the ODK form fields
ParametersDescription
ODK CONFIGURATION
ODK ConfigThe name of the ODK configuration
TARGET SETTINGS
Target Registry

Specifies whether imported records should be associated with individual or group registries within the PBMS.

Select the appropriate value from the drop-down. The valid values are:

  • Individual
  • Groups
JSON FormatterEnables users to define a custom JSON formatter for transforming retrieved data before importing it into the PBMS. 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.
PROGRAM DETAILS
ProgramMap the registrant into the program.
Test Connection
  • Verifies the established connection between the ODK Importer and ODK Central.
  • Ensures that the ODK Importer can effectively communicate with ODK Central, the server hosting the ODK forms.
  • Enables seamless data transfer between the two systems
Import Records
  • Tracks the progress of data import and identifies any errors that may occur during the process.
  • Provides users with real-time updates on the status of their data import, allowing them to quickly address any issues and ensure a smooth import process.
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. | ### Configuration 4. Click the tab ***Configuration*** in the menu bar. ***Configuration*** screen is displayed.
5. Click the ***New*** button. ***Configuration New*** screen is displayed.
The fields and their descriptions are given below. 6. Enter the valid values to access ODK Central in OpenG2P systems. | 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 login 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 ***Test Connection*** feature establishes the connection between ***ODK Central*** and ***PBMS***. 7. Click the ***Test Connection*** button. If the ***Test Connection*** feature connects the ***ODK Central*** and ***PBMS*** 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.
8. Click the ***OK*** button to exit the dialog box. ### Import Records ***Import Records*** feature imports and stores the records in PBMS. 9. 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 PBMS. ### JSON Formatter Configure the required fields based on the ODK form field using pyjq JSON formatter. **Sample JSON Formatter**

JSON Formatter