Previous Topic: &CMDLINE

Next Topic: &CNMCLEAR


&CNMALERT

The &CNMALERT verb sends a CNM record directly to CNMPROC in a local or remote NEWS system for processing.

This verb has the following format:

&CNMALERT [ MODE={ CREATE | INSERT } ]
          [ LINKNAME=linkname | SSCPNAME=sscpname | DOMAIN=domain ]
          [ &var &var .... &var |
            MDO=mdoname | VARS=... |
            ARGS [ RANGE=(start,end) ] ]

The &CNMALERT verb gives you the ability to queue a CNM record to a CNMPROC, running in a local or remote NEWS system, for processing. Any NCL procedure can use this verb. Using this verb, a procedure can generate alerts to make operators aware of events in the system or network, and alerts that simulate a network event to test NEWS processing procedures.

Operands:

MODE={ CREATE | INSERT }

Determines the context in which the receiving CNMPROC processes the alert.

MODE=CREATE

Places the alert on the queue of records waiting to be processed.

MODE=INSERT

Places the alert as the first on the queue so the next &CNMREAD issued by CNMPROC results in CNMPROC receiving this alert. This option is used to create a record that maintains some context with the record CNMPROC is processing.

The MODE=INSERT option is only valid when &CNMALERT is issued from CNMPROC and procedures which are nested (executed) under CNMPROC. Any other NCL procedure that attempts to use the MODE=INSERT option terminates with an error message.

LINKNAME=linkname | SSCPNAME=sscpname | DOMAIN=domain

Are mutually exclusive operands used to direct the alert to the CNMPROC running in the specified region. NEWS uses the Inter-System Routing (ISR) feature to communicate with other product regions running on remote hosts, and therefore can route any CNM request to a remote host for processing. The link, SSCP, or domain ID uniquely identifies the destination host. For remote processing to be possible, the INMC link to the remote host must be active and the NEWS facilities in ISR must be enabled for unsolicited flows. If the destination name is that of the local system, no ISR delivery is necessary and the record is delivered to the local CNMPROC in the usual manner.

&var &var .... &var

Specifies user variables that contain the CNM record to forward to VTAM across the CNM interface.

Each variable contains valid hexadecimal characters that, when concatenated, form the entire CNM RU. Where a Network Services RU (NS RU) is sent to VTAM embedded in a Forward RU, the variables must include the Forward RU with the target resource and PU vectors appended. In addition, set all relevant RU byte values and length fields appropriately, with the exception of the 12 bits in the CNM header comprising the procedure correlator identifier (PRID). Where NEWS recognizes from the supplied RU data that this RU is a solicitation request, it automatically generates a PRID and inserts the value in the CNM RU. The PRID, echoed by the resource in any reply RUs, is used to correlate reply data with the &CNMSEND request.

MDO=mdoname | VARS=... | ARGS [ RANGE=(start,end) ]

Specifies the data to place in the alert. If the MDO= operand is used, the data is located as formatted in the MDO.

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

The MDO, VARS, and ARGS operands are mutually exclusive.

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

Examples: &CNMALERT

&CNMALERT &var &var ....
&CNMALERT MODE=INSERT &var &var ....
&CNMALERT LINKNAME=NMP &var &var ....

Notes:

&CNMALERT does not solicit information. No response is received from any &CNMALERT. The data supplied on the &CNMALERT statement is queued as is to the appropriate NEWS system for processing.

When control is returned to the NCL procedure following a &CNMALERT statement the &RETCODE system variable is set to one of the following:

0

The alert has been successfully delivered to the target CNMPROC.

8

The alert has not been successful. The &SYSMSG variable contains an explanatory message.

See also the ISR command description in the online help.

More information:

&CNMSEND