diff --git a/SUMMARY.md b/SUMMARY.md index 153a6b49..015c4684 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -10,6 +10,10 @@ * [📔 Import CSV file to Social Registry](social-registry/features/individuals-and-groups/user-guides/import-csv-file-to-social-registry.md) * [Offline Assisted Registration](social-registry/features/offline-assisted-registration/README.md) * [Enumerator ID](social-registry/features/offline-assisted-registration/enumerator-id.md) + * [ODK Importer](social-registry/features/offline-assisted-registration/odk-importer/README.md) + * [📔 User Guide](social-registry/features/offline-assisted-registration/odk-importer/user-guide/README.md) + * [📔 Configure and Import ODK Form](social-registry/features/offline-assisted-registration/odk-importer/user-guide/configure-and-import-odk-form.md) + * [📔 Import Specific ODK Forms using ODK Instance ID](social-registry/features/offline-assisted-registration/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md) * [Online Self Registration](social-registry/features/online-self-registration.md) * [Online Assisted Registration](social-registry/features/online-assisted-registration/README.md) * [📔 User Guides](social-registry/features/online-assisted-registration/user-guides/README.md) @@ -62,11 +66,6 @@ * [Unique Social ID](social-registry/features/unique-social-id.md) * [Audit Logs](social-registry/features/audit-log.md) * [Rapid Deployment Framework](social-registry/features/rapid-deployment-framework.md) - * [Modules](social-registry/modules/README.md) - * [ODK Importer](social-registry/modules/odk-importer/README.md) - * [📔 User Guide](social-registry/modules/odk-importer/user-guide/README.md) - * [📔 Configure and Import ODK Form](social-registry/modules/odk-importer/user-guide/configure-and-import-odk-form.md) - * [📔 Import Specific ODK Forms using ODK Instance ID](social-registry/modules/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md) * [Versions](social-registry/versions.md) * [Deployment](social-registry/deployment/README.md) * [Domain names and Certificates](social-registry/deployment/domain-names-and-certificates.md) diff --git a/social-registry/modules/odk-importer/README.md b/social-registry/features/offline-assisted-registration/odk-importer/README.md similarity index 96% rename from social-registry/modules/odk-importer/README.md rename to social-registry/features/offline-assisted-registration/odk-importer/README.md index 59e3cbfe..2c5a20ff 100644 --- a/social-registry/modules/odk-importer/README.md +++ b/social-registry/features/offline-assisted-registration/odk-importer/README.md @@ -35,7 +35,7 @@ After the ODK configuration, the fields/parameters in the ODK form are mapped to Here is the sample ODK import configuration form. -
+
## Configuration @@ -43,7 +43,7 @@ After the computation of required fields in SR, the SR module built on Odoo plat Here is the sample _**Configuration**_ screen. -
+
## **Source code** diff --git a/social-registry/modules/odk-importer/user-guide/README.md b/social-registry/features/offline-assisted-registration/odk-importer/user-guide/README.md similarity index 100% rename from social-registry/modules/odk-importer/user-guide/README.md rename to social-registry/features/offline-assisted-registration/odk-importer/user-guide/README.md diff --git a/social-registry/modules/odk-importer/user-guide/configure-and-import-odk-form.md b/social-registry/features/offline-assisted-registration/odk-importer/user-guide/configure-and-import-odk-form.md similarity index 74% rename from social-registry/modules/odk-importer/user-guide/configure-and-import-odk-form.md rename to social-registry/features/offline-assisted-registration/odk-importer/user-guide/configure-and-import-odk-form.md index 8fb0c4e7..017323c5 100644 --- a/social-registry/modules/odk-importer/user-guide/configure-and-import-odk-form.md +++ b/social-registry/features/offline-assisted-registration/odk-importer/user-guide/configure-and-import-odk-form.md @@ -27,9 +27,9 @@ Every ODK form must have its own ODK importer. ## Procedure -1. Click the main icon ![](../../../../.gitbook/assets/menu-icon.png) and select ODK. +1. Click the main icon ![](../../../../../.gitbook/assets/menu-icon.png) and select ODK. -
+
_**ODK**_ screen is displayed. You can find two tabs. @@ -40,13 +40,13 @@ _**ODK**_ screen is displayed. You can find two tabs. By default, ODK -> ODK Import page is displayed. -
+
2. Click the **New** button. _**ODK Import New**_ screen is displayed. -
+
The fields and their descriptions are given below. @@ -54,9 +54,13 @@ The fields and their descriptions are given below.
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 SR.

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

-
IconClick to

Select the appropriate value. The available values are:

  • Archive
  • Duplicate
  • Change Password
  • Disable two-factor authentication
  • Send Password Reset Instructions
  • Privacy Lookup
Save manually the individual data and exit from the screen.
Discard changes and exit from the screen.
-
+ +
IconClick to

Select the appropriate value. The available values are:

  • Archive
  • Duplicate
  • Change Password
  • Disable two-factor authentication
  • Send Password Reset Instructions
  • Privacy Lookup
Save manually the individual data and exit from the screen.
Discard changes and exit from the screen.
+ + + +
## Configuration @@ -64,13 +68,13 @@ The fields and their descriptions are given below. _**Configuration**_ screen is displayed. -
+
5. Click the _**New**_ button. _**Configuration New**_ screen is displayed. -
+
The fields and their descriptions are given below. @@ -87,7 +91,7 @@ The fields and their descriptions are given below. **Sample ODK form URL** -
+
### Test Connection @@ -97,11 +101,11 @@ _**Test Connection**_ feature establishes the connection between _**ODK Central* If the _**Test Connection**_ feature connects the _**ODK Central**_ and _**SR**_ successfully, a successful message pop ups. -
+
If the _**Test Connection**_ feature unable to connect the _**ODK Central**_ and _**SR**_, an error message pop ups. -
+
8. Click the _**OK**_ button to exit the dialog box. @@ -113,11 +117,11 @@ _**Import Records**_ feature imports and stores the records in SR. If the ODK form is imported successfully, a success message pops up. -
+
If no new ODK forms are submitted, ODK form records will not be imported. -
+
You can find the configuration details in the _**ODK Configuration**_ screen and imported ODK forms' status in the _**ODK Import**_ screen. @@ -129,4 +133,4 @@ Configure the required fields based on the ODK form field using pyjq JSON format **Sample JSON Formatter** -

JSON Formatter

+

JSON Formatter

diff --git a/social-registry/modules/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md b/social-registry/features/offline-assisted-registration/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md similarity index 67% rename from social-registry/modules/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md rename to social-registry/features/offline-assisted-registration/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md index f1dcb907..c8ad925f 100644 --- a/social-registry/modules/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md +++ b/social-registry/features/offline-assisted-registration/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md @@ -22,11 +22,11 @@ This document provides instructions for importing specific applicants/registrant ## Procedure -1. Click the main icon ![](../../../../.gitbook/assets/menu-icon.png) and select _**Settings**_. +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. @@ -34,11 +34,11 @@ _**Settings**_ screen is displayed. ### Occurrence of Instance ID field -4. Use the main menu icon ![](../../../../.gitbook/assets/menu-icon.png) to navigate to ODK -> ODK Import. +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](configure-and-import-odk-form.md) procedure. @@ -55,16 +55,16 @@ The SR module may be able to import duplicate applicant/registrants' ODK forms 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/modules/README.md b/social-registry/modules/README.md deleted file mode 100644 index eb2e3d89..00000000 --- a/social-registry/modules/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# Sub Modules -