Installation and Configuration
Workflow Designer is an enterprise bundle. It requires a Pimcore enterprise subscription.
Prerequisites
The bundle requires Pimcore 2026.1 or later and PHP 8.4 or 8.5.
Bundle Installation
- Install the package:
composer require pimcore/workflow-designer
- Enable the bundle in
config/bundles.php:
use Pimcore\Bundle\WorkflowDesignerBundle\PimcoreWorkflowDesignerBundle;
// ...
return [
// ...
PimcoreWorkflowDesignerBundle::class => ['all' => true],
// ...
];
- Install the bundle:
bin/console pimcore:bundle:install PimcoreWorkflowDesignerBundle
System Requirements
Pimcore workflows are Symfony configuration. The Workflow Designer therefore writes a Symfony configuration file, and Pimcore has to be able to rebuild its container afterwards.
Grant Pimcore write access to var/config/workflow-designer/workflows.yaml, or to whichever path you configure below.
User Permissions
The installer creates three permissions in the Workflow Designer category:
| Permission | Grants |
|---|---|
permission_workflow_designer | Opens the Workflow Designer and manages workflow definitions. Required by every endpoint of the bundle, so a user without it gets a 403. |
permission_workflow_designer_place_permissions | Edits the per-place permissions of a workflow. |
permission_workflow_designer_trans_notifications | Edits the notification settings of a transition. |
Grant permission_workflow_designer to every user or role that works with the designer. The other two reveal the
corresponding settings tabs inside the designer, and existing values stay untouched for users who lack them. Both are
enforced in Pimcore Studio only, they do not block a request to the save endpoint.
The bundle also registers the context permission system.workflowDesigner, which controls whether the
System > Workflow Designer entry appears in a perspective. It is enabled by default, so it only matters for
custom perspectives that restrict the main navigation.
Workflow Save File
configuration_file_path sets where the workflow definitions are written. It defaults to a file under var/config.
pimcore_workflow_designer:
configuration_file_path: '%kernel.project_dir%/var/config/workflow-designer/workflows.yaml'
Next Steps
- Upgrade Notes: what changed between versions.
- Workflow Configuration: build a workflow in the designer.
- Technical Aspects: how the generated configuration is loaded, and the events it dispatches.