IBM Health Checker for z/OS User's Guide
Previous topic | Next topic | Contents | Contact z/OS | Library | PDF


How messages are formatted in the message buffer

IBM Health Checker for z/OS User's Guide
SC23-6843-02

For exception messages, both text (<msgtext>) and explanation (<msgitem class="itemclass"> except rcode and dcode) are issued to the message buffer. For information, report, and debug messages, only the text (<msgtext>) is issued to the message buffer or log.

Default formatting for messages in the message buffer is as follows:
  • Message processing for all messages and all the parts of a message use paragraph flow unless <lines></lines> tags are used to break up lines.
  • When a message is reformatted to fit in the message buffer, the system splits the line on a word boundary. Blanks may be lost when the line is split. The system suppresses blank lines.
  • The system strips leading and trailing blanks from variables, except variables in report messages or nocompress variables (<msgitem class="nocompress">.
  • A character string with a length greater than the output line length will continue on the following line without blanks added. This is referred to as wrap mode.

The table below shows how the different types of messages are formatted in the message buffer:

Table 1. How messages are formatted in the message buffer
Message type Formatting in the message buffer
Exception A complete message, including both the message text and explanation are issued to the message buffer. The message text is limited to 14 lines, 70 characters long (4 for indentation). In the check details, you can have lines 71 characters long. Check exception messages are imbedded in a IBM Health Checker for z/OS HZS prefix message with a prefix of HZS and format as follows:
  • The first line of the exception message contains the HZS message identifiers, either HZS003A, HZS002E, or HZS001I, depending on the severity of the message as well as the check owner and check name. For example, the following output would be issued to the operator console:
    HZS002E (IBMCSV,LNKLST_SPACE)                                      
    CSVH951E  LNKLST CZ INCLUDES DATA SETS WITH SECONDARY SPACE
    DEFINED.
  • The first line of the message explanation in the message buffer begins in position 3.
  • The second line of the message begins with the message identifier assigned to the message in the <msgnum> tag.
  • The second and following lines of the message begin in position 5 and are 66 characters long.
  • When the <msgtext> section ends, the system generates a new line.
Information The message text (<msgtext>) specified is formatted in paragraph format in the message buffer.
  • The system splits the line on a word boundary and begins the new line with a non-blank character. The system suppresses blank lines.
  • When data exceeds the output line length, it will wrap to the next line.
  • A line ends on a word boundary, and new lines begin in the 5th position on the following line.
Report The message text (<msgtext>) is a single line of data issued to the message buffer.
  • Each line of text begins in position 1.
  • When data exceeds the output line length, it will wrap to the next line.
  • The system will not suppress leading and trailing blanks in the message text when you add dynamic variables using the <mv> element. To compress leading and trailing blanks in a variable in a report message, use a <mv class="compress> tag.
Debug The message text (<msgtext>) is issued to the message buffer or system hardcopy log when you place the check in debug mode.
  • The first line of text in a debug message begins in position 1, unless you format the lines differently, using <lines>, for example.
  • Lines end on a word boundary and new lines begin in the 5th position on the following line.
  • When data exceeds the output line length, it will wrap to the next line.
  • The system suppresses leading and trailing blanks in the message text of information messages unless formatting tags override the default text flow.
  • You can add dynamic variables using the <mv> element.

Go to the previous page Go to the next page




Copyright IBM Corporation 1990, 2014