WebSphere Message Brokers
File: as04540_
Writer: Lorraine Waitt

Task topic

This build: July 31, 2007 21:37:07

Installing a user-defined extension to current and past versions of the broker

The task described here is for users, for example for third-party vendors, who want to install user-defined extensions with the minimum of user intervention.

Before you start

Complete the following tasks:

  1. Compiling a Java user-defined node or Compiling a C user-defined extension
  2. Creating the user interface representation of a user-defined node in the workbench
  3. Testing a user-defined node
  4. Packaging a user-defined node workbench project

You must install user-defined extensions on all appropriate broker computers, and, if the extension is a user-defined node, on the toolkit computers (user-defined parsers have no toolkit component). 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.

Toolkit installation

Before installing a user-defined node, establish the version of the toolkit you are installing to, because a specific version of the toolkit could be a prerequisite of the user-defined extension, or it might require specific files to run.

To determine the toolkit version, see Detecting installed versions of WebSphere Message Broker.

New instructions for 6.1 to be developed.

Runtime installation

You might need to detect the version of the runtime that is installed, to ensure that the correct .lil file is loaded by the correct level of the broker. See Detecting installed versions of WebSphere Message Broker.

To add .jar or .lil files to runtime installations on WebSphere Business Integration Message Broker Version 5.0 or later, see Installing user-defined extension runtime files on a broker.

Single broker extension

To make a 32-bit extension accessible from only one broker on the system, modify the UserLilPath setting for the broker by specifying the -l parameter on the mqsicreatebroker or mqsichangebroker command. For more information, see mqsicreatebroker command and mqsichangebroker command.

You cannot use the -l parameter to modify the user LILPATH for 64-bit extensions. Instead, append the directory containing the directory that holds the extension files to the environment variable MQSI_LILPATH64, as described below.

Multiple brokers extension

To affect all brokers on a system, you must modify the system LILPATH. Append the directory containing the directory that holds the extension files to the environment variable MQSI_LILPATH (for 32-bit extensions) or MQSI_LILPATH64 (for 64-bit extensions).

You can do this by creating a custom environment script in %ALLUSERSPROFILE%\Application Data\IBM\MQSI\common\profiles on Windows, or /var/mqsi/common/profiles on UNIX and Linux. 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 should limit the scope to only appending the following variables:

MQSI_LILPATH
Defines the directories to search for 32-bit plug-ins
MQSI_LILPATH64
Defines the directories to search for 64-bit plug-ins
CLASSPATH
Defines the locations Java should search for additional classes
NLSPATH
Defines the location of message catalogues
PATH
Defines the location of executable files. On Windows, this variable also defines the location of dependent libraries.
LIBPATH / SHLIB_PATH / LD_LIBRARY_PATH
Defines the location of dependent libraries on UNIX and Linux.

Example script

Windows platform Environment profile for MyExtension, installed in C:\Program Files\MyExtensions. The script is called C:\Documents and Settings\All Users\Application Data\IBM\MQSI\common\profiles\MyExtension.cmd:
REM Added by MyExtension install, do not modify
set MQSI_LILPATH=%MQSI_LILPATH%;"C:\Program Files\MyExtension\bin"
UNIX platform Environment profile for MyExtension, installed in /opt/MyExtension. The script is called /var/mqsi/common/profiles/MyExtension.sh:
#!/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 only runs on a specific version of the broker:

MQSI_FILEPATH
The full path to the installed file for WebSphere Message Broker
MQSI_WORKPATH
The full path to the configuration data for WebSphere Message Broker
MQSI_VERSION
WebSphere Message Broker version, in the form version.release.modification.fix
MQSI_VERSION_V
The value of WebSphere Message Broker major version
MQSI_VERSION_R
The value of WebSphere Message Broker release
MQSI_VERSION_M
The value of WebSphere Message Broker modification number
MQSI_VERSION_F
The value of WebSphere Message Broker fix level
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:37:07

as04540_ This topic's URL is: