Previous Topic: OPS/REXX Host Environments in the )PROC Section of a USS Rule

Next Topic: Additional AOF Variables Available in a USS Process Event Rule

AOF Variables Available in a USS Rule

You can use all AOF variable types in USS rules. You can use the following unique AOF event variables in the )PROC section of a USS rule, and you can manually interrogate the corresponding OPSLOG display field as an aid in debugging or implementing rule logic.

USS.ATTRIBUTE

The CA Event Manager console display flag byte for the video display attributes of the message

Data Type: 1-byte binary (unprintable), read-only

Sample Value: '01'X

Note: ATTRIBUTE is a bit flag, and bits can be combined. '03'X means blinking reverse video.

USS.AUTOTOKN

The first 8 characters of the platform name on which the message originated. This value is extracted from the USS.TAG variable for inclusion in OPSLOG.

Data Type: Character, read/write

Sample Value: OS390

For USS process events, this variable contains an abbreviated name for the z/OS dynamic exit that created the event.

Possible values are:

OPSLOG Browse Column: AUTOTOKN

USS.CATEGORY

A character string assigned by the issuer of the message for message clarification

Data Type: Character, read-only

Sample Value: System error

USS.COLOR

The color that the message text will use in OPSLOG Browse. This message is initially set to the message color in the CA Event Manager console display.

Data Type: 1-byte binary (unprintable), read/write

Sample Value: '00' X

Note: Use the OPSCOLOR function of OPS/REXX to set the USS.COLOR variable.

OPSLOG Browse Column: COLOR

USS.DESC

The z/OS descriptor codes for the message. If the CA Event Manager highlights this message, descriptor code 2 is set.

Data Type: 2-byte binary (unprintable), read/write

Sample Value: '4000' X

Note: Use the OPSBITS function of OPS/REXX to set the USS.DESC variable. For a description of message descriptor codes, see the IBM documentation.

OPSLOG Browse Column: ROUTE or ROUTEX

USS.DEVICE

A character string that identifies a device associated with an SNMP trap message that was captured by the CATRAPD daemon and converted to a message in the CA Event Manager.

Data Type: Character, read-only

Sample Value: MVS25B (DASD volume)

USS.FACILITY

A character string assigned by the issuer of the message primarily for identifying the application or source of the message

Data Type: Character, read-only

Sample Value: SAPR3

For USS process events, this variable contains one of the following:

USS.FLAGS

The message type, taken from the CA OPS/MVS message flags described below

Data Type: 2-byte binary (unprintable), read-only

Sample Value: '8000' X

Message Flags: The CA OPS/MVS product sets the following flags with the following bits:

OPSLOG Browse Column: OPSFLAGS

USS.FULLTEXT

The complete text (up to 3000 characters) of the message taken from the CA Event Manager message block that was passed to the CA OPS/MVS USS message exit. For USS process events, the value is the complete text of the USSPROCBEG or USSPROCEND message.

Data Type: Character, read-only

Sample Value: USR98765 The names of everybody in the company: Joe, Jill, Sam, Sandra, John, Jane, and so on

USS.ID

The message identifier, usually the first token or the first blank delimited word of the message text

Data Type: Character, read-only

Sample Value: IEF125I

Note: The USS.ID variable value determines which message rules execute for the current message event. This variable never contains any special screen characters, leading, or trailing blanks.

OPSLOG Browse Column: MSGID

USS.JOBID

The identifier that JES2 or JES3 assigned to the CA Event Manager address space. If the address space was created using the MSTR subsystem, the value is the first five characters of the job name.

Data Type: Character, read-only

Sample Value: S12345

For USS process events, this variable contains the job ID of the address space running the process.

OPSLOG Browse Column: JOBID

USS.JOBNAME

The job name of the USS address space that is running the CA Event Manager. The value of this variable varies depending on how the Event Manger task is started.

Data Type: Character, read-only

Sample Value: BPXOINIT

For USS process events, this variable contains the job name of the address space running the process.

OPSLOG Browse Column: JOBNAME

USS.MSGFLAGS

The CA Event Manager message flag for special processing display options and handling:

Data Type: 1-byte binary (unprintable), read-only

Sample Value: '03'X

USS.MSGUSER

The security user ID responsible for issuing the message. On the mainframe, this value is the user ID from the particular security package in use. On Windows, the current logon ID is the usual value. A \ may separate the user ID from other security-related information.

Data Type: Character, read-only

Sample Value: IBMUSER

For USS process events, this variable contains the process user ID and alias in the format userid/alias.

USS.NODE

The TCP/IP host name that issued the message. For messages issued from the CCS for z/OS, this is the z/OS TCP/IP host name. For messages issued from a Windows platform, this value is the Domain\Node name.

Data Type: Character, read-only

Sample Value: SY23TCPN

USS.PROCESS

A character string composed of the process ID number and the program name of the message issuer. It is usually in the form processid,program. The UNIX command KILL requires the process ID to terminate a USS program.

Data Type: Character, read-only

Sample Value: 000356, OPSAEX

For USS process events, this variable contains the same value as the USS.PRCREATE variable (see the following section).

USS.REPLYID

The reply number associated with a CA NSM message generated by the CAWTOR command or API

Data Type: Character, read-only

Sample Value: 11

Notes:

OPSLOG Browse Column: First part of the text field when the message is a WTOR

USS.REPORTID

The first 8 characters of the facility or application name contained in the message. This value is extracted from the USS.FACILITY variable for inclusion in OPSLOG.

Data Type: Character, read-only

Sample Value: TAPEMGMT

For USS process events, this variable contains one of the following:

OPSLOG Browse Column: DSPNAME

USS.SEVERITY

A single character indicating the importance of the message. The issuer of the message assigns severity.

Possible Values:

Data Type: Character, read-only

Sample Value: I

USS.SYNA

The system name of the system issuing the message

Data Type: Character, read-only

Sample Value: MVS34

Note: The system name is derived from the SYSNAME parameter specified in the appropriate IEASYSxx member of the Logical Parmlib Concatenation.

OPSLOG Browse Column: SYSNAME or SYNA

USS.SYSID

The system ID of the system where the message was issued (usually the SMF ID). For JES3 messages, the SYSID value derives from the MPNAME field of the Active Main Processor Control Table. For JES2 messages, the SYSID value derives from the SMF ID string.

Data Type: Character, read-only

Sample Value: S000

Note: The OPSLOG Browse column displays two characters of this variable, not the complete field. The CA OPS/MVS BROWSEIDFORMAT parameter determines which characters are displayed. For a description of the BROWSEIDFORMAT parameter, see the Parameter Reference.

OPSLOG Browse Column: SYSID

USS.TAG

A character string that identifies the type of platform that originated the message

Data Type: Character, read-only

Sample Value: OS390

For USS process events, this variable contains an abbreviated name for the z/OS dynamic exit that created the event.

Possible Values:

USS.TERMNAME

The first 8 characters of the network host name on which the message originated. This value is extracted from the USS.NODE variable for inclusion in OPSLOG.

Data Type: Character, read-only

Sample Value: NODESY01

For USS process events, this variable contains a system terminal name, if applicable.

OPSLOG Browse Column: TERMNAME

USS.TEXT

The first 128 characters of the USS message, taken from the CA Event Manager message block passed to the CA OPS/MVS USS message exit. For USS process events, the value is the potentially truncated text of the USSPROCBEG or USSPROCEND message.

Data Type: Character, read/write

Sample Value: WIN 12345 CA NSM now active on node IPNODE1

OPSLOG Browse Column: Text is always displayed.

USS.TOKEN

The CA Event Manager token number is a numeric value that can be the reply ID for a WTOR, an internal record number in the message database, or an offset into the message database. Except for a WTOR, this field is usually 0.

Data Type: Integer, read-only

Sample Value: 3

OPSLOG Browse Column: TOKEN

USS.TYPE

A character string indicating the type of the message issued

Possible Values:

Data Type: Character, read-only

Sample Value: WTO

USS.USER

An 8-byte variable providing communication between rules that execute for the same USS message event. The variable can contain any installation data that these rules need, and it can store a character string displayable through OPSLOG Browse.

Data Type: User-defined, read/write

Notes:

OPSLOG Browse Column: USER

USS.USERDATA

Defines an arbitrary character string assigned by the issuer of the message to pass data related to the message for automation or diagnostic purposes.

Data Type: Character, read-only

Sample Value: TERMERR=100

USS.USERID

The user ID of the security product on your system. This value is always the CA ACF2 user ID from the ACFASVT or the RACF user ID from the current ACEE of the USS address space that is running the CA Event Manager.

Data Type: Character, read-only

Sample Value: SYSPG01

OPSLOG Browse Column: USERID

USS.WORKLOAD

The name of a workload to which the message is related. This message field is to be used by the Workload Management application of CA NSM.

Data Type: Character, read-only

Sample Value: UNIWKLD

For USS process events, this variable contains the same value as the USS.PRTERM variable (see the following section).

USS.WORKSTATION

The name of the workstation on which a workload is performed. This could be a computer or a physical location. This variable is to be used by the CA NSM Workload Management application.

Data Type: Character, read-only

Sample Value: TAPE BACKUP

USS.WTOID

The CA Event Manager message number assigned by the issuer of the message. This is usually a number that appears somewhere in the message ID field, such as 999 in message ID CASH_999_W. This field is usually 0.

Data Type: Integer, read-only

Sample Value: 1032

OPSLOG Browse Column: WTOID

More information:

AOF Rule Tools