Message ID Utility

The following topics are covered below:


Overview

The Entire Event Management Message ID Utility analyzes a data set or the console log according to various user criteria and displays the result in SYSOUT.

You can analyze:

  • an z/OS or BS2000/OSD data set

  • a PDS member in z/OS

  • console log from z/OS or z/VSE

Statistics for the most important IDs are displayed. You can select these IDs depending on your installation. These statistics provide you with a better overview of your daily work and you can formulate an Automation Rule for particularly important message IDs. For further information, see section Defining an Automation Rule.

Usage

You can only use this utility in batch mode. NCLnnn.SRCE provides JCL examples in E-UTMID and a Natural text member E-UTMIDT, which shows you how to use the function. Replace the symbols in brackets <> according to your installation.

You can analyze every data set from z/OS or BS2000/OSD or a PDS member from z/OS or an z/OS or z/VSE console log. The analysis depends on the user criteria. You can analyze a data set for several different message IDs as follows:

  • search for:

    • a Natural mask criterion

    • a special string

    • a combination of both

  • search:

    • a range of columns

    • all lines of the data set

    • a range of lines in the data set

After the selection a list is printed in SYSOUT, which displays the message IDs that satisfy the criteria, the number of times each analyzed message ID occurs, their percentage of the total, and a snapshot of the last whole message text where this ID was found.

JCL Description

This utility runs only in batch mode. JCL requires following parameters:

LOGON SYSNCLIE, UTMID--P

The following parameters specify the environment where the text member resides:

Parameter Description Format
DBID Database of the text member. N5
FNR File number of the text member. N5
LIBRARY Specifies the container for text member. A8
MEMBER Specifies the name of the text member. Contains the selection criteria. A8

Syntax of the Text Member

The parameters for the analysis must reside in a Natural text member which was specified in the JCL description (above).

The Entire Event Management keywords necessary for the analysis of the data set are described here. Each keyword must be immediately followed by an equal sign (=). Keywords must be separated by a delimiter sign ('' or ; or space).

Without the delimiter sign it is not possible to mark the end of one keyword. Every character following the equal sign up until the delimiter is assumed to belong to the keyword value. An equal sign should not appear in the value itself.

Not every keyword must be followed by a value or not all keywords must exist in this text member. The important keywords are NODE=, START-VALUE=, END-VALUE=, MASK= and must always be assigned a value. In BS2000/OSD, you must also assign a value to DSNAME=. In z/OS, if you do not assign a value to this keyword, CONSOLE-LOG is analyzed.

The order of the keywords is not important.

Description of the Keywords

The following keywords are possible:

Field Description Values Fmt
DSNAME Specifies the container with the analyzed messages. If this field is empty, and NODE specifies an z/OS operating system, the CONSOLE-LOG will be analyzed. <DSNAME> A54
END-VALUE Enter a positive number. This number specifies the column within the record where the analysis of the message IDs ends. <END-VALUE> N3
HIT-LIST-MSG Enter a positive number, to display first <HIT-LIST-MSG> messages analyzed, starting with the message which occurs most often (to limit the result). <HIT-LIST-MSG> N5
MASK

Enter a string which is the criterion for the analysis.

You can enter every character for the analysis and you can use the Natural Edit Mask criterion too, but the string must be enclosed twice by single quotation marks: ' ' string ' ', if it appears alone.

If the Natural Mask criterion appears in a string, the string must be enclosed in single quotation marks ' ' and the Mask criterion must also be enclosed in ' '.

If you use a string which consists of more than one word, enclose this string in ' '. The only restrictions are the length of 50 characters and you only can enter up to 10 masks.

During the analysis every word (within the record from START-VALUE to END-VALUE) which is separated by a space will be compared with the mask criterion. As soon as one mask is found, the next record will be analyzed (that means not every mask criterion will be used).

<MASK> A50
MEMBER Name for PDS member on z/OS. <MEMBER> N3
NODE Entire System Server Node. Location for storage. <NODE> N3
START-VALUE Enter a positive number. This number specifies the column within the record where the analysis of the message IDs starts. <START-VALUE> N3
TIME-FROM Enter a valid time from which to analyze the records for a special time range. This time must occur within a record of the data set and start in the column indicated by TIME-POSITION. HHIISS A8
TIME-TO Enter a valid time until which to analyze the records for a special time range. This time must occur within a record of the data set and start in the column indicated by TIME-POSITION. TIME-TO must be greater than TIME-FROM. HHIISS A8
TIME-POSITION Column where the time is located in the record. This field is necessary if TIME-TO and TIME-FROM are specified. Leave this field blank, if no time interval is specified. <TIME- POSITION> N3
USER Required for logon to the Entire System Server indicated by parameter NODE. <USER-ID> A8

Output Description

Output Header

  • Title displays the container with the records for analysis, this can be a data set name or a PDS member name or CONSOLE-LOG.

  • If a time was specified, it occurs in the next line, for example:

    FROM: 11:11:11 TO: 22:22:22
  • This line displays the sum of analyzed messages and the sum of all messages found.

  • If a number for the HIT-LIST-MSG was specified, it occurs in the next line. The following text appears:

    RESULT SHOWS THE FIRST nn MESSAGES

    where nn is the number of messages.

Table

  • The first column contains the message ID found, which was searched for by the MASK criterion.

  • The second column displays the percentages for this message only;

  • The third column displays the sum of the percentages from the top until this message;

  • The fourth column displays the real counter for this message;

  • The last column displays the last message text where this message ID was found. The message text as a substring starts at the column START-VALUE and has a maximum length of 40 characters.

Examples

  • The Natural text member contains:

    DSNAME=NCL.SYS MEMBER=
    NODE=148
    START-VALUE=56 END-VALUE=70
    MASK=ACF
    MASK=IE
    

    The result is, for example:

    ANALYSIS OF MESSAGE IDS IN:   NCL.SYS
    SUM OF ANALYZED MESSAGES:     37  SUM OF ALL MESSAGES FOUND:     25
    ---------------------------------------------------------------------------
    MSG ID     %   SUM %     VALUE    SAMPLE MESSAGE TEXT
    ---------------------------------------------------------------------------
    IEE301I    20.00  20.00      5    IEE301I ADA230MM CANCEL
    ACF9C009   16.00  36.00      4    ACF9C009 SAF ENVIRONMENT
    ACF9C004   16.00  52.00      4    ACF9C004 TTT SUBSYSTEM
    ACF9C005   16.00  68.00      4    ACF9C005 SAF CONTROL PT
    IEA989I    12.00  80.00      3    IEA989I SLIP TRAP ID=X22
    ACF9C006    8.00  88.00      2    ACF9C006 SAF CLASS
    ACF9C007    8.00  96.00      2    ACF9C007 SAF ENTITY
    IEF196I     4.00 100.00      1    IEF196I IEF237I JES2 ALL
    
  • The Natural text member contains:

    DSNAME=NCL.SYS
    NODE=148
    TIME-POSITION=26
    TIME-FROM=001250 TIME-TO=001252
    HIT-LIST-MSG=5
    START-VALUE=56 END-VALUE=70
    MASK=ACF
    MASK=IE
    

    The result is, for example:

    ANALYSIS OF MESSAGE IDS IN:   NCL.SYS
    FROM:  00:12:50   TO:  00:12:52
    SUM OF ANALYZED MESSAGES:     20  SUM OF ALL MESSAGES FOUND:     18
    RESULT SHOWS THE FIRST      5 MESSAGES
    ---------------------------------------------------------------------------
    MSG ID     %   SUM %     VALUE    SAMPLE MESSAGE TEXT
    ---------------------------------------------------------------------------
    ACF9C004   22.00  22.00      4    ACF9C004 TTT SUBSYSTEM
    ACF9C005   22.00  44.00      4    ACF9C005 SAF CONTROL PT
    ACF9C009   22.00  66.00      4    ACF9C009 SAF ENVIRONMENT
    ACF9C006   11.00  77.00      2    ACF9C006 SAF CLASS
    ACF9C007   11.00  88.00      2    ACF9C007 SAF ENTITY
    
  • The Natural text member contains:

    DSNAME=NCL.SYS
    NODE=148
    HIT-LIST-MSG=5
    START-VALUE=56 END-VALUE=80
    MASK=''AAANANNN' SAF CLASS'
    MASK=IE
    

    The result is, for example:

    ANALYSIS OF MESSAGE ID'S IN:  NCL.SYS
    SUM OF ANALYZED MESSAGES:     37  SUM OF ALL MESSAGES FOUND:     11
    RESULT SHOWS THE FIRST      5 MESSAGES
    ---------------------------------------------------------------------------
    MSG ID     %   SUM %   VALUE    SAMPLE MESSAGE TEXT
    ---------------------------------------------------------------------------
    IEE301I     45   45        5    IEE301I ADA230MM CANCEL
    IEA989I     27   72        3    IEA989I SLIP TRAP ID=X22
    ACF9C006    18   90        2    ACF9C006 SAF CLASS
    IEF196I      9   99        1    IEF196I IEF237I JES2 ALL