INQUIRE TRANCLASS

Retrieve information about a transaction class.

Syntax

Warning: System commands are powerful as they provide information about the state of the system and allow changes to be made to it. System commands should be used only by authorized applications and users.

Activate security checks on commands by specifying the XCMD system initialization parameter and by ensuring that command security checking is active for the transaction (either by specifying CMDSEC(YES) on the TRANSACTION resource definition or by specifying ALWAYS on the CMDSEC system initialization parameter).

The syntax differs between releases. The affected command options are represented as a fragment in the main diagram. Some command options are available in specific releases; see Applicable releases for command options below the main diagram for the affected options.

INQUIRE TRANCLASS

Applicable releases for command options

Some command options are available in specific releases, as identified below:

6.2 and later PURGEACTION

Conditions: INVREQ, NOTAUTH, TCIDERR

NOHANDLE, RESP, and RESP2 are common options that can be added to all EXEC CICS commands to process error conditions. They are not explicitly included in the command syntax diagram and option descriptions. For information about these common options and EXEC CICS command syntax, see EXEC CICS command format and programming considerations. For more information about the use of CVDAs, see CICS-value data areas (CVDAs).

This command is threadsafe.

Description

You can use the INQUIRE TRANCLASS command to determine the limits defined for a transaction class, as well as the current activity within the transaction class.

6.2 and later You can also use the INQUIRE TRANCLASS command to determine the purge action defined for a transaction class.

Browsing

You can also browse through the definitions of all the transaction classes in your system by using the browse options, START, AT, NEXT, and END, on INQUIRE TRANCLASS commands. In browse mode, definitions are returned in alphabetical order, and you can specify a starting point with the AT option if you want. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

The resource signature

You can use this command to retrieve the resource signature fields. You can use these fields to manage resources by capturing details of when the resource was defined, installed, and last changed. For more information, see Identifying changes to resources (resource signatures). See Summary of the resource signature field values for detailed information about the content of the resource signature fields.

Options

ACTIVE(data-area)

Returns a fullword binary field giving the current number of tasks in this class. This count does not include tasks that are queued waiting for initial dispatch.

CHANGEAGENT(cvda)

Returns a CVDA value that identifies the agent that made the last change to the resource definition. The possible values are as follows:

CREATESPI: The resource definition was last changed by an EXEC CICS CREATE command.
CSDAPI: The resource definition was last changed by a CEDA transaction or the programmable interface to DFHEDAP.
CSDBATCH: The resource definition was last changed by a DFHCSDUP job.
DREPAPI: The resource definition was last changed by a CICSPlex® SM BAS API command.
OVERRIDE: The resource definition was last changed by application of an override rule in the resource overrides file.

CHANGEAGREL(data-area)

Returns a 4-digit number of the CICS® release that was running when the resource definition was last changed: for example, 0760 is the identifier for CICS TS for z/OS®, Version 6.3.

CHANGETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was last changed. For more information about the format of the ABSTIME value, see FORMATTIME.

CHANGEUSRID(data-area)

Returns the 8-character user ID that ran the change agent.

DEFINESOURCE(data-area)

Returns the 8-character source of the resource definition. The DEFINESOURCE value depends on the CHANGEAGENT value. For more information, see Summary of the resource signature field values.

DEFINETIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource definition was created.

INSTALLAGENT(cvda)

Returns a CVDA value that identifies the agent that installed the resource. The possible values are as follows:

CREATESPI: The resource was installed by an EXEC CICS CREATE command.
CSDAPI: The resource was installed by a CEDA transaction or the programmable interface to DFHEDAP.
GRPLIST: The resource was installed by GRPLIST INSTALL.

INSTALLTIME(data-area)

Returns an ABSTIME value that represents the time stamp when the resource was installed.

INSTALLUSRID(data-area)

Returns the 8-character user ID that installed the resource.

MAXACTIVE(data-area)

Returns a fullword binary field giving the largest number of tasks in the transaction class that are allowed to run concurrently.

6.2 and later PURGEACTION(cvda)

Returns a CVDA value that indicates the action that CICS takes on a request to start a transaction when its associated TRANCLASS has reached the purge threshold. CVDA values are as follows:

ABEND: CICS starts the requested transaction, and then abends it with AKCC.
DISCARD: CICS discards the request. The requested transaction is not started.

PURGETHRESH(data-area)

Returns a fullword binary field giving the maximum number of tasks in this class that can be queued awaiting initial dispatch. See the QUEUED option. Tasks in this class that arrive while the queue is at its PURGETHRESH limit are purged.

6.2 and later The purge action taken is specified by the PURGEACTION option.

QUEUED(data-area)

Returns a fullword binary field giving the number of tasks that are queued awaiting initial dispatch. Queuing occurs either because the number of active tasks is already at the maximum, or because the maximum for the system has been reached. See the MAXTASKS option in the INQUIRE SYSTEM command.

TRANCLASS(data-value)

Specifies the 8-character name of the transaction class about which you are inquiring. If the class is one of the numbered classes used in earlier releases of CICS, its name is DFHTCLnn, where nn is the two-digit class number.

Conditions

INVREQ

RESP2 values:

12: The TRANCLASS definition is in use.

NOTAUTH

RESP2 values:

100: The user associated with the issuing task is not authorized to use this command.
101: The user associated with the issuing task is not authorized to access this particular resource in the way required by this command.

TCIDERR

RESP2 values:

1: The transaction class cannot be found.