Verbs and Built-in Functions › &PPOALERT

&PPOALERT

Generates a simulated PPO message and specifies delivery options for a local or remote system.

&PPOALERT [ { [ LOCAL ] [ REMOTE ] [ PPOPROC ] } | ALL ]
              [ LINK={ linkname | * } | DOMAIN={ domainid | * } ]
              [ MSGID=nnnn ]
              [ MNAME=name ]
              [ PNAME=name ]
              [ MNETNAME=name ]
              [ PNETNAME=name ]
              [ ONETNAME=name ]
              [ ODOMAIN=name ]
              [ OSSCP=name ]
              [ OLINK=name ]
              [ LDOMAIN=name ]
              [ ALARM={ YES | NO } ]
              [ COLOR=color ]
              [ HLIGHT=highlight ]
              [ INTENS={ HIGH | NORMAL } ]
              [ NRD={ NO | OPER } ]
              [ SCAN={ YES | NO } ]
              [ { DATA | TEXT= } message-text ]

Simulates a PPO message on a LOCAL or REMOTE system. &PPOALERT may be used to signal an event on the local system, or one which is connected by an ISR link.

Operands:

LOCAL REMOTE PPOPROC | ALL

These operands correspond to the DELIVER options on the DEFMSG command. They determine the destinations for message delivery. For simulated VTAM messages where no options are specified, the delivery options in the DEFMSG table of the target system are used, otherwise these options will override the delivery options in the DEFMSG table. (For more information, see Notes for this verb.)

LINK={ linkname | * } | DOMAIN={ domainid | * }

Specifies the ISR-connected system on which the &PPOALERT is to be simulated. LINK=* generates an alert on all connected systems. DOMAIN=* generates an alert on all connected systems as well as the system issuing the alert.

MSGID=nnnn

A 3- or 4-digit VTAM message number associated with the alert message. This number corresponds to the nnnn part of the VTAM ISTnnn or ISTnnnn message ID.

MNAME=name

The minor resource name (MNAME) associated with the message. This must form a valid resource name and may be from 1 to 8 characters long.

PNAME=name

The group resource name (PNAME) associated with the message. This must form a valid resource name and may be from 1 to 8 characters long.

MNETNAME=name

The minor network name (MNETNAME) associated with the message. This must form a valid network name and may be from 1 to 8 characters long.

PNETNAME=name

The group network name (PNETNAME) associated with the message. This must form a valid network name and may be from 1 to 8 characters long.

ONETNAME=name

ODOMAIN=name

OSSCP=name

OLINK=name

These four parameter options let you override the originating network name, domain ID, SSCP name, or link name, if necessary. This may be useful when using &PPOALERT procedures to generate test messages.

LDOMAIN=name

Lets you override the last domain name.

ALARM={ YES | NO }

Specifies whether the terminal alarm sounds when a message is delivered.

COLOR=color

Specifies the screen display color for the message.

HLIGHT=highlight

Specifies whether the message is to be highlighted.

INTENS={ HIGH | NORMAL }

Specifies the message intensity required.

NRD={ NO | OPER }

Sets the non-roll delete attribute for the message.

SCAN={ YES | NO }

Specifies whether at signs (@) within text are to be interpreted as word highlight markers.

DATA | TEXT=message-text

The alert message text generated.

Examples: &PPOALERT

&PPOALERT LINK=CENTRAL TEXT=Successful Recovery of Area-3

Notes:

&PPOALERT simulates a VTAM message if the MSGID operand is specified, or if the message identifier within TEXT is a valid VTAM message ID.

The ALL, LOCAL, and REMOTE operands on the &PPOALERT verb represent the delivery options for the location at which the message is simulated. (This is different from the &PPOCONT and &PPODEL verbs, where these operands direct message flow from PPOPROC.) The LINK= or DOMAIN=operands can also be specified on the &PPOALERT statement. The delivery options are then used to override DEFMSG on the targeted domains. For example:

&PPOALERT LOCAL PPOPROC LINK=CENTRAL + TEXT=Node ASYD01 is now active

This statement causes the message to be delivered to link name CENTRAL, and at CENTRAL it assumes the delivery options of LOCAL and PPOPROC.

Message COLOR and HIGHLIGHT values you specify in the &PPOALERT verb override the PPOCOLOR and PPOHLITE SYSPARMS operands.

If LINK={ linkname | * } or DOMAIN={ domainid | * } is specified, the &ZFDBK system variable is set, following execution, as follows:

0

The message was enqueued successfully.

8

The specified link or domain was not enabled for PPO. This may mean that the link has not been started or PPO ISR has not been enabled for the link.

12

The specified link or domain is enabled for PPO but is not enabled for outbound unsolicited PPO traffic.

16

Storage shortage, message not sent.

20

ISR queue overflow on one or more links, &ZPPOSCNT has a count of the links on which a message was successfully sent.

28

ISR internal error.

In all other cases, &ZFDBK is set to zero.

If sends on multiple links are attempted because an asterisk has been specified on the LINK or DOMAIN operands, any error code returned will reflect the first error encountered, except for a queue overflow condition, which will always be indicated if it has occurred on any of the links.

Note: For information about how the ISR queue limit is calculated, see the description of the ISR QMAXK operand in the Online Help.

More information:

&PPOREAD

&PPODEL

&PPOREPL