Migration support

This section describes how the sedex Client installer supports the migration of a sedex Client to the version of the installer.

Verify prerequisites

• Both existing and new sedex Client must be installed on the same host.
• Only functional sedex Clients can be successfully migrated. The installer does not repair broken installations or replace expired certificates. If a sedex Client does not run properly or cannot connect to the sedex server and transmit messages, fix it before migrating it.
• The installer must have write privileges for the target root folder of the migrated sedex Client.
• The sedex Client must be stopped before migration.

Supported migration locations

The installer can migrate an existing sedex Client as follows:

• Migrate to a new root folder
• Migrate (update) “in place” in the existing root folder. In this case, the installer will create a backup copy of the current installation before migrating. The backup folder is named the same as the existing root folder, but is suffixed with “-backup”.

What is migrated

• The current state of messages and receipts are carried over to the migrated sedex Client.
• The current sedex Client’s properties and configurations (configured in *.properties, *.xml, or *.conf files) will be handled as follows:
  • Any new property keywords and their values will be used for the migrated sedex Client.
  • Except for special cases (none currently exist), the values of property keywords which were configured in the old version will be carried over to the migrated sedex Client.
  • Paths that were specified with the original installer (ex. interface folders) will be handled by the migration as follows:
    • Paths configured to point to subfolders of the current sedex Client’s root folder will point to the same subfolders under the new root folder.
    • Paths configured to point to folders outside the current sedex Client’s root folder will be carried over unchanged for the migrated sedex Client.
  • Depending on the versions involved in the migration, properties and configurations may be consolidated.

What is not migrated or updated

• Start and stop scripts are not migrated but replaced by new ones. If you have modified these scripts, you will have to carry those changes over manually.
• Log files and configurations of the log contents (for example adapter-logback.xml and controller-logback.xml) will not be migrated. They will still be available either under the old sedex Client root folder or under the backup of the old sedex Client root folder.

Prepare for migration

Stop the instance of the sedex Client that is to be migrated

• On Windows:

  1. If the sedex Client has been started as a Windows service, it must be stopped using the Windows Service Manager.

  2. If the sedex client has been started using the bat file, it must be stopped using the following script:

     <sedex_home>/bin/sedex-client-stop.bat

     or for older sedex Clients (5.x):

     <sedex_home>/bin/controller-stop.bat

• On Unix/Linux

  1. If the sedex Client has been started as a Linux daemon / service, it will be stopped during unregistration (see below).

  2. If the sedex client has been started using the sh file, it must be stopped using the following script:

     <sedex_home>/bin/sedex-client-stop.sh

     or for older sedex Clients (5.x):

     <sedex_home>/bin/controller-stop.bat

Unregister the old sedex Service

If the sedex Client was registered as a service or daemon, that service configuration must be unregistered by executing the following script.

On Linux, use postfix “D” if using systemd for daemons, or remove it if you are using system v.

• On Windows systems us the following script:

  <sedex_home>/bin/sedex-client-uninstallWindowsService.bat

  or for older clients (5.x):

  <sedex_home>/bin/controller-UninstallWindowsService.bat

• On Linux using System V use the following script:

  <sedex_home>/bin/sedex-client-uninstallWindowsService.sh

  or for older clients (5.x):

  <sedex_home>/bin/controller-UninstallWindowsService.sh

• On Linux using systemd use the following script:

  <sedex_home>/bin/sedex-client-uninstallWindowsServiceD.sh

  or for older clients (5.x):

  <sedex_home>/bin/controller-UninstallWindowsServiceD.sh

Run the installer program with migration support

Steps 1 – 6/23: Start installer

The initial steps are identical to a normal installation. Therefore, run the installer and perform the three steps as described in Choose an installer type to Run the installer program. Then continue with step 7 as follows.

Step 7/23: Migrate or install

This screen allows you to choose whether to migrate an existing installation or install a fresh version. Select ‘Migration support’ to migrate.

Step 8/23: Warning - Important information regarding the migration

This screen lists things that need to be taken into account to perform a successful and complete migration.

Step 9/23: Root Directory of Client to Migrate

This screen allows you to specify the root folder of the sedex Client which will be migrated.

You can choose to have the migration placed into the existing or a new root folder. If you choose the existing root folder, the installer will automatically make a backup copy of the current installation before migrating it.

Step 10/23: Installation Path

This screen allows you to choose the root folder for the migrated sedex Client. If you chose to have the migration placed into the existing folder, this screen will not be shown.

Step 18/23: Restricting File Access Permissions (Windows only)

The folders of the sedex client must be protected against unauthorized access so that only authorized users and business applications have access. By default, the sedex installer does not restrict the permissions on the created folders. Indicate whether the installer should restrict the permissions as follows:

User	Access
Group “Administrators”	Full Access
User “SYSTEM”	Full Access
Installing user	Full Access
All other users and groups	No permissions

Step 19/23: Summary Configuration Data

This screen displays a summary of all entered values so that you can review them before starting the installation and migration.

Step 20/23: Installation

Now the progress of the sedex Client installation and migration will be displayed. As soon as the progress bar shows “[Finished]”, press the “Next” button.

Step 21/23: Post-Migration Activities

This screen lists things that need to be done now that the migration has completed.

Step 23/23: Installation Finished

The installer can generate an XML-based script describing each step of the installation and the input you provided on each of the preceding screens. The file can be saved to document the installation or to do automatic reinstallations with the same values.

To generate the script, press the button in the middle of the screen.

The installer will write a log of the installation to <sedex_home>/installation.log.

Security issues and clean-up

For security reasons, the following should be done after the migration has completed successfully and the migrated sedex Client runs correctly:

• The certificate and its password should be removed from its old or backup location after the migration.
• If the interface folders were under the sedex Client root folder, the messages should be removed from their old interface folder location.