The Programming Interface › Programming Requirements › COMMAREA Requirements › Definitions

Definitions

APIRTNCD

Contains the XCICCAPI return code. For a transfer schedule request that is successful, XCICCAPI returns a binary zero value. Otherwise, a non‑zero value indicates that there is a problem with the file transfer.

APITYPER

Indicates the type of request to be processed. To schedule a transfer, set this field to S; to perform an operator control function, set this field to O.

APIAUTH

Is used only for operator control functions and is ignored for schedule functions. It determines whether the user initiating the operator control function is given the equivalent of the TSO OPER security level in the CA XCOM Data Transport server. See CA XCOM Data Transport CICS Operator Security in the chapter “Security Considerations” for more information on this field.

APIPARMQ

Is the name of the temporary storage (TS) queue, in which you must put the card image parameters that tell XCICCAPI what to do. You must write each parameter into the same TS queue as individual card image records (or items). You must also move the name of the TS queue to this field. We recommend that the TS queue name include the terminal ID or some other value to make the queue name unique.

APIDSPLQ

Contains the name of the TS queue, into which XCICCAPI moves the information when an operator control display function is requested. The requestor must fill in this field, but CA XCOM Data Transport CICS creates the TS queue.

APISTCAP

Contains the name of the CA XCOM Data Transport server with which you want to communicate. You must define APISTCAP to CICS either through the TCT or the CEDA transaction.

API#XFER

Contains the number of transfers returned by CA XCOM Data Transport when an operator control display function is requested. Remember that these records are written to the TS queue defined by APIDSPLQ. CA XCOM Data Transport does not use this field for schedule operations or for operator control functions in which TYPE=DISPLAY is not requested.

APIMSG

Is a field in which the CA XCOM Data Transport API returns a message that describes the operation being performed. The CA XCOM Data Transport API should always return a message when a transfer function is requested. When operator control functions are performed, CA XCOM Data Transport only returns a message when the return code APIRTNCD is non‑zero, indicating that an error occurred.