TSO variables and USS variables supplied by BMC AMI Ops Automation

IMFACCTG

Contains all accounting fields for a particular event

The accounting field values are separated by blanks. Maximum length is 142.

IMFALGID

Contains a 16-character alphanumeric Alarm Group ID created by Alarm Manager

IMFALID

Alarm ID associated with an alarm created by Alarm Manager

IMFALPRI

User-assigned priority of the alarm

Possible values are

• CRITICAL
• MAJOR
• MINOR
• WARNING
• INFORMATIONAL
• CLEARING

IMFALQID

Name of the queue to which the alarm was assigned

IMFALRM

Contains either Y (sound an alarm) or N (do not sound an alarm)

IMFALUVx

Contains a 16-character alarm User Value x created by Alarm Manager

IMFAREID

Contains a 1-character identifier for the area on the console panel that displays a multiline WTO message

Possible values are the letters A through K, Z.

This variable is valid only for the MSG-initiated and DB2-initiated Rules.

IMFCART

Contains a 1 to 8 character Command and Response Token (CART) associated with an MVS command

IMFCARTX

Contains a 16 byte hexadecimal version of the Command and Response Token (CART) associated with an MVS command

IMFCC

Contains the condition code set for each IMFEXEC statement:

IMFCC = 00 normal completion

IMFCC = 04 warning condition, not necessarily an error

IMFCC = 08 exception condition or command not found

IMFCC = 12 error condition. Did not complete operation

IMFCC = 16 error condition

IMFCC = 20 severe error condition

Refer to the specific IMFEXEC statement for the exact codes.

All EXEC types

IMFCNAME

Contains the name of the console that issued the command

All EXEC types

IMFCNTXT

Contains the name of the context of the alarm

IMFCOLOR

Contains the value of the message color as it was modified by the (Message Processing Facility (MPF) or a subsystem in the subsystem interface (SSI); valid values are as follows: RED, BLUE, PINK, GREEN, TURQUOISE, YELLOW, WHITE

If the message color is not modified, the value is blank.

IMFCSMLU

Contains the LU name for SMCS consoles

IMFCSSOW

Contains the eight character owner ID for subsystem consoles

IMFCSTYP

Contains the console sub type

If the Console Type resolves to Special (IMFCTYPE=P), IMFCSTYP resolves to one of the following values:

• INTERNAL
• INSTREAM
• UNKNOWN
• JES3

IMFCTYPE

Contains the type of console:

M: Command or WTO was issued from or to an MCS console

• S: SMCS console
• E: EMCS console
• U: Susbystem console
• P: Special (see definition for the IMFCSTYP variable)

IMFDATE

Contains the date when the message was issued in the format that is specified on the IMFDATE parameter in BBPARM member AAOPRM00

The following list describes valid formats and an example of each:

• YYYY/MM/DD; 2050/10/23
• YYYYMMDD; 20501023
• DD/MM/YYYY; 23/10/2050
• DDMMYYYY; 23102050
• MMDDYYYY; 10232050
• MM/DD/YYYY; 10/23/2050
• MMMDDYYYY; OCT232050
• DDMMMYYYY; 23OCT2050

IMFDAY

Contains the three-character day of the week: MON, TUE, WED, THU, FRI, SAT, SUN

All EXEC types

IMFDDNAM

Contains the DDNAME specified by the user to generate an external events (EXT event type)

EXT events are generated by using the SUBSYS= parameter on a DD statement in JCL. See the section EXT in the Using-Rules-with-BMC-AMI-Ops-Automation for more information about EXT events.

IMFDOMID

Contains the DOM ID associated with a WTO that initiated an EXEC

IMFEID

Contains the EXEC identification number, 1 to 99999, assigned to each execution by the EXEC manager

The EXEC Management application will not assign the same number to two EXECs in the running or deferred queues, except an EXEC selected with WAIT=(YES) has the same IMFEID as the calling EXEC.

When the EXEC identification number reaches 99999, the assigned number starts over at 1.

All EXEC types

IMFENAME

Contains the name of EXEC

All EXEC types

IMFEROUT

Contains the list of routing codes that were assigned to the WTO that triggered the EXEC, such as 1 2 5 9

This variable is defined only for EXECs initiated as a result of a WTO. IMFEROUT supports routing codes up to 128.

IMFETYPE

Contains the event type that caused the Rule to fire

If a Rule schedules an EXEC, IMFETYPE contains the value from the Rule that scheduled the EXEC. Possible values for IMFETYPE are as follows:

• MSG
• CICS
• CMD
• EOM
• EOS
• JRNL
• IMS
• ALRT
• DB2
• TIME
• ALRM
• EXT
• VAR
• MQS
• NVC
• NVM
• TLM
• BRC
• HWTO

For more information about these event types, see Events.

IMFEXEID

When the IMFJRNLT variable is EXEC, contains the EXEC identifier where the message originated

IMFEXENM

When the IMFJRNLT variable is EXEC, contains the EXEC name where the message originated 

The EXEC identified is the EXEC that scheduled the start of the EXEC thread (outermost EXEC).

IMFEXRC

Contains the exit code set by the IMFEXEC EXIT command when an EXEC is scheduled using AOEXEC SELECT EXEC with WAIT(YES)

The exit code must be a numeric value, up to four characters in length, and can range from 0 to 9999.

All EXEC types

IMFEVFRD

Contains the number of Rules that have fired for a specific event

IMFGROUP

Contains the IBM RACF group ID for the address space that issued the message

The group ID is taken from the GROUP= parameter on the job card.

For commands issued from the console address space, the value for IMFGROUP is derived from the RACF RUTOKEN.

IMFHILIT

Contains the value of the message highlight level as it was modified by MPF or a subsystem in the SSI; valid values are as follows: NONE, BLINKING, REVERSE, UNDERLINE

If the message highlight level is not modified, the value is blank. A value NONE means the message was issued with no highlighting.

IMFIMTYP

IMFINTEN

Contains the value of the message brightness as it was modified by MPF or a subsystem in SSI; valid values are as follows: HIGH or NORMAL

If the message brightness is not modified, the value is blank.

IMFJCAN

Indicates whether the job is canceled: Y means the job is canceled, N means canceled

The variable is valid only for the EOJ event.

IMFJCLAS

Contains the job class name from the job card of the batch job that has generated the message

IMFJNUM

Contains the JES job number of the job, STC, or TSU that issued the message

It is a fixed length five-digit or a variable length value depending on the setting of the IMFJNUM option in member AAOPRM xx. IMFJNUM can also contain blanks (one or five characters as appropriate) for WTOs that are issued by non-JES tasks, such as an STC started under MSTR.

When IMFJNUM=V (the default setting) and the job number is greater than 99,999 (for example, T0100000, S0999999, and so on) are encountered, IMFJNUM will be null (zero length).

IMFJRNLT

Contains the type of JRNL event

The value returned is EXEC when the message originates from an EXEC. 

IMFJSACT

Contains the accounting information from the EXEC JCL statement

IMFJSCC

Contains the condition code

Values can be S0xxx (system abend), Unnnn (user abend), FLUSH (steps were flushed), nnnn (numeric condition code).

IMFJSCPU

Contains the CPU time used by this job step, in hundredths of seconds

Value is zero (0) for EOJ.

IMFJSPGM

Contains the EXEC PGM= program name for this job step

This variable contains the fixed value N/A for end-of-job (EOJ) and end-of-memory or address space termination (EOM) events.

IMFJSNUM

Contains the sequential number of this job step

Value is zero (0) for EOJ.

IMFJSTEP

Contains the job step name

Value is blank for EOJ.

IMFJTCPU

Contains the total amount of CPU time used by this job, in hundredths of seconds

IMFJTYPE

Contains the type of job that issues the message:

• J: Batch Job
• T: TSO User
• S: Started Task

IMFLFIRE

Contains the number of seconds (0 – 9999999) since this Rule last fired

Zero (0) seconds means the Rule last fired less than 1 second ago.  

The maximum value of 9,999,999 seconds (about 115 days) is set when any of these conditions exist 

• The Rule has never fired 
• The Rule has just been Enabled 
• The last fired time exceeds the maximum value

IMFLPROD

Contains the name of the product associated with the alarm

IMFLTYPE

Contains the literal value associated with the alarm

Possible values can be START or STOP.

IMFLUSER

Contains the user-specified user ID associated with the alarm

IMFMPFAU

Contains the value the AUTO parameter in SYS1.PARMLIB member MPFLSTxx

Use this variable to determine the value of the MPF AUTO keyword for a message.

IMFMPFSP

Contains the value of the SUP parameter in SYS1.PARMLIB member MPFLSTxx

Use this variable to determine the value of the MPF SUP keyword for a message.

IMFMSGID

Contains the first word of the message (up to 16 characters) with any leading plus sign (+) that might be present stripped out of the word

This variable is available for MVS and DB2 event types only.

IMFMSTYP

Contains a two-character variable for the message type

This variable is only for the CMD and MSG event types. Valid values for the first character are

• N: A regular WTO
• W: A regular WTOR
• M: A major line of a multi-line WTO (MLWTO)

Valid values for the second character are

• C: Command
• R: Command response

IMFNUSER

Is associated with the NVC and NVM events types and contains the NetView user ID assigned to this event

IMFOASID

Contains the originating Address Space ID (ASID) of the message

For IMFEOM, the value is set to the ASID that is being terminated. For ORIGIN=JRNL, it is set to the subsystem ASID name.

IMFODATE

Contains the date when the message or alarm was issued

Valid only for messages captured through the Rule Processor.

The date format is in Julian calendar format; for example: 20100, where

• 20--are the last two digits of the year 2020.
• 100--is the 100th day of the year. In a non-leap-year, this value is equal to March 10.

IMFODESC

Contains the list of descriptor codes assigned to the WTO that triggered the EXEC, such as 2 11

This variable is defined only for EXECs initiated as a result of a WTO.

IMFOEXEC

Identifies the originating EXEC if the EXEC was scheduled by another EXEC using the IMFEXEC SELECT EXEC

This variable is not set if the EXEC is scheduled by some other means.

IMFEXEC SELECT EXEC initiated

IMFOJOB

IMFOQID

Contains the CICS transient data queue name if source of message is event type CICS.

IMFORGN

Contains the origin of EXEC-Job name/USERID causing EXEC to be scheduled

See Determining-the-origin-of-a-command-or-EXEC for a discussion about using IMFORGN to determine the origin of an EXEC across BBI-SS PASs.

IMFORGSS

Contains the BBI subsystem ID of the BBI-SS PAS that originated an EXEC

If originated locally, IMFORGSS is the same as QIMFID.

See Determining-the-origin-of-a-command-or-EXEC for a discussion about using IMFORGN to determine the origin of an EXEC across BBI-SS PASs.

IMFOROUT

Contains the list of routing codes that were assigned to the WTO that triggered the EXEC, such as 1 2 5 9

This variable is defined only for EXECs initiated as a result of a WTO. IMFOROUT supports routing codes up to 16.

IMFOTIME

Contains the time when the message was issued

Valid only for messages (also known as events) captured through the Rule Processor.

The valid form of the variable is hh:mm:ss for all Rule event types except for the MSG event types. For MSG events, the valid form of the variable is hh.mm.ss.

For the ALRM events, the time represents the time the exception occurred.

IMFOUTS

Contains the the Origin Unix Timestamp

This number is the number of seconds since January 1, 1970. For example, the value 1133978880 is calculates to the date and time that is 2005-12-07 18:08:00 UTC.

IMFPCMD

Contains the PCMD associated with the alarm

IMFPOST

Contains the 1 to 255-character code received from an EXEC that issues the IMFEXEC POST command against an ECB with the same name that the current EXEC is waiting on

All EXECs types

IMFPRIO

Contains the dispatching priority of the currently running EXEC after the IMFEXEC CHAP command has been issued

All EXEC types

IMFRC

EXEC-initiated EXECs

IMFREPLY

Contains the reply ID of the WTOR message

Valid only for messages captured through the Rule Processor

IMFRLFRD

Contains the number of times a Rule was fired

IMFRLID

Contains the Rule identifier that scheduled an EXEC

IMFRLMAT

Contains the number of times the Rules search criteria was matched

IMFRLSET

Contains the name of the Rule Set to which the Rule belongs

IMFRLSTA

Contains the Rule status:

• TEST: Indicates that the status of the Rule that scheduled the EXEC is in a TEST state.
• ACTIVE: Indicates that the status of the Rule that scheduled the EXEC is in ACTIVE state.

IMFRUSER

Contains the RACF user ID for the address space that issued the message

The user ID is taken from the USER= parameter on the job card.

For commands issued from the console address space, the value for IMFRUSER is derived from the RACF RUTOKEN.

IMFSCENV

Contains a 1 to 16-character Workload Manager schedule environment name for the batch job that produced the event 

The scheduling environment name contains alphanumeric characters, national characters ($, @, #) and underscore (_).

This variable is available only for the MSG event type.

IMFSCOPE

Contains the name of the scope associated with the alarm

IMFSTEP

Contains the step name that triggered the Rule

IMFSTOKN

Contains the address space STOKEN

This name is unique for the life of the IPL.

Rule-initiated EXECs or end-of-memory initiated EXECs

IMFSYSID

Contains the originating job name

For CICS messages, IMFSYSID contains the BBI Started Task name.

IMFTCPCT

Contains the number of times this address space has already been extended by a Rule for CPU expired

IMFTCPSC

Contains the number of CPU seconds this address has already been extended by a Rule

IMFTERMT

Contains the type of address space termination; valid values are NORMAL or ABNORMAL

IMFTEXT

Contains the character text that caused the EXEC to be scheduled

For CICS TD events, the maximum length for IMFTEXT can be up to 512 characters. For all other message types, IMFTEXT is 125 characters.

IMFTHTGT

IMFTIME

Contains the time when the message was issued in HH:MM:SS format

IMFTOKEN

Contains the token ID of the message (same as hardcopy ID)

Used to attach MLWTO Minor/Major Lines. Valid only for messages captured through the Rule Processor.

IMFTSNUM

IMFTSSID

Contains the subsystem ID (SSID) that selected job

Possible values are as follows: JES2, JES3, ASCH (APPC), OMVS, STC, or TSO. The value can also be the jobname if none of these apply the jobname is less than 4 characters long.

IMFTTLM

Contains the type of expired time limit; valid values are as follows:

• JCPU: job processor time limit expired
• SCPU: step processor time limit expired
• WAIT: Continuous Wait Time expired

IMFTWTCT

Contains the number of times this address space has already been extended by a Rule for Wait Time limit expired

IMFTWTSC

Contains the number of seconds this address has already been extended by a Rule for Wait Time limit expired

IMFVALUE

Contains the value of a SHARED variable when an event type VAR Rule fires

IMFVIEW

Contains the name of the view associated with the alarm

IMFWTDOM

Contains the DOM ID associated with a WTO issued by IMFEXEC WTO command

All EXEC types

IMFWTCON

Contains the value created when a reply is received successfully

The eight-character name of the console from which the reply to the WTOR was entered.

One of the possible uses for the IMFWTCON variable is that it enables you to direct reply WTOs specifically to the console where the user entered the reply to this WTOR.

IMFXDESC

Contains a two-character value that consists of the exact hexadecimal contents of the descriptor code field of the WQE (WQEDESCD) for a WTO

This variable is more useful in a Rule than an EXEC.

For example, if the WTO that caused the invoking rule contained descriptor codes 7 and 10, the value of this variable is:

To display the contents of the variable in an EXEC you could use the c2x() function. For example:

IMFXJOB

Contains the name of the job or STC name of the task that invoked the AOAnywhere service

This variable is available for use from REXX EXECs and contains valid information only when the REXX EXEC is scheduled from an AOSUBX batch job. In all other cases, this variable contains a null or blank value.

AOSUBX batch jobs

IMFXOJOB

Contains the name of the original job or Started Task that requested the WTO to be issued by another address space

The contents of IMFXOJOB are only meaningful if the WTO is issued by another address space, otherwise its contents are identical to IMFOJOB.

IMFXROUT

Contains a 16-character value that consists of the exact hexadecimal contents of the routing code field of the WQE (WQEERC) for a WTO

This variable is more useful in a Rule than an EXEC.

For example, if the WTO that caused the invoking rule contained route codes 13, 15 and 28, the value of this variable is:

To display the contents of the variable in an EXEC, you could use the c2x() function. For example: