Skip to content

Commit c1317a9

Browse files
shibu-narayanangitbook-bot
authored andcommitted
GITBOOK-1333: No subject
1 parent 4de0468 commit c1317a9

File tree

5 files changed

+81
-95
lines changed

5 files changed

+81
-95
lines changed

SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,7 +492,7 @@
492492
* [OpenG2P Module Doc Template](guides/documentation-guides/openg2p-module-doc-template.md)
493493
* [Use Cases](use-cases/README.md)
494494
* [Farmer Registry](use-cases/farmer-registry/README.md)
495-
* [Farmer Registry: Reference Design](use-cases/farmer-registry/farmer-registry-reference-design.md)
495+
* [Reference Design - Farmer Registry](use-cases/farmer-registry/reference-design-farmer-registry.md)
496496
* [Releases](releases/README.md)
497497
* [1.1.0](releases/1.1.0/README.md)
498498
* [Release Notes](releases/1.1.0/release-notes.md)

g2p-bridge/development/developer-install/installing-openg2p-bridge-on-linux.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
---
2-
icon: laptop-code
32
description: Installation of G2P Bridge on a developer machine
43
---
54

use-cases/farmer-registry/README.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ A country's Department of Agriculture requires a registry of farmers to support
1515
3. Decision Support: Empowering policymakers with real-time data for better decision-making in agricultural programs and public expenditure.
1616
4. Data exchange: Ensuring seamless integration with other systems and data sources to enhance functionality and scalability
1717

18-
## OpenG2P Solution and Architecture
18+
## OpenG2P solution and architecture
19+
20+
The Farmer Registry is a comprehensive solution to capture, manage, share and analyze farmer data efficiently to provide a digital-first approach to farmer identification and management. It contains:\
1921

20-
The Farmer Registry is a comprehensive solution to capture, manage, share and analyze farmer data efficiently. It contains:
2122

2223
* Implementation of an offline ODK-based data collection system integrated with OpenG2P
2324
* Implementation of an online Registration Portal
@@ -32,11 +33,22 @@ The Farmer Registry key functions include **Data Collection, Data Validation and
3233

3334
OpenG2P supports the **Data Sharing** function by sharing data from the registry in a standardized manner. Analytics and Reporting includes reporting and dashboards using Apache Superset and the Reporting Framework, real-time system health monitoring, and revision history to track changes and generate reports.
3435

35-
## Key Processes and Features
36+
## Solution approach
37+
38+
Key objectives achieved include:
39+
40+
* **Structured registration**: A comprehensive registration system that captures essential farmer details such as personal information, land ownership, and farming activities.
41+
* **ID authentication**: The system supports biometric or OTP-based authentication to validate farmers.
42+
* **ODK-based data collection**: Offline and online data capture capabilities using ODK (Open Data Kit) for field-level data collection.
43+
* **Configurable deduplication**: Ensures unique farmer records through configurable deduplication based on IDs or biometric data.
44+
* **Registration portal:** An intuitive interface for the enrollment agents to enumerate farmer and their household data.
45+
* **Interoperability**: Designed to integrate with other systems like subsidy management, and agriculture extension services.
46+
47+
## Key processes and features
3648

3749
<details>
3850

39-
<summary>Data Collection</summary>
51+
<summary>Data collection</summary>
4052

4153
* _Offline assisted registration_: Offline assisted enumeration enables us to reach remote farmers who may not have internet connectivity. Data is collected by a field enumerator using the ODK application on tablets and stored in ODK Central, and then imported into the farmer registry. The enumerator's login details are also stored within the registry, to monitor the data collection.
4254

@@ -50,7 +62,7 @@ OpenG2P supports the **Data Sharing** function by sharing data from the registry
5062

5163
<details>
5264

53-
<summary>Data Validation and Enrichment</summary>
65+
<summary>Data validation and enrichment</summary>
5466

5567
* _Farmer ID generation_: Unique Farmer ID is generated to ensure accurate and efficient tracking, as well as to enhance data consistency and integration with other systems. The ID is generated using MOSIP's sophisticated ID generator which applies multiple rules before assigning an ID, and the generation process is managed through a background task system that handles status updates, retries, and eventual confirmation of ID utilisation.
5668

@@ -68,15 +80,15 @@ OpenG2P supports the **Data Sharing** function by sharing data from the registry
6880

6981
<details>
7082

71-
<summary>Data Sharing</summary>
83+
<summary>Data sharing</summary>
7284

7385
_Data Sharing_: Data stored in the registry can be easily shared in a standardized manner, making the information reusable by third parties for farmer and agricultural insights.
7486

7587
</details>
7688

7789
<details>
7890

79-
<summary>Analytics and Reporting</summary>
91+
<summary>Analytics and reporting</summary>
8092

8193
* _Reporting and Dashboards_: OpenG2P's monitoring and logging tools allow program administrators to track the progress of the registry, and keep an eye on system health. They can do this through:
8294
1. Visual dashboards for monitoring using Apache Superset
@@ -87,16 +99,14 @@ _Data Sharing_: Data stored in the registry can be easily shared in a standardiz
8799

88100
</details>
89101

90-
## Data Model
102+
## Data model
91103

92104
* Basic details of the farmer and household - name, location, ID, education, etc
93105
* Land area, parcel ID, geo-location, ownership details &#x20;
94106
* Data on crop, livestock, inputs, access to finance&#x20;
95107
* Membership and role in farmer organizations
96108

97-
## Deployment
98-
99-
## Reference Design
109+
## Reference design
100110

101-
Pleas click [here](farmer-registry-reference-design.md) to know more about the referece design for Farmer Registry
111+
Please click [here](reference-design-farmer-registry.md) to know more about the reference design for Farmer Registry
102112

use-cases/farmer-registry/farmer-registry-reference-design.md

Lines changed: 0 additions & 81 deletions
This file was deleted.
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Reference Design - Farmer Registry
2+
3+
The OpenG2P Farmer Registry is designed to streamline the identification, registration, and verification of farmers in a structured and scalable manner. It aligns with the use case documented in [OpenG2P Farmer Registry Use Case](https://docs.openg2p.org/use-cases/farmer-registry) and provides a reference implementation based on OpenG2P principles. This reference design can be a base to start off your farmer registry implementation and further you may modify as per your farmer registry specification.&#x20;
4+
5+
## Use case&#x20;
6+
7+
Refer [Farmer Registry](./)
8+
9+
## Components&#x20;
10+
11+
Included The Farmer Registry solution comprises the following components, as reflected in the OpenG2P Reference Designs GitHub repository:&#x20;
12+
13+
* `g2p_farmer`: Core farmer registry model.
14+
* `g2p_farmer_rest_api`: REST API for accessing and managing farmer data.
15+
* `g2p_farmer_service_provider_portal`: Portal for service providers to manage farmer and household in their respective administrative area.
16+
* `g2p_lock_unlock`: Functionality for locking and unlocking farmer records.
17+
* `g2p_odk_importer_farmer`: Component for importing data collected via ODK (Open Data Kit).
18+
19+
## Source code
20+
21+
The entire source code for the reference design can be found in the GitHub [repository](https://github.com/OpenG2P/openg2p-reference-designs/tree/develop/farmer-registry)
22+
23+
## How to setup
24+
25+
Follow the developer installation guide provided for setting up OpenG2P on Linux: [Developer Install Guide](https://docs.openg2p.org/social-registry/developer-zone/developer-install/developer-install-of-openg2p-package-on-linux).
26+
27+
Once the OpenG2P setup is completed, proceed with the following steps specific to the Farmer Registry:
28+
29+
1. Navigate to the OpenG2P addons directory
30+
31+
```
32+
cd ~/odoo/custom-addons/
33+
```
34+
2. Clone the farmer registry repository
35+
36+
```
37+
git clone https://github.com/OpenG2P/openg2p-reference-designs.git
38+
```
39+
3. Adjust Odoo configuration
40+
41+
* Update the `odoo.conf` file to include the Farmer Registry module path:
42+
43+
```
44+
addons_path = /home/odoo/odoo/addons,/home/odoo/custom-addons/openg2p-reference-designs/farmer-registry
45+
```
46+
4. Restart odoo
47+
48+
```
49+
sudo systemctl restart odoo
50+
```
51+
5. Activate the farmer registry module
52+
* Log into Odoo and navigate to **Apps**.
53+
* Enable Developer Mode.
54+
* Search for `Farmer Registry` and install the module.
55+
6. Configure farmer registry settings
56+
* Set up deduplication rules and ODK integration under module settings.
57+
58+
## Deployment

0 commit comments

Comments
 (0)