About API applications

This book describes one of two Transfer CFT programming interfaces, the API applications. This interface enables Transfer CFT to work in conjunction with external applications.

This book begins with this topic which introduces the two application families that can be developed using these two interfaces and the development kit contents for building APIs.

  • Applications communicating with Transfer CFT to submit and monitor transfers or query the catalog, for example. See Using APIs.
  • Exits enabling user programs to take control during a send operation. See Managing exits.

Transfer CFT only provides a programming interface in C. This programming interface can only be used if the development kit is installed on your system, C compiler and associated tools.

This book is comprised of the following topics which describe how to create an API application.

Topic Details

Creating an API application

Describes the procedure to create an API application in Transfer CFT UNIX.

Creating an exit file

Describes how to create an exit file for Transfer CFT UNIX.

Creating a directory exit

Describes how to create a directory exit in Transfer CFT UNIX.

Creating an accounting exit

Describes how to create an accounting exit in UNIX.

Development kit contents

The development kit used to integrate the Transfer CFT APIs is divided into several directories:

  • <installdir>/lib/ containing all required libraries, in C, including:
  • A libcftapi.a module: this library is required for any application using the Transfer CFT APIs
  • A libcftexa.a module: this library is required for any application using the Transfer CFT directory exits
  • A libcftexf.a module; this library is required for any application using the file EXITs
  • A libcftexe.a module; this library is required for any application using the end of transfer EXITs

To generate a user application based on the Transfer CFT APIs and use the file exit function, you must link the following with the libcftapi.a and libexe.a libraries.

  • <installdir>/runtime/src/capi/ containing a command entry and catalog query example
  • <installdir>/runtime/src/exit/ containing simple examples of file exits, directory exits, and end of transfer exits

Related Links