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 |
|
Test Connection |
|
Import Records |
Note: This feature is used when you want to retrieve data in bulk. |
Fetch Records |
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 |
|
Automated Scheduler |
|
Feature | Functionality |
---|---|
Data Import |
|
Test Connection |
|
Import Records |
Note: This feature is used when you want to retrieve data in bulk. |
Fetch Records |
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 |
|
Automated Scheduler |
|
Parameters | Description |
---|---|
ODK CONFIGURATION | |
ODK Config | The 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:
|
JSON Formatter | Enables 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 |
|
Import Records |
|
Start/Stop | Start executes the scheduled job to run periodically at fixed times, dates, or intervals. Stop terminates the scheduled job. |
Parameters | Description |
---|---|
ODK CONFIGURATION | |
ODK Config | The 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:
|
JSON Formatter | Enables 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 | |
Program | Map the registrant into the program. |
Test Connection |
|
Import Records |
|
Start/Stop | Start executes the scheduled job to run periodically at fixed times, dates, or intervals. Stop terminates the scheduled job. |