GITBOOK-1146: No subject

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)

social-registry/modules/odk-importer/README.md → social-registry/features/offline-assisted-registration/odk-importer/README.md

@@ -35,15 +35,15 @@ After the ODK configuration, the fields/parameters in the ODK form are mapped to
 
 Here is the sample ODK import configuration form.
 
-<figure><img src="../../../.gitbook/assets/odk-import-form (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../.gitbook/assets/odk-import-form (1).png" alt=""><figcaption></figcaption></figure>
 
 ## 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](user-guide/configure-and-import-odk-form.md).
 
 Here is the sample _**Configuration**_ screen.
 
-<figure><img src="../../../.gitbook/assets/odk-configuration.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../.gitbook/assets/odk-configuration.png" alt=""><figcaption></figcaption></figure>
 
 ## **Source code**
 

social-registry/modules/odk-importer/user-guide/configure-and-import-odk-form.md → 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.
 
-<figure><img src="../../../../.gitbook/assets/sr-odk.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/sr-odk.png" alt=""><figcaption></figcaption></figure>
 
 _**ODK**_ screen is displayed. You can find two tabs.
 
@@ -40,37 +40,41 @@ _**ODK**_ screen is displayed. You can find two tabs.
 
 By default, ODK -> ODK Import page is displayed.
 
-<figure><img src="../../../../.gitbook/assets/odk-import-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/odk-import-sr.png" alt=""><figcaption></figcaption></figure>
 
 2. Click the **New** button.
 
 _**ODK Import New**_ screen is displayed.
 
-<figure><img src="../../../../.gitbook/assets/odk-import-new-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/odk-import-new-sr.png" alt=""><figcaption></figcaption></figure>
 
 The fields and their descriptions are given below.
 
 3. Customize the ODK Importer based on the ODK form fields
 
 <table><thead><tr><th width="226">Parameters</th><th>Description</th></tr></thead><tbody><tr><td><strong>ODK CONFIGURATION</strong></td><td></td></tr><tr><td><strong>ODK  Config</strong></td><td>The name of the ODK configuration</td></tr><tr><td><strong>TARGET SETTINGS</strong></td><td></td></tr><tr><td><strong>Target Registry</strong></td><td><p>Specifies whether imported records should be associated with individual or group registries within the SR.</p><p>Select the appropriate value from the drop-down. The valid values are:</p><ul><li>Individual</li><li>Groups</li></ul></td></tr><tr><td><strong>JSON Formatter</strong></td><td>Enables 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 <a href="https://pypi.org/project/pyjq/">PYJQ library</a>.</td></tr><tr><td><strong>TIME INTERVAL</strong></td><td></td></tr><tr><td><strong>Interval in Hours (Optional)</strong></td><td>Defines the interval (in hours) at which the import process should be automatically triggered. This allows for scheduled data updates.</td></tr><tr><td><a href="configure-and-import-odk-form.md#test-connection"><strong>Test Connection</strong></a></td><td><ul><li>Verifies the established connection between the ODK Importer and ODK Central.</li><li>Ensures that the ODK Importer can effectively communicate with ODK Central, the server hosting the ODK forms.</li><li>Enables seamless data transfer between the two systems</li></ul></td></tr><tr><td><a href="configure-and-import-odk-form.md#import-records"><strong>Import Records</strong></a></td><td><ul><li>Tracks the progress of data import and identifies any errors that may occur during the process.</li><li>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.</li></ul></td></tr><tr><td><strong>Start/Stop</strong></td><td><p> <em><strong>Start</strong></em> executes the scheduled job to run periodically at fixed times, dates, or intervals.</p><p><em><strong>Stop</strong></em> terminates the scheduled job.</p></td></tr></tbody></table>
 
-<table><thead><tr><th width="108">Icon</th><th>Click to</th></tr></thead><tbody><tr><td><img src="../../../../.gitbook/assets/Actions.png" alt="" data-size="original"></td><td><p>Select the appropriate value. The available values are: </p><ul><li>Archive</li><li>Duplicate</li><li>Change Password</li><li>Disable two-factor authentication</li><li>Send Password Reset Instructions</li><li>Privacy Lookup</li></ul></td></tr><tr><td><img src="../../../../.gitbook/assets/icon-save-manually.png" alt="" data-size="original"></td><td>Save manually the individual data and exit from the screen.</td></tr><tr><td><img src="../../../../.gitbook/assets/discard-changes-icon.png" alt="" data-size="original"></td><td>Discard changes and exit from the screen.</td></tr></tbody></table>
 
-<figure><img src="../../../../.gitbook/assets/odk-import-form.png" alt=""><figcaption></figcaption></figure>
+
+<table><thead><tr><th width="108">Icon</th><th>Click to</th></tr></thead><tbody><tr><td><img src="../../../../../.gitbook/assets/Actions.png" alt="" data-size="original"></td><td><p>Select the appropriate value. The available values are: </p><ul><li>Archive</li><li>Duplicate</li><li>Change Password</li><li>Disable two-factor authentication</li><li>Send Password Reset Instructions</li><li>Privacy Lookup</li></ul></td></tr><tr><td><img src="../../../../../.gitbook/assets/icon-save-manually.png" alt="" data-size="original"></td><td>Save manually the individual data and exit from the screen.</td></tr><tr><td><img src="../../../../../.gitbook/assets/discard-changes-icon.png" alt="" data-size="original"></td><td>Discard changes and exit from the screen.</td></tr></tbody></table>
+
+
+
+<figure><img src="../../../../../.gitbook/assets/odk-import-form.png" alt=""><figcaption></figcaption></figure>
 
 ## Configuration
 
 4. Click the tab _**Configuration**_ in the menu bar.
 
 _**Configuration**_ screen is displayed.
 
-<figure><img src="../../../../.gitbook/assets/configuration-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/configuration-sr.png" alt=""><figcaption></figcaption></figure>
 
 5. Click the _**New**_ button.
 
 _**Configuration New**_ screen is displayed.
 
-<figure><img src="../../../../.gitbook/assets/configuration-new-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/configuration-new-sr.png" alt=""><figcaption></figcaption></figure>
 
 The fields and their descriptions are given below.
 
@@ -87,7 +91,7 @@ The fields and their descriptions are given below.
 
 **Sample ODK form URL**
 
-<figure><img src="../../../../.gitbook/assets/odkformurl-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/odkformurl-sr.png" alt=""><figcaption></figcaption></figure>
 
 ### 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.
 
-<figure><img src="../../../../.gitbook/assets/test-connection-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/test-connection-sr.png" alt=""><figcaption></figcaption></figure>
 
 If the _**Test Connection**_ feature unable to connect the _**ODK Central**_ and _**SR**_, an error  message pop ups.&#x20;
 
-<figure><img src="../../../../.gitbook/assets/test-connection-fail-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/test-connection-fail-sr.png" alt=""><figcaption></figcaption></figure>
 
 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.
 
-<figure><img src="../../../../.gitbook/assets/import-record-success.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/import-record-success.png" alt=""><figcaption></figcaption></figure>
 
 If no new ODK forms are submitted, ODK form records will not be imported.
 
-<figure><img src="../../../../.gitbook/assets/import-record-fail.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/import-record-fail.png" alt=""><figcaption></figcaption></figure>
 
 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**
 
-<figure><img src="../../../../.gitbook/assets/JSON-formatter-1.png" alt=""><figcaption><p>JSON Formatter</p></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/JSON-formatter-1.png" alt=""><figcaption><p>JSON Formatter</p></figcaption></figure>

social-registry/modules/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md → social-registry/features/offline-assisted-registration/odk-importer/user-guide/import-specific-odk-forms-using-odk-instance-id.md

@@ -22,23 +22,23 @@ 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. 
 
-<figure><img src="../../../../.gitbook/assets/odk-import-settings-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/odk-import-settings-sr.png" alt=""><figcaption></figcaption></figure>
 
 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.&#x20;
+4. Use the main menu icon ![](../../../../../.gitbook/assets/menu-icon.png) to navigate to ODK -> ODK Import.&#x20;
 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.
 
-<figure><img src="../../../../.gitbook/assets/instance-id-sr.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/instance-id-sr.png" alt=""><figcaption></figcaption></figure>
 
 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.
 
-<figure><img src="../../../../.gitbook/assets/odk-central-form.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/odk-central-form.png" alt=""><figcaption></figcaption></figure>
 
 3. Select the Group Sample form in the _**Group Sample form**_ screen.
 
-<figure><img src="../../../../.gitbook/assets/odkform.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/odkform.png" alt=""><figcaption></figcaption></figure>
 
 4. Click the _**Submission**_ tab.
 
-<figure><img src="../../../../.gitbook/assets/odkform-submissiontab.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/odkform-submissiontab.png" alt=""><figcaption></figcaption></figure>
 
 5. Find the Instance ID in the current list of submitted ODK forms.
 
-<figure><img src="../../../../.gitbook/assets/odkform-instanceid.png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../../../.gitbook/assets/odkform-instanceid.png" alt=""><figcaption></figcaption></figure>