IBM Support

MA0W: WebSphere MQ API Trace



The API trace utility provides trace function of MQ API calls by exploiting the API exit interface in WebSphere MQ. Detail of API calls can be verified as actual processing results

Download Description

This API trace utility provides trace function of MQ API calls, by exploiting the API exit interface provided by WebSphere MQ. You can verify detail of MQ API calls as actual results without looking into the program logic of MQ application programs.

The utility provides the following main functions:
• All parameter values passed by MQ applications just before API call execution can be traced completely.
• All parameter values just before returning to MQ applications right after API call execution can be traced completely including completion code and reason code.
• You can understand all trace data by referring to the WebSphere MQ product documentation with basic knowledge about MQ.
• Time before API call, time after API call, and process time of each API call are shown for each API call.
• Attribute values are parsed and shown in a format that's easy to view.
• Total call count of each API is shown in summary. Success count, warning count and fail count are also shown respectively.
• Multiple byte character set (MBCS) handling is considered for text output.

The following additional functions are also provided for better use of the utility:
• Trace data can be put to multiple files when data volume becomes large.
• File compression program can be invoked when creating a new trace file to reduce disk space usage.
• Operating environment, process name, and related process/thread information is shown as a part of context information.
• Options for file output operation can be customized for the optimization of the file output process.
• Target queue name and process name to be traced can be specified to eliminate unnecessary data for minimizing output data and also for minimizing performance degradation.
• A batch utility is provided for adding parsed data and character images to graphic hexadecimal data, so that you do not need to rerun the program after updating trace options.

Possible Uses
It can be used for functional verification and problem determination of MQ application programs.

Skill Level Required
Application programming interface of WebSphere MQ with basic MQ skills.

New in this release
• Improved internal logic.
• Fixed program defects.

Author: Osamu Inoue, IBM Japan Ltd
Category: 2
Released: 31Aug05
Last updated: 22Nov12
Current Version: 5.2.1
»Please note that the version number shown in the right-hand pane is the version of the WebSphere MQ or WebSphere Message Broker product that this SupportPac applies to. The date is the last webpage refresh.

To view the complete portfolio of WebSphere MQ SupportPacs please visit the WebSphere MQ SupportPacs homepage.


One of the following versions of WebSphere MQ:
• WebSphere MQ V6.0
• WebSphere MQ V7.0
• WebSphere MQ V7.1
• WebSphere MQ V7.5

Supported operating environments:
• Solaris (SPARC, x86-64)
• HP-UX 11i (PA-RISC, IA-64)
• Windows 2000, XP (x86-32)
• Linux (x86-32, x86-64, PowerPC)

Installation Instructions

To install this SupportPac:
• Package is in ZIP file format.
• Installation instructions are specified in the PDF document in the package.

[{"INLabel":"ma0w.pdf","INLang":"US English","INSize":"715062","INURL":""}]
[{"DNLabel":"","DNDate":"22 Nov 2012","DNLang":"US English","DNSize":"19202239","DNPlat":{"label":"Linux","code":"PF016"},"DNURL":"","DNURL_FTP":" ","DDURL":null}]

Technical Support

Category 2 SupportPacs are provided in good faith and AS-IS. There is no warranty or further service implied or committed and any supplied sample code is not supported via IBM product service channels.

You may submit a question or offer feedback on the SupportPac but please be aware that a response is NOT guaranteed.

Please read the license file that accompanies the SupportPac to determine if you want to use it.

[{"Product":{"code":"SSFKSJ","label":"WebSphere MQ"},"Business Unit":{"code":"BU004","label":"Hybrid Cloud"},"Component":"SupportPac","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"7.5;7.1;7.0.1;7.0;6.0","Edition":""}]

Document Information

Modified date:
15 June 2018