This document outlines the functionality of the OpenSPP SPMIS Base module, the core module for the OpenSPP system. It builds upon existing G2P Registry modules, providing essential customizations and configurations for OpenSPP's specialized functionalities.
The OpenSPP SPMIS Base module serves as the foundation for other OpenSPP modules, offering:
- System Foundation: Establishes core system settings and a mechanism for generating unique identifiers for various records. This ensures consistent data tracking and integrity across all OpenSPP modules.
- Enhanced Registrant Profiles: Extends the base registrant model to include additional, critical information such as registrant tags, gender details, and a clear distinction of registrant type (e.g., individual, group). This enables more comprehensive data capture and analysis for beneficiaries.
- Top-up Card Management: Supports the integration and validation of Top-up Cards as a specific form of identification within the system. This is crucial for programs utilizing physical cards for beneficiary interactions.
- Core UI and Role Configuration: Provides fundamental user interface elements and initial security configurations, including global and local user roles. This ensures a consistent look and feel and lays the groundwork for robust access control.
- Integration Enabler: Serves as a central integration point, allowing other OpenSPP modules to seamlessly interact with core registrant data and system settings.
The OpenSPP SPMIS Base module depends on several other modules, integrating their features and extending them for OpenSPP:
- It extends the core G2P Registry models, including
res.partner(registrants),g2p.reg.id(registrant IDs), andg2p.group.membership(group memberships) from G2P Registry Base, G2P Registry Individual, and G2P Registry Group. This provides foundational data structures for all registrants. - This module integrates with geographical and service delivery modules like OpenSPP Area and OpenSPP Service Points by providing the underlying registrant framework and unique identifiers used across the system.
- It supports identity management features such as spp_idpass and spp_idqueue by defining the 'Top-up Card' ID type and its validation rules, crucial for card issuance and tracking.
- OpenSPP Base underpins UI customization and filtering through OpenSPP Custom Field, OpenSPP Custom Fields UI, OpenSPP Hide Menus, and OpenSPP Custom Filter UI, establishing common interface elements and simplifying user workflows.
- It defines global and local roles, which are utilized by OpenSPP User Roles to manage permissions and access control for users based on their responsibilities and assigned areas.
The OpenSPP SPMIS Base module introduces the following key functionalities:
The module provides a robust system for generating unique identifiers for various records within OpenSPP. These identifiers are automatically assigned and validated, following specific patterns to ensure consistency and prevent errors. This capability is crucial for accurately tracking beneficiaries, programs, and other entities across different modules and activities.
It extends the core registrant profile by adding critical fields for
more comprehensive data capture. Users can assign multiple
Registrant Tags for flexible categorization and reporting, and
easily see the String Kind of a registrant (e.g., individual,
household). This module also integrates Gender information into
individual and group membership records, allowing for more detailed
demographic analysis of beneficiary populations.
OpenSPP Base manages the specific Top-up Card identification type,
including its unique identifier (Card UID). The system ensures data
accuracy by validating that all entered Top-up Card UIDs are exactly 10
characters long. This standardization is essential for reliable card
issuance, tracking, and usage in program distributions.
This module establishes the fundamental user interface components and
initial security settings for the OpenSPP platform. It pre-defines
Global Roles and Local Roles to streamline user permission
management and sets up the basic views for interacting with registrants
and user accounts. This ensures a secure, consistent, and user-friendly
operating environment from the outset.
The OpenSPP SPMIS Base module acts as the backbone of the OpenSPP system, integrating and extending the functionalities of its dependencies to create a cohesive and tailored platform. Its role in providing central configurations, UI modifications, and extension points makes it essential for the proper functioning and customization of OpenSPP's specialized features.
Table of contents
Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.
Do not contact contributors directly about support or help with technical issues.
- OpenSPP.org
Current maintainers:
This module is part of the OpenSPP/openspp-modules project on GitHub.
You are welcome to contribute.