# Customize the ODK Importer Configuration based on the ODK Form Fields ## Description 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. ## Prerequisites * 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. ## Procedure 1. Login to ***OpenG2P*** systems

OpenG2P application

2. In the menu bar, click the icon ![](https://252389534-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FCwMntokukpQZjoCcqMwL%2Fuploads%2Fgit-blob-1b48611b7e3fc05b72b589735073c90404ac05ef%2Fimage.png?alt=media) and select ***ODK**.*

ODK

***ODK configuration*** screen is displayed.

ODK configuration

3. Click the **Create** button. ***ODK Configuration/New*** screen is displayed.

ODK Configuration/New

4. 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*** | | | \*[Project](#project) |

Enter the project number.

For example, 5

| | \*\*[Form ID](#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:

| | \*\*\*[JSON Formatter](#json-formatter) | 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 ***Test Connection*** feature establishes the connection between ***ODK Central*** and ***OpenG2P*** systems. 5. Click the ***Test Connection*** button. If the ***Test Connection*** feature connects the ***ODK Central*** and ***OpenG2P*** systems successfully, a successful message pop ups.

Test Connection - Successful

If the ***Test Connection*** feature unable to connect the ***ODK Central*** and ***OpenG2P*** systems, an error message pop ups. Click the OK 6. Click the ***OK*** button to exit the dialog box.

Test Connection - Failure

### Import Records ***Import Records*** feature imports and stores the records in Social Registry. 7. Click the ***Import Records*** button. If the ODK form is imported successfully, a success message pops up.

Import record - Success

If there is no new ODK form submitted, then ODK form records will not be imported.

Import record

A view of the ODK form recorded in Social Registry.

ODK form recorded

The below image shows the specific ODK form record.

Specific ODK form

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.

Populated fields

Populated fields

You can find the created ODK form below the name column in ***ODK Configuration*** screen.

ODK Configuration

This completes process of importing a ODK form into Social registry by customizing the ODK Importer configuration based on the ODK Form Fields. \--------------------------------------------------------------------------------------------------------------------- ### Project Follow the below steps to know the project ID taken from ODK Central. 1. 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). ### Form ID Follow the below steps to know the form ID taken from ODK Central. 1. Login to ***ODK Central***. ***ODK Central*** home page is displayed.

ODK Central Home screen

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). ### JSON Formatter 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.

JSON Formatter