TIBCO ActiveMatrix Adapter for WebSphere MQ Configuration and Deployment. Software Release 6.2 January 2011

Transcription

1 TIBCO ActiveMatrix Adapter for WebSphere MQ Configuration and Deployment Software Release 6.2 January 2011

2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, The Power of Now, TIBCO Adapter, TIBCO ActiveMatrix, Predictive Business, Information Bus, TIBCO ActiveMatrix BusinessWorks, TIBCO Rendezvous, TIBCO Administrator, TIBCO Designer, TIBCO Runtime Agent, TIBCO Hawk, TIBCO Enterprise Message Service, TIBCO Designer Add-in for TIBCO Business Studio, TIBCO ActiveMatrix Service Grid, TIBCO ActiveMatrix Service Bus, TIBCO ActiveMatrix BusinessWorks Service Engine, TIBCO ActiveMatrix Administrator, TIBCO ActiveEnterprise, and TIBCO Business Studio, are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 iii Contents Figures ix Tables xi Preface xv Changes from the Previous Release of this Guide xvi Related Documentation xvii TIBCO ActiveMatrix Adapter for WebSphere MQ Documentation xvii Other TIBCO Product Documentation xvii Third-Party Documentation xviii Typographical Conventions xix How to Contact TIBCO Support xxi Chapter 1 Preparing WebSphere MQ Application Interfaces Overview Creating a Queue Manager on Microsoft Windows Creating a Queue Manager on UNIX Testing the Connection Locating Queue Manager and Obtaining Queue Statistics Chapter 2 Getting Started Prerequisites Connections to the WebSphere MQ Application Permissions to Access Repository Server Configuring the Adapter Starting the Adapter Starting the Adapter with the Adapter Tester Starting the Adapter from the Command line with a Repository File Starting the Adapter from the Command Line with a Properties File Chapter 3 Adapter Instance Options Overview Configuration Tab

4 iv Contents Run-time Connection Tab General Tab Multithreading Tab Logging Tab Startup Tab Monitoring Tab Chapter 4 Adapter Service Options Transport Specific Service Options Transport Type Quality of Service Wire Format Connection Factory Type Delivery Mode Publication Service Configuration Tab Conversion Tab Queue Options Tab Batching Tab Advanced Tab Subscription Service Configuration Tab Conversion Tab Queue Options Tab Advanced Tab Request-Response Service Configuration Tab Conversion Tab Request Queue Options Tab Reply Queue Options Tab Advanced Tab Request-Response Invocation Service Configuration Tab Conversion Tab Request Queue Options Tab Reply Queue Options Tab Batching Tab Advanced Tab Data Conversion Options Conversion Type Adapter Encoding

5 Contents v Adapter Service Fields Supplement Importing COBOL Copybooks Configuring COBOL CopyBook Parameters Creating an Operation Class Chapter 5 IMS Message Format Overview IMS Message Structure Message Segmentation Creating IMS Wrapper Schema Creating IMS Wrapper Schema Manually Creating with IMS Wrapper Schema Wizard Configuring Services Using IMS Message Format Prerequisites Configuring a Publication Service Configuring a Subscription Service Configuring a Request-Response Service Edit IMS-MQIIH Fields Dialog Chapter 6 RFH Message Format Overview RFH Message Structure Message Segmentation Computational Methods for StrucLength Creating RFH Wrapper Schema Configuring Services Using RFH Message Format Chapter 7 CIH Message Format Overview CIH Message Structure Configuring Services Using CIH Message Format Configuring a Subscription Service Configuring a Publication Service Configuring a Request-Response Service Configuring a Request-Response Invocation Service Chapter 8 Data Conversion Overview None Conversion Restrictions

6 vi Contents Conversion of Data Types MQString to TIBCO Format Conversion Advantages MQString Message Syntax MQString Message to Rendezvous Wire Format Message MQString Message to ActiveEnterprise Wire Format Message MQMD to ExtendedTIBMsg Conversion Advantages Example of an ExtendedTIBMsg Message COBOL Copybook Conversions General Conversion Rules Components in COBOL Copybook Conversions EOC and EOM REDEFINES Clause Importing Multiple 01 COBOL CopyBook Definitions Conversions from TIBCO-Enabled Applications to WebSphere MQ Conversions from WebSphere MQ to TIBCO-Enabled Applications Custom Conversions Conversions from TIBCO-Enabled Applications to WebSphere MQ Conversions from WebSphere MQ to TIBCO-Enabled Applications Error handling Trace Information Customizing the WebSphere MQ API usage Requirement for Compiling Conversion Functions and Replacement APIs Chapter 9 Deploying the Adapter with TIBCO Administrator Deploying the Adapter Starting or Stopping the Adapter Monitoring the Adapter Adapter Properties File Properties File Format Predefined Properties Chapter 10 Advanced Topics Using the Adapter with a Revision Control System Defining a TIBCO Hawk Session Using Global Variables Variable Specification Predefined Global Variables Setting Encoding Options CCSID

7 Contents vii Encoding Conversions Supported by the Adapter Configuring the Adapter to Process Encoded Messages MQMD to JMS Header Mapping Chapter 11 Monitoring the Adapter Using TIBCO Hawk Overview Starting TIBCO Hawk Software The Auto-Discovery Process Invoking Microagent Methods Available Microagents _onunsolictedmsg() activatetracerole() deactivatetracerole() getactivitystatistics() getactivitystatisticsbyoperation() getactivitystatisticsbyschema() getactivitystatisticsbyservice() getadapterserviceinformation() getchannelproperties() getcomponents() getconfig() getconnectionstatistics() getconfigproperties() geteventqueuesize() gethostinformation() getpollinginterval() getprocessdefproperties() getqueueproperties() getqueuestatistics() getrvconfig() getstatus() gettracesinks() getthreadstatistics() getversion() preregisterlistener() resetactivitystatistics() resetconnectionstatistics() resetthreadstatistics() reviewledger() setpollinginterval() settracesinks() stopapplicationinstance()

8 viii Contents unregisterlistener() Index

9 Figures ix Figures Figure 1 TIBCO Designer Startup Panel Figure 2 Save Project Figure 3 Add a Publication Service Figure 4 Import CopyBook Figure 5 COBOL CopyBook Parameter Configuration Figure 6 Wrap Classes with IMS Wrapper Schema Wizard Figure 7 Create IMS Wrapper Class Schema Figure 8 Create IMS Wrapper Class Schema Figure 9 Edit IMS-MQIIH Fields Figure 10 Import CopyBook Figure 11 Enter the Control Field Values Figure 12 Extended Properties Figure 13 Create an EAR File Figure 14 Definition for a Monitoring Tab Figure 15 Configure the Hawk Session Figure 16 Global Variables Figure 17 TIBCO Hawk Enterprise Monitor Figure 18 Microagents, Methods and Arguments Dialog Figure 19 Select Microagent and Method Figure 20 Invocation Result Dialog

10 x Figures

11 Tables xi Tables Table 1 General Typographical Conventions xix Table 2 Syntax Typographical Conventions xx Table 3 Commands to Obtain Queue Statistics Table 4 Field Description of Configuration Tab Table 5 Field Description of Run-time Connection Tab Table 6 Field Description of the General Tab Table 7 Field Description of Multithreading Tab Table 8 Field Description of Logging Tab Table 9 Field Description of Startup Tab Table 10 Field Description of Monitoring Tab Table 11 Configuration Tab of Publication Service Table 12 Conversion Tab of Publication Service Table 13 Queue Options Tab of Publication Service Table 14 Batching Tab of Publication Service Table 15 Advanced Tab of Publication Service Table 16 Configuration Tab of Subscription Service Table 17 Conversion Tab of Subscription Service Table 18 Queue Options Tab of Subscription Service Table 19 Advanced Tab of Subscription Service Table 20 Configuration Tab of Request-Response Service Table 21 Conversion Tab of Request-Response Service Table 22 Request Queue Options Tab of Request-Response Service Table 23 Reply Queue Options Tab of Request-Response Service Table 24 Advanced Tab of Request-Response Service Table 25 Configuration Tab of Request-Response Invocation Service Table 26 Conversion Tab of Request-Response Invocation Service Table 27 Request Queue Options Tab of Request-Response Invocation Service Table 28 Reply Queue Options Tab of Request-Response Invocation Service

12 xii Tables Table 29 Batching Tab of Request-Response Invocation Service Table 30 Advanced Tab of Request-Response Invocation Service Table 31 IBM CCSIDs Supported by the Adapter Table 32 MQIIH Fields Table 33 Data Conversions Supported by the Adapter Table 34 None Conversion from TIBCO to WebSphere MQ Table 35 None Conversion from WebSphere MQ to TIBCO Table 36 Type Conversions from Rendezvous Wire Format to MQString Table 37 Type Conversions from MQString to Rendezvous Wire Format Table 38 Type Conversions from ActiveEnterprise Wire Format to MQString Table 39 Type Conversions from MQString to ActiveEnterprise Wire Format Table 40 Single and Dynamic Copybook Parameter File Fields Table 41 Configuration Parameters from TIBCO-enabled Applications to WebSphere MQ Table 42 Configuration Parameters from WebSphere MQ to TIBCO-enabled Applications Table 43 Supported COBOL Copybook and Data Type Mappings Table 44 Generated ActiveEnterprise Schema for Imported Sample Copybook Table 45 Generated REDEFINES Groups Table 46 Conversions from TIBCO-enabled Applications to WebSphere MQ Table 47 Conversions from WebSphere MQ to TIBCO-Enabled Applications Table 48 Predefined Properties Table 49 Predefined Global Variables Table 50 Hexadecimal values for character sets Table 51 Common CCSIDs and their descriptions Table 52 Platforms and encoding schemes used by WebSphere MQ Table 53 Microagent Methods Table 54 Input parameters of activatetracerole() Table 55 Input parameters of deactivatetracerole() Table 56 Input parameter of getactivitystatistics() Table 57 Returns of getactivitystatistics() Table 58 Input parameter of getactivitystatisticsbyoperation() Table 59 Returns of getactivitystatisticsbyoperation() Table 60 Input parameter of getactivitystatisticsbyschema()

13 Tables xiii Table 61 Returns of getactivitystatisticsbyschema() Table 62 Input parameter of getactivitystatisticsbyservice() Table 63 Returns of getactivitystatisticsbyservice() Table 64 Input parameter of getadapterserviceinformation() Table 65 Returns of getadapterserviceinformation() Table 66 Input parameter of getchannelproperties() Table 67 Returns of getchannelproperties() Table 68 Input parameters of getcomponents() Table 69 Returns of getcomponents() Table 70 Returns of getconfig() Table 71 Returns of getconnectionstatistics() Table 72 Input parameter of getconfigproperties() Table 73 Returns of getconfigproperties() Table 74 Input parameter of geteventqueuesize() Table 75 Returns of geteventqueuesize() Table 76 Returns of gethostinformation() Table 77 Return of getpollinginterval() Table 78 Input parameter of getprocessdefproperties() Table 79 Returns of getprocessdefproperties() Table 80 Input parameter of getqueueproperties() Table 81 Returns of getqueueproperties() Table 82 Returns of getqueuestatistics() Table 83 Input parameter of getrvconfig() Table 84 Returns of getrvconfig() Table 85 Returns of getstatus() Table 86 Input parameters of gettracesinks() Table 87 Returns of gettracesinks() Table 88 Returns of getthreadstatistics() Table 89 Returns of getversion() Table 90 Input parameters of preregisterlistener() Table 91 Input parameters of reviewledger() Table 92 Returns of reviewledger()

14 xiv Tables Table 93 Input parameters of setpollinginterval() Table 94 Input parameters of settracesinks() Table 95 Input parameters of unregisterlistener()

15 xv Preface TIBCO ActiveMatrix Adapter for WebSphere MQ enables WebSphere MQ applications to exchange data with applications configured for the TIBCO environment. This manual describes configuration methods and deployment methods. Topics Changes from the Previous Release of this Guide, page xvi Related Documentation, page xvii Typographical Conventions, page xix How to Contact TIBCO Support, page xxi

16 xvi Changes from the Previous Release of this Guide Changes from the Previous Release of this Guide This section itemizes the major changes from the previous release of TIBCO ActiveMatrix Adapter for WebSphere MQ Configuration and Deployment. The Alerter Option for the Outbound Services The Alerter checkbox has been added in the Configuration tabs of outbound services. If this checkbox is checked, the outbound service is blocked until WebSphere MQ alerts the adapter that there are messages in the queue. The outbound service publishes or sends requests or messages until the queue is empty. Then the adapter will be blocked until another alert is received. See Configuration Tab, page 39 for Publication Service and Configuration Tab, page 74 for Request-Response Invocation Service. Support MQCIH Message Format for Publication Service and Subscription Service In addition to Request-Response Service and Request-Response Invocation Service, this release adds support for MQCIH (MQ CICS Information Header) in Publication Service and Subscription Service. See Chapter 7, CIH Message Format, page 117. Cobol Copybook TIB Message to MQ Supports CIH Message Format This release supports the Cobol CopyBook conversion for the MQCIH data format. To implement this, the following schemas have been added: ccb_cih_errresp_wrapper_class, example_ccb_cih_wrapper_class, ccb_cih_resp_wrapper_class, and example_ccb_cih_operation_class. See Chapter 7, CIH Message Format, page 117. The Are Ids in EBCDIC Option The Are Ids in EBCDIC checkboxes have been added in the Conversion tabs of the adapter services. When this checkbox is checked, the adapter supports the conversion (between EBCDIC IBM-500 and ASCII) of the msgid, correlation id, and group id fields in the MQMD structure. See the Conversion tabs of the adapter services explained in Chapter 4, Adapter Service Options, page 33.

17 Preface xvii Related Documentation This section lists documentation resources you may find useful. TIBCO ActiveMatrix Adapter for WebSphere MQ Documentation The following documents form the TIBCO ActiveMatrix Adapter for WebSphere MQ documentation set: TIBCO ActiveMatrix Adapter for WebSphere MQ Concepts Read this manual before reading any other book in the documentation set. This manual describes the adapter, adapter features, and the applications with which the adapter interacts. TIBCO ActiveMatrix Adapter for WebSphere MQ Installation Read this manual for instructions on how to install and uninstall the standalone adapter on Windows and UNIX platforms. TIBCO ActiveMatrix Adapter for WebSphere MQ Configuration and Deployment Read this manual to learn how to create and configure standalone adapter projects. Information on deploying adapter projects is also included. TIBCO ActiveMatrix Adapter for WebSphere MQ Examples Read this manual to work through the examples provided with the adapter. TIBCO ActiveMatrix Adapter for WebSphere MQ Release Notes Read the release notes for information about new features, changed features, and open and closed issues. Other TIBCO Product Documentation You may find it useful to read the documentation for the following TIBCO products: TIBCO ActiveMatrix BusinessWorks TIBCO Adapter SDK TIBCO Administrator TIBCO Designer TIBCO Enterprise Message Service TIBCO Hawk TIBCO Rendezvous TIBCO Runtime Agent

18 xviii Related Documentation Third-Party Documentation You may also find it useful to read the following IBM WebSphere MQ documentation: WebSphere MQ Quick Beginnings WebSphere MQ System Administration WebSphere MQ Application Programming Reference WebSphere MQ Application Programming Guide WebSphere MQ MQSC Command Reference WebSphere MQ Clients

19 Preface xix Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention TIBCO_HOME ENV_HOME ADMQS_HOME code font bold code font italic font Key combinations Use Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco. Other TIBCO products are installed into an installation environment. Incompatible products and multiple instances of the same product are installed into different installation environments. The directory into which such products are installed is referenced in documentation as ENV_HOME. The value of ENV_HOME depends on the operating system. For example, on Windows systems the default value is C:\tibco. TIBCO ActiveMatrix Adapter for WebSphere MQ installs into a directory within TIBCO_HOME. This directory is referenced in documentation as ADMQS_HOME. The value of ADMQS_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\adapter\admqs\version_number. Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process. Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type admin. In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable disable] Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.

20 xx Typographical Conventions Table 1 General Typographical Conventions (Cont d) Convention Use The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances. The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result. The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken. Table 2 Syntax Typographical Conventions Convention Use [ ] An optional item in a command or code syntax. For example: MyCommand [optional_parameter] required_parameter A logical OR that separates multiple items of which only one may be chosen. For example, you can select only one of the following parameters: MyCommand para1 param2 param3 { } A logical group of items in a command. Other syntax notations may appear within each logical group. For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4. MyCommand {param1 param2} {param3 param4} In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 param2} {param3 param4} In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4. MyCommand param1 [param2] {param3 param4}

21 Preface xxi How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows. For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a user name and password. If you do not have a user name, you can request one.

22 xxii How to Contact TIBCO Support

23 1 Chapter 1 Preparing WebSphere MQ Application Interfaces This chapter explains how to configure the WebSphere MQ application so that the adapter can interoperate with it. Topics Overview, page 2 Creating a Queue Manager on Microsoft Windows, page 3 Creating a Queue Manager on UNIX, page 5 Testing the Connection, page 6 Locating Queue Manager and Obtaining Queue Statistics, page 7

24 2 Chapter 1 Preparing WebSphere MQ Application Interfaces Overview WebSphere MQ is an messaging software that can be used for inter-application communication. WebSphere MQ enables applications in different environments to exchange data asynchronously using messages and queues. Applications that are integrated through WebSphere MQ use a common application programming interface called the Message Queue Interface (MQI). This interface is consistent across all supported platforms. Before configuring the adapter, you must prepare the WebSphere MQ application so that the adapter can interoperate with it.

25 Creating a Queue Manager on Microsoft Windows 3 Creating a Queue Manager on Microsoft Windows You can use WebSphere MQ Explorer to create queue managers. Task A Create a Default Queue Manager To create a default queue manager: 1. Start WebSphere MQ Explorer by selecting Start > All Programs > IBM WebSphere MQ > WebSphere MQ Explorer. 2. In the WebSphere MQ Explorer-Navigator panel, right-click Queue Managers, and then select New > Queue Manager. 3. In the Queue manager name field, enter the name of the default queue manager, for example, queue.manager.1. Select the Make this the default queue manager checkbox. Click Next. 4. Click Next to accept the default setting for log values. 5. Select the Create server-connection channel checkbox. Click Next. 6. Ensure that the Create listener configured for TCP/IP checkbox is selected. Enter 1414 in the Listen on port number field. 7. Click Finish. Task B Create a Local Queue To create a local queue: 1. In the WebSphere MQ Explorer-Navigator panel, expand the queue manager that you have just created. 2. Right-click the Queues folder, and select New > Local Queue. 3. In the Name field, enter the name of the local queue. 4. Click Finish. Task C Define a Server-Connection Channel To define the server-connection channel: 1. In the WebSphere MQ Explorer-Navigator panel, expand the Advanced folder under the queue manager you have just created. 2. Right-click the Channels folder, and select New > Server-Connection Channel.

26 4 Chapter 1 Preparing WebSphere MQ Application Interfaces 3. In the Name field, enter the name of the server-connection channel. Click Next. 4. Click Finish. Task D Verify the Listener The listener starts automatically when you created the queue manager. To verify this: 1. Start the WebSphere MQ utility by entering the following command at the command prompt: runmqsc 2. View the status of the listener process by entering the following command: display lsstatus(*)

27 Creating a Queue Manager on UNIX 5 Creating a Queue Manager on UNIX To create a queue manager on UNIX: 1. Create a default queue manager by entering the following command at the command prompt: crtmqm -q queue.manager.1 where, crtmqm is a WebSphere MQ control command that will create the queue manager and queue.manager.1 is the name of the default queue manager. 2. Start the queue manager by using the following command: strmqm queue.manager.1 3. Start the WebSphere MQ utility by entering the following command: runmqsc This utility allows you to create, delete, and manipulate queue manager objects. 4. Create a local queue by using the following command: define qlocal (queue1) where, queue1 is the name of the local queue. 5. Create a server-connection channel by entering the following command: define channel (channel1) chltype (svrconn) trptype(tcp) mcauser ( ) 6. Stop MQSC by entering end at the command prompt. 7. Start a listener by entering the following command: runmqlsr -t tcp -m queue.manager.1 The WebSphere MQ server is now ready to communicate with the WebSphere MQ client.

28 6 Chapter 1 Preparing WebSphere MQ Application Interfaces Testing the Connection You can test the adapter connection with the WebSphere MQ application after you have created a queue manager and queues and configured the adapter. To test the connection, run the amqsputc example that is packaged with the WebSphere MQ.

29 Locating Queue Manager and Obtaining Queue Statistics 7 Locating Queue Manager and Obtaining Queue Statistics You can use the WebSphere MQ commands to locate the queue manager that you have created, get information about the queues such as names, depth, and so on. The commands in this section are entered at the command prompt. You cannot use the adapter to obtain WebSphere MQ queue statistics. To get queue and queue manager information, you must first start the WebSphere MQ RUNMQSC utility by entering the following command at the command prompt: runmqsc Ensure that the queue manager has started before running the commands in this section. Table 3 lists commands that you can use to interact with a queue manager and obtain queue statistics. Table 3 Commands to Obtain Queue Statistics Purpose Command Example Display how many messages a queue currently contains. Display the maximum number of messages set for a queue. display queue(queue name) CURDEPTH display queue(queue name) MAXDEPTH For the queue MQSUB, use the command: display queue(mqsub) CURDEPTH Sample output: 2 : display queue(mqsub) CURDEPTH AMQ8409: Display Queue details. QUEUE(MQSUB) CURDEPTH(2) For the queue MQSUB, use the command: display queue(mqsub) MAXDEPTH Sample output: 3 : display queue(mqsub) MAXDEPTH AMQ8409: Display Queue details. QUEUE(MQSUB) MAXDEPTH(5000)

30 8 Chapter 1 Preparing WebSphere MQ Application Interfaces Table 3 Commands to Obtain Queue Statistics (Cont d) Purpose Command Example Display if a queue is enabled for the PUT operation. Display a list of available queues. display queue(queue name) PUT display queue (*) type (qlocal) For the queue MQSUB, use the command: display queue(mqsub) PUT Sample output: 4 : display queue(mqsub) PUT AMQ8409: Display Queue details. QUEUE(MQSUB) PUT(ENABLED) The PUT operation is enabled for the MQSUB queue. Use the command: display queue(*) type (qlocal) Sample output: 5: display queue(*) type(qlocal) AMQ8409: Display Queue details. QUEUE(SYSTEM.ADMIN.CHANNEL.EVENT) AMQ8409: Display Queue details. QUEUE(SYSTEM.ADMIN.COMMAND.QUEUE) AMQ8409: Display Queue details. QUEUE(SYSTEM.ADMIN.PERFM.EVENT) AMQ8409: Display Queue details. QUEUE(SYSTEM.ADMIN.QMGR.EVENT) AMQ8409: Display Queue details. QUEUE(SYSTEM.AUTH.DATA.QUEUE) AMQ8409: Display Queue details. QUEUE(SYSTEM.CHANNEL.INITQ) AMQ8409: Display Queue details. QUEUE(SYSTEM.CHANNEL.SYNCQ) AMQ8409: Display Queue details. QUEUE(SYSTEM.CICS.INITIATION.QUEUE)

31 9 Chapter 2 Getting Started This chapter describes the basic steps that are required to configure and run the adapter. Details for each of the steps described here are provided later in the manual. Topics Prerequisites, page 10 Configuring the Adapter, page 11 Starting the Adapter, page 16

32 10 Chapter 2 Getting Started Prerequisites Before starting the configuration, ensure that all required software has been installed and is operating correctly. For a list of required software, see TIBCO ActiveMatrix Adapter for WebSphere MQ Installation. This manual assumes that you know how to drag icons in TIBCO Designer and how to save projects. If you are not familiar with these topics, refer to the TIBCO Designer User s Guide, which is available by selecting Help > Designer Help in TIBCO Designer. Connections to the WebSphere MQ Application Ensure that the adapter to the WebSphere MQ queue manager connections are in place. See Preparing WebSphere MQ Application Interfaces on page 1 for details. Permissions to Access Repository Server If your site is using TIBCO Administrator to control access to the repository server, you must have the account name and password available that is used by the adapter to log into the server.

33 Configuring the Adapter 11 Configuring the Adapter To configure the adapter, you need to complete the following tasks: Task A, Create a Project, page 11 Task B, Create an Adapter Instance, page 13 Task C, Configure Runtime Connection Settings, page 13 Task D, Configure a Service, page 13 Task A Create a Project The TIBCO Designer GUI is used to configure adapter instances. When starting Designer, you must create or select a project. A project contains the configuration files that define options used by a runtime adapter. To create a project: 1. Start TIBCO Designer by executing one of the following platform-specific commands: On Microsoft Windows: select Start > All Programs > TIBCO > TIBCO Designer 5.6> Designer 5.6 On Unix: from a command window change the directory to install-path/tibco/designer/version_number/bin and type./designer 2. In the TIBCO Designer startup panel, click New empty project.

34 12 Chapter 2 Getting Started Figure 1 TIBCO Designer Startup Panel 3. From the Project menu, select Save. 4. In the Project Directory field, browse to select the directory where you want to save the project and specify a name for the project. Click OK. Figure 2 Save Project

35 Configuring the Adapter 13 Task B Create an Adapter Instance An adapter instance can contain Publication Services, Subscription Services, Request-Response Services, Request-Response Invocation Services, or all of the above. To configure an adapter instance: 1. In the Project Explorer, select the project that was created in Task A. 2. Drag the WebSphereMQ Adapter Configuration icon from the Palettes panel to the Design panel. This creates an adapter instance named, by default, WebSphereMQAdapterConfiguration. You can change the name in the Configuration tab. 3. Select the Show All Tabs checkbox. Task C Configure Runtime Connection Settings Specify the instance-level runtime parameters in the Run-time Connection tab. 1. In the Queue Manager field, enter the name of the WebSphere MQ queue manager that you want the adapter to communicate with. If left blank, the default queue manager that is set in the WebSphere MQ Explorer will be used. 2. In the Error Queue field, enter the name of the queue that will be used to write errors generated by the adapter. 3. Click Apply. 4. Click the Test Connection button to verify whether the adapter can connect to the specified queue manager. This step is optional. Task D Configure a Service The next step is to configure an adapter service that performs the publication, subscription, or request-response data passing operations for the adapter. In this task, you will learn how to configure a Publication Service using the COBOL Copybook format to TIBCO wire format message conversion. To add a Publication Service: 1. In the Project panel, expand the WebSphereMQAdapterConfiguration folder, select Adapter Services. 2. Drag the Publication Service icon from the Palettes panel to the Design panel.