You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"description": "Step-by-step guide for installing and configuring OpenSPP modules including SP-MIS, Social Registry, and Farmer Registry"
6
+
"keywords": "OpenSPP, modules, installation, Odoo, SP-MIS, Social Registry, Farmer Registry"
7
+
---
8
+
9
+
# Farmer Registry installation
10
+
11
+
**OpenSPP Farmer Registry Base / spp_base_farmer_registry**
12
+
13
+
The {doc}`OpenSPP Farmer Registry <../overview/products/farmer_registry>` configuration enables convergence between social protection and agricultural development programs. This setup is designed for organizations supporting smallholder farmers, managing agricultural subsidies, or implementing climate-smart agriculture initiatives.
14
+
15
+
**What's included:**
16
+
- Farmer and farm household registration
17
+
- Land parcel mapping with GIS integration
18
+
- Crop and livestock tracking
19
+
- Agricultural input distribution management
20
+
- Seasonal cycle management
21
+
- Integration with agricultural extension services
22
+
23
+
**Installation steps:**
24
+
25
+
1. Navigate to the **Apps** menu.
26
+
2. In the Apps menu, search for {doc}`spp_base_farmer_registry </reference/modules/spp_base_farmer_registry>` or "OpenSPP Farmer Registry Base"
27
+
28
+
29
+
30
+
3. Click the **Activate** button to install the module and its dependencies.
**Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart.
2. Install {doc}`SP-MIS <spmis_installation>`, {doc}`Social Registry <social_installation>`, or {doc}`Farmer Registry <farmer_installation>` from the available modules.
Choose {doc}`SP-MIS <../overview/products/sp_mis>`, {doc}`Social Registry <../overview/products/social_registry>`, or {doc}`Farmer Registry <../overview/products/farmer_registry>`
27
+
<br>
26
28
27
-
3.**Initial setup**
28
-
Configure your first program and import data
29
+
3. Get your system ready for use:
30
+
- Create your first program - {doc}`Creating a Program <../user_guide/program_management/create_program>`
31
+
- Import beneficiary data - {doc}`Registry Management <../user_guide/registry_management/index>`
32
+
- Configure user access - {doc}`Administration <../user_guide/administration/index>`
33
+
29
34
::::
30
35
31
-
::::{grid-item-card} Learn the system
32
-
Explore OpenSPP's capabilities:
36
+
::::{grid-item-card} I want to select my modules freely
37
+
38
+
1. {doc}`Install OpenSPP on Debian/Ubuntu (30 minutes) <installation_deb>`
39
+
40
+
<br>
41
+
42
+
2. Choose modules to install. Read more about {doc}`module installation <module_installation>` and {doc}`available modules <../reference/modules/index>`
43
+
44
+
<br>
33
45
34
-
-**{doc}`Features <../overview/features/index>`** - Understand key features
35
-
-**{doc}`Products <../overview/products/index>`** - Choose the right product configuration
OpenSPP's modular architecture allows organizations to deploy only the features they need. Built on Odoo 17, the platform extends functionality through specialized modules that can be mixed and matched to create tailored social protection solutions. This guide covers installing OpenSPP modules for different use cases.
12
12
13
-
## Prerequisites
14
-
15
-
Before installing OpenSPP modules, ensure you have:
16
-
17
-
-**Odoo 17 instance** running and accessible
18
-
-**OpenSPP modules** source code from the [OpenSPP repository](https://github.com/OpenSPP/openspp-modules/tree/17.0/)
19
-
-**Addons path** configured to include the `openspp-modules` directory
20
-
-**Administrator access** to your Odoo instance
21
-
-**Developer mode** knowledge (required for module installation)
22
-
23
-
:::{tip}
24
-
For development setup instructions, see the {doc}`Development Setup Guide <../developer_guide/setup>`.
13
+
:::{important}
14
+
Before installing OpenSPP modules, ensure you have an **Odoo 17 instance** running and accessible. If not, follow the {doc}`Installation guide <installation_deb>` in order to install it.
25
15
:::
26
16
27
-
## General installation process
28
-
29
-
Installing an Odoo module, including those for OpenSPP, follows a standard procedure:
17
+
## Installing OpenSPP base modules
30
18
31
-
1.**Place Modules in Addons Path**: Ensure the `openspp-modules` directory is included in your Odoo configuration's `addons_path`.
32
-
2.**Update apps list**:
33
-
- Log in to your Odoo instance with administrator privileges.
34
-
- Activate the developer mode.
35
-
- Navigate to the **Apps** menu.
36
-
- Click on **Update Apps List** and confirm the update.
37
-
3.**Install the module**:
38
-
- In the **Apps** menu, clear the default "Apps" filter from the search bar.
39
-
- Search for the desired module by its technical name or title.
40
-
- Click the **Activate** button on the module's card to begin the installation.
41
-
42
-
43
-
44
-
## Installation setups
45
-
46
-
OpenSPP can be configured in different ways depending on your project's needs. Below are the installation guides for three primary setups.
19
+
OpenSPP comes with three configured base modules depending on your needs. The steps on how to install these can be found in {doc}`Installation of OpenSPP Social Registry <social_installation>`, {doc}`Installation of OpenSPP SP-MIS <spmis_installation>` and {doc}`Installation of OpenSPP Farmer Registry <farmer_installation>`.
47
20
48
21
:::{important}
49
-
The **SP-MIS** ({doc}`spp_base </reference/modules/spp_base>`), and **Farmer Registry** ({doc}`spp_farmer_registry_base </reference/modules/spp_farmer_registry_base>`) modules are mutually exclusive. You can only have one of them installed in a single Odoo database. Attempting to install multiple base modules will result in an error.
22
+
The **SP-MIS** ({doc}`spp_base_spmis </reference/modules/spp_base_spmis>`), **Farmer Registry** ({doc}`spp_base_farmer_registry </reference/modules/spp_base_farmer_registry>`) and **Social Registry** ({doc}`spp_base_social_registry </reference/modules/spp_base_social_registry>`) modules are mutually exclusive. You can only have one of them installed in a single Odoo database. Attempting to install multiple base modules will result in an error.
50
23
:::
51
24
52
-
### 1. SP-MIS installation (spp_base)
53
-
54
-
The Social Protection Management Information System ({doc}`SP-MIS <../overview/products/sp_mis>`) configuration provides comprehensive functionality for managing social protection programs. This setup is ideal for organizations running cash transfers, social assistance programs, or humanitarian interventions.
55
-
56
-
**What's included:**
57
-
- Registry management for individuals and groups
58
-
- Program cycles and beneficiary enrollment
59
-
- Eligibility determination and targeting
60
-
- Entitlement calculation and management
61
-
- Payment processing integration
62
-
63
-
**Installation steps:**
64
-
65
-
1. Follow the General Installation Process to update your Apps list
66
-
2. In the Apps menu, search for {doc}`spp_base </reference/modules/spp_base>` or "OpenSPP Base"
67
-
68
-
69
-
70
-
3. Click the **Activate** button to install the module. This will also install all its dependencies, providing a complete SP-MIS foundation.
71
-
72
-
73
-
74
-
Once installed, you will see the "Registry" application in your Odoo dashboard, which is the main entry point for the OpenSPP system.
75
-
76
-
77
-
78
-
### 2. Social Registry installation (spp_registry_base)
79
-
80
-
The {doc}`Social Registry <../overview/products/social_registry>` configuration provides a centralized repository for beneficiary data that can be shared across multiple social protection programs. This setup is ideal for governments and organizations coordinating multiple interventions and requiring a single source of truth for beneficiary information.
81
-
82
-
**What's included:**
83
-
- Unified beneficiary database across programs
84
-
- Advanced deduplication and data quality management
85
-
- Dynamic registration and needs assessment
86
-
- Inter-program data sharing and coordination
87
-
- Household composition and relationship tracking
88
-
- Socioeconomic data collection and analysis
89
-
- Data privacy and access control mechanisms
90
-
91
-
**Installation steps:**
92
-
93
-
1. Follow the General Installation Process to update your Apps list
94
-
2. In the Apps menu, search for {doc}`spp_registry_base </reference/modules/spp_registry_base>` or "OpenSPP Social Registry"
95
-
3. Click the **Activate** button to install the module and its dependencies
96
-
97
-
Once installed, the Social Registry becomes the central hub for managing beneficiary data that can be accessed by various social protection programs.
The {doc}`Farmer Registry <../overview/products/farmer_registry>` configuration enables convergence between social protection and agricultural development programs. This setup is designed for organizations supporting smallholder farmers, managing agricultural subsidies, or implementing climate-smart agriculture initiatives.
27
+
After setting up your base system you can extend the functionality with additional modules. OpenSPP offers 60+ specialized modules covering various aspects of social protection delivery.
102
28
103
-
**What's included:**
104
-
- Farmer and farm household registration
105
-
- Land parcel mapping with GIS integration
106
-
- Crop and livestock tracking
107
-
- Agricultural input distribution management
108
-
- Seasonal cycle management
109
-
- Integration with agricultural extension services
29
+
:::{note}
30
+
Additional modules automatically detect and respect your base configuration (SP-MIS or Farmer Registry). Some modules are specific to one configuration, while others work with both.
31
+
:::
110
32
111
-
**Installation steps:**
33
+
## General installation process
112
34
113
-
1. Follow the general installation process to update your Apps list
114
-
2. In the Apps menu, search for {doc}`spp_farmer_registry_base </reference/modules/spp_farmer_registry_base>` or "OpenSPP Farmer Registry Base"
35
+
Installing an Odoo module, including those for OpenSPP, follows a standard procedure:
115
36
116
-
37
+
1. Navigate to the **Apps** menu.
117
38
118
-
3.Click the **Activate** button to install the module and its dependencies.
39
+
2.Search for the desired module by its technical name or title. If the module does not show up, clear the default "Apps" filter from the search bar.
3. Click the **Activate** button on the module's card to begin the installation.
121
42
122
-
## Installing additional modules
43
+
123
44
124
-
After setting up your base system (either SP-MIS or Farmer Registry), you can extend functionality with additional modules. OpenSPP offers 60+ specialized modules covering various aspects of social protection delivery.
45
+
4. Restart OpenSPP after installing the modules:
46
+
```bash
47
+
sudo systemctl restart openspp
48
+
```
125
49
126
-
:::{note}
127
-
Additional modules automatically detect and respect your base configuration (SP-MIS or Farmer Registry). Some modules are specific to one configuration, while others work with both.
128
-
:::
50
+
**Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart.
129
51
130
-
###Common extension modules
52
+
## Common extension modules
131
53
132
54
**Data management:**
133
55
-**Change request** ({doc}`spp_change_request </reference/modules/spp_change_request>`) - Workflow for reviewing and approving data modifications
@@ -144,41 +66,11 @@ Additional modules automatically detect and respect your base configuration (SP-
144
66
-**OpenID Connect** ({doc}`spp_oauth </reference/modules/spp_oauth>`) - Single sign-on and authentication
145
67
-**DCI API Server** ({doc}`spp_dci_api_server </reference/modules/spp_dci_api_server>`) - Data Collection Interface API
146
68
147
-
### Example: Installing change request module
148
-
149
-
Let's walk through installing the {doc}`Change Request </reference/modules/spp_change_request>` module as an example:
150
-
151
-
**Steps:**
152
-
153
-
1. Navigate to the **Apps** menu
154
-
2. Search for {doc}`spp_change_request </reference/modules/spp_change_request>` or "OpenSPP Change Request"
155
-
156
-
The **OpenSPP Entitlement: Cash** ({doc}`spp_entitlement_cash </reference/modules/spp_entitlement_cash>`) module adds functionality to manage cash-based entitlements for registrants.
165
-
166
-
**Steps:**
167
-
168
-
1. Navigate to the **Apps** menu.
169
-
2. Search for {doc}`spp_entitlement_cash </reference/modules/spp_entitlement_cash>` or "OpenSPP Entitlement: Cash".
170
-
171
-
"description": "Step-by-step guide for installing and configuring OpenSPP modules including SP-MIS, Social Registry, and Farmer Registry"
6
+
"keywords": "OpenSPP, modules, installation, Odoo, SP-MIS, Social Registry, Farmer Registry"
7
+
---
8
+
9
+
# Social Registry installation
10
+
11
+
**OpenSPP Social Registry Base / spp_base_social_registry**
12
+
13
+
The {doc}`OpenSPP Social Registry <../overview/products/social_registry>` configuration provides a centralized repository for beneficiary data that can be shared across multiple social protection programs. This setup is ideal for governments and organizations coordinating multiple interventions and requiring a single source of truth for beneficiary information.
14
+
15
+
**What's included:**
16
+
- Unified beneficiary database across programs
17
+
- Advanced deduplication and data quality management
18
+
- Dynamic registration and needs assessment
19
+
- Inter-program data sharing and coordination
20
+
- Household composition and relationship tracking
21
+
- Socioeconomic data collection and analysis
22
+
- Data privacy and access control mechanisms
23
+
24
+
**Installation steps:**
25
+
26
+
1. Navigate to the **Apps** menu.
27
+
2. In the Apps menu, search for {doc}`spp_base_social_registry </reference/modules/spp_registry_base>` or "OpenSPP Social Registry Base"
28
+
3. Click the **Activate** button to install the module and its dependencies
29
+
4. Restart OpenSPP after installing the module:
30
+
```bash
31
+
sudo systemctl restart openspp
32
+
```
33
+
34
+
**Note**: The `queue_job` module, which is essential for asynchronous background tasks, is automatically installed as a dependency of the main OpenSPP modules. It is also pre-configured as a `server_wide_module`, ensuring that background workers can process jobs correctly after a service restart.
35
+
36
+
Once installed, the Social Registry becomes the central hub for managing beneficiary data that can be accessed by various social protection programs.
0 commit comments