CICS TG Statistics API Overview

Documentation V9.2.0.2

This documentation is for the C-language application programming interface (API) for CICS Transaction Gateway Statistics. This 32-bit API can be used by applications to obtain runtime statistics from the Gateway daemon. Applications can be local or remote to the Gateway daemon. Connectivity is obtained via TCP/IP.

The types and functions which make up this API are defined in header files ctgstats.h and ctgstdat.h.

The CICS TG product provides a sample application installed in directory

  • <install_path>/samples/c/stats

The Statistics API and protocol version numbers are not related to the CICS TG product version. For more information, search for 'API and Protocol version control' in the product documentation.

When an application written for the C-language CICS TG Statistics API is ready for deployment, the appropriate CICS TG DLL or shared object file must be made available on the remote system. The CICS TG file for deployment with the application varies with the operating system. For more information, search for 'Statistics C API components' in the product documentation.

Before statistics can be obtained by the application the Gateway daemon must have a statistics protocol handler enabled. For more information, search for 'Statistics configuration' in the product documentation.