Skip to content

Commit 7c96e35

Browse files
jeremijeremi
committed
docs: regenerate addon READMEs, icons, and addons table\n\n- Run oca-gen-addon-readme for updated DESCRIPTION.md fragments\n- Update root addons table and static description pages\n- Fix spp_grm RST heading to satisfy docutils\n- Refresh external dependencies and metapackage
1 parent 7986fa2 commit 7c96e35

File tree

32 files changed

+9661
-95
lines changed

32 files changed

+9661
-95
lines changed

‎README.md‎

Lines changed: 75 additions & 75 deletions
Large diffs are not rendered by default.

‎spp_attendance/README.rst‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
==================
2+
OpenSPP Attendance
3+
==================
4+
5+
..
6+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
7+
!! This file is generated by oca-gen-addon-readme !!
8+
!! changes will be overwritten. !!
9+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10+
!! source digest: sha256:cb4da5e0378f0750196e4c5fe0e0ff0318fdd8ff97c454823835c029720b31f8
11+
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12+
13+
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
14+
:target: https://odoo-community.org/page/development-status
15+
:alt: Production/Stable
16+
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
17+
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
18+
:alt: License: LGPL-3
19+
.. |badge3| image:: https://img.shields.io/badge/github-OpenSPP%2Fopenspp--modules-lightgray.png?logo=github
20+
:target: https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_attendance
21+
:alt: OpenSPP/openspp-modules
22+
23+
|badge1| |badge2| |badge3|
24+
25+
Attendance
26+
==========
27+
28+
The OpenSPP Attendance module (spp_attendance) provides a comprehensive
29+
system for managing and tracking participant attendance across various
30+
social protection programs and farmer registries. It enables
31+
organizations to accurately record who attended specific events, when,
32+
where, and for what purpose, ensuring accountability and informing
33+
program delivery.
34+
35+
Purpose
36+
-------
37+
38+
This module streamlines the process of tracking participant engagement
39+
and presence, critical for program effectiveness and compliance. It
40+
accomplishes the following key capabilities:
41+
42+
- **Record Participant Attendance:** Accurately logs the presence or
43+
absence of individuals at specific program events, such as training
44+
sessions, benefit distributions, or community meetings. This ensures
45+
precise data for monitoring and evaluation.
46+
- **Manage Program Participants:** Creates and maintains a registry of
47+
individuals participating in social protection programs, linking
48+
their attendance records to their core profile information. This
49+
centralizes participant data for easier management.
50+
- **Categorize Attendance Events:** Defines and categorizes different
51+
types of attendance (e.g., "Cash Transfer Distribution," "Health
52+
Education Workshop") and specific locations where these events occur.
53+
This provides granular insights into program activities.
54+
- **Integrate with External Systems:** Facilitates the secure import of
55+
participant data from external registries and allows external
56+
applications to submit or query attendance records via a robust API.
57+
This supports data synchronization across the OpenSPP ecosystem.
58+
- **Monitor Participant Engagement:** Provides tools to view an
59+
individual's attendance history and aggregated attendance data,
60+
offering valuable insights into participation patterns and program
61+
reach. This helps in assessing program impact and identifying areas
62+
for improvement.
63+
64+
Dependencies and Integration
65+
----------------------------
66+
67+
The spp_attendance module integrates seamlessly with other core OpenSPP
68+
components and extends foundational Odoo functionalities:
69+
70+
- **Base (base):** As a core module, ``spp_attendance`` relies on the
71+
standard Odoo ``base`` module for fundamental system functionalities,
72+
data models, and user interface elements.
73+
- **OpenSPP API: Oauth (spp_oauth):** ``spp_attendance`` leverages the
74+
``spp_oauth`` module to provide secure API access for external
75+
applications. This ensures that any attendance data submitted or
76+
queried by external systems is authenticated and authorized,
77+
protecting sensitive participant information.
78+
- **Partner Management (res.partner):** The module extends Odoo's core
79+
``res.partner`` model to manage program participants (subscribers).
80+
Each attendance subscriber is linked to a ``res.partner`` record,
81+
allowing ``spp_attendance`` to utilize existing contact information
82+
while adding specific details relevant to program participation, such
83+
as a unique person identifier and attendance history.
84+
85+
This module serves as a foundational component for other
86+
program-specific modules that require accurate participant attendance
87+
records for their operations, such as benefit disbursement, case
88+
management, or training program management.
89+
90+
Additional Functionality
91+
------------------------
92+
93+
The ``spp_attendance`` module offers a range of features designed to
94+
provide flexible and robust attendance management:
95+
96+
Participant (Subscriber) Management
97+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
98+
99+
Users can create and manage detailed profiles for program participants,
100+
known as subscribers. Each subscriber is uniquely identified and linked
101+
to a core OpenSPP contact, ensuring consistency. The module
102+
automatically manages the underlying contact record when a subscriber is
103+
created or updated, including details like full name, additional names,
104+
gender, email, and phone numbers.
105+
106+
Flexible Attendance Recording
107+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
108+
109+
The module enables recording of attendance events with specific details.
110+
For each record, users specify the attendance date, time, and category
111+
(either "Present" or "Absent"). Additional context can be added through
112+
a description and an external URL, useful for linking to external
113+
resources or evidence of attendance.
114+
115+
- **Configurable Uniqueness:** System administrators can configure
116+
rules to prevent duplicate attendance entries for a single
117+
participant. This includes options to ensure uniqueness based on
118+
combinations of date, time, attendance type, and location, preventing
119+
data entry errors and ensuring data integrity.
120+
- **Attendance History:** Users can quickly retrieve a comprehensive
121+
attendance history for any participant, filtering by date ranges,
122+
attendance type, or location, providing a clear overview of their
123+
engagement.
124+
125+
Custom Attendance Types and Locations
126+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
127+
128+
To accommodate diverse program needs, the module allows for the
129+
definition of custom attendance types and locations.
130+
131+
- **Attendance Types:** Organizations can define various types of
132+
attendance events (e.g., "Training Session," "Cash Distribution,"
133+
"Health Screening"). Each type can have a name and description,
134+
allowing for clear classification of activities.
135+
- **Attendance Locations:** Users can establish a list of specific
136+
locations where attendance events occur (e.g., "District Office A,"
137+
"Community Hall B"). This helps in geographic tracking and reporting
138+
of program activities.
139+
140+
External System Integration
141+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
142+
143+
The ``spp_attendance`` module supports integration with external systems
144+
for both data import and API-driven attendance management.
145+
146+
- **Secure API Access:** Organizations can generate unique Client ID
147+
and Client Secret credentials for external applications. These
148+
credentials enable secure, authenticated access to the
149+
``spp_attendance`` API, allowing external systems (e.g., mobile
150+
attendance capture apps) to submit new attendance records or query
151+
existing ones.
152+
- **Registry Data Import:** A dedicated wizard facilitates the import
153+
of participant data from external registries. This feature includes
154+
configurable mapping of fields (such as personal information,
155+
identifiers, and contact details) to ensure accurate and efficient
156+
synchronization of participant records into OpenSPP.
157+
158+
Conclusion
159+
----------
160+
161+
The OpenSPP Attendance module is essential for effectively managing and
162+
monitoring participant engagement within social protection programs,
163+
providing robust tools for recording, categorizing, and integrating
164+
attendance data across the OpenSPP platform.
165+
166+
**Table of contents**
167+
168+
.. contents::
169+
:local:
170+
171+
Bug Tracker
172+
===========
173+
174+
Bugs are tracked on `GitHub Issues <https://github.com/OpenSPP/openspp-modules/issues>`_.
175+
In case of trouble, please check there if your issue has already been reported.
176+
If you spotted it first, help us to smash it by providing a detailed and welcomed
177+
`feedback <https://github.com/OpenSPP/openspp-modules/issues/new?body=module:%20spp_attendance%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
178+
179+
Do not contact contributors directly about support or help with technical issues.
180+
181+
Credits
182+
=======
183+
184+
Authors
185+
-------
186+
187+
* OpenSPP.org
188+
189+
Maintainers
190+
-----------
191+
192+
.. |maintainer-reichie020212| image:: https://github.com/reichie020212.png?size=40px
193+
:target: https://github.com/reichie020212
194+
:alt: reichie020212
195+
196+
Current maintainer:
197+
198+
|maintainer-reichie020212|
199+
200+
This module is part of the `OpenSPP/openspp-modules <https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_attendance>`_ project on GitHub.
201+
202+
You are welcome to contribute.

0 commit comments

Comments
 (0)