Upgrade Camunda to use OMN Search

Since OMN 5.10.0 most Camunda workflow views are now using an OMN Search index to fetch data. Therefore, OMN Search and an additional Camunda plugin are required components to use Camunda workflow views from now on.

Upgrade Guide (from OMN 5.9.x or lower)

OMN Accelerator based systems will update and configure the following steps automatically

Prerequisites

newest version of OMN Search is installed (Installation of OMN Search)
newest versions of Camunda and Workflow-Component are installed (Installation of OMN Workflow)

Upgrade steps

In order to keep the new workflow index FS_TABLE_WFL up-to-date we introduced a Camunda engine-plugin that sends update requests to OMN Search for every workflow change event. To enable this plugin you have to configure it in the bpm-platform.xml config file of the camunda container.

Accessing bpm-platform.xml

This config file is located in the camunda container at /camunda/conf/bpm-platform.xml
You can use MINIO (see ACC config) or a manual bind mount to expose this file and make changes persistent.

The additional bind mount can be added to the docker-compose.yml and could look like the following snippet:

- ./configfiles/bpm-platform.xml:/camunda/conf/bpm-platform.xml

Make sure to use a recent version of the bpm-platform.xml included in the camunda container as base file to place in your config directory. You can get this file out of the container via the following command:

docker cp <camunda-container-name>:/camunda/conf/bpm-platform.xml ./configfiles/bpm-platform.xml

Modifying bpm-platform.xml

Please make sure that the Camunda history level is set to full. The related property history is also found in the bpm-platform.xml and is required to generate all the needed events for this plugin.

The following xml snippet must be added into the <plugins> </plugins> section of the bpm-platform.xml file and the example values need to be adjusted according to the rules stated below.

<plugin>
    <class>de.apollon.omn.wfl.ext.camunda.search.OmnSearchUpdateEnginePlugin</class>
    <properties>
        <property name="searchApiUrl">http://web.d.cmda-dev.omn.ap.farm:8070/api/v1</property>
        <property name="searchApiUser">ap-admin</property>
        <property name="searchApiJwtSecret">secret-value</property>
        <property name="searchApiMandator">omn</property>
    </properties>
</plugin>

searchApiUrl: must point to a valid URL where the OMN API is reachable. The URL must be resolvable inside the camunda container.
searchApiUser: Is currently only used in the jwt-token for identification and has no further meaning, so it can stay ap-admin.
searchApiJwtSecret: JWT token used for authentication with OMN API. Must correspond with the frontend key that is configured in OMN config files.
searchApiMandator: must correspond with the OMN mandator name.

After adjusting the config a container restart is needed.

Good to know

The newly added workflow index for Camunda FS_TABLE_WFL is automatically generated based upon the entries of all related FS_TABLE configurations in OMN.
When a workflow FS_TABLE config is modified an index rebuild is required to make the data appear in the frontend again.

Troubleshooting & Known Issues

When you start a workflow or modify the state of a workflow and the changes are not visible in the table-view a manual refresh may be needed.
The UI does currently not wait for the index update to be finished, so it can happen that the automatic page refresh happens before the index is updated. This will be reworked in the future.
When absolutely no data is shown or the data is out of sync with Camunda you can rebuild the index like all other indexes in the OMN Search view.