X4 Update Tool | X4Documentation

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>X4 Downloads.

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 the X4 Server, you need the X4 Server – 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 specifying arguments	None of the arguments for expert mode is specified: `--run server update` `--run repository update` `--run database update`
2	X4 Server update (expert mode)	Run an X4 Server update.	`--run server update` `--x4server` `--x4zip`
3	X4DB Update (expert mode)	Run an update of X4DB	`--run repository update` `--x4db`
4	X4 database update (expert mode)	Run a database update.	`--run database update` `--x4_jdbc` Optional: If not specified, these values are queried: `--x4_jdbc_user` `--x4_jdbc_password`
5	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.
`--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

Output of messages

The update tool uses the log4j framework to output messages. The following logging rules are set by default:

All messages from log level INFO are output in the console.
All messages from log level DEBUG are also saved in a log file.
The file is created under the name migration-<timestamp>.log and stored in the server directory.

If required, a separate log4j configuration can be integrated. To do this, start the update tool with the following option:

java -jar -Dlog4j.configurationFile=<Pfad-zur-log4j2.xml> …

You can find more information in the Update Tool README.txt and on the following pages: