Event message format


The parameters that you use in the SMEVNT xx member formulate most of the event message text.

The message number is always the first element in an event message. If the event header is included in the text (see the EVNT_HDR= keyword), three additional fields are inserted prior to the event message text. The text that you create starts after the fourth element. If the event header is not included in the event, the user event text starts after the first element.

The following example shows an event that includes the event header:

 SVWeventIDseverityCode {functionName | SYSTEM} jobName systemID text

For more information, see the following information:

Event message variables

The following list describes attributes of the event message variables:

  • The value SVW is the prefix used for user and system events.
  • The eventID variable is a 5-character identifier that is used to generate the event.

    Events that are distributed as part of the automation solutions begin with APxxx, AAxxx, AVxxx, AHxxx, ADxxx, AOxxx, and AExxx. You are not restricted from using these event IDs, but it is not recommended by BMC Software.

    The value I is reserved for system events and must not be used in the first position of a user-defined eventID. With the exception of the letter I, you can use any 5 characters or numbers, in any position of the event ID for a user-defined event. You may want to create a naming convention for events that you define.

  • The variable severityCode represents a 1-character user-specified SEV parameter value for a user event. If the event, the code is either supplied by the system or a user-specified value.

    Warning

    Example

    For a user event with an event ID of AP001, the message number is generated as SVWAP001.

    For an internal system event with an event ID of I1001, the message number is generated as SVWI1001.

  • The variable functionName represents the 8-byte name of the function that generated the event (if the event is a user event). If the event is a system event, the value SYSTEM is displayed.
  • The variable jobName represents the 8-byte name of the SVOS Started Task.
  • The variable systemID represents the 8-byte identifier of the z/OS system that was running when the event was generated.

    Warning

    Important

    The functionName, jobName, and systemID values are part of the event message header and can be turned off by using the EVNT_HDR=NO keyword in the event definition.

  • The variable text represents the 218-byte message text that is defined by the user on a TEXT parameter (if the event is a user event). If the event is a system event, the message is either supplied by the system or is a user-specified message.

    Warning

    Important

    If DEST=TSO is used, the maximum text length is greatly reduced. The following section explains this issue in more detail.

Examples of the event message format

The following examples show the usage of the event message format:

Example 1

The parameters in this example are for the AUTOPOOL function, the parameters display information from the AUTOPOOL record.

SET EVENTID=AP092
    SEV=W
    MODE=ACT
    DEST=(SYSLOG)
    TEXT='&AUTOLEV &AP_GROUP %&AP_PERFL FULL CONTAINS &AP_VOLC VOLUMES'

The resulting event message for this example is as follows:

SVWAP092W AUTOPOOL MVSRM SJSG AUTOLEV1 WRK001 95% FULL CONTAINS 23 VOLUMES

Example 2

The parameters in this example are the same as Example 1, but this example is coded with EVNT_HDR=NO, which eliminates the function name, job name, and system ID from the message header.

SET EVENTID=AP092
    SEV=W
    MODE=ACT

EVNT_HDR=NO
    TEXT='&AUTOLEV &AP_GROUP %&AP_PERFL FULL CONTAINS &AP_VOLC VOLUMES'

The resulting event message for this example is as follows:

SVWAP092W AUTOLEV1 WRK001 95% FULL CONTAINS 23 VOLUMES

Example 3

The following example of a SET statement shows how system event definition parameters can be overridden:

SET  EVENTID=I1001
     OVERRIDE=Y
     MODE=ACT



 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC AMI Storage Automation 8.2