Blog

News from the bpmn.io project

Drupal ECA integrates bpmn.io

Published by Jürgen Haas on Thursday, 07 July 2022.

bpmn-js

Drupal is a robust content management system, comes with sophisticated APIs for multichannel publishing, and a track record of continuous innovation. Drupal is the best digital experience platform (DXP) on the web, proudly open source. Applications build with Drupal get customized and extended by an extensive eco-system of open source modules, or with custom modules developed in PHP. ECA is one of those modules and allows you to automate all aspects of Drupal. This post describes how bpmn.io, specifically bpmn-js, integrates as UI to create, review, and maintain the configured automations.

A big thanks to Jürgen Haas from LakeDrops for writing this guest blog post.

ECA Architecture in Drupal

The Drupal module ECA is an automated processor built around the "Event - Condition - Action" paradigm, hence the name, and operates like a black box completely in the background. Like all Drupal configuration, ECA models are managed as config entities in Yaml format as well.

By design, ECA does not provide any UI to create or edit those config entities as it focusses on its role as a processor only. Instead, ECA comes with a number of APIs to allow UI tools receiving the lists of available events, conditions and actions that are available on the current Drupal site and to save back their models to ECA.

As ECA is brand new and only got released on June 22, 2022 as a Release Candidate, there isn't a huge number of UI modellers available. There are just 2: bpmn.io and Camunda, the former is fully integrated in Drupal's admin UI, the latter can be used as a desktop application communicating with the Drupal site through file for templates and the XML files.

Configure ECA with bpmn.io

Like ECA as well, the bpmn.io module can be installed and enabled on any existing Drupal site without further dependencies. Minimum supported Drupal version is 9.4.0 though.

Once enabled, site builders with appropriate permissions can start building their models without any configuration necessary:

An ECA (Event-Condition-Action) automation modeled as a BPMN diagram with bpmn.io

bpmn.io tooling integrated into Drupal's admin UI.

The integration with ECA takes care of all the available templates - they are called plugins in the Drupal world - and makes them dynamically available to the bpmn.io UI, also without any configuration or other pre-processing steps:

bpmn.io Element template chooser to select from actions available in Drupal site

Choosing from templates dynamically provided by the current Drupal site.

This dynamic goes as far as making additional events, conditions (flow controls) and actions (tasks) available transparently when new Drupal modules get installed that bring any of those plugins with them. Or, if Drupal core or any module gets updated, new or changed plugins get recognized and changes will be accessible to bpmn.io right away.

Benefits

Using ECA has a huge number of benefits for all Drupal sites. As it exposes all of Drupal's APIs to the automated processor, that reduces the need for custom PHP code or many smaller and single-purpose contributed modules dramatically. The complexity and overhead in code and maintenance will be reduced while automation gets managed at a single place in revisionable config entities in Yaml, stored in Git repositories for most cases.

The huge extra benefits coming with bpmn.io integration are obvious. First of all, having a UI tool is a requirement to give users (called site builders) access to the power of the ECA black-box. A UI tool based on an event, condition, action paradigm as well, makes it even more attractive and powerful, as there is no loss in data while converting between ECA and bpmn.io configuration, which of course happens seemlessly in the background.

First experience with real Drupal site builders have shown, that bpmn.io tooling is really intuitive and comes with no barriers for new users. Even those users with no knowledge about BPMN get started and productive immediately.

For enterprise users, which is Drupal's main focus globally, the bpmn.io integration comes with even more benfits. While Drupal and its APIs are powerful, scalable and performant, setting up web applications requires fairly deep knowledge about the Drupal framwork. With bpmn.io integration, we managed to include other stakeholders in the business to collaborate with the Drupal developers in initial setup, review and maintenance of the automation configuration. Those stakeholders are key to the process: while they have often limited knowledge about Drupal, they know pretty much everything about their own business processes and having them on board makes all theses processes to much easier.


About the Author

Jürgen Haas is a Drupal expert for over 15 years at LakeDrops.

Are you passionate about JavaScript, modeling, and the web?
Join Camunda and build modeling tools people heart.