Using the TSO Client API

The TSO Client API enables you to perform Remote Build functionality by using a TSO Client API application. Use the TSO Client API to create your own custom TSO Client calls to a distributed system running DevOps Code ClearCase®.

The TSO Client API provides a set of REXX™ scripts that reside on the host in HLQ.TSCRX (where HLQ is the high-level qualifier where TSO Client is installed on the mainframe system). These scripts allow you to perform the same functions that you can perform by issuing a clearmake command to invoke rccbuild or by selecting a makefile to run a build by using panel 2.3 of TSO Client. You can use the TSO Client API by running the provided REXX scripts directly or by submitting a job to run the scripts in batch mode.

You can perform the following tasks by using the API:

  • Test the connectivity between the mainframe and distributed components of z/OS® Extensions.
  • Perform basic DevOps Code ClearCase functions, such as check in, check out, upload, and download from another REXX or ISPF program.
  • Create a toolbox you can customize with functions that meet the specific requirements of your application and environment.

The API validates calls to TSO Client and sends back a return code, reason code, and message.

Note: The TSO Client API supports authentication modes 0, 1, and 2. For more information about authentication modes, see Using secure password protection.
For instructions on using the TSO Client API, choose from the following topics. Some of these topics contain links to further details.