Skip to content

Commit 15cce9f

Browse files
committed
Update the descriptions for the missing ones
1 parent 64618d1 commit 15cce9f

File tree

21 files changed

+677
-1
lines changed

21 files changed

+677
-1
lines changed

spp_attendance/__manifest__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "OpenSPP Attendance",
33
"category": "OpenSPP",
44
"version": "17.0.1.3.1",
5+
"summary": "This module accurately tracks participant attendance for social protection program activities, capturing essential details like date, time, location, and activity type. It integrates attendance records to inform conditional benefit eligibility and leverages spp_oauth to secure API endpoints for external data submission.",
56
"sequence": 1,
67
"author": "OpenSPP.org",
78
"website": "https://github.com/OpenSPP/openspp-modules",
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
2+
# Attendance
3+
4+
The OpenSPP Attendance module (spp_attendance) provides a comprehensive system for managing and tracking participant attendance across various social protection programs and farmer registries. It enables organizations to accurately record who attended specific events, when, where, and for what purpose, ensuring accountability and informing program delivery.
5+
6+
## Purpose
7+
8+
This module streamlines the process of tracking participant engagement and presence, critical for program effectiveness and compliance. It accomplishes the following key capabilities:
9+
10+
* **Record Participant Attendance:** Accurately logs the presence or absence of individuals at specific program events, such as training sessions, benefit distributions, or community meetings. This ensures precise data for monitoring and evaluation.
11+
* **Manage Program Participants:** Creates and maintains a registry of individuals participating in social protection programs, linking their attendance records to their core profile information. This centralizes participant data for easier management.
12+
* **Categorize Attendance Events:** Defines and categorizes different types of attendance (e.g., "Cash Transfer Distribution," "Health Education Workshop") and specific locations where these events occur. This provides granular insights into program activities.
13+
* **Integrate with External Systems:** Facilitates the secure import of participant data from external registries and allows external applications to submit or query attendance records via a robust API. This supports data synchronization across the OpenSPP ecosystem.
14+
* **Monitor Participant Engagement:** Provides tools to view an individual's attendance history and aggregated attendance data, offering valuable insights into participation patterns and program reach. This helps in assessing program impact and identifying areas for improvement.
15+
16+
## Dependencies and Integration
17+
18+
The spp_attendance module integrates seamlessly with other core OpenSPP components and extends foundational Odoo functionalities:
19+
20+
* **Base (base):** As a core module, `spp_attendance` relies on the standard Odoo `base` module for fundamental system functionalities, data models, and user interface elements.
21+
* **OpenSPP API: Oauth (spp_oauth):** `spp_attendance` leverages the `spp_oauth` module to provide secure API access for external applications. This ensures that any attendance data submitted or queried by external systems is authenticated and authorized, protecting sensitive participant information.
22+
* **Partner Management (res.partner):** The module extends Odoo's core `res.partner` model to manage program participants (subscribers). Each attendance subscriber is linked to a `res.partner` record, allowing `spp_attendance` to utilize existing contact information while adding specific details relevant to program participation, such as a unique person identifier and attendance history.
23+
24+
This module serves as a foundational component for other program-specific modules that require accurate participant attendance records for their operations, such as benefit disbursement, case management, or training program management.
25+
26+
## Additional Functionality
27+
28+
The `spp_attendance` module offers a range of features designed to provide flexible and robust attendance management:
29+
30+
### Participant (Subscriber) Management
31+
32+
Users can create and manage detailed profiles for program participants, known as subscribers. Each subscriber is uniquely identified and linked to a core OpenSPP contact, ensuring consistency. The module automatically manages the underlying contact record when a subscriber is created or updated, including details like full name, additional names, gender, email, and phone numbers.
33+
34+
### Flexible Attendance Recording
35+
36+
The module enables recording of attendance events with specific details. For each record, users specify the attendance date, time, and category (either "Present" or "Absent"). Additional context can be added through a description and an external URL, useful for linking to external resources or evidence of attendance.
37+
38+
* **Configurable Uniqueness:** System administrators can configure rules to prevent duplicate attendance entries for a single participant. This includes options to ensure uniqueness based on combinations of date, time, attendance type, and location, preventing data entry errors and ensuring data integrity.
39+
* **Attendance History:** Users can quickly retrieve a comprehensive attendance history for any participant, filtering by date ranges, attendance type, or location, providing a clear overview of their engagement.
40+
41+
### Custom Attendance Types and Locations
42+
43+
To accommodate diverse program needs, the module allows for the definition of custom attendance types and locations.
44+
45+
* **Attendance Types:** Organizations can define various types of attendance events (e.g., "Training Session," "Cash Distribution," "Health Screening"). Each type can have a name and description, allowing for clear classification of activities.
46+
* **Attendance Locations:** Users can establish a list of specific locations where attendance events occur (e.g., "District Office A," "Community Hall B"). This helps in geographic tracking and reporting of program activities.
47+
48+
### External System Integration
49+
50+
The `spp_attendance` module supports integration with external systems for both data import and API-driven attendance management.
51+
52+
* **Secure API Access:** Organizations can generate unique Client ID and Client Secret credentials for external applications. These credentials enable secure, authenticated access to the `spp_attendance` API, allowing external systems (e.g., mobile attendance capture apps) to submit new attendance records or query existing ones.
53+
* **Registry Data Import:** A dedicated wizard facilitates the import of participant data from external registries. This feature includes configurable mapping of fields (such as personal information, identifiers, and contact details) to ensure accurate and efficient synchronization of participant records into OpenSPP.
54+
55+
## Conclusion
56+
57+
The OpenSPP Attendance module is essential for effectively managing and monitoring participant engagement within social protection programs, providing robust tools for recording, categorizing, and integrating attendance data across the OpenSPP platform.

spp_change_request_change_info/__manifest__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"name": "Change Information Change Request",
33
"category": "OpenSPP",
44
"version": "17.0.1.3.1",
5+
"summary": "Manages a structured process for updating an individual registrant's core personal and identification details within the OpenSPP platform. It integrates ID scanning for automatic data population, enforces data integrity with validation rules, and securely stores supporting documents in dedicated DMS directories.",
56
"sequence": 1,
67
"author": "OpenSPP.org",
78
"website": "https://github.com/OpenSPP/openspp-modules",
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
2+
# Change Information Change Request
3+
4+
The OpenSPP Change Request Change Info module streamlines the process of updating and managing an individual registrant's personal and demographic information within the OpenSPP platform. It provides a structured and validated approach for making modifications to existing registrant profiles.
5+
6+
## Purpose
7+
8+
This module enables users to efficiently manage and apply changes to individual registrant data, ensuring that all information remains current and accurate. It accomplishes this by:
9+
10+
* **Standardizing Individual Profile Updates**: It provides a dedicated and formal process for submitting requests to modify personal and demographic details of individual registrants.
11+
* **Streamlining Data Capture**: The module integrates with ID scanning technology to quickly and accurately extract and populate registrant information from official documents.
12+
* **Ensuring Data Accuracy and Completeness**: It enforces validation rules for critical data fields, such as birthdates and national ID numbers, to maintain high data quality.
13+
* **Integrating with Approval Workflows**: Changes submitted through this module follow the established OpenSPP change request and approval framework, ensuring proper authorization before application.
14+
* **Maintaining an Audit Trail**: Every change request and its associated modifications are documented, providing a clear history of all updates to registrant information.
15+
16+
## Dependencies and Integration
17+
18+
The `spp_change_request_change_info` module integrates closely with several other OpenSPP modules to deliver its functionality:
19+
20+
* **`spp_change_request`**: This module extends the core [OpenSPP Change Request](spp_change_request) framework by adding a specialized request type specifically for modifying individual registrant information. It leverages the parent module's workflow, validation sequences, and overall management of change requests.
21+
22+
* **`g2p_registry_individual`**: This module directly interacts with the [G2P Registry Individual](g2p_registry_individual) module to update the personal and demographic data of individual registrants. It modifies fields such as names, birthdate, gender, and identification details stored within an individual's profile.
23+
24+
* **`g2p_registry_group`** and **`g2p_registry_membership`**: These modules are foundational components of the broader OpenSPP G2P Registry. While this specific 'Change Information' module focuses exclusively on individual registrant updates and does not directly modify group or membership data, it operates within the comprehensive registry framework that includes these modules.
25+
26+
* **`spp_service_points`**: [OpenSPP Service Points](spp_service_points) agents utilize this module to initiate and process change requests for registrant information directly from their service locations, facilitating decentralized data management.
27+
28+
* **Document Management System (DMS)**: The module integrates with the OpenSPP Document Management System (DMS) to store supporting documentation, such as scanned ID documents, securely alongside the change request for verification and audit purposes.
29+
30+
## Additional Functionality
31+
32+
### Comprehensive Personal Data Updates
33+
34+
Users can update a wide range of personal details for an individual registrant, ensuring their profile accurately reflects current information. This includes modifying their given name, family name, additional name, place of birth, date of birth, gender, and contact phone number. The module validates that the date of birth is not in the future and ensures phone numbers adhere to correct formatting standards.
35+
36+
### National ID and Photo Management
37+
38+
This module allows for the management of official identification details and the registrant's profile photograph. Users can update the national ID number, which is validated to be a 12-digit entry, and upload a new profile picture. This functionality is crucial for identity verification and maintaining up-to-date records for program eligibility.
39+
40+
### Streamlined Data Capture via ID Scanning
41+
42+
A key feature is the ability to quickly and accurately populate registrant details by processing scanned ID documents. The system automatically extracts information such as name, birthdate, gender, and place of birth from scanned documents (e.g., UID cards), pre-filling the relevant fields. The scanned image is also automatically uploaded and stored within the Document Management System, significantly reducing manual data entry errors and accelerating the change request process.
43+
44+
### Educational and Relationship Information
45+
46+
Beyond core personal details, the module supports recording and updating additional demographic and relational information. Users can specify the registrant's highest educational level attained and define their relationship to an applicant (e.g., father, mother, grandfather). This enriches registrant profiles, providing valuable data for program targeting and analysis.
47+
48+
## Conclusion
49+
50+
The OpenSPP Change Request Change Info module is essential for maintaining accurate and up-to-date individual registrant data within the OpenSPP platform, ensuring data integrity and supporting efficient program administration.

spp_cycle_attendance_compliance/__manifest__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"name": "OpenSPP Cycle: Attendance Compliance",
44
"category": "OpenSPP",
55
"version": "17.0.1.3.1",
6+
"summary": "Program managers define and enforce attendance requirements as eligibility criteria for beneficiaries within social protection program cycles. The module integrates with external attendance systems to automatically fetch records, then evaluates beneficiaries against defined thresholds to ensure ongoing program eligibility.",
67
"sequence": 1,
78
"author": "OpenSPP.org",
89
"website": "https://github.com/OpenSPP/openspp-modules",
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
2+
# Cycle: Attendance Compliance
3+
4+
The OpenSPP Cycle Attendance Compliance module integrates attendance records as a key criterion for determining beneficiary eligibility and ongoing compliance within social protection programs. It allows program managers to define, track, and enforce attendance requirements for beneficiaries participating in program cycles, ensuring accountability and program integrity.
5+
6+
## Purpose
7+
8+
This module enhances OpenSPP's ability to manage beneficiary compliance by incorporating attendance data. It achieves this by:
9+
10+
* **Defining Attendance Requirements**: Enables program administrators to specify a minimum number of attendance days or sessions required for beneficiaries within a program cycle.
11+
* **Integrating External Attendance Data**: Connects OpenSPP with external attendance tracking systems to retrieve real-time attendance records for program participants.
12+
* **Automating Compliance Checks**: Automatically filters and updates beneficiary compliance status within program cycles based on their attendance records against predefined criteria.
13+
* **Maintaining Detailed Attendance History**: Stores a comprehensive log of individual attendance events directly within OpenSPP, providing an auditable history for each beneficiary.
14+
* **Supporting Group and Individual Programs**: Manages attendance compliance for both individual beneficiaries and for members within group-based programs.
15+
16+
This module ensures that only beneficiaries who meet the required attendance levels remain active in a program, helping to optimize resource allocation and verify active participation. For example, a program might require beneficiaries to attend a minimum of 10 health awareness sessions over a cycle to receive their next payment.
17+
18+
## Dependencies and Integration
19+
20+
The OpenSPP Cycle Attendance Compliance module seamlessly integrates with core OpenSPP functionalities and extends existing modules:
21+
22+
* **[OpenSPP Programs: Compliance Criteria](spp_programs_compliance_criteria)**: This module extends the foundational compliance framework. It introduces attendance as a specific type of compliance criterion that can be applied to beneficiaries during program cycles, building upon the general compliance management features.
23+
* **[OpenSPP Event Data](spp_event_data)**: It leverages the event data framework to store detailed attendance records. When attendance data is fetched from an external system, individual attendance events (like a specific date and time of attendance) are logged as `spp.event.attendance` records, which are then managed by the `spp_event_data` module.
24+
* **G2P Cycle Management (g2p_cycle)**: It extends the program cycle model, allowing program managers to enable attendance criteria and configure specific requirements (e.g., required attendance days, date ranges) directly on the cycle.
25+
26+
## Additional Functionality
27+
28+
### External Attendance System Configuration
29+
30+
Program administrators can configure OpenSPP to connect with an external attendance tracking system. This involves setting up the external server URL, authentication endpoints, client credentials (ID and secret), and specific API endpoints for fetching attendance types, locations, and compliance data. A "Test Connection" feature allows administrators to verify the connection and automatically import attendance types and locations from the external system into OpenSPP's configuration. This ensures that attendance data is consistently categorized.
31+
32+
### Program Cycle Attendance Criteria Definition
33+
34+
Within each program cycle, administrators gain the ability to activate and define specific attendance compliance rules. They can:
35+
36+
* Enable or disable the use of attendance criteria for the cycle.
37+
* Specify the **required number of attendance days** or sessions a beneficiary must complete.
38+
* Define a **date range (From Date, To Date)** within which attendance will be considered.
39+
* Optionally, select a specific **Attendance Type** (e.g., "Training Session," "Health Check-up") and **Attendance Location** (e.g., "Community Center A," "District Office") to filter records from the external system.
40+
41+
### Automated Beneficiary Compliance Filtering
42+
43+
When the "Filter Beneficiaries by Compliance Criteria" action is triggered on a program cycle, this module automatically fetches attendance data for all eligible registrants from the configured external system. It then compares each beneficiary's attendance count against the `required_number_of_attendance` set for the cycle.
44+
45+
* **Individual Programs**: For programs targeting individuals, beneficiaries who meet the attendance threshold are marked as 'enrolled', while those who do not are set to 'non_compliant'. The exact `number_of_attendance` is recorded on their cycle membership.
46+
* **Group Programs**: For programs targeting groups, the module assesses attendance for each individual member within the group. A group's overall compliance might depend on a certain number or percentage of its members meeting the attendance criteria, and each member's attendance status (`included` or `not_included`) is tracked within the group's cycle membership.
47+
48+
### Detailed Attendance Event Logging
49+
50+
Upon fetching attendance data from the external system, the module not only updates compliance statuses but also creates detailed `spp.event.attendance` records within OpenSPP for each individual attendance event. These records capture the date, time, type, location, and source of attendance, providing a granular history for each beneficiary. This ensures that a complete, auditable trail of attendance is maintained directly within OpenSPP, accessible for review and reporting.
51+
52+
## Conclusion
53+
54+
The OpenSPP Cycle Attendance Compliance module provides essential capabilities for managing and enforcing attendance-based compliance criteria, thereby strengthening program integrity and ensuring that social protection benefits reach actively participating beneficiaries.

spp_dashboard_base/__manifest__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"name": "OpenSPP Dashboard: Base",
66
"category": "OpenSPP",
77
"version": "17.0.1.3.1",
8+
"summary": "Establishes the foundational framework and consistent user interface components for analytical dashboards across the OpenSPP platform. It delivers core data visualization elements, including reusable metrics, charts, and data cards, enabling other modules to build specialized program-specific dashboards.",
89
"sequence": 1,
910
"author": "OpenSPP.org",
1011
"website": "https://github.com/OpenSPP/openspp-modules",

0 commit comments

Comments
 (0)