Process Macros › WAITEVNT Macro

WAITEVNT Macro

The WAITEVNT macro waits for an N00102 event message.

Parameters: WAITEVNT Macro

Note: You can use the asterisk (*) as wild cards in the Name, Object, Resource, and Reference fields. A leading or embedded * represents a single character; a trailing * represents zero or more characters.

• Name

  Lets you use the name of the event as a criterion to select the event to wait for.

• Type

  Lets you use the type of event as a criterion to select the event to wait for. Valid values are as follows:

  • ALL

    Selects events irrespective of their contents.

  • APPLICATION

    Selects events that contain user-defined information.

  • ACCESS

    Selects events that contain security alarm information.

  • CONFIGURATION

    Selects events that contain object definition and relationship information.

  • PROCEDURAL

    Selects events that contain scheduling and process control information.

  • SERVICEABILITY

    Selects events that contain availability, degradation, error, fault, and recovery information.

  • UTILIZATION

    Select events that contain accounting, performance, response time, and statistics information.

• Scope

  Lets you use the scope of delivery of the event as a criterion to select the event to wait for. Valid values are as follows:

  • REGION

    Selects events that are delivered to processes within the region of the event issuer only.

  • SYSTEM

    Selects events that are delivered to processes within the entire region.

• Object

  Lets you use the object class as a criterion to select the event to wait for.

• Resource

  Lets you use the name of the resource or resource pair (separated by a comma) for which the event is issued as a criterion to select the event to wait for.

• Reference

  Lets you use the reference code for the event as a criterion to select the event to wait for.

• Wait Time

  Specifies how long the macro can wait for an event that satisfies the specified criteria.

Return Codes: WAITEVNT Macro

• 0

  Event message received.

• 4

  Event message not received within the specified time.

Returned Variables: WAITEVNT Macro

• &$RMMCEVENT1 through &$RMMCEVENT12

  Contains the N00102 event message. The number of variables that contain value depends on the length of the message. Each variable can hold up to 256 bytes.

• &$RMMCEVNAME

  Contains the name of the event.

• &$RMMCEVTYPE

  Contains the type of the information in the event.

• &$RMMCEVSCOPE

  Contains the scope of delivery of the event.

• &$RMMCEVOBJ

  Contains the object class for the resource or resource pair for which the event is issued.

• &$RMMCEVRES

  Contains the name of the resource or resource pair for which the event is issued.

• &$RMMCEVREF

  Contains the reference code for the event.

• &$RMMCEVDATA

  Contains the part of data that is in the &$RMMCEVENT1 variable. If the data overflows into the other &$RMMCEVENTn variables, you can obtain all the data by concatenating the value in those variables to the value in this variable.

Example: WAITEVNT Macro

In the following example, the WAITEVNT macro waits for an event with a name that starts with OPERATIONS, and of the specified type and scope. The wait time period is 100 seconds.

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

 .- Event Parameters ----------------------------------------------------------.
 |                                                                             |
 | Name......... OPERATIONS*                                                   |
 |                                                                             |
 | Type........+ SERVICEABILITY                                                |
 | Scope.......+ SYSTEM                                                        |
 |                                                                             |
 | Object.......                                                               |
 | (Blanks will be translated to underscores)                                  |
 |                                                                             |
 | Resource.....                                                               |
 | Reference....                                                               |
 |                                                                             |
 | Wait Time ... 100 (0 - 9999, Blank = Wait Forever)                          |