XCOMJOB Sample JCL

Describes the contents of the samples library.
xdtzos
The CA XCOM Data Transport samples library contains the following sample XCOMJOB job streams:
  • Type of Request
    TYPE=EXECUTE
    • Name of the Sample Job
      CAI.CBXGJCL(XCOMJOBE)
  • Type of Request
    TYPE=SCHEDULE
    • Name of the Sample Job
      CAI.CBXGJCL(XCOMJOBS)
      CAI.CBXGJCL(XCOMJOXS) for XCOMPLEX Admin Server
      CAI.CBXGJCL(XCOMJOQS) for PLEXQ feature
XCOMPLEX feature is deprecated in XCOM r11.6, use the PLEXQ environment instead.
  • Type of Request
    TYPE=INQUIRE
    • Name of the Sample Job
      CAI.CBXGJCL(XCOMJOBI)
      CAI.CBXGJCL(XCOMJOXI) for XCOMPLEX Worker Server
      CAI.CBXGJCL(XCOMJOQI) for PLEXQ feature
XCOMPLEX feature is deprecated in XCOM r11.6, use the PLEXQ environment instead.
  • Type of Request
    TYPE=HISTORY
    • Name of the Sample Job
      CAI.CBXGJCL(XCOMJOBH)
      CAI.CBXGJCL(XCOMJOQH) for PLEXQ feature
For more information about the transfer request types, see the TYPE parameter in PARM Parameters.
XCOMJOB TYPE=EXECUTE Sample
In the XCOMJOB TYPE=EXECUTE sample, a file from the local system is sent to replace a file on a remote system through the execution of a non-queued CA XCOM Data Transport transfer. The EXEC statement includes a PARM parameter used to pass instructions to XCOMJOB concerning the ACB name.
XCOMJOB TYPE=SCHEDULE Samples
In the XCOMJOB TYPE=SCHEDULE samples, a file from the local system is sent to replace a file on a remote system through the execution of a queued CA XCOM Data Transport transfer. The EXEC statement includes a PARM parameter used to pass instructions to XCOMJOB concerning the ACB name.
XCOMJOB TYPE=INQUIRE Samples
In the XCOMJOB TYPE=INQUIRE samples, the job uses TYPE=SCHEDULE to initiate two file transfers and TYPE=INQUIRE to examine the status of those file transfers.
TYPE=INQUIRE does not initiate file transfers, unlike the TYPE=EXECUTE and TYPE=SCHEDULE modes, but examines the status of transfers that were previously initiated by TYPE=SCHEDULE. It waits until the transfers have completed and issues a return code reflecting the status of the transfers.
The primary use of TYPE=INQUIRE is in batch job streams where some job steps are dependent upon the successful completion of other job steps that transfer files. The dependent steps can execute conditionally based on the return code issued by TYPE=INQUIRE.
When you schedule a transfer, you must include the INQUIRE data set in that JCL. CA XCOM Data Transport schedules the transfer and writes the request number and a time stamp into the INQUIRE data set. In the INQUIRE step, you must reference the same INQUIRE data set. You must at least steplib to that same library in your CA XCOM Data Transport start-up JCL. It is essential that the CA XCOM Data Transport started task accesses the same maintained libraries as the INQUIRE step accesses. Make sure that this library occurs first in any concatenation.
The INQUIRE process then interrogates the CA XCOM Data Transport server to locate the transfer. It examines the transfer requests every 10 seconds until the amount of time specified in the SYSIN01 parameter INQWAIT has elapsed. (See the SYSIN01 parameter INQWAIT for details.) If the transfer is pending or active, it is listed in the CA XCOM Data Transport RRDS. If the transfer has completed, whether successful or unsuccessful, it is logged in the CA XCOM Data Transport history file. Both the request number and the time stamp for that transfer are used to search for the transfer. The return code passed back by the INQUIRE step is determined by where the transfer was found and the actual status of the transfer.
TYPE=INQUIRE removes request numbers from the XCOMINQ file if the requests are complete or not found. Request numbers for transfers that have not completed are not removed from the XCOMINQ file.
The XCOMINQ data set must be preallocated using ISPF or IEBGENER. The file cannot be created in a job step. There is sample JCL to define the inquire data set in CAI.CBXGJCL(DEFINQ). Define a unique INQUIRE data set for each set of transfers.
It is important to be consistent when using TYPE=INQUIRE in an XCOMPLEX environment or it does not work properly. If the TYPE=SCHEDULE goes directly to an XCOMPLEX Worker Server, then the TYPE=INQUIRE must also be done against the XCOMPLEX Worker Server. If the TYPE=SCHEDULE goes through the XCOMPLEX Admin Server, then the TYPE=INQUIRE must also be sent to the XCOMPLEX Admin Server. The XCOMPLEX environment is deprecated in XCOM r11.6, use the PLEXQ environment instead.
XCOMJOB TYPE=HISTORY Sample
In the XCOMJOB TYPE=HISTORY sample, history records are first retrieved based on the criteria specified using SYSIN01 parameters. For a description of these parameters, see SYSIN01 Parameters Required by TYPE=HISTORY.
The second step in the XCOMJOB TYPE=HISTORY sample then passes those history records to the sample CA Easytrieve report distributed as part of the CA XCOM Data Transport installation.