OpenSPP Modules Index#

Warning

Work in Progress: This document is actively being developed and updated. Content may be incomplete or subject to change.

SPP Modules#

Module

Summary

OpenSPP Base API

Provides foundational API functions and methods for seamless interaction with the OpenSPP system, enabling data exchange via APIs or XML-RPC.

OpenSPP Programs

Manage cash and in-kind entitlements, integrate with inventory, and enhance program management features for comprehensive social protection and agricultural support.

OpenSPP User Roles

Enhances user role management with local roles and area-based access control for improved data security and granularity in OpenSPP.

OpenSPP DCI API Server

Provides a DCI-compliant RESTful API for secure data exchange with OpenSPP's registry.

OpenSPP In-Kind Entitlement

Manages the distribution of in-kind entitlements within social protection programs, handling inventory, service points, and beneficiary redemption.

OpenSPP Encryption Module

Provides secure encryption, decryption, signing, and verification of data within OpenSPP using JWCrypto.

OpenSPP Data Source

Provides a framework for integrating external data sources into OpenSPP, enabling connection to and retrieval of data from external systems like farmer registries and social protection programs.

OpenSPP Farmer Registry Demo

Provides pre-populated demo data for the OpenSPP Farmer Registry, showcasing its features with realistic sample data.

OpenSPP Registrant Import

Streamlines the import of registrant data into OpenSPP, simplifies data mapping, and automates unique ID generation.

OpenSPP Data Export

Enables exporting large datasets to Excel by overriding the default export functionality and providing error handling for exceeding Excel row limits.

OpenSPP Audit Config

This module allows administrators to define and manage audit rules to track and log changes made to critical data within the OpenSPP platform, ensuring data security and integrity.

OpenSPP SQL Query Eligibility Manager

Define complex program eligibility criteria using SQL queries for flexible and automated beneficiary enrollment within OpenSPP.

OpenSPP Custom Fields UI

Provides a user-friendly interface for defining and managing custom fields for registrants within the OpenSPP platform, allowing implementers to tailor data collection to program-specific needs.

OpenSPP Service Point Device

This module allows managing terminal devices associated with each service point, tracking their model, Android version, and active status.

SPP Audit Log

Provides audit logging functionality to track data changes and user actions within OpenSPP, enhancing transparency and accountability.

OpenSPP API Records

Provides RESTful API endpoints for accessing and managing OpenSPP's core data, including service points, programs, products, and entitlements.

OpenSPP Programs: Compliance Criteria

Manages compliance criteria within social protection programs, allowing administrators to define and enforce additional eligibility requirements beyond initial program criteria.

OpenSPP Proxy Means Testing

Calculates a Proxy Means Testing (PMT) score for groups of registrants to aid in beneficiary identification and prioritization for social protection programs.

OpenSPP Import Match

Enhances data imports in OpenSPP by enabling the matching of imported records with existing data to prevent duplicates and ensure data integrity.

OpenSPP Base GIS

Provides Geographical Information System (GIS) capabilities to OpenSPP, enabling visualization and interaction with geospatial data on maps, integrating with modules like Registries and Targeting & Eligibility for enhanced program management.

OpenSPP Base GIS Demo

Demonstrates the GIS capabilities of the OpenSPP Base GIS module by providing practical examples and use cases with GIS views, data layers, and raster layers.

OpenSPP OpenID VCI

Enables the issuance and management of Verifiable Credentials (VCs) within the OpenSPP platform, leveraging OpenID Connect for Verifiable Presentations (OpenID4VP) to provide secure and verifiable digital credentials for registrants.

OpenSPP Event Data

Records and tracks events related to individual and group registrants, providing a chronological history of changes and actions within the OpenSPP system.

OpenSPP Service Points Management

This module enables the management of service points, linking them to geographical areas, company entities, and user accounts for streamlined service delivery within OpenSPP.

OpenSPP Import: DCI API

Enables integration with external registries, particularly those adhering to the DCI (Digital Civil Identity) standard, for importing and synchronizing registrant data into OpenSPP.

OpenSPP Base Settings

Provides essential settings and customizations for OpenSPP implementations, including Country Office management and user interface adaptations.

OpenSPP Change Request: Add Farmer

Provides a specialized workflow for adding new farmers to existing groups in the registry.

OpenSPP Base Demo

Provides demonstration data for the OpenSPP system, including sample registrants, programs, and products to facilitate user exploration and training.

OpenSPP API: Oauth

Provides OAuth 2.0 authentication for secure access to the OpenSPP API.

OpenSPP Land Record

This module enables the management and geospatial visualization of land records within OpenSPP, linking land parcels to farms, tracking ownership, and supporting land governance initiatives.

OpenSPP Base

Provides essential configurations, UI customizations, and base functionalities for the OpenSPP system, including top-up card management and integration with other OpenSPP modules for areas, service points, programs, and custom fields.

OpenSPP Manual Entitlement

Provides a mechanism for manually creating entitlements for beneficiaries within specific program cycles in OpenSPP, offering flexibility for programs with unique eligibility criteria or situations not covered by automated rules.

OpenSPP Entitlement Basket

This module allows you to define baskets of goods and services that beneficiaries are entitled to receive, simplifying in-kind entitlement management within social protection programs.

OpenSPP Demo

Provides demonstration data and functionalities for the OpenSPP system, showcasing its capabilities in managing social protection programs and registries with pre-populated data for exploration and testing.

OpenSPP Registry Group Hierarchy

Introduces hierarchical relationships between groups, allowing for nested group structures within social protection programs and farmer registries.

OpenSPP Event Demo

Provides demonstration data and functionalities for the OpenSPP event tracking system, showcasing practical applications through predefined event types, data models, views, and wizards.

OpenSPP API

Provides a framework for building and managing a RESTful API for the OpenSPP platform, including API definition, documentation, security, and logging.

OpenSPP 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.

OpenSPP Registrant Tags

Provides enhanced tagging capabilities for registrants in OpenSPP, allowing for better organization and management of registrant data.

OpenSPP Custom Field Recompute Daily

Enables daily recomputation of specified fields to maintain data accuracy and improve performance by offloading intensive calculations.

OpenSPP OpenID VCI Individual

Enables the issuance of Verifiable Credentials (VCs) for individual registrants within the OpenSPP platform, integrating with OpenID Connect for Verifiable Presentations and Decentralized Identifiers.

OpenSPP Auto-Update Entitlements

Automatically updates entitlement states based on their redemption status at the end of program cycles in OpenSPP.

OpenSPP POS

Extend Odoo POS to redeem entitlements from OpenSPP for secure and efficient beneficiary transactions.

OpenSPP Change Request

Streamlines the process of handling changes to registrant information within the OpenSPP system, providing a structured framework for submitting, reviewing, approving, and applying modifications.

OpenSPP Program Entitlement Basic Cash Spent

Tracks cash spending by beneficiaries against allocated entitlements in basic cash programs, calculating remaining balances and supporting program monitoring.

OpenSPP Event Data Program Membership

This module allows users to record and track program membership-related events, such as enrollment, suspension, or exit, and link them to specific program membership records within OpenSPP.

OpenSPP ID Queue

Manages ID card requests, approvals, batch printing, and distribution for registrants within social protection programs and farmer registries.

OpenSPP: Starter

No summary provided

OpenSPP Area Management

This module enables management of geographical areas, linking them to registrants for targeted interventions and analysis in social protection programs.

OpenSPP Programs: Service Points Integration

Extends OpenSPP Programs to integrate service points, enabling the association of beneficiaries and entitlements with designated service delivery locations for improved program efficiency and targeted benefit distribution.

OpenSPP Base GIS REST

Provides RESTful API endpoints for accessing and querying geospatial data within OpenSPP, secured with OAuth 2.0.

OpenSPP Consent

No summary provided

OpenSPP Custom Filter UI

Customizes the OpenSPP UI to enhance filtering for Res Partners, improving usability and efficiency in managing registrants within social protection programs.

OpenSPP Change Request Demo: Add Child/Member

Provides a demonstration of adding children or members to an existing group in the registry using the OpenSPP Change Request framework, including a dedicated form, ID scanning integration, and automated data updates.

OpenSPP Registry: Scan ID Document

Enables the scanning of physical ID documents directly into a registrant's profile, streamlining data entry and improving accuracy in the OpenSPP Registry.

OpenSPP Program ID

Generates and manages unique IDs for social protection programs, enhancing identification and integration within the OpenSPP platform.

OpenSPP OpenID VCI Group

Enables the issuance of Verifiable Credentials (VCs) for groups of registrants, integrating with group management to represent group identity and attributes.

G2P Registry: Audit Post

Enables posting of audit log messages to related parent records, providing a centralized view of changes across interconnected data in social protection programs.

OpenSPP Exclusion Filter

This module enhances the OpenSPP program creation process by enabling the configuration and application of exclusion filters, ensuring that only eligible registrants are considered for enrollment in new programs.

OpenSPP Farmer Registry Base

Base module for managing farmer registries, linking farmers to farms, land, and agricultural activities.

OpenSPP Irrigation

Provides tools for managing and visualizing irrigation infrastructure within OpenSPP, enabling efficient tracking, planning, and analysis of irrigation systems and their impact.

OpenSPP Custom Fields

Adds customizable fields to registrant profiles for enhanced data collection and program management in OpenSPP.

OpenSPP Custom Filter

Enhances Odoo's filtering system by allowing administrators to control which fields are displayed in filter dropdowns, improving user experience and data management.

ID PASS

No summary provided

OpenSPP 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.

OpenSPP Custom Field Custom Filter Integration

Allows administrators to enable custom fields for filtering, enhancing data analysis and program operations.

OpenSPP Document Management System

Provides a centralized system for managing and organizing documents within OpenSPP, facilitating efficient storage, retrieval, and categorization of files related to social protection programs.

OpenSPP Tag Based Eligibility Manager

Define eligibility criteria for programs based on registrant tags and geographical areas, automating beneficiary identification and improving targeting accuracy.

OpenSPP Entitlement Transactions

This module records and manages transactions related to entitlement redemptions, providing a transparent history for both cash and in-kind benefits.

OpenSPP Cash Entitlement

Manage cash-based entitlements for beneficiaries within social protection programs, including defining calculation rules, automating disbursement, and tracking payments.

G2P Modules#

Module

Summary

OpenG2P Entitlement: In-Kind

No summary provided

G2P Registry: Rest API

No summary provided

OpenG2P Program: Documents

No summary provided

OpenG2P Programs: Reimbursement

No summary provided

OpenG2P Entitlement: Differential

No summary provided

G2P Registry: Additional Info

No summary provided

G2P OpenID VCI: Base

No summary provided

G2P Encryption: Rest API

No summary provided

G2P: Proxy Means Test

No summary provided

OpenG2P Program Payment (Payment Hub EE)

No summary provided

OpenG2P Programs

No summary provided

G2P Registry: Encryption

No summary provided

G2P Connect Demo

No summary provided

G2P OpenID VCI: Program Beneficiaries

No summary provided

OpenG2P Programs: Cycleless

No summary provided

G2P Programs: REST API

No summary provided

G2P Encryption: Base

No summary provided

G2P Program : Program Registrant Info Rest API

No summary provided

G2P Auth: OIDC - Reg ID

No summary provided

OpenG2P Entitlement: Voucher

No summary provided

G2P Registry: Individual

No summary provided

OpenG2P Program: Approval

No summary provided

G2P Registry: Membership

No summary provided

OpenG2P Program Payment: Cash

No summary provided

G2P Registry: Groups

No summary provided

G2P Registry: Rest API Extension Demo

No summary provided

G2P Program: Registrant Info

No summary provided

OpenG2P Program Payment (Payment Interoperability Layer)

No summary provided

OpenG2P Program: Assessment

No summary provided

G2P Registry: Base

No summary provided

OpenG2P Program Payments: In Files

No summary provided

OpenG2P Program Payment: Simple Mpesa Payment Manager

No summary provided

OpenG2P Program Payment: G2P Connect Payment Manager

No summary provided

OpenG2P Programs: Autoenrol

No summary provided

G2P Registry: Additional Info REST API

No summary provided

G2P Registry: Bank Details

No summary provided

G2P Registry: Bank Details Rest API

No summary provided

G2P Encryption: Keymanager

No summary provided