Easy BPM Documentation
Easy BPM is a developer-friendly business process platform for modeling, running, and operating business workflows. It includes a process modeler, runtime API, task portal, admin console, asynchronous worker, document handling, code-task execution, and security administration.
This documentation is written for customer developers and technical operators. It focuses on how to install the platform, create processes, integrate systems, complete user work, and use the public API.
Model workflows
Use the Modeler to build process definitions with tasks, gateways, messages, timers, and subprocesses.
Run work
Start process instances, route human tasks, exchange variables, and resume waiting processes.
Integrate systems
Call HTTP APIs, publish and catch messages, upload documents, and execute JVM code through Code Tasks.
Operate safely
Use JWT authentication, RBAC permissions, process monitoring, audit views, health checks, and Prometheus metrics.
Platform components
| Component | What it does |
|---|---|
| Backend API | Runs process definitions, stores instances and variables, exposes REST endpoints, and manages security. |
| Worker | Consumes asynchronous work from RabbitMQ and executes long-running API/service work. |
| Modeler | Browser app for creating process definitions, forms, API tasks, code tasks, AI tasks, and subprocesses. |
| Task Portal | Browser app where users start processes, claim tasks, complete forms, and upload or preview documents. |
| Admin Console | Browser app for monitoring instances, changing variables, moving tokens, managing users/groups, and viewing code-task audits. |
| PostgreSQL | Stores process definitions, instances, tasks, forms, documents, security data, and audit records. |
| RabbitMQ | Coordinates asynchronous work between the backend and worker. |
Start here
- Run a complete process with Run your first BPMN process.
- Connect an AI workflow with Build your first AI agent.
- Add people to the workflow with Orchestrate human tasks.
- Prepare your environment with Docker start.