ODK Importer

The ODK Importer is a module built by OpenG2P. It is specifically designed to tailor, configure the required field based on the ODK (Open Data Kit) form, and import the relevant ODK form of the beneficiaries into OpenG2P Systems. The benefits of using ODK Importer are:

• Streamlines data transfer from ODK forms directly into OpenG2P Systems

• Eliminates manual data entry, improves data accuracy and efficiency in data management

• Provides data import for automatic updates using automated scheduler

Feature and functionality

Feature	Functionality
Data Import	Allows users to import data from ODK forms into relevant fields within the OpenG2P Systems Streamlines the process of transferring data, collected in the field using ODK forms into the OpenG2P Systems, ensuring accuracy and efficiency in data management
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
Automated Data Processing	Removes the risk of manual error, ensuring higher accuracy in data records. Streamlines task, saves time and resources while enhancing overall operational efficiency.
Automated Scheduler	Allows smooth updates that do not require operator intervention. This capability enables rapid and regular changes to data sets, improving data currency and relevancy Automates the import process, improves workflow efficiency, and avoids delay in processing

Process workflow

Process & Data Flow

1. User initiates import: User selects the desired ODK form and configures import options.

2. Data Mapping: User establishes a mapping between corresponding fields in the ODK form using JSON-formatter (PYJQ) and the OpenG2P system.

3. Connection & Data Retrieval: Module connects to ODK Central and retrieves data based on the selected form and import options.

4. Data Import: Extracted data is imported into the designated fields within the OpenG2P system.

5. Import Status Update: User receives notification of successful import completion or encounters any errors.

Concepts

1. ODK Form: This is the source of data collection through the ODK. ODK forms are used to collect various types of data, such as beneficiary information in a structured format.

2. Mapping: Mapping defines the correspondence between fields in the ODK form and the OpenG2P system. It ensures that data collected in the ODK form is accurately mapped to the corresponding fields within the OpenG2P system.

Configuration

The ODK Importer module requires configuration to establish a connection with ODK Central and define import parameters. Users can access the configuration settings through the ODK menu in the system.

Configuration parameters

Parameters	Description
Base URL	The base URL of the ODK Central instance from which data will be retrieved
Username/Password	Login credentials for accessing ODK Central
Project ID	The unique identifier of the ODK project containing the data to be imported
Form ID	The unique identifier of the specific ODK form within the chosen project that holds the data for import
JSON Formatter	Enables users to define a custom JSON formatter for transforming retrieved data before importing it into the OpenG2P system. Refer to relevant documentation for details on utilizing the JSON formatter using PYJQ library
Target Registry	Specifies whether imported records should be associated with individual or group registries within the OpenG2P system. Available options are: Individual Groups
Interval in Hours (Optional)	Defines the interval (in hours) at which the import process should be automatically triggered. This allows for scheduled data updates.
ODK Program (Optional)	Map the registrant into the program using ODK Import

Source code

https://github.com/OpenG2P/openg2p-importers/tree/17.0-develop/g2p_odk_importer

Technical concepts

• Utilizes APIs to communicate with ODK Central for data retrieval.

• Implements error handling mechanisms for robust import processes.

API docs

• Documentation for APIs used in the ODK Importer module is available for reference.

• https://docs.getodk.org/central-api-accounts-and-users/

Installation and deployment

Odoo installation

Related user guides

📔Customize the ODK Importer Configuration based on the ODK Form