Installing the WebSphere Message Broker Exit BTM extension

This topic describes how to install the WebSphere Message Broker Exit BTM Extension on Windows and UNIX.

Installing the WebSphere Message Broker Exit BTM extension on Windows

Before you begin

• Deploy either the 32-bit or 64-bit BTM runtime toolkit to a staging area. Use the version that matches your broker installation. See Working with the runtime toolkit for details. Unzip the contents of the jar file to its own directory.
• If you have installed a 32-bit version of the broker, install the Microsoft Visual C++ 2017 Redistributable Package by installing vcredist_x86.exe located in the agent distribution directory. If you have installed a 64-bit version of the broker, install the Microsoft runtime libraries by installing vcredist_x64.exe located in the agent distribution directory. You might have already done this for other BTM extension types. It only needs to be done once but make sure the correct version (32-bit or 64-bit) is installed.

To install the WebSphere Message Broker Exit BTM extension on Windows

1. Copy btmwmbx.lel to the directory where your broker's exits are installed. If none are currently installed, create a directory and specify it in step 3.
2. Stop the broker using mqsistop.

3. Use the -x parameter with the mqsichangebroker or mqsicreatebroker command to point the broker to the folder containing the extension's exit library btmwmbx.lel. For details about these commands, see the IBM WebSphere Message Broker documentation.
   
   For example, the following command points an existing broker to the folder containing btmwmbx.lel:
   mqsichangebroker BROKER1 -x C:\BTM\WMB_EXIT

   Note

   A list of folders where the broker looks for exits can be specified with the -x switch. Use a list of folders if the broker uses other exits you want to be available.
4. Activate the exit for the flow specified for the Activity Implementation within the Monitor Console. There are several levels on which a WMB Exit BTM Extension can be activated. They are:
   • broker – the exit is active for all flows on all execution groups
   • execution group – the exit is active for all flows processed by a specific execution group
   • flow – the exit is active for only this flow on a specific execution group
5. Activate:
   • To activate the WMB Exit BTM extension on the broker level, use the mqsichangebroker  command. For example:
     mqsichangebroker BROKER1 -e MQSoftwareBTMExtension
   • To activate the WMB Exit BTM extension for a specific execution group or flow, use the mqsichangeflowuserexits  command. For example:
     mqsichangeflowuserexits BROKER1 -e ExecutionGroup1 - a MQSoftwareBTMExtension

See the IBM WebSphere Message Broker documentation for more details on these commands.

Installing the WebSphere Message Broker Exit BTM extension on UNIX

1. All users running any WebSphere applications, especially WebSphere MQ channels and WebSphere Message Brokers started by inetd, need to set the MQS_HOME system environment variable.
2. From the /staging directory, move OperatingSystem_WMB_Exit_Runtime_Toolkit.jar to a temporary directory, extract it, and move btmwmbx.lel to the required directory. Check the IBM information resources for additional details.

3. Edit the QPLog.ini file to place log files in a common directory if required. This makes it easier to find the log files if there is a problem. As is, all log files are in the directory specified by the MQS_HOME system environment variable.

   Note

   The broker must be stopped prior to issuing the mqsichangebroker command.
4. Using the appropriate command below, point the broker to the folder containing the extension's exit library btmwmbx.lel. For details about these commands, see the IBM WebSphere Message Broker documentation.
   • 32-bit WMB Exit BTM extensions:
     • mqsichangebroker -x points an existing broker to the folder containing btmwmbx.lel
     • mqsicreatebroker -x specifies the folder containing btmwmbx.lel when creating the broker.
       
       For example: mqsichangebroker BROKER1 -x /your_path/wmb_exit

'-x userExitPath' the directory from which the broker searches for all 32-bit user exits. This path is added to the system library search path (PATH,LIBPATH,LD_LIBRARY_PATH,SHLIBPATH) for the execution group process only.
   • 64-bit WMB Exit BTM extensions:
   1. • WMB prior to 6.1.0.3: The -b flag is not supported for 64-bit broker user exits using versions of WMB prior to 6.1.0.3. Instead, set the MQSI_USER_EXIT_PATH64 system environment variable to point to the 64-bit folder containing btmwmbx.lel. For example: MQSI_USER_EXIT_PATH64=/your_path/wmb_exit/exits64
      • WMB between 6.1.03 and 6.1.0.7 (inclusive): '-b userExitPath64' the directory from which the broker searches for all 64-bit user exits. This path is added to the system library search path (PATH,LIBPATH,LD_LIBRARY_PATH,SHLIBPATH) for the execution group process only.
      • WMB 7 and later: Uses the same -x parameter as 32-bit.
   A list of folders where the broker looks for exits can be specified with the -x switch. Use a list of folders if the broker uses other exits you want available.
5. Activate the exit for the flow specified for the Activity Implementation within the Management Console. There are several levels on which a WMB Exit BTM Extension can be activated. They are:
   • broker – the exit is active for all flows on all execution groups
   • execution group – the exit is active for all flows processed by a specific execution group
   • flow – the exit is active for only this flow on a specific execution group.

To activate the WMB Exit BTM Extension extension on the broker level, use the mqsichangebroker command. See the IBM WebSphere Message Broker documentation for more details on this command.

mqsichangebroker BROKER1 -e MQSoftwareBTMExtension

To activate the WMB Exit BTM Extension extension for a specific execution group or flow, use the mqsichangeflowuserexits command.

For example, enter mqsichangeflowuserexits BROKER1 -e ExecutionGroup1 -f FLOW1 -a MQSoftwareBTMExtension.

See the IBM WebSphere Message Broker documentation for more details on this command.

Where to go from here

• To control and configure the extension, see Running the WebSphere Message Broker Exit BTM extension.