Process Macros › EVENT Macro

EVENT Macro

The EVENT macro issues an N00102 event message that can be retrieved by NCL processes. To receive the message, the NCL process must be profiled for the event by using the PROFILE EDS command. For a description of the command, see the Network Control Language Reference Guide.

You can wait for the event message from within a process by using the WAITEVNT macro.

Parameters: EVENT Macro

• Name

  Identifies the event. The name can contain alphanumeric, @ and # characters, and . or _ characters (for example, SESSION_COMPLETION).

• Type

  Indicates the type of information contained in the event. Use the types as follows:

  • APPLICATION

    To contain user-defined information.

  • ACCESS

    To contain security alarm information.

  • CONFIGURATION

    To contain object definition and relationship information.

  • PROCEDURAL

    To contain scheduling and process control information.

  • SERVICEABILITY

    To contain availability, degradation, error, fault, and recovery information.

  • UTILIZATION

    To contain accounting, performance, response time, and statistics information.

• Scope

  Specifies the scope of delivery of the event. Valid values are as follows:

  • REGION

    Restricts event delivery to processes in the region of the event issuer.

  • SYSTEM

    Enables event delivery to processes in the entire region.

• Object

  Specifies a user-defined object class for the resource or resource pair for which the event is issued. If the value contains embedded spaces, the spaces are translated to underscore (_) characters.

• Resource

  Names the resource or resource pair (separated by a comma) for which the event is issued. An event can be issued for a pair of resources (for example, a session pair).

• Reference

  Specifies a code for the event.

• Data

  Specifies the data in the event.

Example: EVENT Macro

In the following example, the EVENT macro issues an OPERATIONS_CONDITION event. The event contains operations information in the &ZREVATTENDED user-defined EventView variable.

 PROD------ Automation Services : EVENT Macro Parameter Definition -------------
 Command ===>                                                    Function=BROWSE

 .- Event Parameters ----------------------------------------------------------.
 |                                                                             |
 | Name........ OPERATIONS_CONDITION                                           |
 |                                                                             |
 | Type.......+ SERVICEABILITY                                                 |
 | Scope......+ SYSTEM                                                         |
 |                                                                             |
 | Object......                                                                |
 | (Blanks will be translated to underscores)                                  |
 |                                                                             |
 | Resource....                                                                |
 | Reference...                                                                |
 |                                                                             |
 | Data..... &ZREVATTENDED                                                     |
 |                                                                             |
 |                                                                             |
 |                                                                             |
 '-----------------------------------------------------------------------------'

  F1=Help      F2=Split     F3=Exit
                            F9=Swap