CEMT INQUIRE TSQUEUE / TSQNAME

Retrieve information about temporary storage queues by using the CEMT INQUIRE TSQUEUE or CEMT INQUIRE TSQNAME commands. In CEMT, you can use either command to operate on temporary storage queues (TS queues) with names up to 16 characters long.

CICS Explorer iconIn the CICS Explorer, the TS queues operations view provides a functional equivalent to this command.

Description

The INQUIRE TSQUEUE command returns information about temporary storage (TS) queues. The INQUIRE TSQUEUE command operates on all the temporary storage queues that exist in the CICS® region. Temporary storage queues that CICS creates internally for its own use, for example, queues used by BMS, are included. You can identify the temporary storage queues that CICS creates for its own use by queue names that begin with the following character strings:
**
BMS paging
$$
BMS route
X'FA' to X'FF'
CICS
CEBR
Default CEBR queue name
DF
CICS
DFHM
Message cache for message-protected tasks
DFXXxx
CICS REQIDS (where xx is a hexadecimal value)

Input

Press the Clear key to clear the screen. You can start this transaction in two ways:
  • Type CEMT INQUIRE TSQUEUE (or suitable abbreviations for the keywords). The resulting display lists the status.
  • Type CEMT INQUIRE TSQUEUE (or suitable abbreviations for the keywords), followed by the attributes that are necessary to limit the range of information that you require. For example, if you enter cemt i tsq main, the resulting display shows the details of only those temporary storage queues that are resident in main storage.
To change various attributes, over type your changes on the INQUIRE screen after tabbing to the appropriate field (see Overtyping a display).
ALL
The default.
(value)
The name of the temporary storage queue for which information is requested.
SYSID(value)
The system name that corresponds to the temporary storage pool name if the request is to be sent to a TS server.

This value is input-only, and must be specific; you cannot specify generic names for SYSID. The specified system name must be defined in a temporary storage table (TST) in a TST TYPE=SHARED entry. If the SYSID is not found in a TST TYPE=SHARED entry, CICS returns a SYSID NOT FOUND error.

POOLNAME(value)
Specifies the 8-character pool name of a temporary storage pool if the request is sent to a TS server. Use this option to view shared temporary storage queues that are defined by RDO resource definitions.

If the pool name is not found, CICS returns a POOLERR.

Browsing

If you place the cursor against a specific entry in the list of temporary storage queues and press Enter, CICS displays an expanded format.

If you place the cursor against a specific entry in the expanded list and type a B (uppercase or lowercase), CICS invokes a direct link to the program DFHEDFBR used by the CEBR transaction to enable you to browse the contents of this TS queue. See CEBR - temporary storage browse for details.
Security warning: Take care to avoid a security exposure. In this situation, access to the browse function is not controlled by transaction attach security checking using the XTRAN parameter in DFHSIT, as it is for the CEBR transaction. Instead, access is controlled by application program security checking using the XPPT parameter in DFHSIT.

Not all TS queues visible on the CEMT INQUIRE TSQUEUE results panel can necessarily be browsed using CEBR. Queues resident in a shared TS pool, when the POOLNAME is specified on the INQUIRE TSQUEUE request, can sometimes not be browsed. Such queues can be browsed if there is a TSMODEL resource definition or temporary storage table (TST) entry mapping the queue name to the TS pool.

You can also browse queues in a shared pool by specifying a SYSID that maps to the shared pool using an entry in the temporary storage table (TST). However, the SYSID is not available to CEMT, so entering B next to the queue gives a NOT FOUND response from CEBR. If an appropriate SYSID is then provided by the user, the reference to the shared pool can be resolved.

If there is no suitable entry in the temporary storage table (TST) and no TSMODEL mapping the queue name to the shared pool, the queue cannot be browsed. CEBR indicates that the requested queue does not exist.

Read syntax diagramSkip visual syntax diagram
CEMT INQUIRE TSQUEUE/TSQNAME

                         .-ALL-----.                        
>>-CEMT INQUIRE TSQUEUE--+---------+--+-----------------+------->
                         '-(value)-'  +-SYSID(value)----+   
                                      '-POOLNAME(value)-'   

>--+-----------------+--+------------------+-------------------->
   '-NUMITEMS(value)-'  '-EXPIRYINT(value)-'   

>--+--------------------+--+---------------+--+-----------+----->
   '-LASTUSEDINT(value)-'  '-LENGTH(value)-'  +-AUXILIARY-+   
                                              '-MAIN------'   

>--+--------------+--+-------------------+---------------------->
   +-RECOVERABLE--+  '-MAXITEMLEN(value)-'   
   '-NOTRECOVABLE-'                          

>--+-------------------+--+----------------+-------------------><
   '-MINITEMLEN(value)-'  '-TRANSID(value)-'   

Displayed fields

Start of changeEXPIRYINT(value) End of change
Start of change Displays the expiry interval, in hours, that is defined for the temporary storage queue in its TSMODEL resource definition. If the temporary storage queue is not referenced during the expiry interval, it becomes eligible to be deleted automatically by CICS.
A value of zero means that no expiry interval applies to the temporary storage queue, so it is never eligible for automatic deletion. In addition, the following types of temporary storage queues are never deleted automatically by CICS, even if a nonzero expiry interval is set in the matching TSMODEL resource definition:
  • Queues in auxiliary temporary storage that are defined as recoverable.
  • Queues in a remote CICS region.
  • Queues that CICS creates for its own use.
  • Temporary storage queues in shared temporary storage pools.
End of change
LASTUSEDINT(value)
Displays the elapsed time interval in binary seconds since the queue was last referenced.
LENGTH(value)
Displays the total length in bytes of all the items in the temporary storage queue.
The length of a queue item is the sum of the length of the user data plus 8 bytes for header information, rounded up.
  • For main temporary storage, the length is rounded up to the boundary of the MVS storage subpool used to store it.
  • For auxiliary temporary storage, the length is rounded to the next highest multiple of either 64 or 128. The control interval size of the temporary storage data set determines which is chosen. See Control interval size for auxiliary temporary storage.
  • For shared queues, the lengths returned in MINITEMLEN, MAXITEMLEN, and FLENGTH, reflect the data length stored in the coupling facility. The data length includes any item control information, which consists of a 2-byte length prefix for each item.

For all types of queue, the maximum value returned is capped at 32767 (X'7FFF').

LOCATION
Displays where the temporary storage queue resides. The values are as follows:
AUXILIARY
The temporary storage queue is held in auxiliary temporary storage (the VSAM data set DFHTEMP), or in temporary storage pools in the coupling facility.
MAIN
The temporary storage queue is held in main storage.
MAXITEMLEN(value)
Displays the length in bytes of the largest item in the temporary storage queue.
The length of a queue item is the sum of the length of the user data plus 8 bytes for header information, rounded up.
  • For main temporary storage, the length is rounded up to the boundary of the MVS storage subpool used to store it.
  • For auxiliary temporary storage, the length is rounded to the next highest multiple of either 64 or 128. The control interval size of the temporary storage data set determines which is chosen. See Control interval size for auxiliary temporary storage.
  • For shared queues, the lengths returned in MINITEMLEN, MAXITEMLEN, and FLENGTH, reflect the data length stored in the coupling facility. The data length includes any item control information, which consists of a 2-byte length prefix for each item.

For all types of queue, the maximum value returned is capped at 32767 (X'7FFF').

MINITEMLEN(value)
Displays the length in bytes of the smallest item in the temporary storage queue.
The length of a queue item is the sum of the length of the user data plus 8 bytes for header information, rounded up.
  • For main temporary storage, the length is rounded up to the boundary of the MVS storage subpool used to store it.
  • For auxiliary temporary storage, the length is rounded to the next highest multiple of either 64 or 128. The control interval size of the temporary storage data set determines which is chosen. See Control interval size for auxiliary temporary storage.
  • For shared queues, the lengths returned in MINITEMLEN, MAXITEMLEN, and FLENGTH, reflect the data length stored in the coupling facility. The data length includes any item control information, which consists of a 2-byte length prefix for each item.

For all types of queue, the maximum value returned is capped at 32767 (X'7FFF').

NUMITEMS(value)
Displays the number of items in the temporary storage queue.
RECOVSTATUS
Displays the recovery status of the temporary storage queue. The values are as follows:
RECOVERABLE
The temporary storage queue is recoverable.
NOTRECOVABLE
The temporary storage queue is not recoverable.
TRANSID(value)
Displays the 4-character ID of the transaction that created the TS queue.
TSQUEUE(value)
Indicates that this panel relates to a TSQUEUE inquiry and displays the 16-character name of a temporary storage queue.
Note: Characters that cannot be displayed appear as periods. You can use PF2 on the expanded panel to see the value in hexadecimal.

Reference Reference

Feedback


Timestamp icon Last updated: Saturday, 7 April 2018


http://publib.boulder.ibm.com/infocenter/cicsts/v4r2/topic/com.ibm.cics.ts.systemprogramming.doc//com.ibm.cics.ts.systemprogramming.doc/transactions/cemt/dfha7mo.html