&AOMCONT

The &AOMCONT verb is used in an AOMPROC procedure to request the processing of a message in one of the following ways. The message could be a WTO or WTOR, VM MSG, MVS DOM notify, or AOM EVENT that was previously delivered for processing by an &AOMREAD.

Passed to your product region for normal delivery, including possible automatic ISR delivery. The message is no longer available to the issuing AOMPROC.
Passed to your product region for local delivery only. No automatic ISR delivery is performed. The message is no longer available to the issuing AOMPROC.
Passed to your product region for possible automatic ISR delivery only. The message is not delivered to local AOM receivers. The message is no longer available to the issuing AOMPROC.
Copied to a specified ISR link, or to all active ISR links. The message remains available to the issuing AOMPROC.
Passed to another AOMPROC for further processing. The message is no longer available to the issuing AOMPROC.

An AOM message passed to your product region for normal 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 processing attributes of the message, set by the screening table when the message was selected for routing to AOMPROC, is changed by specifying the appropriate &AOMCONT operand. When this is done with the LINK= or DOMAIN= operands, only the copy of the message that is sent to the ISR link has its attributes altered.

When processing a multiline WTO message, only the current line of the message is altered. However, if this is the first line, and the next &AOMREAD specifies MINOR=NO, all lines will have the same attribute alterations applied.

Any operand specified overrides the current value of that message attribute. Attribute modification operands are ignored if the current message is an MVS DOM-notify message.

The LINK, DOMAIN, and NCLID options are only valid when processing the first line of a multiline WTO. The entire message (or a copy of it) is sent.

This verb has the following format:

&AOMCONT [ ALL | LOCAL | REMOTE | NCLID=nclid | LINK={ * | link } | DOMAIN={ * | domain } ]
         [ ALARM={ YES | NO } ]
         [ COLOR={ NONE | BLUE | RED | PINK | GREEN | TURQUOISE | YELLOW | WHITE } ]
         [ DOM-NOTIFY={ NO | YES } ]
         [ DOM-TRACK={ 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 } ]
         [ RMTCLASS={ ALL | NONE | LIST } ]
         [ ROUTCDE={ NONE | ALL | list } ]
         [ ROUTE=route | [  LCLROUTE=route ] [ RMTROUTE=route ] ]
         [ UFLAGn={ YES | NO } ]

Operands:

ALL

Indicates that the current message is to be (possibly) altered as requested, and released for both local and automatic remote ISR delivery. Following this statement, this AOMPROC no longer owns the message, and until another &AOMREAD is executed, the message-related system variables are null.

For a multiline message, only the current line is processed, and the next line is made available by issuing &AOMREAD MINOR=YES. If this was the last line, or if the next &AOMREAD has MINOR=NO specified, then the entire message is released.

LOCAL

Indicates that the current message is to be (possibly) altered as requested, and released for local delivery only. 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.

This option is invalid when processing minor lines of a multiline message. If specified for the major line, the entire message is released.

REMOTE

Indicates that the current message is to be (possibly) altered as requested, and released for automatic ISR remote delivery only. No local 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.

This option is invalid when processing minor lines of a multiline message. If specified for the major line, the entire message is released.

NCLID=nclid

Indicates that the current message is to be passed to the specified secondary AOMPROC. The nclid must correspond to a secondary AOMPROC (that is, a procedure, executing in the AOMP environment, that has issued &AOMINIT).

If the message is successfully queued to the secondary AOMPROC, this AOMPROC no longer owns the message, and until another &AOMREAD is executed, the message-related system variables are null. The &ZFDBK system variable is set to 0. If the specified NCL ID cannot be found, or is not a secondary AOMPROC, or is the same as the NCL ID of the issuing AOMPROC, the &ZFDBK system variable is set to 8. The message remains owned by this AOMPROC.

Note: If NCLID= is specified, you cannot specify other operands. This means that the message attributes cannot be altered in this case.

This option is not valid for a minor line of a multiline message. If specified for the major (first) line, the entire message is enqueued.

LINK={ * | link } | DOMAIN={ * | domain }

Enqueues a copy of the message to the indicated ISR link, specified by LINK=link, or DOMAIN=domain; or enqueues a copy of the message to all presently active and enabled (for AOM unsolicited outbound from this system) ISR links, specified by LINK=* or DOMAIN=* (no route code, message level, or RMT class filtering is done in this case).

In either case, the message remains under the control of the current AOMPROC.

When LINK=link or DOMAIN=domain is specified, the &ZFDBK system variable is set as follows:

0: Message enqueued to specified ISR link.
1: Multiline message enqueued successfully to ISR link, but some minor lines were lost due to overflows, and so on.
4: Not enqueued, either the destination domain matched the message originator or last-handler domain, or the message has already been sent to that link.
8: Not enqueued, link or domain name not found.
12: Not enqueued, cannot send AOM unsolicited outbound to this ISR link.
16: Not enqueued, storage shortage.
20: Not enqueued, outbound queue overflow.
24: Specific delete done for specified link or all links.
28: Not enqueued, ISR internal error.

When LINK=* or DOMAIN=* is specified, The &ZFDBK system variable is set as follows:

0: Message enqueued to all eligible (and at least one) ISR links.
4: Message enqueued to some eligible links, but not delivered to some because of some error such as already sent or came from that link, and so on.
8: Not enqueued to any link. There were none, or all eligible links already received a copy, or an &AOMDEL LINK/DOMAIN=* was previously issued for this message (possibly by a previous AOMPROC that passed this message to this AOMPROC).

If attribute alteration options are specified, only the copy enqueued to the remote systems has its attributes altered. The current message is not changed.

These options are not valid for minor lines of a multiline message. If used for the major (first) line, a copy of the entire message is sent.

Note: After a message has been enqueued to any ISR link, it is no longer eligible for any automatic ISR delivery. Also, it cannot be enqueued twice to any link.

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.

This operand is only valid when ALL, LOCAL, or REMOTE is specified (or ALL defaulted).

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

This operand is abbreviated to DN.

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

DOM-TRACK={ NO | YES }

Alters the current value of the DOM-TRACK option for an MVS-sourced WTO, WTOR, or EVENT.

DOM-TRACK=YES causes the first following MVS DOM that matches this message to follow it across the relevant ISR links.

This operand is abbreviated to DT.

Note: Many messages never have a matching DOM generated, because they were never intended to be non-roll delete. Careless use of DOM-TRACK=YES can cause excessive storage wastage in the sending system, as it notes the sending of the message across the links.

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 to 12 characters.

INTENS={ LOW | HIGH }

Modifies the intensity attribute for the current message or event.

MONITOR={ YES | NO }

Alter 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.

NRD={ NO | OPER | YES }

Alters the NRD (non-roll delete) attribute of the current message.

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

RMTCLASS={ ALL | NONE | list }

Alters the ISR automatic delivery routing classes of the current message or event. This operand can affect the links that receive this message, if ISR automatic delivery occurs later.

ROUTCDE= {NONE | ALL | list }

Modifies the routing codes currently assigned to the current message.

ROUTE=route | [LCLROUTE=route ] | [RMTROUTE=route ]

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

Specifying a single value for ROUTE sets both the local and remote route options to the same value. Specifying values for LCLROUTE and RMTROUTE allows individual setting of the local and remote AOM route options. 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 the primary AOMPROC, if it is active. If not, 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 the primary AOMPROC, if it is active. If not, 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. Following this, it is also queued to the primary AOMPROC, if it is active. Regardless of the action taken by any AOMPROC that handles the message, it is never redelivered locally—it is treated as if ROUTE=NO was specified, and this cannot be overridden by the ROUTE operand on any other verb.

UFLAGn={ YES | NO }

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

Examples: &AOMCONT

&AOMCONT COLOR=PINK MONITOR=YES

&AOMCONT LINK=NY

&AOMCONT LINK=LA

&AOMCONT LOCAL COLOR=RED

&AOMCONT NCLID=&SUBID1

Notes:

If &AOMCONT 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 has the region-assigned DOMID that is used to delete the message later from OCS consoles.
&AOMCONT REMOTE and &AOMCONT LOCAL complement &AOMDEL LOCAL and &AOMDEL REMOTE. See &AOMDEL for more information.
The &AOMCONT verb always sets the system variable &AFDBK. If LINK=, DOMAIN=, or NCLID= was not specified, it is always set to 0.

More information:

&AOMREAD

&AOMREPL

&AOMDEL