Title Page

webMethods JMS Adapter Installation Guide

Version 6.1

April 2010

Copyright & Document ID

This document applies to webMethods JMS Adapter Version 6.1 and to all subsequent releases. Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions. Copyright 20012010 Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, United States of America, and/or their licensors. The name Software AG, webMethods, and all Software AG product names are either trademarks or registered trademarks of Software AG and/or Software AG USA, Inc. and/or their licensors. Other company and product names mentioned herein may be trademarks of their respective owners. Use of this software is subject to adherence to Software AGs licensing conditions and terms. These terms are part of the product documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s). This software may include portions of third-party products. For third-party copyright notices and license terms, please refer to "License Texts, Copyright Notices and Disclaimers of Third Party Products." This document is part of the product documentation, located at http://documentation.softwareag.com/legal/ and/or in the root installation directory of the licensed product(s).

Document ID: ADAPTER-JMS-IG-61-20100430

Contents
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing JMS Adapter 6.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrading to JMS Adapter 6.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Uninstalling JMS Adapter 6.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 3 3 8 9

Overview
This guide, in conjunction with the Software AG Installation Guide, explains how to install, upgrade, and uninstall webMethods JMS Adapter 6.1. In those instances where you are installing the adapter with webMethods Integration Server (prerequisite) or other webMethods products, this webMethods JMS Adapter Installation Guide refers to the Software AG Installation Guide, but you should use the correct installation guide as follows: If you are installing the adapter with webMethods 8 products, refer to the Software AG Installation Guide for instructions. If you are installing the adapter with previous versions of webMethods products, refer to the webMethods Installation Guide for instructions.

Requirements
For a list of the operating systems, JMS products, and webMethods products supported by JMS Adapter 6.1, see the webMethods Adapters System Requirements. JMS Adapter 6.1 has no hardware requirements beyond those of its host Integration Server.

Installing JMS Adapter 6.1

The instructions in this section are meant to be used with the more complete instructions in the Software AG Installation Guide. The instructions explain how to use the Software AG Installer wizard. Note: If you are installing the JMS Adapter in a clustered environment, you must install the adapter on each Integration Server in the cluster, and each installation must be identical. For more information about working with the adapter in a clustered environment, see the webMethods JMS Adapter Users Guide.

webMethods JMS Adapter Installation Guide Version 6.1

To install JMS Adapter 6.1 1 2 3 Download the Software AG Installer from the Software AG Empower Web site. If you are installing the adapter on an existing Integration Server, shut down the Integration Server. Start the Software AG Installer wizard.

Choose the webMethods release that includes the Integration Server on which to install the adapter. For example, if you want to install the adapter on Integration Server 7.1, choose the 7.1 release. If you are installing on an existing Integration Server, specify the webMethods installation directory that contains the host Integration Server. If you are installing both the host Integration Server and the adapter, specify the installation directory to use. The Software AG Installer will install the adapter in the IntegrationServer_directory\packages directory. In the product selection list, select Adapters > webMethods JMS Adapter 6.1. You can also choose to install documentation and these items: If you want to... Use the JMS Adapter with the webMethods Broker JMS Provider Use the JMS Adapter with a filebased JNDI implementation Choose to install this... Broker JMS provider client libraries version Sun JNDI libraries version

If you do not want to install these libraries now, you can do so later manually. For instructions, seeAdding the JMS Provider Client Libraries to the Integration Server Classpath on page 4. 4 After installation is complete, start the host Integration Server.

Adding the JMS Provider Client Libraries to the Integration Server Classpath
The Integration Server requires access to some of the JMS providers Java client libraries. Place these libraries in the servers classpath by copying them into the IntegrationServer_directory\lib\jars directory, as described in the following sections. The server will automatically add the .jar files to its classpath.

webMethods JMS Adapter Installation Guide Version 6.1

Note: The JMS providers .jar files could conflict with JNDI properties that are used with other webMethods products running under Integration Server. If you encounter a JNDI properties conflict, copy the .jar files to the WmJMSAdapter\code\jars\static directory instead. However, if you do this you must make sure that MessageListener notifications configured using the adapter publish documents using the Broker rather than in local mode, or you must configure the notification to invoke a service rather than publish a document.

To add the JMS providers client libraries to the Integration Server classpath 1 Copy the jms.jar file to the IntegrationServer_directory\lib\jars directory. The jms.jar file is available from Sun Microsystems at http://java.sun.com/products/jms/docs.html

If you are using the JMS Adapter with SonicMQ v6: Download the 1.1 API Documentation, Jar, and Source. Unzip the jms-1_1-fr-apidocs.zip file to extract the jms.jar file. Note: Even though the SonicMQ v6 JMS provider requires the jms.jar version 1.1, the adapter supports the 1.0.2b API specification and does not use any of the added extensions of the 1.1 specification.

For all other supported JMS providers: Download the 1.0.2b API Documentation, Jar, and Source. Unzip the jms-1_0_2b.zip file to extract the jms.jar file.

If you are going to use the JMS Adapter with a file-based JNDI implementation, copy the fscontext.jar and providerutil.jar files to the IntegrationServer_directory\lib\jars directory. These files are available from Sun Microsystems at http://java.sun.com/products/jndi/downloads/index.html From the Download JNDI 1.2.1 & More menu, select File System Service Provider, 1.2 Beta 3 to download the fscontext-1_2_beta3.zip file. Then extract the fscontext.jar and providerutil.jar files from the fscontext-1_2_beta3.zip file.

Copy your JMS providers Java API libraries to the required location, as described in the table below. JMS Provider JBoss Files to Copy Copy the jbossall-client.jar and client\log4j.jar files from the JBoss_directory\client directory to the IntegrationServer_directory\lib\jars directory. Copy the j2ee.jar file from the j2sdkee_directory1.3.1\lib directory to the IntegrationServer_directory\lib\jars directory. The j2sdkee_directory is the directory in which the Java SDK Enterprise Edition is installed.

webMethods JMS Adapter Installation Guide Version 6.1

JMS Provider webMethods Broker JMS Provider

Files to Copy Copy the apiutil60.jar and client60.jar files from the Software AG_directory\common directory to the IntegrationServer_directory\lib\jars directory. Copy the BrokerJMS60.jar file from the Software AG_directory\Broker\lib directory to the IntegrationServer_directory\lib\jars directory. Make sure the Software AG_directory\common\lib\ wmbrokerclient.jar, wmjmsclient.jar, and jms.jar files are in the server classpath.

WebSphere MQ 6.0

Copy the mqji.properties and mqji.properties_your_locale files from the WebSphereMQ_directory\Tools\Java\base directory to the IntegrationServer_directory\packages\WmJMSAdapter\code\ classes directory. For example, if your WebSphere MQ installation is running on a machine configured for en_US locale, copy the files mqji.properties and mqji.properties_en_US. Copy these files from the WebSphereMQ_directory\Java\lib directory to the IntegrationServer_directory\lib\jars directory: com.ibm.mq.jar com.ibm.mqjms.jar For WebSphere MQ 6.0, dhbcore.jar Additionally, copy the mqji.properties and mqji.properties_your_locale files from the WebSphereMQ_directory\Tools\Java\base directory to the IntegrationServer_directory\packages\WmJMSAdapter\code\ classes directory. For example, if your WebSphere MQ installation is running on a machine configured for en_US locale, copy the files mqji.properties and mqji.properties_en_US.

Other WebSphere MQ

SonicMQ 5

Copy these files from the SonicMQ_directory\lib directory to the IntegrationServer_directory\lib\jars directory: mfcontext.jar sonic_Client.jar sonic_mgmt.jar sonic_Selector.jar sonic_XA.jar

webMethods JMS Adapter Installation Guide Version 6.1

JMS Provider SonicMQ 6

Files to Copy Copy these files from the SonicMQ_directory\lib directory to the IntegrationServer_directory\lib\jars directory: mfcontext.jar sonic_Client.jar sonic_Crypto.jar sonic_mgmt_client.jar sonic_Selector.jar sonic_XA.jar

WebLogic

Copy the following jar files from the same version of WebLogic server that you intend to connect to from your Integration Server. WebLogic 7.0: Copy the WebLogic_directory\server\lib\weblogic.jar file to the IntegrationServer_directory\lib\jars directory. WebLogic 8.1, 9.0, 9.1, and 9.2: Copy the WebLogic_directory\server\ lib\wlclient.jar and wljmsclient.jar files to:

The IntegrationServer_directory\packages\WmJMSAdapter\ code\jars\static directory when the JMS adapter notifications publish the documents to the Broker. The IntegrationServer_directory\packages\WmJMSAdapter\ code\jars directory when the JMS adapter notifications do not publish the documents to the Broker.

WebLogic 10.0 and 10.3.1.0: a Create wlfullclient.jar from the WebLogic installation using the following command:
java -jar wljarbuilder.jar

Place the wlfullclient.jar in the IntegrationServer_directory\packages\WmJMSAdapter\ code\jars\static directory.

webMethods JMS Adapter Installation Guide Version 6.1

JMS Provider Oracle JMS

Files to Copy Copy the following files from the Oracle Application Server installation directory to the IntegrationServer_directory\ packages\WmJMSAdapter\code\classes directory: aqapi.jar jndi.jar ojdl.jar jms.jar oc4jclient.jar

Copy the wmjms.zip file from the IntegrationServer_directory\packages\WmJMSAdapter\pub directory to the IntegrationServer_directory\lib\jars directory. If you are using the adapter with a JVM 1.2.x, copy the following .jar files to the IntegrationServer_directory\lib\jars directory. These files are available from Sun Microsystems at: http://java.sun.com/products/jndi/downloads/index.html File jndi.jar Instructions From the Download JNDI 1.2.1 & More menu, select JNDI Class Library to download the jndi-1_2_1.zip file. Unzip the jndi-1_2_1.zip file to extract the jndi.jar file. From the Download JNDI 1.2.1 & More menu, select LDAP Service Provider, 1.2.4 to download the ldap.1_2_4.zip file. Unzip the jndi-1_2_1.zip file to extract the jndi.jar file. Unzip the ldap.1_2_4.zip file to extract the ldap.jar file.

ldap.jar

Restart the host Integration Server.

Upgrading to JMS Adapter 6.1

The information in this section provides instructions for upgrading to JMS Adapter 6.1. The adapter supports upgrading from JMS Adapter version 6.0. To upgrade, uninstall JMS Adapter 6.0 and then install JMS Adapter 6.1 using the instructions provided in Installing JMS Adapter 6.1 on page 3. All configuration files and files you created in your 6.0 installation remain unchanged in the 6.1 installation.

webMethods JMS Adapter Installation Guide Version 6.1

Uninstalling JMS Adapter 6.1

The instructions in this section are meant to be used with the uninstallation instructions in the Software AG Installation Guide. To uninstall JMS Adapter 6.1 1 2 Shut down the Integration Server that hosts the JMS Adapter. The Software AG Uninstaller does not delete any user-defined JMS Adapter components such as connections, adapter services, and adapter notifications. Because these components will not work without the adapter, delete them manually, either at the file system level or using Developer. For instructions, see Developing Integration Solutions: webMethods Developer Users Guide. Start the Software AG Uninstaller, selecting the webMethods installation directory that contains the host Integration Server. In the product selection list, select Adapters > webMethods JMS Adapter 6.1. You can also choose to uninstall documentation and these items, if you installed them:

Broker JMS provider client libraries. Sun JNDI libraries.

4 5

Restart the host Integration Server. The Software AG Uninstaller removes all JMS Adapter-related files that were installed into the IntegrationServer_directory\packages\WmJMSAdapter directory. However, the Software AG Uninstaller does not delete files created after you installed the adapter (for example, user-created or configuration files), nor does it delete the adapter directory structure. You can go to the IntegrationServer_directory\packages directory and delete the WmJMSAdapter directory.

webMethods JMS Adapter Installation Guide Version 6.1

10

webMethods JMS Adapter Installation Guide Version 6.1