ODK Importer

Work in Progress

The Social Registry (SR) gathers registrants'/applicants' data through various mechanisms, one of which includes ODK forms to import data housed within ODK Central.

OpenG2P has built an ODK Importer module. It is specifically designed to tailor, configure the required field based on the ODK (Open Data Kit) form, and import the beneficiaries' relevant ODK form into SR module. ODK forms are customised in compliance with project requirements using the JSON Formatter. The benefits of using ODK Importer are:

  • Streamlines data transfer from ODK forms directly into SR modules.

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

  • Provides data import for automatic updates using the automated scheduler.

Feature and functionality

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.

ODK import

After the ODK configuration, the fields/parameters in the ODK form are mapped to the relevant fields in SR module using the JSON formatter. Navigate to the path Social Registry -> ODK -> ODK Import -> New. To learn more on ODK Import, refer to Configure and Import ODK Form.

Here is the sample ODK import configuration form.

Configuration

After the computation of required fields in SR, the SR module built on Odoo platform needs to be integrated with ODK Central to facilitate data collection and integration. SR module must be set up to automatically pull data from the ODK forms located in the ODK Central. Navigate to the path Social Registry -> ODK -> Configuration -> New. To learn more on Configuration, refer to Configure and Import ODK Form.

Here is the sample Configuration screen.

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

Below is the documentation link for the APIs used in the ODK configuration between ODK Central and SR.

Installation and deployment

Odoo installation

Configure and Import ODK Form.

Last updated

Logo

Copyright © 2024 OpenG2P. This work is licensed under Creative Commons Attribution International LicenseCC-BY-4.0 unless otherwise noted.