ODK Importer

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 data into individual/group registries of the PBMS module. The benefits of using ODK Importer are:

• Streamlines data transfer from ODK forms directly into PBMS module.

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

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

Feature	Functionality
Data Import	Simplifies the process of entering data from the ODK forms' field into individual/group registries of the PBMS module, ensuring accuracy and effectiveness 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. Note: This feature is used when you want to retrieve data in bulk.
Fetch Records	This feature enables users to retrieve a specific record from the ODK system using the unique ODK Instance ID. It works similarly to the standard import record process but offers more precision by allowing users to target a single record based on its unique identifier. This is particularly useful when you need to retrieve specific record without importing the complete dataset. Note: Make sure you have completed the Configuration procedure to use this feature. To learn more on this feature, refer Import Specific ODK Form.
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. Increases total operational efficiency, streamlines tasks, saves time and resources.
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 relevant fields in individual/groups' registries in PBMS.

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 PBMS.

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 PBMS. It ensures that data collected in the ODK form is accurately mapped to the corresponding fields within the PBMS.

ODK Import

The ODK Importer imports files from ODK Central and define import settings using ODK Import feature. Navigate to the path PBMS -> ODK -> ODK Import -> New. To learn more on ODK Import, refer to Configure and Import ODK Form.

Configuration

The ODK Importer module requires configuration to establish a connection with ODK Central and the ODK form defines import parameters. Users can access the configuration settings through the ODK menu in the system. To learn more on Configuration, refer to Import/Configure ODK.

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

Configure and Import ODK Form