Message instance tag - <msg>

<msg class="msgtype"></msg>
The <msg> element defines a message in a message list. The class="msgtype" attribute, which describes the type of message, is required on the <msg> tag. The class describes z/OS® Health Checker message behavior. You can have the following values for class="msgtype":
  • Exception: Messages notifying the installation that action is required because a check routine found an exception to a suggested setting. The message text, intended for the operator, is issued in a WTO. The message text and full explanation are issued to the message buffer, mainly for the system programmer.
  • Information: Messages conveying general non-exception information, for example the completion of the check without exceptions, or as the first line of a report. Only the message text is issued to the message buffer.
  • Report: Single lines of report data issued to the message buffer without a message number (except in debug mode). Only the message text is issued to the message buffer. The report message type gives you the most control over the formatted output. A single report line should be 72 characters of formatted output or less. Because report messages do not display with a message number, a report message with a line of report data should be preceded by an information message containing the report title.
  • Debug: Messages issued to the message buffer when the check is placed in debug mode to aid in testing and diagnosis. Only the message text is issued to the message buffer.
The following table summarizes information for the different message types:
Table 1. A summary of message types for IBM Health Checker for z/OS
Message type <msg class=msgtype> Message number suffix Where is message text issued?
Exception <msg class=Exception> E
  • The message buffer, including the message text and all details.
  • WTO message text only to console, operlog, or syslog
Information <msg class=Information> I Message buffer
Report <msg class=report> N/A - Message number is not displayed unless you are running in debug mode and use SDSF to display the message. Message buffer
Debug <msg class=debug> N/A - Message number is not displayed unless you are running in debug mode and use SDSF to display the message. Message buffer or system hardcopy log
Each <msg> element must contain the following elements: Restriction: You must code the following tags in consecutive lines without comments or blank lines between them:

<msg class="msgtype"></msg>
<msgnum xreftext="nnnn">ccccHmmmms</msgnum>
<msgtext>....