IBM WebSphere Message Broker V6
Display, Test and Performance utilities
Version 6.0
14 April 2008
Jim MacNair
MQSeries Sales Support
IBM
Route 100
Somers, NY
USA
macnair@us.ibm.com
Property of IBM
WebSphere Message Broker - Message display and test utility
Take Note!
Before using this report be sure to read the general information under "Notices".
Twenty-sixth Edition, April, 2008
This edition applies to Version 6.0 of WebSphere Message Broker test, display and
performance utilities and to all subsequent releases and modifications unless otherwise
indicated in new editions.
© Copyright International Business Machines Corporation 2001, 2002, 2003, 2004, 2005,
2006, 2007, 2008 All rights reserved. Note to US Government Users – Documentation related
to restricted rights – Use, duplication or disclosure is subject to restrictions set forth in GSA
ADP Schedule contract with IBM Corp.
WebSphere Message Broker V6 - Message display, test and performance utilities
ii
Table of Contents
Take Note! ........................................................................................................................i
Twenty-sixth Edition, April, 2008 ......................................................................................i
Table of Contents .........................................................................ii
Notices .......................................................................................viii
Trademarks and service marks ................................................................................................................................viii
Acknowledgments........................................................................x
Summary of Amendments..........................................................xi
Preface ........................................................................................xii
Chapter 1. Introduction................................................................1
Version History...........................................................................................................................................................1
Changes in V1.0.1 .......................................................................................................... 1
Changes in V1.0.2 .......................................................................................................... 1
Changes in V2.0.1 .......................................................................................................... 1
Changes in V2.1 ............................................................................................................. 1
Changes in V2.11 ........................................................................................................... 2
Changes in V2.12 ........................................................................................................... 2
Changes in V3.0 ............................................................................................................. 2
Changes in V3.02 ........................................................................................................... 2
Changes in V3.1 ............................................................................................................. 2
Changes in V3.1.1 .......................................................................................................... 3
Changes in V3.2 ............................................................................................................. 3
Changes in V3.21 ........................................................................................................... 3
Changes in V3.22 ........................................................................................................... 3
Changes in V3.23 ........................................................................................................... 3
Changes in V3.3 ............................................................................................................. 3
Changes in V3.4.2 .......................................................................................................... 4
Changes in V3.4.3 .......................................................................................................... 4
Changes in V3.5.0 .......................................................................................................... 4
Changes in V3.5.1 .......................................................................................................... 4
Changes in V3.6 ............................................................................................................. 4
Changes in V3.6.1 .......................................................................................................... 5
Changes in V3.6.2 .......................................................................................................... 5
Changes in V3.7.1 .......................................................................................................... 5
Changes in V3.7.2 .......................................................................................................... 5
Changes in V3.9.2 .......................................................................................................... 5
Changes in V3.9.2 .......................................................................................................... 5
Changes in V4.0.1 .......................................................................................................... 5
Changes in V 4.0.2 ......................................................................................................... 6
Changes in V 4.0.3 ......................................................................................................... 6
Changes in V 4.0.4 ......................................................................................................... 6
Changes in V 4.0.5 ......................................................................................................... 6
Changes in V 4.0.6 ......................................................................................................... 6
Changes in V 4.0.7 ......................................................................................................... 6
Changes in V 4.0.11 ....................................................................................................... 6
Changes in V 4.20 .......................................................................................................... 7
Changes in V 5.0 ............................................................................................................ 7
Changes in V 5.0.1 ......................................................................................................... 7
Changes in V 5.0.2 ......................................................................................................... 7
Changes in V 5.0.3 ......................................................................................................... 7
Changes in V 5.0.4 ......................................................................................................... 8
Changes in V 5.0.6 ......................................................................................................... 8
Changes in V 6.0 ............................................................................................................ 8
WebSphere Message Broker V6 - Message display, test and performance utilities
iii
What the RFHUtil utility does .....................................................................................................................................9
Header chaining .........................................................................................................................................................9
Chapter 2. Installation................................................................10
Supported Environments..........................................................................................................................................10
Display Requirements ...................................................................................................... 10
Character set considerations............................................................................................ 10
Installing additional code pages on Windows XP......................................................... 10
Limitations in the RFHUtil.exe utility.........................................................................................................................11
Installation ................................................................................................................................................................11
Using the source programs .............................................................................................. 13
Security Considerations when using RFHUtil and RFHUtilc ....................................................................................13
Chapter 3. Using the Display and Test Utility..........................14
Starting the utility......................................................................................................................................................14
Main Tab ..................................................................................................................................................................14
Reading and writing from/to a file or queue ..................................................................... 14
Queue manager and queue names ................................................................................. 14
Considerations when using the client version (rfhutilc.exe)............................................. 15
Read Queue button.......................................................................................................... 15
Write Queue button .......................................................................................................... 16
Writing to remote queues ................................................................................................. 16
Browse operations............................................................................................................ 16
Browse Queue button....................................................................................................... 16
Start Browse button.......................................................................................................... 16
Browse Next, Browse Prev and End Browse buttons...................................................... 17
Close Q button ................................................................................................................. 17
Open File button............................................................................................................... 17
Save File Button ............................................................................................................... 18
Clear Data and Clear All buttons...................................................................................... 18
Display Q button............................................................................................................... 18
Purge Q button ................................................................................................................. 20
Save Q button .................................................................................................................. 20
Load Q button...................................................................................................................21
Move Q button.................................................................................................................. 22
Considerations when moving messages using the Move Q button ................................. 23
Load Names button.......................................................................................................... 24
Set Conn Id button ........................................................................................................... 24
Q Depth, Queue Type and Data Size .............................................................................. 25
Cluster Open ....................................................................................................................25
Get and Put options.......................................................................................................... 26
Convert option and MQ data conversion considerations.............................................. 26
Setting the user id and application context ...................................................................... 27
Considerations when using message groups and segmentation..................................... 27
Data tab selections...................................................................................................................................................28
Data Window .................................................................................................................... 28
Data formats..................................................................................................................... 28
Numeric formats ............................................................................................................... 29
Character formats............................................................................................................. 30
CR/LF selection ............................................................................................................ 30
EDI selection................................................................................................................. 30
Indent selection............................................................................................................. 30
Validate......................................................................................................................... 30
Data Translation ........................................................................................................... 30
Browse Next button.......................................................................................................... 31
Browse Prev button.......................................................................................................... 31
Browse status messages ................................................................................................. 31
Copybook button .............................................................................................................. 31
WebSphere Message Broker V6 - Message display, test and performance utilities
iv
Search Menu Items ..................................................................................................................................................32
MQMD tab ................................................................................................................................................................32
MQ Message Format........................................................................................................ 33
User id, Accounting Token and Backout Count ............................................................... 33
Put Date/Time, Expiry and Feedback .............................................................................. 33
Original Length and message sequence number ............................................................ 33
Message Id, Correlation Id and Group Id......................................................................... 33
Editing the message id, correlation id and group id ......................................................... 33
Report options ..................................................................................................................34
Message flags .................................................................................................................. 34
Application context fields.................................................................................................. 34
Reply to queue and queue manager................................................................................ 34
Reset Ids button ............................................................................................................... 35
Copy msgid to correlid button........................................................................................... 35
RFH tab selections ...................................................................................................................................................35
Multiple RFH headers in a single message...................................................................... 36
RFH fixed data ................................................................................................................. 36
RFH variable data ............................................................................................................ 36
RFH Type ......................................................................................................................... 36
V2 Folders ........................................................................................................................ 37
PubSub tab...............................................................................................................................................................37
Request Type ................................................................................................................... 38
Topic(s)............................................................................................................................. 38
Filter.................................................................................................................................. 38
Sub Point/Stream ............................................................................................................. 38
Sub Name, Identity and Data ........................................................................................... 38
Queue manager to connect to.......................................................................................... 38
Queue Name .................................................................................................................... 38
Broker Queue Manager Name ......................................................................................... 38
Subscription Queue Manager........................................................................................... 39
Subscription Queue.......................................................................................................... 39
Pub Time .......................................................................................................................... 39
Seq No.............................................................................................................................. 39
Other Fields...................................................................................................................... 39
Options ............................................................................................................................. 39
Persistence....................................................................................................................... 40
Clear button...................................................................................................................... 41
Save to File button ........................................................................................................... 41
Write Msg button .............................................................................................................. 41
pscr tab.....................................................................................................................................................................41
jms tab......................................................................................................................................................................42
JMS Message Type.......................................................................................................... 42
Destination........................................................................................................................ 43
Reply To ........................................................................................................................... 43
Correlation Id.................................................................................................................... 43
Group Id and Sequence ................................................................................................... 43
Timestamp........................................................................................................................ 43
Priority .............................................................................................................................. 43
Expiration.......................................................................................................................... 43
Delivery mode .................................................................................................................. 43
User Defined Fields.......................................................................................................... 43
usr tab ......................................................................................................................................................................44
Handling of attributes in the RFH2 usr area..................................................................... 44
other tab ...................................................................................................................................................................45
CICS Tab..................................................................................................................................................................45
Version ............................................................................................................................. 46
Program............................................................................................................................ 46
Trans id............................................................................................................................. 47