Transaction Routing › Directory Services DLL Functions

Directory Services DLL Functions

The Directory Services user exit DLL contains three functions that interface with the Client Manager. The functions, their descriptions, and the arguments passed are:

1. IEFDP_InitDir—Initializes any processes used by the sample Directory Services user exit. This function is called once and is the first Directory Services function called by Client Manager during execution initialization. The IEFDP_InitDir() reads in transaction codes and target server names in pairs from the transaction file (.TRN) and inserts them into a binary tree.
   • The Client Manager passes an argument that contains the name of the Client Manager's initialization file ( iefcmn.ini by default). The name of the transaction file is extracted from this initialization file. The transaction file name is defined within the Client Managers File - Setup dialog by setting the Dir. Svc. Input File parameter to name the appropriate file.
   • IEFDP_InitDir() returns a return code value to the Client Manager.
     • If the function returns a value of zero (0) to the Client Manager, the Client Manager assumes that the initialization is either successful or that the transaction file name specified in the initialization file has been found and successfully processed.
     • If the function returns a non-zero value to the Client Manager, the Client Manager assumes that the Directory Services capability is not available and sets the Directory Services Status to unavailable. Consult the Client Manager log file for possible causes of the failure.

   The supplied sample transaction file, IEFDIR.TRN, must be modified to include the names of all application transactions and configured server names that are to take advantage of transaction routing.

   Note: NEXTLOCATION does not use the IEFDIR.TRN file. However, the sample IEFDP_InitDir() returns an error message if no input file exists. Thus, the sample exit requires a file with dummy data or other trancode/server name pairs being used when NEXTLOCATION is not set.

2. IEFDP_SearchDir—Processes an inquiry and returns a target server name to the Client Manager.
   • The Client Manager passes to IEFDP_SearchDir() a single argument that contains two NULL-terminated strings, transaction code and NEXTLOCATION data.
     • Using NEXTLOCATION Data—If data is provided in NEXTLOCATION, the sample implementation of IEFDP_SearchDir() assumes that NEXTLOCATION contains a 16-byte target server name and IEFDP_SearchDir() returns this value as the target server name.
     • Using Transaction Code—If data is not provided in NEXTLOCATION, the sample implementation of IEFDP_SearchDir() enforces a one-to-one mapping between the transaction code and a target server by performing a binary search of the data previously loaded from the sample transaction file (IEFDIR.TRN), using the transaction code as the key field.
   • If an appropriate target server match cannot be found, the sample implementation of IEFDP_SearchDir() returns a NULL value to the Client Manager indicating a server name could not be found. Otherwise, the corresponding target server name is returned.

     Note: Any value returned by IEFDP_SearchDir() needs to be defined as a target server within the Client Manager configuration in order to properly complete the routing of transactions to the selected target server.

3. IEFDP_CleanupDir—Provides the opportunity to perform any exit activities. This function is called at the termination of the Client Manager.

   No arguments are passed.

More information:

User Exits