Skip to content

chore(spp_cel_event): promote to Beta #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
emjay0921 wants to merge 1 commit into
base: 19.0
Choose a base branch
from
Open

chore(spp_cel_event): promote to Beta #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 21 additions & 26 deletions spp_cel_event/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ OpenSPP CEL Event Data Integration
!! source digest: sha256:e2f2bc40368e1bb65ac6336eec7a46ff133360ef67c8283271317282c593c0df
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Alpha
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
Expand All @@ -35,15 +35,15 @@ with Python fallback for complex cases.
Key Capabilities
~~~~~~~~~~~~~~~~

- Query event field values with temporal filtering (within_days,
within_months, named periods) and selection modes (active, latest,
latest_active, first, any)
- Check event existence with date-based filtering
- Aggregate event data using count, sum, avg, min, max functions
- Generate period strings using helper functions (this_year,
this_quarter, etc.)
- Optimize queries using SQL fast paths with automatic fallback to
Python evaluation
- Query event field values with temporal filtering (within_days,
within_months, named periods) and selection modes (active, latest,
latest_active, first, any)
- Check event existence with date-based filtering
- Aggregate event data using count, sum, avg, min, max functions
- Generate period strings using helper functions (this_year,
this_quarter, etc.)
- Optimize queries using SQL fast paths with automatic fallback to
Python evaluation

Key Models
~~~~~~~~~~
Expand Down Expand Up @@ -74,9 +74,9 @@ optimal query performance.
UI Location
~~~~~~~~~~~

- **Menu**: Studio > Rules > Variables > All Variables
- **Form**: Event aggregation fields appear in the Source Configuration
section when **Aggregate Target** is set to "Events"
- **Menu**: Studio > Rules > Variables > All Variables
- **Form**: Event aggregation fields appear in the Source Configuration
section when **Aggregate Target** is set to "Events"

Security
~~~~~~~~
Expand All @@ -87,24 +87,19 @@ No module-specific security. Access control inherits from
Extension Points
~~~~~~~~~~~~~~~~

- Override ``spp.cel.translator._to_plan()`` to add custom event query
plan nodes
- Override ``spp.cel.executor._exec_event_value_sql()`` to customize
SQL execution logic
- Extend period helper functions in ``models/cel_event_functions.py``
- Implement custom aggregation functions following the
events_count/sum/avg pattern
- Override ``spp.cel.translator._to_plan()`` to add custom event query
plan nodes
- Override ``spp.cel.executor._exec_event_value_sql()`` to customize SQL
execution logic
- Extend period helper functions in ``models/cel_event_functions.py``
- Implement custom aggregation functions following the
events_count/sum/avg pattern

Dependencies
~~~~~~~~~~~~

``spp_cel_domain``, ``spp_event_data``, ``spp_studio``

Copy link

@gemini-code-assist gemini-code-assist bot Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While promoting to Beta is a great step, it's good practice to still include a warning about the development status. According to the Odoo Community Association guidelines, a Beta version's data model is not yet stable. Consider adding a note to inform users about this, similar to the one that was removed for the Alpha status.

Suggested change
.. IMPORTANT::
This is a beta version. The data model is not yet stable and may change in future versions.
It is not recommended to use this version in a production environment without thorough testing.
`More details on development status <https://odoo-community.org/page/development-status>`_

.. IMPORTANT::
This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
`More details on development status <https://odoo-community.org/page/development-status>`_

**Table of contents**

.. contents::
Expand Down
2 changes: 1 addition & 1 deletion spp_cel_event/__manifest__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"author": "OpenSPP.org",
"website": "https://github.com/OpenSPP/OpenSPP2",
"license": "LGPL-3",
"development_status": "Alpha",
"development_status": "Beta",
"maintainers": ["jeremi", "gonzalesedwin1123", "emjay0921"],
"depends": [
"spp_cel_domain",
Expand Down
12 changes: 3 additions & 9 deletions spp_cel_event/static/description/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ <h1>OpenSPP CEL Event Data Integration</h1>
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:e2f2bc40368e1bb65ac6336eec7a46ff133360ef67c8283271317282c593c0df
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_cel_event"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/license-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/OpenSPP2/tree/19.0/spp_cel_event"><img alt="OpenSPP/OpenSPP2" src="https://img.shields.io/badge/github-OpenSPP%2FOpenSPP2-lightgray.png?logo=github" /></a></p>
<p>Integrates event data with CEL expressions for eligibility and
entitlement rules. Extends the CEL domain framework to query event data
records collected through surveys, field visits, and assessments.
Expand Down Expand Up @@ -451,8 +451,8 @@ <h2>Extension Points</h2>
<ul class="simple">
<li>Override <tt class="docutils literal">spp.cel.translator._to_plan()</tt> to add custom event query
plan nodes</li>
<li>Override <tt class="docutils literal">spp.cel.executor._exec_event_value_sql()</tt> to customize
SQL execution logic</li>
<li>Override <tt class="docutils literal">spp.cel.executor._exec_event_value_sql()</tt> to customize SQL
execution logic</li>
<li>Extend period helper functions in <tt class="docutils literal">models/cel_event_functions.py</tt></li>
<li>Implement custom aggregation functions following the
events_count/sum/avg pattern</li>
Expand All @@ -461,12 +461,6 @@ <h2>Extension Points</h2>
<div class="section" id="dependencies">
<h2>Dependencies</h2>
<p><tt class="docutils literal">spp_cel_domain</tt>, <tt class="docutils literal">spp_event_data</tt>, <tt class="docutils literal">spp_studio</tt></p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
</div>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
Expand Down
Loading