CICSplex Exit Program Analysis attribute group

The CICSplex Exit Program Analysis attribute groups returns information about a global user exit (GLUE) or a task-related user exit (TRUE). This information is retrieved using the EXEC CICS INQUIRE EXITPROGRAM command.

API Type Indicates which APIs the task-related user exit program uses. Values are:

BASE_API
CICSAPI has replaced BASEAPI. Both these values have the same meaning, and, for compatibility, BASEAPI is still accepted by the translator.
CICS_API
The task-related user exit program is enabled as either QUASIRENT or THREADSAFE, but without the OPENAPI option. This means it is restricted to the CICS permitted programming interfaces. In releases before CICS Transaction Server for z/OS version 3, this CVDA was called BASEAPI.
OPEN_API
The task-related user exit program is enabled with the OPENAPI option. This means it is permitted to use non-CICS API, for which purpose CICS will give control to the task-related user exit under an L8 mode open TCB. OPENAPI assumes that the program is written to threadsafe standards.

CICS Region Name Indicates the job name or modify ID of the CICS region being monitored. Each CICS region in a z/OS image has a unique name. This name is an alphanumeric string, with a maximum of 8 characters, and case-sensitive. CICS region names are always in uppercase characters.

Concurrency Status Indicates the concurrency status of the task-related user exit program, as specified by the latest ENABLE command for this program. Values are:

QUASIRENT
The task-related user exit program is defined as being quasi-reentrant, and is able to 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 program is defined as threadsafe, and is capable of running under an open TCB. If the APIST option returns OPENAPI, it will always be invoked under an open TCB. If the APIST option returns BASEAPI, it is invoked under whichever TCB is in use by its user task when the program is given control, which could be either an L8 mode open TCB or the CICS QR TCB.

Connection Status Indicates the state of the connection between the exit and the external resource manager that it supports. CONNECTST enables you to determine whether the specified exit has connected to its resource manager, so that CICS tasks can safely issue API requests to the resource manager. Values are:

Connected
The task-related user exit is connected to its external resource manager subsystem, and API requests can be issued.
N/A
The exit is not a task-related user exit.
Not_Connected
The task-related user exit is not connected to its external resource manager subsystem, and therefore API requests cannot be issued.
Unknown
The task-related user exit has been enabled and started, but not enabled for SPI requests. UNKNOWN can also be returned if CICS is unable to call the task related user exit. In both of these cases, CICS cannot tell whether it is connected to its external resource manager.

EDF Format Status Indicates that the FORMATEDF option is enabled for the exit. FORMATEDF causes extra invocations of the exit for tasks executed under EDF, to format output screens and interpret input, and applies only to task-related user exits. Values are:

On
FORMATEDF processing is turned on.
Off
FORMATEDF processing is turned off.
Unknown
This is a global user exit.

Entry Point Indicates the entry address of the user exit.

Exit Program Name Is the name of the current exit program.

Exit Point Name Is the identifier of an exit point associated with the exit.

Exit Qualifier Is the Task Related User Exit SPI qualifier assigned by CICS.

Global Exit Points Is the number of global user exit points at which the exit is enabled.

Global Workarea Owner Is the exit that owns the global workarea associated with the current exit.

Global Workarea Length Is the length of the global workarea for the exit.

GWA Use Count Indicates the total number of user exits that are using the global workarea owned by this exit. This count includes the owning exit program. A zero is returned if the exit is not the owner.

In-Doubt Wait Status indicates whether the task-related user exit is enabled with the INDOUBTWAIT keyword. Values are:

Wait
The exit is enabled with the INDOUBTWAIT keyword.
No_wait
The exit is not enabled with the INDOUBTWAIT keyword.
N/A
The exit being inquired upon is a global user exit.

Newcopy Count Is the number of times that the Program has been Newcopied.

Location Indicates the exit location of the program. Values are:

Origin Node Is the combination of z/OS System ID (SMFID) and CICS region name. The value format is an alphanumeric string, maximum 32 bytes, and case-sensitive.

When a situation is true, the system compares the origin node name in the attribute to the names of managed systems assigned to the item. If the origin node name matches the name of a managed system, the status of the item changes accordingly. If the names of the origin node and the managed systems do not match, the status of the item remains unchanged.

Program Size Is the size in bytes of the Exit Program.

Purge Status Indicates whether the task-related user exit is enabled with the PURGEABLE keyword. Values are:

Purgable
Tasks are purgeable from CICS waits within the task-related user exit.
Not_purgable
Tasks are not purgeable from CICS waits within the task-related user exit.
N/A
The exit being inquired upon is a global user exit.

RPL Offset Is the offset into the RPL DD of the owning PDS.

Shutdown Status Indicates whether the SHUTDOWN option is enabled for the exit. SHUTDOWN causes invocation during CICS shutdown, and applies only to task-related user exits. Values are:

Shutdown
The exit is invoked when a CICS shutdown occurs.
Noshutdown
The exit is not invoked when a CICS shutdown occurs.
N/A
This is a global user exit

SPI Enablement Indicates whether the task-related user exit is enabled for SPI calls. Values are:

SPI
The exit is enabled for SPI.
No_SPI
The exit is not enabled for SPI.
N/A
The exit being inquired upon is a global user exit.

Start Status Identifies whether the exit is available for execution. Values are:

Started
The exit program is available for execution; that is, the START option on an EXEC CICS ENABLE command is still in force.
Stopped
The exit program is not available for execution; that is, the START option has not been issued, or has been revoked by the STOP option on an EXEC CICS DISABLE command.

System ID Indicates the four-character name that uniquely identifies an active z/OS operating system within a given CICSplex. The value format is an alphanumeric string, maximum 4 characters, and case-sensitive. z/OS System IDs are always in uppercase characters.

TASKSTART Status Indicateswhether the TASKSTART option is enabled for the exit. TASKSTART causes CICS to invoke the exit at the start and end of every task; it applies only to task-related user exits. Values are:

Taskstart
The exit is set for invocation at the start and end of every task.
Notaskstart
The exit is not set for invocation at the start and end of every task.
N/A
This is a global user exit.

Task Workarea Length Indicates the length of the local (task-related) workarea for the exit. Local workareas apply only to task-related user exits. A zero is returned if this is a global user exit.

Use Count Is the number of times the exit program has been invoked.