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 8.0.18 and your current version is 8.0.3, you must complete all steps from patch version 8.0.4 up to and including patch version 8.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.

  • Component

    Components involved in the patch step.

  • Action

    Action(s) that must be performed.

Patch level 8.0.0

Process Engine - Updating Tomcat to 9.0.58

Action

As Tomcat has been updated automatically to version 9.0.58 during patch installation, check whether manual steps are necessary.

Proceed as follows

Refer to Updating Tomcat

Patch level 8.0.1

BPC Portal - Updating BPC Modules to Version 4.0.1

Patch level 8.0.2

BPC Portal - Updating BPC Modules to Version 4.0.2

Patch level 8.0.3

Manual step BEFORE patch installation required.

Including Password Manager in Backup File

Action

Process the following steps BEFORE starting the patch installer.

If required, include password manager details in backup archive (backup.zip). It will be used during migration/restore.

This is applicable only if the backup is taken before INUBIT 7.4.0.60.

Proceed as follows

  1. In the source system, enter the following command to start the CLI mode:

    ./startcli.sh -u root

  2. Enter the root password.

  3. Go to cache mode: CLI|root@HOSTNAME>cachemode

  4. Execute the following command to get aliases password data:

    CACHE|root@HOSTNAME>get PASSWORD_DATA “Alias_name“ /Path/to/XML_file_to_save/aliases.xml
  5. Create XML file` password_manager.xml`

  6. Copy the content of aliases.xml to password_manager.xml under tag IBISPasswordManager

    You can add multiple aliases with user and password under tag IBISPasswordManager

    Example:

    <?xml version="1.0" encoding="UTF-8"?>
    <IBISPasswordManager>
        <IBISAlias version="3.2">
            <Attrib>
                <Name>AliasName</Name>
                <Value>Tomcat</Value>
            </Attrib>
            <Attrib>
                <Name>Password</Name>
                <Value>AES-RGSLnzag0+JntHrcQ16ovg==</Value>
            </Attrib>
            <Attrib>
                <Name>UserName</Name>
                <Value>root</Value>
            </Attrib>
        </IBISAlias>
    </IBISPasswordManager>
  7. Add the password_manager.xml file to the /conf folder of the backup archive.

Patch level 8.0.4

No additional patch steps are required.

Patch level 8.0.5

BPC Portal - Updating BPC Modules to Version 4.0.5

Patch level 8.0.6

BPC Portal - Updating BPC Modules to Version 4.0.6

BPC - Updating Widgets Directory in the Global Repository

For BPC INUBIT webapp module and Process Interaction module users only.

Action

Synchronize files in the Widgets directories in the local Global Repository Hierarchy with the files stored in the corresponding directories on the Process Engine.

When updating the Widgets directory, files in the Global directory and its subdirectories are updated as new version, added, or deleted according to the content of the directories on the Process Engine.

Prerequisites

You are logged in to the Workbench as INUBIT administrator root.

Proceed as follows

  1. Open the Repository tab.

  2. Navigate to the Global > System > Widgets directory.

  3. Right-click the Widgets directory.

  4. Choose the Update directory menu item from the context menu.

    → The directory including its subdirectories is updated. No further message is displayed.

Patch level 8.0.7

No additional patch steps are required.

Patch level 8.0.8

BPC Portal - Updating BPC Modules to Version 4.0.7

BPC - Updating Widgets Directory in the Global Repository

For BPC INUBIT webapp module and Process Interaction module users only.

Action

Synchronize files in the Widgets directories in the local Global Repository Hierarchy with the files stored in the corresponding directories on the Process Engine.

When updating the Widgets directory, files in the Global directory and its subdirectories are updated as new version, added, or deleted according to the content of the directories on the Process Engine.

Prerequisites

You are logged in to the Workbench as INUBIT administrator root.

Proceed as follows

  1. Open the Repository tab.

  2. Navigate to the Global > System > Widgets directory.

  3. Right-click the Widgets directory.

  4. Choose the Update directory menu item from the context menu.

    → The directory including its subdirectories is updated. No further message is displayed.

Patch level 8.0.9

Action

Adapt the OAuth2-related properties during the deployment.

Proceed as follows

  1. Log in to the INUBIT Workbench as root.

  2. Open Configuration > Deployment.

  3. Open the ibis_deploy.xml file.

  4. Copy the desired OAuth2 properties depending on the modules or system connectors which were added or updated in the ibis_deploy_template.xml file.

  5. Click the OK button.

  6. Restart the INUBIT Process Engine.

If there is no manual configuration necessary, proceed as follows:

  1. Copy <inubit-installdir>/server/ibis_root/conf/ibis_deploy_template.xml file.

  2. Rename the file to ibis_deploy.xml.

  3. Remove the ibis_deploy.xml.bak file.

  4. Restart the INUBIT Process Engine.

BPC Portal - Updating BPC Modules to Version 4.0.8

Patch level 8.0.10

No additional patch steps are required.

Patch level 8.0.11

BPC Portal - Updating BPC Modules to Version 4.0.9

Patch level 8.0.12

Liferay Portal - Patching or Re-deploying Tasklist

Action

Patch or re-deploy Tasklist.

Prerequisites

You are using Tasklist or tasklists based on Tasklist on a Liferay portal.

Proceed as follows

  1. Log in to the INUBIT Workbench as administrator.

  2. Go to Administration > General Settings > Portal > Portal Deployment

  3. Open option Task Lists on the portal

  4. When using the default Tasklist, re-deploy the Tasklist.

  5. When using a custom copy of Tasklist:

    • Modify XSLT version to 3.0.:

      <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:inubit="http://inubit.com/xsl" version="3.0" exclude‑result‑prefixes="xs INUBIT">
    • Replace the line <xsl:param name="adHoc" as="element()"><nothing/></xsl:param> with

      <xsl:param name="adHocData"/>
      <xsl:param name="adHoc" select="parse‑xml‑fragment($adHocData)/Modules"/>
    • Save the changes.

    • Re-deploy the custom copy of Tasklist.

BPC Portal - Updating BPC Modules to Version 4.0.10

ibis.xml and logsDBConfig.xml - Changing Default Values

Action

If needed change the new default values of the following properties in the files ibis.xml and logsDBConfig.xml:

  • CheckValidConnection=true

  • noOfRetries=3

  • retryInterval=2000

Proceed as follows

  1. Open <inubit-installdir>/server/ibis_root/conf/ibis.xml.

  2. Change the default values of the properties CheckValidConnection, noOfRetries and retryInterval.

  3. Save ibis.xml in the <inubit-installdir>/server/ibis_root/conf directory.

  4. Open <inubit-installdir>/server/ibis_root/conf/logsDBConfig.xml.

  5. Change the default values of the properties CheckValidConnection, noOfRetries and retryInterval.

  6. Save logsDBConfig.xml in the <inubit-installdir>/server/ibis_root/conf directory.

Remote Connector - Merging Files

Action

Compare and merge the generated files with the suffix _patch.[bat|cmd|sh] and _backup.[bat|cmd|sh] after patch installation with original configuration:

  • Windows:

    • <inubit-installdir>/INUBIT/remoteConnector/bin/rc_nt_service_nssm_install_patch.cmd

    • <inubit-installdir>/INUBIT/remoteConnector/bin/rc_nt_service_nssm_uninstall_patch.cmd

    • <inubit-installdir>/INUBIT/remoteConnector/bin/start_rc_patch.bat

    • <inubit-installdir>/INUBIT/remoteConnector/bin/rc_nt_service_install_patch.cmd

    • <inubit-installdir>/INUBIT/remoteConnector/bin/rc_nt_service_uninstall_patch.cmd

  • Linux:

    • <inubit-installdir>/INUBIT/remoteConnector/bin: INUBITrc_patch

    • <inubit-installdir>/INUBIT/remoteConnector/bin: INUBITrcSystemd_patch

    • <inubit-installdir>/INUBIT/remoteConnector/bin: start_rc_patch.sh

    • <inubit-installdir>/INUBIT/remoteConnector/bin: remote_conf_backup.xml

Prerequisites

You have successfully executed the 8.0.12 patch installer for INUBIT.

Proceed as follows

  1. If Remote Connector is running as a service and the patch is applied for the same, stop Remote Connector Service.

  2. Go to folder <inubit-installdir>/INUBIT/remoteConnector/bin.

  3. If custom configurations exists, rename your existing files *.[bat|cmd|sh] to *_original.[bat|cmd|sh] to keep a backup of your configuration.

  4. Rename files _patch.[bat|cmd|sh] to .[bat|cmd|sh].

  5. If custom configurations exists, compare and merge files _original.[bat|cmd|sh] and .[bat|cmd|sh].

  6. If any backup files _backup.[bat|cmd|sh] has been created after patch installation compare and merge files *_backup.[bat|cmd|sh] and .[bat|cmd|sh].

  7. If Remote Connector is running as a service and the patch is applied for the same:

    • Uninstall Remote Connector Service:

      <inubit-installdir>/INUBIT/remoteConnector/bin/rc_nt_service_uninstall.cmd

    • Install Remote Connector Service:

      <inubit-installdir>/INUBIT/remoteConnector/bin/rc_nt_service_install.cmd

    • Start Remote Connector Service.

Patch level 8.0.13

Process Engine - Merging Files

This is an optional patch step.

Action

Compare and merge the generated files with the suffix _`patch.[bat|cmd|sh] `after patch installation with original configuration:

  • Windows:

    • <inubit-installdir>/INUBIT/bin/start_process_engine_patch.bat

    • <inubit-installdir>/INUBIT/bin/stop_process_engine_patch.bat

    • <inubit-installdir>/INUBIT/server/process_engine/bin/ibis_nt_service_nssm_install_patch.cmd

  • Linux:

    • <inubit-installdir>/INUBIT/bin/start_process_engine_patch.sh

    • <inubit-installdir>/INUBIT/bin/stop_process_engine_patch.sh

    • <inubit-installdir>/INUBIT/server/process_engine/bin/INUBIT_service_patch

Prerequisites

You have successfully executed the 8.0.13 patch installer for INUBIT.

Proceed as follows

  1. If Process Engine is running as a service and the patch is applied for the same, stop Process Engine Service.

  2. Go to folder <inubit-installdir>/INUBIT/bin.

  3. If custom configurations exists, rename your existing files *.[bat|cmd|sh] to *_original.[bat|cmd|sh] to keep a backup of your configuration.

  4. Rename files _patch.[bat|cmd|sh] to .[bat|cmd|sh].

  5. If custom configurations exists, compare and merge files _original.[bat|cmd|sh] and .[bat|cmd|sh].

  6. If Process Engine is running as a service and the patch is applied for the same:

    • Uninstall Process Engine Service:

      <inubit‑installdir>/INUBIT/server/process_engine/bin/ibis_nt_service_nssm_uninstall.cmd

    • Install Process Engine Service:

      <inubit-installdir>/INUBIT/server/process_engine/bin/ibis_nt_service_nssm_install.cmd

    • Start Process Engine Service.

BPC - Updating Widgets Directory in the Global Repository

For BPC INUBIT webapp module and Process Interaction module users only.

Action

Synchronize files in the Widgets directories in the local Global Repository Hierarchy with the files stored in the corresponding directories on the Process Engine.

When updating the Widgets directory, files in the Global directory and its subdirectories are updated as new version, added, or deleted according to the content of the directories on the Process Engine.

Prerequisites

You are logged in to the Workbench as INUBIT administrator root.

Proceed as follows

  1. Open the Repository tab.

  2. Navigate to the Global > System > Widgets directory.

  3. Right-click the Widgets directory.

  4. Choose the Update directory menu item from the context menu.

    → The directory including its subdirectories is updated. No further message is displayed.

Process Engine - Updating Tomcat to 9.0.68

Action

As Tomcat has been updated automatically to version 9.0.68 during patch installation, check whether manual steps are necessary.

Proceed as follows

Refer to Updating Tomcat

Patch level 8.0.14

BPC Portal - Updating BPC Modules to Version 4.0.12

Updating SFTP Cipher algorithms

If you are facing SFTP connection issues after patching INUBIT 8.0.14, you have to configure the SFTP Cipher algorithms within the Workbench Server Configuration. Refer to Administration Guide.

If already -D jvm parameters configuration for JSch was set in setenv.[bat|sh] file, it will be overridden by the configuration implemented within the Workbench.

Action

Remove existing -D jvm parameters set for JSch in setenv.[bat|sh] file.

Prerequisites

You have successfully executed the 8.0.14 patch installer for INUBIT.

Proceed as follows

Removing the existing -D jvm parameters set for JSch in the setenv.[bat|sh] file is optional.

  1. Go to <inubit-installdir>/server/process_engine/bin directory.

  2. Open setenv.[bat|sh] file for editing.

  3. Remove -D jvm parameter set for JSch.

    Example:

    set JVM_PARAMS=%JVM_PARAMS% -DJSch.kex=diffie-group14-sha1

  4. Save setenv.[bat|sh] file.

Updating scripts

Action

Adapt scripts for the Process Engine, INUBIT Workbench, and Remote Connector.

Prerequisites

You have successfully executed the 8.0.14 patch installer for INUBIT.

Proceed as follows

Process Engine

  1. Create the back-up of setenv.[sh/bat] from <install_dir>/INUBIT/server/process_engine/bin.

  2. Rename setenv.[sh/bat] to setenv_backup.[sh/bat].

  3. Rename setenv_patch.[sh, bat] to setenv.[sh/bat].

  4. If you made any changes to the existing setenv_backup.[sh/bat], adjust setenv.[sh/bat] accordingly.

INUBIT Workbench

  1. Create the back-up of start_workbench.[sh/bat] from <install_dir>/INUBIT/client/bin and <install_dir>/inubit/bin.

  2. Rename start_workbench.[sh/bat] to start_workbench_backup.[sh/bat].

  3. Rename start_workbench_patch.[sh/bat] to start_workbench.[sh/bat].

  4. If you made any changes to the existing start_workbench_backup.[sh/bat], adjust start_workbench.[sh/bat] accordingly.

Remote Connector

  1. Create the back-up of start_rc.[sh/bat] from <install_dir>/INUBIT/remoteConnector/bin.

  2. Rename start_rc.[sh/bat] to start_rc_backup.[sh/bat].

  3. Rename start_rc_patch.[sh/bat] to start_rc.[sh/bat].

  4. If you made any changes to the existing start_rc_backup.[sh/bat], adjust start_rc.[sh/bat] accordingly.

Patch level 8.0.15

Changing Repository Workspace Path

This is an optional patch step.

Action

Change Repository workspace path to an absolute path.

Prerequisites

You have successfully executed the 8.0.15 patch installer for INUBIT.

Proceed as follows

  1. Open <inubit-installdir>/server/ibis_root/conf/repository.xml file for editing.

  2. Go to entry:

    <Workspace name="${wsp.name}">
        <FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
            <param name="path" value="${wsp.name}"/>
        </FileSystem>
  3. Change param value to <param name="path" value="${rep.home}/workspaces/${wsp.name}"/>

  4. Open workspace.xml files for editing located in the directories:

    • <inubit-installdir>/server/ibis_root/ibis_data/repository/workspaces/ibis

    • <inubit-installdir>/server/ibis_root/ibis_data/repository/workspaces/security

  5. Go to entry:

    <FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
        <param name="path" value="${wsp.name}"/>
    </FileSystem>
  6. Change param value to <param name="path" value="${rep.home}/workspaces/${wsp.name}"/>

  7. Delete previously created empty folders, which will not be used anymore with above changes.

    • <inubit-installdir>/bin/ibis

    • <inubit-installdir>/bin/security

BPC Portal - Updating BPC Modules to version 4.0.13

8.0.16

Update BPC modules to version 4.0.14

Load external references in XML

Prerequisites

It is not mandatory to configure these JVM properties.

By default, external DTD and external entity loading are disabled, DOCTYPE is allowed but not resolved.

The loading of XML is used extensively in INUBIT. This starts with the configuration files, continues with the communication between Workbench and Process Engine, also includes the execution of modules up to the display of watchpoints in a technical workflow.

Proceed as follows

For change those default settings additional JVM properties must be set in the start scripts of Workbench, CLI, Server or Remote Connector. The following properties are allowed:

-DDISABLE_EXTERNAL_DTD

true (default) | false

Deactivate (true) or activate (false) loading of external DTDs

-DDISABLE_DOCTYPE

true | false (default)

Disallow (true) or allow (false) DOCTYPE usage in XML

-DDISABLE_EXTERNAL_ENTITY

true (default) | false

Deactivate (true) or activate (false) resolving of external entities inside XML

Example

To adjust the configuration in the Process Engine startup script, the following file is opened: <inubit_install_path>/process_engine/bin/setenv.sh

And adds the following lines to the JVM_PARAMS block:

JVM_PARAMS="$JVM_PARAMS -DDISABLE_EXTERNAL_DTD=true"
JVM_PARAMS="$JVM_PARAMS -DDISABLE_DOCTYPE=true"
JVM_PARAMS="$JVM_PARAMS -DDISABLE_EXTERNAL_ENTITY=true

8.0.17

Update EDIGAS files in repository

This step is optional and only necessary if you use EDI in connection with EDIGAS messages using auto-detection.

Requirement

  1. The INUBIT Process Engine has started

  2. You are connected to the process engine with a workbench

  3. You have access to the repository

How to proceed

  • Update the EDIGAS-MESSAGES.xml file in the repository

    1. Switch to the Repository tab

    2. Select the following path in the navigation tree: Global > System > EDI Specification > Rule Metadata

    3. Switch to the file table

    4. Right-click to open the context menu and select the following entry: "Import"

    5. Use the file EDIGAS-MESSAGES.xml

    6. Alternatively, you can also import this zip file directly under Global.

  • Remove the EDIGAS-SUBSETS.xml file from the repository

    1. Switch to the Repository tab

    2. Select the following path in the navigation tree: Global > System > EDI Specification > Rule Metadata

    3. Right-click on the "EDIGAS-SUBSETS.xml" file in the table on the right

    4. Execute the following entry from the context menu: "Delete…​"

  • Remove the EDIGAS-SUBSETS.xml file from the server file system

In addition to deleting from the repository, the file (if any) must also be removed from the INUBIT server file system at <inubit-installdir>/inubit/server/ibis_root/ibis_data/repository/deploy/Global/System/EDI Specification/Rule Metadata to prevent deployment to the repository the next time the Process Engine is started.

Process Engine - Updating JDK to 11.0.18

Action

As the java distribution has been updated automatically to version 11.0.18 during patch installation, check whether manual steps are necessary.

Proceed as follows

Refer to Updating JDK

Update BPC modules to version 4.0.15

8.0.18 Spring 2023

Workbench - Update the Widgets directory in the repository

Running the patch updates the files widget.xsl and widget_bpc.xsl in the repository. If you have made any manual adjustments to these files, create a backup before running the patch.

This step is optional and only necessary if one the below folders is not appearing in the Workbench after patching:

  • Global > System > Widgets > ExtTreePanel

  • Global > System > Widgets > resources

Tree Widgets is used by BPC INUBIT WebApp module and Process Interaction module.

Prerequisites

  1. Process Engine is up and running.

  2. You are logged-in into a Workbench as a System Administrator.

Proceed as follows

  1. Switch to tab Repository

  2. In the navigation tree choose the following path: Global > System > Widgets.

  3. Open the context menu by right-clicking the folder Widgets in the tree.

  4. Click on the action Update directory.

  5. The directory including its subdirectories will be updated.

  6. The missing folders and their content will be visible afterward.

BPC - Temporary activation to load inline JavaScript in a browser

This step is required if you are using INUBIT WebApp or INUBIT Process Interaction module in BPC.

The above modules use JavaScript, which is located directly in the HTML output. By default, the Karaf instructs browsers not to execute such JavaScript code. In order for the modules to work, this Content-Security-Policy-Header statement in the Karaf must be adapted so that browsers execute such JavaScript code.

Prerequisites

  • Karaf’s configuration file jetty.xml has been relocated as described here

  • BPC/Karaf has been stopped

Proceed as follows

  1. Open the file jetty.xml

  2. Locate the section "Set Response Headers"

        <!-- ==================== -->
        <!-- Set Response Headers -->
        <!-- ==================== -->
        <Call name="insertHandler">
            <Arg>
                <New id="RewriteHandler" class="org.eclipse.jetty.rewrite.handler.RewriteHandler">
                    <Set name="rules">
                        <Array type="org.eclipse.jetty.rewrite.handler.Rule">
                               ...
                        </Array>
                    </Set>
                </New>
            </Arg>
        </Call>
  3. Find the Item element "header-csp".

    1. If no such element exists add a new Item element.

  4. To the element <Set name="value"> add behind script-src the value 'unsafe-inline'.

  5. The Item element should look like this:

    <Item>
      <New id="header-csp" class="org.eclipse.jetty.rewrite.handler.HeaderPatternRule">
        <Set name="pattern">/*</Set>
        <Set name="name">Content-Security-Policy</Set>
        <Set name="value">script-src 'self' 'unsafe-eval' 'unsafe-inline'; connect-src 'self'; img-src 'self' data:; style-src 'self' 'unsafe-inline'; font-src 'self'; frame-ancestors 'self'; form-action 'self'; worker-src 'self' blob: ;</Set>
      </New>
    </Item>
  6. Safe and close the file

  7. Now you can start BPC/Karaf

Process Engine - Updating Tomcat to 9.0.73

Action

As Tomcat has been updated automatically to version 9.0.73 during patch installation, check whether manual steps are necessary.

Proceed as follows

Refer to Updating Tomcat

Update BPC modules to version 4.1.0

8.0.19

Remove Elasticsearch

Since Elasticsearch is no longer used from BPC version 4.1.0 and replaced by Opensearch.

Prerequisites

  • BPC is used together with Opensearch

  • All data are available in Opensearch

Proceed as follows

  1. Stop the BPC

  2. Run the patch installer and update the BPC installation

    1. Opensearch will be installed and configured.

    2. For a manual conversion, follow the instruction.

  3. Navigate to the <bpc_install_dir>/bpc folder.

  4. Back up all necessary files and folders in the elasticsearch sub-folder

  5. Remove the elasticsearch subdirectory

  6. Start the BPC

Update BPC modules to version 4.1.1

8.0.20

Only standard patch steps are required.

8.0.21

BPC - Temporary activation to load inline JavaScript in a browser

This step is required if you are using INUBIT WebApp or INUBIT Process Interaction module in BPC and encounter problems related to JavaScript code execution.

By default, the Karaf applies CSP restrictions informing browsers to prevent inline JavaScript code execution. In order for the affected modules to work, any JavaScript must be loaded via referencing the resource properly.

As a temporary workaround the inline JavaScript execution can be re-enabled by setting a specific module property.

Enabling inline JavaScript execution is potentially a security risk. Virtimo recommends strongly to rework all JavaScript usage towards using JS files referenced from within the HTML.

Prerequisites

  • BPC is up and running

  • BPC user with admin rights is logged in

Proceed as follows

  1. Open the INUBIT WebApp modules configuration tab in BPC

  2. Select the module instance where the inline JavaScript should be re-enabled

  3. In the specific module’s configuration set the property "SanitizeHTML" to value false (deselect checkbox).

Process Engine - Updating JDK to 11.0.19

Action

As the java distribution has been updated automatically to version 11.0.19 during patch installation, check whether manual steps are necessary.

Proceed as follows

Refer to Updating JDK

Update BPC modules to version 4.1.2

8.0.22

Checking the API key stored for BPC

Requirements

  • The INUBIT is linked to the BPC Portal

  • An API key was stored in the server configuration under Portal > Portal server > BPC

How to proceed

  1. Log in to the Process Engine using the workbench

  2. Go to the Administration > General Settings tab

  3. In the tree structure on the left, select Portal > Portal server

  4. Check the value for the "API Key for the BPC connection" option

  5. If the value is filled, you do not need to do anything else

  6. If the value is empty, continue here

  7. Click on the "…​" button on the right in the same table row

  8. In the "API key for the BPC connection" dialog that opens, select an API key from the dropdown or click on the New button

  9. As soon as a new API key is displayed, close the dialog by clicking on the OK button

  10. Click on the Save button in the toolbar → The BPC API key is now set and updated accordingly on the Process Engine

Update BPC modules to version 4.1.3

8.0.23

Workbench - Update the IS Configuration directory in the repository

Running the patch installer updates the file configuration.xml under Global> System> Mapping templates > IS Configuration in the repository. If you have made any manual adjustments to the file, create a backup before running the patch.

Prerequisites

  1. Process Engine is up and running.

  2. You are logged-in into a Workbench as a System Administrator.

Proceed as follows

  1. Switch to tab Repository

  2. In the navigation tree choose the following path: Global > System > Mapping Templates> IS Configuration

  3. Open the context menu by right-clicking the folder IS Configuration in the tree

  4. Click on the action Update directory

The directory including its subdirectories and configuration.xml file will be updated and ready to be used.

8.0.24

Update BPC modules to version 4.1.5

8.0.25 Winter 2023

Update OAuth2 properties of system diagrams

Prerequisites

  • The INUBIT Process Engine is started and available

Do the following

  1. Log in as System Administrator with the INUBIT Workbench.

  2. From the burger menu, open Configuration > System Diagrams.

  3. Open the systemdiagram_config.xml file.

  4. Apply all OAuth2 properties from the systemdiagram_config_template.xml file.

  5. Click the OK button*.

  6. Restart the INUBIT Process Engine

Process Engine - Updating Tomcat to 9.0.80

Action

As Tomcat has been updated automatically to version 9.0.80 during patch installation, check whether manual steps are necessary.

Proceed as follows

Refer to Updating Tomcat

Process Engine - Updating JDK to 17.0.7

Action

As the java distribution has been updated automatically to version 17.0.7 during patch installation, check whether manual steps are necessary.

Proceed as follows

Refer to Updating JDK

Process Engine – Update H2 database

Prerequisites

The H2 database is used as an INUBIT internal database.

The use of the H2 database is not recommended for productive use.

Action

By updating INUBIT to this version, a previously used H2 database file will no longer be accessible. Therefore, the contents of this database must be backed up before patch installation.

Do the following

  1. Stop the Process Engine

  2. Back up the H2 database file with the following command:

    java -cp h2-<old-driver-version>.jar org.h2.tools.Script -url jdbc:h2:/<path-to-old-db-file>/<database-name> -user <username> -script backup.zip -options compression zip

    The file backup.zip is created, which contains the contents of the H2 database.

  3. Remove the following files:

    • <inubit-installdir>/inubit/server/ibis_root/ibis_data/database/<h2-db-file-name>

    • If present: <inubit-installdir>/inubit/server/ibis_root/log/dbh2

  4. Run the patch installer

  5. Restore the backed up H2 database content:

    java -cp h2-<new-driver-version>.jar org.h2.tools.RunScript -url jdbc:h2:/<path-to-new-db-file>/<database-name> -user <username> -script backup.zip -options compression zip

    The database file is restored from the file backup.zip at the specified path.

Using the latest script files

Action

Start the Process Engine

INUBIT is now being rolled out with JDK 17. To do this, various script files in INUBIT had to be adapted. In order to use these changes to the script files, manual adjustments are necessary.

Proceed as follows

Follow the instructions under updating script files.

Update BPC modules to version 4.1.8

8.0.26

Only standard patch steps are required.

8.0.27

Only standard patch steps are required.

8.0.28

Process Engine – Prevent disclosure of server information

It is considered a potential security vulnerability to leak server information (server name, version, etc.) in responses sent by a server application. This type of information has already been removed from all server responses, the only exception being the error responses.

Action

Updating the INUBIT with the patch installer also removes the server information from error responses.

The content of the server response is controlled via the <ErrorReportValue> entry in the server.xml file. For more information, see here.

Proceed as follows

  • Check the server.xml file. It should not contain an ErrorReportValue entry. If so, we recommend checking the file entry manually after running the patch installer.

  • Run the patch installer. The necessary entry <ErrorReportValue> is added or adjusted in the server.xml file.

Manual check

  • Open the server.xml file

  • Find the lines with the entry <ErrorReportValve>

  • Make sure: showServerInfo="false"

The value false indicates that no server information should be sent in error responses.

Further adjustments to the ErrorReportValue are possible. For more information, see here.

8.0.29

Only standard patch steps are required.

8.0.30

Add IGUASU connector in system diagram and deployment

Action

It is necessary to update the systemdiagram_config.xml file to override the IGUASU Connector module properties in system diagrams.

Process as follows

  • Go to the burger menu and open the "Configuration" menu

  • Open the "System diagrams…​" entry within the configuration.

  • Switch the view of the systemdiagram_config.xml file to text format

  • At the end of the file add the following entry:

    <Resource name="IGUASU Connector">
       <Target class="com.inubit.ibis.configuration.workflowtool.systemdiagram.shapes.ExtSystem"/>
       <Properties>
         <Property name="IguasuURL" type="String" displayName="ServerURL"/>
       </Properties>
    </Resource>
  • Save the systemdiagram_config.xml file

  • Close the dialog

Action

It is necessary to update the ibis_deploy.xml file to override module properties of the IGUASU Connectors in deployment.

Proceed as follows

  • Go to the burger menu and open the "Configuration" menu

  • Open the "Deployment…​" entry within the configuration.

  • Switch the view of the ibis_deploy.xml file to text format

  • At the end of the file add the following entry:

    <Property name="IGUASU Connector" type="ListProperty">
       <Property name="IguasuURL" type="String" displayName="ServerURL"/>
       <Property name="IguasuCallableFlowKey" type="String" displayName="FlowID"/>
    </Property>
  • Save the ibis_deploy.xml file

  • Close the dialog

After completing the above steps, restart the Process Engine and Workbench.

8.0.31

Update BPC modules to version 4.1.9