IBM Integration Bus, Version 10.0.0.2 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS


Installing a user-defined extension to current and past versions of IBM Integration Bus

Install user-defined extensions that you have developed yourself, or have acquired from an independent software vendor, with the minimum of user intervention.

Before you begin

Complete the following tasks:

  1. Compiling a Java user-defined node, Compiling a C user-defined extension, or Creating a user-defined node from a subflow
  2. Creating the user interface representation of a user-defined node in the IBM Integration Toolkit
  3. Testing a user-defined node
  4. Packaging and distributing a user-defined node project

About this task

You must install user-defined extensions on all appropriate IBM Integration Bus systems. If your extension is a user-defined message flow node that contains a custom compiler, you must install the compiled user-defined extension file and the user-defined node plug-in on the integration node to which you want to deploy the message flow node. Components can be installed separately, or as part of one process. The components can be on different systems, therefore check that the installations are completed on all affected systems.

If an extension writes messages to user trace, you must update the environment variable MQSI_CONSOLE_NLSPATH (Windows systems), or NLSPATH (all other systems), so that the mqsiformatlog command can find the message catalog.

Installing user-defined message flow nodes

Before you begin

Before installing a user-defined message flow node, check the version of IBM Integration Bus to which you are installing, because a specific version of the IBM Integration Bus might be a prerequisite of the user-defined extension, or it might require specific files to run.

To determine the version, see Detecting installed versions of IBM Integration Bus.

Procedure

  1. Copy your files to a directory that the IBM Integration Toolkit can access, so that you can view your user-defined message flow node in the IBM Integration Toolkit session. Choose one of the following options:
    • Add your new plug-in JAR file directly into the dropins directory where the IBM Integration Toolkit is installed. For example, on Windows, add the file to C:\Program Files\IBM\IIB\10.0.0.n\tools\dropins.

      If you choose this option, you might find it difficult to manage your plug-ins files safely if you later remove or replace them. Also, your system administrator might want to control security and access on computers that are used by more than one user, and might not set permissions for users to write to the primary installation directories.

    • Create Eclipse link files to the directories in which you maintain your plug-in files.
      For details about how to create link files, see the developerWorks® article about using Eclipse features (the section entitled "Using link files to manage an Eclipse install").
      1. Linux platformOn Linux: Delete any existing .eclipse directory in your home directory, and restart the IBM Integration Toolkit. For example, remove the following directory, where userid is your user identification: /home/userid/.eclipse
      2. Create a directory called eclipse in a suitable location in your file system; the directory structure that contains the eclipse directory is not significant.
      3. Within the eclipse directory, create directories named features and plugins.
      4. Windows platformOn Windows: Under C:\Program Files\IBM\IIB\10.0.0.n\tools, create a new links folder, and create a file called name.link, where name is a name that you have chosen. Type the following text path=C:/path_to_your_dir into the name.link file, where path_to_your_dir is the path to your directory.

        Example: If you put your plug-ins into C:\Temp\MyPlugins\eclipse\plugins\, the content of the link file is path=C:/Temp/MyPlugins.

  2. Restart your IBM Integration Toolkit session for the changes to take effect.

Integration node installations

About this task

You might be required to detect the versions of IBM Integration Bus that are installed, to ensure that the correct LIL file is loaded by the correct level of the integration node. See Detecting installed versions of IBM Integration Bus.

To add .jar or .lil files to integration node installations on IBM Integration Bus Version 10.0 and later, see Installing user-defined extension runtime files on an integration node.

Installing a user-defined extension for single integration node

About this task

To make an extension accessible from only one integration node on the system, modify the UserLilPath setting for the integration node by specifying the -l parameter on the mqsicreatebroker or mqsichangebroker command.

For more information, see mqsicreatebroker command and mqsichangebroker command.

Installing a user-defined extension for multiple integration nodes

About this task

To affect all integration nodes on a system, you modify the system LILPATH. Append the directory containing the directory that holds the extension files to the environment variable MQSI_LILPATH. MQSI_LILPATH64 is not valid at this version.

Make this change by creating a custom environment script in the working directory:

  • Linux platformUNIX platformOn Linux and UNIX systems: /var/mqsi/common/profiles
  • Windows platformOn Windows: C:\ProgramData\IBM\MQSI\Common\profiles.

You can give the environment script any name, but the file extension must be .cmd on Windows and .sh on all other platforms. The script can perform all the operations of a shell script, but you must limit the scope to only appending the following variables:

MQSI_LILPATH
Defines the directories to search for plug-ins
CLASSPATH
Defines the locations that Java searches for additional classes
MQSI_CONSOLE_NLSPATH
On Windows: Defines the location of message catalogs (DLL files)
NLSPATH
On Linux and UNIX: Defines the location of message catalogs (CAT files)
PATH
Defines the location of executable files. On Windows: This variable also defines the location of dependent libraries.
LIBPATH / SHLIB_PATH / LD_LIBRARY_PATH
On UNIX and Linux: Defines the location of dependent libraries.

Example scripts

About this task

Windows platformOn Windows: This example shows the environment profile for MyExtension, which is installed in C:\Program Files\MyExtension.

The script is called MyExtension.cmd and is stored in the working directory. The default location is C:\ProgramData\IBM\MQSI\common\profiles.

The Windows script contains the following content:

REM Added by MyExtension install, do not modify
set MQSI_LILPATH=%MQSI_LILPATH%;"C:\Program Files\MyExtension\bin"

Linux platformUNIX platformOn Linux and UNIX: This example shows the environment profile for MyExtension, which is installed in /opt/MyExtension. The script is called MyExtension.sh and is stored in the working directory /var/mqsi/common/profiles/ (for a shared installation) or $HOME/iibconfig/common/profiles/ (for a single-user installation).

The Linux script contains the following content:

#!/bin/ksh
# Added by MyExtension install, do not modify
export MQSI_LILPATH=/opt/MyExtension/lil${MQSI_LILPATH:+":"${MQSI_LILPATH}}

You can test the following variables in the profile script, for example if you want to ensure that a user-defined extension runs only on a specific version of the integration node:

MQSI_FILEPATH
The full path to the installed file for IBM Integration Bus
MQSI_WORKPATH
The full path to the configuration data for IBM Integration Bus
MQSI_VERSION
IBM Integration Bus version, in the form version.release.modification.fix
MQSI_VERSION_V
The value of IBM Integration Bus major version
MQSI_VERSION_R
The value of IBM Integration Bus release
MQSI_VERSION_M
The value of IBM Integration Bus modification number
MQSI_VERSION_F
The value of IBM Integration Bus fix level

as04540_.htm | Last updated 2015-09-24 12:53:16