Skip to content

Commit a14eab8

Browse files
committed
add GIS integration documentation for farmer registry
1 parent 619a0c4 commit a14eab8

File tree

16 files changed

+31
-78
lines changed

16 files changed

+31
-78
lines changed
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Integrate Geolocation
2+
3+
This guide provides step-by-step instructions for integrating geolocation platforms such as MapTiler with the OpenSPP Farmer Registry module to enhance area-based functionality.
4+
5+
## Prerequisites
6+
To enable geolocation integration in OpenSPP, ensure the following:
7+
- Your user account has the System Admin role. Learn more in this guide: {doc}`user_access`
8+
- Your OpenSPP instance installed Farmer registry base module. Learn more in this gu
9+
- You have an API Key for MapTiler to enable GIS functionality. You can retrieve this by checking their documentation [here](https://docs.maptiler.com/cloud/api/).
10+
- Developer mode in OpenSPP is enabled to allow configuration of the MapTiler key. For details, refer to the {doc}`../../developer_guide/developer_mode`
11+
12+
## Objective
13+
By the end of this guide, you will be able to configure MapTiler integration to support area-based features in the Farmer Registry.
14+
15+
## Process
16+
17+
### Setting Up the API Key for MapTiler
18+
As a System Admin, log in to your OpenSPP Farmer Registry instance. Go to **Settings**, then select **Technical**, and click **System Parameters**.
19+
20+
![Settings menu with Technical and System Parameters options](farmer_geolocation/farmer_geolocation_system_parameters.png)
21+
22+
Click the **New** button. Set the Key field to **spp_base_gis.map_tiler_api_key** and enter your MapTiler API Key in the **value** field.
23+
24+
![Setup farmer registry maptiler key](farmer_geolocation/farmer_geolocation_maptiler_key.png)
25+
26+
Click the **Save** button to apply the configuration. Refresh your browser to see the changes.
27+

docs/user_guide/registry_management/setting_up_farmer_registry/setup_farmer_registry_maptiler_key.png renamed to docs/user_guide/administration/farmer_geolocation/farmer_geolocation_maptiler_key.png

File renamed without changes.

docs/user_guide/registry_management/setting_up_farmer_registry/5.png renamed to docs/user_guide/administration/farmer_geolocation/farmer_geolocation_system_parameters.png

File renamed without changes.

docs/user_guide/administration/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ This section provides guides for a variety of administrative tasks and system ma
1515

1616
- {doc}`inventory_configuration`: Learn how to configure the necessary inventory settings to support in-kind and basket entitlements.
1717

18+
- {doc}`farmer_geolocation`: Guide to enabling geolocation integration in the OpenSPP Farmer Registry to improve area-based operations.
19+
1820
- {doc}`incoming_email_configuration`: A guide to setting up automatic email retrieval and processing from a designated incoming mailbox.
1921

2022
- {doc}`outgoing_email_configuration`: A guide to setting up outgoing email servers for automated messaging and data integration.
@@ -41,6 +43,7 @@ User access <user_access>
4143
Custom fields <custom_fields>
4244
Indicator fields <indicator_fields>
4345
Import areas <import_areas>
46+
Integrate Geolocation <farmer_geolocation>
4447
Service points <service_points>
4548
Inventory setup <inventory_configuration>
4649
Incoming email setup <incoming_email_configuration>

docs/user_guide/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Guides for managing registrant data and registry operations:
99

1010
- {doc}`registry_management/register_individual`
1111
- {doc}`registry_management/import_export_registrant_data`
12-
- {doc}`registry_management/setting_up_farmer_registry`
1312
- {doc}`registry_management/identity_management`
1413
- {doc}`registry_management/using_change_requests`
1514
- {doc}`registry_management/using_event_data`
@@ -37,6 +36,7 @@ Administrative tasks and system management:
3736
- {doc}`administration/indicator_fields`
3837
- {doc}`administration/import_areas`
3938
- {doc}`administration/inventory_configuration`
39+
- {doc}`administration/farmer_geolocation`
4040
- {doc}`administration/incoming_email_configuration`
4141
- {doc}`administration/outgoing_email_configuration`
4242
- {doc}`administration/hardware_integration`

docs/user_guide/registry_management/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,6 @@ This section provides essential guides for managing the core of OpenSPP: the reg
1111

1212
- {doc}`register_individual`: Details the process of manually creating individual and group records and associating individuals as members of a group.
1313

14-
- {doc}`setting_up_farmer_registry`: Instructions for installing and configuring the Farmer Registry module, including the generation of sample farmer data.
15-
1614
- {doc}`using_change_requests`: Explains how to use the Change Request module to update registrant information, including the workflow for initiating, validating, and approving changes.
1715

1816
- {doc}`using_event_data`: This guide explains how to use the Event Data feature to record and track significant occurrences related to registrants over time.
@@ -24,7 +22,6 @@ This section provides essential guides for managing the core of OpenSPP: the reg
2422
2523
Register individuals <register_individual>
2624
Import/Export data <import_export_registrant_data>
27-
Farmer Registry setup <setting_up_farmer_registry>
2825
Identity management <identity_management>
2926
Change requests <using_change_requests>
3027
Event data <using_event_data>

docs/user_guide/registry_management/setting_up_farmer_registry.md

Lines changed: 0 additions & 74 deletions
This file was deleted.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)