API Call/Macro Extensibility

Edit online

The Extensibility - API feature allows you to access an analysis that reflects their usage of in-house or 3rd party APIs, by using a configuration file, instead of waiting for development support. Using JSON configuration files, the user describes how each API/Macro call is interpreted.

API call events can be handled as one of the following types of calls:
  • Data access calls
  • Inner application program calls
  • Cross application calls

The following statements are supported for API calls:

  • CALL PROGRAM
  • EXEC CICS LINK PROGRAM
  • EXEC CICS XCTL PROGRAM

To enable the API macro extensibility feature, go to the config folder and edit .ini file used for project creation and then set the EnableExtensibilityAPI option in the Settings section to true: EnableExtensibilityAPI=Y. At the creation project time, the API Config folder is created.

In the API Config folder, two types of JSON configuration files can be added:
API Config
Specifies the API calls to be analyzed, the API call parameters, and for which one of these parameters, the values are required.
User Exits Config
Contains a list of API calls and the path to a user exit.

The user exit is a JSON file or a utility that you must create. It contains new resolutions for the API calls. For more information about the user exit JSON files, see section API/Macro Call Extensibility Examples.

The resolution of the API calls is made by using a module that is called the API Resolver, which uses the User Exists Config JSON configuration file.

Note: After each compilation, a JVME_Post_Compiler.log file is created in directory /wca4z-understand/.ad/comp/log.
The API Config configuration file is validated before each build event and in case errors are found, an error message is displayed and the build stops.

The folder is added as an option only after the project is created, so the users that do not use the API Macro feature will not get confused.