&EVENT

The &EVENT verb signals an event occurrence.

This verb has the following format:

&EVENT [ NAME=event name ]
       [ TYPE={ APPLICATION | SERVICEABILITY | UTILIZATION | CONFIGURATION |
                ACCESS | PROCEDURAL } ]
       [ SCOPE={ SYSTEM | REGION } ]
       [ OBJECT=object ]
       [ RESOURCE=resource ]
       [ REFERENCE=event reference code ]
       [ ROUTCDE=route code ]
       [ DATA=data | MDO=stem | VARS=... | ARGS [ RANGE=(start,end) ] ]

To signal listeners who are profiled for the declared event. The &EVENT statement causes message N00102 to be queued to the response queue of any processes that have an active event profile which matches the attributes of the &EVENT statement operands. The event listener should retrieve the N00102 message with an &INTREAD statement.

Operands:

NAME=event name

Specifies a mandatory 1- to 32-byte event identifier used to provide information about the event source. Names is composed of any valid NCL variable name characters and full stop (.) or underscore (_) characters. Names beginning with a dollar sign ($) are reserved for internal use.

TYPE=event type

Event type is a high-level event category which provides an efficient event profile filter. Valid event types are as follows:

APPLICATION: User-defined (this is the default).
SERVICEABILITY: Faults, errors, availability, degradation, recovery.
UTILIZATION: Statistics, raw performance, and accounting data, RTM.
CONFIGURATION: Object definition, relationship notifies.
ACCESS: Security alarms.
PROCEDURAL: Scheduling, process control.

SCOPE={ SYSTEM | REGION }

The default event scope of SYSTEM means that an event is delivered to all listeners in the Management Services domain. Scope of REGION is used to limit event notification to processes within the user's region.

OBJECT=object

A 1- to 32-byte object classification of the event resource. For example, LU, PU, or SESSION are SNA object categories.

RESOURCE=resource

A single resource instance, or a resource instance pair separated by commas. A resource pair is specified when a relationship exists between event resources (for example, a session pair). Each resource name is 1 to 64 bytes long.

REFERENCE=event reference code

Specifies a 1- to 32-byte event code such as message number or error code.

ROUTCDE=route code

Specifies a list of numbers from 1 to 128 which represent the event route code. Each number is represented by a bit. To qualify for event notification, receivers must have at least one corresponding route code set in the event profile.

DATA=data | MDO=stem | VARS=... | ARGS [ RANGE=(start,end) ]

Specifies optional data or mapped object to be passed to event receivers of the N00102 message. If DATA=data is specified , the data is part of the N00102 text. If MDO=stem is specified, the mapped object is available in the $INT MDO received by the &INTREAD verb (or directly in the MDO specified on the &INTREAD MDO=mdo operand).

Specifying VARS=... or ARGS results in a $NCL MDO being built and delivered in the $MSG MDO, containing the named variables or arguments.

Note: The DATA, MDO, VARS, and ARGS operands are mutually exclusive.

RANGE=(start,end) is specified with ARGS, to denote an argument range.

Notes:

Event classification generally depends on how much subjective rule based interpretation has been performed. For example an event containing raw performance data should be classified as a utilization event. A rule based application receiving this event might interpret it as a performance problem and generate a secondary serviceability event. This might then be passed on to another application which generates procedural events.

&EVENT resets the &RETCODE variable to zero. If at least one listener is profiled for the event, &ZFDBK is set to 00. If no listeners were notified of this event, &ZFDBK is set to 04.

Examples: & EVENT

&EVENT NAME=SNA_SESSION_COMPLETION +
       TYPE=CONFIGURATION +
       OBJECT=SESSION +
       REF=N01208 +
       RESOURCE=(&APPL,&LUNAME)+
       DATA=&VTAMTEXT

More information:

Sample Code