Installing the LoopBack connector

Install and configure the required LoopBack® connector for use with IBM® Integration Bus.

About this task

Before you can use the LoopBackRequest node in a message flow, you must install the relevant LoopBack connector.

Procedure

Follow these steps to install and configure your LoopBack connector to work with IBM Integration Bus:

  1. Open the IBM Integration Bus Command Console and change to the node_modules subdirectory of the work path directory (which is defined by the MQSI_WORKPATH environment variable).
    For example, on Windows:
    cd %MQSI_WORKPATH%\node_modules
    and on UNIX:
    cd $MQSI_WORKPATH/node_modules
  2. From the node_modules subdirectory, run the npm command, specifying the name of your chosen LoopBack connector.
    For example, to install the MongoDB LoopBack connector:
    npm install loopback-connector-mongodb
    Note: Ensure that you use the version of npm that is provided with IBM Integration Bus, by running the npm command from the Command Console. If you install the connector by using any other method, the modules will be incompatible.
    Some LoopBack connectors might depend on native libraries that are built during the installation process, and which require compiler tools to be accessible on the system. For example, the LoopBack Oracle connector requires changes to the library path so that the connector can locate the Oracle InstantClient that is packaged with the connector. On Windows, you could enable this by adding the following line to a common profile in the work_path\common\profiles\loopback.cmd file:
    set PATH=%PATH%;%MQSI_WORKPATH%\node_modules\instantclient\vc11;%MQSI_WORKPATH%\node_modules\instantclient;
    On Linux®, you could enable the Oracle connector to locate the InstantClient, by adding the following line to a common profile in the work_path/common/profiles/loopback.sh file:
    export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/$MQSI_WORKPATH/node_modules/instantclient:

    If you encounter problems when installing LoopBack connectors, contact the connector author for assistance.

    Some LoopBack connectors might also require you to configure the environment in which the connector is running, such as modifying the library path. See Setting up a command environment for information on how to configure the command environment to make these settings available to IBM Integration Bus.

    Some LoopBack connectors might be incompatible if they use native libraries that are used internally by IBM Integration Bus.

  3. Check the node_modules subdirectory to confirm that the required LoopBack connector and any dependent modules have been installed.

What to do next

Configure the data source for your installed connector, as described in Configuring the data source and models for your LoopBack connector.