Writing a CICS-DBCTL interface status program

Considerations common to all user-replaceable programs

Note that the comments contained in General notes about user-replaceable programs apply to this section.

The CICS®-DBCTL interface status program DFHDBUEX is a user-replaceable program forming part of the support for the CICS-DBCTL interface. It is designed to invoke user-supplied code whenever CICS successfully connects to or disconnects from DBCTL. It runs in a CICS application environment and is driven at specific points to allow you to enable and disable your CICS-DL/I transactions when the CICS-DBCTL interface initializes or terminates.

DFHDBUEX is invoked in the following case for the ENABLE command:

DFHDBUEX is invoked in the following cases for the DISABLE command:

Input to DFHDBUEX is by means of a communication area addressed by DFHEICAP. The layout of the communication area is shown in Figure 54.

Figure 54. The DFHDBUEX communication area
DBUSHEAD    DS      OCL4              Standard Header
DBUREQT     DS      CL1               Function Code
DBUCOMP     DS      CL2               Component Code         Always "DB"
DBURESV     DS      CL1               Reserved
DBUREAS     DS      CL1               Reason for disconnection
DBUSUFF     DS      CL2               DRA startup table suffix
DBUDBCTL    DS      CL4               DBCTL identifier

The parameter list contains the following information:

DBUREQT
Request Type. The function code has one of the following values:
DBUCONN (X'01')
Connected
DBUDISC (X'02')
Disconnected.
DBUREAS
Reason for Disconnection. Contains flags:
DBUMENU (X'01')
Disconnected from menu
DBUDBCC (X'02')
Checkpoint Freeze input to DBCTL
DBUDRAF (X'03')
DRA Failure has taken place
DBUDBCF (X'04')
DBCTL Failure has taken place.
DBUSUFF
DRA startup table suffix.
DBUDBCTL
DBCTL identifier.

Related tasks
Rewriting user-replaceable programs
Assembling and link-editing user-replaceable programs
Related reference
The sample CICS-DBCTL interface status program

14.
The interface that enables DBCTL databases to be accessed from CICS.

[[ Contents Previous Page | Next Page Index ]]