Installing the ADABAS Interface in CMS

This section describes how to install the ADABAS Interface in the CMS environment. The ADABAS Interface is distributed in ready-to-execute form. The installation requires only a tape-to-disk load and a copy step to move the components to the appropriate libraries.

The installation process consists of the following basic tasks:

1. Prepare the ADABAS Interface load libraries.

2. Create the ADAUSER TEXT file.

3. Access the ADABAS nucleus.

4. Install AUTOADBS.

5. Test the ADABAS Interface installation.

Preparing the ADABAS Interface Load Libraries

The ADABAS Interface is distributed on the same tape/cartridge as the standard FOCUS product. The necessary ADABAS Interface load libraries, ADABAS Interface error message files, and AUTOADBS files are copied (during the COPYFS step) to the FOCUS production disk when FOCUS for CMS is installed.

If you have not completed the standard FOCUS installation, do it now before continuing.

FOCUS must be installed and fully operational. If it is not, contact your FOCUS database administrator or consult the appropriate FOCUS installation guide for instructions.

Creating the ADAUSER TEXT File

To establish communication with the ADABAS nucleus, standard FOCUS requires an ADABAS file named ADAUSER TEXT. To create ADAUSER TEXT, you need access to the following files and libraries:

• The Software AG source file ADAUSER ASSEMBLE. This file usually resides on the disk of the ADABAS database administrator.
• Macro libraries (for example, DMSGPI MACLIB, HCPGPI MACLIB, OSPSI MACLIB). If you are unsure which macro libraries are required at your site, ask your CMS systems staff.
• The Software AG macro library. The naming convention is usually

ADAVxxx MACLIB

where:

xxx

Is the ADABAS version number (for example, ADAV524 MACLIB for ADABAS version 5.2.4).

Perform these steps to create the ADAUSER TEXT file and copy it to the FOCUS production disk:

1. From the CMS Ready prompt, specify the search order of the macro libraries with the CMS GLOBAL command:

   GLOBAL MACLIB DMSGPI ADAVxxx HCPGPI OSPSI

2. Assemble the ADAUSER TEXT file:

   ASSEMBLE ADAUSER

This command creates the ADAUSER TEXT file on your A disk. Consult your CMS systems staff if any errors occur.

3. Copy the ADAUSER TEXT file to the FOCUS production disk. If a file already exists, replace it.

Accessing the ADABAS Nucleus

To establish a link between your CMS FOCUS machine and the ADABAS nucleus, execute NUCXTNTS EXEC. This EXEC usually resides on the disk of the ADABAS database administrator. Supplied by Software AG, it provides ADABAS access from your programs in CMS. From the CMS Ready prompt, enter:

EX NUCXTNTS

You must execute the EXEC once per CMS session. Include this command in a PROFILE or in the EXEC that is used to call FOCUS. For global access, copy the NUCXTNTS EXEC to the FOCUS production minidisk.

Installing AUTOADBS for CMS

The ADABAS Interface is distributed with an automated procedure that simplifies the process of describing ADABAS files to FOCUS. It is a full-screen procedure named AUTOADBS. AUTOADBS generates MASTER and Access Files for specified ADABAS files by using the file information stored in the Predict dictionary. For instructions on how to use AUTOADBS, see The AUTOADBS Facility.

The files used by AUTOADBS are automatically copied to the FOCUS production disk; however, you may need to edit these files to conform to your site requirements.

The AUTOADBS installation process consists of the following tasks:

1. Determine which Predict dictionaries require access and create menu selection choices.

2. Edit the Access Files PREDDB FOCADBS and PREDEL FOCADBS.

Note: You can assign the filetype ACCESS to your Access Files. In this appendix, we use the term FOCADBS to refer to either FOCADBS or ACCESS, depending on the name chosen at your site.

3. Determine the value for the CALLTYPE attribute.

4. Decide whether the SEQFIELD attribute is optional or required.

Determining Which Predict Dictionaries Require Access

If you have only one Predict dictionary to use as a source for FOCUS file descriptions, skip this section and continue with the next task of editing the database number (DBNO) and file number (FILENO).

In order for AUTOADBS to access several Predict dictionaries concurrently, you must do the following:

1. Determine which Predict dictionaries need to be accessed and create menu selection choices. For each dictionary, select a one-character identifier. This value uniquely identifies the dictionary for reporting purposes and is displayed on the Main Menu of AUTOADBS. Select a letter A through Z, a number 0 through 9, or blank for the identifier.

For example, if you have a test and production Predict dictionary, you might select T and P as the identifiers.

2. For each menu identifier, copy and rename the following files. For each filename, the suffix n represents the identifier.

From:	To:
PREDDB MASTER	PREDDBn MASTER
PREDEL MASTER	PREDELn MASTER
PREDDB FOCADBS	PREDDBn FOCADBS
PREDEL FOCADBS	PREDELn FOCADBS

3. Edit AUTOADBS FOCEXEC to include all the menu identifiers. Locate the line that reads

   DEFAULT &DICT_FILES=' '

and replace the blank value with the identifier.

You can have more than one character. In that case, the first character is used as the default dictionary on the AUTOADBS Main Menu. For example, if you choose P and T as your identifiers and the production dictionary is the default, the line reads:

DEFAULT &DICT_FILES='PT'

Note: The characters must be entered in uppercase.

Editing the PREDDB and PREDEL Access Files

Edit the Access Files named PREDDB FOCADBS and PREDEL FOCADBS. If you have several Predict dictionaries with associated identifiers, repeat these steps for all of the PREDDB and PREDEL Access Files created in the section, Determining Which Predict Dictionaries Require Access, in Installing AUTOADBS for CMS.

1. Update the ADABAS database number and file number for the Predict dictionary in each Access File. Locate the attributes DBNO=001 and FILENO=012 and change these values to the actual values for your site's Predict dictionary. You must change one occurrence in the file PREDDB and all three occurrences in the file PREDEL.

   $ FILENAME=PREDDB,SUFFIX=ADBSINX,$
   RELEASE=6,OPEN=YES,$ 
   $ ADABAS FILE = SYSDIC
   SEGNAM=S02   ,ACCESS=ADBS,DBNO=001,FILENO=012,
                 CALLTYPE=RL,SEQFIELD=FILE_REC,
                 KEYFLD=FILE_ELEMENT,
                 IXFLD=FILE_REC
    FIELD=FILE_REC                          ,TYPE=NOP,$

$ FILENAME=PREDEL,SUFFIX=ADBSINX,$
$ ADABAS FILE = SYSDIC
RELEASE=6,OPEN=YES,$ 
SEGNAM=S03   ,ACCESS=ADBS,DBNO=001,FILENO=012,
              CALLTYPE=RL,SEQFIELD=FIELD_SEQ,$
 FIELD= FIELD_SEQ                           ,TYPE=SPR,$
  FIELD=FILE_NAME_EL                        ,TYPE=   ,NU=NO,$
  FIELD=FIELD_SEQUEN                        ,TYPE=DSC,NU=NO,$
SEGNAM=BD0103,ACCESS=MU  ,DBNO=001,FILENO=012,$ COMMENTS
SEGNAM=BQ0603,ACCESS=MU  ,DBNO=001,FILENO=012,$ DERIVATION_GROUP

2. If your Predict dictionaries are password-protected, you must insert the password value in each member. Add the PASSWORD attribute after all three occurrences of the FILENO attribute in each member.

The PASSWORD attribute with the value ADADBA is included in the following sample PREDEL Access File:

$ FILENAME=PREDEL,SUFFIX=ADBSINX,$
$ ADABAS FILE = SYSDIC
RELEASE=6,OPEN=YES,$ 
SEGNAM=S03   ,ACCESS=ADBS,DBNO=001,FILENO=012,PASSWORD=ADADBA,
              CALLTYPE=RL,SEQFIELD=FIELD_SEQ,$
 FIELD= FIELD_SEQ                           ,TYPE=SPR,$
  FIELD=FILE_NAME_EL                        ,TYPE=   ,NU=NO,$
  FIELD=FIELD_SEQUEN                        ,TYPE=DSC,NU=NO,$
SEGNAM=BD0103,ACCESS=MU  ,DBNO=001,FILENO=012,PASSWORD=ADADBA,$ COMMENTS
SEGNAM=BQ0603,ACCESS=MU  ,DBNO=001,FILENO=012,PASSWORD=ADADBA,$

Determining the CALLTYPE Value

Determine how AUTOADBS treats the CALLTYPE value you supply. The CALLTYPE attribute appears in all generated Access Files. Its value indicates whether the ADABAS Interface needs to construct Read Logical (RL) or FIND calls for retrieval. You have two choices:

• By default, AUTOADBS assigns RL. Override this default by entering FIND for the CALLTYPE value.
• If you do not want users to change the CALLTYPE value to FIND, restrict the acceptable value to RL. Edit the AUTOADBS FOCEXEC and locate the line that reads:

DEFAULT &REQ_RL=NO

Change NO to YES. AUTOADBS will then accept only the RL value.

Deciding Whether the SEQFIELD Attribute Is Optional or Required

We recommend using the SEQFIELD option. This field (an index) is used when there are no IF or WHERE clauses in the report request. This option avoids an L2 call (Read Physical) through the entire database. Using the index is more efficient in most cases.

Determine if AUTOADBS requires the SEQFIELD value. The SEQFIELD attribute is specified to use an ADABAS descriptor or superdescriptor's inverted list for retrieval by default. You have two choices:

• By default, AUTOADBS requires a value for the SEQFIELD attribute. If you accept the default, the user must enter a SEQFIELD value for each ADABAS file when running AUTOADBS. The value will be included in the generated Access File.
• You can change the default to make the SEQFIELD value optional. To do so, edit the AUTOADBS FOCEXEC and locate the line that reads:

DEFAULT &REQ_SEQFIELD=YES

Change YES to NO. If the user chooses to specify a SEQFIELD value when running AUTOADBS, AUTOADBS will include the value in the generated Access File. However, a value is not required.

Testing the ADABAS Interface Installation

After you copy the appropriate ADABAS Interface load libraries and ADAUSER TEXT to the FOCUS minidisk and execute the NUCXTNTS EXEC from CMS, test the ADABAS Interface installation:

1. Enter the FOCUS session by typing

   FOCUS

at the CMS Ready prompt.

2. Enter the following simple report request:

   TABLE FILE PREDDB
   PRINT FILE_ELEMENT
   IF RECORDLIMIT EQ 10
   END

If the ADABAS Interface is properly installed, the result is a FOCUS report that displays data from the first ten records in your Predict dictionary.

Note: If you customize AUTOADBS to run with multiple copies of the Predict dictionary, append the suffix for the identifier to PREDDB in the request. For example, if you choose P or T as a suffix, specify

TABLE FILE PREDDBP

or:

TABLE FILE PREDDBT

If you did not receive a report (0 records), make sure that the Predict dictionary contains data. The Predict dictionary is identified by the DBNO and FILENO in PREDDB FOCADBS and PREDEL FOCADBS.

If you receive any ADABAS Interface error messages and/or ADABAS response codes, check your installation against the instructions in this appendix. Also consult Appendix B, Interface Error Messages, and the appropriate Software AG documentation, or call Information Builders for assistance.