Web applications
Starting from CIB seven 2.0, the default web application is CIB seven webclient.
To enable the webclient application you can use the following starter in your pom.xml
:
<dependency>
<groupId>org.cibseven.bpm.springboot</groupId>
<artifactId>cibseven-bpm-spring-boot-starter-webapp</artifactId>
<version>2.0.0</version>
</dependency>
By default the application path is /webapp
, so without any further configuration you can access
the CIB seven webclient under http://localhost:8080/webapp.
Note: The previous Camunda web applications are still accessible at http://localhost:8080/camunda, however, this endpoint is deprecated and will be discontinued in the future releases.
Enterprise webapps
Enterprise Feature
Please note that this feature is only included in the enterprise edition of CIB seven, it is not available in the community edition.
To use the enterprise webclient, include enterprise version of the starter, with -ee
suffix:
<dependency>
<groupId>org.cibseven.bpm.springboot</groupId>
<artifactId>cibseven-bpm-spring-boot-starter-webapp</artifactId>
<version>${project-version}-ee</version>
</dependency>
If you are using the enterprise edition, you can also use the cibseven.webclient.license.file.path
property to provide a license file that is inserted on application start. Or copy your license file under the name
cibseven-license.txt
to your ${user.home}/.cibseven/
directory. See the dedicated License docs section
for more details on how to add a License key to your CIB seven installation.
Configurations
You can change the application path for CIB seven webclient with the following configuration property in your application.yaml
file:
camunda.bpm.webapp.application-path=/my/application/path
The application path for the previous Camunda web applications is configured with this property:
camunda.bpm.webapp.legacy-application-path=/my/legacy-application/path
By default, the starter registers a controller to redirect /
to CIB seven’s bundled index.html
.
To disable this, you have to add to your application properties:
camunda.bpm.webapp.index-redirect-enabled=false
For more information about the configuration options for CIB seven webclient, please see here: CIB seven webclient properties
Error Pages
The default error handling coming with the Spring Boot (‘whitelabel’ error page) is enabled in the starter. To switch to the Camunda error pages (webjar/META-INF/resources/webjars/camunda/error-XYZ-page.html
), please put them to the application folder structure under /src/main/resources/public/error/XYZ.html
.
Building Custom REST APIs
The Camunda Web Applications use a CSRF Prevention Filter
that expects a CSRF Token
on any
modifying request for paths beginning with /camunda/api/
or /camunda/app/
. Any modifying requests
mapped to these paths will fail, and the current session will be ended if no CSRF Token is present.
You can avoid this by registering your resources on different paths or add your resources to the
CSRF Prevention Filter Whitelist (via the configuration property camunda.bpm.webapp.csrf.entry-points
).