Apitomy Flow
Lightweight visual workflow engine for orchestrating long-running project lifecycles.
Apitomy Flow is a standalone library designed to integrate into Apitomy products. It provides a stateless workflow execution engine (Java) and a visual drag-and-drop editor (React) for defining and monitoring workflows.
Key Features
- Directed graph workflows with 6 node types and conditional edge routing
- Stateless engine — takes state in, returns state out; no persistence opinions
- Human-in-the-loop tasks and external event correlation
- Visual editor with drag-and-drop node placement and real-time validation
- Read-only viewer for monitoring workflow instance progress
- Shape and semantic validation catches definition problems before execution
- Parallel fork/join and pending actions support multiple parked branches
- Routing simulation and definition diff support authoring and review
Two Components
| Component | Technology | Purpose |
|---|---|---|
| Engine | Java 21, pure library | Workflow execution, validation, event correlation |
| UI | React 19, TypeScript | WorkflowEditor, WorkflowViewer, and WorkflowDiffViewer |
The engine has no framework dependencies — it works in any Java application. The visual editor is a React component library that consuming applications import and render.
Getting Started
These guides describe the source branch, including pending C1–C14 changes, rather than guaranteeing availability in a published artifact. Start with current contracts.
- Installation — Maven coordinates and npm package
- Quick Start — Run your first workflow in minutes
User Guide
- Workflow Model — nodes, edges, and instances
- Typed Configuration — wire schema and source migration
- Engine Usage — running and resuming workflows with
WorkflowEngine - Node Executors — implementing action nodes
- Error Handling — fail / retry / transition strategies
- Event Correlation — matching external events to waiting instances
- Validation — the validation rules reference
- Visual Editor — the
WorkflowEditorcomponent - Workflow Viewer — the
WorkflowViewercomponent - Workflow Diff Viewer — compare definitions by ID
- Parallel Fork/Join — a worked fork/join workflow
Developer Guide
- Architecture — engine and UI internals
- Engine Errors — structured diagnostics and host SPI
- Indexed Architecture — ownership and benchmark evidence
- Documentation Checks — executable examples and browser checks
- Building — build from source and run the dev app
- Contributing — contribution workflow
Links
- GitHub Repository
- Apitomy Website
- Apitomy Axiom — the first product integrating Flow