Skip to content

Commit 64618d1

Browse files
jeremijeremi
committed
docs: clean MyST fences and graphviz; remove conflicting DESCRIPTION.rst; regenerate README.rst across addons
1 parent 9f27d2e commit 64618d1

File tree

13 files changed

+1206
-920
lines changed

13 files changed

+1206
-920
lines changed

‎spp_custom_field_custom_filter/README.rst‎

Lines changed: 97 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ OpenSPP Custom Field Custom Filter Integration
77
!! This file is generated by oca-gen-addon-readme !!
88
!! changes will be overwritten. !!
99
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
10-
!! source digest: sha256:3caaf6e3aa1813a149d470804494b6f4047c77429da5513b3dde4d867d84838d
10+
!! source digest: sha256:179eca0e6bacedb7578b7728879e51e5f5723363023bb048c37529f326fa3537
1111
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
1212
1313
.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
@@ -25,79 +25,110 @@ OpenSPP Custom Field Custom Filter Integration
2525
OpenSPP Custom Field Custom Filter
2626
==================================
2727

28-
Overview
29-
--------
30-
31-
The **SPP Custom Field - Custom Filter Integration** module bridges the
32-
functionality of the [G2P Registry: Custom Fields UI](G2P Registry:
33-
Custom Fields UI) module and the [SPP Custom Filter](SPP Custom Filter)
34-
module. It allows administrators to decide whether a custom field,
35-
created through the [G2P Registry: Custom Fields UI](G2P Registry:
36-
Custom Fields UI](G2P Registry: Custom Fields UI](G2P Registry: Custom
37-
Fields UI) module and the [SPP Custom Filter](SPP Custom Filter) module.
38-
It allows administrators to decide whether a custom field, created
39-
through the [G2P Registry: Custom Fields UI) module, should be available
40-
for filtering within the system. This integration provides a
41-
comprehensive approach to managing both the definition and usability of
42-
custom fields within the OpenSPP platform.
28+
The OpenSPP Custom Field Custom Filter module integrates custom-defined
29+
data fields directly into the platform's powerful filtering system. This
30+
module empowers program administrators to make the unique data they
31+
collect fully actionable, enabling more precise data analysis and
32+
operational management.
4333

4434
Purpose
4535
-------
4636

47-
The primary goal of this module is to enhance the filtering capabilities
48-
of custom fields within OpenSPP. By enabling the "Allow Filter" option
49-
for specific custom fields, administrators can empower users to filter
50-
and analyze registry data based on these custom attributes. This
51-
granular control over filterable fields contributes to a more efficient
52-
and tailored user experience.
53-
54-
Integration and Functionality
55-
-----------------------------
56-
57-
1. **Dependency on Custom Field Definition:** This module relies on the
58-
[G2P Registry: Custom Fields UI](G2P Registry: Custom Fields UI)
59-
module for the creation and management of custom fields. It extends
60-
the functionality of this module by adding a filtering dimension to
61-
the custom field definition.
62-
63-
2. **Integration with Custom Filter Logic:** It seamlessly integrates
64-
with the [SPP Custom Filter](SPP Custom Filter) module, which
65-
provides the underlying mechanism for controlling the visibility of
66-
fields in filter dropdowns. The "Allow Filter" option, added by this
67-
module, acts as a flag that the [SPP Custom Filter](SPP Custom
68-
Filter](SPP Custom Filter](SPP Custom Filter) module, which provides
69-
the underlying mechanism for controlling the visibility of fields in
70-
filter dropdowns. The "Allow Filter" option, added by this module,
71-
acts as a flag that the [SPP Custom Filter) module uses to determine
72-
whether to display a custom field in the filter interface.
73-
74-
3. **User Interface Enhancement:** From the user perspective, enabling
75-
the "Allow Filter" option for a custom field results in that field
76-
appearing as a selectable option in the filter dropdown menus,
77-
alongside standard fields. This allows users to construct specific
78-
queries and filter data based on the values stored in these custom
79-
fields.
80-
81-
Example Use Case
82-
----------------
83-
84-
Let's say a program using OpenSPP has defined a custom field called
85-
"Disability Status" to track the disability status of registrants. By
86-
enabling the "Allow Filter" option for this custom field, program staff
87-
can easily filter the registry to identify and target interventions for
88-
registrants with specific disabilities. This streamlines program
89-
operations and allows for more effective service delivery.
37+
This module significantly enhances OpenSPP's data management
38+
capabilities by allowing custom fields to be used for filtering and
39+
querying records. It addresses the need for programs to segment and
40+
analyze data based on criteria unique to their operations, beyond the
41+
standard fields.
42+
43+
- **Enables Custom Field Filtering:** Allows program-specific custom
44+
fields, defined by administrators, to appear and function within the
45+
system's filter dropdown menus.
46+
- **Enhances Data Analysis:** Provides the ability to construct highly
47+
specific queries using unique program data, facilitating deeper
48+
insights into beneficiary populations or farmer registries.
49+
- **Improves Operational Efficiency:** Streamlines the process of
50+
identifying and segmenting specific groups of records for targeted
51+
interventions, reporting, or communication.
52+
- **Extends Custom Field Utility:** Increases the value of custom
53+
fields by transforming them from mere data points into powerful tools
54+
for data retrieval and program management.
55+
- **Granular Control:** Offers administrators the flexibility to choose
56+
precisely which custom fields are relevant for filtering, preventing
57+
clutter in the user interface.
58+
59+
Dependencies and Integration
60+
----------------------------
61+
62+
This module acts as a crucial bridge, integrating two foundational
63+
OpenSPP modules to extend their combined functionality.
64+
65+
It depends on the `OpenSPP Custom Fields UI <spp_custom_fields_ui>`__
66+
module, which provides the interface for defining and managing the
67+
custom fields themselves. Without custom fields being created, there
68+
would be no custom data to filter.
69+
70+
Furthermore, this module relies on the `OpenSPP Custom
71+
Filter <spp_custom_filter>`__ module. The Custom Filter module
72+
establishes the core mechanism that allows administrators to mark any
73+
field as filterable. This module specifically leverages that mechanism
74+
to ensure that custom fields defined via the Custom Fields UI are also
75+
eligible to be marked as filterable.
76+
77+
By integrating these, the OpenSPP Custom Field Custom Filter module
78+
ensures that custom-defined data becomes a seamless part of the system's
79+
advanced filtering capabilities, making this unique data accessible and
80+
actionable across various OpenSPP functionalities that utilize filtered
81+
data for reporting and analysis.
82+
83+
Additional Functionality
84+
------------------------
85+
86+
The OpenSPP Custom Field Custom Filter module extends the platform's
87+
capabilities through several key features focused on leveraging custom
88+
data for advanced filtering.
89+
90+
Activating Custom Fields for Filtering
91+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
92+
93+
Administrators can easily designate which custom fields, previously
94+
created using the `OpenSPP Custom Fields UI <spp_custom_fields_ui>`__
95+
module, should be available in the system's filter options. This
96+
capability allows programs to extend standard filtering to include
97+
unique, program-specific data points such as "Disability Type,"
98+
"Preferred Crop Variety," or "Household Vulnerability Score." This
99+
ensures that only relevant custom fields appear in the filter menus,
100+
maintaining a clear and user-friendly interface.
101+
102+
Advanced Data Segmentation and Analysis
103+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
104+
105+
This module empowers program staff to perform highly specific data
106+
segmentation. Users can combine standard filters with custom field
107+
filters to isolate very particular groups of beneficiaries or farmers.
108+
For instance, a program manager could filter for "all female
109+
beneficiaries aged 18-35 residing in District X who have a 'Vocational
110+
Training: Sewing' status" to identify candidates for a new program
111+
initiative. This greatly enhances the ability to conduct targeted
112+
reporting, impact assessments, and operational planning based on
113+
detailed, program-specific criteria.
114+
115+
Streamlined Program Operations
116+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
117+
118+
By enabling custom field filtering, program operations become more
119+
efficient. Staff can quickly generate dynamic lists of beneficiaries or
120+
farmers based on unique attributes, facilitating targeted interventions,
121+
communications, or service delivery. This reduces the manual effort
122+
required to sort and categorize data, allowing program teams to respond
123+
more effectively to evolving program needs and beneficiary profiles.
90124

91125
Conclusion
92126
----------
93127

94-
The **SPP Custom Field - Custom Filter Integration** module plays a
95-
crucial role in maximizing the utility of custom fields within OpenSPP.
96-
By linking custom field definitions with filtering capabilities, this
97-
module provides a powerful tool for data analysis, reporting, and
98-
program implementation. It contributes to a more flexible and
99-
user-friendly system that can be readily adapted to the specific needs
100-
of diverse social protection programs.
128+
The OpenSPP Custom Field Custom Filter module is essential for making
129+
program-specific data actionable, transforming custom fields from mere
130+
data points into powerful tools for precise data analysis and efficient
131+
program management within OpenSPP.
101132

102133
**Table of contents**
103134

‎spp_custom_field_custom_filter/static/description/index.html‎

Lines changed: 88 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -367,79 +367,105 @@ <h1 class="title">OpenSPP Custom Field Custom Filter Integration</h1>
367367
!! This file is generated by oca-gen-addon-readme !!
368368
!! changes will be overwritten. !!
369369
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
370-
!! source digest: sha256:3caaf6e3aa1813a149d470804494b6f4047c77429da5513b3dde4d867d84838d
370+
!! source digest: sha256:179eca0e6bacedb7578b7728879e51e5f5723363023bb048c37529f326fa3537
371371
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
372372
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.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/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OpenSPP/openspp-modules/tree/17.0/spp_custom_field_custom_filter"><img alt="OpenSPP/openspp-modules" src="https://img.shields.io/badge/github-OpenSPP%2Fopenspp--modules-lightgray.png?logo=github" /></a></p>
373373
<div class="section" id="openspp-custom-field-custom-filter">
374374
<h1>OpenSPP Custom Field Custom Filter</h1>
375-
<div class="section" id="overview">
376-
<h2>Overview</h2>
377-
<p>The <strong>SPP Custom Field - Custom Filter Integration</strong> module bridges the
378-
functionality of the [G2P Registry: Custom Fields UI](G2P Registry:
379-
Custom Fields UI) module and the [SPP Custom Filter](SPP Custom Filter)
380-
module. It allows administrators to decide whether a custom field,
381-
created through the [G2P Registry: Custom Fields UI](G2P Registry:
382-
Custom Fields UI](G2P Registry: Custom Fields UI](G2P Registry: Custom
383-
Fields UI) module and the [SPP Custom Filter](SPP Custom Filter) module.
384-
It allows administrators to decide whether a custom field, created
385-
through the [G2P Registry: Custom Fields UI) module, should be available
386-
for filtering within the system. This integration provides a
387-
comprehensive approach to managing both the definition and usability of
388-
custom fields within the OpenSPP platform.</p>
389-
</div>
375+
<p>The OpenSPP Custom Field Custom Filter module integrates custom-defined
376+
data fields directly into the platform’s powerful filtering system. This
377+
module empowers program administrators to make the unique data they
378+
collect fully actionable, enabling more precise data analysis and
379+
operational management.</p>
390380
<div class="section" id="purpose">
391381
<h2>Purpose</h2>
392-
<p>The primary goal of this module is to enhance the filtering capabilities
393-
of custom fields within OpenSPP. By enabling the “Allow Filter” option
394-
for specific custom fields, administrators can empower users to filter
395-
and analyze registry data based on these custom attributes. This
396-
granular control over filterable fields contributes to a more efficient
397-
and tailored user experience.</p>
382+
<p>This module significantly enhances OpenSPP’s data management
383+
capabilities by allowing custom fields to be used for filtering and
384+
querying records. It addresses the need for programs to segment and
385+
analyze data based on criteria unique to their operations, beyond the
386+
standard fields.</p>
387+
<ul class="simple">
388+
<li><strong>Enables Custom Field Filtering:</strong> Allows program-specific custom
389+
fields, defined by administrators, to appear and function within the
390+
system’s filter dropdown menus.</li>
391+
<li><strong>Enhances Data Analysis:</strong> Provides the ability to construct highly
392+
specific queries using unique program data, facilitating deeper
393+
insights into beneficiary populations or farmer registries.</li>
394+
<li><strong>Improves Operational Efficiency:</strong> Streamlines the process of
395+
identifying and segmenting specific groups of records for targeted
396+
interventions, reporting, or communication.</li>
397+
<li><strong>Extends Custom Field Utility:</strong> Increases the value of custom
398+
fields by transforming them from mere data points into powerful tools
399+
for data retrieval and program management.</li>
400+
<li><strong>Granular Control:</strong> Offers administrators the flexibility to choose
401+
precisely which custom fields are relevant for filtering, preventing
402+
clutter in the user interface.</li>
403+
</ul>
404+
</div>
405+
<div class="section" id="dependencies-and-integration">
406+
<h2>Dependencies and Integration</h2>
407+
<p>This module acts as a crucial bridge, integrating two foundational
408+
OpenSPP modules to extend their combined functionality.</p>
409+
<p>It depends on the <a class="reference external" href="spp_custom_fields_ui">OpenSPP Custom Fields UI</a>
410+
module, which provides the interface for defining and managing the
411+
custom fields themselves. Without custom fields being created, there
412+
would be no custom data to filter.</p>
413+
<p>Furthermore, this module relies on the <a class="reference external" href="spp_custom_filter">OpenSPP Custom
414+
Filter</a> module. The Custom Filter module
415+
establishes the core mechanism that allows administrators to mark any
416+
field as filterable. This module specifically leverages that mechanism
417+
to ensure that custom fields defined via the Custom Fields UI are also
418+
eligible to be marked as filterable.</p>
419+
<p>By integrating these, the OpenSPP Custom Field Custom Filter module
420+
ensures that custom-defined data becomes a seamless part of the system’s
421+
advanced filtering capabilities, making this unique data accessible and
422+
actionable across various OpenSPP functionalities that utilize filtered
423+
data for reporting and analysis.</p>
424+
</div>
425+
<div class="section" id="additional-functionality">
426+
<h2>Additional Functionality</h2>
427+
<p>The OpenSPP Custom Field Custom Filter module extends the platform’s
428+
capabilities through several key features focused on leveraging custom
429+
data for advanced filtering.</p>
430+
<div class="section" id="activating-custom-fields-for-filtering">
431+
<h3>Activating Custom Fields for Filtering</h3>
432+
<p>Administrators can easily designate which custom fields, previously
433+
created using the <a class="reference external" href="spp_custom_fields_ui">OpenSPP Custom Fields UI</a>
434+
module, should be available in the system’s filter options. This
435+
capability allows programs to extend standard filtering to include
436+
unique, program-specific data points such as “Disability Type,”
437+
“Preferred Crop Variety,” or “Household Vulnerability Score.” This
438+
ensures that only relevant custom fields appear in the filter menus,
439+
maintaining a clear and user-friendly interface.</p>
440+
</div>
441+
<div class="section" id="advanced-data-segmentation-and-analysis">
442+
<h3>Advanced Data Segmentation and Analysis</h3>
443+
<p>This module empowers program staff to perform highly specific data
444+
segmentation. Users can combine standard filters with custom field
445+
filters to isolate very particular groups of beneficiaries or farmers.
446+
For instance, a program manager could filter for “all female
447+
beneficiaries aged 18-35 residing in District X who have a ‘Vocational
448+
Training: Sewing’ status” to identify candidates for a new program
449+
initiative. This greatly enhances the ability to conduct targeted
450+
reporting, impact assessments, and operational planning based on
451+
detailed, program-specific criteria.</p>
398452
</div>
399-
<div class="section" id="integration-and-functionality">
400-
<h2>Integration and Functionality</h2>
401-
<ol class="arabic simple">
402-
<li><strong>Dependency on Custom Field Definition:</strong> This module relies on the
403-
[G2P Registry: Custom Fields UI](G2P Registry: Custom Fields UI)
404-
module for the creation and management of custom fields. It extends
405-
the functionality of this module by adding a filtering dimension to
406-
the custom field definition.</li>
407-
<li><strong>Integration with Custom Filter Logic:</strong> It seamlessly integrates
408-
with the [SPP Custom Filter](SPP Custom Filter) module, which
409-
provides the underlying mechanism for controlling the visibility of
410-
fields in filter dropdowns. The “Allow Filter” option, added by this
411-
module, acts as a flag that the [SPP Custom Filter](SPP Custom
412-
Filter](SPP Custom Filter](SPP Custom Filter) module, which provides
413-
the underlying mechanism for controlling the visibility of fields in
414-
filter dropdowns. The “Allow Filter” option, added by this module,
415-
acts as a flag that the [SPP Custom Filter) module uses to determine
416-
whether to display a custom field in the filter interface.</li>
417-
<li><strong>User Interface Enhancement:</strong> From the user perspective, enabling
418-
the “Allow Filter” option for a custom field results in that field
419-
appearing as a selectable option in the filter dropdown menus,
420-
alongside standard fields. This allows users to construct specific
421-
queries and filter data based on the values stored in these custom
422-
fields.</li>
423-
</ol>
453+
<div class="section" id="streamlined-program-operations">
454+
<h3>Streamlined Program Operations</h3>
455+
<p>By enabling custom field filtering, program operations become more
456+
efficient. Staff can quickly generate dynamic lists of beneficiaries or
457+
farmers based on unique attributes, facilitating targeted interventions,
458+
communications, or service delivery. This reduces the manual effort
459+
required to sort and categorize data, allowing program teams to respond
460+
more effectively to evolving program needs and beneficiary profiles.</p>
424461
</div>
425-
<div class="section" id="example-use-case">
426-
<h2>Example Use Case</h2>
427-
<p>Let’s say a program using OpenSPP has defined a custom field called
428-
“Disability Status” to track the disability status of registrants. By
429-
enabling the “Allow Filter” option for this custom field, program staff
430-
can easily filter the registry to identify and target interventions for
431-
registrants with specific disabilities. This streamlines program
432-
operations and allows for more effective service delivery.</p>
433462
</div>
434463
<div class="section" id="conclusion">
435464
<h2>Conclusion</h2>
436-
<p>The <strong>SPP Custom Field - Custom Filter Integration</strong> module plays a
437-
crucial role in maximizing the utility of custom fields within OpenSPP.
438-
By linking custom field definitions with filtering capabilities, this
439-
module provides a powerful tool for data analysis, reporting, and
440-
program implementation. It contributes to a more flexible and
441-
user-friendly system that can be readily adapted to the specific needs
442-
of diverse social protection programs.</p>
465+
<p>The OpenSPP Custom Field Custom Filter module is essential for making
466+
program-specific data actionable, transforming custom fields from mere
467+
data points into powerful tools for precise data analysis and efficient
468+
program management within OpenSPP.</p>
443469
<p><strong>Table of contents</strong></p>
444470
</div>
445471
</div>

0 commit comments

Comments
 (0)