X4 Update Tool
To update existing versions of X4 BPMS, you need the Update Tool. You can find the latest version of the Update Tool on the SoftProject website under Resources > Software X4 BPMS.
General notes
- If you want to migrate the X4 Server of an older product line to the current product line, we recommend that you consult a SoftProject consultant who can assist you with the migration. SoftProject cannot assume any liability for updates performed by the customer.
- The X4 Server and Keycloak - ZIP Archive installation package is required for an update with the Update Tool if you want to update Keycloak or the X4 Server.
- A backup is automatically created during the update. However, we recommend that you back up your entire X4 installation before the update.
- If the Update Tool crashes during the update, it automatically restores the previous state of the X4 installation.
Options in the Update Tool
The Update Tool provides several options for updating:
| Option in update tool | Update Type | Description | Arguments (Commands in commandline) |
|---|---|---|---|
| 1 | Guided Update (recommended) | Run the Update Tool without any arguments. | No arguments |
| 2 | X4 Server update | Run a X4 Server update. | --x4server --zip |
| 3 | X4DB update | Run an update of X4DB. | --x4db |
| 4 | X4 database update | Run an X4 database update. |
Optional:
|
| 5 | X4 server as a windows service | Install the X4 Server as a Windows service. |
|
| 6 | Keycloak as a windows service | Install Keycloak as a Windows service. |
|
| 7 | Migration of custom placeholders (=global parameters) | Migration of custom placeholders (=global parameters) | |
| Not specified as an option | Fully automated update | For a fully automated update, run the Update Tool with all arguments. | All arguments |
List of Java Arguments
| Argument | Description |
|---|---|
-?, -h, --help | Displays the command line help. |
| Installs Keyloak as a Windows service. |
| Installs X4 as a Windows service. |
| Path to the Keycloak installation |
| JDBC URL for connecting to the X4 database |
| Password for the database user for the X4 database connection |
| Database user for the X4 database connection |
| Fully qualified path to the X4DB folder |
| Fully qualified path to the X4 Server folder |
| Fully qualified path to the ZIP file of the new X4 installation |
| In silent mode, the user interaction for the JDBC update is skipped. Warning! This may result in data loss. Create a database backup before using this argument! |
--dry-run | Simulation mode of the Update Tool |
You can find more information in the Update Tool README.txt and on the following pages: