The Programming Interface › DISPLAY Transfer Requests

DISPLAY Transfer Requests

To display transfer requests

1. Create the parameter records which describe the transfers that you want to retrieve. For example, to retrieve all file transfers for remote system CHICAGO submitted by user ALEC, use these statements:

   TYPE=DISPLAY
   GROUP=CHICAGO
   LUSER=ALEC
   ACTIVE=YES
   INACTIVE=YES
   COMPLETED=YES
   

2. Create the APIDSECT storage area and initialize the APIDSECT to nulls (X'00'), and set fields as follows:
   • Set APITYPER to O.
   • Set APIPARMQ to the name of the TS queue to which CA XCOM Data Transport writes the parameter records. For example, set APIPARMQ to XAPILU22. This indicates that the six records created in the first step are written as individual records (items) to TS queue XAPILU22.
   • Set APIDSPLQ to the name of the TS queue to which CA XCOM Data Transport writes the records received as a result of the DISPLAY. Note that CA XCOM Data Transport writes one record to the TS queue for each transfer request returned. The records written to the APIDSPLQ are in the format of the CA XCOM Data Transport History File. For example, set APIDSPLQ to XDISLU22.
   • Contact the CA XCOM Data Transport systems programmer to get the APPLID of the CA XCOM Data Transport server. Ensure that this APPLID is in the CICS TCT or is defined by RDO. Set APISTCAP to the name of the CA XCOM Data Transport server APPLID.
3. Create a link to program XCICCAPI and pass the APIDSECT as the COMMAREA:

   EXEC CICS LINK PROGRAM('XCICCAPI') COMMAREA(APIDSECT) LENGTH(328)
   

4. Interrogate the return code APIRTNCD and the API message returned in APIMSG. If the return code is zero, the API#XFER field returns the same number of transfer requests that were returned to the TS queue specified by APIDSPLQ.