Modules Reference

This section provides comprehensive documentation for all OpenSPP V2 modules.

Module Categories

Core Modules

Foundation modules that provide essential platform functionality.

Module	Summary
Area Management	Establishes associations between registrants and geographical administrative areas with validation and hierarchy support.
Base (Common)	Main menu, generic configuration, user role management base, area management base, and non-OpenSPP menu hiding.
Base Settings	Fundamental configurations for country implementations, Country Offices, and user management.
GIS	GIS core with area geo fields, importer extensions, layers, and spatial queries.
Programs	Manage cash and in-kind entitlements, integrate with inventory, and program management for social protection.
Registry	Consolidated registry management for individuals, groups, and membership.
Security	Central security definitions for OpenSPP modules.
Storage Backend	Pluggable storage backend configuration (Odoo, S3, Azure, Filesystem).

API V2 Modules

RESTful API modules built on FastAPI for external system integration.

Module	Summary
API V2	Core API V2 module providing FastAPI-based RESTful endpoints.
API V2 - Change Request	REST API endpoints for Change Request V2.
API V2 - Cycles	API endpoints for program cycle management.
API V2 - Data	API endpoints for variable data push/pull.
API V2 - Entitlements	API endpoints for entitlement management.
API V2 - GIS	OGC API - Features compliant GIS endpoints for QGIS and GovStack.
API V2 - Products	API endpoints for product catalog management.
API V2 - Service Points	API endpoints for service point management.
API V2 - Simulation	REST API for simulation scenario management.
API V2 - Vocabulary	API endpoints for vocabulary/lookup data.
OAuth	OAuth 2.0 authentication framework for API security.

Case Management Modules

Modules for individual case tracking and management.

Module	Summary
Case Management Base	Core case management with configurable workflow stages and intervention plans.
Case: CEL Rules	CEL-based triage and assignment rules for case management.
Case: Demo Data	Demo data generator for Case Management.
Case: Entitlements	Links cases to program entitlements for relationship tracking.
Case: Graduation	Link graduation assessments to cases for exit management.
Case: Programs	Links cases to programs with compliance tracking.
Case: Registry	Links cases to registrants with area auto-population.
Case: Sessions	Link sessions and training attendance to cases.

CEL Modules

Common Expression Language modules for rule-based logic.

Module	Summary
CEL Domain Query Builder	Write simple CEL-like expressions to filter records.
CEL Event Data	Integrate event data with CEL expressions for eligibility rules.
CEL Expression Widget	Reusable CEL expression editor with syntax highlighting and autocomplete.
CEL Registry Search	Search the registry using CEL expressions.
CEL Vocabulary	Vocabulary-aware CEL functions for eligibility rules.

Change Request Modules

Workflow modules for managing data change requests.

Module	Summary
Change Request V2	Configuration-driven change request system with conflict detection and duplicate prevention.
CR Types - Advanced	Advanced change request types with custom Python strategies.
CR Types - Base	Basic change request types with field mapping strategy.

DRIMS Modules

Disaster Response Inventory Management System.

Module	Summary
DRIMS	Disaster relief inventory management for donations, requests, and distribution tracking.
DRIMS - Sri Lanka	Sri Lanka-specific configuration for DRIMS with geographic hierarchy and approval thresholds.
DRIMS - Sri Lanka Demo	Demo data generator for DRIMS Sri Lanka implementation.

Farmer Registry Modules

Modules for agricultural beneficiary management.

Module	Summary
Farmer Registry	Farm details, agricultural activities, seasons, and CEL variable integration.
Farmer Registry: Change Requests	Farmer-specific change request types for farm details and activities.
Farmer Registry: Dashboard	Dashboard with CEL-based metrics and trends for farmer data.
Farmer Registry: Demo	Demo generator with fixed stories and volume generation.
Farmer Registry: Vocabularies	FAO-aligned vocabularies for crops, livestock, and aquaculture.

GIS Modules

Geographic Information System modules for spatial data and mapping.

Module	Summary
GIS Indicators	Choropleth visualization with color scales and classification methods.
GIS Reports	Geographic visualization and reporting for social protection data.
GIS Reports - Programs	Add program context filtering to GIS reports.
Registrant GIS	Adds GPS coordinates to registrants for spatial queries.

GRM Modules

Grievance Redress Mechanism modules.

Module	Summary
GRM	Centralized grievance receiving, tracking, and resolution with multi-channel submission.
GRM: Case Link	Links GRM tickets with Case Management for escalation.
GRM: CEL Rules	CEL-based routing and escalation rules for GRM tickets.
GRM: Demo Data	Demo data generator for GRM with story-based tickets.
GRM: Programs	Link GRM tickets to programs, entitlements, and payments.
GRM: Registry	Link GRM tickets to registrants with repeat ticket detection.

Hazard & Emergency Modules

Modules for disaster and emergency management.

Module	Summary
Hazard & Emergency Management	Hazard classification, incident recording, and impact assessment for emergency response.
Hazard: Programs	Links hazard impacts to program eligibility and emergency entitlements.

Indicators & Metrics Modules

Modules for data analytics, indicators, and scoring.

Module	Summary
Analytics	Query engine for indicators, simulations, and GIS analytics.
Indicator	Publishable indicators based on CEL variables for dashboards, GIS, and APIs.
Indicator Studio	Studio UI for managing publishable indicators.
Metric	Unified metric foundation for indicators and simulations.
Metric Service	Computation services for fairness, distribution, breakdown, and privacy.

Integration Modules

Modules for external system integration and data exchange.

Module	Summary
Banking	Bank account details for registrants and payment processing.
DCI Core	Core DCI (Digital Convergence Initiative) API components and schemas.
DCI Client	Base DCI client infrastructure with OAuth2 and data source management.
DCI Client - CRVS	Connect to Civil Registration and Vital Statistics registries via DCI API.
DCI Client - Disability	Connect to Disability Registries via DCI API.
DCI Client - IBR	Connect to Identity Bureau for duplication checks via DCI API.
DCI Server	DCI API server infrastructure with FastAPI routers.
Document Management System	Centralized document management with directory trees and indexed storage.
Event Data	Records events from surveys, field visits, and external systems (ODK, KoBoToolbox).
HXL Integration	Humanitarian Exchange Language support for data interoperability.
HXL Area Integration	HXL import with area-level aggregation for humanitarian indicators.
Import Match	Intelligent import matching to prevent duplication during bulk data onboarding.
Service Points	Manage physical or virtual service delivery locations with area linking.
Source Tracking	Track data provenance and source information for registrants.
Vocabulary	Centralized vocabulary and lookup value management.

Monitoring Modules

Modules for audit, compliance, and approval workflows.

Module	Summary
Alerts	Generic alert engine for threshold monitoring, expiry tracking, and deadlines.
Approval	Standardized approval workflows with multi-tier sequencing and CEL rules.
Audit	Immutable change history with multiple backends (database, file, syslog, HTTP).

Registry Extensions

Modules extending core registry functionality.

Module	Summary
Disability Registry	WG-SS/CFM disability assessments, assistive device tracking, and CEL functions.
Graduation	Manage graduation and exit from time-bound social protection programs.
Group Hierarchy	Hierarchical group relationships with nested group structures.
Registry Search Portal	Search-first registry interface for privacy protection.
Session Tracking	Track attendance at required sessions and trainings.

Scoring & Targeting Modules

Modules for beneficiary assessment and targeting.

Module	Summary
Scoring	Configurable scoring and assessment framework for beneficiary targeting.
Scoring: Programs	Integrates scoring with program eligibility and entitlements.
Simulation	Simulate targeting scenarios and analyze fairness before committing.

Security & Identity Modules

Modules for access control, encryption, privacy, and security features.

Module	Summary
Attachment Antivirus Scan	ClamAV-based antivirus scanning with quarantine workflow.
Consent	DPV-aligned consent management implementing ISO/IEC TS 27560:2023.
Encryption	JWE encryption, JWT signing, and Linked Data Proof signing.
Key Management	Centralized cryptographic key management with pluggable providers.
QR Credentials	MOSIP Claim 169 QR code identity credentials for registrants.
User Roles	Area-based access control with global and local role definitions.

Studio Modules

No-code configuration tools for implementers.

Module	Summary
Custom Fields	Define and add custom data fields to registrant profiles.
Studio	No-code customization interface for OpenSPP.
Studio - API V2	Bridge Studio custom fields and variables with API v2.
Studio - Change Requests	No-code change request type builder.
Studio - Events	No-code event type designer for data collection.

Utility Modules

Helper modules providing common utilities and tools.

Module	Summary
Area HDX Integration	HDX Common Operational Datasets integration for admin boundaries.
Hide Menus: Base	Manage visibility of navigation menus for specific user groups.
Irrigation	Irrigation asset management with GIS and water distribution networks.
Land Record	Land parcel records with ownership, lease tracking, and GIS fields.
Versioning	Artifact versioning with scheduled activation.

Starter & Demo Modules

Pre-configured bundles and demonstration data.

Module	Summary
Demo	Core demo module with data generator and sample data.
MIS Demo V2	Demo Generator V2 for SP-MIS programs with fixed stories and volume generation.
Starter: Farmer Registry	Complete Farmer Registry bundle with API, DCI, and Program support.
Starter: Social Registry	Complete Social Registry bundle with API, DCI, and Change Request support.
Starter: SP-MIS	Complete SP-MIS bundle with Social Registry, Programs, and Service Points.

Theme & Branding

Module	Summary
Branding Kit	Branding customization, URL routing (/openspp), and telemetry management.
Theme	OpenSPP visual theme and branding.