Verbs and Built-in Functions › &SNAMS REGISTER

&SNAMS REGISTER

The &SNAMS REGISTER verb registers an application with SNAMS.

An NCL application uses this option to register itself with SNAMS. Once registered, it is deemed to be a valid destination for MDS-MUs.

The application can optionally register a category for which it intends to be the local focal point. This registration indicates to MS_CAPS that the local node can negotiate for the role of a focal point for that category in an MS Capabilities exchange.

Alternatively, the application can register interest in a category to receive focal point updates from MS_CAPS. This option however, is unnecessary for applications that use such notification messages solely to obtain addressing details, to send MDS-MUs to the active focal point. The &SNAMS SEND verb provides an option for sending MDS-MUs to the focal point of a specified category, eliminating the need for applications to track focal point activation/deactivation.

This verb has the following format:

&SNAMS	REGISTER NAME=applicationname
              [ APPLID=routingname ]
              [ CATEGORY=fpcategory [ TYPE={ FP | FPN } ] ]

Operands:

NAME=applicationname

(Mandatory) The name of the application being registered and must be 1 through 32 characters long. If the APPLID= operand is not supplied, the first eight characters of this name are used as the routing name. Otherwise it is purely a descriptive name known only to the local system.

APPLID=rountingname

This operand, if supplied, is the name recognized by SNAMS as a potential target application for incoming MDS-MUs. If omitted, the first 8 bytes of the NAME= operand is used as the routing name. This operand is designed for SNA-architected applications with nondescriptive names (for example, '23F0F3F1'X). The value must be four bytes specified as a hexadecimal quoted string.

CATEGORY=fpcategory [ TYPE={ FP | FPN } ]

The CATEGORY operand indicates the focal point category for the TYPE= operand. The operand is not required, but if supplied, it must be one through eight characters long and specified as a hexadecimal quoted string.

TYPE={ FP | FPN }

Indicates the role of the registered application with respect to the category specified for the CATEGORY= operand. This operand itself is optional. If supplied, the CATEGORY= operand must be specified.

TYPE=FP registers the application as the local focal point for the specified category. This registration authorizes MS-CAPS to accept negotiations with remote nodes aimed at establishing the local node as the focal point for that category, and with this application acting as the focal point application.

TYPE=FPN indicates to MS_CAPS that this application wishes to be notified of all focal point updates for the specified category.

Default: FP

Return Codes:

For &RETCODE 0 and 4, the &ZSNAMID variable contains a non-zero application registration identifier.

For &RETCODE 8, the &SYSMSG variable contains a system error message.

Notes:

New registrations trigger the following EDS system configuration notification events:

• $$SNAMS.APPL.REGISTER

  This is generated when the application is registered for the first time. The resources for this event are, respectively, the application routing name and the local node name.

• $$SNAMS.FP.ACTIVE.LOCAL

  This is generated if the registration is for a focal point application. The resources for this event are respectively, the MS category and the focal point address.

Processes that are profiled for the receipt of the events have the message N00102 queued to their response queues and accessible using the &INTREAD statement. The resources for this message are formatted as follows:

Application routing name, or MS category

Is a hexadecimal quoted string if it is an SNA-architected value, that is, a 4-byte value containing non-displayable characters (for example, '23F0F3F1'x). Otherwise, it is formatted as a text string (for example, USERAPPL).

Node name

Contains the network identifier and the NAU name, separated by a period (for example, NETID.NAUNAME).

Focal point address

Contains the network identifier, NAU name, and focal point application routing name, each separated by a period (for example, NETID.NAUNAME.'23F0F3F1'x).