Starting the Update Tool

How to start the Update Tool

A backup is automatically created during the update.

However, we recommend that you create a backup of your entire X4 installation before updating.

1. Download the Update Tool from the SoftProject webseite (https://www.softproject.de/en/downloads/) to a folder outside your X4 BPMS installation.

2. Open the folder in which you have saved the Update Tool.

3. Open the command line (Command Line Interface) by entering cmd in the address bar of the file explorer.

4. Start the Update Tool de.softproject.x4.update-<Version>.jar with the command java -jar de.softproject.x4.update-x.x.x.jar.

   Example

   CODE

   path_to_update_tool> java -jar "de.softproject.x4.update-x.x.x.jar"

If the path or file name contains spaces, insert the path or file name in brackets "...".

How to start the Update Tool if Java is not installed

If Java is not installed, you have two options:

1. Install Java via Download:
   You can install a Java Development Kit (JDK). We recommend at least Java version 11.  You can download JDKs at https://adoptium.net/de/temurin/releases/?version=11.
   After the installation, Java is available in the Windows environment variables and can be used in the command line.

   If you use this option, you can run the Update Tool using the java -jar command:
   java -jar "de.softproject.x4.update-x.x.x.jar"

   Example with Java installed via download

   CODE

   path_to_update_tool> java -jar "de.softproject.x4.update-x.x.x.jar"

2. Run Java via java.exe:
   You can use the Java Development Kit that is included with X4 BPMS. To do this, copy the jdk folder with the java.exe file from the <Server_directory>\jdk\bin\java.exe folder to another folder outside your X4 BPMS installation, e.g. to the folder where your Update Tool is located.

   If you use this option, run the Update Tool using the following command:
   path_to_update_tool>"folder\jdk\bin\java.exe" -jar "de.softproject.x4.update-x.x.x.jar"

Example with java.exe

path_to_update_tool>"folder\jdk\bin\java.exe" -jar "de.softproject.x4.update-x.x.x.jar"

If the path or file name contains spaces, insert the path or file name into brackets "...".

The Update Tool guides you through the update process

The Update Tool starts and guides you through the update process:

1. Enter the number for the update you want to perform, e.g. 4.

2. The Update Tool guides you through the process.

Note on updating custom files

Custom files (e.g. adapters, extensions, modules) that are NOT included in

<server_directory>\wildfly\modules\system\layers\base\de\softproject\x4\extensions\main\module.xml

will NOT be migrated!

You need to manually migrate these files by changing the following file at the new location:

<server_directory>\Server\wildfly\modules\de\softproject\extensions\main\module.xml.