Patch Level Update

This guide explains how to perform a patch level update. The patch level is the version number “after the second dot”. Example: update from 2.1.2 to 2.1.2.

Database Patches

Between patch levels, the structure of the database schema is not changed. The database structure of all patch releases is backward compatible with the corresponding minor version. Our database schema update guide provides details on the update procedure as well as available database patches.

Special Considerations

This section describes noteworthy potentially breaking changes when you update to the respective patch levels.

2.1.2 to 2.1.3

Multi-engine support

In CIB seven 2.1.3, multi-engine support was introduced, and CIB seven webclient was updated to use the extended REST API endpoints that include engine names. For example, before 2.1.3, the webclient connected to:

/process-definition/key

Now, it connects to:

/engine/<engine_name>/process-definition/key

In the next release, we plan to further improve this feature, so that the extended endpoints are used only for alternative engines, ensuring full backward compatibility with existing configurations.

Expected Impact

We expect no impact for most users. If you have custom Spring Boot configurations, please review your authentication filter configuration and ensure that the /engine/* endpoint is included in the urlPatterns array. Alternatively, update your configuration to the recommended general URL pattern /*, which enables the authentication filter for all required endpoints:

  String[] urlPatterns = Arrays.asList("/*")
    .stream()
    .map(pattern -> addUrl(restApiPathPattern, pattern))
    .toArray(String[]::new);

Full Distribution

This section is applicable if you installed the Full Distribution with a shared process engine. In this case you need to update the libraries and applications installed inside the application server.

Please note that the following procedure may differ for cluster scenarios. Contact our support team if you need further assistance.

• Shut down the server
• Exchange CIB seven libraries, tools and webapps (EAR, RAR, Subsystem (Wildfly), Shared Libs) - essentially, follow the installation guide for your server.
• Restart the server

Application With Embedded Process Engine

In case you use an embedded process engine inside your Java Application, you need to

1. update the Process Engine library in your dependency management (Apache Maven, Gradle …),
2. re-package the application,
3. deploy the new version of the application.

Applying Multiple Patches at Once

It is possible to apply multiple patches in one go (e.g., updating from 2.1.0 to 2.1.3).