Table 20-1, Table 20-2 on page 353, and Table 20-3 on page 358 list most IMS exit routines and briefly describe what the exit routines can be used for.
Table 20-1. IMS Database Manager Exit Routines and Their Uses
Exit Routine Name | Description |
|---|
Data Capture exit routine | Receives control whenever a segment for which the exit routine is defined is updated. Possible use is to enable replication of that data to a DB2 database. |
Data Conversion User exit routine (DFSDBUX1) | Receives control at the beginning of a DL/I call and at the end of the call. In the exit routine, you can modify segment search arguments, the key feedback area, the I/O area, and the status code. |
Data Entry Database Randomizing routine (DBFHDC40/ DBFHDC44) | Required for placing root segments in or retrieving them from a DEDB. |
Data Entry Database Resource Name Hash routine (DBFLHSH0) | Used with the IRLM and enables IMS and DBCTL to maintain and retrieve information about the control intervals (CIs) used by sharing subsystems. |
Data Entry Database Sequential Dependent Scan Utility exit routine (DBFUMSE1) | Allows you to copy and process a subset of the number of segments that the utility scans at a particular time. |
HALDB Partition Selection exit routine (DFSPSE00) | Used to select partitions by some criteria other than high key. |
HDAM and PHDAM Randomizing routines (DFSHDC40) | Required routine for HDAM and PHDAM access methods for placing root segments in, or retrieving them from, HDAM or PHDAM databases. |
Secondary Index Database Maintenance exit routine | Used to selectively suppress secondary indexing. |
Segment Edit/Compression exit routine (DFSCMPX0) | Used to compress and expand segments of data. |
Sequential Buffering Initialization exit routine (DFSSBUX0) | Used to dynamically control the use of sequential buffering (SB) for online and batch IMS subsystems, as well as DBCTL. |
Table 20-2. IMS Transaction Manager Exit Routines and Their Uses
Exit Routine Name | Description |
|---|
Build Security Environment exit routine (DFSBSEX0) | Tells IMS whether or not to build the RACF or equivalent security environment in an IMS dependent region for an application that has received its input message from neither OTMA nor an LU 6.2 device. |
Conversational Abnormal Termination exit routine (DFSCONE0) | Used to clean up, if required, when a conversation is terminated prematurely. |
Fast Path Input Edit/Routing exit routine (DBFHAGU0) | Used to determine the eligibility of an incoming message for Fast Path processing. |
Front-End Switch exit routine (DFSFEBJ0) | Allows you to keep the input terminal in response mode while it is waiting for the reply from the processing system for messages entered in an IMS system by a front-end switchable VTAM node and processed in another system (such as IMS or CICS). |
Global Physical Terminal (Input) edit routine (DFSGPIX0) | Message segments are passed one at a time to this edit routine so that the routine can process the segments in one of the following ways: Accept the segment and release it for further editing by the IMS basic edit function. Modify the segment (for example, change the transaction code or reformat the message text) and release it for further editing by the IMS basic edit function. Cancel the segment. Cancel the message and request that IMS send a corresponding message to the terminal operator. Cancel the message and request that IMS send a specific message from the user message table to the terminal operator.
|
Greeting Messages exit routine (DFSGMSG0) | Allows you to tailor how IMS handles messages issued during the logon and signon process. |
IMS Adapter for REXX exit routine (DFSREXXU) | Has the ability to: Override the EXEC name to be executed. This name defaults to the IMS program name. Choose not to execute any EXEC and have the IMS adapter for REXX return to IMS. Issue DL/I calls using the AIB interface as part of its logic in determining what EXEC to execute. Set REXX variables (through the TSO/E IRXEXCOM variable access routine) before the EXEC starts. Extract REXX variables (through IRXEXCOM) after the EXEC ends. Change the initial default IMSRXTRC tracing level.
|
Initialization exit routine (DFSINTX0) | Used to create two user data areas that can be used by some of your installation's exit routines. |
Input Message Field edit routine (DFSME000) | Used to perform common editing functions such as numeric validation or conversion of blanks to numeric zeros. |
Input Message Segment edit routine (DFSME127) | Used to perform common editing functions such as numeric validation or conversion of blanks to numeric zeros. |
Logoff exit routine (DFSLGFX0) | Used to perform processing that complements the Logon exit routine (DFSLGNX0). |
Logon exit routine (DFSLGNX0) | Enables you to control the way logons are processed. |
LU 6.2 Edit exit routine (DFSLUEE0) | Enables you to edit input and output LU 6.2 messages for IMS-managed LU 6.2 conversations. |
Message Control/Error exit routine (DFSCMUX0) | Used to control transactions, responses, and message switches that are in error. |
Message Switching (Input) edit routine (DFSCNTE0) | Similar to the Transaction Code Input edit routine and is capable of message switching. |
Non-Discardable Messages exit routine (DFSNDMX0) | Tells IMS what to do with the input message that is associated with an abended application program. |
OTMA Destination Resolution exit routine (DFSYDRU0) | Determines and changes the final destination of OTMA member names or Tpipe names that are used for OTMA asynchronous output messages. |
OTMA Input/Output Edit exit routine (DFSYIOE0) | Modifies or cancels OTMA input and output messages. |
OTMA Prerouting exit routine (DFSYPRX0) | Determines whether an asynchronous output message needs to be routed to an OTMA destination or a non-OTMA destination. |
Output Creation exit routine (DFSINSX0) | Validates both an unknown destination for a message and the creation of an unknown user. |
Physical Terminal Input edit routine (DFSPIXT0) | Message segments are passed one at a time to the Physical Terminal Input edit routine, and the edit routine can handle them in one of the following ways: Accept the segment and release it for further editing by the IMS basic edit function. Modify the segment and release it for further editing by the IMS basic edit function. Cancel the segment. Cancel the message and request that the terminal operator be notified accordingly. Cancel the message and request that a specific message from the user message table be sent to the terminal operator.
|
Physical Terminal Output edit routine (DFSCTTO0) | Edits output messages immediately before they are sent to a terminal. |
Queue Space Notification exit routine (DFSQSPC0/DFSQSSP0) | This exit routine is activated when a logical record is assigned to or released from a message queue data set. This routine causes a message to be issued when one of the following situations occurs: The number of records currently in use exceeds the upper threshold percentage value of the maximum number assignable before initiation of automatic shutdown. The number of records currently in use falls below the lower threshold percentage value of the same maximum.
|
Security Reverification exit routine (DFSCTSE0) | Reevaluates transaction authorization checking on the DL/I CHNG Call. |
Shared Printer exit routine (DFSSIML0) | Decides whether a terminal that is unavailable can be automatically acquired by IMS or an AOI application program. |
Sign-On exit routine (DFSSGNX0) | Used for signon processing if ETO=Y is specified. |
Signoff exit routine (DFSSGFX0) | Used for signoff processing. |
Sign On/Off Security exit routine (DFSCSGN0) | Verifies a user's ID and password. This exit routine can conflict with the Sign-On exit routine (DFSSGNX0). |
Time-Controlled Operations (TCO) exit routine (DFSTXIT0) | Inserts messages that are the commands, transactions, and message switches that you specify in the time schedule requests and message sets that make up a script member. |
TM and MSC Message Routing and Control User exit routine (DFSMSCE0) | Provides maximum routing control for TM and MSC messages. Eases TM and MSC coding and maintenance requirements, and reduces the number of exit modules. Supports a consistent set of routing capabilities across all of the exit entry points (or functions). Provides a common parameter list interface and linkage interface to the various entry points (or functions). Provides the ability to append an optional user prefix segment to TM and MSC messages which TM and MSC user exit routines can use to communicate and control user-customized routing needs. Logs routing errors and footprints in the message to indicate those exit routines that reroute the message.
|
Transaction Authorization exit routine (DFSCTRN0) | Works with the Security Reverification exit routine (DFSCTSE0) and the Sign On/Off Security exit routine (DFSCSGN0) to check an individual user ID for authority to use a transaction. |
Transaction Code (Input) edit routine (DFSCSMB0) | Used to edit input messages before they are enqueued for scheduling. |
Type 1 Automated Operator exit routine (DFSAOUE0) | This AO exit routine is called continuously for system messages destined for the master terminal, operator-entered commands, and command responses. Use it to: Ignore selected segments or an entire message. Send a copy of a system message, command, or command response to an alternate destination. Send a new message to an alternate destination for a system message, command, or command response. Change a system message. Change a system message and send a copy to an alternate destination. Change a copy of a command or command response and send the copy to an alternate destination. Delete a system message. Delete a system message and send a copy to an alternate destination. Request the edited command buffer (when the input is a command).
|
2972/2980 Input edit routine (DFS29800) | Required to perform terminal-related functions inherent in the design of the 2972/2980 General Banking Terminal system. |
4701 Transaction Input edit routine (DFS36010) | Appends a blank and the 8-byte node name to a transaction input message. |
Table 20-3. IMS System Exit Routines and Their Uses
Exit Routine Name | Description |
|---|
Application Group Name (AGN) exit routine (DFSISIS0) | Provides users without RACF a mechanism for checking authorization to IMS application group names (AGNs). Recommendation: Use the Resource Access Security exit routine (DFSRAS00) instead of this exit routine for AGNs. |
Buffer Size Specification Facility (DSPBUFFS) | Allows you to control the number of buffers used for RECON data sets when either the local shared resource (LSR) or the nonshared resource (NSR) buffering option is used. |
Command Authorization exit routine (DFSCCMD0) | Verifies the authority of a command that is issued from a particular origin. |
DBRC Command Authorization exit routine (DSPDCAX0) | Determines (in conjunction with RACF or another security product) the success or failure of DBRC command authorization. |
Dependent Region Preinitialization Routines | Dependent Region Preinitialization routines enable you to perform any application-unique dependent region initialization. |
Dump Override Table (DFSFDOT0) | Either forces or suppresses dumps for specified abends. |
ESAF Indoubt Notification exit routine (DFSFIDN0) | Resolves in-doubt work before restarting a failed IMS. |
IMS Command Language Modification Facility (DFSCKWD0) | Modifies the command keyword table. |
Large SYSGEN Sort/Split Input exit routine (DFSSS050) | Alters the resource data for user-generated resources. |
Large SYSGEN Sort/Split Output exit routine (DFSSS060) | Alters the resource data for user-generated resources. |
Log Archive exit routine | Produces an edited subset of the complete IMS log. |
Log Filter exit routine (DFSFTFX0) | Controls the amount of log data sent to an RSR tracking subsystem, by acting as a filter. |
Logger exit routine (DFSFLGX0) | Processes log data for recovery purposes. |
Partner Product exit routine (DFSPPUE0) | Initializes products that run with IMS. |
RECON I/O exit routine (DSPCEXT0) | Tracks changes to the RECON data set, which you can log in a journal. |
Resource Access Security exit routine (DFSRAS00) | Authorizes IMS resources such as transactions, PSBs, or output LTERM names. Recommendation: Use this exit routine instead of the Application Group Name exit routine (DFSISIS0) for AGNs. |
SCI Registration exit routine (DSPSCIX0) | Used by DBRC to perform an authorization check before allowing a potential SCI client to register with SCI. |
System Definition Preprocessor exit routine (Input Phase) (DFSPRE60) | Alters, inserts, or deletes data from stage 1 input before the preprocessor record scan occurs. |
System Definition Preprocessor exit routine (Name Check Complete) (DFSPRE70) | Builds tables that contain resource names that have been cross-checked. |
Type 2 Automated Operator exit routine (DFSAOE00) | Modifies the text of IMS system messages. Deletes IMS system messages. Directs any message, command, or command response to an Automated Operator (AO) application. Starts a BMP job (for example, an AO application).
|
User Message Table (DFSCMTU0) | Used to create your own messages and list them in your own message table. |
