Upgrade to B2Bi 2.3.1

Important: Due to local configurations that are only accessible by the user that performed the initial installation (for example, registry entries and environment variables), the updater must be executed by the same user as the installation.

An upgrade to B2Bi 2.3.1 requires uninstalling the previous version of B2Bi and then installing B2Bi 2.3.1, while conserving the database. The database content is automatically upgraded during the first startup of the newly installed product.

After the upgrade, you must manually restore any custom components you created in B2Bi 1.5. For details, see the Upgrade procedure.

Note   In cases where you are upgrading from B2Bi 1.5 with the embedded Synchrony Database, you must select an alternative database for the upgrade. The Synchrony Database is no longer supported.


  • B2Bi 2.3.1 license file for each machine
  • B2Bi 2.x latest service pack installed (if upgrading from 2.x)
  • B2Bi 1.5 SP10 (or later) installed (If upgrading from 1.5)
  • Contact Axway support for assistance in the upgrade process.

Upgrades if running a multi-node cluster

If you are running a multi-node cluster, you must repeat the upgrade procedure for each node in the cluster. There is a minor difference in the “post-upgrade” procedures for clusters. This is because the automatic upgrade of the database schema is completed during the upgrade of the first node, and is not repeated for subsequent node upgrades.

Upgrades from Synchrony Database

B2Bi 2.3.1 does not support either the Synchrony Database or the more recent version of this database known as the Axway Database.

When upgrading from an environment with the Synchrony Database you must select an alternative database, for example, MySQL (where the Synchrony Database is built).

Upgrades with Secure Relay installed

If you are upgrading from a B2Bi implementation in which you use Secure Relay, see the related section in the overview topic. Also, see Upgrade B2Bi with Secure Relay.

Upgrades with shared paths (B2Bi 1.5 and onward)

When you install B2Bi 1.5 (or onward), the installer prompts you for the common directory path, and supplies a suggested path that includes the "/common" directory. For example:


When you install B2Bi 2.3.1, the B2Bi installer prompts you for the "shared directory location", with the following display text:

Shared directory location


Enter the location of the shared directory to store documents and other files. If you plan to run the application on multiple machines in a cluster, the directory must be available to all of the machines.

NOTE: Potentially large amounts of data will be stored here.

This directory will contain the common directory which will be created if it does not already exist.

The default location of the B2Bi 2.3.1 “common directory” is .../opt/axway/B2Bi/shared, however you can enter any directory you choose. The simplest procedure when upgrading is to point the new B2Bi installation to the shared directory defined for your existing B2Bi instance.

To do this:

  1. In the B2Bi installation go to <B2Bi_install_directory>/Interchange/conf/ and open filereg.xml in a text editor.
  2. Locate the attribute: <File name="commonPath" path="[file_path]"/> and note the [file_path] value.
  3. Important: The path you enter for the shared directory must not include the /common element, because the installer automatically appends this element to the shared path.
  4. Run the B2Bi installation, and when prompted, enter the shared path you noted above, without the /common extension. For example, if <File name="commonPath" path="/Axway/Interchange/common"> then enter "/Axway/Interchange".

Migration for new shared location

If you use a new shared location, you must copy the shared/common/ directory to the new (empty) shared location prior to the new B2Bi migration. This creates the directory structure for Application pickup and the Trading pickup (related to FTP embedded server and SFTP embedded server).

Uniqueness of objects and exchange contexts

When upgrade B2Bi, you should take into consideration uniqueness requirements.

See: Uniqueness in B2Bi

Before you begin

Be sure to back up each of these items before you upgrade.

Back up the environment

Back up the entire B2Bi installation, before an upgrade procedure, in case you need to revert to the old installation for any reason.

Copy the license.xml file

Go to <B2Bi_1.5_install_directory>\Interchange\conf and copy/save the file license.xml.

Back up the database

Make a backup of the database before an upgrade procedure, in case you need to revert to the old installation for any reason.

Back up the common directory

Create a copy of (rename) the B2Bi common directory, in order to keep copies of the numerous files that are copied and restored in the upgrade procedure. This enables you to roll back to the old installation if for any reason the upgrade procedure fails or is interrupted.

See Upgrades with shared paths (B2Bi 1.5 and onward).

Back up custom components and customizations

Back up all custom components and other customizations. The following table lists items to consider for backup:

Item Location
Custom Java libraries <B2Bi_Shared_Dir>\local\java\lib
MBCs (Message Builder Components) <B2Bi_Shared_Dir>\local\4edi\component
Custom MB libraries <B2Bi_Shared_Dir>\local\4edi\lib
Custom MB includes <B2Bi_Shared_Dir>\local\4edi\include
Inline processor (must be installed on each node) <B2Bi_Install_Dir>\Interchange\site\jars

After the upgrade, you must redeploy DML maps to the deployment server from Mapping Services, or through the command line API on the server itself.


Alternatively, maps can be saved from the deployment server cache.



You must then confirm the map update in the B2Bi UI as described in the post-upgrade procedure.

Private keys <B2Bi_shared_directory>\common\conf\keys
Unique Counters <B2Bi_shared_directory>\data\unique
tuning.properties file

If you applied environment-specific tuning in previous versions of B2Bi that you want to retain for 2.3.1, you should back up and restore the tuning.properties file to the updated installation at the following location:


Note The tuning.properties file must be identical on every node in the cluster.

jvmArguments.xml file

If you have created any customized classes or jars and added references to these items in jvmArguments.xml in previous versions of B2Bi that you want to retain for 2.3.1, you should back up and restore the jvmArguments.xml file to the updated installation at the following location:


The customized classes and jars must also be backed up and restored to the updated installation.

Back up runtime data

If you are upgrading to B2Bi 2.3.1 from previous version of B2Bi, to preserve the runtime data (payloads) produced by the B2Bi trading engine, you must make copies of the following files, and restore them in their original location after the upgrade:

• Files that are located in <common_dir>\data\backup

• Files that are located in <common_dir>\data\filestore

B2Bi 1.5 upgrades: Check EDIFACT Messaging Profiles

In some cases, when you upgrade a B2Bi 1.5 configuration with EDIFACT Messaging Profiles to B2Bi 2.3.1, Agreements are not generated to handle the EDIFACT documents.

This result occurs when a B2Bi 1.5 EDIFACT Community Messaging Profile that does not have all four sub-identifiers filled in, is used in an EDIFACT v4 partner messaging profile (by using 'Specify community' in the Identification tab). After you upgrade, the Community Messaging Profile is transformed to an EDIFACT v3 Messaging ID, which is incompatible with the EDIFACT v4 Partner Messaging ID. As a result the Agreement is not created.

Before you begin the upgrade to B2Bi 2.3.1, in the B2Bi 1.5 configuration, fill in all four sub-identification fields for Community Messaging Profile EDIFACT Messaging IDs.

Upgrade procedure

Before you start this procedure, make sure you have completed the preparatory steps, see Before you begin.

  1. Stop B2Bi.
  2. Go to the existing <B2Bi_install_directory>/Interchange/conf/ and open filereg.xml. Note the location of the current installation common folder. You will need to provide this information in the 2.3.1 installer to specify the location of the share and common folders.
  3. See Upgrades with shared paths (B2Bi 1.5 and onward) for additional information.
  4. Stop the B2Bi product.
  5. Uninstall B2Bi.
  6. After uninstalling, check the installation directories. You can see that the .../Integrator and .../Interchange folders are still present, and that they contain installer-related items in them. Additionally, the share directory contains the common folder. These folders and their contents can now be deleted.
  7. Log out of your operating system and log on again.
  8. Install B2Bi 2.3.1. Make sure that you have met the prerequisites for this installation, see B2Bi prerequisites.
  9. When prompted by the installer, enter a valid shared path. For example you can use the common folder location that you noted in step 2 of this procedure.
  10. For additional information, see Upgrades with shared paths (B2Bi 1.5 and onward).
  11. Install the latest service pack.
  12. Restore all custom components and other customizations:
    • Custom components and customizations
    • Runtime data
  13. Start B2Bi.

Upgrade procedure from 2.3.0

IMPORTANT: To upgrade to B2Bi 2.3.1, you are required to stop B2Bi 2.3.0 due to the addition of a new port in B2Bi 2.3.1. Failure to stop B2Bi before you upgrade to B2Bi 2.3.1 will cause the installer to allocate new ports.

Before you start this procedure, make sure you have completed the preparatory steps, see Before you begin.

To upgrade from B2Bi 2.3.0 to B2Bi 2.3.1:

  1. Stop B2Bi 2.3.0.
  2. Start the 2.3.1 installer on the machine where 2.3.0 is installed.
  3. When prompted to update the existing installation, select Update. You are presented with information of where the original installation is backed up and asked to backup the existing database before updating. It is highly recommeneded that you perform a full back up of your database.
  4. Select Next to continue. The upgrade is started and the information for the ports is displayed as a new port was added to B2Bi 2.3.1. The following tasks are completed for the upgrade:
    • Original installation is backed up (except for the data directories)
    • Configuration is updated
    • New files are installed
    • Obsolete files are deleted
  1. Apply any changes were made to the files in <B2Bi_install_directory>/Interchange/conf/. You can locate the content of the original directory in <B2Bi_install_directory>/backup/<version>/Interchange_conf.zip.
  2. If the update is done in silent mode, add the following variables to the response file:
    • sys.confirmedUpdateInstallation=true
    • BackupInstallation=true
    • RestoreInstallation=false
  1. When the installation is started, you are asked if the original installation should be restored. CAUTION: ONLY restore the installation if an issue occurred with the update and you need to revert to the previous version.

After the upgrade

Execute post upgrade tasks

See Post-upgrade procedures.

Discover B2Bi 2.3.1

The organization and configuration of the objects that define message exchanges has changed significantly in B2Bi 2.x. For details of changes and a comparison with earlier versions, see Changes in data model from B2Bi 1.x to 2.x.

Related Links