# mubarak-saeed/pmp architecture

> Architecture diagram of the GitHub repository mubarak-saeed/pmp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mubarak-saeed/pmp
- Repository: https://github.com/mubarak-saeed/pmp

## Overview

ProcessMaker 4 is a workflow-management application for designing processes and forms, routing work, and managing users and roles. A principal workflow is defining a process, publishing it, starting a case, and completing its assigned tasks. The repository tree and README establish these capabilities; the sampled source shows the BPMN engine, workflow managers, process/task models, and data manager, but not enough call sites to trace the full runtime path. Accordingly, edges are limited to relationships visible in the excerpts or source index.

Main entry points: [`ProcessMaker/Http/Controllers/Api/ProcessController.php`](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Http/Controllers/Api/ProcessController.php) (Process API), [`ProcessMaker/Http/Controllers/Api/TaskController.php`](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Http/Controllers/Api/TaskController.php) (Task API), [`ProcessMaker/Facades/WorkflowManager.php`](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Facades/WorkflowManager.php) (Workflow facade), [`ProcessMaker/BpmnEngine.php`](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/BpmnEngine.php) (BPMN engine)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_design["Process design"]
  node_process_api["Process API"]
  node_process_model[("Process definitions")]
  node_process_versions[("Published versions")]
  node_bpmn_document["BPMN document"]
  node_import_export["Process import and export<br/>[Exporter.php]"]
end

subgraph group_runtime["Workflow runtime"]
  node_workflow_facade["Workflow facade"]
  node_bpmn_engine["BPMN engine<br/>[BpmnEngine.php]"]
  node_workflow_default["Default workflow manager"]
  node_workflow_rabbit["RabbitMQ workflow manager"]
  node_scheduler["Timer scheduler"]
end

subgraph group_work["Cases and tasks"]
  node_requests[("Cases")]
  node_tokens[("Task tokens")]
  node_data_manager["Workflow data"]
  node_task_api["Task API<br/>[TaskController.php]"]
  node_task_preview["Task preview<br/>[TasksPreview.vue]"]
end

subgraph group_platform["Platform services"]
  node_users[("Users and roles")]
  node_auth["Authentication and policy"]
  node_recommendations["Recommendations"]
end

node_user(("Process user"))

node_user -.->|"manages processes"| node_process_api
node_user -.->|"works tasks"| node_task_api
node_process_api -->|"uses workflow"| node_workflow_facade
node_workflow_default -->|"uses engine"| node_bpmn_engine
node_workflow_rabbit -->|"uses workflow"| node_workflow_facade
node_bpmn_engine -->|"loads case"| node_requests
node_data_manager -->|"reads and updates"| node_tokens
node_scheduler -->|"completes catch events"| node_workflow_facade
node_task_api -.->|"serves tasks"| node_tokens
node_task_preview -.->|"uses task data"| node_task_api
node_process_api -.->|"manages definitions"| node_process_model
node_process_versions -->|"belongs to process"| node_process_model
node_auth -->|"authenticates"| node_users

click node_process_api "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Http/Controllers/Api/ProcessController.php"
click node_workflow_facade "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Facades/WorkflowManager.php"
click node_bpmn_engine "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/BpmnEngine.php"
click node_workflow_default "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Nayra/Managers/WorkflowManagerDefault.php"
click node_workflow_rabbit "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Nayra/Managers/WorkflowManagerRabbitMq.php"
click node_scheduler "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Managers/TaskSchedulerManager.php"
click node_task_api "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Http/Controllers/Api/TaskController.php"
click node_task_preview "https://github.com/mubarak-saeed/pmp/blob/develop/resources/js/tasks/components/TasksPreview.vue"
click node_auth "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Providers/AuthServiceProvider.php"
click node_recommendations "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/RecommendationEngine.php"
click node_import_export "https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/ImportExport/Exporter.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_process_api,node_process_model,node_process_versions,node_bpmn_document,node_import_export,node_user toneBlue
class node_workflow_facade,node_bpmn_engine,node_workflow_default,node_workflow_rabbit,node_scheduler toneAmber
class node_requests,node_tokens,node_data_manager,node_task_api,node_task_preview toneMint
class node_users,node_auth,node_recommendations toneRose
```

## Components

### Process design

- [Process API](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Http/Controllers/Api/ProcessController.php): `ProcessMaker/Http/Controllers/Api/ProcessController.php`
- **Process definitions**
- **Published versions**
- **BPMN document**
- [Process import and export](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/ImportExport/Exporter.php): `ProcessMaker/ImportExport/Exporter.php`

### Workflow runtime

- [Workflow facade](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Facades/WorkflowManager.php): `ProcessMaker/Facades/WorkflowManager.php`
- [BPMN engine](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/BpmnEngine.php): `ProcessMaker/BpmnEngine.php`
- [Default workflow manager](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Nayra/Managers/WorkflowManagerDefault.php): `ProcessMaker/Nayra/Managers/WorkflowManagerDefault.php`
- [RabbitMQ workflow manager](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Nayra/Managers/WorkflowManagerRabbitMq.php): `ProcessMaker/Nayra/Managers/WorkflowManagerRabbitMq.php`
- [Timer scheduler](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Managers/TaskSchedulerManager.php): `ProcessMaker/Managers/TaskSchedulerManager.php`

### Cases and tasks

- **Cases**
- **Task tokens**
- **Workflow data**
- [Task API](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Http/Controllers/Api/TaskController.php): `ProcessMaker/Http/Controllers/Api/TaskController.php`
- [Task preview](https://github.com/mubarak-saeed/pmp/blob/develop/resources/js/tasks/components/TasksPreview.vue): `resources/js/tasks/components/TasksPreview.vue`

### Platform services

- **Users and roles**
- [Authentication and policy](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/Providers/AuthServiceProvider.php): `ProcessMaker/Providers/AuthServiceProvider.php`
- [Recommendations](https://github.com/mubarak-saeed/pmp/blob/develop/ProcessMaker/RecommendationEngine.php): `ProcessMaker/RecommendationEngine.php`

### Other components

- **Process user**

## Connections

- Process user → Process API: manages processes
- Process user → Task API: works tasks
- Process API → Workflow facade: uses workflow (evidence: `ProcessMaker/Http/Controllers/Api/ProcessController.php`)
- Default workflow manager → BPMN engine: uses engine (evidence: `ProcessMaker/Nayra/Managers/WorkflowManagerDefault.php`)
- RabbitMQ workflow manager → Workflow facade: uses workflow (evidence: `ProcessMaker/Nayra/Managers/WorkflowManagerRabbitMq.php`)
- BPMN engine → Cases: loads case (evidence: `ProcessMaker/BpmnEngine.php`)
- Workflow data → Task tokens: reads and updates
- Timer scheduler → Workflow facade: completes catch events (evidence: `ProcessMaker/Managers/TaskSchedulerManager.php`)
- Task API → Task tokens: serves tasks
- Task preview → Task API: uses task data
- Process API → Process definitions: manages definitions
- Published versions → Process definitions: belongs to process
- Authentication and policy → Users and roles: authenticates (evidence: `ProcessMaker/Providers/AuthServiceProvider.php`)
