Version-dependent patch steps

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

Enter the root password.

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

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

Create XML file` password_manager.xml`

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

<?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>

Add the password_manager.xml file to the /conf folder of the backup archive.

Open the Repository tab.

Navigate to the Global > System > Widgets directory.

Right-click the Widgets directory.

Choose the Update directory menu item from the context menu.

Open the Repository tab.

Navigate to the Global > System > Widgets directory.

Right-click the Widgets directory.

Choose the Update directory menu item from the context menu.

Log in to the INUBIT Workbench as root.

Open Configuration > Deployment.

Open the ibis_deploy.xml file.

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

Click the OK button.

Restart the INUBIT Process Engine.

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

Rename the file to ibis_deploy.xml.

Remove the ibis_deploy.xml.bak file.

Restart the INUBIT Process Engine.

Log in to the INUBIT Workbench as administrator.

Go to Administration > General Settings > Portal > Portal Deployment

Open option Task Lists on the portal

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

When using a custom copy of Tasklist:

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

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

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

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

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

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

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

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

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

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

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

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].

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

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

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

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

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

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

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

Open the Repository tab.

Navigate to the Global > System > Widgets directory.

Right-click the Widgets directory.

Choose the Update directory menu item from the context menu.

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

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

Remove -D jvm parameter set for JSch.

Save setenv.[bat|sh] file.

Create the back-up of setenv.[sh/bat] from <inubit-installdir>/inubit/server/process_engine/bin.

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

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

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

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

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

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

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

Create the back-up of start_rc.[sh/bat] from <inubit-installdir>/inubit/remoteConnector/bin.

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

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

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

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

Go to entry:

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

Change param value to <param name="path" value="${rep.home}/workspaces/${wsp.name}"/>

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

Go to entry:

<FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
    <param name="path" value="${wsp.name}"/>
</FileSystem>

Change param value to <param name="path" value="${rep.home}/workspaces/${wsp.name}"/>

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

The INUBIT Process Engine has started

You are connected to the process engine with a workbench

You have access to the repository

Process Engine is up and running.

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

Switch to tab Repository

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

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

Click on the action Update directory.

The directory including its subdirectories will be updated.

The missing folders and their content will be visible afterward.

Open the file jetty.xml

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>

Find the Item element "header-csp".

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

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>

Safe and close the file

Now you can start BPC/Karaf

Stop the BPC

Run the patch installer and update the BPC installation

Navigate to the <bpc_install_dir>/bpc folder.

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

Remove the elasticsearch subdirectory

Start the BPC

Open the INUBIT WebApp modules configuration tab in BPC

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

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

Log in to the Process Engine using the workbench

Go to the Administration > General Settings tab

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

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

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

If the value is empty, continue here

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

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

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

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

Process Engine is up and running.

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

Switch to tab Repository

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

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

Click on the action Update directory

Log in as System Administrator with the INUBIT Workbench.

From the burger menu, open Configuration > System Diagrams.

Open the systemdiagram_config.xml file.

Apply all OAuth2 properties from the <inubit-installdir>/inubit/server/ibis_root/conf/systemdiagram_config_template.xml file.

Click the OK button*.

Restart the INUBIT Process Engine

Stop the Process Engine

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

Remove the following files:

Run the patch installer

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

Read Keycloak Migration Guide to learn about the latest migration changes.

Stop the Keycloak server if it is running.

Read Preparing for upgrading and follow the preparation steps.

Run the Virtimo Digitalization Suite patch installer and upgrade to the latest Keycloak version on your computer.

Read Migrating the database and follow the database migration steps.

Read the remaining sections like Migrating themes and follow the instructions.

Once all the above steps are completed, start the Keycloak server.

Login to Keycloak admin console and navigate to Realm Settings and change the value of "Unmanaged attributes" to "Enabled"

Navigate to Authentication and then to Required Actions tab . Change the value of "Verify Profile" to "off"

Stop the Process Engine

Remove the provider-specific JMS JAR file from <inubit-installdir>/inubit/server/process_engine/webapps/ibis/WEB-INF/lib

Start the Process Engine

Stop the Process Engine

Rename the plugin.xml.bak into plugin.xml under <inubit‑installdir>/server/ibis_root/conf>.

Add JSON Formatter plugin details to the plugins.xml:

<Plugin>
    <Name>JSON Formatter</Name>
    <PluginGroup>Utilities</PluginGroup>
     <ClientJavaClass>de.virtimo.inubit.plugins.jsonformatter.JSONFormatterClient</ClientJavaClass>
    <ClientComment>JSON Formatter</ClientComment>
    <ServerJavaClass>de.virtimo.inubit.plugins.jsonformatter.JSONFormatter</ServerJavaClass>
    <ServerComment>JSON Formatter</ServerComment>
    <Image>icons/60x40.colored/json_formatter.svg</Image>
    <PluginComment/>
    <LastUpdateUser>root</LastUpdateUser>
    <LastUpdateTime>25.09.2024 10:00:00</LastUpdateTime>
</Plugin>

Rename profile.xml.bak into profile.xml under <inubit‑installdir>/server/ibis_root/conf>.

Add the entry below entry to all the profiles which need this plugin:

<Use>JSON Formatter</Use>

Save all changes

Start the Process Engine