X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Option 2: Updating the X4 Server

General Information

This option allows you to update only the X4 Server without updating the X4DB folder, X4 database, and Keycloak database.

The following steps are performed during the update:

  1. Backup of the existing X4 Server

  2. Unpacking of the new X4 Server installation

  3. Copying of the X4DB folder into the new installation

  4. Copying of the configurations and deployments folders into the new installation

  5. Migration of configurations (de.softproject.x4.database.X4ConfigurationMigration)

  6. Migration of Keycloak

  7. Migration of WildFly expansion modules

Note on updating custom files

Custom files (e.g. adapters, extensions, modules) that are NOT stored in the <server_directory>\wildfly\modules\system\layers\base\de\softproject\x4\extensions\main\module.xml folder will NOT be migrated!

These files must be migrated manually by saving them here: <server_directory>\Server\wildfly\modules\de\softproject\extensions\main\module.xml.

If you have also made changes in WildFly, for example, in the standalone.xml file, these changes will not be adopted and must be done manually.

Steps in detail

The Update Tool guides you through the individual steps:

  1. Backup your X4 Server
    Backup: <Folder>\X4_7-3-1_Release\Server_bak_2024-02-29_12-56-19 successfully created

  2. Unzip your X4 Server installation
    (-> The Update Tool unzips the new X4 Server installation to which you want to migrate your data in a new folder.Successfully unzipped to: <Folder>\X4_7-3-1_Release\Server

  3. Copy your X4DB folder
    (→The Update Tool copies the X4DB folder.)
    Successfully copied
    <Folder>\X4_7-3-1_Release\Server_bak_2024-02-29_12-56-19\X4DB-02-29\X4DB to <Folder>\X4_7-3-1_Release\Server\X4DB

  4. Copy your configurations and deployments folders.
    Successfully copied
    <Folder>\X4_7-3-1_Release\Server_bak_2024-02-29_12-56-19\configurations
    to
    <Folder>\X4_7-3-1_Release\Server\configurations
    Successfully copied
    <Folder>\X4_7-3-1_Release\Server_bak_2024-02-29_12-56-19\deployments
    to
    <Folder>\X4_7-3-1_Release\Server\deployments

  5. Migrate your configurations

Update Tool Note for the configuration migration (de.softproject.x4.database.X4ConfigurationMigration):

  1. Make sure the memory settings have been adjusted to the new X4 version and meet the minimum requirements:

    1. Check the startX4.bat file for Windows installations and the X4-Server file for Linux installations.

    2. Check the standalone.conf.bat file for Windows installations if the X4 Server is installed as a service.

  2. Check the standalone.xml file to ensure that the <datasources> are configured correctly.

  3. For Oracle database installations:

    1. After the migration, you need to install the appropriate driver. You can find more information on how to set up an Oracle database here: (7.4.0-en) Setting up an Oracle database .

  4. Any configuration files that are not part of X4 will not be migrated. You need to migrate these manually.

  1. Migrate your Keycloak
    Successfully migrate keycloak to the current installation (update tool message)

  2. Migrate your WildFly extensions modules

This migration applies to a migration from X4 BPMS version 7.3.x to X4 BPMS 7.4.x.

The WildFly Extension modules are moved from

<server_directory>\wildfly\modules\system\layers\base\de\softproject\x4\extensions

to

<server_directory>\wildfly\modules\de\softproject\extensions

Custom dependencies and resources are also moved:

  • Path before migration: <server_directory>\wildfly\modules\system\layers\base\de\softproject\plugins\mai

  • Path after migration: <server_directory>\wildfly\modules\de\customer\custom\adapter

If you have made changes to your WildFly, for example, in the standalone.xml file, these changes are not adopted and need to be done manually.

  1. After the migration, verify that your custom changes from <Folder>\X4_7-3-1_Release\Server_bak_2024-02-29_12-56-19\wildfly\modules\system\layers\base\de\softproject\x4\extensions\main\module.xml (e.g. custom adapters, custom implementations and extensions) have been applied correctly and migrated to the new site: <Folder>\X4_7-3-1_Release\Server\wildfly\modules\de\softproject\extensions\main\module.xml.

After a successful update, the Update Tool generates a message:

Completed. BYE BYE!