FlexiRule Docs

Architecture

Core architecture and design philosophy of FlexiRule.

Improve this page

FlexiRule Architecture#

Keywords: architecture, system overview, design, layers, frappe, vueflow

Audience#

Developers
Administrators
Contributors

Overview#

FlexiRule is a visual rule orchestration engine built for Frappe v15+. It bridges the gap between no-code configuration and standard Python business logic by providing a graph-based execution layer.

Rule Execution Lifecycle#

sequenceDiagram participant F as Frappe Hook participant RC as RuleCoordinator participant RE as RuleEngine participant AH as ActionHandlers F->>RC: Trigger Event (e.g., on_update) RC->>RC: Find & Filter Rules RC->>RE: Execute Rule(s) loop For each Node RE->>AH: Handle Action AH-->>RE: Return Result end RE-->>RC: Execution Finished RC-->>F: Done

System Layers#

1. Presentation Layer (Frontend)#

The frontend is built using Vue 3 and VueFlow, integrated into the Frappe Desk. It manages complex graph states and ensures design-time safety through context-aware validation.

2. API Layer#

The API layer provides a secure bridge between the frontend and backend. Key functionalities include introspection, validation, and execution testing.

3. Domain Layer (Core Engine)#

The core engine is responsible for the deterministic execution of rules.

RuleCoordinator: Handles event dispatching and caching.
RuleEngine: Traverses the graph using a Strategy Pattern.
ContextManager: Manages variable scope (vars) and mutation modes.

4. Persistence Layer (Data Model)#

FlexiRule uses several Frappe DocTypes to maintain rules, processes, and audit trails.

Integration Flow#

graph TD A[Frappe App] -->|Hooks| B[RuleCoordinator] B -->|Registry| C{Rules Active?} C -- Yes --> D[RuleEngine] C -- No --> E[Exit] D --> F[Action Handlers] F -->|Result| G[Update doc/vars] G --> D

Technical Integrity#

The system includes a built-in technical audit mechanism to ensure rule integrity:

Graph Validation: Prevents disconnected nodes, cycles, and invalid exit paths.
Contract Enforcement: Ensures action configurations match backend expectations.
Pre-Activation Check: A full validation suite runs automatically before activation.

Was this page helpful?