X4 Help Center
X4 Help Center
Breadcrumbs

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 Information

  • 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 will assist you with the migration. SoftProject cannot assume any liability for updates performed by the customer.

  • If you want to update Keycloak or the X4 Server, you need the X4 Server and Keycloak - ZIP archive installation package for an update with the Update Tool.

  • 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 the Update Tool

Update Type

Description

Arguments (command line commands)

1

Guided update (recommended)

Guided update without arguments

No arguments

2

X4 Server update

Run an X4 Server update.

--x4server --zip

3

X4DB update

Run an update of X4DB.

--x4db

4

X4 database update

Run a database update.

--x4_jdbc

Optional:

If not specified, these values are queried:

--x4_jdbc_user

--x4_jdbc_password

5

X4 Server as a Windows service

Install the X4 Server as a Windows service.

--installX4Service
--x4server

6

Keycloak as a Windows service

Install Keycloak as a Windows service.

--installKeycloakService
--keycloakPath

7

Migrating custom placeholders (=global parameters)

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

--backup

Optional. Path to a previously manually created backup. If the argument is not specified, a backup is automatically created.

--installKeycloakService

Installs Keycloak as a Windows service.

--installX4Service

Installs X4 as a Windows service.

--keycloakPath

Path to the Keycloak installation

--x4_jdbc

JDBC URL for connecting to the X4 database

--x4_jdbc_password

Password for the X4 database connection database user

--x4_jdbc_user

Database user for the X4 database connection

--x4db

Fully qualified path to the X4DB folder

--x4server

Fully qualified path to the X4 Server folder

--zip

Fully qualified path to the ZIP file of the new X4 installation

--silent

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: