|
|
|
The &AOMALERT verb generates an event, message, WTO, or DOM occurrence, as if it had been produced by either the local operating system interface, or received across an AOM ISR link. The verb can also be used to send an occurrence directly across an ISR link or to a specific AOMPROC.
Any NCL procedure can use &AOMALERT. It is not restricted to an AOMPROC, or any particular environment. This allows processes outside of AOM to provide input to AOM.
By default, &AOMALERT generates an EVENT, with a ROUTE option of PROCONLY. Thus, the primary AOMPROC sees the event, and can process it.
A comprehensive set of operands allows specification of the exact occurrence to generate, and the attributes of that occurrence.
This verb has the following format:
&AOMALERT [ TYPE={ EVENT | WTO | MSG | DOM } ]
[ SOS={ OS | VM } ]
[ STATUS={ YES | NO } ]
[ DOMAIN=domain | LINK=link | NCLID=nclid ]
[ ROUTE={ PROCONLY | route } [ LCLROUTE=route ] [ RMTROUTE=route ] ]
[ ALARM={ YES | NO } ]
[ ASID=asid ]
[ CLASS=class ]
[ COLOR={ NO | BLUE | RED | PINK | GREEN | TURQUOISE | YELLOW | WHITE } ]
[ DESC={ NONE | ALL | list } ]
[ DOM-TRACK={ YES | NO } ]
[ DOMID={ * | mvsdomid ]
[ HLITE={ NO | USCORE | REVERSE | BLINK } ]
[ ID={ AOMALERT | identifier } ]
[ INTENS={ NORMAL | HIGH } ]
[ JOBNAME=jobname ]
[ JOBID=jobid ]
[ JSTCB=jstcb ]
[ LDOMAIN=domain ]
[ MONITOR={ YES | NO } ]
[ MSGCLASS={ 30 | msgclass } ]
[ MSGCODE={ 00 | nn } ]
[ MSGID=msgid ]
[ MSGLEVEL={ IN | msglevel } ]
[ NRD={ NO | OPER | YES } ]
[ ODOMAIN=domain ]
[ ROUTCDE = { 2 | NONE | ALL | list }]
[ RMTCLASS={ NONE | ALL | list } ]
[ SCAN={ YES | NO } ]
[ SOURCE={ PROP | GCS } ]
[ TIME=hhmmss ]
[ TRACE=* ]
[ UFLAGS=nn | UFLAGn={ YES | NO } ]
[ USERID=userid ]
[ USERNODE=node ]
[ DATA=msg, wto or event data ]
Operands:
Specifies the type of occurrence to generate.
Generates an AOM event message. An event message allows notification to an AOMPROC of an event, but the message is never delivered to authorized AOM receivers.
Generates a simulated WTO message. In this case, several operands allow specification of job name, JES job ID, message attributes, as well as address space and DOMID information.
Generates a simulated VM message. In this case, several operands allow specification of VM user ID and node, message attributes and VM message class.
Generates a simulated MVS DOM. A DOMID must be specified, and it is used to cause deletion of NRD messages.
Note: TYPE=DOM does not send the generated DOM to MVS. Use the &DOM NCL verb for this.
Indicates the sourcing operating system. By default, this is the operating system that this product region is running on.
Indicates that the WTO, EVENT, or DOM is to be marked as originating from an OS type system (including z/OS, MSP, and VOS3). In this case, operands that imply or are relevant to TYPE=MSG (which implies SOS=VM) are not permitted.
Indicates that the MSG or EVENT is to be marked as originating from a VM type system. In this case, operands that imply or are relevant to TYPE=WTO or TYPE=DOM are not permitted.
For TYPE=EVENT, messages are marked as coming from either OS or VM. Source information, such as job name, user ID, and so on, must be consistent with the indicated or defaulted operating system. For example, if SOS=VM is specified, JOBNAME and JOBID cannot be specified.
Indicates whether this is a status only message. This parameter is ignored for TYPE=DOM.
Status only messages are never delivered to Local AOM receivers (regardless of the ROUTE options), and have an implied RMTCLASS=8 if the RMTCLASS parameter is not specified.
Makes the message equivalent to the internally generated status messages for such things as AOM START, AOM STOP, SYSTEM IN SHUTDOWN that are queued to AOMPROC. This setting is useful if some other procedure in the system, such as LOGPROC needs to send status information to AOMPROC.
Specifies that the message is to be delivered normally.
Allows the alert to be sent to a specific destination, either a specific AOMPROC, or a specific ISR link identified either by LINK name (as defined on this system), or DOMAIN ID (as defined on the remote system). None of these operands is used with TYPE=DOM. Only one of these three operands is specified.
Queues the message to the ISR link where the remote system has the indicated domain ID. This operand makes the sending end independent of the link name used locally to identify the remote system. If the message cannot be queued, a non-zero &ZFDBK value indicates the reason.
Queues the message to the ISR link with the specified local LINK name. This operand makes the sending end dependent on the link name. This is advantageous when different remote systems could be (at different times) connected with the same link name. If the message cannot be queued, a non-zero &ZFDBK value indicates the reason.
Queues the message to the nominated AOMPROC in this system. If the specified NCL ID is not found, is equal to the NCL ID of the issuing NCL process, or is not a current primary or secondary AOMPROC, the &ZFDBK system variable is set to 8 and the message not queued.
This option allows individual AOMPROCs to hold conversations with each other, independent of the incoming message flow.
These options allow AOMPROCs in separate, ISR-connected systems to communicate with each other independently of the unsolicited message flow.
Specifies the AOM routing option for the current WTO, 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:
Does not deliver the message. If set from the screening table, the message is not passed to Automation Services.
Delivers the message to the activity log only.
Note: If your product region has SYSPARMS AOMLOG=NO set, the message is never logged.
Delivers the message to authorized AOM receivers and to the activity log.
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.
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.
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.
If NCLID= is specified, the message is always queued to the specified NCL procedure (if there), regardless of the ROUTE value specified. For example, if ROUTE=NO is coded, the NCL procedure still gets the message. The same applies for LINK= and DOMAIN=, although the message is discarded at the remote end depending on the ISR command LCLROUTE and RMTROUTE options in effect.
Allows specification of the ALARM attribute for a WTO or MSG. If not specified, the default, ALARM=NO, is assumed.
Allows specification of an address space ID. This operand is only permitted for TYPE=WTO or TYPE=EVENT with SOS=MVS. asid must contain exactly four hexadecimal digits. This corresponds to the values provided by the &AOMASID system variable. By specifying an address space ID that ties in to MVS, any address-space DOM correctly correlates to this message, if it is also marked as NRD=YES, DOM-TRACK=YES, or an AOMPROC uses DOM-NOTIFY=YES.
If this operand is specified, the JSTCB operand must also be specified.
Allows specification of an event class. This operand is only permitted for TYPE=EVENT (which is the default if TYPE= is not specified).
The class value must be from 0 to 12 characters in length.
Allows specification of a color attribute for TYPE=WTO or TYPE=MSG. The operand can also be spelt COLOUR.
Allows specification of a descriptor code list, for TYPE=WTO or TYPE=MSG. The list is a single descriptor number, or a list of numbers or ranges:
Note: For a list of valid descriptor codes, see the Administration Guide.
Lets you indicate that, for TYPE=WTO, or TYPE=EVENT with SOS=MVS, any subsequent DOM that matches this message follows it across any ISR links automatically, even if the message or event is not marked NRD=YES.
DT is an acceptable abbreviation for this operand.
Allows specification of an MVS DOMID for TYPE=WTO, or TYPE=EVENT with SOS=MVS, or TYPE=DOM (in which case it is required).
Generates a DOMID internally. This DOMID will not match any valid DOMID that MVS generates. This format is not valid for TYPE=DOM.
Allows specification of your own DOMID. mvsdomid must be eight hexadecimal digits. The first two correspond to a system ID, the last six are the DOMID.
Regardless of the specification of DOMID, after &AOMALERT the system variable &ZDOMID contains the DOMID that was used, in the MVS (eight hexadecimal digits) format. Thus, if &AOMALERT generated a DOMID, you can save it for a future &AOMALERT TYPE=DOM.
Default: *
Allows specification of a highlight attribute for TYPE=WTO or TYPE=MSG. The operand can also be spelt HLITE.
Allows specification of an optional 1- to 12-character identifier. This value is made available to AOMPROC in &AOMID, and to an MSGPROC in &ZMAOMID.
Specifies whether the intensity attribute is TYPE=WTO or TYPE=MSG.
Allows specification of the job name that is to be regarded as the source of a TYPE=WTO or TYPE=EVENT with SOS=MVS alert. This operand cannot be specified if TYPE=MSG or SOS=VM is specified.
jobname is either null or one through eight characters in length.
This value corresponds to, and is derived from, the &AOMJOBNM and &ZMAOMJN system variables.
Allows specification of the JES job ID that is to be regarded as the source of a TYPE=WTO or TYPE=EVENT with SOS=MVS alert. This operand cannot be specified if TYPE=MSG or SOS=VM is specified.
jobid is either null or in the format typnnnnn where:
typ is JOB, STC, or TSU (abbreviated to J, S, or T), and nnnnn is a one- to five-digit number.
This value corresponds to, and is derived from, the &AOMJOBID and &ZMAOMJI system variables.
Allows specification of a job-step TCB address. This operand is only permitted for TYPE=WTO or TYPE=EVENT with SOS=MVS. jstcb must be exactly eight hexadecimal digits. This corresponds to the values provided by the &AOMJSTCB system variable. By specifying a job-step TCB address that ties in to MVS, any JSTCB-specific DOMs correctly correlate to this message, if it is also marked as NRD=YES, DOM-TRACK=YES, or an AOMPROC uses DOM-NOTIFY=YES.
If this operand is specified, the ASID operand must also be specified.
Allows specification of a specific last-handler domain value. If omitted, the current domain ID is used (that is, the value in &ZNMDID).
The value must be 1 through 4 characters, the first alphabetic or national, the remainder alphanumeric or national.
This operand corresponds to, and is initialized from, the &AOMLDID system variable.
This operand allows specification of the MONITOR attribute for TYPE=WTO or TYPE=MSG. If YES, the message is eligible for delivery to MONITOR class message receivers, and AOM class receivers.
Specifies of a specific VM msgclass, for TYPE=MSG. This corresponds to the IUCV *MSG message class. Classes 1 through 8 are IUCV message types; class 30 is a programmable operator facility message type. Valid values are:
Message sent using CP MESSAGE and CP MSGNOH
Message sent using CP WARNING
Asynchronous CP messages, CP responses to a CP command executed by the programmable operator facility virtual machine, and any other console I/O initiated by CP
Message sent using CP SMSG command
Any data directed to the virtual console by the virtual machine (WRTERM, LINEDIT, and others)
Error messages from CP (EMSG)
Information messages from CP (IMSG)
Single Console Image Facility (SCIF) message from CP 30 Message coming from Automation Services
Allows specification of an MSGCODE value for TYPE=WTO or TYPE=MSG. This value is used to restrict the delivery of the message to receivers with at least one common MSGCODE in their user ID definition.
nn must be two hexadecimal digits. If omitted, 00 is assumed.
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.
Allows specification of a message severity level, corresponding to the &AOMMSGLV system variable, and the user profile AOMMSGLV values.
Only one message level is assigned. The default, IN, means informational.
Allows specification of the non-roll delete attribute for a message or event.
Means the message is not to be regarded as NRD.
Causes the message to remain on OCS screens, but the system retains no copy. When an operator deletes the message from the screen, it is not recallable.
Causes the message to remain on OCS screens, until the appropriate DOM is sent (it could be produced by &AOMALERT TYPE=DOM, or an MVS DOM). The system remembers the message, and it is recalled to OCS screens with the NRDRET command.
Allows specification of an originator domain value. If this operand is omitted, the current domain ID is used (that is, the value in &ZNMDID).
The value must be 1 through 4 characters, the first alphabetic or national, the remainder alphanumeric or national.
This operand corresponds to, and is initialized from, the &AOMODID system variable.
Allows specification of a list of routing codes for the generated WTO or MSG. Either a single value or list of values is specified as follows:
ROUTCDE=5
ROUTCDE=(1,5,16-29,112)
Allows specification of a list of remote ISR delivery classes, for automatic ISR delivery of WTO, MSG, or EVENT alerts. Remote classes are numbered from 1 to 8.
RMTCLASS=NONE means no remote classes. RMTCLASS=ALL is equivalent to RMTCLASS=1–8.
Either a single value, or a list of values and ranges is specified:
RMTCLASS=5
RMTCLASS=(3,5-7)
If this parameter is omitted, RMTCLASS=ALL is assumed if STATUS=NO is specified, else RMTCLASS=8 is assumed if STATUS=YES is specified or defaulted.
Allows specification of the scan-for-highlight (@) characters for message display. If SCAN=YES is specified, when the message text is displayed on an OCS screen, text between @ characters is displayed in high intensity.
Indicates the source of the message for TYPE=MSG or TYPE=EVENT with SOS=VM.
Indicates the message is to be regarded as originating from the PROP virtual machine IUCV interface.
Indicates the message is to be regarded as originating from the GCS IUCV interface.
Specifies the message issue time. If omitted, the current time is used. This parameter must be in the format hhmmss.
Specifies that the current message is to be traced on the local system. Trace messages are written to the activity log.
Assigns a value to the 8 user flags, either by using a hexadecimal value to assign all 8, or individually using UFLAG1, UFLAG2, and so on.
In an AOMPROC, the system variables &AOMUFLGn contains the set values.
In MSGPROC, the system variables &ZMAOMUFM and &ZMAOMUFn contain the user flags in various formats. Variables are also set after an &INTREAD if receiving unsolicited messages.
Specifies the VM user ID that is to be regarded as the source of a TYPE=MSG or TYPE=EVENT with SOS=VM alert. This operand cannot be specified if TYPE=WTO or SOS=MVS is specified. userid is null, else it must be from 1 to 8 characters in length.
This value corresponds to, and is derived from, the &AOMUSERI and &ZMAOMUI system variables.
Specifies the VM RSCS node that is to be regarded as the source of a TYPE=MSG or TYPE=EVENT with SOS=VM alert. This operand cannot be specified if TYPE=WTO or SOS=MVS is specified. node is null; otherwise, it must be from 1 to 8 characters in length.
This value corresponds to, and is derived from, the &AOMUSERN and &ZMAOMUN system variables.
The optional message text to be associated with the WTO, MSG, or EVENT.
For TYPE=WTO, ensure that the first character of the text is the MVS flag character (which is blank).
Examples: &AOMALERT
&AOMALERT DATA=MSG001 SYSTEM UP
&AOMALERT TYPE=EVENT STATUS=NO LINK=NEWYORK DATA=LA IS ONLINE
&AOMALERT TYPE=WTO STATUS=NO ROUTE=MSG DATA=*IEF233D COUNTERFEIT MSG
Notes:
If NCLID, DOMAIN, or LINK were specified, &ZFDBK is set as follows:
Message queued successfully.
Destination domain same as ODOMAIN or LDOMAIN value.
Link/domain not found or NCL ID not found, not an AOMPROC, or same as issuing process.
Link/domain not enabled outbound.
ISR storage shortage. Message not sent.
Queue overflow on ISR link.28 Internal ISR error.
In all other cases, &ZNCLID is set to 0.
The &ZDOMID system variable is always cleared to null by &AOMALERT, and, if TYPE=WTO or TYPE=ALERT with OS=MVS message is generated, the supplied or internally assigned MVS DOMID is placed in &ZDOMID in the MVS format (eight hexadecimal digits).
When an AOMPROC reads a message produced by &AOMALERT, the &AOMSALRT system variable is always set to YES. Thus, AOMPROCs can always distinguish &AOMALERT-sourced messages.
| Copyright © 2009 CA. All rights reserved. |
|