Input variables for HZSLFMSG_REQUEST='CHECKMSG'

HZSLFMSG_REQUEST='CHECKMSG' indicates that the message text is provided in the message table identified by the MSGTBL parameter when the check was added to IBM® Health Checker for z/OS®.

The following REXX variables are required input when HZSLFMSG_REQUEST='CHECKMSG' is specified:
Table 1. HZSLFMSG_REQUEST='CHECKMSG' input variables
Variable name Description

HZSLFMSG_
MESSAGENUMBER

The message number for the message being issued. This is the value specified in "XREFTEXT=MessageNumber" within the <msgnum> tag of the message source used to create the message table identified by the MSGTBL parameter when the check was added. Must be in the range between 1 and 999999999.
HZSLFMSG_INSERT REXX stem variable identifying the character variable message inserts.
HZSLFMSG_INSERT.0 The number of inserts or variables provided. This value must match the number of inserts defined in the message and must be in the range between 0 and 20.
HZSLFMSG_INSERT.x The message insert text. The text provided in the insert should be compatible with the class attribute of the associated message variable in the message table. A class attribute of hex, decimal or timestamp in the message table will treat the insert data as a hexadecimal string.
In the following example, variable HZSLFMSG_INSERT.1 expects to receive hexadecimal data:
  • Variable 1 in the message table has a class attribute of hex: <mv class="hex">variable 1</mv>
  • The REXX check might use the following HZSLFMSG input variables:
    HZSLFMSG_INSERT.1 = '01234567'X    /* A hex character string  */
    HZSLFMSG_INSERT.1 = x2c(020B140E)  /* Text that is converted to hexadecimal */
Note that decimal text also converts hex values to decimal text. For example, lets say that variable in the message table has a class attribute of:
<mv class=“decimal">variable 1</mv>
The REXX check use the following HZSLFMSG input variable:
HZSLFMSG_INSERT.1 = '0A'X   ->  10    /*  The decimal value 10 is displayed  */
In general, the REXX values you use will be text and usually do not require additional translation.
HZSLFMSG_SEVERITY HZSLFMSG_SEVERITY={SYSTEM | LOW | MED | HI | NONE} specifies the severity for the check, for checks that are set up to specify check severity dynamically.
HZSLFMSG_SEVERITY is only allowed for:
  • Checks added with parameter ALLOWDYNSEV(YES) to allow the check to specify check severity dynamically
  • Check exception messages (not for information or report messages)
Note that the check is responsible to clear (with a DROP statement) or reset this variable between calls to HZSLFMSG, to avoid having a consecutive HZSLFMSG call pick up the severity specified previously.
  • SYSTEM, which is the default, indicates that check exceptions be issued with the severity defined for the check when the check was added or updated.
  • LOW indicates that this check exception message is sent as a low severity message
  • MED indicates that this check exception message is sent as a medium severity message.
  • HI indicates that the check exception message is sent as a high severity message.
  • NONE indicates that the check has no severity.

The severity specified on HZSLFMSG_SEVERITY overrides the default severity defined for the check when it was added.

The check writer can use specific criteria and check parameters to specify when to use the different severities. See Writing a check with dynamic severity levels. See also HZSPRMxx parameters SEVERITY and WTOTYPE in Syntax and parameters for HZSPRMxx and MODIFY hzsproc .