IBM Support

Collect troubleshooting data for a Dead Letter Queue problem in IBM MQ for z/OS

Troubleshooting


Problem

You are experiencing a Dead Letter Queue (DLQ) problem in IBM MQ for z/OS. You would like to know what documentation you must collect (MustGather) so that the IBM MQ Support team can diagnose your problem. If you gather this documentation before contacting support, it expedites the troubleshooting process and saves you time.

Environment

These instructions apply only to IBM MQ for z/OS. Refer to the IBM MQ Read First page for instructions on other operating systems:

Resolving The Problem

Gather this MustGather data before contacting IBM Support:

 

Collecting general data for all problems

A complete description of the problem, including the following:

  • IBM MQ version, release, and maintenance level
  • Operating system version, release, and maintenance level
  • Related products version, and release levels if applicable
     

Collecting troubleshooting data for this problem

Required (MustGather) data:

  • Error Log
  • Browse of the messages on the dead letter queue. On z/OS, there are several ways to browse the message on the DLQ:

    • - Use the Message Handler Sample. Program CSQ4TCH3 formats the contents of the Dead Letter Header (DLH) like the now-withdrawn SupportPac MA17 did.
      - Use sample JCL CSQ4BCGR to run CSQ4BCG0, which is the browse-mode version of CSQ4BCG1.
      - Use a vendor or in-house program that displays the DLH in addition to the message data.
 
 

Troubleshooting hints and tips

  • Search the IBM MQ Support site for known problems by using symptoms like the message number and error codes.
  • Gather the documentation and work with the IBM MQ Support Team to resolve your problem.

Determine why a message is on the DLQ (dead letter queue):

  1. Browse the message on the dead letter queue by using a program that shows headers, such as CSQ4BGC0 in SCSQLOAD with sample JCL in SCSQPROC. See sample output below.
     
  2. Locate the dead letter header. The dead letter header starts with the characters "DLH".
    444C 4820 0000 0001 0000 010A 4D59 2E51 'DLH ........MY.Q'
     
  3. Find the dead letter Reason (the reason the message arrived on the DLQ) in the third word in the dead letter header.
    In this example the dead letter Reason is:

    x'0000 010A'

  4. Convert hex x'0000 010A' to decimal 266.

  5. Use the dead letter reason code to determine why the message was placed on the dead-letter queue. The deal letter reason code is a Reason Code (MQRC_*) or a Feedback Code (MQFB_*).
    Examples:
    MQFB_TM_ERROR  266  X'0000010A'
    MQRC_Q_FULL   2053  X'00000805'

     

For a list of reason codes, see Reason Codes

For a list of feedback codes, see Feedback Codes


See technote Dead Letter Reason Code 326 (x'146') in the MQDLH for more details on interpreting IMS feedback codes.
 

Learn more about this component:


Use the dead letter header (DLH) structure to determine why the message was routed to the dead letter queue (DLQ).
MQDLH - Dead Letter Header
 
Field Description Topic
StrucId Structure identifier StrucId
Version Structure version number Version
Reason Reason message arrived on the dead-letter queue Reason
DestQName Name of original destination queue DestQName
DestQMrgName Name of original destination queue manager DestQMrgName
Encoding Numeric encoding of data that follows MQDHL Encoding
CodedCharSetId Character set identifier of data that follows MQDHL CodedCharSetId
Format Format name of data that follows MQFHL Format
PutApplType Type of application that put message on dead-letter queue PutApplType
PutApplName Name of application that put message on dead-letter queue PutApplName
PutDate Date when message was put on dead-letter queue PutDate
PutTime Time when message was put on dead-letter queue PutTime


 

Exchanging data with IBM Support

Note:
 

Attached is an example of output of browing a message from the DLQ using sample JCL CSQ4BCGR to call browse program CSQ4BCG0



zSeries_CSQ4BCG1.txt

[{"Type":"MASTER","Line of Business":{"code":"LOB77","label":"Automation Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSWN2J","label":"IBM MQ for z\/OS"},"ARM Category":[{"code":"a8m0z00000008QrAAI","label":"Configuration-\u003EDead Letter Queue"},{"code":"a8m0z0000001iitAAA","label":"Retired-\u003ETroubleshooting"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"},{"Type":"MASTER","Line of Business":{"code":"LOB77","label":"Automation Platform"},"Business Unit":{"code":"BU048","label":"IBM Software"},"Product":{"code":"SSYHRD","label":"IBM MQ"},"ARM Category":[{"code":"a8m0z00000008QrAAI","label":"Configuration-\u003EDead Letter Queue"},{"code":"a8m0z0000001iitAAA","label":"Retired-\u003ETroubleshooting"}],"Platform":[{"code":"PF035","label":"z\/OS"}],"Version":"All Versions"}]

Product Synonym

IBM MQ WebSphere MQ WMQ

Document Information

Modified date:
30 April 2025

UID

swg21290934