Installation Procedure


The Installation medium

The installation medium contains the data sets listed in the table below. The sequence of the data sets is shown in the Software GmbH Product Delivery Report that accompanies the installation medium.

Data Set Contents
AFPvrs.LOAD AFP load modules
AFPvrs.INPL SYSAFP objects
AFPvrs.ERRN SYSAFP error messages
AFPvrs.SRCE AFPLOOK configuration source
AFPvrs.JOBS AFPLOOK installation job

where vrs in data set names represents the version, revision, and system maintenance level of the product.

Installation Checklist

The Adabas System Coordinator must be installed prior to the installation of Adabas Fastpath. See the Adabas System Coordinator documentation for detailed information.

Once the required System Coordinator components have been installed, you can proceed to install Adabas Fastpath. The following checklist identifies the steps necessary to complete the installation:

Step Description
0 Check, Prepare, and Install the Product License File
1 Restore the Adabas Fastpath libraries from the installation medium
2 Prepare SYSAFP
3 Enable the client process
4 Enable the Adabas server process
5 Prepare the asynchronous buffer manager
6 Verify the installation

System Programming Considerations

Buffer storage is acquired from extended CSA (ECSA subpool 241). The operating system parameter CSA in the IEASYSxx member of SYS1.PARMLIB defines the size available. It may need to be increased if a large buffer is required.

Installation Procedure Steps

Following is the general Adabas Fastpath installation procedure. The actual installation depends on your particular requirements and the specific contents of your release package for your site. Information in the release package is intended for your system. If that information differs from the information in this section, use the release package information or contact your technical support representative for assistance.

Step 0: Check, Prepare, and Install the Product License File

You must install a valid license file on all mainframe platforms in which Adabas Fastpath is installed. The license file is provided as an XML document (encoding is US-ASCII) and must remain in that format – even on the mainframe. It must not be modified. Any modification of the license file will invalidate the digital signature, and the license check will fail. In the event of a check failure, please contact your technical support representative.

Note
Forty days before the license expires, license check failure messages are produced. Adabas Fastpath will still function, but these messages warn you that it is time to obtain a new license.

In this step, you will prepare the license file (obtain it from email or the installation tape and store it on your z/OS system) and then install it:

Preparing the Product License File

The product license file is supplied on the individual customer installation tape or separately via an email attachment. Before you can install the license, you must transfer it from email or the installation tape and store it on your z/OS system. This section describes how to do this for a license distributed either by email or on the installation tape.

To prepare the license file from an email attachment, complete the following steps:
  1. Transfer the license to z/OS, as described in the section Transferring a License File from PC to a z/OS Host Using FTP within the Mainframe Product Licensing topic in the Adabas for Mainframes documentation.

  2. Verify that the transferred license file is stored in a source library (with RECFM=F or FB and LRECL=80), taking care to preserve its format as ASCII.

To prepare the license file from the installation tape, complete the following steps:
  • Verify that the license file is stored from the tape into a source library (with RECFM=F or FB and LRECL=80), taking care to preserve its format as ASCII.

Installing the Product License File

Once the license file has been prepared, you can install it in one of two ways:

  • You can convert the license to a load module (AFPLIC) that is then loaded by the appropriate job/started task.

  • You can reference the license file in the appropriate job/started task by DD statement.

This section describes both methods.

To convert the license file to a load module, complete the following steps:
  1. Review and modify the sample job ASMLICAM, supplied on the ADAvrs.JOBS library, as follows:

    • Ensure the STEPLIB DD statement resolves to the license load library (MLCvrs.LOAD).

    • Ensure the SYSUT1 DD statement resolves to the data set containing the Adabas Fastpath license file you transferred to z/OS earlier.

    • Ensure the generated load module is called AFPLIC.

    • Ensure the SYSLMOD DD statement resolves to an appropriate user load library.

      Note
      This user load library must also be included in the STEPLIB concatenation for the appropriate job/started task.

  2. Submit the modified ASMLICAM. This job runs the MAKE function of the LICUTIL utility to convert the license text file to an assembler source module. ASMLICAM then links and assembles the assembler source to generate a load module called AFPLIC, which is stored in the specified user load library. For more information about the LICUTIL utility, refer to section Using The License Utility: LICUTIL within the Software GmbH Mainframe Product Licensing topic in the Adabas for Mainframes documentation.

  3. Update your job/started task to reference the user load library so AFPLIC will be loaded, as described in Step 5. Prepare the Asynchronous Buffer Manager.

To reference the license file by DDLAFP statement, complete the following steps:
  1. Ensure any previously created AFPLIC license load module is inaccessible to the job/started task (loading the AFPLIC license load module is attempted first and only if this is unsuccessful is a read from the DDLAFP data set attempted).

  2. Update your job/started task as described in Step 5. Prepare the Asynchronous Buffer Manager.

Step 1: Copying the Medium Contents to Disk

If you are using System Maintenance Aid (SMA), refer to the SMA documentation (included on the current edition of the Natural documentation CD). If you are not using SMA, perform steps 1a, 1b and 1c as described in this section:

Note
If the data sets for more than one product are delivered on the medium, the data set COPY.JOB contains the JCL to unload the data sets for all delivered products from the medium to your disk. After that, you will have to perform the individual install procedure for each component.

Step 1a: Copy Data Set COPY.JOB from medium to Disk

The data set COPY.JOB (label 2) contains the JCL to unload all other existing data sets from medium to disk. To unload COPY.JOB, use the following sample JCL:

//SAGmedium JOB SAG,CLASS=1,MSGCLASS=X
//* ---------------------------------
//COPY EXEC PGM=IEBGENER
//SYSUT1 DD DSN=COPY.JOB,
// DISP=(OLD,PASS),
// UNIT=(CASS,,DEFER),
// VOL=(,RETAIN,SER=<Tnnnnn>),
// LABEL=(2,SL)
//SYSUT2 DD DSN=<hilev>.COPY.JOB,
// DISP=(NEW,CATLG,DELETE),
// UNIT=3390,VOL=SER=<vvvvvv>,
// SPACE=(TRK,(1,1),RLSE),
// DCB=*.SYSUT1
//SYSPRINT DD SYSOUT=*
//SYSIN DD DUMMY
// 
where: 

<hilev>  is a valid high level qualifier 
<Tnnnnn> is the medium number 
<vvvvvv> is the desired volser  

Step 1b: Modify COPY.JOB

Modify COPY.JOB to conform with your local naming conventions and set the disk space parameters before submitting this job:

  • set HILEV to a valid high level qualifier

  • set LOCATION to a storage location

  • set EXPDT to a valid expiration date

Step 1c: Submit COPY.JOB

Submit COPY.JOB to unload all other data sets from the medium to your disk.

Step 2. Prepare SYSAFP

The Adabas Fastpath Online Services (SYSAFP) objects are delivered on the Adabas Fastpath installation medium.

Start of instruction setTo prepare SYSAFP:

  1. Use your everyday Natural INPL job to load the administration tool (Natural application SYSAFP) and associated message texts into your Natural system. For reference a sample Natural INPL job called CORI061 can be found with the sibling System Coordinator product in the jobs distribution file. The INPL job’s work file 1 must reference the distribution file AFPvrs.INPL and work file 2 must reference AFPvrs.ERRN.

    Note
    If you use Natural Security in this system, define the libraries SYSAFP and SYSMWvrs (where vrs is the level you are installing, for example 821) and protect as you require. You may define MENU as the startup transaction for SYSAFP. However, you must not define a startup transaction for SYSMWvrs.

  2. Use the following parameter to define the Natural session where SYSAFP is to be used:

    LFILE=(152,dbid,fnr<,passw><,ciph>) 

    where dbid and fnr define the location of the Adabas System Coordinator configuration file.

    Alternatively, assemble the Natural parameter module with

    NTFILE,ID=152,DBID=dbid,FNR=fnr 

Any supported version of Adabas Fastpath may be used in conjunction with SYSAFP 8.6 provided that the following required maintenance is applied:

Version Fix number
8.2 SP2 AW822077

Step 3. Enable the Client Process

To enable the Adabas Fastpath client process

  1. for the Adabas System Coordinator:

    • make the modified Adabas link module available (COMPLIB for Com-plete, DFHRPL for CICS, STEPLIB for all other client systems);

    • make the generated configuration module CORCFG available (COMPLIB for Com-plete, STEPLIB for all other client systems); and

    • make the Adabas System Coordinator load library available (COMPLIB for Com-plete, STEPLIB for all other client systems).

  2. for Adabas Fastpath:

    • make the Adabas Fastpath load library available (COMPLIB for Com-plete, STEPLIB for all other client systems).

Step 4. Enable the Database Process

To enable the Adabas Fastpath database process

  1. for the Adabas System Coordinator:

    • make the Adabas System Coordinator load library available.

  2. for Adabas Fastpath:

    • set the Adabas parameter ADARUN FASTPATH=YES; and

    • make the Adabas Fastpath load library available.

Note
An unmodified ADALNK must be available to the database in preference to the ADALNK created during the installation of the Adabas System Coordinator.

Step 5. Prepare the Asynchronous Buffer Manager

The asynchronous buffer manager (ABM) runs as an optional service within the Adabas System Coordinator daemon.

To enable the ABM for the Adabas System Coordinator daemon, modify the Adabas System Coordinator daemon job to make the following available:

  • COR configuration module (CORCFG) with information on the location of the primary and, if used, alternate configuration file

  • Adabas Fastpath load library

  • Adabas Fastpath License

    • either make the AFPLIC module available to the Adabas System Coordinator daemon

    • or add a DDLAFP DD statement to the job to reference the AFP license

Then modify the file referenced by the DDCARD statement to contain the following control statement:

PRODUCT=AFP

For more information, refer to the Adabas System Coordinator documentation.

Step 6. Verify the Installation

Use the procedure described in section Verifying the Installation to ensure that the installation has been successful.

Verifying the Installation

Use this procedure to ensure that the installation has been successful.

Several Natural programs are supplied in source form that demonstrate the effect of Adabas Fastpath optimization. These programs refer to the sample EMPLOYEES file distributed with Adabas.

  1. Using Adabas Fastpath Online Services (SYSAFP), define a global buffer. For more information, see Parameter Maintenance.

  2. Using Adabas Fastpath Online Services, define EMPLOYEES as a file to be optimized, and for all command types, set the default for optimization to ON. For more information, see Parameter Maintenance.

  3. Using Adabas Fastpath Online Services, define the Client Runtime controls for the TP system (or batch job) where you wish to implement Adabas Fastpath optimization. See Parameter Maintenance.

  4. Enable the database containing the EMPLOYEES file. See Step 4 of the Adabas Fastpath installation procedure for the operating system you are using. For example, step 4 for z/OS.

  5. Start the asynchronous buffer manager. See Step 5 of the Adabas Fastpath installation procedure for the operating system you are using. For example, step 5 for z/OS.

  6. Enable the client job chosen for Adabas Fastpath optimization. See Step 3 of the Adabas Fastpath installation procedure for the operating system you are using. For example, step 3 for z/OS.

  7. From the Adabas Fastpath administration menu go to the command line and LIST/STOW the Natural programs beginning with EEX* to compile them with your correct EMPLOYEES DDM

  8. The verification program relies on a certain amount of records being present in the EMPLOYEES file. Ensure the file is not empty.

  9. Type VERIFY at the SYSAFP command line to execute the verification procedure. Use VERIFY along with the SYSAFP command 2.1 to show the optimization being achieved. Initially, only a small percentage of commands are actually optimized: this grows with the repeated use of VERIFY as Adabas Fastpath builds the knowledge base based on previous requests.