BMC AMI Ops Automation-supplied EVENT variables

EVENT variables are variables that are used by the Rule Processor application and exist for the duration of the event.

EVENT variables consist of

• BMC AMI Ops Automation-supplied variables
• &WORDxxx variables, where xxx represents a number (for example, &WORD4)

  Many of these variables are also be available for use by BMC AMI OpsA EXECs.

  For more information about variables and BMC AMI OpsA EXECs, see Variables in REXX EXECs.

  When creating Rules for the ALRT event type, see Variables-for-ALRT-initiated-Rules for additional available variables.

  The following table shows all the EVENT variables supplied by BMC AMI OpsA.

   

  Variable name	Description
  &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 Management
  &IMFALID	Contains the Alarm ID associated with an Alarm created by Alarm Management
  &IMFALMID	Contains the Alarm Message ID created by Alarm Management The values can be 1 to 16 characters in length and is valid only for ALRM-initiated Rules Management Rules
  &IMFALNME	Contains the name of the Alarm Message created by Alarm Management The value can be 1 to 16 characters in length and is valid only for ALRM-initiated Rules Management Rules
  &IMFALPRI	Contains the user-assigned priority of the Alarm Possible values are 1 – CRITICAL 2 – MAJOR 3 – MINOR 4 – WARNING 5 – INFORMATIONAL 6 – CLEARING
  &IMFALQID	Contains the name of the queue to which the alarm was assigned
  &IMFALRM	Contains either Y (sound an alarm) or N (do not an sound alarm)
  &IMFALUVx	Contains the values specified for the fields User Values 1 through User Values 8 where x can be 1 through 8 The values can be 1 to 16 characters in length, and if not specified, the value is null.    This variable is valid only for ALRM-initiated Rules.
  &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.
  &IMFAUTH	Contains Y if the message was issued from an authorized program
  &IMFCART	Contains an 8-character Command and Response Token (CART) associated with an MVS command
  &IMFCARTX	Contains the &IMFCART variable in 16-character printable EBCDIC format
  &IMFCIJOB	Contains the values for the &IMFCIJOB variable for different event types are as follows: ALRM: contains the same value as the IMFTHTGT variable, which is the name of the address space that causes the Alarm to be generated ALRT: contains the name of the address space that issues the BMC AMI OpsA ALERT (which is also the address space where the Rule fires). CICS: contains the CICS address space name CMD: contains the address space that issues the MVS command DB2: contains the name of the address space issuing the WTOR EXT: contains the name of the address space where the Rule fires HWTO: contains the early or interim WTOs IMP: contains the IMS OM address space name IMS: contains the IMS address space name JRNL: contains the name of the BMC AMI OpsA PAS address space MQS: contains the 4-character Queue Manager name followed by MSTR  MSG: contains the name of the address space issuing the WTOR NVC: contains the NetView address space name NVM: contains the NetView address space name Time: contains the name of the BMC AMI OpsA PAS address space VAR: contains the name of the BMC AMI OpsA PAS address space
  &IMFCLOCK	Contains the number derived from the first word of the MVS Time-of-Day clock The increment value is approximately once every 1.05 seconds.Each Rule that fires has its own copy of the &IMFCLOCK variable, but the variable is not passed to Rule-initiated EXECs. You can use this variable to help construct names and values that are unique for the life of this IPL. For example, you can combine the IMFCLOCK and IMFRLID variables to create a unique variable to create a unique ALERT key. On the Alert Action(s) I panel in the Rule Processor, specify Key ===> &IMFRLID::&IMFCLOCK
  &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.
  &IMFCONNM	Contains the console name to which the WTO was issued &IMFCONNM may be used to identify the origin of an MVS command. The contents of the variable (by origin) are Origin: IMFCONNM Value Rule: Internal SDSF: TSO user ID that issued the command Console: Console Name where the command was issued
  &IMFCSMLU	Contains the LU name for SMCS consoles
  &IMFCSSOW	Contains the eight-character owner ID for subsystem consoles
  &IMFCSTYP	Contains the console subtype 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; one of the following possible values: M: Command or WTO was issued from or to an MCS console S: SMCS console E: EMCS console U: Subsystem 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 shows 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
  &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. For more information about EXT events, see EXT.
  &IMFDOMID	Contains the DOM ID associated with a WTO that caused a Rule to fire
  &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 ALRM ALRT BRC CICS CMD DB2 EOM EOS EXT HWTO IMP IMS JRNL MQS MSG NVC NVM TIME TLM VAR For more information about these event types, refer to Events.
  &IMFEVALP	Contains the evaluation policy for the Rule The contents of this variable are updated after each qualifying rule is evaluated. This includes all conventional Rules and all Rules that are part of a chained Rule group (CRG). You can use the IMFEVALP variable in a Rule like any other event variable and will be passed to EXECs like any other event variable. Valid values are: N/A: The Rule is not part of a CRG FIRST: The Rule is the first rule in a CRG. FIRED: The Rule has an Evaluation Policy of Fired. NOTFIRED: The Rule has an Evaluation Policy of NotFired.
  &IMFEVALR	Contains the evaluation result for the Rule The contents of this variable are updated after each qualifying rule is evaluated. This includes all conventional Rules and all Rules that are part of a chained Rule group (CRG). You can use the IMFEVALP variable in a Rule like any other event variable and will be passed to EXECs like any other event variable. Valid values are: N/A: The Rule is not part of a CRG FIRST: The Rule is the first rule in a CRG. FIRED: The last Rule that was evaluated by the Rules engine fired. NOTFIRED: The last Rule that was evaluated by the Rules engine did not fire.
  &IMFEVFRD	Contains the number of Rules that have fired for a specific event
  &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).
  &IMFEXITP	Contains the exit policy for the Rule The contents of this variable are updated after each qualifying rule is evaluated. This includes all conventional Rules and all Rules that are part of a chained Rule group (CRG). You can use the IMFEVALP variable in a Rule like any other event variable and will be passed to EXECs like any other event variable. Valid values are: N/A: The Rule is not part of a CRG CONTINUE: The exit policy for this Rule is Continue. FIRED: The exit policy for this Rule is set to Fired. NOTFIRED: The exit policy for this Rule is set to NotFired.
  &IMFGROUP	Contains the IBM RACF group ID for the address space that issued the event The group ID is taken from the GROUP= parameter on the job card, or the default IBM RACF group ID for a TSO user ID.    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	Contains a two-character value describing the type of IMS event Valid value for this variable is RE; RE means that the event is a command response to an IMS command issued from an EXEC with response. This value can be used to prevent automatic logging of the IMS command response to the Journal by the IMS Generic (or similar) Rule. Specifying IMFIMTYP NE RE on the Variable Dependencies panel of an IMS event type Rule causes the Rule not to fire for responses to IMS command that are returned to and processed by an EXEC. Eliminating unnecessary logging to the Journal will reduce the possibility of out-of-storage problems and loss of automation during periods when BMC AMI OpsA is processing very large number of IMS response segments.
  &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.
  &IMFJBCOR	Contains the 32-to 64-character job correlator token
  &IMFJCAN	Indicates if the job is canceled: Y means the job is canceled, N means the job is not canceled The variable is valid only for the EOJ event.
  &IMFJCLAS	Contains the job class 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 AAOPRMxx. IMFJNUM can also contain blanks (one or five characters as appropriate) for WTOs that are issued by non-JES tasks, such as a STC started under MSTR. The default setting is IMFJNUM=V. When IMFJNUM=V (the default setting) and the job number is greater than 99,999 (for example, T0100000, S0999999, etc.) 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 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.
  (BMC.AMIOPS.SPE2207) &IMFJSMCC	Contains the maximum condition code  Values can be: S0xxx (system abend) Unnnn (user abend) FLUSH (steps were flushed) nnnn (numeric condition code).  System abends are considered the highest values, followed by user abends, and normal return codes.  The value FLUSH is returned only when all steps, up to and including the current step, are not executed.  The variable will not be defined when end of job (EOJ or IMFJSNUM = 0) processing occurs.
  &IMFJSNUM	Contains sequential number of this job step Value is zero (0) for EOJ.
  &IMFJSPGM	Contains 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.
  &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 issuing message: J – Batch Job T – TSO User S – Started Task
  &IMFLFIRE	Contains the number of seconds (0 – 9999999) since this Rule last fired 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 This variable is not valid for the HWTO, NVC, NVM, and TIME event types.
  &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 of the AUTO parameter in SYS1.PARMLIB member MPFLSTxx The value could be YES, NO, or an 8-character token set by the user in SYS1.PARMLIB See Implementing-support-for-MPF in the Customizing-BMC-AMI-Ops-Automation-after-installation for more information about MPF.
  &IMFMPFSP	Contains the value of the SUP parameter in SYS1.PARMLIB member MPFLSTxx The value could be either YES or NO. See Implementing-support-for-MPF in the Customizing-BMC-AMI-Ops-Automation-after-installation for more information about MPF.
  &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 For example, for the following message: +DFHSI1500 TYSPCICS CICS startup is in progress The value of the &IMFMSGID variable is DFHSI1500 Valid only for the MSG and DB2 event types.
  &IMFMSTYP	Contains the two-character variable for the message type This variable is only for the CMD and MSG event types. Valid values for the first character can be N: a regular WTO W: a regular WTOR M: a major line of a multiline WTO (MLWTO) Valid values for the second character can be C: command R: command response
  &IMFNOL	Contains the number of LINE variables in the LOCAL pool Output from multiline messages is placed in LOCAL variables, LINE1 through LINEnnnn.
  &IMFNUSER	Contains the NetView user ID assigned to this event
  &IMFOASID	Contains the originating Address Space ID (ASID) of the message For IMFEOM, it is set to the ASID that is being terminated.
  &IMFODATE	Contains the date when the message was issued in Juilan date format
  &IMFOJOB	For WTOs: contains the job or Started Task that issued the WTO For CICS messages: CICS region name that the subsystem issued the message for, which is useful when monitoring multiple CICS regions with one BBI-SS PAS. For DB2 messages: DB2 region name that the subsystem issued the message for, which is useful when monitoring multiple DB2 regions with one BBI-SS PAS. For IMS messages: IMS job name for IMS MTO messages IMS job name for commands (and their responses) entered from BMC AMI OpsA Originating LTERM for commands (and their responses) entered from an IMS LTERM For Journal messages issued by an EXEC: user ID of the person who scheduled the EXEC
  &IMFOMCLT	Contains the name of the client (IMSplex member) where IMS Type-2 command originated Valid only for IMP events.
  &IMFOMRTE	Contains up to 30 characters of the ROUTE list of the IMS Type-2 command Valid only for IMP events. The ROUTE list is a list of client names separated by commas. The ROUTE list can contain a single asterisk as a client name, which routes to all clients.
  &IMFOMUSR	Contains user ID of application where the IMS Type-2 command originated Valid only for IMP events.
  &IMFOQID	Contains the CICS transient data queue name if source of message is CICSTD
  &IMFORGN	Contains the possible event types and their descriptions are: ALRM: name of issuer ALRT: BMC AMI OpsA job name issuing the ALERT BRC: PAS subsystem ID CICS: CICS address space job name CMD: job name of issuer DB2: DB2 address space job name EXT: job name of issuer HWTO: job name of issuer IMP: contains the IMS OM address space name IMS CMD: IMS LTERM name IMS MSG: IMS region name JRNL: job name on whose behalf the Journal message was issued MSG: job name of issuer NVC: job name of issuer NVM: job name of issuer TIME: BMC AMI OpsA job name
  &IMFORGSS	Contains the BBI Subsystem ID of the BBI-SS PAS
  &IMFOTIME	Contains the time when the message was issued Valid only for messages captured through the Rule Processor. The format is HH.MM.SS for MSG event types. For all other event types, the format is HH:MM:SS
  &IMFPCMD	Contains the PCMD associated with the alarm
  &IMFPLUS	Contains Y if the message ID text begins with a plus sign (+)
  &IMFREPLY	Contains the Reply ID of the WTOR message
  &IMFRETAIN	Contains Y if the message is marked as retain (and it is not automatically scrolled off the MVS Console) and is retained in the Automatic Message Retention Facility (AMRF)
  &IMFRLFRD	Contains the number of times a Rule was fired
  &IMFRLID	Contains the Rule identifier
  &IMFRLMAT	Contains the number of times the Rules search criteria was matched
  &IMFRLSET	Contains the name of the Rule Set the Rule belongs to
  &IMFRLSTA	Contains the Rule status: TEST: indicates the Rule is in a TEST state. ACTIVE: indicates the Rule is in ACTIVE state.
  &IMFRUSER	Contains the user ID 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
  &IMFSRC	Contains the name of the NetView exit that produced the event
  &IMFSTEP	Contains the step name that triggered the Rule
  &IMFSTOKN	Contains the Address Space STOKEN name This name is unique for the life of the IPL.
  &IMFSUPR	Contains Y if the message text is suppressed from the console
  &IMFSYSID	Contains the possible event types and their descriptions are: ALRM: name of issuer ALRT: BMC AMI OpsA job name issuing the ALERT BRC: jobname of PAS CICS: CICS address space job name CMD: job name of issuer DB2: DB2 address space job name EXT: job name of issuer HWTO: job name of issuer IMP: contains the IMS OM address space name IMS: when a Rule matches an IMC command issued from LTERM, IMS LTERM name IMS: when a Rule matches an IMC message, IMS region name JRNL: job name on whose behalf the Journal message was issued MSG: job name of issuer NVC: job name of issuer NVM: job name of issuer TIME: BMC AMI OpsA job 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 full text of the event that triggered the Rule.  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	Resolves to the address space name that causes the Alarm to be generated
  &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 multiline WTO Minor/Major Lines.
  &IMFTSNUM	Contains the sequential step number Warning Note The IMFSTEP variable is also populated.
  &IMFTSSID	Contains the subsystem ID (SSID) that selected the 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 limit expired
  &IMFTWTSC	Contains the number of seconds this address has already been extended by a Rule for WAIT 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
  &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 allows the testing of specific bits in the descriptor code, by using the FN and FO operators on the Selection Criteria panel or the BITON() function on the Advanced Variable Dependency panel, to determine eligibility of the Rule to fire. For example, if you want to Rule to fire when descriptor code 12 is used you could specify the following value on the Variables Dependency panel: IMFXDESC_______________________ FO 0010___________________________ Or, you could specify the following value on the Advanced Variables Dependency panel: BITON(&IMFXDESC,0010) Either method causes the Rule to fire.
  &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. &IMFXOJOB is valid only for MSG and JRNL type Rules. When a JRNL event originates from a Total Object Manager (TOM) log message, the &IMFXOJOB variable contains the TOMID of the TOM PAS that originated the message. To determine if a JRNL event originated from a local TOM PAS, use the Variable Dependencies (SV) panel in the Rules Processor to compare the IMFOJOB variable to IMFXOJOB (IMFOJOB EQ IMFXOJOB). If the values are equal, the message originated from the local TOM PAS.
  &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 allows the testing of specific bits in the route code, by using the FN and FO operators on the Selection Criteria panel or the BITON() function on the Advanced Variable Dependency panel, to determine eligibility of the Rule to fire. For example, if you want to Rule to fire when route codes 2 and 11 are used you could specify the following value on the Variables Dependency panel: IMFXROUT___________________ FO 40200000000000000000000000000000___ Or, you could specify the following value on the Advanced Variables Dependency panel: BITON(&IMFXROUT,4020) Either method causes the Rule to fire.
  &SYSDATE	Contains the current date in the form month/day/year
  &SYSTIME	Contains the current time of day expressed as hh:mm:ss
  &WORDxxx	Represents a number (for example, &WORD4) These are variables created by the Rule Processor to represent the different words in the text of the event that fire a Rule. The variable &WORD3 should resolve to the third word of the text of the event. Word variables are delimited by blanks and commas in the text. The message text used to return &WORD variables is a maximum length of 512 for CICS TD messages and 255 for all others.

  This section contains the following topics: