Version-dependent patch steps

To upgrade to the desired version, you must perform all applicable patch steps from the following list whose patch level is higher than the current patch level and lower than or equal to the target version.

For example, if you want to upgrade to the target version 9.0.18 and your current version is 9.0.3, you must complete all steps from patch version 9.0.4 up to and including patch version 9.0.18.

In case a patch step occurs several times, you must execute it once only (e.g., Tomcat updates).

List structure

  • Patch level

    Patch level requiring a manual patch action. Patching is necessary if you patch from a minor version to the indicated or to a higher version.

  • Prerequisites

    Conditions that must be met for you to perform the patch step manually.

  • Action/Proceed as follows

    Action(s) that must be performed.

9.0.0

Only standard patch steps are required.

9.0.1

Only standard patch steps are required.

9.0.2

Only standard patch steps are required.

9.0.3

Only standard patch steps are required.

9.0.4

Only standard patch steps are required.

9.0.5

Only standard patch steps are required.

9.0.6

Only standard patch steps are required.

9.0.7

New Leaky Bucket Settings

Usage

The fault tolerance setting in the Process Engine determines how quickly the Process Engine shuts down in the event of database connection problems.

Previous settings resulted in shutdown even after just a few connection interruptions. Therefore, the default settings have been revised to tolerate more connection interruptions.

Proceed as follows

Copy the setting from the ibis.xml_patch file placed by the patch installer into your ibis.xml file.

New values

<Property name="DBErrorHandlerBucketSize" type="Integer">10000</Property>
<Property name="DBErrorHandlerReductionSize" type="Integer">100</Property>
<Property name="DBErrorHandlerLeakInterval" type="TimePeriod">10</Property>

Old values

<Property name="DBErrorHandlerBucketSize" type="Integer">25</Property>
<Property name="DBErrorHandlerReductionSize" type="Integer">4</Property>
<Property name="DBErrorHandlerLeakInterval" type="TimePeriod">3600</Property>

Impacts:

  • Application - Process Engine

Prevent database dead locks

While this patch step is optional. We highly recommend performing it before you start the Process Engine.

Requirements

For regular database cleanup batch processing has been introduced with INUBIT-22257. The size of the batch is configurable by adding the configuration to the logsDBConfig.xml file in use.

Proceed as follows

  1. Stop the Process Engine (if not already done)

  2. Open the file <inubit-installdir>/inubit/server/ibis_root/conf/logsDBConfig.xml, maybe logsDBConfig.xml.bak

  3. Add the following section inside the <dataEntriesLimit> element:

    <dataEntriesLimit>
        ...
<!-- Chunk size for batch deletion to prevent lock contention on large DELETE operations.
        Rows are deleted in chunks with intermediate commits to release locks and allow
        concurrent INSERT operations to proceed.
        Default: 5000 rows per chunk
        Tuning: Increase for large tables with infrequent deletes; decrease if lock contention persists
        -->
       <batchDeleteChunkSize>5000</batchDeleteChunkSize>
</dataEntriesLimit>

  4. Save the changes as logsDBConfig.xml file.

  5. Start the Process Engine

Impacts:

  • Application - Process Engine

Use new feature by Keycloak

This patch step is optional.

Requirements

Keycloak has been updated to 26.6.1.

Proceed as follows

  1. Open the file <inubit-installdir>/inubit/server/ibis_root/conf/keycloak_template.json

  2. Add the following section inside the "documentation": element in between "admin-group-priority" and "client-ids" :

    "group-description": "If added, fetches the Keycloak group descriptions alongside the group names. If not added, group descriptions are ignored.",

  3. Save the changes as keycloak_template.json file.

Impacts:

Virtimo Cluster Manager Update

This INUBIT version updates the Cluster Manager to include the behavioral change described in Changelogs.

Prerequisites

You are using the Virtimo Cluster Manager. The patch installation has not yet been performed.

Action before running the patch installer

  1. On all cluster nodes, open the configuration file located at <SUITE-INSTALL-DIR>/inubit/server/ibis_root/conf/clustermanager/virtimo_cluster_config.xml.

  2. Ensure that there is only one node with the highest priority value:

    <properties>
...
<priority>...</priority>
...
</properties>

  3. Save the changes.

  4. Update the node with the highest priority first.

  5. Start this node so that it rejoins the cluster.

  6. Now update the remaining cluster nodes (one by one).

  7. You can then restore the previous priority configuration.

Impacts:

9.0.8

Applying custom changes to web.xml

This step of the patching process is required if custom changes have been made to the web.xml file.

Prerequisites

  1. The patch installation has been completed successfully.

Procedure

  1. Stop the Process Engine.

  2. Locate the files web.xml and web_<timestamp>.xml.bak in the directory <inubit-installdir>/inubit/server/process_engine/webapps/ibis/WEB-INF.

  3. Compare the backup file web_<timestamp>.xml.bak with the newly created web.xml to identify custom changes that were present in the previous version.

  4. Manually transfer the required changes from the web_<timestamp>.xml.bak file to the new web.xml.

  5. Save the changes to the web.xml file.

→ The Process Engine can now be restarted.

Impacts:

9.0.9

Restore the maximum request parameter count

This patch step is required if the application requires support for more than 1,000 request parameters.

Requirements

Tomcat 11.0.x reduced the default maxParameterCount from 10,000 to 1,000. If the application or existing integrations rely on the previous limit of 10,000 parameters, the value must be explicitly configured.

Proceed as follows

  1. Open the file <inubit-installdir>/inubit/server/process_engine/conf/server.xml

  2. Locate the HTTPS <Connector> configuration.

  3. Add the following attribute to the <Connector> element:

    maxParameterCount="10000"

  4. The resulting HTTPS Connector should look similar to the following:

    <Connector
      port="8000" protocol="HTTP/1.1" URIEncoding="UTF-8"
      connectionTimeout="20000"
      maxThreads="100"
      enableLookups="false" redirectPort="8443"
      acceptCount="100"
      compression="on"
      compressionMinSize="2048"
      compressibleMimeType="text/html,text/xml,text/javascript"
      maxParameterCount="10000"
      server=" "
/>

  5. Save the changes to the server.xml file.

Configuration

The maxParameterCount attribute defines the maximum number of request parameters that Tomcat parses for a request.

Setting it to 10000 restores the previous limit and maintains compatibility with configurations that relied on the previous Tomcat default.

Update the SSL Connector protocol

This patch step is required when upgrading to Tomcat 11.

Requirements

Tomcat 11 no longer supports the Http11Nio2Protocol connector. The connector must therefore be changed to the supported Http11NioProtocol.

Proceed as follows

  1. Open the file <inubit-installdir>/inubit/server/process_engine/conf/server.xml

  2. Locate the HTTPS <Connector> configuration using Http11Nio2Protocol.

  3. Replace:

    protocol="org.apache.coyote.http11.Http11Nio2Protocol"

    with:

    protocol="org.apache.coyote.http11.Http11NioProtocol"

  4. The resulting HTTPS Connector should look similar to the following:

    <Connector port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol"
            maxThreads="150" SSLEnabled="true">
    <UpgradeProtocol className="org.apache.coyote.http2.Http2Protocol" />
    <SSLHostConfig>
         <Certificate certificateKeystoreFile="conf/localhost-rsa.jks"
                 certificateKeystorePassword="changeit" type="RSA" />
    </SSLHostConfig>
</Connector>

  5. Save the changes to the server.xml file.

  6. Restart the inubit Process Engine.

Configuration

The protocol change is required because Http11Nio2Protocol is no longer available in Tomcat 11.

The change moves the HTTP connector from Java NIO.2 asynchronous I/O to the Java NIO-based HTTP/1.1 connector.

The change does not require modifications to application-level Servlet or REST APIs. HTTPS remains enabled through SSLEnabled="true", and the existing SSL certificate configuration remains unchanged.

The HTTP/2 configuration using Http2Protocol can remain unchanged.

Impacts:

Press Esc to exit full screen
Modal image placeholder
Press Esc to exit full screen