INQUIRE DB2ENTRY

Returns the attributes of the DB2ENTRY that defines resources to be used by a specific transaction or by a group of transactions when accessing DB2.

Read syntax diagramSkip visual syntax diagramINQUIRE DB2ENTRY
 
>>-INQUIRE DB2ENTRY(data-value)--ACCOUNTREC(cvda)--------------->
 
>--+-------------------+--AUTHTYPE(cvda)--DISABLEDACT(cvda)----->
   '-AUTHID(data-area)-'
 
>--DROLLBACK(cvda)--ENABLESTATUS(cvda)--+-----------------+----->
                                        '-PLAN(data-area)-'
 
>--+-------------------------+--PRIORITY(cvda)------------------>
   '-PLANEXITNAME(data-area)-'
 
>--+-----------------------+--+---------------------+----------->
   '-PROTECTNUM(data-area)-'  '-PTHREADS(data-area)-'
 
>--+------------------------+--+--------------------+----------->
   '-THREADLIMIT(data-area)-'  '-THREADS(data-area)-'
 
>--THREADWAIT(cvda)--------------------------------------------><
 

Conditions: END,ILLOGIC,NOTAUTH, NOTFND

This command is threadsafe.

Description

The entry is identified by the name it was defined with in the CSD by the DEFINE DB2ENTRY command. For RCTs migrated to the CSD, it is identified by the name of the first transaction on the DSNCRCT TYPE=ENTRY statement unless the RDONAME parameter has been specified.

Browsing

You can also browse through all of the DB2ENTRYs installed in a CICS region by using the browse options (START, NEXT, and END) on INQUIRE DB2ENTRY commands. See Browsing resource definitions for general information about browsing, including syntax, exception conditions, and examples.

Options

ACCOUNTREC
returns the minimum amount of DB2 accounting required for transactions using this DB2ENTRY. The specified minimum may be exceeded, as described in the following options. CVDA values are:
UOW
The CICS DB2 attachment facility causes an accounting to be produced by DB2 for each UOW, assuming that the thread is released at the end of the UOW.
TASK
The CICS DB2 attachment facility causes a minimum of one accounting record to be produced by DB2 for each CICS task.

A transaction containing multiple UOWs may use a different thread for each UOW (assuming the thread is released at syncpoint). The result may be the production of an accounting record for each UOW. For example, an accounting record is produced if a thread terminates after being released, or if a thread is reused but the primary AUTHID is changed.

TXID
The CICS DB2 attachment facility causes an accounting record to be produced by DB2 when the transid using the thread changes.

This option applies to DB2ENTRYs that are used by more than one transaction ID. As threads are typically released at syncpoint, a transaction containing multiple UOWs may use a different thread for each UOW. The result may be that an accounting record is produced for each UOW. For example, an accounting record is produced if a thread terminates after being released, or if a thread is reused but the primary AUTHID is changed.

NONE
No accounting records are required for transactions using threads from this DB2ENTRY.

DB2 produces. however, at least one accounting record per thread when the thread is terminated. Additionally, authorization changes cause accounting records to be produced.

AUTHID
returns an id to be used for security checking for threads on this DB2ENTRY. If an AUTHId is returned, AUTHType is not applicable.
AUTHTYPE
returns the type of id to be used for security checking for threads on this DB2ENTRY. If an AUTHType is returned, AUTHid is blank. CVDA values are:
GROUP
The 8-character userid and the connected group name are used as the authorization ID. The following table shows how these two values are interpreted by DB2.
IDs passed to DB2 How DB2 interprets values
CICS sign-on user ID (USERID) Represents the primary DB2 authorization ID.
RACF-connected group name If the RACF list of group options is not active, then DB2 uses the connected group name supplied by the CICS attachment facility as the secondary DB2 authorization ID. If the RACF list of group options is active, DB2 ignores the connected group name supplied by the CICS attachment facility, but the value appears in the DB2 list of secondary DB2 authorization IDs.

If no RACF group ID is available for this USERID, then an 8-character field of blanks is passed to DB2 as the group ID.

SIGN
The SIGNID parameter of the DB2CONN is used as the resource authorization ID.
TERM
The terminal identification (four characters padded to eight) is used as an authorization ID. An authorization ID cannot be obtained in this manner if a terminal is not connected with the transaction.

If a transaction is started (using a CICS command) and has no terminal associated with it, AUTHTYPE(TERM) should not be used.

TX
The transaction identification (four characters padded to eight) is used as the authorization ID.
OPID
The operator identification associated with the userid that is associated with the CICS transaction is used as the authorization ID (three characters padded to eight).
USERID
The 8-character USERID associated with the CICS transaction is used as the authorization ID.

When the DB2 sample sign-on exit DSN3@.SGN is used with AUTHTYPE(USERID), the exit sends the USERID to DB2 as the primary authorization ID and the RACF group ID to DB2 as the secondary ID. When the sample sign-on exit is used, there is no difference between AUTHTYPE(USERID) and AUTHTYPE(GROUP).

DISABLEDACT
returns what CICS is to do with new transactions accessing the DB2ENTRY when it has been disabled or disabling. If DISABLEDACT is not specified, and DB2ENTRY is disabled, new requests are routed to the pool by default. CVDA values are:
POOL
The CICS DB2 attachment facility routes the request to the pool. Message DFHDB2072 is sent to the transient data destination specified by MSGQUEUEn on the DB2CONN for each transaction routed to the pool.
ABEND
The CICS DB2 attachment facility abends the transaction.The abend code is AD26.
SQLCODE
An SQLCODE is returned to the application indicating that the DB2ENTRY is disabled.
DROLLBACK
returns whether or not the CICS DB2 attachment should initiate a SYNCPOINT rollback in the event of a transaction being selected as victim of a deadlock resolution. CVDA values are:
ROLLBACK
The attachment facility issues a sync point rollback before returning control to the application. An SQL return code of -911 is returned to the program.
NOROLLBACK
The attachment facility is not to initiate a rollback for this transaction. An SQL return code of -913 is returned to the application.
ENABLESTATUS
returns a cvda indicating whether the DB2ENTRY can be accessed by applications. CVDA values are:
ENABLED
The DB2ENTRY can be accessed by applications. DB2ENTRY is installed in an ENABLED state.
DISABLED
The DB2ENTRY cannot be accessed by applications.
DISABLING
The DB2ENTRY is in the process of being disabled. New transactions cannot access the DB2ENTRY. Existing transactions using the DB2ENTRY are allowed to complete unless the DB2ENTRY is being disabled with the FORCE option.
PLAN
returns the name of the plan to be used for this DB2ENTRY. If PLAN is returned, PLANEXITNAME is blank.
PLANEXITNAME
returns the name of the dynamic plan exit (if any) to be used for this DB2ENTRY. If PLANEXITname is returned, PLAN is blank.
PRIORITY
returns the priority of the thread TCBs for this DB2ENTRY relative to the CICS main TCB (QR TCB). If CICS is connected to DB2 Version 6 or later, the thread TCBs are CICS open L8 TCBs. If CICS is connected to DB2 Version 5 or earlier, the thread TCBs are private TCBs created by the CICS-DB2 Attachment Facility. CVDA values are:
HIGH
Thread TCBs have a higher priority than the CICS QR TCB.
EQUAL
Thread TCBs have equal priority with the CICS QR TCB.
LOW
Thread TCBs have a lower priority than the CICS QR TCB.
PROTECTNUM
returns the maximum number of protected threads allowed for this DB2ENTRY.
PTHREADS
returns the current number of protected threads for this DB2ENTRY. A protected thread is an inactive thread available for reuse by a new transaction. If no transaction has reused the thread by the time it has been processed by 2 purge cycles, the thread is terminated.
THREADS
returns the current number of threads active for this DB2ENTRY.
THREADLIMIT
returns the current maximum number of threads for this DB2ENTRY that the CICS DB2 attachment allows active before requests are made to wait, overflow to the pool, or are rejected (see THREADWait).
THREADWAIT
returns whether or not transactions should wait for a DB2ENTRY thread be abended, or overflow to the pool if the number of active DB2ENTRY threads reach the Threadlimit number. CVDA values are:
TWAIT
If all threads are busy, a transaction waits until one becomes available.
NOTWAIT
If any threads are busy, a transaction is terminated with an abend code AD2P.
TPOOL
If all threads are busy, a transaction is diverted to use a pool thread. If the pool is also busy, and NOTWAIT has been specified for the THREADWAIT parameter on the DB2CONN, the transaction is terminated with an abend code AD3T.

Conditions

NOTFND
RESP2 values:
1
The DB2ENTRY cannot be found.
NOTAUTH
RESP2 values:
100
Command authorization failure
101
Resource authorization failure
[[ Contents Previous Page | Next Page Index ]]