diff --git a/spp_alerts/README.rst b/spp_alerts/README.rst index 54f87c0d..d67d1fe6 100644 --- a/spp_alerts/README.rst +++ b/spp_alerts/README.rst @@ -43,15 +43,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------+-------------------------------------------------+ -| Model | Description | -+====================+=================================================+ -| ``spp.alert`` | Alert instance with state tracking and | -| | resolution workflow | -+--------------------+-------------------------------------------------+ -| ``spp.alert.rule`` | Rule configuration for monitoring criteria and | -| | thresholds | -+--------------------+-------------------------------------------------+ ++--------------------+------------------------------------------------+ +| Model | Description | ++====================+================================================+ +| ``spp.alert`` | Alert instance with state tracking and | +| | resolution workflow | ++--------------------+------------------------------------------------+ +| ``spp.alert.rule`` | Rule configuration for monitoring criteria and | +| | thresholds | ++--------------------+------------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_api_v2/README.rst b/spp_api_v2/README.rst index a73935a8..e9731ed0 100644 --- a/spp_api_v2/README.rst +++ b/spp_api_v2/README.rst @@ -44,24 +44,24 @@ Key Capabilities Key Models ---------- -+---------------------------+------------------------------------------+ -| Model | Description | -+===========================+==========================================+ -| ``spp.api.client`` | OAuth 2.0 credentials, organization | -| | verification | -+---------------------------+------------------------------------------+ -| ``spp.api.client.scope`` | Resource/action permissions | -+---------------------------+------------------------------------------+ -| ``spp.api.path`` | Endpoint configuration and filters | -+---------------------------+------------------------------------------+ -| ``spp.api.path.filter`` | Field-level filter configurations | -+---------------------------+------------------------------------------+ -| ``spp.api.filter.preset`` | Saved filter combinations | -+---------------------------+------------------------------------------+ -| ``spp.api.extension`` | Domain field registry | -+---------------------------+------------------------------------------+ -| ``spp.consent.scope`` | Resource types per consent | -+---------------------------+------------------------------------------+ ++---------------------------+-----------------------------------------+ +| Model | Description | ++===========================+=========================================+ +| ``spp.api.client`` | OAuth 2.0 credentials, organization | +| | verification | ++---------------------------+-----------------------------------------+ +| ``spp.api.client.scope`` | Resource/action permissions | ++---------------------------+-----------------------------------------+ +| ``spp.api.path`` | Endpoint configuration and filters | ++---------------------------+-----------------------------------------+ +| ``spp.api.path.filter`` | Field-level filter configurations | ++---------------------------+-----------------------------------------+ +| ``spp.api.filter.preset`` | Saved filter combinations | ++---------------------------+-----------------------------------------+ +| ``spp.api.extension`` | Domain field registry | ++---------------------------+-----------------------------------------+ +| ``spp.consent.scope`` | Resource types per consent | ++---------------------------+-----------------------------------------+ UI Location ----------- @@ -110,20 +110,20 @@ API endpoints available at ``/api/v2/`` (token endpoint: Security -------- -+--------------------------+-------------------------------------------+ -| Group | Access | -+==========================+===========================================+ -| ``group_api_v2_viewer`` | Read-only: all API configuration and | -| | consent | -+--------------------------+-------------------------------------------+ -| ``group_api_v2_officer`` | Read/Write: all models (no | -| | create/delete), full CRUD on consent | -| | scopes | -+--------------------------+-------------------------------------------+ -| ``group_api_v2_manager`` | Full CRUD: clients, scopes, paths, | -| | filters, presets, extensions; | -| | Read/Write/Create on consent (no delete) | -+--------------------------+-------------------------------------------+ ++--------------------------+------------------------------------------+ +| Group | Access | ++==========================+==========================================+ +| ``group_api_v2_viewer`` | Read-only: all API configuration and | +| | consent | ++--------------------------+------------------------------------------+ +| ``group_api_v2_officer`` | Read/Write: all models (no | +| | create/delete), full CRUD on consent | +| | scopes | ++--------------------------+------------------------------------------+ +| ``group_api_v2_manager`` | Full CRUD: clients, scopes, paths, | +| | filters, presets, extensions; | +| | Read/Write/Create on consent (no delete) | ++--------------------------+------------------------------------------+ Extension Points ---------------- diff --git a/spp_api_v2/static/description/index.html b/spp_api_v2/static/description/index.html index 7c943e8b..7fd00cf9 100644 --- a/spp_api_v2/static/description/index.html +++ b/spp_api_v2/static/description/index.html @@ -393,8 +393,8 @@

Key Capabilities

Key Models

--++ diff --git a/spp_api_v2_change_request/README.rst b/spp_api_v2_change_request/README.rst index 5858f9ba..b632afbc 100644 --- a/spp_api_v2_change_request/README.rst +++ b/spp_api_v2_change_request/README.rst @@ -47,19 +47,19 @@ Key Models This module extends existing models and does not define new ones. -+-----------------------------+----------------------------------------+ -| Model | Usage | -+=============================+========================================+ -| ``fastapi.endpoint`` | Extended to register ChangeRequest | -| | router with API V2 | -+-----------------------------+----------------------------------------+ -| ``spp.change.request`` | CRUD operations via REST API | -+-----------------------------+----------------------------------------+ -| ``spp.change.request.type`` | Looked up by code in create requests | -+-----------------------------+----------------------------------------+ -| ``spp.registry.id`` | Used to resolve registrant identifiers | -| | (system|value) | -+-----------------------------+----------------------------------------+ ++-----------------------------+---------------------------------------+ +| Model | Usage | ++=============================+=======================================+ +| ``fastapi.endpoint`` | Extended to register ChangeRequest | +| | router with API V2 | ++-----------------------------+---------------------------------------+ +| ``spp.change.request`` | CRUD operations via REST API | ++-----------------------------+---------------------------------------+ +| ``spp.change.request.type`` | Looked up by code in create requests | ++-----------------------------+---------------------------------------+ +| ``spp.registry.id`` | Used to resolve registrant | +| | identifiers (system|value) | ++-----------------------------+---------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_api_v2_change_request/static/description/index.html b/spp_api_v2_change_request/static/description/index.html index 4c0c788f..3c6d9a72 100644 --- a/spp_api_v2_change_request/static/description/index.html +++ b/spp_api_v2_change_request/static/description/index.html @@ -395,8 +395,8 @@

Key Models

This module extends existing models and does not define new ones.

Model
--++ @@ -415,8 +415,8 @@

Key Models

- +
Model Looked up by code in create requests
spp.registry.idUsed to resolve registrant identifiers -(system|value)Used to resolve registrant +identifiers (system|value)
diff --git a/spp_api_v2_entitlements/README.rst b/spp_api_v2_entitlements/README.rst index fbde6155..3941c873 100644 --- a/spp_api_v2_entitlements/README.rst +++ b/spp_api_v2_entitlements/README.rst @@ -44,15 +44,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------------+-------------------------------------------+ -| Model | Description | -+==========================+===========================================+ -| ``spp.api.client.scope`` | Extended to add ``entitlement`` as | -| | resource type | -+--------------------------+-------------------------------------------+ -| ``fastapi.endpoint`` | Extended to register entitlement router | -| | for ``api_v2`` app | -+--------------------------+-------------------------------------------+ ++--------------------------+------------------------------------------+ +| Model | Description | ++==========================+==========================================+ +| ``spp.api.client.scope`` | Extended to add ``entitlement`` as | +| | resource type | ++--------------------------+------------------------------------------+ +| ``fastapi.endpoint`` | Extended to register entitlement router | +| | for ``api_v2`` app | ++--------------------------+------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_api_v2_gis/README.rst b/spp_api_v2_gis/README.rst index 14c61f2e..85408fe6 100644 --- a/spp_api_v2_gis/README.rst +++ b/spp_api_v2_gis/README.rst @@ -53,23 +53,27 @@ API Endpoints **OGC API - Features (primary interface)** -+-------------------------------------------+--------+------------------------------+ -| Endpoint | Method | Description | -+===========================================+========+==============================+ -| ``/gis/ogc/`` | GET | OGC API landing page | -+-------------------------------------------+--------+------------------------------+ -| ``/gis/ogc/conformance`` | GET | OGC conformance classes | -+-------------------------------------------+--------+------------------------------+ -| ``/gis/ogc/collections`` | GET | List feature collections | -+-------------------------------------------+--------+------------------------------+ -| ``/gis/ogc/collections/{id}`` | GET | Collection metadata | -+-------------------------------------------+--------+------------------------------+ -| ``/gis/ogc/collections/{id}/items`` | GET | Feature items (GeoJSON) | -+-------------------------------------------+--------+------------------------------+ -| ``/gis/ogc/collections/{id}/items/{fid}`` | GET | Single feature | -+-------------------------------------------+--------+------------------------------+ -| ``/gis/ogc/collections/{id}/qml`` | GET | QGIS style file (extension) | -+-------------------------------------------+--------+------------------------------+ ++-----------------------------+--------+-----------------------------+ +| Endpoint | Method | Description | ++=============================+========+=============================+ +| ``/gis/ogc/`` | GET | OGC API landing page | ++-----------------------------+--------+-----------------------------+ +| ``/gis/ogc/conformance`` | GET | OGC conformance classes | ++-----------------------------+--------+-----------------------------+ +| ``/gis/ogc/collections`` | GET | List feature collections | ++-----------------------------+--------+-----------------------------+ +| `` | GET | Collection metadata | +| /gis/ogc/collections/{id}`` | | | ++-----------------------------+--------+-----------------------------+ +| ``/gis/o | GET | Feature items (GeoJSON) | +| gc/collections/{id}/items`` | | | ++-----------------------------+--------+-----------------------------+ +| ``/gis/ogc/col | GET | Single feature | +| lections/{id}/items/{fid}`` | | | ++-----------------------------+--------+-----------------------------+ +| ``/gis | GET | QGIS style file (extension) | +| /ogc/collections/{id}/qml`` | | | ++-----------------------------+--------+-----------------------------+ **Additional endpoints** @@ -87,15 +91,16 @@ Scopes and Data Privacy **OAuth Scopes** -+------------------+--------------+------------------------------------+ -| Scope | Access | Description | -+==================+==============+====================================+ -| ``gis:read`` | Read-only | View collections, layers, | -| | | statistics, export data | -+------------------+--------------+------------------------------------+ -| ``gis:geofence`` | Read + Write | Create and archive geofences (also | -| | | requires ``gis:read`` for listing) | -+------------------+--------------+------------------------------------+ ++------------------+--------------+----------------------------------+ +| Scope | Access | Description | ++==================+==============+==================================+ +| ``gis:read`` | Read-only | View collections, layers, | +| | | statistics, export data | ++------------------+--------------+----------------------------------+ +| ``gis:geofence`` | Read + Write | Create and archive geofences | +| | | (also requires ``gis:read`` for | +| | | listing) | ++------------------+--------------+----------------------------------+ **What data is exposed** diff --git a/spp_api_v2_gis/static/description/index.html b/spp_api_v2_gis/static/description/index.html index 5da61de2..451b007b 100644 --- a/spp_api_v2_gis/static/description/index.html +++ b/spp_api_v2_gis/static/description/index.html @@ -401,9 +401,9 @@

API Endpoints

OGC API - Features (primary interface)

---+++ @@ -424,19 +424,23 @@

API Endpoints

- + - + - + - + @@ -480,9 +484,9 @@

Scopes and Data Privacy

OAuth Scopes

Endpoint GET List feature collections
/gis/ogc/collections/{id}
`` +/gis/ogc/collections/{id}`` GET Collection metadata
/gis/ogc/collections/{id}/items
/gis/o +gc/collections/{id}/items GET Feature items (GeoJSON)
/gis/ogc/collections/{id}/items/{fid}
/gis/ogc/col +lections/{id}/items/{fid} GET Single feature
/gis/ogc/collections/{id}/qml
/gis +/ogc/collections/{id}/qml GET QGIS style file (extension)
-+-+ @@ -498,8 +502,9 @@

Scopes and Data Privacy

- +
Scope
gis:geofence Read + WriteCreate and archive geofences (also -requires gis:read for listing)Create and archive geofences +(also requires gis:read for +listing)
diff --git a/spp_api_v2_products/README.rst b/spp_api_v2_products/README.rst index c5e4dcde..6ea1d3f5 100644 --- a/spp_api_v2_products/README.rst +++ b/spp_api_v2_products/README.rst @@ -44,15 +44,15 @@ Key Models This module extends existing models rather than introducing new ones: -+--------------------------+-------------------------------------------+ -| Model | Extension | -+==========================+===========================================+ -| ``spp.api.client.scope`` | Adds "product" resource type for scope | -| | management | -+--------------------------+-------------------------------------------+ -| ``fastapi.endpoint`` | Registers Product, ProductCategory, UoM | -| | routers | -+--------------------------+-------------------------------------------+ ++--------------------------+------------------------------------------+ +| Model | Extension | ++==========================+==========================================+ +| ``spp.api.client.scope`` | Adds "product" resource type for scope | +| | management | ++--------------------------+------------------------------------------+ +| ``fastapi.endpoint`` | Registers Product, ProductCategory, UoM | +| | routers | ++--------------------------+------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_api_v2_service_points/README.rst b/spp_api_v2_service_points/README.rst index a9f66f3b..648289d3 100644 --- a/spp_api_v2_service_points/README.rst +++ b/spp_api_v2_service_points/README.rst @@ -45,15 +45,15 @@ Extended Models This module extends existing models from dependencies: -+--------------------------+-------------------------------------------+ -| Model | Description | -+==========================+===========================================+ -| ``spp.api.client.scope`` | Extended to add "service_point" resource | -| | type for OAuth scopes | -+--------------------------+-------------------------------------------+ -| ``fastapi.endpoint`` | Extended to register Service Point router | -| | in API V2 app | -+--------------------------+-------------------------------------------+ ++--------------------------+------------------------------------------+ +| Model | Description | ++==========================+==========================================+ +| ``spp.api.client.scope`` | Extended to add "service_point" resource | +| | type for OAuth scopes | ++--------------------------+------------------------------------------+ +| ``fastapi.endpoint`` | Extended to register Service Point | +| | router in API V2 app | ++--------------------------+------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_api_v2_service_points/static/description/index.html b/spp_api_v2_service_points/static/description/index.html index 20541256..0294cb47 100644 --- a/spp_api_v2_service_points/static/description/index.html +++ b/spp_api_v2_service_points/static/description/index.html @@ -407,8 +407,8 @@

Extended Models

type for OAuth scopes fastapi.endpoint -Extended to register Service Point router -in API V2 app +Extended to register Service Point +router in API V2 app diff --git a/spp_api_v2_vocabulary/README.rst b/spp_api_v2_vocabulary/README.rst index 7efddcaf..feef9058 100644 --- a/spp_api_v2_vocabulary/README.rst +++ b/spp_api_v2_vocabulary/README.rst @@ -45,20 +45,20 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------------+-------------------------------------------+ -| Model | Description | -+==========================+===========================================+ -| ``spp.vocabulary`` | Vocabulary definitions exposed via GET | -| | endpoints | -+--------------------------+-------------------------------------------+ -| ``spp.vocabulary.code`` | Individual codes within vocabularies | -+--------------------------+-------------------------------------------+ -| ``spp.api.client.scope`` | Extended to add "vocabulary" resource | -| | type for OAuth | -+--------------------------+-------------------------------------------+ -| ``fastapi.endpoint`` | Extended to register Vocabulary router in | -| | API V2 | -+--------------------------+-------------------------------------------+ ++--------------------------+------------------------------------------+ +| Model | Description | ++==========================+==========================================+ +| ``spp.vocabulary`` | Vocabulary definitions exposed via GET | +| | endpoints | ++--------------------------+------------------------------------------+ +| ``spp.vocabulary.code`` | Individual codes within vocabularies | ++--------------------------+------------------------------------------+ +| ``spp.api.client.scope`` | Extended to add "vocabulary" resource | +| | type for OAuth | ++--------------------------+------------------------------------------+ +| ``fastapi.endpoint`` | Extended to register Vocabulary router | +| | in API V2 | ++--------------------------+------------------------------------------+ API Endpoints ~~~~~~~~~~~~~ diff --git a/spp_api_v2_vocabulary/static/description/index.html b/spp_api_v2_vocabulary/static/description/index.html index 684f1b7d..23a7ad64 100644 --- a/spp_api_v2_vocabulary/static/description/index.html +++ b/spp_api_v2_vocabulary/static/description/index.html @@ -415,8 +415,8 @@

Key Models

type for OAuth fastapi.endpoint -Extended to register Vocabulary router in -API V2 +Extended to register Vocabulary router +in API V2 diff --git a/spp_approval/README.rst b/spp_approval/README.rst index 19fb5953..31a3f83f 100644 --- a/spp_approval/README.rst +++ b/spp_approval/README.rst @@ -51,30 +51,30 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------+---------------------------------------+ -| Model | Description | -+==============================+=======================================+ -| ``spp.approval.mixin`` | Abstract mixin providing approval | -| | workflow to inheriting models | -+------------------------------+---------------------------------------+ -| ``spp.approval.definition`` | Configures approval rules, approvers, | -| | and conditions per model | -+------------------------------+---------------------------------------+ -| ``spp.approval.tier`` | Individual tier in a multi-tier | -| | approval sequence | -+------------------------------+---------------------------------------+ -| ``spp.approval.review`` | Tracks individual approval/rejection | -| | actions | -+------------------------------+---------------------------------------+ -| ``spp.approval.tier.review`` | Tracks progress through multi-tier | -| | workflows | -+------------------------------+---------------------------------------+ -| ``spp.approval.freeze`` | Defines system-wide freeze periods | -| | blocking approvals | -+------------------------------+---------------------------------------+ -| ``spp.approval.config`` | System-wide approval configuration | -| | settings | -+------------------------------+---------------------------------------+ ++------------------------------+--------------------------------------+ +| Model | Description | ++==============================+======================================+ +| ``spp.approval.mixin`` | Abstract mixin providing approval | +| | workflow to inheriting models | ++------------------------------+--------------------------------------+ +| ``spp.approval.definition`` | Configures approval rules, | +| | approvers, and conditions per model | ++------------------------------+--------------------------------------+ +| ``spp.approval.tier`` | Individual tier in a multi-tier | +| | approval sequence | ++------------------------------+--------------------------------------+ +| ``spp.approval.review`` | Tracks individual approval/rejection | +| | actions | ++------------------------------+--------------------------------------+ +| ``spp.approval.tier.review`` | Tracks progress through multi-tier | +| | workflows | ++------------------------------+--------------------------------------+ +| ``spp.approval.freeze`` | Defines system-wide freeze periods | +| | blocking approvals | ++------------------------------+--------------------------------------+ +| ``spp.approval.config`` | System-wide approval configuration | +| | settings | ++------------------------------+--------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -112,20 +112,23 @@ On **Approval Definition** forms: Security ~~~~~~~~ -+------------------------------------------+----------------------------------+ -| Group | Access | -+==========================================+==================================+ -| ``spp_approval.group_approval_viewer`` | Read approval records | -+------------------------------------------+----------------------------------+ -| ``spp_approval.group_approval_officer`` | Read/Write/Create (no delete) | -+------------------------------------------+----------------------------------+ -| ``spp_approval.group_approval_manager`` | Read/Write/Create on all models | -| | (delete only for reviews/config; | -| | definitions and freezes require | -| | admin) | -+------------------------------------------+----------------------------------+ -| ``spp_approval.group_approval_approver`` | Approve/reject assigned reviews | -+------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_ | Read approval records | +| approval.group_approval_viewer`` | | ++----------------------------------+----------------------------------+ +| ``spp_a | Read/Write/Create (no delete) | +| pproval.group_approval_officer`` | | ++----------------------------------+----------------------------------+ +| ``spp_a | Read/Write/Create on all models | +| pproval.group_approval_manager`` | (delete only for reviews/config; | +| | definitions and freezes require | +| | admin) | ++----------------------------------+----------------------------------+ +| ``spp_ap | Approve/reject assigned reviews | +| proval.group_approval_approver`` | | ++----------------------------------+----------------------------------+ Note: ``approval_definition`` and ``approval_freeze`` models block deletion for managers via Python override - only system administrators diff --git a/spp_approval/static/description/index.html b/spp_approval/static/description/index.html index fca91d09..d595e836 100644 --- a/spp_approval/static/description/index.html +++ b/spp_approval/static/description/index.html @@ -400,8 +400,8 @@

Key Capabilities

Key Models

--++ @@ -414,8 +414,8 @@

Key Models

workflow to inheriting models - +
Model
spp.approval.definitionConfigures approval rules, approvers, -and conditions per modelConfigures approval rules, +approvers, and conditions per model
spp.approval.tier Individual tier in a multi-tier @@ -478,8 +478,8 @@

Tabs

Security

--++ @@ -487,19 +487,23 @@

Security

- + - + - + - + diff --git a/spp_area/README.rst b/spp_area/README.rst index 53f6c857..a5f81632 100644 --- a/spp_area/README.rst +++ b/spp_area/README.rst @@ -46,29 +46,29 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------------+----------------------------------+ -| Model | Description | -+=====================================+==================================+ -| ``spp.area`` | Hierarchical geographical area | -| | with code and name | -+-------------------------------------+----------------------------------+ -| ``spp.area.kind`` | Area type definition (country, | -| | province, district, etc.) | -+-------------------------------------+----------------------------------+ -| ``spp.area.tag`` | Classification tags for areas | -+-------------------------------------+----------------------------------+ -| ``spp.area.import`` | Excel import wizard with | -| | validation and bulk processing | -+-------------------------------------+----------------------------------+ -| ``spp.area.import.raw`` | Staging table for import | -| | validation | -+-------------------------------------+----------------------------------+ -| ``spp.area.import.json`` | Parsed JSON storage from Excel | -| | files | -+-------------------------------------+----------------------------------+ -| ``spp.area.import.language.wizard`` | Wizard for activating languages | -| | during import | -+-------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.area`` | Hierarchical geographical area | +| | with code and name | ++----------------------------------+----------------------------------+ +| ``spp.area.kind`` | Area type definition (country, | +| | province, district, etc.) | ++----------------------------------+----------------------------------+ +| ``spp.area.tag`` | Classification tags for areas | ++----------------------------------+----------------------------------+ +| ``spp.area.import`` | Excel import wizard with | +| | validation and bulk processing | ++----------------------------------+----------------------------------+ +| ``spp.area.import.raw`` | Staging table for import | +| | validation | ++----------------------------------+----------------------------------+ +| ``spp.area.import.json`` | Parsed JSON storage from Excel | +| | files | ++----------------------------------+----------------------------------+ +| ``s | Wizard for activating languages | +| pp.area.import.language.wizard`` | during import | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_area/static/description/index.html b/spp_area/static/description/index.html index 06d6fed3..5cd5d7ee 100644 --- a/spp_area/static/description/index.html +++ b/spp_area/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

Group
spp_approval.group_approval_viewer
spp_ +approval.group_approval_viewer Read approval records
spp_approval.group_approval_officer
spp_a +pproval.group_approval_officer Read/Write/Create (no delete)
spp_approval.group_approval_manager
spp_a +pproval.group_approval_manager Read/Write/Create on all models (delete only for reviews/config; definitions and freezes require admin)
spp_approval.group_approval_approver
spp_ap +proval.group_approval_approver Approve/reject assigned reviews
--++ @@ -427,7 +427,8 @@

Key Models

- + diff --git a/spp_area_hdx/README.rst b/spp_area_hdx/README.rst index 8efd2692..e86b7d9d 100644 --- a/spp_area_hdx/README.rst +++ b/spp_area_hdx/README.rst @@ -46,21 +46,21 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.hdx.cod.source`` | Tracks COD datasets available from | -| | HDX (one per country) | -+-------------------------------+--------------------------------------+ -| ``spp.hdx.cod.resource`` | Individual admin level dataset | -| | within a COD (e.g., Level 3) | -+-------------------------------+--------------------------------------+ -| ``spp.hdx.cod.import.wizard`` | Multi-step wizard to download from | -| | HDX or upload GeoJSON | -+-------------------------------+--------------------------------------+ -| ``spp.area`` (extended) | Adds ``hdx_pcode`` field and GPS | -| | lookup methods | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.hdx.cod.source`` | Tracks COD datasets available from | +| | HDX (one per country) | ++-------------------------------+-------------------------------------+ +| ``spp.hdx.cod.resource`` | Individual admin level dataset | +| | within a COD (e.g., Level 3) | ++-------------------------------+-------------------------------------+ +| ``spp.hdx.cod.import.wizard`` | Multi-step wizard to download from | +| | HDX or upload GeoJSON | ++-------------------------------+-------------------------------------+ +| ``spp.area`` (extended) | Adds ``hdx_pcode`` field and GPS | +| | lookup methods | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -87,14 +87,14 @@ UI Location Security ~~~~~~~~ -+-----------------------+----------------------------------------------+ -| Group | Access | -+=======================+==============================================+ -| ``group_hdx_user`` | Read access to COD sources and resources | -+-----------------------+----------------------------------------------+ -| ``group_hdx_manager`` | Full CRUD on sources/resources, sync from | -| | HDX, run imports | -+-----------------------+----------------------------------------------+ ++-----------------------+---------------------------------------------+ +| Group | Access | ++=======================+=============================================+ +| ``group_hdx_user`` | Read access to COD sources and resources | ++-----------------------+---------------------------------------------+ +| ``group_hdx_manager`` | Full CRUD on sources/resources, sync from | +| | HDX, run imports | ++-----------------------+---------------------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_audit/README.rst b/spp_audit/README.rst index b0de36ad..c19a2b5c 100644 --- a/spp_audit/README.rst +++ b/spp_audit/README.rst @@ -52,15 +52,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------+-------------------------------------------------+ -| Model | Description | -+====================+=================================================+ -| ``spp.audit.rule`` | Defines which models and operations to audit, | -| | with field filters | -+--------------------+-------------------------------------------------+ -| ``spp.audit.log`` | Database-stored audit entries with old/new | -| | value comparison | -+--------------------+-------------------------------------------------+ ++--------------------+------------------------------------------------+ +| Model | Description | ++====================+================================================+ +| ``spp.audit.rule`` | Defines which models and operations to audit, | +| | with field filters | ++--------------------+------------------------------------------------+ +| ``spp.audit.log`` | Database-stored audit entries with old/new | +| | value comparison | ++--------------------+------------------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -103,15 +103,15 @@ UI Location Security ~~~~~~~~ -+-----------------------------------+----------------------------------+ -| Group | Access | -+===================================+==================================+ -| ``spp_audit.group_audit_manager`` | Full CRUD on audit rules and | -| | logs | -+-----------------------------------+----------------------------------+ -| ``spp_security.group_spp_admin`` | Includes audit manager | -| | privileges (via imply) | -+-----------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ` | Full CRUD on audit rules and | +| `spp_audit.group_audit_manager`` | logs | ++----------------------------------+----------------------------------+ +| ``spp_security.group_spp_admin`` | Includes audit manager | +| | privileges (via imply) | ++----------------------------------+----------------------------------+ Audit logs cannot be deleted by default (``ALLOW_DELETE = False`` in code, despite ``perm_unlink=1`` in access rules). diff --git a/spp_audit/static/description/index.html b/spp_audit/static/description/index.html index 56bb0104..29283bde 100644 --- a/spp_audit/static/description/index.html +++ b/spp_audit/static/description/index.html @@ -464,8 +464,8 @@

UI Location

Security

Model Parsed JSON storage from Excel files
spp.area.import.language.wizard
s +pp.area.import.language.wizard Wizard for activating languages during import
--++ @@ -473,7 +473,8 @@

Security

- + diff --git a/spp_banking/README.rst b/spp_banking/README.rst index a16a04c4..dbe328c1 100644 --- a/spp_banking/README.rst +++ b/spp_banking/README.rst @@ -41,12 +41,11 @@ Key Capabilities Key Models ~~~~~~~~~~ -+----------------------+-----------------------------------------------+ -| Model | Description | -+======================+===============================================+ -| ``res.partner.bank`` | Bank account details with automatic IBAN | -| | computation | -+----------------------+-----------------------------------------------+ ++----------------------+------------------------------------------------------+ +| Model | Description | ++======================+======================================================+ +| ``res.partner.bank`` | Bank account details with automatic IBAN computation | ++----------------------+------------------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_banking/static/description/index.html b/spp_banking/static/description/index.html index 9fa29261..645bda63 100644 --- a/spp_banking/static/description/index.html +++ b/spp_banking/static/description/index.html @@ -390,8 +390,8 @@

Key Capabilities

Key Models

Group
spp_audit.group_audit_manager
` +spp_audit.group_audit_manager` Full CRUD on audit rules and logs
--++ @@ -400,8 +400,7 @@

Key Models

- +
Model
res.partner.bankBank account details with automatic IBAN -computationBank account details with automatic IBAN computation
diff --git a/spp_base_common/README.rst b/spp_base_common/README.rst index 85003af2..a253c7d2 100644 --- a/spp_base_common/README.rst +++ b/spp_base_common/README.rst @@ -44,12 +44,12 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------------+-------------------------------------------+ -| Model | Description | -+==========================+===========================================+ -| ``spp.phone.validation`` | Configurable phone validation rule | -| | (prefix, digits) | -+--------------------------+-------------------------------------------+ ++--------------------------+------------------------------------------+ +| Model | Description | ++==========================+==========================================+ +| ``spp.phone.validation`` | Configurable phone validation rule | +| | (prefix, digits) | ++--------------------------+------------------------------------------+ **Extensions:** diff --git a/spp_branding_kit/README.rst b/spp_branding_kit/README.rst index 4c61d197..987f7be8 100644 --- a/spp_branding_kit/README.rst +++ b/spp_branding_kit/README.rst @@ -51,21 +51,21 @@ Key Models This module does not introduce new models. It extends existing models: -+-------------------------+--------------------------------------------+ -| Model | Extension Purpose | -+=========================+============================================+ -| ``res.users`` | Custom email signature, removes Odoo | -| | account URL | -+-------------------------+--------------------------------------------+ -| ``res.config.settings`` | Adds branding and telemetry configuration | -| | fields | -+-------------------------+--------------------------------------------+ -| ``ir.http`` | Injects OpenSPP branding into web client | -| | session info | -+-------------------------+--------------------------------------------+ -| ``ir.module.module`` | Provides utility to count paid/proprietary | -| | apps | -+-------------------------+--------------------------------------------+ ++-------------------------+-------------------------------------------+ +| Model | Extension Purpose | ++=========================+===========================================+ +| ``res.users`` | Custom email signature, removes Odoo | +| | account URL | ++-------------------------+-------------------------------------------+ +| ``res.config.settings`` | Adds branding and telemetry configuration | +| | fields | ++-------------------------+-------------------------------------------+ +| ``ir.http`` | Injects OpenSPP branding into web client | +| | session info | ++-------------------------+-------------------------------------------+ +| ``ir.module.module`` | Provides utility to count | +| | paid/proprietary apps | ++-------------------------+-------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_case_base/README.rst b/spp_case_base/README.rst index 0dacf2ba..1411b475 100644 --- a/spp_case_base/README.rst +++ b/spp_case_base/README.rst @@ -45,42 +45,43 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------------------+-------------------------------------+ -| Model | Description | -+================================+=====================================+ -| ``spp.case`` | Core case record with client and | -| | assignment | -+--------------------------------+-------------------------------------+ -| ``spp.case.type`` | Case type with default intensity | -| | and caseload | -+--------------------------------+-------------------------------------+ -| ``spp.case.stage`` | Workflow stage with phase and | -| | requirements | -+--------------------------------+-------------------------------------+ -| ``spp.case.assessment`` | Assessment with risk score and | -| | findings | -+--------------------------------+-------------------------------------+ -| ``spp.case.intervention.plan`` | Versioned plan with approval | -| | workflow | -+--------------------------------+-------------------------------------+ -| ``spp.case.intervention`` | Individual intervention with status | -| | tracking | -+--------------------------------+-------------------------------------+ -| ``spp.case.visit`` | Client visit with type and notes | -+--------------------------------+-------------------------------------+ -| ``spp.case.note`` | Case note with confidentiality flag | -+--------------------------------+-------------------------------------+ -| ``spp.case.referral`` | External service referral with | -| | status | -+--------------------------------+-------------------------------------+ -| ``spp.case.team`` | Team with supervisor and members | -+--------------------------------+-------------------------------------+ -| ``spp.case.risk.factor`` | Risk factor with severity weight | -+--------------------------------+-------------------------------------+ -| ``spp.case.vulnerability`` | Vulnerability for assessment | -+--------------------------------+-------------------------------------+ -| ``spp.case.closure.reason`` | Closure reason with outcome type | -+--------------------------------+-------------------------------------+ ++--------------------------------+------------------------------------+ +| Model | Description | ++================================+====================================+ +| ``spp.case`` | Core case record with client and | +| | assignment | ++--------------------------------+------------------------------------+ +| ``spp.case.type`` | Case type with default intensity | +| | and caseload | ++--------------------------------+------------------------------------+ +| ``spp.case.stage`` | Workflow stage with phase and | +| | requirements | ++--------------------------------+------------------------------------+ +| ``spp.case.assessment`` | Assessment with risk score and | +| | findings | ++--------------------------------+------------------------------------+ +| ``spp.case.intervention.plan`` | Versioned plan with approval | +| | workflow | ++--------------------------------+------------------------------------+ +| ``spp.case.intervention`` | Individual intervention with | +| | status tracking | ++--------------------------------+------------------------------------+ +| ``spp.case.visit`` | Client visit with type and notes | ++--------------------------------+------------------------------------+ +| ``spp.case.note`` | Case note with confidentiality | +| | flag | ++--------------------------------+------------------------------------+ +| ``spp.case.referral`` | External service referral with | +| | status | ++--------------------------------+------------------------------------+ +| ``spp.case.team`` | Team with supervisor and members | ++--------------------------------+------------------------------------+ +| ``spp.case.risk.factor`` | Risk factor with severity weight | ++--------------------------------+------------------------------------+ +| ``spp.case.vulnerability`` | Vulnerability for assessment | ++--------------------------------+------------------------------------+ +| ``spp.case.closure.reason`` | Closure reason with outcome type | ++--------------------------------+------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_case_base/static/description/index.html b/spp_case_base/static/description/index.html index 135d3408..c5c2c385 100644 --- a/spp_case_base/static/description/index.html +++ b/spp_case_base/static/description/index.html @@ -394,8 +394,8 @@

Key Capabilities

Key Models

--++ @@ -424,14 +424,15 @@

Key Models

workflow - + - +
Model
spp.case.interventionIndividual intervention with status -trackingIndividual intervention with +status tracking
spp.case.visit Client visit with type and notes
spp.case.noteCase note with confidentiality flagCase note with confidentiality +flag
spp.case.referral External service referral with diff --git a/spp_case_cel/README.rst b/spp_case_cel/README.rst index 93baf8fb..a8ab0bff 100644 --- a/spp_case_cel/README.rst +++ b/spp_case_cel/README.rst @@ -44,18 +44,18 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------+---------------------------------------+ -| Model | Description | -+==============================+=======================================+ -| ``spp.case.triage.rule`` | CEL-based rule for automatic case | -| | categorization and risk tagging | -+------------------------------+---------------------------------------+ -| ``spp.case.assignment.rule`` | CEL-based rule for automatic case | -| | assignment with workload balancing | -+------------------------------+---------------------------------------+ -| ``spp.case`` | Extended to apply triage and | -| | assignment rules on creation | -+------------------------------+---------------------------------------+ ++------------------------------+--------------------------------------+ +| Model | Description | ++==============================+======================================+ +| ``spp.case.triage.rule`` | CEL-based rule for automatic case | +| | categorization and risk tagging | ++------------------------------+--------------------------------------+ +| ``spp.case.assignment.rule`` | CEL-based rule for automatic case | +| | assignment with workload balancing | ++------------------------------+--------------------------------------+ +| ``spp.case`` | Extended to apply triage and | +| | assignment rules on creation | ++------------------------------+--------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_case_cel/static/description/index.html b/spp_case_cel/static/description/index.html index 85416fbc..dff11d09 100644 --- a/spp_case_cel/static/description/index.html +++ b/spp_case_cel/static/description/index.html @@ -393,8 +393,8 @@

Key Capabilities

Key Models

--++ diff --git a/spp_case_demo/README.rst b/spp_case_demo/README.rst index af487498..59dbb391 100644 --- a/spp_case_demo/README.rst +++ b/spp_case_demo/README.rst @@ -50,15 +50,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-----------------------------+----------------------------------------+ -| Model | Description | -+=============================+========================================+ -| ``spp.case.demo.generator`` | Core logic for configuring and | -| | generating demo data | -+-----------------------------+----------------------------------------+ -| ``spp.case.demo.wizard`` | Wizard interface for demo data | -| | generation (inherits generator) | -+-----------------------------+----------------------------------------+ ++-----------------------------+---------------------------------------+ +| Model | Description | ++=============================+=======================================+ +| ``spp.case.demo.generator`` | Core logic for configuring and | +| | generating demo data | ++-----------------------------+---------------------------------------+ +| ``spp.case.demo.wizard`` | Wizard interface for demo data | +| | generation (inherits generator) | ++-----------------------------+---------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_case_demo/static/description/index.html b/spp_case_demo/static/description/index.html index b2131a12..dbb49c1a 100644 --- a/spp_case_demo/static/description/index.html +++ b/spp_case_demo/static/description/index.html @@ -399,8 +399,8 @@

Key Capabilities

Key Models

Model
--++ diff --git a/spp_case_entitlements/README.rst b/spp_case_entitlements/README.rst index 5fe10e1e..632bf7a1 100644 --- a/spp_case_entitlements/README.rst +++ b/spp_case_entitlements/README.rst @@ -42,12 +42,11 @@ Key Capabilities Extended Models ~~~~~~~~~~~~~~~ -+--------------+-------------------------------------------------------+ -| Model | Description | -+==============+=======================================================+ -| ``spp.case`` | Extended with entitlement relationships and computed | -| | metrics | -+--------------+-------------------------------------------------------+ ++--------------+--------------------------------------------------------------+ +| Model | Description | ++==============+==============================================================+ +| ``spp.case`` | Extended with entitlement relationships and computed metrics | ++--------------+--------------------------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_case_entitlements/static/description/index.html b/spp_case_entitlements/static/description/index.html index 963d26a6..c281957d 100644 --- a/spp_case_entitlements/static/description/index.html +++ b/spp_case_entitlements/static/description/index.html @@ -391,8 +391,8 @@

Key Capabilities

Extended Models

Model
--++ @@ -401,8 +401,7 @@

Extended Models

- +
Model
spp.caseExtended with entitlement relationships and computed -metricsExtended with entitlement relationships and computed metrics
diff --git a/spp_case_graduation/README.rst b/spp_case_graduation/README.rst index 38aa7503..dcd18414 100644 --- a/spp_case_graduation/README.rst +++ b/spp_case_graduation/README.rst @@ -42,14 +42,14 @@ Key Models This module extends existing models without introducing new ones: -+-------------------------------+--------------------------------------+ -| Model | Extension | -+===============================+======================================+ -| ``spp.case`` | Adds graduation assessment tracking | -| | and computed status fields | -+-------------------------------+--------------------------------------+ -| ``spp.graduation.assessment`` | Adds case linkage field | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Extension | ++===============================+=====================================+ +| ``spp.case`` | Adds graduation assessment tracking | +| | and computed status fields | ++-------------------------------+-------------------------------------+ +| ``spp.graduation.assessment`` | Adds case linkage field | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_case_graduation/static/description/index.html b/spp_case_graduation/static/description/index.html index 728b147a..05cd5c57 100644 --- a/spp_case_graduation/static/description/index.html +++ b/spp_case_graduation/static/description/index.html @@ -390,8 +390,8 @@

Key Models

This module extends existing models without introducing new ones:

--++ diff --git a/spp_case_programs/README.rst b/spp_case_programs/README.rst index 554552b5..324b08d9 100644 --- a/spp_case_programs/README.rst +++ b/spp_case_programs/README.rst @@ -46,13 +46,13 @@ Key Models This module extends existing models and does not introduce new ones. -+--------------+-------------------------------------------------------+ -| Model | Extension | -+==============+=======================================================+ -| ``spp.case`` | Adds ``program_membership_ids``, | -| | ``triggered_by_program_id``, and computed enrollment | -| | fields | -+--------------+-------------------------------------------------------+ ++--------------+------------------------------------------------------+ +| Model | Extension | ++==============+======================================================+ +| ``spp.case`` | Adds ``program_membership_ids``, | +| | ``triggered_by_program_id``, and computed enrollment | +| | fields | ++--------------+------------------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_case_programs/static/description/index.html b/spp_case_programs/static/description/index.html index a6bcf4f5..f6d4a698 100644 --- a/spp_case_programs/static/description/index.html +++ b/spp_case_programs/static/description/index.html @@ -394,8 +394,8 @@

Key Models

This module extends existing models and does not introduce new ones.

Model
--++ diff --git a/spp_case_registry/README.rst b/spp_case_registry/README.rst index c8902d47..a9be19b8 100644 --- a/spp_case_registry/README.rst +++ b/spp_case_registry/README.rst @@ -43,15 +43,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-----------------+----------------------------------------------------+ -| Model | Description | -+=================+====================================================+ -| ``spp.case`` | Extended with registrant_id, household_id, | -| | area_id, and previous case detection | -+-----------------+----------------------------------------------------+ -| ``res.partner`` | Extended with case counts and relationships to | -| | cases as registrant or household | -+-----------------+----------------------------------------------------+ ++-----------------+---------------------------------------------------+ +| Model | Description | ++=================+===================================================+ +| ``spp.case`` | Extended with registrant_id, household_id, | +| | area_id, and previous case detection | ++-----------------+---------------------------------------------------+ +| ``res.partner`` | Extended with case counts and relationships to | +| | cases as registrant or household | ++-----------------+---------------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_cel_domain/README.rst b/spp_cel_domain/README.rst index f9ce7aa3..5b48bfd0 100644 --- a/spp_cel_domain/README.rst +++ b/spp_cel_domain/README.rst @@ -48,32 +48,34 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.cel.variable`` | Variable definitions with source | -| | type, CEL accessor, and caching | -+-------------------------------+--------------------------------------+ -| ``spp.cel.variable.category`` | Variable categories for organization | -+-------------------------------+--------------------------------------+ -| ``spp.cel.expression`` | Business rule expressions with CEL | -| | syntax and variable tracking | -+-------------------------------+--------------------------------------+ -| ``spp.data.provider`` | External data provider configuration | -| | with auth and connection settings | -+-------------------------------+--------------------------------------+ -| ``spp.data.credential`` | Secure encrypted credential storage | -| | for external providers | -+-------------------------------+--------------------------------------+ -| ``spp.data.value`` | Cached variable values with period | -| | keys and expiration tracking | -+-------------------------------+--------------------------------------+ -| ``spp.cel.service`` | Service facade for compiling and | -| | evaluating CEL expressions | -+-------------------------------+--------------------------------------+ -| ``spp.cel.variable.resolver`` | Resolves variable references into | -| | expanded CEL expressions | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.cel.variable`` | Variable definitions with source | +| | type, CEL accessor, and caching | ++-------------------------------+-------------------------------------+ +| ``spp.cel.variable.category`` | Variable categories for | +| | organization | ++-------------------------------+-------------------------------------+ +| ``spp.cel.expression`` | Business rule expressions with CEL | +| | syntax and variable tracking | ++-------------------------------+-------------------------------------+ +| ``spp.data.provider`` | External data provider | +| | configuration with auth and | +| | connection settings | ++-------------------------------+-------------------------------------+ +| ``spp.data.credential`` | Secure encrypted credential storage | +| | for external providers | ++-------------------------------+-------------------------------------+ +| ``spp.data.value`` | Cached variable values with period | +| | keys and expiration tracking | ++-------------------------------+-------------------------------------+ +| ``spp.cel.service`` | Service facade for compiling and | +| | evaluating CEL expressions | ++-------------------------------+-------------------------------------+ +| ``spp.cel.variable.resolver`` | Resolves variable references into | +| | expanded CEL expressions | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -103,19 +105,19 @@ UI Location Security ~~~~~~~~ -+---------------------------------------------+----------------------------------+ -| Group | Access | -+=============================================+==================================+ -| ``spp_cel_domain.group_cel_domain_viewer`` | Read variables, expressions, and | -| | data cache | -+---------------------------------------------+----------------------------------+ -| ``spp_cel_domain.group_cel_domain_manager`` | Full CRUD on variables, | -| | expressions, providers, and | -| | cache | -+---------------------------------------------+----------------------------------+ -| ``spp_cel_domain.group_cel_domain_admin`` | Full CRUD on credentials and | -| | sensitive configs | -+---------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_cel_ | Read variables, expressions, and | +| domain.group_cel_domain_viewer`` | data cache | ++----------------------------------+----------------------------------+ +| ``spp_cel_d | Full CRUD on variables, | +| omain.group_cel_domain_manager`` | expressions, providers, and | +| | cache | ++----------------------------------+----------------------------------+ +| ``spp_cel | Full CRUD on credentials and | +| _domain.group_cel_domain_admin`` | sensitive configs | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_cel_domain/static/description/index.html b/spp_cel_domain/static/description/index.html index 7f31d741..6b64b8ac 100644 --- a/spp_cel_domain/static/description/index.html +++ b/spp_cel_domain/static/description/index.html @@ -397,8 +397,8 @@

Key Capabilities

Key Models

Model
--++ @@ -411,15 +411,17 @@

Key Models

type, CEL accessor, and caching - + - +
Model
spp.cel.variable.categoryVariable categories for organizationVariable categories for +organization
spp.cel.expression Business rule expressions with CEL syntax and variable tracking
spp.data.providerExternal data provider configuration -with auth and connection settingsExternal data provider +configuration with auth and +connection settings
spp.data.credential Secure encrypted credential storage @@ -470,8 +472,8 @@

UI Location

Security

--++ @@ -479,16 +481,19 @@

Security

- + - + - + diff --git a/spp_cel_registry_search/README.rst b/spp_cel_registry_search/README.rst index 29ad63d2..0e877d6b 100644 --- a/spp_cel_registry_search/README.rst +++ b/spp_cel_registry_search/README.rst @@ -66,14 +66,15 @@ UI Location Security ~~~~~~~~ -+---------------------------------------------------+----------------------------------+ -| Group | Access | -+===================================================+==================================+ -| ``spp_cel_registry_search.group_cel_search_user`` | Access to Advanced Search portal | -+---------------------------------------------------+----------------------------------+ -| ``spp_registry.group_registry_officer`` | Automatically includes CEL | -| | Search access | -+---------------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_cel_registr | Access to Advanced Search portal | +| y_search.group_cel_search_user`` | | ++----------------------------------+----------------------------------+ +| ``spp_r | Automatically includes CEL | +| egistry.group_registry_officer`` | Search access | ++----------------------------------+----------------------------------+ The ``group_cel_search_user`` group implies ``spp_registry.group_registry_viewer``, ensuring users can only search diff --git a/spp_cel_registry_search/static/description/index.html b/spp_cel_registry_search/static/description/index.html index 900c4765..40c0cb97 100644 --- a/spp_cel_registry_search/static/description/index.html +++ b/spp_cel_registry_search/static/description/index.html @@ -414,8 +414,8 @@

UI Location

Security

Group
spp_cel_domain.group_cel_domain_viewer
spp_cel_ +domain.group_cel_domain_viewer Read variables, expressions, and data cache
spp_cel_domain.group_cel_domain_manager
spp_cel_d +omain.group_cel_domain_manager Full CRUD on variables, expressions, providers, and cache
spp_cel_domain.group_cel_domain_admin
spp_cel +_domain.group_cel_domain_admin Full CRUD on credentials and sensitive configs
--++ @@ -423,10 +423,12 @@

Security

- + - + diff --git a/spp_cel_widget/README.rst b/spp_cel_widget/README.rst index a8a48469..8abc9a4f 100644 --- a/spp_cel_widget/README.rst +++ b/spp_cel_widget/README.rst @@ -47,16 +47,16 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-----------------------------+----------------------------------------+ -| Model | Description | -+=============================+========================================+ -| ``spp.cel.symbol.provider`` | Abstract model that extracts symbols | -| | for autocompletion and validates | -| | expressions | -+-----------------------------+----------------------------------------+ -| ``spp.cel.widget.demo`` | Transient wizard for testing the | -| | widget (debug mode only) | -+-----------------------------+----------------------------------------+ ++-----------------------------+---------------------------------------+ +| Model | Description | ++=============================+=======================================+ +| ``spp.cel.symbol.provider`` | Abstract model that extracts symbols | +| | for autocompletion and validates | +| | expressions | ++-----------------------------+---------------------------------------+ +| ``spp.cel.widget.demo`` | Transient wizard for testing the | +| | widget (debug mode only) | ++-----------------------------+---------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -102,19 +102,20 @@ Tabs in Demo Wizard Security ~~~~~~~~ -+--------------------+-------------------------+------------------------+ -| Group | Model | Access | -+====================+=========================+========================+ -| Internal User | HTTP endpoints | Can call widget | -| | | JSONRPC endpoints | -| | | (auth="user") | -+--------------------+-------------------------+------------------------+ -| Settings | ``spp.cel.widget.demo`` | Full CRUD (read, | -| | | write, create, delete) | -+--------------------+-------------------------+------------------------+ -| Technical Features | Menu visibility | Can see demo menu in | -| | | Settings > Technical | -+--------------------+-------------------------+------------------------+ ++--------------------+-----------------------+-----------------------+ +| Group | Model | Access | ++====================+=======================+=======================+ +| Internal User | HTTP endpoints | Can call widget | +| | | JSONRPC endpoints | +| | | (auth="user") | ++--------------------+-----------------------+-----------------------+ +| Settings | `` | Full CRUD (read, | +| | spp.cel.widget.demo`` | write, create, | +| | | delete) | ++--------------------+-----------------------+-----------------------+ +| Technical Features | Menu visibility | Can see demo menu in | +| | | Settings > Technical | ++--------------------+-----------------------+-----------------------+ HTTP Endpoints ~~~~~~~~~~~~~~ diff --git a/spp_cel_widget/static/description/index.html b/spp_cel_widget/static/description/index.html index f1f236d9..312b532e 100644 --- a/spp_cel_widget/static/description/index.html +++ b/spp_cel_widget/static/description/index.html @@ -396,8 +396,8 @@

Key Capabilities

Key Models

Group
spp_cel_registry_search.group_cel_search_user
spp_cel_registr +y_search.group_cel_search_user Access to Advanced Search portal
spp_registry.group_registry_officer
spp_r +egistry.group_registry_officer Automatically includes CEL Search access
--++ @@ -462,8 +462,8 @@

Tabs in Demo Wizard

Security

Model
--++ @@ -480,9 +480,11 @@

Security

(auth=”user”) - + +write, create, +delete) diff --git a/spp_change_request_v2/README.rst b/spp_change_request_v2/README.rst index 8f2a4a5f..26688d87 100644 --- a/spp_change_request_v2/README.rst +++ b/spp_change_request_v2/README.rst @@ -50,63 +50,63 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------------+----------------------------------+ -| Model | Description | -+=====================================+==================================+ -| ``spp.change.request`` | Main change request record with | -| | approval workflow | -+-------------------------------------+----------------------------------+ -| ``spp.change.request.type`` | Configuration for CR types: | -| | target, detail model, workflow | -+-------------------------------------+----------------------------------+ -| ``spp.change.request.type.mapping`` | Field mappings for automatic | -| | application | -+-------------------------------------+----------------------------------+ -| ``spp.cr.conflict.rule`` | Rules for detecting conflicting | -| | change requests | -+-------------------------------------+----------------------------------+ -| ``spp.cr.duplicate.config`` | Configuration for duplicate | -| | detection thresholds | -+-------------------------------------+----------------------------------+ -| ``spp.cr.conflict.mixin`` | Mixin providing conflict and | -| | duplicate detection | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.base`` | Base model for all change | -| | request detail types | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.add_member`` | Detail model for adding members | -| | to groups | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.edit_individual`` | Detail model for editing | -| | individual registrant data | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.edit_group`` | Detail model for editing | -| | group/household data | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.remove_member`` | Detail model for removing | -| | members from groups | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.change_hoh`` | Detail model for changing head | -| | of household | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.exit_registrant`` | Detail model for marking | -| | registrants as exited | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.transfer_member`` | Detail model for transferring | -| | members between groups | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.update_id`` | Detail model for updating | -| | registrant ID numbers | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.create_group`` | Detail model for creating new | -| | groups/households | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.merge_registrants`` | Detail model for merging | -| | duplicate registrant records | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.split_household`` | Detail model for splitting | -| | households into separate groups | -+-------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.change.request`` | Main change request record with | +| | approval workflow | ++----------------------------------+----------------------------------+ +| ``spp.change.request.type`` | Configuration for CR types: | +| | target, detail model, workflow | ++----------------------------------+----------------------------------+ +| ``s | Field mappings for automatic | +| pp.change.request.type.mapping`` | application | ++----------------------------------+----------------------------------+ +| ``spp.cr.conflict.rule`` | Rules for detecting conflicting | +| | change requests | ++----------------------------------+----------------------------------+ +| ``spp.cr.duplicate.config`` | Configuration for duplicate | +| | detection thresholds | ++----------------------------------+----------------------------------+ +| ``spp.cr.conflict.mixin`` | Mixin providing conflict and | +| | duplicate detection | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.base`` | Base model for all change | +| | request detail types | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.add_member`` | Detail model for adding members | +| | to groups | ++----------------------------------+----------------------------------+ +| ` | Detail model for editing | +| `spp.cr.detail.edit_individual`` | individual registrant data | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.edit_group`` | Detail model for editing | +| | group/household data | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.remove_member`` | Detail model for removing | +| | members from groups | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.change_hoh`` | Detail model for changing head | +| | of household | ++----------------------------------+----------------------------------+ +| ` | Detail model for marking | +| `spp.cr.detail.exit_registrant`` | registrants as exited | ++----------------------------------+----------------------------------+ +| ` | Detail model for transferring | +| `spp.cr.detail.transfer_member`` | members between groups | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.update_id`` | Detail model for updating | +| | registrant ID numbers | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.create_group`` | Detail model for creating new | +| | groups/households | ++----------------------------------+----------------------------------+ +| ``s | Detail model for merging | +| pp.cr.detail.merge_registrants`` | duplicate registrant records | ++----------------------------------+----------------------------------+ +| ` | Detail model for splitting | +| `spp.cr.detail.split_household`` | households into separate groups | ++----------------------------------+----------------------------------+ Form Tabs ~~~~~~~~~ @@ -161,25 +161,25 @@ UI Location Security ~~~~~~~~ -+------------------------------------------------------+----------------------------------+ -| Group | Access | -+======================================================+==================================+ -| ``spp_change_request_v2.group_cr_user`` | Create and submit change | -| | requests (read/write/create) | -+------------------------------------------------------+----------------------------------+ -| ``spp_change_request_v2.group_cr_validator`` | Approve/reject, field-level | -| | validation (read/write/create) | -+------------------------------------------------------+----------------------------------+ -| ``spp_change_request_v2.group_cr_validator_hq`` | HQ-level approval with registry | -| | write (read/write/create) | -+------------------------------------------------------+----------------------------------+ -| ``spp_change_request_v2.group_cr_manager`` | Full CRUD including | -| | configuration | -+------------------------------------------------------+----------------------------------+ -| ``spp_change_request_v2.group_cr_conflict_approver`` | Override blocking conflict | -| | detections | -| | (specialized/functional) | -+------------------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_c | Create and submit change | +| hange_request_v2.group_cr_user`` | requests (read/write/create) | ++----------------------------------+----------------------------------+ +| ``spp_change | Approve/reject, field-level | +| _request_v2.group_cr_validator`` | validation (read/write/create) | ++----------------------------------+----------------------------------+ +| ``spp_change_re | HQ-level approval with registry | +| quest_v2.group_cr_validator_hq`` | write (read/write/create) | ++----------------------------------+----------------------------------+ +| ``spp_chan | Full CRUD including | +| ge_request_v2.group_cr_manager`` | configuration | ++----------------------------------+----------------------------------+ +| ``spp_change_request | Override blocking conflict | +| _v2.group_cr_conflict_approver`` | detections | +| | (specialized/functional) | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ @@ -221,20 +221,20 @@ multi-tier workflows. A CR type consists of four parts: -+----------------------+-----------------------------------------------+ -| Part | What it does | -+======================+===============================================+ -| **Detail model** | Python model holding the proposed changes | -| | (inherits ``spp.cr.detail.base``) | -+----------------------+-----------------------------------------------+ -| **Detail form view** | XML view rendered inside the CR form | -+----------------------+-----------------------------------------------+ -| **CR type record** | XML data linking the detail model, view, | -| | approval workflow, and field mappings | -+----------------------+-----------------------------------------------+ -| **Field mappings** | XML records defining how detail fields map to | -| | registrant fields at apply time | -+----------------------+-----------------------------------------------+ ++----------------------+----------------------------------------------+ +| Part | What it does | ++======================+==============================================+ +| **Detail model** | Python model holding the proposed changes | +| | (inherits ``spp.cr.detail.base``) | ++----------------------+----------------------------------------------+ +| **Detail form view** | XML view rendered inside the CR form | ++----------------------+----------------------------------------------+ +| **CR type record** | XML data linking the detail model, view, | +| | approval workflow, and field mappings | ++----------------------+----------------------------------------------+ +| **Field mappings** | XML records defining how detail fields map | +| | to registrant fields at apply time | ++----------------------+----------------------------------------------+ When a user creates a change request, the system: @@ -622,26 +622,26 @@ fallback. CEL conditions have access to these variables: -+--------------------------------+--------+------------------------------+ -| Variable | Type | Description | -+================================+========+==============================+ -| ``record.selected_field_name`` | string | Technical field name the | -| | | user selected | -+--------------------------------+--------+------------------------------+ -| ``old_value`` | typed | Current value on the | -| | | registrant | -+--------------------------------+--------+------------------------------+ -| ``new_value`` | typed | Proposed value from the | -| | | detail record | -+--------------------------------+--------+------------------------------+ -| ``record`` | dict | All fields on the | -| | | ``spp.change.request`` | -| | | record | -+--------------------------------+--------+------------------------------+ -| ``user`` | dict | Current user | -+--------------------------------+--------+------------------------------+ -| ``company`` | dict | Current company | -+--------------------------------+--------+------------------------------+ ++-----------------------------+--------+-----------------------------+ +| Variable | Type | Description | ++=============================+========+=============================+ +| ``r | string | Technical field name the | +| ecord.selected_field_name`` | | user selected | ++-----------------------------+--------+-----------------------------+ +| ``old_value`` | typed | Current value on the | +| | | registrant | ++-----------------------------+--------+-----------------------------+ +| ``new_value`` | typed | Proposed value from the | +| | | detail record | ++-----------------------------+--------+-----------------------------+ +| ``record`` | dict | All fields on the | +| | | ``spp.change.request`` | +| | | record | ++-----------------------------+--------+-----------------------------+ +| ``user`` | dict | Current user | ++-----------------------------+--------+-----------------------------+ +| ``company`` | dict | Current company | ++-----------------------------+--------+-----------------------------+ Many2one values are dicts with ``id`` and ``name`` (display_name) keys. Vocabulary models (``spp.vocabulary.code``) additionally include @@ -728,101 +728,120 @@ Methods Reference Methods available for override on detail models (all inherited from ``spp.cr.detail.base``): -+--------------------------------------+----------------+--------------------------------------+-----------------+ -| Method | Decorator | Returns | When to | -| | | | override | -+======================================+================+======================================+=================+ -| ``_get_field_to_modify_selection()`` | ``@api.model`` | ``[(field, label), ...]`` | Dynamic | -| | | | approval: | -| | | | define | -| | | | selectable | -| | | | fields | -+--------------------------------------+----------------+--------------------------------------+-----------------+ -| ``_get_prefill_mapping()`` | instance | ``{detail_field: registrant_field}`` | Pre-fill detail | -| | | | from registrant | -| | | | on creation | -+--------------------------------------+----------------+--------------------------------------+-----------------+ -| ``prefill_from_registrant()`` | instance | None | Detail has | -| | | | boolean fields | -| | | | that need | -| | | | ``False`` | -| | | | pre-filled | -+--------------------------------------+----------------+--------------------------------------+-----------------+ ++----------------+----------------+----------------+----------------+ +| Method | Decorator | Returns | When to | +| | | | override | ++================+================+================+================+ +| ``_get_f | ``@api.model`` | ``[(field, | Dynamic | +| ield_to_modify | | label), ...]`` | approval: | +| _selection()`` | | | define | +| | | | selectable | +| | | | fields | ++----------------+----------------+----------------+----------------+ +| ``_get_prefi | instance | ``{detai | Pre-fill | +| ll_mapping()`` | | l_field: regis | detail from | +| | | trant_field}`` | registrant on | +| | | | creation | ++----------------+----------------+----------------+----------------+ +| ` | instance | None | Detail has | +| `prefill_from_ | | | boolean fields | +| registrant()`` | | | that need | +| | | | ``False`` | +| | | | pre-filled | ++----------------+----------------+----------------+----------------+ Related fields available on all detail models (from ``spp.cr.detail.base``): -+----------------------------+-----------+------------------------------------------------------------+ -| Field | Type | Source | -+============================+===========+============================================================+ -| ``change_request_id`` | Many2one | Direct link to parent CR | -+----------------------------+-----------+------------------------------------------------------------+ -| ``registrant_id`` | Many2one | ``change_request_id.registrant_id`` | -+----------------------------+-----------+------------------------------------------------------------+ -| ``approval_state`` | Selection | ``change_request_id.approval_state`` | -+----------------------------+-----------+------------------------------------------------------------+ -| ``is_applied`` | Boolean | ``change_request_id.is_applied`` | -+----------------------------+-----------+------------------------------------------------------------+ -| ``use_dynamic_approval`` | Boolean | ``change_request_id.request_type_id.use_dynamic_approval`` | -+----------------------------+-----------+------------------------------------------------------------+ -| ``field_to_modify`` | Selection | Dynamic field selector (populated by | -| | | ``_get_field_to_modify_selection``) | -+----------------------------+-----------+------------------------------------------------------------+ ++--------------------------+-----------+---------------------------+ +| Field | Type | Source | ++==========================+===========+===========================+ +| ``change_request_id`` | Many2one | Direct link to parent CR | ++--------------------------+-----------+---------------------------+ +| ``registrant_id`` | Many2one | ``change_r | +| | | equest_id.registrant_id`` | ++--------------------------+-----------+---------------------------+ +| ``approval_state`` | Selection | ``change_re | +| | | quest_id.approval_state`` | ++--------------------------+-----------+---------------------------+ +| ``is_applied`` | Boolean | ``chang | +| | | e_request_id.is_applied`` | ++--------------------------+-----------+---------------------------+ +| ``use_dynamic_approval`` | Boolean | ``change | +| | | _request_id.request_type_ | +| | | id.use_dynamic_approval`` | ++--------------------------+-----------+---------------------------+ +| ``field_to_modify`` | Selection | Dynamic field selector | +| | | (populated by | +| | | ``_get_fie | +| | | ld_to_modify_selection``) | ++--------------------------+-----------+---------------------------+ CR Type Fields Reference ~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------+-----------+---------------------+----------------------+ -| Field | Type | Default | Description | -+==============================+===========+=====================+======================+ -| ``name`` | Char | required | Display name | -+------------------------------+-----------+---------------------+----------------------+ -| ``code`` | Char | required | Unique identifier | -| | | | (lowercase, | -| | | | underscores) | -+------------------------------+-----------+---------------------+----------------------+ -| ``target_type`` | Selection | ``"both"`` | ``"individual"``, | -| | | | ``"group"``, or | -| | | | ``"both"`` | -+------------------------------+-----------+---------------------+----------------------+ -| ``detail_model`` | Char | required | Technical name of | -| | | | the detail model | -+------------------------------+-----------+---------------------+----------------------+ -| ``detail_form_view_id`` | Many2one | required | Reference to the | -| | | | detail form view | -+------------------------------+-----------+---------------------+----------------------+ -| ``apply_strategy`` | Selection | ``"field_mapping"`` | ``"field_mapping"``, | -| | | | ``"custom"``, or | -| | | | ``"manual"`` | -+------------------------------+-----------+---------------------+----------------------+ -| ``auto_apply_on_approve`` | Boolean | ``True`` | Apply changes | -| | | | automatically after | -| | | | final approval | -+------------------------------+-----------+---------------------+----------------------+ -| ``approval_definition_id`` | Many2one | required | Static/fallback | -| | | | approval workflow | -+------------------------------+-----------+---------------------+----------------------+ -| ``use_dynamic_approval`` | Boolean | ``False`` | Enable field-level | -| | | | approval routing | -+------------------------------+-----------+---------------------+----------------------+ -| ``candidate_definition_ids`` | Many2many | empty | Candidate | -| | | | definitions for | -| | | | dynamic routing | -+------------------------------+-----------+---------------------+----------------------+ -| ``icon`` | Char | optional | FontAwesome icon | -| | | | class (e.g., | -| | | | ``"fa-cog"``) | -+------------------------------+-----------+---------------------+----------------------+ -| ``sequence`` | Integer | ``10`` | Display order in | -| | | | type lists | -+------------------------------+-----------+---------------------+----------------------+ -| ``is_system_type`` | Boolean | ``False`` | Installed by a | -| | | | module (not | -| | | | user-created) | -+------------------------------+-----------+---------------------+----------------------+ -| ``source_module`` | Char | optional | Module that | -| | | | installed this type | -+------------------------------+-----------+---------------------+----------------------+ ++-----------------+-----------+-----------------+-----------------+ +| Field | Type | Default | Description | ++=================+===========+=================+=================+ +| ``name`` | Char | required | Display name | ++-----------------+-----------+-----------------+-----------------+ +| ``code`` | Char | required | Unique | +| | | | identifier | +| | | | (lowercase, | +| | | | underscores) | ++-----------------+-----------+-----------------+-----------------+ +| ``target_type`` | Selection | ``"both"`` | `` | +| | | | "individual"``, | +| | | | ``"group"``, or | +| | | | ``"both"`` | ++-----------------+-----------+-----------------+-----------------+ +| ` | Char | required | Technical name | +| `detail_model`` | | | of the detail | +| | | | model | ++-----------------+-----------+-----------------+-----------------+ +| ``detail | Many2one | required | Reference to | +| _form_view_id`` | | | the detail form | +| | | | view | ++-----------------+-----------+-----------------+-----------------+ +| ``a | Selection | ``"f | ``"fi | +| pply_strategy`` | | ield_mapping"`` | eld_mapping"``, | +| | | | ``"custom"``, | +| | | | or ``"manual"`` | ++-----------------+-----------+-----------------+-----------------+ +| ``auto_app | Boolean | ``True`` | Apply changes | +| ly_on_approve`` | | | automatically | +| | | | after final | +| | | | approval | ++-----------------+-----------+-----------------+-----------------+ +| ``approval_ | Many2one | required | Static/fallback | +| definition_id`` | | | approval | +| | | | workflow | ++-----------------+-----------+-----------------+-----------------+ +| ``use_dyn | Boolean | ``False`` | Enable | +| amic_approval`` | | | field-level | +| | | | approval | +| | | | routing | ++-----------------+-----------+-----------------+-----------------+ +| ``candidate_d | Many2many | empty | Candidate | +| efinition_ids`` | | | definitions for | +| | | | dynamic routing | ++-----------------+-----------+-----------------+-----------------+ +| ``icon`` | Char | optional | FontAwesome | +| | | | icon class | +| | | | (e.g., | +| | | | ``"fa-cog"``) | ++-----------------+-----------+-----------------+-----------------+ +| ``sequence`` | Integer | ``10`` | Display order | +| | | | in type lists | ++-----------------+-----------+-----------------+-----------------+ +| ``i | Boolean | ``False`` | Installed by a | +| s_system_type`` | | | module (not | +| | | | user-created) | ++-----------------+-----------+-----------------+-----------------+ +| `` | Char | optional | Module that | +| source_module`` | | | installed this | +| | | | type | ++-----------------+-----------+-----------------+-----------------+ Checklist ~~~~~~~~~ diff --git a/spp_change_request_v2/static/description/index.html b/spp_change_request_v2/static/description/index.html index 0ef9486d..31cbce91 100644 --- a/spp_change_request_v2/static/description/index.html +++ b/spp_change_request_v2/static/description/index.html @@ -399,8 +399,8 @@

Key Capabilities

Key Models

Settingsspp.cel.widget.demo`` +spp.cel.widget.demo`` Full CRUD (read, -write, create, delete)
Technical Features Menu visibility
--++ @@ -416,7 +416,8 @@

Key Models

- + @@ -440,7 +441,8 @@

Key Models

- + @@ -456,11 +458,13 @@

Key Models

- + - + @@ -472,11 +476,13 @@

Key Models

- + - + @@ -538,8 +544,8 @@

UI Location

Security

Model Configuration for CR types: target, detail model, workflow
spp.change.request.type.mapping
s +pp.change.request.type.mapping Field mappings for automatic application
Detail model for adding members to groups
spp.cr.detail.edit_individual
` +spp.cr.detail.edit_individual` Detail model for editing individual registrant data
Detail model for changing head of household
spp.cr.detail.exit_registrant
` +spp.cr.detail.exit_registrant` Detail model for marking registrants as exited
spp.cr.detail.transfer_member
` +spp.cr.detail.transfer_member` Detail model for transferring members between groups
Detail model for creating new groups/households
spp.cr.detail.merge_registrants
s +pp.cr.detail.merge_registrants Detail model for merging duplicate registrant records
spp.cr.detail.split_household
` +spp.cr.detail.split_household` Detail model for splitting households into separate groups
--++ @@ -547,23 +553,28 @@

Security

- + - + - + - + - + @@ -631,8 +642,8 @@

Developer Guide: Creating Custom CR Types

approval workflow, and field mappings - +
Group
spp_change_request_v2.group_cr_user
spp_c +hange_request_v2.group_cr_user Create and submit change requests (read/write/create)
spp_change_request_v2.group_cr_validator
spp_change +_request_v2.group_cr_validator Approve/reject, field-level validation (read/write/create)
spp_change_request_v2.group_cr_validator_hq
spp_change_re +quest_v2.group_cr_validator_hq HQ-level approval with registry write (read/write/create)
spp_change_request_v2.group_cr_manager
spp_chan +ge_request_v2.group_cr_manager Full CRUD including configuration
spp_change_request_v2.group_cr_conflict_approver
spp_change_request +_v2.group_cr_conflict_approver Override blocking conflict detections (specialized/functional)
Field mappingsXML records defining how detail fields map to -registrant fields at apply timeXML records defining how detail fields map +to registrant fields at apply time
@@ -993,9 +1004,9 @@

Example 3: Dynamic Approval

CEL conditions have access to these variables:

---+++ @@ -1004,7 +1015,8 @@

Example 3: Dynamic Approval

- + @@ -1115,10 +1127,10 @@

Methods Reference

spp.cr.detail.base):

Variable
record.selected_field_name
r +ecord.selected_field_name string Technical field name the user selected
----++++ @@ -1129,23 +1141,32 @@

Methods Reference

- + - + - + - - + + - +
Method
_get_field_to_modify_selection()
_get_f +ield_to_modify +_selection() @api.model[(field, label), ...][(field, +label), ...] Dynamic approval: define selectable fields
_get_prefill_mapping()
_get_prefi +ll_mapping() instance{detail_field: registrant_field}Pre-fill detail -from registrant -on creation{detai +l_field: regis +trant_field}Pre-fill +detail from +registrant on +creation
prefill_from_registrant()
` +prefill_from_ +registrant()` instance None Detail has @@ -1160,9 +1181,9 @@

Methods Reference

spp.cr.detail.base):

---+++ @@ -1177,24 +1198,31 @@

Methods Reference

- + - + - + - + - +
Field
registrant_id Many2onechange_request_id.registrant_idchange_r +equest_id.registrant_id
approval_state Selectionchange_request_id.approval_statechange_re +quest_id.approval_state
is_applied Booleanchange_request_id.is_appliedchang +e_request_id.is_applied
use_dynamic_approval Booleanchange_request_id.request_type_id.use_dynamic_approvalchange +_request_id.request_type_ +id.use_dynamic_approval
field_to_modify SelectionDynamic field selector (populated by -_get_field_to_modify_selection)Dynamic field selector +(populated by +_get_fie +ld_to_modify_selection)
@@ -1203,10 +1231,10 @@

Methods Reference

CR Type Fields Reference

----++++ @@ -1224,56 +1252,73 @@

CR Type Fields Reference

- - - + - + - + - + - + - - + + - + +automatically +after final +approval - + +approval +workflow - + - + - + - - + - + - + +installed this +type
Field
code Char requiredUnique identifier +Unique +identifier (lowercase, underscores)
target_type Selection "both""individual", -"group", or +`` +“individual”, +``"group", or "both"
detail_model
` +detail_model` Char requiredTechnical name of -the detail modelTechnical name +of the detail +model
detail_form_view_id
detail +_form_view_id Many2one requiredReference to the -detail form viewReference to +the detail form +view
apply_strategy
a +pply_strategy Selection"field_mapping""field_mapping", -"custom", or -"manual""f +ield_mapping""fi +eld_mapping", +"custom", +or "manual"
auto_apply_on_approve
auto_app +ly_on_approve Boolean True Apply changes -automatically after -final approval
approval_definition_id
approval_ +definition_id Many2one required Static/fallback -approval workflow
use_dynamic_approval
use_dyn +amic_approval Boolean FalseEnable field-level -approval routingEnable +field-level +approval +routing
candidate_definition_ids
candidate_d +efinition_ids Many2many empty Candidate @@ -1283,28 +1328,32 @@

CR Type Fields Reference

icon Char optionalFontAwesome icon -class (e.g., +FontAwesome +icon class +(e.g., "fa-cog")
sequence Integer 10Display order in -type listsDisplay order +in type lists
is_system_type
i +s_system_type Boolean False Installed by a module (not user-created)
source_module
`` +source_module`` Char optional Module that -installed this type
diff --git a/spp_claim_169/README.rst b/spp_claim_169/README.rst index 7e7a74ad..1d959d04 100644 --- a/spp_claim_169/README.rst +++ b/spp_claim_169/README.rst @@ -47,27 +47,27 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------------+----------------------------------+ -| Model | Description | -+=====================================+==================================+ -| ``spp.claim169.credential`` | Stores issued credentials with | -| | QR codes and validity dates | -+-------------------------------------+----------------------------------+ -| ``spp.claim169.issuer.config`` | Defines issuer identity and | -| | signing keys | -+-------------------------------------+----------------------------------+ -| ``spp.claim169.attribute.mapping`` | Maps partner fields to claim | -| | attribute numbers | -+-------------------------------------+----------------------------------+ -| ``spp.claim169.service`` | Service for credential | -| | generation and verification | -+-------------------------------------+----------------------------------+ -| ``spp.claim169.generate.qr.wizard`` | Wizard for batch credential | -| | generation | -+-------------------------------------+----------------------------------+ -| ``spp.claim169.verify.qr.wizard`` | Wizard for credential | -| | verification | -+-------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.claim169.credential`` | Stores issued credentials with | +| | QR codes and validity dates | ++----------------------------------+----------------------------------+ +| ``spp.claim169.issuer.config`` | Defines issuer identity and | +| | signing keys | ++----------------------------------+----------------------------------+ +| `` | Maps partner fields to claim | +| spp.claim169.attribute.mapping`` | attribute numbers | ++----------------------------------+----------------------------------+ +| ``spp.claim169.service`` | Service for credential | +| | generation and verification | ++----------------------------------+----------------------------------+ +| ``s | Wizard for batch credential | +| pp.claim169.generate.qr.wizard`` | generation | ++----------------------------------+----------------------------------+ +| ` | Wizard for credential | +| `spp.claim169.verify.qr.wizard`` | verification | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -102,13 +102,15 @@ UI Location Security ~~~~~~~~ -+------------------------------------------+--------------+---------------+-----------+ -| Group | Credentials | Configuration | Wizards | -+==========================================+==============+===============+===========+ -| ``spp_claim_169.group_claim169_user`` | Read, Create | Read only | Full CRUD | -+------------------------------------------+--------------+---------------+-----------+ -| ``spp_claim_169.group_claim169_manager`` | Full CRUD | Full CRUD | Full CRUD | -+------------------------------------------+--------------+---------------+-----------+ ++------------------------+--------------+---------------+-----------+ +| Group | Credentials | Configuration | Wizards | ++========================+==============+===============+===========+ +| ``spp_claim_169 | Read, Create | Read only | Full CRUD | +| .group_claim169_user`` | | | | ++------------------------+--------------+---------------+-----------+ +| ``spp_claim_169.gr | Full CRUD | Full CRUD | Full CRUD | +| oup_claim169_manager`` | | | | ++------------------------+--------------+---------------+-----------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_consent/README.rst b/spp_consent/README.rst index 1e15c975..6b6bbf0b 100644 --- a/spp_consent/README.rst +++ b/spp_consent/README.rst @@ -54,44 +54,44 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------------+----------------------------------+ -| Model | Description | -+====================================+==================================+ -| ``spp.consent`` | Consent record implementing ISO | -| | 27560 structure with DPV fields | -+------------------------------------+----------------------------------+ -| ``spp.consent.history`` | Audit trail of consent changes | -| | (action, status, user, | -| | timestamp) | -+------------------------------------+----------------------------------+ -| ``spp.consent.notice`` | Privacy notices per ISO 29184 | -| | with version tracking | -+------------------------------------+----------------------------------+ -| ``spp.consent.purpose`` | DPV-aligned purpose taxonomy | -| | (service delivery, research, | -| | etc.) | -+------------------------------------+----------------------------------+ -| ``spp.consent.personal.data`` | DPV-aligned data categories | -| | (GDPR Article 9 sensitivity | -| | tagging) | -+------------------------------------+----------------------------------+ -| ``spp.consent.processing`` | DPV-aligned processing | -| | operations (collect, store, | -| | share, etc.) | -+------------------------------------+----------------------------------+ -| ``spp.consent.org.type`` | Organization type categories for | -| | category-based consent | -+------------------------------------+----------------------------------+ -| ``spp.consent.mixin`` | Abstract mixin to add consent | -| | tracking to any model | -+------------------------------------+----------------------------------+ -| ``spp.record.consent.wizard`` | Wizard for recording individual | -| | consent | -+------------------------------------+----------------------------------+ -| ``spp.bulk.record.consent.wizard`` | Wizard for bulk consent | -| | recording across multiple | -| | beneficiaries | -+------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.consent`` | Consent record implementing ISO | +| | 27560 structure with DPV fields | ++----------------------------------+----------------------------------+ +| ``spp.consent.history`` | Audit trail of consent changes | +| | (action, status, user, | +| | timestamp) | ++----------------------------------+----------------------------------+ +| ``spp.consent.notice`` | Privacy notices per ISO 29184 | +| | with version tracking | ++----------------------------------+----------------------------------+ +| ``spp.consent.purpose`` | DPV-aligned purpose taxonomy | +| | (service delivery, research, | +| | etc.) | ++----------------------------------+----------------------------------+ +| ``spp.consent.personal.data`` | DPV-aligned data categories | +| | (GDPR Article 9 sensitivity | +| | tagging) | ++----------------------------------+----------------------------------+ +| ``spp.consent.processing`` | DPV-aligned processing | +| | operations (collect, store, | +| | share, etc.) | ++----------------------------------+----------------------------------+ +| ``spp.consent.org.type`` | Organization type categories for | +| | category-based consent | ++----------------------------------+----------------------------------+ +| ``spp.consent.mixin`` | Abstract mixin to add consent | +| | tracking to any model | ++----------------------------------+----------------------------------+ +| ``spp.record.consent.wizard`` | Wizard for recording individual | +| | consent | ++----------------------------------+----------------------------------+ +| `` | Wizard for bulk consent | +| spp.bulk.record.consent.wizard`` | recording across multiple | +| | beneficiaries | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -137,30 +137,33 @@ UI Location Security ~~~~~~~~ -+-----------------------------------------+-------------------------+----------------------+ -| Group | Model | Access | -+=========================================+=========================+======================+ -| ``spp_registry.group_registry_viewer`` | All models | Read | -+-----------------------------------------+-------------------------+----------------------+ -| ``spp_registry.group_registry_officer`` | ``spp.consent`` | Read/Write/Create | -| | | (no delete) | -+-----------------------------------------+-------------------------+----------------------+ -| ``spp_registry.group_registry_officer`` | Wizards | Read/Write/Create | -| | | (no delete) | -+-----------------------------------------+-------------------------+----------------------+ -| ``spp_registry.group_registry_officer`` | DPV taxonomies and | Read | -| | notices | | -+-----------------------------------------+-------------------------+----------------------+ -| ``spp_registry.group_registry_manager`` | ``spp.consent`` | Full CRUD | -+-----------------------------------------+-------------------------+----------------------+ -| ``spp_registry.group_registry_manager`` | ``spp.consent.history`` | Read/Create (no | -| | | write/delete) | -+-----------------------------------------+-------------------------+----------------------+ -| ``spp_registry.group_registry_manager`` | Taxonomies, notices, | Full CRUD | -| | org types | | -+-----------------------------------------+-------------------------+----------------------+ -| ``spp_security.group_spp_admin`` | All models | Full CRUD | -+-----------------------------------------+-------------------------+----------------------+ ++----------------------+----------------------+----------------------+ +| Group | Model | Access | ++======================+======================+======================+ +| ``spp_registry.gro | All models | Read | +| up_registry_viewer`` | | | ++----------------------+----------------------+----------------------+ +| ``spp_registry.grou | ``spp.consent`` | Read/Write/Create | +| p_registry_officer`` | | (no delete) | ++----------------------+----------------------+----------------------+ +| ``spp_registry.grou | Wizards | Read/Write/Create | +| p_registry_officer`` | | (no delete) | ++----------------------+----------------------+----------------------+ +| ``spp_registry.grou | DPV taxonomies and | Read | +| p_registry_officer`` | notices | | ++----------------------+----------------------+----------------------+ +| ``spp_registry.grou | ``spp.consent`` | Full CRUD | +| p_registry_manager`` | | | ++----------------------+----------------------+----------------------+ +| ``spp_registry.grou | ``s | Read/Create (no | +| p_registry_manager`` | pp.consent.history`` | write/delete) | ++----------------------+----------------------+----------------------+ +| ``spp_registry.grou | Taxonomies, notices, | Full CRUD | +| p_registry_manager`` | org types | | ++----------------------+----------------------+----------------------+ +| ``spp_securi | All models | Full CRUD | +| ty.group_spp_admin`` | | | ++----------------------+----------------------+----------------------+ Note: Configuration menu requires ``spp_security.group_spp_admin`` or ``spp_registry.group_registry_config_admin``. diff --git a/spp_consent/static/description/index.html b/spp_consent/static/description/index.html index c5fe084b..618fa051 100644 --- a/spp_consent/static/description/index.html +++ b/spp_consent/static/description/index.html @@ -403,8 +403,8 @@

Key Capabilities

Key Models

--++ @@ -452,7 +452,8 @@

Key Models

- + @@ -506,9 +507,9 @@

UI Location

Security

Model Wizard for recording individual consent
spp.bulk.record.consent.wizard
`` +spp.bulk.record.consent.wizard`` Wizard for bulk consent recording across multiple beneficiaries
---+++ @@ -517,40 +518,49 @@

Security

- + - + - + - + - + - - + + - + - + diff --git a/spp_cr_types_advanced/README.rst b/spp_cr_types_advanced/README.rst index f770738f..16b85c75 100644 --- a/spp_cr_types_advanced/README.rst +++ b/spp_cr_types_advanced/README.rst @@ -51,33 +51,33 @@ This module does not define models. It provides data records for ``spp.change.request.type`` and security rules for detail/apply models defined in ``spp_change_request_v2``: -+-------------------------------------+------------------------------------+----------------------+ -| Detail Model | Apply Model | Purpose | -+=====================================+====================================+======================+ -| ``spp.cr.detail.add_member`` | ``spp.cr.apply.add_member`` | Add new member to | -| | | group | -+-------------------------------------+------------------------------------+----------------------+ -| ``spp.cr.detail.remove_member`` | ``spp.cr.apply.remove_member`` | Remove member from | -| | | group | -+-------------------------------------+------------------------------------+----------------------+ -| ``spp.cr.detail.change_hoh`` | ``spp.cr.apply.change_hoh`` | Change head of | -| | | household | -+-------------------------------------+------------------------------------+----------------------+ -| ``spp.cr.detail.transfer_member`` | ``spp.cr.apply.transfer_member`` | Transfer member | -| | | between groups | -+-------------------------------------+------------------------------------+----------------------+ -| ``spp.cr.detail.exit_registrant`` | ``spp.cr.apply.exit_registrant`` | Deactivate | -| | | registrant | -+-------------------------------------+------------------------------------+----------------------+ -| ``spp.cr.detail.create_group`` | ``spp.cr.apply.create_group`` | Create new | -| | | group/household | -+-------------------------------------+------------------------------------+----------------------+ -| ``spp.cr.detail.split_household`` | ``spp.cr.apply.split_household`` | Split household into | -| | | two groups | -+-------------------------------------+------------------------------------+----------------------+ -| ``spp.cr.detail.merge_registrants`` | ``spp.cr.apply.merge_registrants`` | Merge duplicate | -| | | registrant records | -+-------------------------------------+------------------------------------+----------------------+ ++----------------------+----------------------+----------------------+ +| Detail Model | Apply Model | Purpose | ++======================+======================+======================+ +| ``spp.cr | ``spp.c | Add new member to | +| .detail.add_member`` | r.apply.add_member`` | group | ++----------------------+----------------------+----------------------+ +| ``spp.cr.de | ``spp.cr.a | Remove member from | +| tail.remove_member`` | pply.remove_member`` | group | ++----------------------+----------------------+----------------------+ +| ``spp.cr | ``spp.c | Change head of | +| .detail.change_hoh`` | r.apply.change_hoh`` | household | ++----------------------+----------------------+----------------------+ +| ``spp.cr.deta | ``spp.cr.app | Transfer member | +| il.transfer_member`` | ly.transfer_member`` | between groups | ++----------------------+----------------------+----------------------+ +| ``spp.cr.deta | ``spp.cr.app | Deactivate | +| il.exit_registrant`` | ly.exit_registrant`` | registrant | ++----------------------+----------------------+----------------------+ +| ``spp.cr.d | ``spp.cr. | Create new | +| etail.create_group`` | apply.create_group`` | group/household | ++----------------------+----------------------+----------------------+ +| ``spp.cr.deta | ``spp.cr.app | Split household into | +| il.split_household`` | ly.split_household`` | two groups | ++----------------------+----------------------+----------------------+ +| ``spp.cr.detail | ``spp.cr.apply | Merge duplicate | +| .merge_registrants`` | .merge_registrants`` | registrant records | ++----------------------+----------------------+----------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_cr_types_advanced/static/description/index.html b/spp_cr_types_advanced/static/description/index.html index 64c913ee..f2b3ca34 100644 --- a/spp_cr_types_advanced/static/description/index.html +++ b/spp_cr_types_advanced/static/description/index.html @@ -399,9 +399,9 @@

Models Secured by This Module

defined in spp_change_request_v2:

Group
spp_registry.group_registry_viewer
spp_registry.gro +up_registry_viewer All models Read
spp_registry.group_registry_officer
spp_registry.grou +p_registry_officer spp.consent Read/Write/Create (no delete)
spp_registry.group_registry_officer
spp_registry.grou +p_registry_officer Wizards Read/Write/Create (no delete)
spp_registry.group_registry_officer
spp_registry.grou +p_registry_officer DPV taxonomies and notices Read
spp_registry.group_registry_manager
spp_registry.grou +p_registry_manager spp.consent Full CRUD
spp_registry.group_registry_managerspp.consent.history
spp_registry.grou +p_registry_managers +pp.consent.history Read/Create (no write/delete)
spp_registry.group_registry_manager
spp_registry.grou +p_registry_manager Taxonomies, notices, org types Full CRUD
spp_security.group_spp_admin
spp_securi +ty.group_spp_admin All models Full CRUD
---+++ @@ -410,43 +410,59 @@

Models Secured by This Module

- - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + diff --git a/spp_cr_types_base/README.rst b/spp_cr_types_base/README.rst index 87f3e7d4..38efda35 100644 --- a/spp_cr_types_base/README.rst +++ b/spp_cr_types_base/README.rst @@ -48,24 +48,24 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------------+----------------------------------+ -| Model | Description | -+=====================================+==================================+ -| ``spp.cr.detail.edit_individual`` | Detail form for individual | -| | information changes | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.edit_group`` | Detail form for group/household | -| | information | -+-------------------------------------+----------------------------------+ -| ``spp.cr.detail.update_id`` | Detail form for ID document | -| | operations | -+-------------------------------------+----------------------------------+ -| ``spp.change.request.type`` | CR type configurations (defined | -| | in parent) | -+-------------------------------------+----------------------------------+ -| ``spp.change.request.type.mapping`` | Field mappings for field_mapping | -| | strategy | -+-------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ` | Detail form for individual | +| `spp.cr.detail.edit_individual`` | information changes | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.edit_group`` | Detail form for group/household | +| | information | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.update_id`` | Detail form for ID document | +| | operations | ++----------------------------------+----------------------------------+ +| ``spp.change.request.type`` | CR type configurations (defined | +| | in parent) | ++----------------------------------+----------------------------------+ +| ``s | Field mappings for field_mapping | +| pp.change.request.type.mapping`` | strategy | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -93,14 +93,15 @@ UI Location Security ~~~~~~~~ -+--------------------------------------------+----------------------------------+ -| Group | Access | -+============================================+==================================+ -| ``spp_change_request_v2.group_cr_user`` | Read/write/create detail models | -| | (no delete) | -+--------------------------------------------+----------------------------------+ -| ``spp_change_request_v2.group_cr_manager`` | Full CRUD on detail models | -+--------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_c | Read/write/create detail models | +| hange_request_v2.group_cr_user`` | (no delete) | ++----------------------------------+----------------------------------+ +| ``spp_chan | Full CRUD on detail models | +| ge_request_v2.group_cr_manager`` | | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_cr_types_base/static/description/index.html b/spp_cr_types_base/static/description/index.html index 9c90a59c..0901a368 100644 --- a/spp_cr_types_base/static/description/index.html +++ b/spp_cr_types_base/static/description/index.html @@ -397,8 +397,8 @@

Key Capabilities

Key Models

Detail Model
spp.cr.detail.add_memberspp.cr.apply.add_member
spp.cr +.detail.add_memberspp.c +r.apply.add_member Add new member to group
spp.cr.detail.remove_memberspp.cr.apply.remove_member
spp.cr.de +tail.remove_memberspp.cr.a +pply.remove_member Remove member from group
spp.cr.detail.change_hohspp.cr.apply.change_hoh
spp.cr +.detail.change_hohspp.c +r.apply.change_hoh Change head of household
spp.cr.detail.transfer_memberspp.cr.apply.transfer_member
spp.cr.deta +il.transfer_memberspp.cr.app +ly.transfer_member Transfer member between groups
spp.cr.detail.exit_registrantspp.cr.apply.exit_registrant
spp.cr.deta +il.exit_registrantspp.cr.app +ly.exit_registrant Deactivate registrant
spp.cr.detail.create_groupspp.cr.apply.create_group
spp.cr.d +etail.create_groupspp.cr. +apply.create_group Create new group/household
spp.cr.detail.split_householdspp.cr.apply.split_household
spp.cr.deta +il.split_householdspp.cr.app +ly.split_household Split household into two groups
spp.cr.detail.merge_registrantsspp.cr.apply.merge_registrants
spp.cr.detail +.merge_registrantsspp.cr.apply +.merge_registrants Merge duplicate registrant records
--++ @@ -406,7 +406,8 @@

Key Models

- + @@ -422,7 +423,8 @@

Key Models

- + @@ -457,8 +459,8 @@

UI Location

Security

Model
spp.cr.detail.edit_individual
` +spp.cr.detail.edit_individual` Detail form for individual information changes
CR type configurations (defined in parent)
spp.change.request.type.mapping
s +pp.change.request.type.mapping Field mappings for field_mapping strategy
--++ @@ -466,11 +468,13 @@

Security

- + - + diff --git a/spp_custom_field/README.rst b/spp_custom_field/README.rst index dfee7594..016153b9 100644 --- a/spp_custom_field/README.rst +++ b/spp_custom_field/README.rst @@ -44,18 +44,18 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------+---------------------------------------+ -| Model | Description | -+==============================+=======================================+ -| ``spp.custom.field.group`` | Groups custom fields for organized | -| | display in UI | -+------------------------------+---------------------------------------+ -| ``ir.model.fields`` (extend) | Adds ``field_group_id`` and | -| | ``sequence`` for field order | -+------------------------------+---------------------------------------+ -| ``res.partner`` (extend) | Dynamically injects custom fields | -| | into forms | -+------------------------------+---------------------------------------+ ++------------------------------+--------------------------------------+ +| Model | Description | ++==============================+======================================+ +| ``spp.custom.field.group`` | Groups custom fields for organized | +| | display in UI | ++------------------------------+--------------------------------------+ +| ``ir.model.fields`` (extend) | Adds ``field_group_id`` and | +| | ``sequence`` for field order | ++------------------------------+--------------------------------------+ +| ``res.partner`` (extend) | Dynamically injects custom fields | +| | into forms | ++------------------------------+--------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_custom_field/static/description/index.html b/spp_custom_field/static/description/index.html index 180382d8..425dba44 100644 --- a/spp_custom_field/static/description/index.html +++ b/spp_custom_field/static/description/index.html @@ -393,8 +393,8 @@

Key Capabilities

Key Models

Group
spp_change_request_v2.group_cr_user
spp_c +hange_request_v2.group_cr_user Read/write/create detail models (no delete)
spp_change_request_v2.group_cr_manager
spp_chan +ge_request_v2.group_cr_manager Full CRUD on detail models
--++ diff --git a/spp_dci/README.rst b/spp_dci/README.rst index 68cc1d7e..c5de78da 100644 --- a/spp_dci/README.rst +++ b/spp_dci/README.rst @@ -46,12 +46,12 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------+--------------------------------------------+ -| Model | Description | -+=========================+============================================+ -| ``spp.dci.signing.key`` | Cryptographic signing key with lifecycle | -| | state management | -+-------------------------+--------------------------------------------+ ++-------------------------+-------------------------------------------+ +| Model | Description | ++=========================+===========================================+ +| ``spp.dci.signing.key`` | Cryptographic signing key with lifecycle | +| | state management | ++-------------------------+-------------------------------------------+ Pydantic Schemas ~~~~~~~~~~~~~~~~ diff --git a/spp_dci/static/description/index.html b/spp_dci/static/description/index.html index 1e960153..dd2deb89 100644 --- a/spp_dci/static/description/index.html +++ b/spp_dci/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

Model
--++ diff --git a/spp_dci_client/README.rst b/spp_dci_client/README.rst index acc336cf..192cae01 100644 --- a/spp_dci_client/README.rst +++ b/spp_dci_client/README.rst @@ -45,12 +45,12 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------+--------------------------------------------+ -| Model | Description | -+=========================+============================================+ -| ``spp.dci.data.source`` | Connection configuration for external DCI | -| | registries | -+-------------------------+--------------------------------------------+ ++-------------------------+-------------------------------------------+ +| Model | Description | ++=========================+===========================================+ +| ``spp.dci.data.source`` | Connection configuration for external DCI | +| | registries | ++-------------------------+-------------------------------------------+ Python Service Classes ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/spp_dci_client/static/description/index.html b/spp_dci_client/static/description/index.html index baaa3245..d6420f96 100644 --- a/spp_dci_client/static/description/index.html +++ b/spp_dci_client/static/description/index.html @@ -394,8 +394,8 @@

Key Capabilities

Key Models

Model
--++ diff --git a/spp_dci_client_crvs/README.rst b/spp_dci_client_crvs/README.rst index 054e0c3e..5cbba06b 100644 --- a/spp_dci_client_crvs/README.rst +++ b/spp_dci_client_crvs/README.rst @@ -46,15 +46,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------+--------------------------------------------+ -| Model | Description | -+=========================+============================================+ -| ``spp.dci.crvs.event`` | Vital event log with identifier, type, | -| | date, processing state | -+-------------------------+--------------------------------------------+ -| ``spp.dci.crvs.sender`` | Trusted CRVS registry with sender ID and | -| | public key | -+-------------------------+--------------------------------------------+ ++-------------------------+-------------------------------------------+ +| Model | Description | ++=========================+===========================================+ +| ``spp.dci.crvs.event`` | Vital event log with identifier, type, | +| | date, processing state | ++-------------------------+-------------------------------------------+ +| ``spp.dci.crvs.sender`` | Trusted CRVS registry with sender ID and | +| | public key | ++-------------------------+-------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_dci_client_crvs/static/description/index.html b/spp_dci_client_crvs/static/description/index.html index 2f0c61ac..aaa7da4a 100644 --- a/spp_dci_client_crvs/static/description/index.html +++ b/spp_dci_client_crvs/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

Model
--++ diff --git a/spp_dci_client_dr/README.rst b/spp_dci_client_dr/README.rst index ecc9fdb4..c806bb79 100644 --- a/spp_dci_client_dr/README.rst +++ b/spp_dci_client_dr/README.rst @@ -42,17 +42,17 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.dci.disability.status`` | Cached disability data: PWD flag, | -| | disability types, functional scores, | -| | raw data | -+-------------------------------+--------------------------------------+ -| ``spp.dci.dr.sender`` | Trusted DR registry entries with | -| | sender_id, public keys, and JWKS | -| | endpoints | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.dci.disability.status`` | Cached disability data: PWD flag, | +| | disability types, functional | +| | scores, raw data | ++-------------------------------+-------------------------------------+ +| ``spp.dci.dr.sender`` | Trusted DR registry entries with | +| | sender_id, public keys, and JWKS | +| | endpoints | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -108,15 +108,15 @@ DR Sender form: Security ~~~~~~~~ -+-----------------------+----------------------------------------------+ -| Group | Access | -+=======================+==============================================+ -| ``base.group_system`` | Full CRUD on disability status and DR sender | -| | registry | -+-----------------------+----------------------------------------------+ -| ``base.group_user`` | Read/Write/Create disability status, | -| | read-only DR sender registry | -+-----------------------+----------------------------------------------+ ++-----------------------+---------------------------------------------+ +| Group | Access | ++=======================+=============================================+ +| ``base.group_system`` | Full CRUD on disability status and DR | +| | sender registry | ++-----------------------+---------------------------------------------+ +| ``base.group_user`` | Read/Write/Create disability status, | +| | read-only DR sender registry | ++-----------------------+---------------------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_dci_client_dr/static/description/index.html b/spp_dci_client_dr/static/description/index.html index f73ca1e2..a5b386bd 100644 --- a/spp_dci_client_dr/static/description/index.html +++ b/spp_dci_client_dr/static/description/index.html @@ -391,8 +391,8 @@

Key Capabilities

Key Models

Model
--++ @@ -402,8 +402,8 @@

Key Models

+disability types, functional +scores, raw data
Model
spp.dci.disability.status Cached disability data: PWD flag, -disability types, functional scores, -raw data
spp.dci.dr.sender Trusted DR registry entries with @@ -467,8 +467,8 @@

Tabs

Security

--++ @@ -477,8 +477,8 @@

Security

- +
Group
base.group_systemFull CRUD on disability status and DR sender -registryFull CRUD on disability status and DR +sender registry
base.group_user Read/Write/Create disability status, diff --git a/spp_dci_client_ibr/README.rst b/spp_dci_client_ibr/README.rst index c97544b6..c8752134 100644 --- a/spp_dci_client_ibr/README.rst +++ b/spp_dci_client_ibr/README.rst @@ -45,18 +45,18 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.dci.duplication.check`` | Stores duplication check requests | -| | and results from IBR | -+-------------------------------+--------------------------------------+ -| ``spp.dci.ibr.sender`` | Registry of trusted IBR systems with | -| | public keys | -+-------------------------------+--------------------------------------+ -| ``fastapi.endpoint`` | Inherited to add IBR callback router | -| | to DCI API endpoint | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.dci.duplication.check`` | Stores duplication check requests | +| | and results from IBR | ++-------------------------------+-------------------------------------+ +| ``spp.dci.ibr.sender`` | Registry of trusted IBR systems | +| | with public keys | ++-------------------------------+-------------------------------------+ +| ``fastapi.endpoint`` | Inherited to add IBR callback | +| | router to DCI API endpoint | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -83,20 +83,24 @@ UI Location Security ~~~~~~~~ -+-----------------------------------------+-------------------------------+----------------------+ -| Group | Model | Access | -+=========================================+===============================+======================+ -| ``spp_registry.group_registry_viewer`` | ``spp.dci.duplication.check`` | Read | -+-----------------------------------------+-------------------------------+----------------------+ -| ``spp_registry.group_registry_officer`` | ``spp.dci.duplication.check`` | Read/Write/Create | -| | | (no delete) | -+-----------------------------------------+-------------------------------+----------------------+ -| ``spp_registry.group_registry_manager`` | ``spp.dci.duplication.check`` | Full CRUD | -+-----------------------------------------+-------------------------------+----------------------+ -| ``base.group_system`` | ``spp.dci.ibr.sender`` | Full CRUD | -+-----------------------------------------+-------------------------------+----------------------+ -| ``base.group_user`` | ``spp.dci.ibr.sender`` | Read | -+-----------------------------------------+-------------------------------+----------------------+ ++----------------------+----------------------+----------------------+ +| Group | Model | Access | ++======================+======================+======================+ +| ``spp_registry.gro | ``spp.dci | Read | +| up_registry_viewer`` | .duplication.check`` | | ++----------------------+----------------------+----------------------+ +| ``spp_registry.grou | ``spp.dci | Read/Write/Create | +| p_registry_officer`` | .duplication.check`` | (no delete) | ++----------------------+----------------------+----------------------+ +| ``spp_registry.grou | ``spp.dci | Full CRUD | +| p_registry_manager`` | .duplication.check`` | | ++----------------------+----------------------+----------------------+ +| ` | `` | Full CRUD | +| `base.group_system`` | spp.dci.ibr.sender`` | | ++----------------------+----------------------+----------------------+ +| ``base.group_user`` | `` | Read | +| | spp.dci.ibr.sender`` | | ++----------------------+----------------------+----------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_dci_client_ibr/static/description/index.html b/spp_dci_client_ibr/static/description/index.html index 62bb4fb2..1d891626 100644 --- a/spp_dci_client_ibr/static/description/index.html +++ b/spp_dci_client_ibr/static/description/index.html @@ -394,8 +394,8 @@

Key Capabilities

Key Models

--++ @@ -408,12 +408,12 @@

Key Models

and results from IBR - + - +
Model
spp.dci.ibr.senderRegistry of trusted IBR systems with -public keysRegistry of trusted IBR systems +with public keys
fastapi.endpointInherited to add IBR callback router -to DCI API endpointInherited to add IBR callback +router to DCI API endpoint
@@ -445,9 +445,9 @@

UI Location

Security

--++ @@ -456,25 +456,34 @@

Security

- - + + - - + + - - + + - - + + - + diff --git a/spp_dci_server/README.rst b/spp_dci_server/README.rst index 4f378a40..31e7e059 100644 --- a/spp_dci_server/README.rst +++ b/spp_dci_server/README.rst @@ -51,24 +51,24 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------+---------------------------------------+ -| Model | Description | -+==============================+=======================================+ -| ``spp.dci.sender.registry`` | External DCI senders with public keys | -| | for signature verification | -+------------------------------+---------------------------------------+ -| ``spp.dci.transaction`` | Async DCI request tracking (search, | -| | subscribe, unsubscribe) | -+------------------------------+---------------------------------------+ -| ``spp.dci.subscription`` | Event subscriptions with callback | -| | URIs and filter expressions | -+------------------------------+---------------------------------------+ -| ``spp.dci.notification.log`` | Audit trail of sent notifications | -| | with receipt tracking | -+------------------------------+---------------------------------------+ -| ``spp.dci.server.key`` | Server signing keys for outbound | -| | responses and notifications | -+------------------------------+---------------------------------------+ ++------------------------------+--------------------------------------+ +| Model | Description | ++==============================+======================================+ +| ``spp.dci.sender.registry`` | External DCI senders with public | +| | keys for signature verification | ++------------------------------+--------------------------------------+ +| ``spp.dci.transaction`` | Async DCI request tracking (search, | +| | subscribe, unsubscribe) | ++------------------------------+--------------------------------------+ +| ``spp.dci.subscription`` | Event subscriptions with callback | +| | URIs and filter expressions | ++------------------------------+--------------------------------------+ +| ``spp.dci.notification.log`` | Audit trail of sent notifications | +| | with receipt tracking | ++------------------------------+--------------------------------------+ +| ``spp.dci.server.key`` | Server signing keys for outbound | +| | responses and notifications | ++------------------------------+--------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_dci_server/static/description/index.html b/spp_dci_server/static/description/index.html index 8475eace..437c31a1 100644 --- a/spp_dci_server/static/description/index.html +++ b/spp_dci_server/static/description/index.html @@ -400,8 +400,8 @@

Key Capabilities

Key Models

Group
spp_registry.group_registry_viewerspp.dci.duplication.check
spp_registry.gro +up_registry_viewerspp.dci +.duplication.check Read
spp_registry.group_registry_officerspp.dci.duplication.check
spp_registry.grou +p_registry_officerspp.dci +.duplication.check Read/Write/Create (no delete)
spp_registry.group_registry_managerspp.dci.duplication.check
spp_registry.grou +p_registry_managerspp.dci +.duplication.check Full CRUD
base.group_systemspp.dci.ibr.sender
` +base.group_system``` +spp.dci.ibr.sender`` Full CRUD
base.group_userspp.dci.ibr.sender`` +spp.dci.ibr.sender`` Read
--++ @@ -410,8 +410,8 @@

Key Models

- +
Model
spp.dci.sender.registryExternal DCI senders with public keys -for signature verificationExternal DCI senders with public +keys for signature verification
spp.dci.transaction Async DCI request tracking (search, diff --git a/spp_demo/README.rst b/spp_demo/README.rst index 92e150a7..448e9bf3 100644 --- a/spp_demo/README.rst +++ b/spp_demo/README.rst @@ -46,27 +46,27 @@ Key Capabilities Key Models ~~~~~~~~~~ -+----------------------------------+-----------------------------------+ -| Model | Description | -+==================================+===================================+ -| ``spp.demo.data.generator`` | Main generator with configuration | -| | and batch controls | -+----------------------------------+-----------------------------------+ -| ``spp.demo.data.generation.log`` | Logs failed generation attempts | -| | with diagnostics | -+----------------------------------+-----------------------------------+ -| ``spp.demo.data.id.types`` | ID type configuration for | -| | individual/group generation | -+----------------------------------+-----------------------------------+ -| ``spp.demo.data.bank.types`` | Bank type configuration for | -| | account generation | -+----------------------------------+-----------------------------------+ -| ``spp.apps.wizard`` | Wizard for installing missing | -| | demo modules | -+----------------------------------+-----------------------------------+ -| ``spp.missing.module`` | Transient model for tracking | -| | missing modules | -+----------------------------------+-----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.demo.data.generator`` | Main generator with | +| | configuration and batch controls | ++----------------------------------+----------------------------------+ +| ``spp.demo.data.generation.log`` | Logs failed generation attempts | +| | with diagnostics | ++----------------------------------+----------------------------------+ +| ``spp.demo.data.id.types`` | ID type configuration for | +| | individual/group generation | ++----------------------------------+----------------------------------+ +| ``spp.demo.data.bank.types`` | Bank type configuration for | +| | account generation | ++----------------------------------+----------------------------------+ +| ``spp.apps.wizard`` | Wizard for installing missing | +| | demo modules | ++----------------------------------+----------------------------------+ +| ``spp.missing.module`` | Transient model for tracking | +| | missing modules | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -99,19 +99,20 @@ UI Location Security ~~~~~~~~ -+----------------------------------------+----------------------------------+ -| Group | Access | -+========================================+==================================+ -| ``base.group_system`` | Full CRUD on all models | -+----------------------------------------+----------------------------------+ -| ``spp_registry.group_registry_read`` | Read access to all models | -+----------------------------------------+----------------------------------+ -| ``spp_registry.group_registry_write`` | Read/Write on generator and logs | -| | (delete ID/Bank types) | -+----------------------------------------+----------------------------------+ -| ``spp_registry.group_registry_create`` | Read/Create access (delete | -| | ID/Bank types) | -+----------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``base.group_system`` | Full CRUD on all models | ++----------------------------------+----------------------------------+ +| ``sp | Read access to all models | +| p_registry.group_registry_read`` | | ++----------------------------------+----------------------------------+ +| ``spp | Read/Write on generator and logs | +| _registry.group_registry_write`` | (delete ID/Bank types) | ++----------------------------------+----------------------------------+ +| ``spp_ | Read/Create access (delete | +| registry.group_registry_create`` | ID/Bank types) | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_demo/static/description/index.html b/spp_demo/static/description/index.html index 0ece0bdb..14b2537a 100644 --- a/spp_demo/static/description/index.html +++ b/spp_demo/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

--++ @@ -405,8 +405,8 @@

Key Models

- +
Model
spp.demo.data.generatorMain generator with configuration -and batch controlsMain generator with +configuration and batch controls
spp.demo.data.generation.log Logs failed generation attempts @@ -464,8 +464,8 @@

UI Location

Security

--++ @@ -476,14 +476,17 @@

Security

- + - + - + diff --git a/spp_dms/README.rst b/spp_dms/README.rst index c6247498..6367730c 100644 --- a/spp_dms/README.rst +++ b/spp_dms/README.rst @@ -46,24 +46,24 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------------+----------------------------------+ -| Model | Description | -+====================================+==================================+ -| ``spp.dms.directory`` | Directory with parent/child | -| | hierarchy and file storage | -+------------------------------------+----------------------------------+ -| ``spp.dms.file`` | File record with binary content | -| | and optional versioning | -+------------------------------------+----------------------------------+ -| ``spp.dms.file.version`` | Version snapshot with content, | -| | checksum, and comment | -+------------------------------------+----------------------------------+ -| ``spp.dms.category`` | File classification with | -| | validation rules | -+------------------------------------+----------------------------------+ -| ``spp.dms.restore.version.wizard`` | Transient wizard for restoring | -| | file versions | -+------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.dms.directory`` | Directory with parent/child | +| | hierarchy and file storage | ++----------------------------------+----------------------------------+ +| ``spp.dms.file`` | File record with binary content | +| | and optional versioning | ++----------------------------------+----------------------------------+ +| ``spp.dms.file.version`` | Version snapshot with content, | +| | checksum, and comment | ++----------------------------------+----------------------------------+ +| ``spp.dms.category`` | File classification with | +| | validation rules | ++----------------------------------+----------------------------------+ +| `` | Transient wizard for restoring | +| spp.dms.restore.version.wizard`` | file versions | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -89,18 +89,18 @@ UI Location Security ~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Group | Access | -+===============================+======================================+ -| ``spp_dms.group_dms_viewer`` | Read directories, files, versions, | -| | categories | -+-------------------------------+--------------------------------------+ -| ``spp_dms.group_dms_officer`` | Create/edit files and directories | -| | (no delete) | -+-------------------------------+--------------------------------------+ -| ``spp_dms.group_dms_manager`` | Full CRUD on all models including | -| | categories | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Group | Access | ++===============================+=====================================+ +| ``spp_dms.group_dms_viewer`` | Read directories, files, versions, | +| | categories | ++-------------------------------+-------------------------------------+ +| ``spp_dms.group_dms_officer`` | Create/edit files and directories | +| | (no delete) | ++-------------------------------+-------------------------------------+ +| ``spp_dms.group_dms_manager`` | Full CRUD on all models including | +| | categories | ++-------------------------------+-------------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_dms/static/description/index.html b/spp_dms/static/description/index.html index 18eead21..cd6eb13b 100644 --- a/spp_dms/static/description/index.html +++ b/spp_dms/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

Group
base.group_system Full CRUD on all models
spp_registry.group_registry_read
sp +p_registry.group_registry_read Read access to all models
spp_registry.group_registry_write
spp +_registry.group_registry_write Read/Write on generator and logs (delete ID/Bank types)
spp_registry.group_registry_create
spp_ +registry.group_registry_create Read/Create access (delete ID/Bank types)
--++ @@ -420,7 +420,8 @@

Key Models

- + @@ -453,8 +454,8 @@

UI Location

Security

Model File classification with validation rules
spp.dms.restore.version.wizard
`` +spp.dms.restore.version.wizard`` Transient wizard for restoring file versions
--++ diff --git a/spp_drims/README.rst b/spp_drims/README.rst index df30ccf9..62ebed85 100644 --- a/spp_drims/README.rst +++ b/spp_drims/README.rst @@ -123,31 +123,31 @@ UI Location Security ~~~~~~~~ -+--------------------------------------------------+----------------------------------+ -| Group | Access | -+==================================================+==================================+ -| ``spp_drims.group_drims_viewer`` | Read-only access to donations, | -| | requests, dispatches | -+--------------------------------------------------+----------------------------------+ -| ``spp_drims.group_drims_officer`` | Create and edit donations, | -| | requests, returns (no delete) | -+--------------------------------------------------+----------------------------------+ -| ``spp_drims.group_drims_approver`` | Approve or reject supply | -| | requests | -+--------------------------------------------------+----------------------------------+ -| ``spp_drims.group_drims_manager`` | Full CRUD including deletion and | -| | configuration | -+--------------------------------------------------+----------------------------------+ -| ``spp_drims.group_drims_warehouse_worker`` | Receive donations, manage stock, | -| | process dispatches | -+--------------------------------------------------+----------------------------------+ -| ``spp_drims.group_drims_field_officer`` | Create requests and confirm | -| | deliveries in the field | -+--------------------------------------------------+----------------------------------+ -| ``spp_drims.group_drims_coordinator_supervisor`` | Coordinate requests and | -| | distributions within assigned | -| | areas | -+--------------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_drims.group_drims_viewer`` | Read-only access to donations, | +| | requests, dispatches | ++----------------------------------+----------------------------------+ +| ` | Create and edit donations, | +| `spp_drims.group_drims_officer`` | requests, returns (no delete) | ++----------------------------------+----------------------------------+ +| `` | Approve or reject supply | +| spp_drims.group_drims_approver`` | requests | ++----------------------------------+----------------------------------+ +| ` | Full CRUD including deletion and | +| `spp_drims.group_drims_manager`` | configuration | ++----------------------------------+----------------------------------+ +| ``spp_drim | Receive donations, manage stock, | +| s.group_drims_warehouse_worker`` | process dispatches | ++----------------------------------+----------------------------------+ +| ``spp_d | Create requests and confirm | +| rims.group_drims_field_officer`` | deliveries in the field | ++----------------------------------+----------------------------------+ +| ``spp_drims.grou | Coordinate requests and | +| p_drims_coordinator_supervisor`` | distributions within assigned | +| | areas | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_drims/static/description/index.html b/spp_drims/static/description/index.html index 5e4ac297..44d4467f 100644 --- a/spp_drims/static/description/index.html +++ b/spp_drims/static/description/index.html @@ -492,8 +492,8 @@

UI Location

Security

Group
--++ @@ -505,27 +505,33 @@

Security

- + - + - + - + - + - + diff --git a/spp_drims_sl/README.rst b/spp_drims_sl/README.rst index 3bcab5e9..bae4bfa7 100644 --- a/spp_drims_sl/README.rst +++ b/spp_drims_sl/README.rst @@ -61,19 +61,19 @@ Key Configuration Data Approval Workflow Tiers ~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------+------------------------------+--------+ -| Condition | Approvers | SLA | -+==============================+==============================+========+ -| Priority = Life-Threatening | Single manager (fast-track) | 0 days | -+------------------------------+------------------------------+--------+ -| Value < 100,000 LKR | District approver | 1 day | -+------------------------------+------------------------------+--------+ -| Value 100,000 - 500,000 LKR | District → Provincial | 2 days | -| | (2-tier) | | -+------------------------------+------------------------------+--------+ -| Value > 500,000 LKR | District → Provincial → | 3 days | -| | National DMC (3-tier) | | -+------------------------------+------------------------------+--------+ ++-----------------------------+-----------------------------+--------+ +| Condition | Approvers | SLA | ++=============================+=============================+========+ +| Priority = Life-Threatening | Single manager (fast-track) | 0 days | ++-----------------------------+-----------------------------+--------+ +| Value < 100,000 LKR | District approver | 1 day | ++-----------------------------+-----------------------------+--------+ +| Value 100,000 - 500,000 LKR | District → Provincial | 2 days | +| | (2-tier) | | ++-----------------------------+-----------------------------+--------+ +| Value > 500,000 LKR | District → Provincial → | 3 days | +| | National DMC (3-tier) | | ++-----------------------------+-----------------------------+--------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_drims_sl_demo/README.rst b/spp_drims_sl_demo/README.rst index a0acfad7..4f2106d4 100644 --- a/spp_drims_sl_demo/README.rst +++ b/spp_drims_sl_demo/README.rst @@ -51,15 +51,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.drims.demo.generator`` | Transient wizard that orchestrates | -| | demo data generation | -+-------------------------------+--------------------------------------+ -| ``spp.gis.report`` (extended) | Adds ``spp.drims.request`` as | -| | supported GIS report data source | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.drims.demo.generator`` | Transient wizard that orchestrates | +| | demo data generation | ++-------------------------------+-------------------------------------+ +| ``spp.gis.report`` (extended) | Adds ``spp.drims.request`` as | +| | supported GIS report data source | ++-------------------------------+-------------------------------------+ Usage ~~~~~ diff --git a/spp_drims_sl_demo/static/description/index.html b/spp_drims_sl_demo/static/description/index.html index 797d1207..65e5bd08 100644 --- a/spp_drims_sl_demo/static/description/index.html +++ b/spp_drims_sl_demo/static/description/index.html @@ -400,8 +400,8 @@

Key Capabilities

Key Models

Group Read-only access to donations, requests, dispatches
spp_drims.group_drims_officer
` +spp_drims.group_drims_officer` Create and edit donations, requests, returns (no delete)
spp_drims.group_drims_approver
`` +spp_drims.group_drims_approver`` Approve or reject supply requests
spp_drims.group_drims_manager
` +spp_drims.group_drims_manager` Full CRUD including deletion and configuration
spp_drims.group_drims_warehouse_worker
spp_drim +s.group_drims_warehouse_worker Receive donations, manage stock, process dispatches
spp_drims.group_drims_field_officer
spp_d +rims.group_drims_field_officer Create requests and confirm deliveries in the field
spp_drims.group_drims_coordinator_supervisor
spp_drims.grou +p_drims_coordinator_supervisor Coordinate requests and distributions within assigned areas
--++ diff --git a/spp_event_data/README.rst b/spp_event_data/README.rst index 485a4f5f..6f20b18c 100644 --- a/spp_event_data/README.rst +++ b/spp_event_data/README.rst @@ -53,24 +53,24 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-----------------------------+----------------------------------------+ -| Model | Description | -+=============================+========================================+ -| ``spp.event.data`` | Event record with registrant link, | -| | collection metadata | -+-----------------------------+----------------------------------------+ -| ``spp.event.type`` | Event type configuration (category, | -| | lifecycle, source) | -+-----------------------------+----------------------------------------+ -| ``spp.event.field`` | Custom field definition for JSON-based | -| | event types | -+-----------------------------+----------------------------------------+ -| ``spp.event.type.mapping`` | Field mapping for external source data | -| | transformation | -+-----------------------------+----------------------------------------+ -| ``spp.create.event.wizard`` | Wizard to create new event records | -| | from registrant form | -+-----------------------------+----------------------------------------+ ++-----------------------------+---------------------------------------+ +| Model | Description | ++=============================+=======================================+ +| ``spp.event.data`` | Event record with registrant link, | +| | collection metadata | ++-----------------------------+---------------------------------------+ +| ``spp.event.type`` | Event type configuration (category, | +| | lifecycle, source) | ++-----------------------------+---------------------------------------+ +| ``spp.event.field`` | Custom field definition for | +| | JSON-based event types | ++-----------------------------+---------------------------------------+ +| ``spp.event.type.mapping`` | Field mapping for external source | +| | data transformation | ++-----------------------------+---------------------------------------+ +| ``spp.create.event.wizard`` | Wizard to create new event records | +| | from registrant form | ++-----------------------------+---------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_event_data/static/description/index.html b/spp_event_data/static/description/index.html index a42a92ab..e8e00698 100644 --- a/spp_event_data/static/description/index.html +++ b/spp_event_data/static/description/index.html @@ -402,8 +402,8 @@

Key Capabilities

Key Models

Model
--++ @@ -420,12 +420,12 @@

Key Models

lifecycle, source) - + - +
Model
spp.event.fieldCustom field definition for JSON-based -event typesCustom field definition for +JSON-based event types
spp.event.type.mappingField mapping for external source data -transformationField mapping for external source +data transformation
spp.create.event.wizard Wizard to create new event records diff --git a/spp_gis/README.rst b/spp_gis/README.rst index 300826d8..5c053da6 100644 --- a/spp_gis/README.rst +++ b/spp_gis/README.rst @@ -47,21 +47,21 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.gis.raster.layer`` | Background map layers (OSM, WMS, | -| | image) | -+-------------------------------+--------------------------------------+ -| ``spp.gis.data.layer`` | Vector data layers referencing geo | -| | fields from any model | -+-------------------------------+--------------------------------------+ -| ``spp.gis.color.scheme`` | Color palettes for choropleth and | -| | thematic visualizations | -+-------------------------------+--------------------------------------+ -| ``spp.gis.raster.layer.type`` | Raster layer type definitions (WMS | -| | services) | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.gis.raster.layer`` | Background map layers (OSM, WMS, | +| | image) | ++-------------------------------+-------------------------------------+ +| ``spp.gis.data.layer`` | Vector data layers referencing geo | +| | fields from any model | ++-------------------------------+-------------------------------------+ +| ``spp.gis.color.scheme`` | Color palettes for choropleth and | +| | thematic visualizations | ++-------------------------------+-------------------------------------+ +| ``spp.gis.raster.layer.type`` | Raster layer type definitions (WMS | +| | services) | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -89,19 +89,19 @@ UI Location Security ~~~~~~~~ -+--------------------------------------+----------------------------------+ -| Group | Access | -+======================================+==================================+ -| ``spp_security.group_spp_admin`` | Full CRUD on all GIS models | -+--------------------------------------+----------------------------------+ -| ``spp_registry.group_registry_read`` | Read-only on color schemes and | -| | layers | -+--------------------------------------+----------------------------------+ -| ``spp_gis.group_gis_user`` | View GIS data and maps | -+--------------------------------------+----------------------------------+ -| ``spp_gis.group_gis_admin`` | Full GIS management including | -| | configuration | -+--------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_security.group_spp_admin`` | Full CRUD on all GIS models | ++----------------------------------+----------------------------------+ +| ``sp | Read-only on color schemes and | +| p_registry.group_registry_read`` | layers | ++----------------------------------+----------------------------------+ +| ``spp_gis.group_gis_user`` | View GIS data and maps | ++----------------------------------+----------------------------------+ +| ``spp_gis.group_gis_admin`` | Full GIS management including | +| | configuration | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_gis/static/description/index.html b/spp_gis/static/description/index.html index b428fb13..7c0ce3aa 100644 --- a/spp_gis/static/description/index.html +++ b/spp_gis/static/description/index.html @@ -396,8 +396,8 @@

Key Capabilities

Key Models

--++ @@ -452,8 +452,8 @@

UI Location

Security

Model
--++ @@ -464,7 +464,8 @@

Security

- + diff --git a/spp_gis_report/README.rst b/spp_gis_report/README.rst index f956ef5c..ab22d2f5 100644 --- a/spp_gis_report/README.rst +++ b/spp_gis_report/README.rst @@ -51,27 +51,27 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------+---------------------------------------+ -| Model | Description | -+==============================+=======================================+ -| ``spp.gis.report`` | Report configuration defining source, | -| | aggregation, and display | -+------------------------------+---------------------------------------+ -| ``spp.gis.report.data`` | Cached computed values for each area, | -| | updated on schedule | -+------------------------------+---------------------------------------+ -| ``spp.gis.report.template`` | Pre-built report definitions with | -| | JSON configuration | -+------------------------------+---------------------------------------+ -| ``spp.gis.report.category`` | Categories for organizing reports and | -| | templates | -+------------------------------+---------------------------------------+ -| ``spp.gis.report.threshold`` | Color threshold definitions for map | -| | visualization | -+------------------------------+---------------------------------------+ -| ``spp.gis.report.wizard`` | Three-step wizard for creating | -| | reports from templates | -+------------------------------+---------------------------------------+ ++------------------------------+--------------------------------------+ +| Model | Description | ++==============================+======================================+ +| ``spp.gis.report`` | Report configuration defining | +| | source, aggregation, and display | ++------------------------------+--------------------------------------+ +| ``spp.gis.report.data`` | Cached computed values for each | +| | area, updated on schedule | ++------------------------------+--------------------------------------+ +| ``spp.gis.report.template`` | Pre-built report definitions with | +| | JSON configuration | ++------------------------------+--------------------------------------+ +| ``spp.gis.report.category`` | Categories for organizing reports | +| | and templates | ++------------------------------+--------------------------------------+ +| ``spp.gis.report.threshold`` | Color threshold definitions for map | +| | visualization | ++------------------------------+--------------------------------------+ +| ``spp.gis.report.wizard`` | Three-step wizard for creating | +| | reports from templates | ++------------------------------+--------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -94,22 +94,23 @@ UI Location Security ~~~~~~~~ -+-----------------------------------------+----------------------------------+ -| Group | Access | -+=========================================+==================================+ -| ``base.group_user`` | Read reports and data | -+-----------------------------------------+----------------------------------+ -| ``group_gis_report_user`` | Read reports, write data for | -| | refresh | -+-----------------------------------------+----------------------------------+ -| ``group_gis_report_officer`` | Read/Write/Create (no delete) | -+-----------------------------------------+----------------------------------+ -| ``group_gis_report_manager`` | Full CRUD | -+-----------------------------------------+----------------------------------+ -| ``spp_registry.group_registry_officer`` | Read reports and data | -+-----------------------------------------+----------------------------------+ -| ``spp_security.group_spp_admin`` | Full CRUD and configuration | -+-----------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``base.group_user`` | Read reports and data | ++----------------------------------+----------------------------------+ +| ``group_gis_report_user`` | Read reports, write data for | +| | refresh | ++----------------------------------+----------------------------------+ +| ``group_gis_report_officer`` | Read/Write/Create (no delete) | ++----------------------------------+----------------------------------+ +| ``group_gis_report_manager`` | Full CRUD | ++----------------------------------+----------------------------------+ +| ``spp_r | Read reports and data | +| egistry.group_registry_officer`` | | ++----------------------------------+----------------------------------+ +| ``spp_security.group_spp_admin`` | Full CRUD and configuration | ++----------------------------------+----------------------------------+ API Endpoints ~~~~~~~~~~~~~ diff --git a/spp_gis_report/static/description/index.html b/spp_gis_report/static/description/index.html index bc29408d..b586ed20 100644 --- a/spp_gis_report/static/description/index.html +++ b/spp_gis_report/static/description/index.html @@ -400,8 +400,8 @@

Key Capabilities

Key Models

Group
spp_security.group_spp_admin Full CRUD on all GIS models
spp_registry.group_registry_read
sp +p_registry.group_registry_read Read-only on color schemes and layers
--++ @@ -410,20 +410,20 @@

Key Models

- + - + - +
Model
spp.gis.reportReport configuration defining source, -aggregation, and displayReport configuration defining +source, aggregation, and display
spp.gis.report.dataCached computed values for each area, -updated on scheduleCached computed values for each +area, updated on schedule
spp.gis.report.template Pre-built report definitions with JSON configuration
spp.gis.report.categoryCategories for organizing reports and -templatesCategories for organizing reports +and templates
spp.gis.report.threshold Color threshold definitions for map @@ -458,8 +458,8 @@

UI Location

Security

--++ @@ -480,7 +480,8 @@

Security

- + diff --git a/spp_graduation/README.rst b/spp_graduation/README.rst index d81a083c..316156de 100644 --- a/spp_graduation/README.rst +++ b/spp_graduation/README.rst @@ -48,21 +48,21 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------------------------+----------------------------------+ -| Model | Description | -+======================================+==================================+ -| ``spp.graduation.pathway`` | Defines a graduation pathway | -| | with criteria and exit type | -+--------------------------------------+----------------------------------+ -| ``spp.graduation.criteria`` | Individual criterion within a | -| | pathway with weight and method | -+--------------------------------------+----------------------------------+ -| ``spp.graduation.assessment`` | Assessment of a beneficiary | -| | against a pathway with scores | -+--------------------------------------+----------------------------------+ -| ``spp.graduation.criteria.response`` | Response to a specific criterion | -| | within an assessment | -+--------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.graduation.pathway`` | Defines a graduation pathway | +| | with criteria and exit type | ++----------------------------------+----------------------------------+ +| ``spp.graduation.criteria`` | Individual criterion within a | +| | pathway with weight and method | ++----------------------------------+----------------------------------+ +| ``spp.graduation.assessment`` | Assessment of a beneficiary | +| | against a pathway with scores | ++----------------------------------+----------------------------------+ +| ``sp | Response to a specific criterion | +| p.graduation.criteria.response`` | within an assessment | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -93,16 +93,16 @@ UI Location Security ~~~~~~~~ -+-------------------------------------------------+----------------------------------+ -| Group | Access | -+=================================================+==================================+ -| ``spp_graduation.group_spp_graduation_user`` | Read pathways/criteria; | -| | create/edit own assessments (no | -| | delete) | -+-------------------------------------------------+----------------------------------+ -| ``spp_graduation.group_spp_graduation_manager`` | Full CRUD on all graduation data | -| | and configuration | -+-------------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_gradua | Read pathways/criteria; | +| tion.group_spp_graduation_user`` | create/edit own assessments (no | +| | delete) | ++----------------------------------+----------------------------------+ +| ``spp_graduatio | Full CRUD on all graduation data | +| n.group_spp_graduation_manager`` | and configuration | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_graduation/static/description/index.html b/spp_graduation/static/description/index.html index 6e33b82e..b36444b2 100644 --- a/spp_graduation/static/description/index.html +++ b/spp_graduation/static/description/index.html @@ -397,8 +397,8 @@

Key Capabilities

Key Models

Group
group_gis_report_manager Full CRUD
spp_registry.group_registry_officer
spp_r +egistry.group_registry_officer Read reports and data
spp_security.group_spp_admin
--++ @@ -418,7 +418,8 @@

Key Models

- + @@ -456,8 +457,8 @@

UI Location

Security

Model Assessment of a beneficiary against a pathway with scores
spp.graduation.criteria.response
sp +p.graduation.criteria.response Response to a specific criterion within an assessment
--++ @@ -465,12 +466,14 @@

Security

- + - + diff --git a/spp_grm/README.rst b/spp_grm/README.rst index bb58317a..7caede66 100644 --- a/spp_grm/README.rst +++ b/spp_grm/README.rst @@ -55,33 +55,33 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------------------+-------------------------------------+ -| Model | Description | -+================================+=====================================+ -| ``spp.grm.ticket`` | Main complaint/grievance with SLA | -| | tracking and decision fields | -+--------------------------------+-------------------------------------+ -| ``spp.grm.ticket.stage`` | Workflow stage with access control | -| | and closure configuration | -+--------------------------------+-------------------------------------+ -| ``spp.grm.ticket.category`` | Primary classification with | -| | hierarchical structure | -+--------------------------------+-------------------------------------+ -| ``spp.grm.ticket.subcategory`` | Second-level classification under | -| | category | -+--------------------------------+-------------------------------------+ -| ``spp.grm.team`` | Team of handlers with manager and | -| | geographic areas | -+--------------------------------+-------------------------------------+ -| ``spp.grm.sla.rule`` | Conditional SLA rules with | -| | escalation targets | -+--------------------------------+-------------------------------------+ -| ``spp.grm.ticket.tag`` | Tags for flexible ticket | -| | classification | -+--------------------------------+-------------------------------------+ -| ``spp.grm.ticket.channel`` | Communication channel (email, | -| | phone, walk-in, portal, etc.) | -+--------------------------------+-------------------------------------+ ++--------------------------------+------------------------------------+ +| Model | Description | ++================================+====================================+ +| ``spp.grm.ticket`` | Main complaint/grievance with SLA | +| | tracking and decision fields | ++--------------------------------+------------------------------------+ +| ``spp.grm.ticket.stage`` | Workflow stage with access control | +| | and closure configuration | ++--------------------------------+------------------------------------+ +| ``spp.grm.ticket.category`` | Primary classification with | +| | hierarchical structure | ++--------------------------------+------------------------------------+ +| ``spp.grm.ticket.subcategory`` | Second-level classification under | +| | category | ++--------------------------------+------------------------------------+ +| ``spp.grm.team`` | Team of handlers with manager and | +| | geographic areas | ++--------------------------------+------------------------------------+ +| ``spp.grm.sla.rule`` | Conditional SLA rules with | +| | escalation targets | ++--------------------------------+------------------------------------+ +| ``spp.grm.ticket.tag`` | Tags for flexible ticket | +| | classification | ++--------------------------------+------------------------------------+ +| ``spp.grm.ticket.channel`` | Communication channel (email, | +| | phone, walk-in, portal, etc.) | ++--------------------------------+------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_grm/static/description/index.html b/spp_grm/static/description/index.html index 6d81d79a..771c4dde 100644 --- a/spp_grm/static/description/index.html +++ b/spp_grm/static/description/index.html @@ -404,8 +404,8 @@

Key Capabilities

Key Models

Group
spp_graduation.group_spp_graduation_user
spp_gradua +tion.group_spp_graduation_user Read pathways/criteria; create/edit own assessments (no delete)
spp_graduation.group_spp_graduation_manager
spp_graduatio +n.group_spp_graduation_manager Full CRUD on all graduation data and configuration
--++ diff --git a/spp_grm_case_link/README.rst b/spp_grm_case_link/README.rst index 5ac460a3..949e1e7b 100644 --- a/spp_grm_case_link/README.rst +++ b/spp_grm_case_link/README.rst @@ -47,18 +47,18 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.grm.escalate.wizard`` | Transient wizard to configure and | -| | execute escalation | -+-------------------------------+--------------------------------------+ -| ``spp.grm.ticket`` (extended) | Adds ``case_id`` field and | -| | escalation/view case actions | -+-------------------------------+--------------------------------------+ -| ``spp.case`` (extended) | Adds ``source_grm_ticket_id``, | -| | ``grm_ticket_ids``, and count | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.grm.escalate.wizard`` | Transient wizard to configure and | +| | execute escalation | ++-------------------------------+-------------------------------------+ +| ``spp.grm.ticket`` (extended) | Adds ``case_id`` field and | +| | escalation/view case actions | ++-------------------------------+-------------------------------------+ +| ``spp.case`` (extended) | Adds ``source_grm_ticket_id``, | +| | ``grm_ticket_ids``, and count | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_grm_case_link/static/description/index.html b/spp_grm_case_link/static/description/index.html index 8dca3de8..aae3fada 100644 --- a/spp_grm_case_link/static/description/index.html +++ b/spp_grm_case_link/static/description/index.html @@ -396,8 +396,8 @@

Key Capabilities

Key Models

Model
--++ diff --git a/spp_grm_cel/README.rst b/spp_grm_cel/README.rst index 94ebeb17..f5d0320b 100644 --- a/spp_grm_cel/README.rst +++ b/spp_grm_cel/README.rst @@ -46,21 +46,21 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.grm.routing.rule`` | Routing rule with CEL condition that | -| | assigns tickets to teams/users | -| | (first match wins) | -+-------------------------------+--------------------------------------+ -| ``spp.grm.escalation.rule`` | Escalation rule with CEL condition | -| | and time trigger that escalates | -| | tickets | -+-------------------------------+--------------------------------------+ -| ``spp.grm.ticket`` (extended) | Adds ``routing_rule_id`` and | -| | ``escalation_rule_ids`` fields to | -| | track applied rules | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.grm.routing.rule`` | Routing rule with CEL condition | +| | that assigns tickets to teams/users | +| | (first match wins) | ++-------------------------------+-------------------------------------+ +| ``spp.grm.escalation.rule`` | Escalation rule with CEL condition | +| | and time trigger that escalates | +| | tickets | ++-------------------------------+-------------------------------------+ +| ``spp.grm.ticket`` (extended) | Adds ``routing_rule_id`` and | +| | ``escalation_rule_ids`` fields to | +| | track applied rules | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_grm_cel/static/description/index.html b/spp_grm_cel/static/description/index.html index 7c686d6a..6ee26fe1 100644 --- a/spp_grm_cel/static/description/index.html +++ b/spp_grm_cel/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

Model
--++ @@ -405,8 +405,8 @@

Key Models

- diff --git a/spp_grm_demo/README.rst b/spp_grm_demo/README.rst index be88bc6d..bc3ecc16 100644 --- a/spp_grm_demo/README.rst +++ b/spp_grm_demo/README.rst @@ -47,15 +47,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+----------------------------+-----------------------------------------+ -| Model | Description | -+============================+=========================================+ -| ``spp.grm.demo.generator`` | Transient model containing generation | -| | logic and workflow simulation | -+----------------------------+-----------------------------------------+ -| ``spp.grm.demo.wizard`` | Transient model inheriting from | -| | generator for wizard UI configuration | -+----------------------------+-----------------------------------------+ ++----------------------------+----------------------------------------+ +| Model | Description | ++============================+========================================+ +| ``spp.grm.demo.generator`` | Transient model containing generation | +| | logic and workflow simulation | ++----------------------------+----------------------------------------+ +| ``spp.grm.demo.wizard`` | Transient model inheriting from | +| | generator for wizard UI configuration | ++----------------------------+----------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_grm_registry/README.rst b/spp_grm_registry/README.rst index f8662444..0615284e 100644 --- a/spp_grm_registry/README.rst +++ b/spp_grm_registry/README.rst @@ -45,15 +45,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------+-------------------------------------------------+ -| Model | Description | -+====================+=================================================+ -| ``spp.grm.ticket`` | Adds registrant/household links, repeat | -| | detection fields | -+--------------------+-------------------------------------------------+ -| ``res.partner`` | Adds GRM ticket relationships and computed | -| | count fields | -+--------------------+-------------------------------------------------+ ++--------------------+------------------------------------------------+ +| Model | Description | ++====================+================================================+ +| ``spp.grm.ticket`` | Adds registrant/household links, repeat | +| | detection fields | ++--------------------+------------------------------------------------+ +| ``res.partner`` | Adds GRM ticket relationships and computed | +| | count fields | ++--------------------+------------------------------------------------+ UI Location ~~~~~~~~~~~ diff --git a/spp_hazard/README.rst b/spp_hazard/README.rst index 5f12ee79..3c5882a0 100644 --- a/spp_hazard/README.rst +++ b/spp_hazard/README.rst @@ -1,13 +1,17 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + ===================================== OpenSPP Hazard & Emergency Management ===================================== -.. +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! source digest: sha256:6c799a070608a2c41e92173cb6e13783cda3e3e01c784f1d94decc3c6391a182 + !! source digest: sha256:a8c431bd5b3d9af3ed97d2c211663e30be9d94121f66c6bb1f83369c1cfe43d3 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png @@ -47,27 +51,27 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------+---------------------------------------+ -| Model | Description | -+==============================+=======================================+ -| ``spp.hazard.category`` | Hierarchical classification of hazard | -| | types | -+------------------------------+---------------------------------------+ -| ``spp.hazard.incident`` | Specific disaster event with dates, | -| | severity, and affected areas | -+------------------------------+---------------------------------------+ -| ``spp.hazard.incident.area`` | Links incident to area with | -| | area-specific details | -+------------------------------+---------------------------------------+ -| ``spp.hazard.impact`` | Records impact on a registrant (type, | -| | damage level, verification) | -+------------------------------+---------------------------------------+ -| ``spp.hazard.impact.type`` | Classification of impact types by | -| | category | -+------------------------------+---------------------------------------+ -| ``res.partner`` (extended) | Adds hazard impact tracking fields to | -| | registrants | -+------------------------------+---------------------------------------+ ++------------------------------+--------------------------------------+ +| Model | Description | ++==============================+======================================+ +| ``spp.hazard.category`` | Hierarchical classification of | +| | hazard types | ++------------------------------+--------------------------------------+ +| ``spp.hazard.incident`` | Specific disaster event with dates, | +| | severity, and affected areas | ++------------------------------+--------------------------------------+ +| ``spp.hazard.incident.area`` | Links incident to area with | +| | area-specific details | ++------------------------------+--------------------------------------+ +| ``spp.hazard.impact`` | Records impact on a registrant | +| | (type, damage level, verification) | ++------------------------------+--------------------------------------+ +| ``spp.hazard.impact.type`` | Classification of impact types by | +| | category | ++------------------------------+--------------------------------------+ +| ``res.partner`` (extended) | Adds hazard impact tracking fields | +| | to registrants | ++------------------------------+--------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -96,20 +100,20 @@ UI Location Security ~~~~~~~~ -+----------------------------------+-----------------------------------+ -| Group | Access | -+==================================+===================================+ -| ``group_hazard_viewer`` | Read-only access to all hazard | -| | records | -+----------------------------------+-----------------------------------+ -| ``group_hazard_officer`` | Create and manage incidents and | -| | impacts (no delete) | -+----------------------------------+-----------------------------------+ -| ``group_hazard_manager`` | Full CRUD access including | -| | configuration | -+----------------------------------+-----------------------------------+ -| ``spp_security.group_spp_admin`` | Inherits manager access | -+----------------------------------+-----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``group_hazard_viewer`` | Read-only access to all hazard | +| | records | ++----------------------------------+----------------------------------+ +| ``group_hazard_officer`` | Create and manage incidents and | +| | impacts (no delete) | ++----------------------------------+----------------------------------+ +| ``group_hazard_manager`` | Full CRUD access including | +| | configuration | ++----------------------------------+----------------------------------+ +| ``spp_security.group_spp_admin`` | Inherits manager access | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ @@ -172,4 +176,4 @@ Current maintainers: This module is part of the `OpenSPP/OpenSPP2 `_ project on GitHub. -You are welcome to contribute. \ No newline at end of file +You are welcome to contribute. diff --git a/spp_hazard/security/compliance.yaml b/spp_hazard/security/compliance.yaml index eb4e05ca..be2b1859 100644 --- a/spp_hazard/security/compliance.yaml +++ b/spp_hazard/security/compliance.yaml @@ -104,7 +104,7 @@ record_rules: [] menus: # Main Hazard menu - accessible to all hazard groups - id: hazard_main_menu_root - name: "Hazard & Emergency" + name: "Hazard and Emergency" groups: [ spp_security.group_spp_admin, diff --git a/spp_hazard/static/description/index.html b/spp_hazard/static/description/index.html index c4bd810a..a0c53e0b 100644 --- a/spp_hazard/static/description/index.html +++ b/spp_hazard/static/description/index.html @@ -3,7 +3,7 @@ -OpenSPP Hazard & Emergency Management +README.rst -
-

OpenSPP Hazard & Emergency Management

+
+ + +Odoo Community Association + +
+

OpenSPP Hazard & Emergency Management

Beta License: LGPL-3 OpenSPP/OpenSPP2

Records disaster events and tracks their impact on individual @@ -375,7 +380,7 @@

OpenSPP Hazard & Emergency Management

scope tracking, severity levels, and verification workflows to enable targeted emergency response and humanitarian assistance.

-

Key Capabilities

+

Key Capabilities

  • Define hazard categories in a tree structure (e.g., Natural > Storm > Typhoon)
    • @@ -393,11 +398,11 @@

    Key Capabilities

-

Key Models

+

Key Models

Model
spp.grm.routing.ruleRouting rule with CEL condition that -assigns tickets to teams/users +Routing rule with CEL condition +that assigns tickets to teams/users (first match wins)
spp.grm.escalation.rule
--++ @@ -406,8 +411,8 @@

Key Models

- + - + - +
Model
spp.hazard.categoryHierarchical classification of hazard -typesHierarchical classification of +hazard types
spp.hazard.incident Specific disaster event with dates, @@ -418,22 +423,22 @@

Key Models

area-specific details
spp.hazard.impactRecords impact on a registrant (type, -damage level, verification)Records impact on a registrant +(type, damage level, verification)
spp.hazard.impact.type Classification of impact types by category
res.partner (extended)Adds hazard impact tracking fields to -registrantsAdds hazard impact tracking fields +to registrants
-

Configuration

+

Configuration

After installing:

  1. Navigate to Hazard & Emergency > Configuration > Hazard @@ -446,7 +451,7 @@

    Configuration

-

UI Location

+

UI Location

  • Menu: Hazard & Emergency (top-level application menu)
  • Incidents: Hazard & Emergency > Incidents > All Incidents
    • @@ -458,11 +463,11 @@

    UI Location

-

Security

+

Security

--++ @@ -489,7 +494,7 @@

Security

Group
-

Extension Points

+

Extension Points

  • Inherit spp.hazard.incident and override identify_potentially_affected_registrants() to customize targeting @@ -501,7 +506,7 @@

    Extension Points

-

Dependencies

+

Dependencies

base, spp_security, spp_registry, spp_area

Table of contents

@@ -515,7 +520,7 @@

Dependencies

-

Bug Tracker

+

Bug Tracker

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 @@ -523,15 +528,15 @@

Bug Tracker

Do not contact contributors directly about support or help with technical issues.

-

Credits

+

Credits

-

Authors

+

Authors

  • OpenSPP.org
-

Maintainers

+

Maintainers

Current maintainers:

jeremi gonzalesedwin1123 reichie020212 emjay0921

This module is part of the OpenSPP/OpenSPP2 project on GitHub.

@@ -540,5 +545,6 @@

Maintainers

+ diff --git a/spp_hazard/views/menu.xml b/spp_hazard/views/menu.xml index ccc8b04d..ef42b29d 100644 --- a/spp_hazard/views/menu.xml +++ b/spp_hazard/views/menu.xml @@ -3,7 +3,7 @@ diff --git a/spp_hide_menus_base/README.rst b/spp_hide_menus_base/README.rst index 7ba579ee..d243be08 100644 --- a/spp_hide_menus_base/README.rst +++ b/spp_hide_menus_base/README.rst @@ -43,12 +43,12 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------+--------------------------------------------------+ -| Model | Description | -+===================+==================================================+ -| ``spp.hide.menu`` | Stores menu reference, state (show/hide), and | -| | original group_ids | -+-------------------+--------------------------------------------------+ ++-------------------+-------------------------------------------------+ +| Model | Description | ++===================+=================================================+ +| ``spp.hide.menu`` | Stores menu reference, state (show/hide), and | +| | original group_ids | ++-------------------+-------------------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -73,15 +73,15 @@ UI Location Security ~~~~~~~~ -+-----------------------------------------------+----------------------------------+ -| Group | Access | -+===============================================+==================================+ -| ``base.group_system`` | Full CRUD | -+-----------------------------------------------+----------------------------------+ -| ``spp_hide_menus_base.group_hide_menus_user`` | See menus hidden from other | -| | users (assigned via privilege | -| | system) | -+-----------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``base.group_system`` | Full CRUD | ++----------------------------------+----------------------------------+ +| ``spp_hide_me | See menus hidden from other | +| nus_base.group_hide_menus_user`` | users (assigned via privilege | +| | system) | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_hide_menus_base/static/description/index.html b/spp_hide_menus_base/static/description/index.html index b6d3398d..fb7d8137 100644 --- a/spp_hide_menus_base/static/description/index.html +++ b/spp_hide_menus_base/static/description/index.html @@ -432,8 +432,8 @@

UI Location

Security

--++ @@ -444,7 +444,8 @@

Security

- + diff --git a/spp_hxl/README.rst b/spp_hxl/README.rst index b37b4d11..cafcb4bc 100644 --- a/spp_hxl/README.rst +++ b/spp_hxl/README.rst @@ -48,25 +48,25 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-----------------------------------+----------------------------------+ -| Model | Description | -+===================================+==================================+ -| ``spp.hxl.tag`` | Registry of HXL hashtags (e.g., | -| | #affected, #adm2, #indicator) | -+-----------------------------------+----------------------------------+ -| ``spp.hxl.attribute`` | Registry of HXL attributes | -| | (e.g., +f, +children, +code) | -+-----------------------------------+----------------------------------+ -| ``spp.hxl.export.profile`` | Export template defining model | -| | and column mapping with HXL tags | -+-----------------------------------+----------------------------------+ -| ``spp.hxl.export.profile.column`` | Column definition with field | -| | path and HXL tag assignment | -+-----------------------------------+----------------------------------+ -| ``spp.cel.variable`` (extended) | CEL variable with HXL hashtag, | -| | attributes, and import/export | -| | behavior | -+-----------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.hxl.tag`` | Registry of HXL hashtags (e.g., | +| | #affected, #adm2, #indicator) | ++----------------------------------+----------------------------------+ +| ``spp.hxl.attribute`` | Registry of HXL attributes | +| | (e.g., +f, +children, +code) | ++----------------------------------+----------------------------------+ +| ``spp.hxl.export.profile`` | Export template defining model | +| | and column mapping with HXL tags | ++----------------------------------+----------------------------------+ +| ` | Column definition with field | +| `spp.hxl.export.profile.column`` | path and HXL tag assignment | ++----------------------------------+----------------------------------+ +| ``spp.cel.variable`` (extended) | CEL variable with HXL hashtag, | +| | attributes, and import/export | +| | behavior | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_hxl/static/description/index.html b/spp_hxl/static/description/index.html index bc405e1b..802213d4 100644 --- a/spp_hxl/static/description/index.html +++ b/spp_hxl/static/description/index.html @@ -397,8 +397,8 @@

Key Capabilities

Key Models

Group
base.group_system Full CRUD
spp_hide_menus_base.group_hide_menus_user
spp_hide_me +nus_base.group_hide_menus_user See menus hidden from other users (assigned via privilege system)
--++ @@ -418,7 +418,8 @@

Key Models

- + diff --git a/spp_hxl_area/README.rst b/spp_hxl_area/README.rst index 126d5696..f9601899 100644 --- a/spp_hxl_area/README.rst +++ b/spp_hxl_area/README.rst @@ -48,27 +48,27 @@ Key Capabilities Key Models ~~~~~~~~~~ -+--------------------------------+-------------------------------------+ -| Model | Description | -+================================+=====================================+ -| ``spp.hxl.import.profile`` | Configuration defining area | -| | matching and rules | -+--------------------------------+-------------------------------------+ -| ``spp.hxl.aggregation.rule`` | Rule specifying what to aggregate | -| | and how | -+--------------------------------+-------------------------------------+ -| ``spp.hxl.import.batch`` | Track one execution of profile | -| | against HXL file | -+--------------------------------+-------------------------------------+ -| ``spp.hxl.import.mapping`` | Auto-detected column mapping | -| | (adjustable pre-run) | -+--------------------------------+-------------------------------------+ -| ``spp.hxl.area.indicator`` | Aggregated indicator value stored | -| | per area | -+--------------------------------+-------------------------------------+ -| ``spp.hxl.area.import.wizard`` | Wizard for uploading files and | -| | previewing matches | -+--------------------------------+-------------------------------------+ ++--------------------------------+------------------------------------+ +| Model | Description | ++================================+====================================+ +| ``spp.hxl.import.profile`` | Configuration defining area | +| | matching and rules | ++--------------------------------+------------------------------------+ +| ``spp.hxl.aggregation.rule`` | Rule specifying what to aggregate | +| | and how | ++--------------------------------+------------------------------------+ +| ``spp.hxl.import.batch`` | Track one execution of profile | +| | against HXL file | ++--------------------------------+------------------------------------+ +| ``spp.hxl.import.mapping`` | Auto-detected column mapping | +| | (adjustable pre-run) | ++--------------------------------+------------------------------------+ +| ``spp.hxl.area.indicator`` | Aggregated indicator value stored | +| | per area | ++--------------------------------+------------------------------------+ +| ``spp.hxl.area.import.wizard`` | Wizard for uploading files and | +| | previewing matches | ++--------------------------------+------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -94,15 +94,13 @@ UI Location Security ~~~~~~~~ -+----------------------------------+-----------------------------------+ -| Group | Access | -+==================================+===================================+ -| ``spp_security.group_spp_admin`` | Full CRUD on profiles, rules, | -| | indicators | -+----------------------------------+-----------------------------------+ -| ``base.group_user`` | Read profiles/rules; create/edit | -| | batches | -+----------------------------------+-----------------------------------+ ++----------------------------------+------------------------------------------+ +| Group | Access | ++==================================+==========================================+ +| ``spp_security.group_spp_admin`` | Full CRUD on profiles, rules, indicators | ++----------------------------------+------------------------------------------+ +| ``base.group_user`` | Read profiles/rules; create/edit batches | ++----------------------------------+------------------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_hxl_area/static/description/index.html b/spp_hxl_area/static/description/index.html index 1395e3f4..287e92db 100644 --- a/spp_hxl_area/static/description/index.html +++ b/spp_hxl_area/static/description/index.html @@ -397,8 +397,8 @@

Key Capabilities

Key Models

Model Export template defining model and column mapping with HXL tags
spp.hxl.export.profile.column
` +spp.hxl.export.profile.column` Column definition with field path and HXL tag assignment
--++ @@ -459,8 +459,8 @@

UI Location

Security

Model
--++ @@ -469,12 +469,10 @@

Security

- + - +
Group
spp_security.group_spp_adminFull CRUD on profiles, rules, -indicatorsFull CRUD on profiles, rules, indicators
base.group_userRead profiles/rules; create/edit -batchesRead profiles/rules; create/edit batches
diff --git a/spp_key_management/README.rst b/spp_key_management/README.rst index bba27048..3c043c89 100644 --- a/spp_key_management/README.rst +++ b/spp_key_management/README.rst @@ -50,42 +50,43 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------------+----------------------------------+ -| Model | Description | -+=====================================+==================================+ -| ``spp.key.manager`` | Main service interface for all | -| | key operations | -+-------------------------------------+----------------------------------+ -| ``spp.encryption.key`` | Encrypted key storage with | -| | versioning support | -+-------------------------------------+----------------------------------+ -| ``spp.key.provider`` | Abstract base class for key | -| | provider implementations | -+-------------------------------------+----------------------------------+ -| ``spp.key.provider.registry`` | Registry configuring which | -| | provider serves which purpose | -+-------------------------------------+----------------------------------+ -| ``spp.key.purpose`` | Purpose definitions (PII, | -| | financial, credentials, etc) | -+-------------------------------------+----------------------------------+ -| ``spp.asymmetric.key`` | RSA/EC/Ed25519 key pairs for | -| | signing operations | -+-------------------------------------+----------------------------------+ -| ``spp.key.provider.config`` | Configuration file provider | -| | (development) | -+-------------------------------------+----------------------------------+ -| ``spp.key.provider.database`` | Database provider using envelope | -| | encryption | -+-------------------------------------+----------------------------------+ -| ``spp.key.provider.vault`` | HashiCorp Vault integration | -+-------------------------------------+----------------------------------+ -| ``spp.key.provider.aws.kms`` | AWS Key Management Service | -| | integration | -+-------------------------------------+----------------------------------+ -| ``spp.key.provider.gcp.kms`` | Google Cloud KMS integration | -+-------------------------------------+----------------------------------+ -| ``spp.key.provider.azure.keyvault`` | Azure Key Vault integration | -+-------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.key.manager`` | Main service interface for all | +| | key operations | ++----------------------------------+----------------------------------+ +| ``spp.encryption.key`` | Encrypted key storage with | +| | versioning support | ++----------------------------------+----------------------------------+ +| ``spp.key.provider`` | Abstract base class for key | +| | provider implementations | ++----------------------------------+----------------------------------+ +| ``spp.key.provider.registry`` | Registry configuring which | +| | provider serves which purpose | ++----------------------------------+----------------------------------+ +| ``spp.key.purpose`` | Purpose definitions (PII, | +| | financial, credentials, etc) | ++----------------------------------+----------------------------------+ +| ``spp.asymmetric.key`` | RSA/EC/Ed25519 key pairs for | +| | signing operations | ++----------------------------------+----------------------------------+ +| ``spp.key.provider.config`` | Configuration file provider | +| | (development) | ++----------------------------------+----------------------------------+ +| ``spp.key.provider.database`` | Database provider using envelope | +| | encryption | ++----------------------------------+----------------------------------+ +| ``spp.key.provider.vault`` | HashiCorp Vault integration | ++----------------------------------+----------------------------------+ +| ``spp.key.provider.aws.kms`` | AWS Key Management Service | +| | integration | ++----------------------------------+----------------------------------+ +| ``spp.key.provider.gcp.kms`` | Google Cloud KMS integration | ++----------------------------------+----------------------------------+ +| ``s | Azure Key Vault integration | +| pp.key.provider.azure.keyvault`` | | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -118,18 +119,18 @@ UI Location Security ~~~~~~~~ -+---------------------------------------------------+----------------------------------+ -| Group | Access | -+===================================================+==================================+ -| ``spp_key_management.group_key_admin`` | Read/Write/Create on all models, | -| | key rotation | -+---------------------------------------------------+----------------------------------+ -| ``spp_key_management.group_key_operator_officer`` | Read encryption keys for use in | -| | operations | -+---------------------------------------------------+----------------------------------+ -| ``base.group_system`` | Full access to all key | -| | management features | -+---------------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_ | Read/Write/Create on all models, | +| key_management.group_key_admin`` | key rotation | ++----------------------------------+----------------------------------+ +| ``spp_key_managem | Read encryption keys for use in | +| ent.group_key_operator_officer`` | operations | ++----------------------------------+----------------------------------+ +| ``base.group_system`` | Full access to all key | +| | management features | ++----------------------------------+----------------------------------+ Encryption keys and asymmetric keys cannot be deleted (enforced by Python ``unlink()`` override). All key access operations are logged with diff --git a/spp_key_management/static/description/index.html b/spp_key_management/static/description/index.html index 9e3047ff..292bd49e 100644 --- a/spp_key_management/static/description/index.html +++ b/spp_key_management/static/description/index.html @@ -399,8 +399,8 @@

Key Capabilities

Key Models

--++ @@ -450,7 +450,8 @@

Key Models

- + @@ -490,8 +491,8 @@

UI Location

Security

Model
spp.key.provider.gcp.kms Google Cloud KMS integration
spp.key.provider.azure.keyvault
s +pp.key.provider.azure.keyvault Azure Key Vault integration
--++ @@ -499,11 +500,13 @@

Security

- + - + diff --git a/spp_programs/README.rst b/spp_programs/README.rst index ea6f8ce3..ba5c6b74 100644 --- a/spp_programs/README.rst +++ b/spp_programs/README.rst @@ -56,95 +56,95 @@ Key Capabilities Key Models ~~~~~~~~~~ -+---------------------------------------------+----------------------------------+ -| Model | Description | -+=============================================+==================================+ -| ``spp.program`` | Main program with managers, | -| | target type, and funding | -+---------------------------------------------+----------------------------------+ -| ``spp.cycle`` | Time-bound distribution cycle | -| | within a program | -+---------------------------------------------+----------------------------------+ -| ``spp.program.membership`` | Enrolls registrant in program | -| | with state tracking | -+---------------------------------------------+----------------------------------+ -| ``spp.cycle.membership`` | Links registrant to specific | -| | cycle for entitlement prep | -+---------------------------------------------+----------------------------------+ -| ``spp.entitlement`` | Cash entitlement with approval | -| | workflow | -+---------------------------------------------+----------------------------------+ -| ``spp.entitlement.inkind`` | In-kind entitlement with | -| | product, quantity, warehouse | -+---------------------------------------------+----------------------------------+ -| ``spp.payment`` | Individual payment linked to | -| | cash entitlement | -+---------------------------------------------+----------------------------------+ -| ``spp.payment.batch`` | Groups payments for batch | -| | processing and reconciliation | -+---------------------------------------------+----------------------------------+ -| ``spp.payment.batch.tag`` | Tags for categorizing payment | -| | batches | -+---------------------------------------------+----------------------------------+ -| ``spp.eligibility.manager`` | Wrapper for eligibility manager | -| | implementations | -+---------------------------------------------+----------------------------------+ -| ``spp.program.membership.manager`` | Base eligibility manager | -| | (abstract) | -+---------------------------------------------+----------------------------------+ -| ``spp.program.membership.manager.default`` | Default eligibility | -| | implementation | -+---------------------------------------------+----------------------------------+ -| ``spp.deduplication.manager`` | Wrapper for deduplication | -| | manager implementations | -+---------------------------------------------+----------------------------------+ -| ``spp.program.notification.manager`` | Notification manager for | -| | beneficiary communications | -+---------------------------------------------+----------------------------------+ -| ``spp.program.manager`` | Wrapper for program lifecycle | -| | manager implementations | -+---------------------------------------------+----------------------------------+ -| ``spp.program.manager.default`` | Default program manager | -| | implementation | -+---------------------------------------------+----------------------------------+ -| ``spp.cycle.manager`` | Wrapper for cycle manager | -| | implementations | -+---------------------------------------------+----------------------------------+ -| ``spp.cycle.manager.default`` | Default cycle manager | -| | implementation | -+---------------------------------------------+----------------------------------+ -| ``spp.program.entitlement.manager`` | Wrapper for entitlement manager | -| | implementations | -+---------------------------------------------+----------------------------------+ -| ``spp.program.entitlement.manager.default`` | Default entitlement manager | -| | implementation | -+---------------------------------------------+----------------------------------+ -| ``spp.program.entitlement.manager.cash`` | Cash entitlement manager with | -| | amount calculation | -+---------------------------------------------+----------------------------------+ -| ``spp.program.entitlement.manager.inkind`` | In-kind entitlement manager with | -| | product configuration | -+---------------------------------------------+----------------------------------+ -| ``spp.program.payment.manager`` | Wrapper for payment manager | -| | implementations | -+---------------------------------------------+----------------------------------+ -| ``spp.program.payment.manager.default`` | Default payment manager | -| | implementation | -+---------------------------------------------+----------------------------------+ -| ``spp.compliance.manager`` | Wrapper for compliance manager | -| | implementations | -+---------------------------------------------+----------------------------------+ -| ``spp.compliance.manager.default`` | Default compliance manager with | -| | CEL support | -+---------------------------------------------+----------------------------------+ -| ``spp.program.fund`` | Tracks program budget and fund | -| | utilization | -+---------------------------------------------+----------------------------------+ -| ``spp.program.fund.report.view`` | Fund balance reporting view | -+---------------------------------------------+----------------------------------+ -| ``spp.program.membership.duplicate`` | Tracks duplicate membership | -| | records | -+---------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.program`` | Main program with managers, | +| | target type, and funding | ++----------------------------------+----------------------------------+ +| ``spp.cycle`` | Time-bound distribution cycle | +| | within a program | ++----------------------------------+----------------------------------+ +| ``spp.program.membership`` | Enrolls registrant in program | +| | with state tracking | ++----------------------------------+----------------------------------+ +| ``spp.cycle.membership`` | Links registrant to specific | +| | cycle for entitlement prep | ++----------------------------------+----------------------------------+ +| ``spp.entitlement`` | Cash entitlement with approval | +| | workflow | ++----------------------------------+----------------------------------+ +| ``spp.entitlement.inkind`` | In-kind entitlement with | +| | product, quantity, warehouse | ++----------------------------------+----------------------------------+ +| ``spp.payment`` | Individual payment linked to | +| | cash entitlement | ++----------------------------------+----------------------------------+ +| ``spp.payment.batch`` | Groups payments for batch | +| | processing and reconciliation | ++----------------------------------+----------------------------------+ +| ``spp.payment.batch.tag`` | Tags for categorizing payment | +| | batches | ++----------------------------------+----------------------------------+ +| ``spp.eligibility.manager`` | Wrapper for eligibility manager | +| | implementations | ++----------------------------------+----------------------------------+ +| `` | Base eligibility manager | +| spp.program.membership.manager`` | (abstract) | ++----------------------------------+----------------------------------+ +| ``spp.prog | Default eligibility | +| ram.membership.manager.default`` | implementation | ++----------------------------------+----------------------------------+ +| ``spp.deduplication.manager`` | Wrapper for deduplication | +| | manager implementations | ++----------------------------------+----------------------------------+ +| ``sp | Notification manager for | +| p.program.notification.manager`` | beneficiary communications | ++----------------------------------+----------------------------------+ +| ``spp.program.manager`` | Wrapper for program lifecycle | +| | manager implementations | ++----------------------------------+----------------------------------+ +| ``spp.program.manager.default`` | Default program manager | +| | implementation | ++----------------------------------+----------------------------------+ +| ``spp.cycle.manager`` | Wrapper for cycle manager | +| | implementations | ++----------------------------------+----------------------------------+ +| ``spp.cycle.manager.default`` | Default cycle manager | +| | implementation | ++----------------------------------+----------------------------------+ +| ``s | Wrapper for entitlement manager | +| pp.program.entitlement.manager`` | implementations | ++----------------------------------+----------------------------------+ +| ``spp.progr | Default entitlement manager | +| am.entitlement.manager.default`` | implementation | ++----------------------------------+----------------------------------+ +| ``spp.pr | Cash entitlement manager with | +| ogram.entitlement.manager.cash`` | amount calculation | ++----------------------------------+----------------------------------+ +| ``spp.prog | In-kind entitlement manager with | +| ram.entitlement.manager.inkind`` | product configuration | ++----------------------------------+----------------------------------+ +| ``spp.program.payment.manager`` | Wrapper for payment manager | +| | implementations | ++----------------------------------+----------------------------------+ +| ``spp.p | Default payment manager | +| rogram.payment.manager.default`` | implementation | ++----------------------------------+----------------------------------+ +| ``spp.compliance.manager`` | Wrapper for compliance manager | +| | implementations | ++----------------------------------+----------------------------------+ +| `` | Default compliance manager with | +| spp.compliance.manager.default`` | CEL support | ++----------------------------------+----------------------------------+ +| ``spp.program.fund`` | Tracks program budget and fund | +| | utilization | ++----------------------------------+----------------------------------+ +| ``spp.program.fund.report.view`` | Fund balance reporting view | ++----------------------------------+----------------------------------+ +| ``sp | Tracks duplicate membership | +| p.program.membership.duplicate`` | records | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -192,29 +192,30 @@ UI Location Security ~~~~~~~~ -+------------------------------------------------+----------------------------------+ -| Group | Access | -+================================================+==================================+ -| ``spp_programs.group_programs_viewer`` | Read-only on all program data | -+------------------------------------------------+----------------------------------+ -| ``spp_programs.group_programs_officer`` | Read/write/create on all models | -| | (no delete) | -+------------------------------------------------+----------------------------------+ -| ``spp_programs.group_programs_manager`` | Full CRUD on cycles and | -| | memberships, RWC on programs (no | -| | program delete) | -+------------------------------------------------+----------------------------------+ -| ``spp_programs.group_programs_validator`` | Read/write/create on | -| | entitlements and cycles (finance | -| | validation role) | -+------------------------------------------------+----------------------------------+ -| ``spp_programs.group_programs_cycle_approver`` | Read/write/create on | -| | entitlements and cycles | -| | (approval role) | -+------------------------------------------------+----------------------------------+ -| ``spp_programs.group_programs_rejector`` | Read/write/create on | -| | entitlements (rejection role) | -+------------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_ | Read-only on all program data | +| programs.group_programs_viewer`` | | ++----------------------------------+----------------------------------+ +| ``spp_p | Read/write/create on all models | +| rograms.group_programs_officer`` | (no delete) | ++----------------------------------+----------------------------------+ +| ``spp_p | Full CRUD on cycles and | +| rograms.group_programs_manager`` | memberships, RWC on programs (no | +| | program delete) | ++----------------------------------+----------------------------------+ +| ``spp_pro | Read/write/create on | +| grams.group_programs_validator`` | entitlements and cycles (finance | +| | validation role) | ++----------------------------------+----------------------------------+ +| ``spp_programs | Read/write/create on | +| .group_programs_cycle_approver`` | entitlements and cycles | +| | (approval role) | ++----------------------------------+----------------------------------+ +| ``spp_pr | Read/write/create on | +| ograms.group_programs_rejector`` | entitlements (rejection role) | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_programs/static/description/index.html b/spp_programs/static/description/index.html index 0ec885d5..df51b76b 100644 --- a/spp_programs/static/description/index.html +++ b/spp_programs/static/description/index.html @@ -405,8 +405,8 @@

Key Capabilities

Key Models

Group
spp_key_management.group_key_admin
spp_ +key_management.group_key_admin Read/Write/Create on all models, key rotation
spp_key_management.group_key_operator_officer
spp_key_managem +ent.group_key_operator_officer Read encryption keys for use in operations
--++ @@ -454,11 +454,13 @@

Key Models

- + - + @@ -466,7 +468,8 @@

Key Models

- + @@ -486,19 +489,23 @@

Key Models

- + - + - + - + @@ -506,7 +513,8 @@

Key Models

- + @@ -514,7 +522,8 @@

Key Models

- + @@ -525,7 +534,8 @@

Key Models

- + @@ -580,8 +590,8 @@

UI Location

Security

Model Wrapper for eligibility manager implementations
spp.program.membership.manager
`` +spp.program.membership.manager`` Base eligibility manager (abstract)
spp.program.membership.manager.default
spp.prog +ram.membership.manager.default Default eligibility implementation
Wrapper for deduplication manager implementations
spp.program.notification.manager
sp +p.program.notification.manager Notification manager for beneficiary communications
Default cycle manager implementation
spp.program.entitlement.manager
s +pp.program.entitlement.manager Wrapper for entitlement manager implementations
spp.program.entitlement.manager.default
spp.progr +am.entitlement.manager.default Default entitlement manager implementation
spp.program.entitlement.manager.cash
spp.pr +ogram.entitlement.manager.cash Cash entitlement manager with amount calculation
spp.program.entitlement.manager.inkind
spp.prog +ram.entitlement.manager.inkind In-kind entitlement manager with product configuration
Wrapper for payment manager implementations
spp.program.payment.manager.default
spp.p +rogram.payment.manager.default Default payment manager implementation
Wrapper for compliance manager implementations
spp.compliance.manager.default
`` +spp.compliance.manager.default`` Default compliance manager with CEL support
spp.program.fund.report.view Fund balance reporting view
spp.program.membership.duplicate
sp +p.program.membership.duplicate Tracks duplicate membership records
--++ @@ -589,29 +599,35 @@

Security

- + - + - + - + - + - + diff --git a/spp_registry/README.rst b/spp_registry/README.rst index 7b7a5c73..59fb32fe 100644 --- a/spp_registry/README.rst +++ b/spp_registry/README.rst @@ -47,27 +47,28 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``res.partner`` | Extended for registrant management | -| | (individuals/groups) | -+-------------------------------+--------------------------------------+ -| ``spp.group.membership`` | Links individuals to groups with | -| | roles and dates | -+-------------------------------+--------------------------------------+ -| ``spp.registry.id`` | ID documents attached to registrants | -+-------------------------------+--------------------------------------+ -| ``spp.id.type`` | ID type definitions with validation | -| | rules | -+-------------------------------+--------------------------------------+ -| ``spp.registry.relationship`` | Relationships between registrants | -+-------------------------------+--------------------------------------+ -| ``spp.relationship`` | Relationship type definitions | -+-------------------------------+--------------------------------------+ -| ``spp.phone.number`` | Phone numbers with country-based | -| | validation | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``res.partner`` | Extended for registrant management | +| | (individuals/groups) | ++-------------------------------+-------------------------------------+ +| ``spp.group.membership`` | Links individuals to groups with | +| | roles and dates | ++-------------------------------+-------------------------------------+ +| ``spp.registry.id`` | ID documents attached to | +| | registrants | ++-------------------------------+-------------------------------------+ +| ``spp.id.type`` | ID type definitions with validation | +| | rules | ++-------------------------------+-------------------------------------+ +| ``spp.registry.relationship`` | Relationships between registrants | ++-------------------------------+-------------------------------------+ +| ``spp.relationship`` | Relationship type definitions | ++-------------------------------+-------------------------------------+ +| ``spp.phone.number`` | Phone numbers with country-based | +| | validation | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -100,17 +101,21 @@ modules (e.g., ``spp_base_demo``). Security ~~~~~~~~ -+----------------------------------------------+-------------------------------+ -| Group | Access | -+==============================================+===============================+ -| ``spp_registry.group_registry_viewer`` | Read-only | -+----------------------------------------------+-------------------------------+ -| ``spp_registry.group_registry_officer`` | Read/Write/Create (no delete) | -+----------------------------------------------+-------------------------------+ -| ``spp_registry.group_registry_manager`` | Full CRUD | -+----------------------------------------------+-------------------------------+ -| ``spp_registry.group_registry_config_admin`` | Configuration menu access | -+----------------------------------------------+-------------------------------+ ++-------------------------------------+-------------------------------+ +| Group | Access | ++=====================================+===============================+ +| ``s | Read-only | +| pp_registry.group_registry_viewer`` | | ++-------------------------------------+-------------------------------+ +| ``sp | Read/Write/Create (no delete) | +| p_registry.group_registry_officer`` | | ++-------------------------------------+-------------------------------+ +| ``sp | Full CRUD | +| p_registry.group_registry_manager`` | | ++-------------------------------------+-------------------------------+ +| ``spp_reg | Configuration menu access | +| istry.group_registry_config_admin`` | | ++-------------------------------------+-------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_registry/static/description/index.html b/spp_registry/static/description/index.html index 2d0741b9..65d37c79 100644 --- a/spp_registry/static/description/index.html +++ b/spp_registry/static/description/index.html @@ -396,8 +396,8 @@

Key Capabilities

Key Models

Group
spp_programs.group_programs_viewer
spp_ +programs.group_programs_viewer Read-only on all program data
spp_programs.group_programs_officer
spp_p +rograms.group_programs_officer Read/write/create on all models (no delete)
spp_programs.group_programs_manager
spp_p +rograms.group_programs_manager Full CRUD on cycles and memberships, RWC on programs (no program delete)
spp_programs.group_programs_validator
spp_pro +grams.group_programs_validator Read/write/create on entitlements and cycles (finance validation role)
spp_programs.group_programs_cycle_approver
spp_programs +.group_programs_cycle_approver Read/write/create on entitlements and cycles (approval role)
spp_programs.group_programs_rejector
spp_pr +ograms.group_programs_rejector Read/write/create on entitlements (rejection role)
--++ @@ -414,7 +414,8 @@

Key Models

roles and dates - + - + @@ -451,8 +451,8 @@

UI Location

Security

Model
spp.registry.idID documents attached to registrantsID documents attached to +registrants
spp.id.type ID type definitions with validation @@ -465,8 +466,8 @@

UI Location

Security

--++ @@ -474,16 +475,20 @@

Security

- + - + - + - + diff --git a/spp_registry_search/README.rst b/spp_registry_search/README.rst index d2100bc9..44b7f7eb 100644 --- a/spp_registry_search/README.rst +++ b/spp_registry_search/README.rst @@ -46,15 +46,15 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.registry.view.history`` | Tracks user's recently viewed | -| | registrants with timestamps | -+-------------------------------+--------------------------------------+ -| ``res.partner`` (extended) | Adds view tracking on form open and | -| | archive restrictions | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.registry.view.history`` | Tracks user's recently viewed | +| | registrants with timestamps | ++-------------------------------+-------------------------------------+ +| ``res.partner`` (extended) | Adds view tracking on form open and | +| | archive restrictions | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -81,16 +81,16 @@ UI Location Security ~~~~~~~~ -+-------------------------------------------------------+----------------------------------+ -| Group | Access | -+=======================================================+==================================+ -| ``spp_registry.group_registry_read`` | Full CRUD on view history | -| | (restricted to own records via | -| | IR rule) | -+-------------------------------------------------------+----------------------------------+ -| ``spp_registry_search.group_registry_search_auditor`` | Bypass search requirement, | -| | access browse-all menus | -+-------------------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``sp | Full CRUD on view history | +| p_registry.group_registry_read`` | (restricted to own records via | +| | IR rule) | ++----------------------------------+----------------------------------+ +| ``spp_registry_search | Bypass search requirement, | +| .group_registry_search_auditor`` | access browse-all menus | ++----------------------------------+----------------------------------+ Archive/unarchive permission check enforces these groups: diff --git a/spp_registry_search/static/description/index.html b/spp_registry_search/static/description/index.html index 3f766f8d..de068884 100644 --- a/spp_registry_search/static/description/index.html +++ b/spp_registry_search/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

Group
spp_registry.group_registry_viewer
s +pp_registry.group_registry_viewer Read-only
spp_registry.group_registry_officer
sp +p_registry.group_registry_officer Read/Write/Create (no delete)
spp_registry.group_registry_manager
sp +p_registry.group_registry_manager Full CRUD
spp_registry.group_registry_config_admin
spp_reg +istry.group_registry_config_admin Configuration menu access
--++ @@ -442,8 +442,8 @@

UI Location

Security

Model
--++ @@ -451,12 +451,14 @@

Security

- + - + diff --git a/spp_security/README.rst b/spp_security/README.rst index 32cbcd8b..0137751e 100644 --- a/spp_security/README.rst +++ b/spp_security/README.rst @@ -1,13 +1,17 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + ================ OpenSPP Security ================ -.. +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! - !! source digest: sha256:c840abe0695f0616775f34c46ab40c1e7bdf851d59940cc72b8ebcbba0860a30 + !! source digest: sha256:4e2e68cbd15f17068de9438997aa8a298a5d06d9b2578787860e2c88429c1247 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! .. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png @@ -59,17 +63,17 @@ This module defines no model access rights (empty ``ir.model.access.csv``). It provides only security groups and record rules. -+-----------------------+--------------------------------+----------------------+ -| Group | XML ID | Purpose | -+=======================+================================+======================+ -| Administrator | ``group_spp_admin`` | Inherits all manager | -| | | permissions from all | -| | | domains | -+-----------------------+--------------------------------+----------------------+ -| Restricted: Self Only | ``group_access_restrict_self`` | Restricts users to | -| | | viewing only their | -| | | own record | -+-----------------------+--------------------------------+----------------------+ ++----------------------+----------------------+----------------------+ +| Group | XML ID | Purpose | ++======================+======================+======================+ +| Administrator | ``group_spp_admin`` | Inherits all manager | +| | | permissions from all | +| | | domains | ++----------------------+----------------------+----------------------+ +| Restricted: Self | ``group_ac | Restricts users to | +| Only | cess_restrict_self`` | viewing only their | +| | | own record | ++----------------------+----------------------+----------------------+ Record rules: @@ -171,4 +175,4 @@ Current maintainers: This module is part of the `OpenSPP/OpenSPP2 `_ project on GitHub. -You are welcome to contribute. \ No newline at end of file +You are welcome to contribute. diff --git a/spp_security/security/categories.xml b/spp_security/security/categories.xml index 134e3ae7..849828a8 100644 --- a/spp_security/security/categories.xml +++ b/spp_security/security/categories.xml @@ -120,9 +120,9 @@ 77 - + - Hazard & Emergency + Hazard and Emergency Hazard classification, incident tracking, and impact assessment diff --git a/spp_security/static/description/index.html b/spp_security/static/description/index.html index fc413cf3..14ac4bb5 100644 --- a/spp_security/static/description/index.html +++ b/spp_security/static/description/index.html @@ -3,7 +3,7 @@ -OpenSPP Security +README.rst -
-

OpenSPP Security

+
+ + +Odoo Community Association + +
+

OpenSPP Security

Production/Stable License: LGPL-3 OpenSPP/OpenSPP2

Foundation security infrastructure for OpenSPP modules. Defines 22 @@ -376,7 +381,7 @@

OpenSPP Security

privilege framework. Domain modules register their security groups within these predefined categories.

-

Key Capabilities

+

Key Capabilities

  • Define 22 domain-specific security categories (Registry, Programs, Entitlements, GRM, etc.) organizing security groups in user settings @@ -393,22 +398,22 @@

    Key Capabilities

-

Configuration

+

Configuration

No configuration required. This module provides infrastructure only. When domain modules are installed, their security groups automatically appear under the appropriate category in Settings > Users & Companies > Users.

-

Security

+

Security

This module defines no model access rights (empty ir.model.access.csv). It provides only security groups and record rules.

Group
spp_registry.group_registry_read
sp +p_registry.group_registry_read Full CRUD on view history (restricted to own records via IR rule)
spp_registry_search.group_registry_search_auditor
spp_registry_search +.group_registry_search_auditor Bypass search requirement, access browse-all menus
---+++ @@ -423,8 +428,10 @@

Security

permissions from all domains - - + + @@ -440,7 +447,7 @@

Security

-

Extension Points

+

Extension Points

Domain modules must follow this pattern to integrate with the security framework:

    @@ -460,7 +467,7 @@

    Extension Points

-

Available Categories

+

Available Categories

Administration: category_spp_admin

Domain categories: category_spp_registry, category_spp_programs, category_spp_scoring, category_spp_entitlements, @@ -476,14 +483,14 @@

Available Categories

appear when domain modules install groups under them.

-

Architecture

+

Architecture

Categories are centrally defined in spp_security but security groups are distributed to domain modules. This design ensures groups only exist when their domain module is installed, preventing UI clutter from unused permissions and enabling flexible installation combinations.

-

Dependencies

+

Dependencies

base

Table of contents

@@ -497,7 +504,7 @@

Dependencies

-

Bug Tracker

+

Bug Tracker

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 @@ -505,15 +512,15 @@

Bug Tracker

Do not contact contributors directly about support or help with technical issues.

-

Credits

+

Credits

-

Authors

+

Authors

  • OpenSPP.org
-

Maintainers

+

Maintainers

Current maintainers:

jeremi gonzalesedwin1123

This module is part of the OpenSPP/OpenSPP2 project on GitHub.

@@ -522,5 +529,6 @@

Maintainers

+ diff --git a/spp_service_points/README.rst b/spp_service_points/README.rst index 477a0e2c..52c4c304 100644 --- a/spp_service_points/README.rst +++ b/spp_service_points/README.rst @@ -48,25 +48,23 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-----------------------+----------------------------------------------+ -| Model | Description | -+=======================+==============================================+ -| ``spp.service.point`` | Service delivery location with area | -| | assignment and type classification | -+-----------------------+----------------------------------------------+ ++-----------------------+---------------------------------------------+ +| Model | Description | ++=======================+=============================================+ +| ``spp.service.point`` | Service delivery location with area | +| | assignment and type classification | ++-----------------------+---------------------------------------------+ Extends ~~~~~~~ -+-----------------+----------------------------------------------------+ -| Model | Fields Added | -+=================+====================================================+ -| ``res.partner`` | ``service_point_ids``, | -| | ``individual_service_points_ids`` | -+-----------------+----------------------------------------------------+ -| ``res.users`` | ``service_point_ids`` (related to partner service | -| | points) | -+-----------------+----------------------------------------------------+ ++-----------------+-----------------------------------------------------------+ +| Model | Fields Added | ++=================+===========================================================+ +| ``res.partner`` | ``service_point_ids``, ``individual_service_points_ids`` | ++-----------------+-----------------------------------------------------------+ +| ``res.users`` | ``service_point_ids`` (related to partner service points) | ++-----------------+-----------------------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_service_points/static/description/index.html b/spp_service_points/static/description/index.html index eaa7400c..03ae24d5 100644 --- a/spp_service_points/static/description/index.html +++ b/spp_service_points/static/description/index.html @@ -397,8 +397,8 @@

Key Capabilities

Key Models

Group
Restricted: Self Onlygroup_access_restrict_self
Restricted: Self +Onlygroup_ac +cess_restrict_self Restricts users to viewing only their own record
--++ @@ -417,8 +417,8 @@

Key Models

Extends

Model
--++ @@ -427,12 +427,10 @@

Extends

- + - +
Model
res.partnerservice_point_ids, -individual_service_points_idsservice_point_ids, individual_service_points_ids
res.usersservice_point_ids (related to partner service -points)service_point_ids (related to partner service points)
diff --git a/spp_session_tracking/README.rst b/spp_session_tracking/README.rst index 163d9544..b8dc8653 100644 --- a/spp_session_tracking/README.rst +++ b/spp_session_tracking/README.rst @@ -47,20 +47,20 @@ Key Capabilities Key Models ~~~~~~~~~~ -+----------------------------+-----------------------------------------+ -| Model | Description | -+============================+=========================================+ -| ``spp.session.type`` | Session type definition with attendance | -| | requirements | -+----------------------------+-----------------------------------------+ -| ``spp.session.topic`` | Topics that can be covered in sessions | -+----------------------------+-----------------------------------------+ -| ``spp.session`` | Session instance with facilitator, | -| | participants, and date | -+----------------------------+-----------------------------------------+ -| ``spp.session.attendance`` | Attendance record for a participant at | -| | a session | -+----------------------------+-----------------------------------------+ ++----------------------------+----------------------------------------+ +| Model | Description | ++============================+========================================+ +| ``spp.session.type`` | Session type definition with | +| | attendance requirements | ++----------------------------+----------------------------------------+ +| ``spp.session.topic`` | Topics that can be covered in sessions | ++----------------------------+----------------------------------------+ +| ``spp.session`` | Session instance with facilitator, | +| | participants, and date | ++----------------------------+----------------------------------------+ +| ``spp.session.attendance`` | Attendance record for a participant at | +| | a session | ++----------------------------+----------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -89,18 +89,18 @@ UI Location Security ~~~~~~~~ -+------------------------------------------------+----------------------------------+ -| Group | Access | -+================================================+==================================+ -| ``spp_session_tracking.group_session_user`` | Read all sessions and session | -| | types/topics; write own | -| | facilitated sessions; | -| | read/write/create attendance (no | -| | delete) | -+------------------------------------------------+----------------------------------+ -| ``spp_session_tracking.group_session_manager`` | Full CRUD on all sessions, | -| | types, topics, and attendance | -+------------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_sessi | Read all sessions and session | +| on_tracking.group_session_user`` | types/topics; write own | +| | facilitated sessions; | +| | read/write/create attendance (no | +| | delete) | ++----------------------------------+----------------------------------+ +| ``spp_session_ | Full CRUD on all sessions, | +| tracking.group_session_manager`` | types, topics, and attendance | ++----------------------------------+----------------------------------+ The session user group can view all sessions but only edit sessions they facilitate (via record rule). The ``spp_security.group_spp_admin`` group diff --git a/spp_session_tracking/static/description/index.html b/spp_session_tracking/static/description/index.html index 4b682d2f..e5b7d74b 100644 --- a/spp_session_tracking/static/description/index.html +++ b/spp_session_tracking/static/description/index.html @@ -406,8 +406,8 @@

Key Models
spp.session.typeSession type definition with attendance -requirementsSession type definition with +attendance requirements
spp.session.topic Topics that can be covered in sessions
--++ @@ -460,14 +460,16 @@

Security

- + - + diff --git a/spp_simulation/README.rst b/spp_simulation/README.rst index 779bbd3a..a8b71710 100644 --- a/spp_simulation/README.rst +++ b/spp_simulation/README.rst @@ -56,23 +56,24 @@ individual beneficiary records are persisted in simulation results. Models ------ -+--------------------------------------+----------------------------------+ -| Model | Description | -+======================================+==================================+ -| ``spp.simulation.scenario.template`` | Pre-built targeting scenario | -| | templates | -+--------------------------------------+----------------------------------+ -| ``spp.simulation.scenario`` | Targeting scenario definitions | -+--------------------------------------+----------------------------------+ -| ``spp.simulation.entitlement.rule`` | Amount calculation rules | -+--------------------------------------+----------------------------------+ -| ``spp.simulation.run`` | Aggregated simulation results | -| | (non-deletable) | -+--------------------------------------+----------------------------------+ -| ``spp.simulation.comparison`` | Side-by-side run comparisons | -+--------------------------------------+----------------------------------+ -| ``spp.simulation.metric`` | Custom evaluation metrics | -+--------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``sp | Pre-built targeting scenario | +| p.simulation.scenario.template`` | templates | ++----------------------------------+----------------------------------+ +| ``spp.simulation.scenario`` | Targeting scenario definitions | ++----------------------------------+----------------------------------+ +| ``s | Amount calculation rules | +| pp.simulation.entitlement.rule`` | | ++----------------------------------+----------------------------------+ +| ``spp.simulation.run`` | Aggregated simulation results | +| | (non-deletable) | ++----------------------------------+----------------------------------+ +| ``spp.simulation.comparison`` | Side-by-side run comparisons | ++----------------------------------+----------------------------------+ +| ``spp.simulation.metric`` | Custom evaluation metrics | ++----------------------------------+----------------------------------+ Security Groups --------------- diff --git a/spp_simulation/static/description/index.html b/spp_simulation/static/description/index.html index 5a13b8d7..b8f59a4f 100644 --- a/spp_simulation/static/description/index.html +++ b/spp_simulation/static/description/index.html @@ -403,8 +403,8 @@

Privacy

Models

Group
spp_session_tracking.group_session_user
spp_sessi +on_tracking.group_session_user Read all sessions and session types/topics; write own facilitated sessions; read/write/create attendance (no delete)
spp_session_tracking.group_session_manager
spp_session_ +tracking.group_session_manager Full CRUD on all sessions, types, topics, and attendance
--++ @@ -412,14 +412,16 @@

Models

- + - + diff --git a/spp_source_tracking/README.rst b/spp_source_tracking/README.rst index ea38c1ec..5077f759 100644 --- a/spp_source_tracking/README.rst +++ b/spp_source_tracking/README.rst @@ -47,24 +47,24 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.mixin.source.tracking`` | Abstract mixin providing source | -| | tracking fields | -+-------------------------------+--------------------------------------+ -| ``spp.merge.provenance`` | Audit record of merge operations | -| | with data snapshots | -+-------------------------------+--------------------------------------+ -| ``res.partner`` | Extended with source tracking and | -| | merge capabilities | -+-------------------------------+--------------------------------------+ -| ``spp.registry.id`` | Extended with source tracking for | -| | identifier provenance | -+-------------------------------+--------------------------------------+ -| ``spp.program.membership`` | Extended with source tracking for | -| | enrollment provenance | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.mixin.source.tracking`` | Abstract mixin providing source | +| | tracking fields | ++-------------------------------+-------------------------------------+ +| ``spp.merge.provenance`` | Audit record of merge operations | +| | with data snapshots | ++-------------------------------+-------------------------------------+ +| ``res.partner`` | Extended with source tracking and | +| | merge capabilities | ++-------------------------------+-------------------------------------+ +| ``spp.registry.id`` | Extended with source tracking for | +| | identifier provenance | ++-------------------------------+-------------------------------------+ +| ``spp.program.membership`` | Extended with source tracking for | +| | enrollment provenance | ++-------------------------------+-------------------------------------+ UI Location ~~~~~~~~~~~ diff --git a/spp_source_tracking/static/description/index.html b/spp_source_tracking/static/description/index.html index 5a333f77..c32bead4 100644 --- a/spp_source_tracking/static/description/index.html +++ b/spp_source_tracking/static/description/index.html @@ -396,8 +396,8 @@

Key Capabilities

Key Models

Model
spp.simulation.scenario.template
sp +p.simulation.scenario.template Pre-built targeting scenario templates
spp.simulation.scenario Targeting scenario definitions
spp.simulation.entitlement.rule
s +pp.simulation.entitlement.rule Amount calculation rules
spp.simulation.run
--++ diff --git a/spp_starter_sp_mis/README.rst b/spp_starter_sp_mis/README.rst index 19fcc696..de494cd9 100644 --- a/spp_starter_sp_mis/README.rst +++ b/spp_starter_sp_mis/README.rst @@ -46,12 +46,12 @@ Key Models This module defines no models. It extends: -+-------------------------+--------------------------------------------+ -| Model | Extension | -+=========================+============================================+ -| ``res.config.settings`` | Adds ``is_registry_admin_only_crud`` | -| | boolean field | -+-------------------------+--------------------------------------------+ ++-------------------------+-------------------------------------------+ +| Model | Extension | ++=========================+===========================================+ +| ``res.config.settings`` | Adds ``is_registry_admin_only_crud`` | +| | boolean field | ++-------------------------+-------------------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_starter_sp_mis/static/description/index.html b/spp_starter_sp_mis/static/description/index.html index e6a17de3..bfd332ab 100644 --- a/spp_starter_sp_mis/static/description/index.html +++ b/spp_starter_sp_mis/static/description/index.html @@ -394,8 +394,8 @@

Key Models

This module defines no models. It extends:

Model
--++ diff --git a/spp_studio/README.rst b/spp_studio/README.rst index 6766292c..7273bf1d 100644 --- a/spp_studio/README.rst +++ b/spp_studio/README.rst @@ -48,41 +48,41 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------------+--------------------------------------+ -| Model | Description | -+===============================+======================================+ -| ``spp.cel.expression`` | Business logic definitions with CEL | -| | expressions | -+-------------------------------+--------------------------------------+ -| ``spp.cel.variable`` | Variable definitions for use in | -| | expressions | -+-------------------------------+--------------------------------------+ -| ``spp.cel.variable.category`` | Categories for organizing variables | -+-------------------------------+--------------------------------------+ -| ``spp.studio.field`` | Custom field definitions for | -| | registry extension | -+-------------------------------+--------------------------------------+ -| ``spp.studio.pack`` | Pre-built logic bundles for common | -| | use cases | -+-------------------------------+--------------------------------------+ -| ``spp.studio.pack.item`` | Individual logic definitions within | -| | a pack | -+-------------------------------+--------------------------------------+ -| ``spp.studio.test`` | Test cases for validating logic | -| | expressions | -+-------------------------------+--------------------------------------+ -| ``spp.studio.test.persona`` | Test personas with example data for | -| | logic validation | -+-------------------------------+--------------------------------------+ -| ``spp.studio.placement.zone`` | Form zones where custom fields can | -| | be placed | -+-------------------------------+--------------------------------------+ -| ``spp.studio.version`` | Version history tracking for logic | -| | changes | -+-------------------------------+--------------------------------------+ -| ``spp.studio.usage`` | Usage tracking for logic and field | -| | references | -+-------------------------------+--------------------------------------+ ++-------------------------------+-------------------------------------+ +| Model | Description | ++===============================+=====================================+ +| ``spp.cel.expression`` | Business logic definitions with CEL | +| | expressions | ++-------------------------------+-------------------------------------+ +| ``spp.cel.variable`` | Variable definitions for use in | +| | expressions | ++-------------------------------+-------------------------------------+ +| ``spp.cel.variable.category`` | Categories for organizing variables | ++-------------------------------+-------------------------------------+ +| ``spp.studio.field`` | Custom field definitions for | +| | registry extension | ++-------------------------------+-------------------------------------+ +| ``spp.studio.pack`` | Pre-built logic bundles for common | +| | use cases | ++-------------------------------+-------------------------------------+ +| ``spp.studio.pack.item`` | Individual logic definitions within | +| | a pack | ++-------------------------------+-------------------------------------+ +| ``spp.studio.test`` | Test cases for validating logic | +| | expressions | ++-------------------------------+-------------------------------------+ +| ``spp.studio.test.persona`` | Test personas with example data for | +| | logic validation | ++-------------------------------+-------------------------------------+ +| ``spp.studio.placement.zone`` | Form zones where custom fields can | +| | be placed | ++-------------------------------+-------------------------------------+ +| ``spp.studio.version`` | Version history tracking for logic | +| | changes | ++-------------------------------+-------------------------------------+ +| ``spp.studio.usage`` | Usage tracking for logic and field | +| | references | ++-------------------------------+-------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -110,16 +110,18 @@ UI Location Security ~~~~~~~~ -+--------------------------------------------+----------------------------------+ -| Group | Access | -+============================================+==================================+ -| ``spp_studio.group_studio_viewer`` | Read | -+--------------------------------------------+----------------------------------+ -| ``spp_studio.group_studio_editor_officer`` | Read/Write/Create on logic and | -| | fields (no delete on fields) | -+--------------------------------------------+----------------------------------+ -| ``spp_studio.group_studio_manager`` | Full CRUD | -+--------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| `` | Read | +| spp_studio.group_studio_viewer`` | | ++----------------------------------+----------------------------------+ +| ``spp_stud | Read/Write/Create on logic and | +| io.group_studio_editor_officer`` | fields (no delete on fields) | ++----------------------------------+----------------------------------+ +| ``s | Full CRUD | +| pp_studio.group_studio_manager`` | | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_studio/static/description/index.html b/spp_studio/static/description/index.html index edde10c4..c76dd708 100644 --- a/spp_studio/static/description/index.html +++ b/spp_studio/static/description/index.html @@ -397,8 +397,8 @@

Key Capabilities

Key Models

Model
--++ @@ -480,8 +480,8 @@

UI Location

Security

Model
--++ @@ -489,14 +489,17 @@

Security

- + - + - + diff --git a/spp_studio_change_requests/README.rst b/spp_studio_change_requests/README.rst index ea6787ec..56153ad8 100644 --- a/spp_studio_change_requests/README.rst +++ b/spp_studio_change_requests/README.rst @@ -46,23 +46,23 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------------+----------------------------------+ -| Model | Description | -+====================================+==================================+ -| ``spp.studio.change.request.type`` | Studio-created CR type | -| | definition with lifecycle | -| | tracking | -+------------------------------------+----------------------------------+ -| ``spp.studio.cr.field.mapping`` | Field mapping from | -| | ``res.partner`` to CR detail | -| | model | -+------------------------------------+----------------------------------+ -| ``spp.cr.detail.generic`` | Generic detail template model | -| | (unused; types generate x\_\*) | -+------------------------------------+----------------------------------+ -| ``x_spp_cr_detail_*`` | Auto-generated detail models for | -| (dynamically) | each activated CR type | -+------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| `` | Studio-created CR type | +| spp.studio.change.request.type`` | definition with lifecycle | +| | tracking | ++----------------------------------+----------------------------------+ +| ``spp.studio.cr.field.mapping`` | Field mapping from | +| | ``res.partner`` to CR detail | +| | model | ++----------------------------------+----------------------------------+ +| ``spp.cr.detail.generic`` | Generic detail template model | +| | (unused; types generate x\_\*) | ++----------------------------------+----------------------------------+ +| ``x_spp_cr_detail_*`` | Auto-generated detail models for | +| (dynamically) | each activated CR type | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -88,17 +88,19 @@ UI Location Security ~~~~~~~~ -+--------------------------------------------+----------------------------------+ -| Group | Access | -+============================================+==================================+ -| ``spp_studio.group_studio_viewer`` | Read CR types and mappings | -+--------------------------------------------+----------------------------------+ -| ``spp_studio.group_studio_editor_officer`` | Read/Write/Create on CR types | -| | and mappings (no delete on CR | -| | types) | -+--------------------------------------------+----------------------------------+ -| ``spp_studio.group_studio_manager`` | Full CRUD | -+--------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| `` | Read CR types and mappings | +| spp_studio.group_studio_viewer`` | | ++----------------------------------+----------------------------------+ +| ``spp_stud | Read/Write/Create on CR types | +| io.group_studio_editor_officer`` | and mappings (no delete on CR | +| | types) | ++----------------------------------+----------------------------------+ +| ``s | Full CRUD | +| pp_studio.group_studio_manager`` | | ++----------------------------------+----------------------------------+ Detail models use ``spp_change_request_v2`` groups (user, validator, manager) with create disabled to prevent manual record creation. diff --git a/spp_studio_change_requests/static/description/index.html b/spp_studio_change_requests/static/description/index.html index a6b64c8f..32cb7724 100644 --- a/spp_studio_change_requests/static/description/index.html +++ b/spp_studio_change_requests/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

Group
spp_studio.group_studio_viewer
`` +spp_studio.group_studio_viewer`` Read
spp_studio.group_studio_editor_officer
spp_stud +io.group_studio_editor_officer Read/Write/Create on logic and fields (no delete on fields)
spp_studio.group_studio_manager
s +pp_studio.group_studio_manager Full CRUD
--++ @@ -404,7 +404,8 @@

Key Models

- + @@ -452,8 +453,8 @@

UI Location

Security

Model
spp.studio.change.request.type
`` +spp.studio.change.request.type`` Studio-created CR type definition with lifecycle tracking
--++ @@ -461,15 +462,18 @@

Security

- + - + - + diff --git a/spp_studio_events/README.rst b/spp_studio_events/README.rst index b939eae3..2381776f 100644 --- a/spp_studio_events/README.rst +++ b/spp_studio_events/README.rst @@ -50,30 +50,30 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------------------+----------------------------------+ -| Model | Description | -+==========================================+==================================+ -| ``spp.studio.event.type`` | Custom event type definition | -| | with draft/active lifecycle | -+------------------------------------------+----------------------------------+ -| ``spp.studio.event.field`` | Field definition with type, | -| | validation, and visibility | -+------------------------------------------+----------------------------------+ -| ``spp.studio.event.field.group`` | Groups fields into tabs in the | -| | data entry wizard | -+------------------------------------------+----------------------------------+ -| ``spp.studio.event.field.template`` | Reusable template containing | -| | field definitions | -+------------------------------------------+----------------------------------+ -| ``spp.studio.event.field.template.line`` | Field definition within a | -| | template | -+------------------------------------------+----------------------------------+ -| ``spp.studio.event.type.wizard`` | 3-step wizard for creating event | -| | types | -+------------------------------------------+----------------------------------+ -| ``spp.event.data.entry.wizard`` | Generated wizard for entering | -| | event data | -+------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.studio.event.type`` | Custom event type definition | +| | with draft/active lifecycle | ++----------------------------------+----------------------------------+ +| ``spp.studio.event.field`` | Field definition with type, | +| | validation, and visibility | ++----------------------------------+----------------------------------+ +| ``spp.studio.event.field.group`` | Groups fields into tabs in the | +| | data entry wizard | ++----------------------------------+----------------------------------+ +| ``s | Reusable template containing | +| pp.studio.event.field.template`` | field definitions | ++----------------------------------+----------------------------------+ +| ``spp.st | Field definition within a | +| udio.event.field.template.line`` | template | ++----------------------------------+----------------------------------+ +| ``spp.studio.event.type.wizard`` | 3-step wizard for creating event | +| | types | ++----------------------------------+----------------------------------+ +| ``spp.event.data.entry.wizard`` | Generated wizard for entering | +| | event data | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -99,18 +99,20 @@ UI Location Security ~~~~~~~~ -+--------------------------------------------+----------------------------------+ -| Group | Access | -+============================================+==================================+ -| ``spp_studio.group_studio_viewer`` | Read event types and templates | -+--------------------------------------------+----------------------------------+ -| ``spp_studio.group_studio_editor_officer`` | Read/Write/Create on event | -| | types, fields, and templates (no | -| | delete on event | -| | types/fields/templates) | -+--------------------------------------------+----------------------------------+ -| ``spp_studio.group_studio_manager`` | Full CRUD | -+--------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| `` | Read event types and templates | +| spp_studio.group_studio_viewer`` | | ++----------------------------------+----------------------------------+ +| ``spp_stud | Read/Write/Create on event | +| io.group_studio_editor_officer`` | types, fields, and templates (no | +| | delete on event | +| | types/fields/templates) | ++----------------------------------+----------------------------------+ +| ``s | Full CRUD | +| pp_studio.group_studio_manager`` | | ++----------------------------------+----------------------------------+ Extension Points ~~~~~~~~~~~~~~~~ diff --git a/spp_studio_events/static/description/index.html b/spp_studio_events/static/description/index.html index a0fb315f..2b4ae476 100644 --- a/spp_studio_events/static/description/index.html +++ b/spp_studio_events/static/description/index.html @@ -399,8 +399,8 @@

Key Capabilities

Key Models

Group
spp_studio.group_studio_viewer
`` +spp_studio.group_studio_viewer`` Read CR types and mappings
spp_studio.group_studio_editor_officer
spp_stud +io.group_studio_editor_officer Read/Write/Create on CR types and mappings (no delete on CR types)
spp_studio.group_studio_manager
s +pp_studio.group_studio_manager Full CRUD
--++ @@ -420,11 +420,13 @@

Key Models

- + - + @@ -465,8 +467,8 @@

UI Location

Security

Model Groups fields into tabs in the data entry wizard
spp.studio.event.field.template
s +pp.studio.event.field.template Reusable template containing field definitions
spp.studio.event.field.template.line
spp.st +udio.event.field.template.line Field definition within a template
--++ @@ -474,16 +476,19 @@

Security

- + - + - + diff --git a/spp_user_roles/README.rst b/spp_user_roles/README.rst index 3aa49754..a5c9d54f 100644 --- a/spp_user_roles/README.rst +++ b/spp_user_roles/README.rst @@ -45,17 +45,17 @@ Key Capabilities Key Models ~~~~~~~~~~ -+-------------------------+--------------------------------------------+ -| Model | Description | -+=========================+============================================+ -| ``res.users.role`` | Extended with ``role_type`` field and | -| | manual update action | -+-------------------------+--------------------------------------------+ -| ``res.users.role.line`` | Extended with related ``role_type`` field | -+-------------------------+--------------------------------------------+ -| ``res.users`` | Extended with stored roles field and | -| | custom group sync | -+-------------------------+--------------------------------------------+ ++-------------------------+-------------------------------------------+ +| Model | Description | ++=========================+===========================================+ +| ``res.users.role`` | Extended with ``role_type`` field and | +| | manual update action | ++-------------------------+-------------------------------------------+ +| ``res.users.role.line`` | Extended with related ``role_type`` field | ++-------------------------+-------------------------------------------+ +| ``res.users`` | Extended with stored roles field and | +| | custom group sync | ++-------------------------+-------------------------------------------+ Configuration ~~~~~~~~~~~~~ @@ -81,15 +81,15 @@ UI Location Security ~~~~~~~~ -+------------------------------------------+----------------------------------+ -| Group | Access | -+==========================================+==================================+ -| ``spp_user_roles.group_local_registrar`` | Read users, roles, and role | -| | lines | -+------------------------------------------+----------------------------------+ -| ``spp_security.group_spp_admin`` | Full CRUD on roles and role | -| | lines | -+------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Group | Access | ++==================================+==================================+ +| ``spp_us | Read users, roles, and role | +| er_roles.group_local_registrar`` | lines | ++----------------------------------+----------------------------------+ +| ``spp_security.group_spp_admin`` | Full CRUD on roles and role | +| | lines | ++----------------------------------+----------------------------------+ Predefined Roles ~~~~~~~~~~~~~~~~ diff --git a/spp_user_roles/static/description/index.html b/spp_user_roles/static/description/index.html index 78bf5c84..8da60c63 100644 --- a/spp_user_roles/static/description/index.html +++ b/spp_user_roles/static/description/index.html @@ -394,8 +394,8 @@

Key Capabilities

Key Models

Group
spp_studio.group_studio_viewer
`` +spp_studio.group_studio_viewer`` Read event types and templates
spp_studio.group_studio_editor_officer
spp_stud +io.group_studio_editor_officer Read/Write/Create on event types, fields, and templates (no delete on event types/fields/templates)
spp_studio.group_studio_manager
s +pp_studio.group_studio_manager Full CRUD
--++ @@ -443,8 +443,8 @@

UI Location

Security

Model
--++ @@ -452,7 +452,8 @@

Security

- + diff --git a/spp_versioning/README.rst b/spp_versioning/README.rst index c22b8d17..a7d796e6 100644 --- a/spp_versioning/README.rst +++ b/spp_versioning/README.rst @@ -42,23 +42,23 @@ Key Capabilities Key Models ~~~~~~~~~~ -+------------------------------------------+----------------------------------+ -| Model | Description | -+==========================================+==================================+ -| ``spp.versioned.mixin`` | Abstract mixin to add versioning | -| | capabilities to any model | -+------------------------------------------+----------------------------------+ -| ``spp.artifact.version`` | Stores version snapshots with | -| | state machine | -| | (draft/scheduled/current) | -+------------------------------------------+----------------------------------+ -| ``spp.artifact.usage`` | Tracks where artifacts are used | -| | (prevents orphan archiving) | -+------------------------------------------+----------------------------------+ -| ``spp.artifact.version.schedule.wizard`` | Wizard for scheduling version | -| | activation with conflict | -| | detection | -+------------------------------------------+----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.versioned.mixin`` | Abstract mixin to add versioning | +| | capabilities to any model | ++----------------------------------+----------------------------------+ +| ``spp.artifact.version`` | Stores version snapshots with | +| | state machine | +| | (draft/scheduled/current) | ++----------------------------------+----------------------------------+ +| ``spp.artifact.usage`` | Tracks where artifacts are used | +| | (prevents orphan archiving) | ++----------------------------------+----------------------------------+ +| ``spp.ar | Wizard for scheduling version | +| tifact.version.schedule.wizard`` | activation with conflict | +| | detection | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_versioning/static/description/index.html b/spp_versioning/static/description/index.html index 994fed67..af8c08cd 100644 --- a/spp_versioning/static/description/index.html +++ b/spp_versioning/static/description/index.html @@ -391,8 +391,8 @@

Key Capabilities

Key Models

Group
spp_user_roles.group_local_registrar
spp_us +er_roles.group_local_registrar Read users, roles, and role lines
--++ @@ -413,7 +413,8 @@

Key Models

- + diff --git a/spp_vocabulary/README.rst b/spp_vocabulary/README.rst index 8a269f93..7d99f202 100644 --- a/spp_vocabulary/README.rst +++ b/spp_vocabulary/README.rst @@ -46,28 +46,30 @@ Key Capabilities Key Models ~~~~~~~~~~ -+----------------------------------+-----------------------------------+ -| Model | Description | -+==================================+===================================+ -| ``spp.vocabulary`` | Collection of codes with a | -| | namespace (e.g., Gender, ID Type) | -+----------------------------------+-----------------------------------+ -| ``spp.vocabulary.code`` | Individual code within a | -| | vocabulary (e.g., 'M', 'female') | -+----------------------------------+-----------------------------------+ -| ``spp.vocabulary.mapping`` | Maps codes between different | -| | vocabularies | -+----------------------------------+-----------------------------------+ -| ``spp.vocabulary.concept.group`` | Semantic grouping of codes for | -| | business logic abstraction | -+----------------------------------+-----------------------------------+ -| ``spp.deployment.profile`` | Deployment-specific configuration | -| | for active code subsets | -+----------------------------------+-----------------------------------+ -| ``spp.vocabulary.selection`` | Code selection within a | -| | deployment profile with | -| | inheritance | -+----------------------------------+-----------------------------------+ ++----------------------------------+----------------------------------+ +| Model | Description | ++==================================+==================================+ +| ``spp.vocabulary`` | Collection of codes with a | +| | namespace (e.g., Gender, ID | +| | Type) | ++----------------------------------+----------------------------------+ +| ``spp.vocabulary.code`` | Individual code within a | +| | vocabulary (e.g., 'M', 'female') | ++----------------------------------+----------------------------------+ +| ``spp.vocabulary.mapping`` | Maps codes between different | +| | vocabularies | ++----------------------------------+----------------------------------+ +| ``spp.vocabulary.concept.group`` | Semantic grouping of codes for | +| | business logic abstraction | ++----------------------------------+----------------------------------+ +| ``spp.deployment.profile`` | Deployment-specific | +| | configuration for active code | +| | subsets | ++----------------------------------+----------------------------------+ +| ``spp.vocabulary.selection`` | Code selection within a | +| | deployment profile with | +| | inheritance | ++----------------------------------+----------------------------------+ Configuration ~~~~~~~~~~~~~ diff --git a/spp_vocabulary/static/description/index.html b/spp_vocabulary/static/description/index.html index a4493916..031224e5 100644 --- a/spp_vocabulary/static/description/index.html +++ b/spp_vocabulary/static/description/index.html @@ -395,8 +395,8 @@

Key Capabilities

Key Models

Model Tracks where artifacts are used (prevents orphan archiving)
spp.artifact.version.schedule.wizard
spp.ar +tifact.version.schedule.wizard Wizard for scheduling version activation with conflict detection
--++ @@ -406,7 +406,8 @@

Key Models

+namespace (e.g., Gender, ID +Type) - +
Model
spp.vocabulary Collection of codes with a -namespace (e.g., Gender, ID Type)
spp.vocabulary.code Individual code within a @@ -421,8 +422,9 @@

Key Models

business logic abstraction
spp.deployment.profileDeployment-specific configuration -for active code subsetsDeployment-specific +configuration for active code +subsets
spp.vocabulary.selection Code selection within a