Provides a standardized approval workflow engine for OpenSPP models.
Adds configurable multi-tier approval sequences with CEL-based
conditional routing, SLA tracking, and system-wide freeze periods for
regulatory compliance. Models inherit spp.approval.mixin to gain
submit/approve/reject actions with audit trails and optimistic locking.
- Approval Mixin: Add
spp.approval.mixinto any model to enable approval workflow with state tracking (draft,pending,approved,rejected,revision) - Multi-Tier Workflows: Define sequential approval tiers with configurable approver types (security group, specific users, submitter's manager, or dynamic field)
- CEL Rules: Conditional approval routing using Common Expression Language domain filters
- Freeze Periods: System-wide approval suspension during election bans, audits, or maintenance windows
- SLA Tracking: Track approval deadlines per tier with escalation support
- Revision Requests: Approvers can request revisions instead of outright rejection
- Optimistic Locking: Prevents concurrent approval conflicts via version-based locking
| 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 |
After installing:
- Navigate to Approvals > Configuration > Approval Definitions
- Create a definition selecting the target model, approver type, and optional domain filter
- For multi-tier workflows, enable "Multi-Tier Approval" and configure tiers in the inline editable list
- (Optional) Configure freeze periods at Approvals > Configuration > Freeze Periods
- Menu: Approvals > My Approvals > Pending Approvals
- Configuration: Approvals > Configuration > Approval Definitions
- Freeze Periods: Approvals > Configuration > Freeze Periods
- Mixin Integration: Approval buttons appear on forms of models inheriting the mixin
On Approval Definition forms:
- Conditions: Domain filter to determine which records require this approval
- Behavior: Approval settings (require comment, auto-approve, notifications)
- SLA & Escalation: SLA tracking and escalation rules
| 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 |
Note: approval_definition and approval_freeze models block
deletion for managers via Python override - only system administrators
can delete these records.
- Inherit
spp.approval.mixinto add approval workflow to any model inheritingmail.thread - Override
_on_submit(),_on_approve(),_on_reject(),_on_request_revision()hooks for custom logic - Override
_get_approval_definition()to provide record-specific approval rules (e.g., from a type field) - Extend
spp.approval.definitionto add custom approver types or matching logic
base, mail, spp_base_common, spp_cel_domain,
spp_security
Table of contents
- Initial migration to OpenSPP2
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 feedback.
Do not contact contributors directly about support or help with technical issues.
- OpenSPP.org
- OpenSPP Community
Current maintainers:
This module is part of the OpenSPP/OpenSPP2 project on GitHub.
You are welcome to contribute.