System Variables › &AOMID

&AOMID

Returns an ID that has been assigned to the current message or event.

Enables AOM messages to be classified into groups for processing.

Example: .&AOMID

&CONTROL NOLABEL
 .
 .
 . 
&AOMREAD SET 
&GOTO .&AOMID   -* Use &AOMID as a branch destination
 .                               
 .                               
 .                               
.JESMSG         -* $HASP messages
 .                               
 .                               
 .                               
.ACFMSGS        -* ACF2 messages
 .                               
 .                               
 .                               

Notes:

The GLOBAL, MSGGROUP, and SET statements in the AOM screening table allow the specification of an ID, from 1 to 12 characters in length. If a message passes screening at a particular level then the ID specified at that level, or a default value, is assigned.

If no screening table is active, this variable has a value of NOTABLE. AOMPROC can contain logic to detect whether the screening table is not loaded by checking for ID=NOTABLE.

If a screening table is active but no ID has been specified on a GLOBAL or MSGGROUP statement, a message passing the relevant screening statements is assigned a default ID of AOMGLOBAL or AOMMSGGROUP respectively.

Events have a default ID of AOMEVENT. Messages and events sourced by the &AOMALERT NCL verb have a default ID of AOMALERT.

This ID attribute is also propagated to AOM receivers, and is inspected using the &ZMAOMID system variable.

Normally a group of messages are all assigned the same ID, for example, all $HASP messages might be assigned an ID of JESMSG. This means &AOMID is used in AOMPROC for processing a particular group of messages.

The EVENT statement in the screening table also allows an ID value to be assigned.

Note: For more information, see the ID operand on the GLOBAL, MSGGROUP, SET, and EVENT screening table statements.