diff --git a/.gitbook/assets/odk-import-new.png b/.gitbook/assets/odk-import-new.png index 3163a875..9519476b 100644 Binary files a/.gitbook/assets/odk-import-new.png and b/.gitbook/assets/odk-import-new.png differ diff --git a/SUMMARY.md b/SUMMARY.md index b20cc4ae..186e60b1 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -116,7 +116,7 @@ * [ODK Importer](pbms/features/odk-importer/README.md) * [📔 User Guides](pbms/features/odk-importer/user-guides/README.md) * [📔 Configure and Import ODK Form](pbms/features/odk-importer/user-guides/customize-the-odk-importer-configuration-based-on-the-odk-form-fields.md) - * [📔 Import Specific ODK Forms](pbms/functionality/odk-importer/user-guides/import-specific-odk-forms.md) + * [📔 Import Specific ODK Forms using Instance ID](pbms/functionality/odk-importer/user-guides/import-specific-odk-forms-using-instance-id.md) * [MTS Connector](pbms/functionality/mts-connector/README.md) * [📔 User Guides](pbms/functionality/mts-connector/user-guides/README.md) * [📔 Create MTS Connector](pbms/user-guides/eligibility-and-program-enrollment/mts-connector/create-mts-connector/README.md) diff --git a/pbms/features/odk-importer/README.md b/pbms/features/odk-importer/README.md index e4da8e83..4bdf0619 100644 --- a/pbms/features/odk-importer/README.md +++ b/pbms/features/odk-importer/README.md @@ -21,7 +21,7 @@ OpenG2P has built an ODK Importer module. It is specifically designed to tailor, * 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 field using ODK forms 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
+
Feature Functionality
Data Import
  • Simplifies the process of entering data from the field using ODK forms 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 diff --git a/pbms/features/odk-importer/user-guides/customize-the-odk-importer-configuration-based-on-the-odk-form-fields.md b/pbms/features/odk-importer/user-guides/customize-the-odk-importer-configuration-based-on-the-odk-form-fields.md index 69156b1c..6c1baa91 100644 --- a/pbms/features/odk-importer/user-guides/customize-the-odk-importer-configuration-based-on-the-odk-form-fields.md +++ b/pbms/features/odk-importer/user-guides/customize-the-odk-importer-configuration-based-on-the-odk-form-fields.md @@ -52,7 +52,7 @@ 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.
ODK Program (Optional)Map the registrant into the program using ODK Import.
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.

+
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 | | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -111,7 +111,7 @@ If the _**Test Connection**_ feature unable to connect the _**ODK Central**_ and ### Import Records -_**Import Records**_ feature imports and stores the records in Social Registry. +_**Import Records**_ feature imports and stores the records in PBMS. 9. Click the _**Import Records**_ button. diff --git a/pbms/functionality/odk-importer/user-guides/import-specific-odk-forms.md b/pbms/functionality/odk-importer/user-guides/import-specific-odk-forms-using-instance-id.md similarity index 92% rename from pbms/functionality/odk-importer/user-guides/import-specific-odk-forms.md rename to pbms/functionality/odk-importer/user-guides/import-specific-odk-forms-using-instance-id.md index e917275b..b2fe3f02 100644 --- a/pbms/functionality/odk-importer/user-guides/import-specific-odk-forms.md +++ b/pbms/functionality/odk-importer/user-guides/import-specific-odk-forms-using-instance-id.md @@ -12,11 +12,11 @@ layout: visible: true --- -# 📔 Import Specific ODK Forms +# 📔 Import Specific ODK Forms using Instance ID -This document provides instructions for importing specific applicants/registrants' ODK forms hosted in ODK Central. It uses the unique [**Instance ID**](import-specific-odk-forms.md#instance-id) of the ODK forms to import them into the PBMS modules' relevant individual/group registries. +This document provides instructions for importing specific applicants/registrants' ODK forms hosted in ODK Central. It uses the unique [**Instance ID**](import-specific-odk-forms-using-instance-id.md#instance-id) of the ODK forms to import them into the PBMS modules' relevant individual/group registries. ## Prerequisites