NEWS Device Solicitation Procedures › $NWDS13B Procedure

$NWDS13B Procedure

The CSCF Batch Command Interface enables the execution of all CSCF functions in a batch NCL mode. This enables you to control a controller through automation, so that an end user does not have to be logged on to execute controller functions. The command interface is the execution of the $NWDS13B procedure with parameters dictating processing flow.

$NWDS13B FUNC = LOGON

&CONTROL SHRVARS=($NWCS#,$NW#USR,$GP) NOVARSEG
$NWDS13B      FUNC=LOGON
            { NODE=node_name }
            [ OP=command line text ]
            [ LINK=link_name ]
            [ SSCP=sscp_name ]
            [ PRINT={ YES|nnn|LOG } ]

Note: Print is skipped if RETCODE greater than 4 occurs.

$NWDS13B FUNC = ACTION

&CONTROL SHRVARS=($NWCS#,$NW#USR,$GP) NOVARSEG
$NWDS13B      FUNC=ACTION
            { KEY=PFnn|ENTER }
            [ OP=command line text ]
            [ DATA1-n=xx ]
            [ PRINT={ YES|nnn|LOG } ]

Note: Print is skipped if RETCODE greater than 4 occurs.

$NWDS13B FUNC = LOGOFF

&CONTROL SHRVARS=($NWCS#,$NW#USR,$GP) NOVARSEG
$NWDS13B    FUNC=LOGOFF

Parameters: $NWDS13B Procedure

FUNC

Indicates to the batch procedure what process to take. This is a required parameter where the valid values must be:

$NWDS13B FUNC = LOGON

LOGON the session ID; must be first call.

$NWDS13B FUNC = ACTION

Indicates that some type of action is to take place.

$NWDS13B FUNC = LOGOFF

LOGOFF the session ID after processing is completed.

NODE

Specifies the 3174 node name, required on the logon call only.

OP

Specifies the command to enter. This represents what would be the command line on an on-line panel; that is, any valid CSCF command or option (for example /5,2). The F key command text is not supported at the command line (RETURN, for instance).

KEY

Specifies the key (one of PF1 to PF24, or Enter) to enter once at an indicated panel.

DATA1-20

Specifies the data to enter for each input field on a panel. If the third data item on a panel is updated, DATA3 is passed with the data to enter.

LINK

Specifies the link name if remote controller operations are desired on the logon call only.

SSCP

Specifies the SSCP name if remote controller operations are desired on a logon call only.

PRINT

Specify YES to print screen using user's default PSM printer ID; or specify a specific printer; or specify LOG to send screen capture to the log. This option is skipped if a non-zero RETCODE occurs. The PRINT will occur after all OP and/or KEY parameters are processed.

Return Variables: $NWDS13B

&RETCODE

0

Batch process completed. This means that a command was sent to the controller and a response was received from the controller.

4

Key supplied is not active on current panel.

8

Processing error.

12

Unable to log on.

16

Invalid parameters.

&SYSMSG

Error message.

&$NW#USR#Lnn

Variables where Lnn represents up to 24 lines of panel data.

Example 1: IML the controller.

EXEC $NWDS13B FUNC=LOGON NODE=ACSC11
EXEC $NWDS13B FUNC=ACTION OP=14 KEY=ENTER
EXEC $NWDS13B FUNC=ACTION OP=1,2,41 KEY=ENTER
EXEC $NWDS13B FUNC=ACTION OP=password KEY=ENTER

Example 2: Reset event logs, cable errors and trace data.

EXEC $NWDS13B FUNC=LOGON NODE=ACSC11 OP=/4,2
EXEC $NWDS13B FUNC=LOGOFF

Example 3: Change configuration data (update controller vital product data).

EXEC $NWDS13B FUNC=LOGON NODE=ACSC11 OP=/5,2
EXEC $NWDS13B FUNC=ACTION KEY=PF04 DATA3=CINCY
EXEC $NWDS13B FUNC=LOGOFF

Example 4: Display configuration data and print out to specified printer.

EXEC $NWDS13B FUNC=LOGON NODE=ACSC11 OP=/2,2 PRINT=U33
EXEC $NWDS13B FUNC=ACTION KEY=PF8 PRINT=U33
EXEC $NWDS13B FUNC=ACTION KEY=PF8 PRINT=U33
EXEC $NWDS13B FUNC=ACTION KEY=PF8 PRINT=U33
EXEC $NWDS13B FUNC=ACTION KEY=PF8 PRINT=U33
EXEC $NWDS13B FUNC=LOGOFF

Note: Two methods are available when selecting options from the command line. You can specify only the option number and get to the desired option one screen at a time or you can use the forward slash (/) as a means of panel skipping. Example 1 above shows the one-screen-at-a-time route; all other examples show the fast route. See sample procedure $SANWCSF as a working example.

It is a requirement that data with embedded blanks be assigned to the DATAn keyword using a variable. For example:

&LOCATION = &STR Cincinnati, Ohio

DATA5=&LOCATION

As noted above, &CONTROL NOVARSEG must be in effect or a RETCODE 16 (SYSMSG EWKB01 invalid keyword parameter) occurs.

Note: In example 1, there is no need for a LOGOFF call as the session is implicitly terminated by the IML process.