Skip to content

Commit af57797

Browse files
authored
Merge pull request #66 from OpenSPP/refactor-structure-michael
Fix Module Index and Integrations Index
2 parents f1c795c + 9ee987a commit af57797

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

docs/developer_guide/integrations/index.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,15 @@ migration-notes: "Added during 2025 documentation reorganization"
77

88
# Integrations
99

10-
This section contains guides for integrating OpenSPP across external systems.
10+
This section provides comprehensive guides for connecting OpenSPP with external systems, identity providers, and other digital public infrastructure components. These integrations are key to building a robust and interoperable social protection ecosystem.
11+
12+
Here, you will find detailed instructions and best practices for:
13+
14+
- **Digital Convergence Initiative (DCI)**: Learn how to implement the DCI specification to enable seamless data exchange between OpenSPP and other registries, such as a Civil Registration and Vital Statistics (CRVS) system.
15+
16+
- **eSignet**: Discover how to integrate eSignet as an identity provider, allowing users to authenticate into OpenSPP using their MOSIP-based digital identity.
17+
18+
- **OpenID Connect (OIDC)**: Follow our guide to configure Keycloak as an OIDC provider for OpenSPP, enabling single sign-on (SSO) for a secure and streamlined user authentication experience.
1119

1220
```{toctree}
1321
:maxdepth: 2
@@ -17,6 +25,4 @@ This section contains guides for integrating OpenSPP across external systems.
1725
dci
1826
esignet
1927
oidc
20-
keycloak_beneficiary_portal
21-
g2p-connect
2228
```

docs/reference/modules/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ migration-notes: "Added during 2025 documentation reorganization"
2121
| [OpenSPP Area Management](spp_area) | Establishes direct associations between OpenSPP registrants, beneficiary groups, and their corresponding geographical administrative areas. It validates registrant-area linkages against official area types, ensuring data integrity and enabling targeted program delivery and analysis. |
2222
| [OpenSPP Area GIS](spp_area_gis) | Integrates GIS capabilities into OpenSPP's Area management, enabling visualization on maps, associating coordinates, defining polygons, and facilitating spatial analysis for improved targeting and monitoring of social protection programs. |
2323
| [OpenSPP Audit Config](spp_audit_config) | Administrators define and manage comprehensive audit rules within this module, specifying which data models, fields, and operations require tracking across the OpenSPP platform. The module ensures data integrity and accountability by logging user and timestamp details, and it enables cross-record auditing through parent-child relationships for consolidated change views. |
24-
| [SPP Audit Log](spp_audit_log) | Comprehensively tracks all data modifications and user actions across the OpenSPP platform, recording old and new values for configured data. It enhances accountability and data integrity by maintaining an immutable history of changes, crucial for internal audits, compliance, and detecting unauthorized alterations. |
25-
| [G2P Registry: Audit Post](spp_audit_post) | OpenSPP Audit Post extends core audit logging by automatically posting audit log messages to related parent records. It consolidates changes from child records onto the parent's communication timeline, leveraging the mail module for message posting. |
24+
| [OpenSPP Audit Log](spp_audit_log) | Comprehensively tracks all data modifications and user actions across the OpenSPP platform, recording old and new values for configured data. It enhances accountability and data integrity by maintaining an immutable history of changes, crucial for internal audits, compliance, and detecting unauthorized alterations. |
25+
| [OpenSPP Audit Post](spp_audit_post) | OpenSPP Audit Post extends core audit logging by automatically posting audit log messages to related parent records. It consolidates changes from child records onto the parent's communication timeline, leveraging the mail module for message posting. |
2626
| [OpenSPP Auto-Update Entitlements](spp_auto_update_entitlements) | Automatically reviews and updates the state of entitlements based on their redemption status at the end of each program cycle. It assigns precise states, including a new 'Partially Redeemed' status, to ensure accurate records for program closure, reporting, and auditing. |
2727
| [OpenSPP Base](spp_base) | Establishes core system settings and generates unique identifiers for records, enhancing registrant profiles with attributes like tags, gender, and type. The module also integrates Top-up Cards for identification and provides fundamental user interface elements with initial security configurations for user roles. |
2828
| [OpenSPP Base API](spp_base_api) | Provides foundational API functions and methods for robust data exchange between OpenSPP and external systems or internal modules. It enables efficient record management, complex data retrieval, and external system integration primarily through APIs and XML-RPC protocols. |
@@ -60,7 +60,7 @@ migration-notes: "Added during 2025 documentation reorganization"
6060
| [OpenSPP Farmer Registry Base](spp_farmer_registry_base) | Manages comprehensive farmer profiles, detailing farm operations, size, legal status, and specific agricultural practices. Furthermore, it links farmers and farms to land records with geographic data, tracks agricultural activities by season, and oversees farm assets and extension services. |
6161
| [OpenSPP Farmer Registry Dashboard](spp_farmer_registry_dashboard) | Provides interactive dashboards and reports for visualizing data from the OpenSPP Farmer Registry, offering insights into key metrics and trends related to registered farmers. |
6262
| [OpenSPP Farmer Registry Demo](spp_farmer_registry_demo) | Generates and populates the OpenSPP Farmer Registry with comprehensive, realistic sample data. It integrates with core registry models to provide diverse farmer profiles, farm details, and agricultural activities, facilitating system exploration, training, and testing. |
63-
| [ID PASS](spp_idpass) | OpenSPP Idpass securely generates and manages digital identification passes for program registrants, streamlining beneficiary verification and access to social protection services. The module automates ID generation using existing registrant data, offers configurable templates with expiry rules, and integrates with external services via secure API calls. |
63+
| [OpenSPP ID PASS](spp_idpass) | OpenSPP Idpass securely generates and manages digital identification passes for program registrants, streamlining beneficiary verification and access to social protection services. The module automates ID generation using existing registrant data, offers configurable templates with expiry rules, and integrates with external services via secure API calls. |
6464
| [OpenSPP ID Queue](spp_idqueue) | Manages the complete lifecycle of ID card requests for registrants, centralizing their creation, tracking, and final distribution. It streamlines approval workflows, automates ID card generation through integration with external services, and facilitates batch processing with comprehensive audit trails. |
6565
| [OpenSPP Import: DCI API](spp_import_dci_api) | Integrates OpenSPP with external Digital Civil Identity (DCI) compliant registries for automated import and synchronization of individual and family registrant data. It automatically creates or updates registrant profiles, manages hierarchical location data, and facilitates family group creation within OpenSPP. |
6666
| [OpenSPP Import Match](spp_import_match) | OpenSPP Import Match enhances data import processes by intelligently matching incoming records against existing data, preventing duplication and ensuring registry integrity. It provides configurable matching logic and supports seamless updates to existing records during bulk data onboarding. |

0 commit comments

Comments
 (0)