Spring Boot Integration

The Camunda Engine can be used in a Spring Boot application by using provided Spring Boot starters. Spring boot starters allow to enable behavior of your spring-boot application by adding dependencies to the classpath.

These starters will pre-configure the Camunda process engine, REST API and Web applications, so they can easily be used in a standalone process application.

If you are not familiar with Spring Boot, read the getting started guide or use the Camunda BPM Initializr.

To enable Camunda BPM auto configuration, add the following dependency to your pom.xml:

<dependency>
  <groupId>org.camunda.bpm.springboot</groupId>
  <artifactId>camunda-bpm-spring-boot-starter</artifactId>
  <version>7.13.0</version>
</dependency>

This will add the Camunda engine v.7.13.0 to your dependencies.

Other starters that can be used are: camunda-bpm-spring-boot-starter-rest and camunda-bpm-spring-boot-starter-webapp.

Using Enterprise Edition

To use Camunda Spring Boot Starter with Camunda EE you need to define the EE version of the webapp (camunda-bpm-spring-boot-starter-webapp-ee instead of camunda-bpm-spring-boot-starter-webapp), see also Web Applications:

<dependency>
  <groupId>org.camunda.bpm.springboot</groupId>
  <artifactId>camunda-bpm-spring-boot-starter-webapp-ee</artifactId>
  <version>7.13.0-ee</version>
</dependency>

Supported deployment scenarios

Following deployment scenario is supported by Camunda:

  • executable JAR with embedded Tomcat and one embedded process engine (plus Webapps when needed)

There are other possible variations that might also work, but are not tested by Camunda at the moment.