Verbs and Built-in Functions › &AOMREPL

&AOMREPL

&AOMREPL requests that a message, which was previously delivered for processing by an &AOMREAD, have the message text replaced and then delivered locally. The message could be a WTO, a WTOR, or a VM message. The verb is used within an AOMPROC procedure. No automatic ISR delivery is performed.

An AOM message for delivery is sent to all OCS and ROF users with the following authorities:

• AOM message receipt authority
• Authorized to receive messages with the relevant routing codes and message levels

The screening table sets the processing attributes of the message when the message was selected for routing to AOMPROC. These attributes are changed by specifying the appropriate &AOMREPL operand.

When processing a multiline WTO message, only the current line of the message is altered. If this line is the first line, and the next &AOMREAD specifies MINOR=NO, all lines have the same attribute alterations applied. The text of these lines, however, is not altered. The text of individual lines is altered by issuing &AOMREAD MINOR=YES to obtain each line in turn, and then issuing &AOMREPL for each line.

Any operand specified overrides the current value of that message attribute. This statement is treated as &AOMDEL for an MVS DOM-notify message.

This verb has the following format:

&AOMREPL [ LOCAL ]
         [ ALARM={ YES | NO } ]
         [ COLOR={ NONE | BLUE | RED | PINK | GREEN |TURQUOISE | YELLOW | WHITE } ]
         [ DOM-NOTIFY={ NO | YES } ]
         [ HLIGHT={ NONE | USCORE | BLINK | REVERSE } ]
         [ ID=identifier ]
         [ INTENS={ LOW | HIGH } ]
         [ MONITOR={ YES | NO } ]
         [ MSGCODE=nn ]
         [ MSGID=msgid ]
         [ MSGLEVEL=msglevel ]
         [ NRD={ NO | OPER | YES } ]
         [ ROUTCDE={ NONE | ALL | list } ]
         [ ROUTE=route | LCLROUTE=route ]
         [ SCAN={ YES | NO } ]
         [ UFLAGn={ YES | NO } ]
           DATA=replacement message text

Operands:

LOCAL

Specifies that the current message is to be (possibly) altered as requested and released for local delivery only. This process occurs regardless of the specification of LOCAL or not. This operand is provided for compatibility with &AOMCONT LOCAL. No automatic ISR delivery is performed.

Following this statement, this AOMPROC no longer owns the message, and until another &AOMREAD is executed, the message-related system variables are null.

ALARM={ YES | NO }

Modifies the alarm attribute of the current message or event.

COLOR={ NONE | BLUE | RED | PINK | GREEN | TURQUOISE | YELLOW |
WHITE }

Modifies the color attribute for the current message or event. This operand can also be spelt COLOUR.

DOM-NOTIFY={ NO | YES }

DOM-NOTIFY=YES indicates that this AOMPROC wants a DOM-notify message queued to it when an appropriate MVS DOM is received.

If the current message is not a WTO, WTOR, or MVS-sourced EVENT, no DOM-notify ever occurs, as only MVS issues DOMs.

This operand is abbreviated to DN.

Note: Many messages never have a matching DOM generated, as they were never intended to be NRD. Careless use of DOM-NOTIFY=YES can waste excessive storage in the system as it notes all messages that are to be DOM-NOTIFIED.

HLIGHT={ NONE | USCORE | BLINK | REVERSE }

Modifies the highlight attribute for the current message or event. This operand can also be spelt HLITE.

ID=identifier

Modifies the value of the AOM ID attribute, as seen in the &AOMID and &ZMAOMID system variables.

The value is null, or from 1 through 12 characters.

INTENS={ LOW | HIGH }

Modifies the intensity attribute for the current message or event.

MONITOR={ YES | NO }

Alters the MONITOR attribute of the current message or event. The monitor attribute determines whether MONITOR class OCS receivers also receive the message, even if they are not AOM receivers.

MSGCODE=nn

Modifies the MSGCODE mask for the current message or event.

MSGID=msgid

Allows specification of a specific message id for type=WTO, MSG, or EVENT. If omitted, no message ID value is set.

msgid is null, or 1 through 12 characters.

The value set by this parameter is available to an AOMPROC in the &AOMMSGID system variable, and to an MSGPROC in the &ZMAOMMID system variable.

MSGLEVEL=msglevel

Modifies the message level of the current message.

For a list of valid message levels, see the Administration Guide.

NRD={ NO | OPER | YES }

Alters the NRD attribute of the current message.

Note: If the message has the NRD=YES attribute, then, following execution of &AOMCONT ALL, LOCAL, or REMOTE, &ZDOMID contains the region-assigned DOMID. The &NRDDEL verb uses DOMID to delete the message from OCS screens.

ROUTCDE={ NONE | ALL | list }

Modifies the routing codes currently assigned to the current message.

ROUTE=route | LCLROUTE=route

Modifies the AOM routing option for the current message or event.

Because the message is only delivered locally, ROUTE= or LCLROUTE= have the same effect. Valid values are:

NO

Does not deliver the message. If set from the screening table, the message is not passed to Automation Services.

LOG

Delivers the message to the activity log only.

Note: If your product region has SYSPARMS AOMLOG=NO set, the message is never logged.

MSG

Delivers the message to authorized AOM receivers and to the activity log.

PROC

Queues the message to an active primary AOMPROC. If the primary AOMPROC is not active, the message is delivered as if ROUTE=MSG was specified. Following AOM processing, ROUTE=PROC is treated as ROUTE=MSG.

PROCONLY

Queues the message to an active primary AOMPROC. If the primary AOMPROC is not active, the message is delivered as if ROUTE=NO was specified. Following AOM processing, ROUTE=PROCONLY is treated as ROUTE=NO.

BOTH

Treats the message as if ROUTE=MSG was specified—it is immediately queued to all eligible AOM receivers and logged. The message is also queued to an active primary AOMPROC. Regardless of the action taken by any AOMPROC that handles the message, it is never redelivered locally. The message is treated as if ROUTE=NO was specified, which cannot be overridden by the ROUTE operand on any other verb.

SCAN={ YES | NO }

Indicates whether the replacement text has highlight characters (@) to highlight parts of the text selectively.

UFLAGn={ YES | NO }

Modifies one of the eight user flags that is initially set in the AOM screening table.

DATA=replacement message text

Specifies the replacement text for the message. Any text is specified, up to 256 characters. If the current message is part of a multiline WTO, only the current message text is replaced.

If this operand is omitted, &AOMREPL acts like &AOMDEL. The message is deleted.

Examples: &AOMREPL

&AOMREPL COLOR=PINK MONITOR=YES DATA=&NEWMSG

&AOMREPL DATA=*&AOMMSGID MESSAGE SUPPRESSED BY AOMPROC

Notes:

• IF &AOMREPL is issued when no AOM message is current, the procedure is terminated abnormally.
• If the message had the NRD=YES attribute assigned or overridden, the system variable &ZDOMID have the region-assigned DOMID. The DOMID is used to delete the message from OCS consoles later.

More information:

&AOMCONT

&AOMDEL

&AOMREAD