Process Engine Plugins
The process engine configuration can be extended through process engine plugins. A process engine plugin is an extension to the process engine configuration.
A plugin must provide an implementation of the ProcessEnginePlugin interface.
Configure Process Engine Plugins
Process engine plugins can be configured
- in the Camunda Platform Deployment Descriptors (bpm-platform.xml/processes.xml),
- in the Wildfly configuration file (standalone.xml/domain.xml),
- using Spring Beans XML,
- in the Camunda Platform Run YAML configuration files
- programatically.
The following is an example of how to configure a process engine plugin in a bpm-platform.xml file:
<?xml version="1.0" encoding="UTF-8"?>
<bpm-platform xmlns="http://www.camunda.org/schema/1.0/BpmPlatform"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.camunda.org/schema/1.0/BpmPlatform http://www.camunda.org/schema/1.0/BpmPlatform ">
<job-executor>
<job-acquisition name="default" />
</job-executor>
<process-engine name="default">
<job-acquisition>default</job-acquisition>
<configuration>org.camunda.bpm.engine.impl.cfg.JtaProcessEngineConfiguration</configuration>
<datasource>jdbc/ProcessEngine</datasource>
<plugins>
<plugin>
<class>org.camunda.bpm.engine.MyCustomProcessEnginePlugin</class>
<properties>
<property name="boost">10</property>
<property name="maxPerformance">true</property>
<property name="actors">akka</property>
</properties>
</plugin>
</plugins>
</process-engine>
</bpm-platform>
A process engine plugin class must be visible to the classloader which loads the process engine classes.
List of Built-In Process Engine Plugins
The following is a list of built-in process engine plugins: