Windows B2Bi Server installation

For Windows installations of the B2Bi Server, you can run the B2Bi installer using either a graphic user interface or a command console interface. Each interface presents the same installation options.

  • Console mode: In this mode, you configure the B2Bi installation through a system console display.
  • Graphic mode: In this mode, you configure the B2Bi installation through a graphic installation interface

Console mode

The following describes how to WindowsB2Bi Server installation in Console mode:

  1. Go to the Windows Start menu and type cmd.
  2. Right-click cmd.exe (displays under "Programs" at the top of the screen) and select Run as administrator. The DOS window is displayed.
  3. Navigate to the directory where the B2Bi installer file is downloaded.
  4. Launch the installer for the Server:
    start /wait b2bi-installer-server-<platform><version><build>-server.exe -c

Installer console mode initialization

In the initialization phase of B2Bi installation you must:

  • Accept the Axway license agreement
  • Select the type of installation infrastructure you require (single host or multi-host)
  • Specify the installation directory

Complete the Server installation process

After you have configured the Server for installation, the installer presents you with an installation summary and prompts you to launch the installation process. When the process has been successfully completed, the installer displays an "Installation successful" message and a summary of completed installation tasks. You can quit the installer or add any updates.

Tip   To reconfigure, add products, remove products, or update your installation run the installer again in the appropriate mode.

Graphic mode

The following describes how to WindowsB2Bi Server installation in Graphic mode:

  1. Navigate to the directory where you downloaded the B2Bi Server installer file:
  2. b2bi-installer-server-win-64-2.3.0-<build_number>-server.exe
  3. Right-click on the file.
  4. Select Run as administrator.
  5. The Installer program opens the graphical installation interface. Complete the requested information.
Page Description
Welcome Welcome message.
License Agreement Accept the terms to continue.
Select Destination Directory

Accept the default directory, or use the Browse tool to select a preferred installation location.

Upgrade Information
  • Upgrade from Interchange 5.10.1 or later – Select this option if you already have Interchange 5.10.1 or later installed and you want to upgrade the installation to B2Bi2.3.1.
  • If you select this option you must specify the root directory of the Interchange installation.
  • For details of upgrading from Interchange to B2Bi, see the B2Bi Interchange Upgrade Guide, available at
Shared Directory Location

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

If you are installing on Windows and plan to cluster on multiple computers, specify a common directory path in the Uniform Naming Convention (UNC) format. This is a name that uses the fully-qualified domain name of the computer rather than a drive letter as part of the path.

See Troubleshoot Universal Naming Conventions.

Non-default Directory Location

You can accept the directory locations that the installer uses by default, or select the option to Use non-default directory locations.

If you select this option, you can then specify the following non-default directory locations:

  • Integrator root directory
  • Integrator local directory
  • Integrator data directory
  • B2Bi solutions directory
  • B2Bi tmp directory
  • B2Bi shared root directory
  • B2Bi shared data directory
  • B2Bi shared local directory
  • Interchange shared directory
License File Location Enter the location of the B2Bi license file.
Database Type

Select a database type to use with Interchange:

  • MySQL
  • Oracle
  • Microsoft SQL Server
  • DB2
Database Information

Enter the connection information for the database.

These fields vary depending on the type of database you selected in the previous screen.

See Configure databases.

PassPort AM Configuration

Use Passport AM – Select this option if you are using PassPort for user access management. If you select this option, enter values for:

  • PassPort host – The name of the machine where PassPort is installed.
  • PassPort port – The PassPort access port on the supporting machine.
  • Shared secret – Enter the PassPort shared secret that you specified during PassPort installation.
  • Confirm shared secret
Port Range Allocation

Accept the default range, or specify a range of ports in which the installer must allocate the required B2Bi ports. A minimum of 371 free ports must be available in the specified range.

  • minimum value (default = 8832) – The minimum allowed value is 1024.
  • maximum value (default = 10000) – The maximum allowed value is 65535.

The installer uses this port range to allocate the B2Bi ports. The installer checks for free ports within the specified range. If there are an insufficient number of free ports available in the range, you are prompted to increase the range.

The port allocations that are made by the installer are written to the file:


After installation, you can modify the port allocation values. See Manage server ports.

Important: Do not assign ports from the server's ephemeral range. The use of ports in this range may cause integration engine tasks to stop and attempt to restart, with the error "failed to bind socket: Address already in use."

Service attributes

For Windows installations only, enter values for:

  • Service Parameters
    • Service name – Enter a service name, or accept the default.
    • Service display name – Accept the default or enter the name of the service as you want it to display in the Windows service screen.
  • User authentication
  • The user account you enter here must have Administrative privileges to the server, and must have the "Log on as a Service" privilege. See Windows user rights.
    • Username – Accept the default
    • Domain – Accept the default
    • Password – Enter the password for the Window user account
    • This is the password for the Windows user under which you are installing B2Bi. This password enables the installer to create services in Windows. This is not the password for the Integrator user.
Configure Farm Client

Farm server enabled

This option requires pre-installation of the B2Bi farm server. For details, see Farm Server installation.

  • If you want to operate this instance of the B2Bi server in a cluster farm and have already installed the cluster farm server, select this option and enter the farm host and server port.
  • If you want to operate this instance of the B2Bi server in a cluster farm and have not yet installed the cluster farm server, clear this option and complete this B2Bi server installation. You can then install the farm server, note the connection parameters, and run this server installer in "configure" mode to enable the farm server.
  • If you do not want to operate this instance of the B2Bi server in a cluster farm, clear this option and continue the installation.
B2Bi Core Server Configuration (1)

Set the B2Bi configuration:

  • Number of CPUs – Select the number CPUs of your host machine (2,4,6 or 8). Default = 2.
  • The number of CPUs is used only during installation to calculate initial settings. It is not saved or used for anything else.
  • Message size limit for caching message content in memory – Accept the default (16384) or enter a new cache size value.
  • Use Sentinel – Indicate if you are using Sentinel for B2Bi monitoring.
  • Enable online archive – Select this option if you want to create an online archiving task in the trading engine. This task enables you to view and manage message archives from the Document Tracker tool of the B2Bi System Manager.
B2Bi Core Server Configuration (2)

Select the server connectors to use:

  • MQ (WebSphere MQ)
    • MQ mode server/client
  • WebEDI – Optionally select to use WebEDI. If you select this option, enter the WebEDI Portal URL. Also see Email in this section.
  • SAP ALE – When you select the SAP connector you can select the option to Use Unicode.
  • Warning: The B2Bi client only provides non-unicode SAP integration support. When using B2Bi to create custom integrations that include a SAP ALE connector, or when using the B2Bi client to import older XIB datasets that have SAP integrations, the SAP ALE connector on the B2Bi server must be installed in non-unicode mode.
  • FTP
  • File system
  • HTTP
  • Email – If you selected WebEDI, you must also select this when trying to use WebEDI. If you do not, then the messages are not sent, and remain active.
  • Secure Transport
  • Enable Migration Connectors- Select this option to make HTTP and FTP connectors available on the Partner side.
  • A migration connector is an implementation of an integration engine transport protocol connector that is exposed as a B2Bi trading partner exchange in the B2Bi user interface. This connector has been implemented for backwards compatibility and ease of migration from AMTrix environments. It should only be used for AMTrix migration purposes, in cases where regular B2Bi transports cannot be used.

  • JMS
  • Execute Map As A Service – Select this option to enable the REST APIs for listing and running maps. If you select this option you must also enter a Port number for the REST API connection to the server.
SAP connector

Select this option if you are using the ALE SAP server connector. If you select this option, you must then specify the location of the SAP libraries on your network so that they can be copied by the installer to the B2Bi installation. In most cases your SAP libraries are located here:


B2Bi SAP exchanges require SAP version 3.0.9 libraries.

B2Bi Server: JMS configuration

If you selected the JMS Connector in the previous screen, enter the JMS connection parameters:

  • Provider name – Example: OpenJMS
  • Initial context factory name – Example: com.swiftmq.jndi.InitialContextFactoryImpl
  • Connection factory name – Example: plainsocket@router1 or QueueConnectionFactory22
  • Provider URL – Example: smqp://localhost:4001/timeout=10000
Select Start Menu Folder For Windows installations only, select the Start Menu folder in which you would like to create shortcuts. The default folder is Axway Software.

Complete the installation process

Click Next to launch the installation. Complete installation may require several minutes. When installation is complete a summary page displays information about the installation, including any installation errors.

Related Links