diff --git a/.gitbook/assets/odk-central-form.png b/.gitbook/assets/odk-central-form.png new file mode 100644 index 00000000..983f907b Binary files /dev/null and b/.gitbook/assets/odk-central-form.png differ diff --git a/.gitbook/assets/odkform-instanceid.png b/.gitbook/assets/odkform-instanceid.png new file mode 100644 index 00000000..459f9cac Binary files /dev/null and b/.gitbook/assets/odkform-instanceid.png differ diff --git a/.gitbook/assets/odkform-submissiontab.png b/.gitbook/assets/odkform-submissiontab.png new file mode 100644 index 00000000..66afd833 Binary files /dev/null and b/.gitbook/assets/odkform-submissiontab.png differ diff --git a/.gitbook/assets/odkform.png b/.gitbook/assets/odkform.png new file mode 100644 index 00000000..93d4e031 Binary files /dev/null and b/.gitbook/assets/odkform.png differ diff --git a/.gitbook/assets/odkimport-fetchrecord.png b/.gitbook/assets/odkimport-fetchrecord.png new file mode 100644 index 00000000..f53dbf11 Binary files /dev/null and b/.gitbook/assets/odkimport-fetchrecord.png differ diff --git a/.gitbook/assets/pbms-settings (1).png b/.gitbook/assets/pbms-settings (1).png new file mode 100644 index 00000000..611d791a Binary files /dev/null and b/.gitbook/assets/pbms-settings (1).png differ diff --git a/.gitbook/assets/pbms-settings-screen.png b/.gitbook/assets/pbms-settings-screen.png new file mode 100644 index 00000000..db0141ba Binary files /dev/null and b/.gitbook/assets/pbms-settings-screen.png differ diff --git a/SUMMARY.md b/SUMMARY.md index 502cbf8f..d9f90c78 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -116,6 +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) * [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) @@ -238,7 +239,7 @@ * [Administration / User Management](social-registry/features/administration/README.md) * [User Roles](social-registry/features/administration/user-roles.md) * [📔 User Guide](social-registry/features/administration/user-guide/README.md) - * [📔 Create User](social-registry/features/administration/user-guide/create-user.md) + * [📔 Create User](social-registry/functionality/administration/user-guide/create-user-and-assign-role.md) * [📔 Assign a Role to a User](social-registry/features/administration/user-guide/assign-a-role-to-a-user.md) * [Geographic](social-registry/features/geographic.md) * [MOSIP ID Validation and Tokenization](social-registry/features/id-verification.md) diff --git a/pbms/features/odk-importer/README.md b/pbms/features/odk-importer/README.md index 69cb94c9..e4da8e83 100644 --- a/pbms/features/odk-importer/README.md +++ b/pbms/features/odk-importer/README.md @@ -15,21 +15,19 @@ layout: # 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 ~~OpenG2P Systems~~ individual/group registries of PBMS module. The benefits of using ODK Importer are: +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 ~~OpenG2P Systems~~ PBMS module. +* 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 and functionality - -
Feature Functionality
Data Import
  • Allows users to import data from ODK forms into relevant fields within the OpenG2P Systems individual/group registries of PBMS module.
  • Streamlines the process of transferring data, collected in the field using ODK forms into the OpenG2P Systems PBMS module, ensuring accuracy and efficiency in data management.
  • Simplifies the process of entering data from the field using ODK forms into individual/group registries of 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 to Retrieve Specific Record.

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 {% embed url="https://miro.com/app/board/uXjVKcYGOyg=/?share_link_id=96965246843" %} -## **Process & Data Flow** +## **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. 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.md new file mode 100644 index 00000000..e917275b --- /dev/null +++ b/pbms/functionality/odk-importer/user-guides/import-specific-odk-forms.md @@ -0,0 +1,74 @@ +--- +layout: + title: + visible: true + description: + visible: false + tableOfContents: + visible: true + outline: + visible: true + pagination: + visible: true +--- + +# 📔 Import Specific ODK Forms + + + +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. + +## Prerequisites + +* A user must have an Administrator role to access ODK Central in OpenG2P systems. + +## Procedure + +1. Click the main icon ![](../../../../.gitbook/assets/menu-icon.png) and select _**Settings**_. + +
+ +_**Settings**_ screen is displayed. + +
+ +2. Select the _**General Settings**_ tab. +3. Select the _**ODK Import Settings**_ from the menu. +4. Check the _**Enable ODK Import InstanceID**_ box. + +### Occurrence of Instance ID field + +4. Use the main menu icon ![](../../../../.gitbook/assets/menu-icon.png) to navigate to ODK -> ODK Import. +5. Select the ODK Import from the current list. +6. Find an additional field labeled _**InstanceID**_ that appears at the bottom of the displayed screen. + +
+ +7. Enter the _**Instance ID**_. +8. Fill in the remaining fields following the [import record configuration](../../../features/odk-importer/user-guides/customize-the-odk-importer-configuration-based-on-the-odk-form-fields.md) procedure. +9. Click the _**Fetch Record**_ to import the specific applicants/registrants' ODK form relevant to the entered Instance ID. + +{% hint style="danger" %} +The PBMS module may be able to import duplicate applicant/registrants' ODK forms if the same Instance ID is used more than once. +{% endhint %} + +## Instance ID + +1. Log into the _**ODK central**_ with the valid credentials. +2. Select a form below the _**Projects**_ section. + +For example, here Group sample form is selected. + +
+ +3. Select the Group Sample form in the _**Group Sample form**_ screen. + +
+ +4. Click the _**Submission**_ tab. + +
+ +5. Find the Instance ID in the current list of submitted ODK forms. + +
diff --git a/social-registry/features/administration/user-guide/create-user.md b/social-registry/functionality/administration/user-guide/create-user-and-assign-role.md similarity index 100% rename from social-registry/features/administration/user-guide/create-user.md rename to social-registry/functionality/administration/user-guide/create-user-and-assign-role.md