The Programming Interface › About the Programming Interface

About the Programming Interface

Using the CA XCOM Data Transport CICS API, programs can perform the following functions:

• Schedule a transfer request
• Retrieve information about transfer requests
• Perform operator control functions, including the following:
  • Alter priority or start date/time of a transfer request.
  • Cancel, suspend, resume, hold, or release a transfer request.

The CA XCOM Data Transport CICS API uses many XCOMJOB interface facilities. It is designed to accept parameter input in card image format, rather than building the interface using a DSECT or copy book member, which are subject to change.

The CICS API uses the same format as XCOMJOB. You can place the parameters in card image format in a CICS temporary storage (TS) queue and pass this queue to the CA XCOM Data Transport CICS API program. CA XCOM Data Transport then evaluates the parameters, adding the default parameters not specified in the user program, builds the necessary data areas, and initiates a conversation with the CA XCOM Data Transport server. Using this design, you are shielded from having to understand all of the fields in a copy book or DSECT. You can specify almost all parameters in the XCOMJOB interface to the CA XCOM Data Transport CICS API.

The CA XCOM Data Transport CICS API performs most of the XCOMJOB functions with the following exceptions:

• TYPE=EXECUTE is not supported.
• The NEWXFER parameter is not supported. Only one transfer request is allowed per API invocation.

Security within the CA XCOM Data Transport CICS API is the same as within the CA XCOM Data Transport CICS menu interface. For more information about CA XCOM Data Transport CICS security, see the chapter “Security Considerations.”