User Exit Programs report

The User Exit Programs report is produced from two tables. This report is produced using the EXEC CICS INQUIRE EXITPROGRAM command.

Table 1. Fields in the User Exit Programs report
Field Heading Description
Program Name The program name of the program that is enabled as an exit program by using the EXEC CICS® ENABLE command.

Source field: EXEC CICS INQUIRE EXITPROGRAM()

Entry Name The entry point name for this exit program.

Source field: EXEC CICS INQUIRE EXITPROGRAM() ENTRYNAME()

Global Area Entry Name The name of the exit program that owns the global work area associated with this exit program.

Source field: EXEC CICS INQUIRE EXITPROGRAM() GAENTRYNAME()

Global Area Length The length of the global work area associated with this exit program.

Source field: EXEC CICS INQUIRE EXITPROGRAM() GALENGTH()

Global Area Use Count The number of exit programs that are associated with the global work area owned by this exit program.

Source field: EXEC CICS INQUIRE EXITPROGRAM() GAUSECOUNT()

Number of Exits The number of global user exit points at which this exit program is enabled.

Source field: EXEC CICS INQUIRE EXITPROGRAM() NUMEXITS()

Program Status Indicates whether this exit program is available for execution.

Source field: EXEC CICS INQUIRE EXITPROGRAM() STARTSTATUS(cvda)

Program Concurrency Indicates the concurrency attribute of this exit program.

Source field: EXEC CICS INQUIRE PROGRAM() CONCURRENCY(cvda)

Exit Program Use Count The number of times this exit program has been invoked.

Source field: EXEC CICS INQUIRE PROGRAM() USECOUNT(data-area)

LIBRARY Name The name of the LIBRARY from which the program was loaded. This is blank if the program has not been loaded, or if the LPASTATUS is LPA (indicating that the program was loaded from the LPA).

Source field: EXEC CICS INQUIRE PROGRAM() LIBRARY(data-area)

LIBRARY Data Set Name The name of the data set in the LIBRARY from which the program was loaded. This is blank if the program has not been loaded, or if the LPASTATUS is LPA (indicating that the program has been loaded from the LPA).

Source field: EXEC CICS INQUIRE PROGRAM() LIBRARYDSN(data-area)

Program Name The program name of the program that is enabled as an exit program by using the EXEC CICS ENABLE command.

Source field: EXEC CICS INQUIRE EXITPROGRAM()

Entry Name The entry point name for this exit program.

Source field: EXEC CICS INQUIRE EXITPROGRAM() ENTRYNAME()

API Indicates which APIs the task-related user exit program uses. The values are as follows:
CICSAPI
The task-related user exit program is enabled as either QUASIRENT or THREADSAFE, but without the OPENAPI option. The program is restricted to the CICS permitted programming interfaces.
OPENAPI
The task-related user exit program is enabled with the OPENAPI option. The program is permitted to use non-CICS APIs, for which purpose CICS will give control to the task-related user exit under an open TCB. OPENAPI assumes that the program is written to threadsafe standards.

Source field: EXEC CICS INQUIRE EXITPROGRAM() APIST(cvda)

Concurrency Status Indicates the concurrency attribute of the exit program. The values are as follows:
QUASIRENT
The task-related user exit program is defined as being quasi-reentrant, and can run only under the CICS QR TCB when invoking CICS services through the CICS API. To use any MVS™ services, this task-related user exit program must switch to a privately-managed TCB.
THREADSAFE
The task-related user exit program is defined as threadsafe, and can run under an open TCB. If the APIST option returns OPENAPI, the program is always invoked under an open TCB. If the APIST option returns CICSAPI, the program is invoked under the TCB that is in use by its user task when the program is given control, which might be either an open TCB, or the CICS QR TCB.
REQUIRED
The task-related user exit program is defined to always run on an open TCB. REQUIRED was specified either on the program definition or on the ENABLE PROGRAM command.
Note: When a task-related user exit is enabled REQUIRED and OPENAPI, it is treated the same as if it was enabled THREADSAFE and OPENAPI. For compatibility, an INQUIRE EXITPROGRAM for either combination always returns THREADSAFE, OPENAPI. For a task-related user exit enabled REQUIRED and CICSAPI, INQUIRE EXITPROGRAM returns REQUIRED, CICSAPI.

Source field: EXEC CICS INQUIRE EXITPROGRAM() CONCURRENST(cvda)

Qualifier The name of the qualifier specified for this exit program.

Source field: EXEC CICS INQUIRE EXITPROGRAM() QUALIFIER()

Length The length of the task local work area associated with this exit program.

Source field: EXEC CICS INQUIRE EXITPROGRAM() TALENGTH()

Task Related User Exit Options - Taskstart Indicates whether this exit program was enabled with the TASKSTART option.

Source field: EXEC CICS INQUIRE EXITPROGRAM() TASKSTART(cvda)

Task Related User Exit Options - EDF Indicates whether this exit program was enabled with the FORMATEDF option.

Source field: EXEC CICS INQUIRE EXITPROGRAM() FORMATEDFST(cvda)

Task Related User Exit Options - Shutdown Indicates whether this exit program was enabled with the SHUTDOWN option.

Source field: EXEC CICS INQUIRE EXITPROGRAM() SHUTDOWNST(cvda)

Task Related User Exit Options - Indoubt Indicates whether this exit program was enabled with the INDOUBTWAIT option.

Source field: EXEC CICS INQUIRE EXITPROGRAM() INDOUBTST(cvda)

Task Related User Exit Options - SPI Indicates whether this exit program was enabled with the SPI option.

Source field: EXEC CICS INQUIRE EXITPROGRAM() SPIST(cvda)

Task Related User Exit Options - Purgeable Indicates whether this exit program was enabled with the PURGEABLE option.

Source field: EXEC CICS INQUIRE EXITPROGRAM() PURGEABLEST(cvda)