Application Programming Interface › $RFCALL

$RFCALL

$RFCALL is the API procedure used to call CA NetMaster FTM from external sources, for example, a user-written NCL procedure.

$RFCALL ACTION=CDCOMMAND

Use this call to issue CONNECT:Direct commands from CA NetMaster FTM.

This command has the following format:

$RFCALL ACTION=CDCOMMAND
        NAME=cd-manager-name
        [SYSNAME=system-image-name]
        [VERSION=system-image-version]
        COMMAND='cd-command-string'
        [DISPLAY={YES|NO}]
        [USERID=user-id PASSWORD=user-password]
        [CASE={YES|NO}]

ACTION=CDCOMMAND

Indicates that a CONNECT:Direct command is to be processed.

NAME=cd-manager-name

Specifies the name of the CONNECT:Direct manager to which the command applies.

SYSNAME=system-image-name

Specifies the name of the system image in which the command is processed.

Default: The name of the local active system image.

VERSION=system-image-version

Specifies the version of the system image in which the command is processed.

Default: The version of the local active system image.

COMMAND=‘cd-command-string’

Specifies the command to be sent to the CONNECT:Direct product.

DISPLAY={YES|NO}

Specifies whether the response to the command appears (YES) or returned as &$RF$RESPn variables (NO), where n is a sequence number starting from 1 (for example, &$RF$RESP1).

Default: Full-screen mode: YES

Background mode: NO

USERID=user-id

Specifies the CONNECT:Direct signon ID of the user issuing the command. You must specify this operand if you use the API in background mode.

PASSWORD=user-password

Specifies the CONNECT:Direct signon password of the user. You must specify this operand if you use the API in background mode.

CASE={YES|NO}

Indicates whether the specified CONNECT:Direct signon details of the user are to be treated as case sensitive.

Returned Variables

&$RF$RESPn

Command response is returned in &$RF$RESPn variables. Each variable contains one line of the response.

&$RF$RESPCNT

The number of lines in the command response is returned in the &$RF$RESPCNT variable.

&SYSMSG

Contains the message returned by $RFCALL.

Return Codes

The following return codes indicate the success or failure of command processing:

0

Processing successful.

8

Processing failed.

16

Error occurred in call syntax.

Example

The following example shows how to issue a SELECT PROCESS command to the CONNECT:Direct region, DECD1, on the local system in full-screen mode:

$RFCALL ACTION=CDCOMMAND NAME=DECD1 COMMAND='SELECT PROCESS WHERE (QUEUE=HOLD)'

$RFCALL ACTION=FORCEEND

Use this call to force a schedule that monitors file transfers to end.

This command has the following format:

$RFCALL ACTION=FORCEEND NAME=schedule-name

ACTION=FORCEEND

Indicates that a schedule is to be ended.

NAME=schedule-name

Specifies the name of the schedule resource to be ended.

Example

The following example shows how to force a schedule resource (identified by the &ZRMDBNAME knowledge base variable) to end.

$RFCALL ACTION=FORCEEND NAME=&ZRMDBNAME

Note: For more information about knowledge base variables, see the Reference Guide.