The Programming Interface › Operator Control Modification

Operator Control Modification

To modify a transfer request

1. Perform the DISPLAY function.
2. Retrieve the MICR field described in the CA XCOM Data Transport history record from one of the records in the TS queue specified in APIDSPLQ.
3. After this is done, change the start date of a transfer request.

To change the start date of a transfer request

1. Create the parameter records that describe the desired file transfer operator control function. For example, to change the Start Date of a file transfer:

   TYPE=ALTER
   ALTER=STARTDATE
   STARTDATE=19970201
   MICR=xxxxxxxx
   

   Note: xxxxxxxx is the eight‑character MICR field created by a TYPE=DISPLAY request that you should retrieve from the TS queue.

2. Create the APIDSECT storage area, initialize it to nulls (X'00'), and set the following fields:
   • 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 assumes that the four records created in Step 1 are written as individual records (items) to TS queue XAPILU22.
   • 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.

   For example, set APISTCAP to XCOMAPPL. 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.

3. Create a link to program XCICCAPI and pass the APIDSECT as the COMMAREA:

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

4. Interrogate the return code APIRTNCD. If the return code is zero, the request was successful and there is no message returned. If the return code is non‑zero, a message should be returned in the APIMSG field.

There are two sample programs supplied in the XCOMSAMP library which show how to schedule a file transfer request:

• XCICTSTA, an Assembler program
• XCICTSTC, a COBOL program.

You can use these programs and alter them to fit your requirements.