Installing with the IIM in GUI mode

You can install Sterling B2B Integrator in a non-cluster or cluster environment with the IBM® Installation Manager (IIM) in a graphical user interface (GUI) mode.

Before you begin

  • Complete the Prerequisites for installing Sterling B2B Integrator.
  • Complete the Installation checklist.
  • Ensure that you have the correct version of JDK. For more information, see Java Requirements.
  • If you are creating adapter containers, you must install IBM MQ before you create the adapter containers. You must also configure the Properties for messaging queues.
  • If you are using the Standards Processing Engine (SPE) application with Sterling B2B Integrator, you must install SPE before you install Sterling B2B Integrator.
  • If you are using the EBICS Banking Server application with Sterling B2B Integrator, the data encryption for storage within the installation location is not supported.
  • If you are upgrading to Sterling B2B Integrator from a previous version, you must manually install the EBICS client. For more information about installing the EBICS Client manually, see the EBICS Client User Guide.
  • Note: The clustered environment does not support AS2 Edition.

About this task

Consider the following points when you install Sterling B2B Integrator in a cluster environment:
  • You can install and upgrade through the user interface or silent installation mode (response files). Console mode installation and upgrade is not supported.
  • Sterling B2B Integrator JAR file is included in the repository. Therefore it is not required to manually select the JAR file when installing or upgrading.
  • You must use correct version of the IIM to install or upgrade Sterling B2B Integrator. For more information, see The IBM Installation Manager (IIM).
  • InstallService is disabled, and cannot be used to install Sterling B2B Integrator. You can use InstallService, only for a specific scenario related to Sterling File Gateway. For more information, see step 10.


  1. If you are using the Windows operating system, close all open programs and all command prompt windows.
  2. Start the Installation Manager.
    Table 1. Starting the IBM Installation Manager
    Condition Action
    If you do not have the Installation Manager installed and are using the Installation Manager agent Go to the IM_<operating_system> directory and run the following command.
    • For Windows: userinst.exe
    • For Unix/Linux: ./userinst
    If you have a 64-bit Installation Manager installed. Go to the IM_<operating_system> directory and run the following command.
    • For Windows: userinst.exe
    • For Unix/Linux: ./userinst
    If you have Installation Manager installed on a platform that has only one download available for Installation Manager. For example, AIX, zLinux. Go to the IM_<operating_system> directory and run the following command.
    • For Windows: userinst.exe
    • For Unix/Linux: ./userinst
    If you have 32-bit Installation Manager installed on a Linux or Windows system.
    • For Windows: Go to <installation directory>\Installation Manager\eclipse and type IBMIM.exe.
    • For Unix/Linux: Go to <installation directory>/Installation Manager/eclipse and type ./IBMIM
  3. If IM_<operating_system> and b2birepo directories are not in the same directory or if you already have Installation Manager installed, then you must add the Sterling B2B Integrator repository files to the Installation Manager repository. For more information about adding repository files, see Repository preferences.
  4. Optional: It is suggested to record a response file. The response file can be used to install Sterling B2B Integrator after applying database schema manually or install second and subsequent nodes in a cluster. For more information, see Installing or updating with a response file.
  5. On the Installation Manager home page, click Install.
    Note: If you get a message saying that there no packages to install or Installation Manager could not connect to the repositories, go back to step 3 and add the Sterling B2B Integrator repository files to the Installation Manager repository.
  6. On the Install Packages screen, select IBM Sterling B2B Integrator. This action selects the versions also. Click Next.
  7. Review the license agreement and select the option I accept the terms in the license agreement.

    If you do not accept the agreement, the installation process does not continue.

  8. Select the location for the Shared Resources Directory and click Next. This directory is used by the Installation Manager for the Sterling B2B Integrator installation and other installations.

    The shared resources directory cannot be a subdirectory of the directory for the installation of Sterling B2B Integrator. The shared resources directory must be empty.

  9. Choose Create a new package group and specify the path to Sterling B2B Integrator Installation Directory.

    If you install Sterling B2B Integrator using IIM, the installation directory structure for v6.0 has changed from the directory structure in v5.2.6.x. The installation files for 6.0 are located in the <install_dir>/ directory.

    The installation files for 5.2.6.x were located in the <install_dir>/install/ directory.

  10. Select the required features to be installed.
    The available options are:
    • IBM Sterling B2B Integrator
    • IBM Sterling File Gateway
    • FIPS Module
    • AS2 Edition Module
    • Financial Services Module
    • EBICS Banking Server Module
    • B2B Advanced Communications Integration Module
    • Sterling B2B Integrator is selected by default. Select only the licenses and features that were defined by your IBM contract. If you are unsure which to select, the installation can proceed without a selection and complete successfully. Startup and operation of the software, however, requires one of the licenses to be selected. See License modifications to apply licenses after the installation.
    • For Sterling B2B Integrator V5.2.6 or later, Sterling File Gateway is automatically installed if IBM Sterling File Gateway is selected. Any additional post installation tasks are not required to start Sterling File Gateway. It is strongly suggested to install Sterling File Gateway when installing Sterling B2B Integrator. If for any reason Sterling File Gateway is not installed with Sterling B2B Integrator, you cannot install Sterling File Gateway later by using the Installation Manager. Install Sterling File Gateway after you install Sterling B2B Integrator by following the instructions in License modifications.
    • When installing Sterling B2B Integrator, select B2B Advanced Communications Integration Module to install Sterling B2B Integrator bridge. Sterling B2B Integrator bridge is required for communication between Sterling B2B Integrator and B2B Advanced Communications. If you are installing Global Mailbox and Sterling B2B Integrator, then B2B Advanced Communications Integration Module (Sterling B2B Integrator bridge) is installed by default, because Global Mailbox uses the storage module of B2B Advanced Communications. However, you must configure the adapter containers and adapters for Sterling B2B Integrator bridge after installing.
  11. Type the path to your JDK directory and click Next.
  12. Specify the configuration for the features to install and click Next.
    • FIPS Compliance Mode (Must enable FIPS Module)
    • NIST 800-131a Compliance Mode
      • off (default value)
      • strict
    • SPE Integration Module (Requires pre-install of SPE, WTX optional)

      If you select the SPE option, you are prompted for the following information:

      • SPE installation directory
      • (Optional) WebSphere® Transformation Extender (WTX) installation directory
      • SPE UI port

      For more information, see the documentation for the integration of Sterling B2B Integrator and SPE.

  13. Type the path to the JCE policy file and click Next.
  14. Enter the following server location information and click Next:
    1. Type the explicit IP address or host name for the server or use the default value of localhost.
    2. Type the initial port number or use the default value of 8080.
      Important: In a clustered environment, for node 2 and higher, you must use a different unique port number.
  15. Enter the system passphrase information and click Next:
    1. Type a passphrase.
    2. Confirm the passphrase.
  16. Type the email information and click Next:
    1. Type the email address to which you want system alert messages sent.
    2. Type the SMTP mail server (IP address or host name) that you want to use for system alert messages and other administrative notices.
  17. Enter the following database information and click Next.
    1. Select the database vendor that you want to use:
      • Oracle
      • Microsoft SQL Server
      • DB2
    2. Select all of the following options that apply to this installation:
      Choices: Action
      This installation is for a cluster node 1 only Do not select this option if you are using a non-cluster environment or if you are installing a node other than node 1 in a clustered environment.

      If you are using a clustered environment and you are installing node 1 in the cluster setup, select the check box and specify the node number.

      You must complete the following in a cluster setup, after installing the first node (node 1) on the host where node 1 is installed:

      Windows operating system:
      1. Go to \<install_dir>\bin directory.

      2. Enter startCluster.cmd 1 true.

      Linux/Unix operating system:

      1. Go to /<install_dir>/bin directory.

      2. Enter ./ 1 true.

      Important: For v5.2.6 or later versions, after you run the startCluster command for the first node, the subsequent nodes are automatically clustered by the installer when they are installed. You must not execute the startCluster command on nodes other than node 1.
      Apply database schema automatically? The default is to automatically apply the DDL (Data Definition Language) statements that apply the database schema.

      If you want to manually create the database schema, then clear the Apply database schema automatically check box and continue with the remaining installation steps.

      Important: If you manually apply the schema, the installation stops without error later in the installation process so that you can manually apply the schema. When the installation stops, you must complete the additional steps to manually apply the database schema.
  18. Type the following Database Connection Information. Do not click Next until you configure the JDBC driver in the next steps.
    • User name
    • Password (and confirmation)
    • Catalog name
    • Host
    • Port
  19. Select a JDBC driver or drivers by completing the following steps and then click Next.
    1. Click Add to browse to the file location for the appropriate JDBC driver or drivers:
      • (Oracle and Microsoft SQL Server only) Absolute path and file name for one JDBC driver file.
      • (DB2 only) Absolute paths and file names for two JDBC driver files. Use the Type-4 JDBC driver. This type of driver converts JDBC calls into the network protocol that is used directly by DB2, allowing a direct call from the system to the DB2 server.
    2. Click Test to confirm that the driver is supported for the database and Sterling B2B Integrator.
      Tip: Make sure that you select the driver path in the Database driver field before you click Test.
      The Installation Manager must successfully validate the connection to the database before you can continue with the installation. If there is a validation failure, you can view the system log to determine more information about the failure. Complete the following steps to view the log file:
      1. If you are using the Windows operating system, identify the location of the user’s application directory by clicking Start > Run and entering the command %APPDATA%.
      2. Open the user’s application directory:

        For Windows: <local_path>\IBM\Installation Manager\logs

        For Unix/Linux: <local_path>/IBM/Installation Manager/logs
      3. Open theindex.xml file in a browser.
      4. Identify the log file that is based on the time stamp of when you started the installation.
      5. Click the instal file to view a listing of errors that occurred during that installation.
  20. Determine which of the following options apply to this installation. Select the applicable options and click Next:
    • Verbose install?
    • This installation is an upgrade from a prior version

      Do not select this option because this installation is a new installation.

      Important: In a clustered environment, for node 2 and higher, this option might be selected by default. This default selection causes the display of the option Would you like to run upgrade pre-check?. You must clear the check box before you continue.
  21. Determine what performance configurations apply to this installation and click Next. Accept the default value or type the appropriate value.
    • Number of Processor Cores
    • Physical Memory (MB) allocated to Sterling B2B Integrator
  22. Enter values for the following properties to access myFileGateway 2.0 in the MyFG 2.0 Information (Optional) panel:
    • Gateway Service hostname or IP address: IP address of the Liberty server where the B2BAPIs are installed.
    • Gateway service port: Port number of the Liberty server where the B2BAPIs are installed.
    • ASI Service Hostname or IP Address: IP address/hostname of the location where Sterling B2B Integrator is installed.
    • ASI Service Port: Port number of the Sterling B2B Integrator application.
    • Rest HTTP Server Adapter Service hostname or IP Address: IP address of the REST HTTP Adapter where the b2bauthapi are installed.
    • Rest HTTP Server Adapter Service Port: Port number of the REST HTTP Adapter where the b2bauthapi are installed.
    • Use HTTPS Protocol?: Select the checkbox to access the UI using the HTTPS protocol. By default, it is disabled (uses HTTP protocol).

    These values are further used in the gateway_application.yaml file internally to automate the installation and configure myFileGateway 2.0.

    Important: The above changes are not applicable from v6.1.0.1 and later versions, since the MyFG 2.0 Information panel is not available.
  23. Review the installation package summary information. Click Install to apply your installation settings to the installation.

    The Installation Progress screen indicates which component of the installation is in process.

    A status bar below the Repository Information heading displays the progress of the component installation. When the installation completes, a large green circle with a check mark displays with the message The packages are installed. A link is provided to view the installation log file.

  24. If you did not select the option to automatically apply the database schema, the installation stops and you must perform these additional steps to complete the installation with manual DDL statements:
    1. Open the installation directory.
    2. Locate the InstallSI.log file and open it with a file editor.
    3. Search the file for these error messages:
      <SI_Install>/repository/scripts/EFrame_IndexAdds.sql must be applied to the database.<SI_Install>//repository/scripts/EFrame_Sequence.sql must be applied to the database.<SI_Install>//repository/scripts/EFrame_TableChanges.sql must be applied to the database. Exiting installation..."
      Important: If you do not find these error messages in the log file, the installation failed because of another reason and you must resolve that error and attempt the installation again. If you find these messages, continue with the remaining steps.
    4. Edit each .sql script for the database. These changes might include changing the SQL delimiter or adding table space options.
    5. Log in to the database as the database schema user.
      Important: Table generation is not included in these SQL scripts, but is performed automatically during the initial start of Sterling B2B Integrator or when a new cluster node is added. Table generation might fail if security restrictions reduced the Sterling B2B Integrator database user permissions. To avoid this issue, ensure that the DBADM role permissions are enabled during the initial startup. If further issues arise, contact IBM customer support for guidance.
    6. Run the following SQL files manually in this order:
      Important: When you are running the scripts, you must run the SQL scripts in the specified order.
      1. EFrame_IndexDrops.sql
      2. EFrame_TableChanges.sql
      3. EFrame_IndexAdds.sql
      4. EFrame_TextIndexAdds.sql
      5. EFrame_Sequence.sql
      6. EFrame_TextIndexModify.sql
      7. EFrame_TextIndexUpdates.sql
      8. EFrame_TextIndexUpgrade.sql
      9. EFrame_Static.sql
    7. Exit from the database.
    8. Open the parent directory of the Sterling B2B Integrator installation directory.
    9. Delete (or rename as a backup) the installation directory.
    10. Uninstall the Sterling B2B Integrator offering to clear out the Installation Manager metadata about the installation, and the delete (or rename as a backup) the Sterling B2B Integrator installation directory.
    11. Restart the installation wizard and provide the same installation options that you provided before you cleared the Apply database schema automatically check box. If you have recorded a response file, you can use the response file to install Sterling B2B Integrator.
  25. After installation is completed, click Finish.
    The Installation Manager closes and you are returned to your desktop.

    Check the InstallSI.log file to verify that all of the components were installed properly.

  26. If you are installing on Windows 2008, see Configure the Sterling B2B Integrator Desktop Icon for Windows Server 2008.
  27. If you are using the AIX® operating system and are using IPv6:
    1. Open the /<install_dir>/properties directory.
    2. Add the following value to the sandbox.config file: IPV4STACK=false
    3. Open the /<install_dir>/bin directory.
    4. Enter the ./ command.
  28. In a clustered environment, to install each additional node, open the Installation Manager folder and start a new installation.
    Note: For node 2 and higher, follow the same steps as you did for node 1 until you get to the step with the This installation is for a cluster node 2 or higher check box. Select that box.
  29. In a clustered environment, if you have installed multiple nodes on the same server or used different base ports for node 2 onward, you must complete the following steps:
    Step Action
    1 Open the following directory for node 1:
    • For Windows: \<install_dir>\properties
    • For Unix/Linux: /<install_dir>/properties
    2 In the noapp.properies_platform_ifcresources_ext file, record the value for multicastBasePort.
    3 In file, record the values for the mcast_port parameters of the property_string and lock.protocolStack properties.
    4 For each subsequent node, complete the remaining steps.
    5 Open the following directory for each node (node 2 and higher):
    • For Windows: \<install_dir>\properties
    • For Unix/Linux: /<install_dir>/properties
    6 In the file, update the value of the multicastBasePort property to match the value for node 1.

    For example, replace the string &MULTICAST_NODE_PORT1 with the port number 45460

    • (before) multicastBasePort=&MULTICAST_NODE_PORT1;
    • (after) multicastBasePort=45460;
    7 In the file, update all occurrences of mcast_port to match the values for node 1.
    8 After you updated the attributes for all of the nodes, enter the following command for node 2 and higher:
    • For Windows: \<install_dir>\bin\setupfiles.cmd
    • For Unix/Linux: /<install_dir>/bin/
  30. Determine whether you need to apply a Fix Pack to the installation.