Workflow — Developer Index

Entry point for the Enezaframework workflow developer guides. Start here, then follow the links to the topic you need.

Table of Contents

1. What the Workflow Guides Cover
2. The Four Features
3. Documentation Map
4. Suggested Reading Paths
5. A Note on Testing

What the Workflow Guides Cover

enezaworkflowengine is the workflow approval engine of Enezaframework. Documents are submitted into approval workflows, condition steps decide routing, and saved queries define which records match a condition.

These guides cover four supporting features of that engine:

• The Workflow Type Registry, which maps a workflow name to the models its condition queries may use.
• The Workflow Query Enhancements, which add object-scoped query execution and aggregate annotations to SavedQuery.
• The State-Based Workflow, which runs a document through developer-defined states with user-chosen transitions and parallel Fork/Join branches.
• The Workflow Hooks, which run developer business logic after approval and state-based engine events.

Who this is for: Django developers and coding agents extending the workflow engine or wiring workflow conditions into a business app.

The Four Features

flowchart LR
    subgraph Registry["Workflow Type Registry"]
        R1[Framework defaults]
        R2[Project workflowconfig/]
        R3[Runtime register()]
        R1 --> R4[WorkflowTypeRegistry]
        R2 --> R4
        R3 --> R4
        R4 --> R5[QueryBuilderMixin]
        R5 --> R6[Query builder UI]
    end

    subgraph Query["Workflow Query Enhancements"]
        Q1[SavedQuery.get_queryset]
        Q1 --> Q2[object_id filtering]
        Q1 --> Q3[annotations -> annotate]
        Q3 --> Q4[aggregate filters]
        Q2 --> Q5[Workflow engine condition steps]
        Q4 --> Q5
    end

    subgraph State["State-Based Workflow"]
        S1[WorkflowTemplate.workflow_kind = state_based]
        S1 --> S2[Designer: state / fork / join graph]
        S2 --> S3[StateTransition + StepTemplate]
        S3 --> S4[state_workflow engine -> WorkflowBranch]
        S4 --> S5[Document.workflowstate]
    end

    subgraph Hooks["Workflow Hooks"]
        H1[WorkflowTypeConfig.WORKFLOW_HOOKS]
        H3[Engine events] --> H4[emit_workflow_event -> on_commit]
        H4 --> H2[WorkflowHookRegistry]
        H1 --> H2
        H2 --> H5[handler context]
    end

    R6 -. saved queries .-> Q1

Documentation Map

The original, unsplit references remain available at workflow-type-registry-developer-guide.md and workflow-query-enhancements-developer-guide.md.

For surrounding framework concepts, see the Enezaframework developer index:

• Base Models & Model Types
• CRUD Base Views
• URL Auto-Registration

Suggested Reading Paths

Adding a workflow type to a project 1. Workflow Type Registry Architecture 2. Workflow Model Configuration 3. Workflow Project Configuration

Registering a workflow type from an app 1. Workflow Dynamic Registration 2. Workflow Model Configuration 3. QueryBuilderMixin Integration

Scoping conditions to a document 1. Workflow Query Architecture 2. Workflow Object ID Filtering 3. Workflow Engine Auto-Extraction

Writing aggregate conditions 1. Workflow Aggregate Annotations 2. Workflow Query JSON Format 3. Workflow Query Examples

Building a user-defined state workflow with parallel branches 1. State-Based Workflows 2. State-Based Workflow Architecture 3. State-Based Workflow Reference 4. State-Based Workflow Troubleshooting

Running business logic on workflow events 1. Workflow Hooks 2. Workflow Hooks Reference 3. Workflow Project Configuration

A Note on Testing

Per project rules, the developer or agent does not run or claim test results. The user is solely responsible for all testing and validation of the output described in these guides.

Related Guides

• Workflow Type Registry Architecture
• Workflow Query Architecture
• Workflow Type Registry Reference
• Workflow Query Reference
• Workflow Hooks
• Workflow Hooks Reference