IBM Tools Base Diagnostics Aid (HKTUDIAG) Utility User's Guide and Reference

The IBM Tools Base Diagnostics Aid is a tool that can help you collect the necessary diagnostic information to resolve a problem before you contact IBM Software Support.


IBM Tools Base Diagnostics Aid (HKTUDIAG) Utility User's Guide and Reference - cover page
Brand
IBM
Category
Other software
Document type
User Manual
Language
English
Pages
16
File format
PDF
File size
569 KB
Published
30 November, 2023
Updated
30 November, 2023
MD5 checksum
6C13C633EC6DF5CD94000D43BF739851

About this manual

The Tools Base Diagnostics Aid (HKTUDIAG) is the IBM utility documented in Part 6 of the IBM Tools Base: IMS Tools Common Services User's Guide and Reference. If you have a problem you think is not a user error, you run the aid to collect the necessary information, attach the resulting Load Module APAR Status report to other diagnostic documents such as the job dump list, and report the error to IBM. The report shows the latest APAR fixes applied to each module of the IMS Tools components, and the aid also produces a Journal Messages report about the job.

The chapters cover how to run the aid with a JCL stream, including the EXEC statement and the STEPLIB, LOADLIB, HKTPRINT and HKTRPRT DD statements; the two output reports and the fields of the Load Module APAR Status report; the IMS Tools load modules supported by the aid; and the HKTnnnx message format with its severity codes, explanations, system actions and user responses.

What's inside

  • Tools Base Diagnostics Aid overview
  • Load modules supported by the Tools Base Diagnostics Aid
  • How to run Tools Base Diagnostics Aid with JCL stream
  • LOADLIB DD statement
  • HKTPRINT DD statement
  • HKTRPRT DD statement
  • Journal Messages report
  • Load Module APAR Status report
  • Tools Base Diagnostics Aid return codes
  • Tools Base Diagnostics Aid messages

Specifications

Diagnostics Aid program nameHKTUDIAG
Journal Messages report output data setHKTPRINT
Load Module APAR Status report output data setHKTRPRT
Report record format133-byte, fixed-length records
STEPLIB library data setITB.SHKTLOAD
Message identifier formatHKTnnnx
Message severity WWarning to alert you to a possible error condition
Return code when the process ends with warning4

Frequently asked questions

What is the Tools Base Diagnostics Aid used for?

It is used to collect the necessary information when you have a problem you think is not a user error, so the report can be attached to other diagnostic documents before you report the error to IBM.

Which reports does the Tools Base Diagnostics Aid generate?

It generates a Journal Messages report and a Load Module APAR Status report.

What is shown in the APAR Number field when no APAR is applied?

None is shown in the APAR Number field.

What does the message suffix W indicate?

It indicates that the message is a warning to alert you to a possible error condition; processing then ends with a return code of 4.

Download PDF (569 KB)

More IBM Manuals


View all IBM manuals →