Version 8.1.4

Installation Procedure

This section describes the preparation for and installation of Adabas on systems running under the Fujitsu Technology Solutions BS2000 operating system.

Information for your specific installation is contained in the BS2000 Product Installation Package distributed with the System Installation Aid.


Installation Checklist

The following list provides an overview of the Adabas installation procedure on BS2000 systems.

Step Description Additional Information
1 Provide disk space for the Adabas libraries. The libraries are restored from the installation tape into these libraries. Refer to the section Adabas Library Disk Space Requirements.
2 Allocate disk space for the Adabas database. For better performance, distribute the database files over multiple devices and channels. Refer to the section Disk Space Requirements for the Database.
3 Specify the address space for running the Adabas nucleus. Refer to the section Adabas Nucleus Address Space Requirements.
4 Install the product license file (job I010, steps 0010 and 0011). For more information, read Installing the Adabas License File
5 Allocate and format the Adabas database with the ADAFRM utility job (job I030, steps 0010 to 0018).  
6 Define the global database characteristics with the ADADEF utility job (job I030, step 0020).  
7 Start the Adabas nucleus and test the Adabas communications with the ADANUC job.  
8 Load the demonstration files ADAvrs.EMPL/MISC/VEHI/PERS/PERL with the ADALOD utility (performed in job I050 steps 0001 to 0003).

Note:
The Personnel demo file must be installed on a UES-enabled database because it includes wide-character format (W) fields.

 
9 If appropriate, test Adabas address space communications by running ADAREP (job I050 step 9999).  
10 If appropriate, load the Adabas Online System (AOS) selectable unit into a Natural system file by running the ADAINPL job. Alternatively, install the AOS demo version delivered with Adabas (job I061, steps 0111 and 0112).  
11 Terminate the Adabas nucleus with an ADAEND operator command.  
12 Back up the database by running the ADASAV utility job.  

Top of page

Contents of the Release Tape

The following table describes most of the libraries included on the release tape. Once you have unloaded the libraries from the tape, you can change these names as required by your site, but the following lists the names that are delivered when you purchase Adabas for BS2000 environments.

Library Name Description
ADAvrs.ECnn The Adabas library containing character encoding members to support various languages and Unicode. The vrs in the library name represents the version of Adabas. The nn letters in the library name represents a number from "00" to "99", assigned by Software AG.
ADAvrs.EMPL The Employees demo file, containing dummy employee data you can use for testing Adabas. The vrs in the library name represents the version of Adabas.
ADAvrs.ERRN Error messages for the Adabas Triggers and Stored Procedures Facility. These messages can be viewed using the Natural SYSERR utility. The vrs in the library name represents the version of Adabas.
ADAvrs.INPL The code for Adabas Online System, Adabas Caching Facility, Triggers and Stored Procedures Facility, and various add-on demo products. The vrs in the library name represents the version of Adabas.
ADAvrs.JOBS The sample job library for Adabas. The vrs in the library name represents the version of Adabas.
ADAvrs.MISC The Miscellaneous demo file, containing dummy miscellaneous data you can use for testing Adabas. The vrs in the library name represents the version of Adabas.
ADAvrs.MOD The load library for Adabas. The vrs in the library name represents the version of Adabas.
ADAvrs.PERL The LOB demo file storing the LOB data referenced by the new Personnel demo file. The vrs in the library name represents the version of Adabas.
ADAvrs.PERS The Personnel demo file, containing dummy personnel data you can use for testing Adabas. This demo file includes fields that make use of the extended and expanded features of Adabas 8, include large object (LOB) fields. The vrs in the library name represents the version of Adabas.

Note:
The Personnel demo file must be installed on a UES-enabled database because it includes wide-character format (W) fields.

ADAvrs.SRC The source library for Adabas. The vrs in the library name represents the version of Adabas.
ADAvrs.VEHI The Vehicles demo file, containing dummy vehicle data you can use for testing Adabas. The vrs in the library name represents the version of Adabas.
APSvrs.L016 A Software AG internal library. The vrs in the library name represents the version of the internal library code, which is not necessarily the same as the version of Adabas.
APSvrs.PAMS A Software AG internal library. The vrs in the library name represents the version of the internal library code, which is not necessarily the same as the version of Adabas.
MLCvrs.JOBS The sample job library for Software AG's common mainframe license check software. The vrs in the library name represents the version of the license check software, which is not necessarily the same as the version of Adabas.
MLCvrs.MOD The load library for Software AG's common mainframe license check software. The vrs in the library name represents the version of the license check software, which is not necessarily the same as the version of Adabas.
WALvrs.MOD The load library for Adabas components shared by Adabas and other Software AG products, such as Entire Net-Work. The vrs in the library name represents the version of Adabas.
WALvrs.SRC The source library for Adabas components shared by Adabas and other Software AG products, such as Entire Net-Work.The vrs in the library name represents the version of Adabas.

Top of page

Preparing to Install Adabas

This section provides information related to activities required prior to Adabas installation.

Defining a BS2000 Logon ID

Before you install Adabas in a BS2000 system, you must:

When allocating direct access files, private volumes are preferred to avoid the space fragmentation that can occur with public volumes.

Data Sets Required for UES Support

The Software AG internal product libraries (APS - operating system layer) are required if you intend to enable a database for universal encoding service (UES) support. For UES support, the following library must be loaded and included in the BLSLIB concatenation: APSvrs.LIB (internal product application server), updated with the last patch level (APSvrs.Lnnn).

Note:
Newer APS module libraries are updates of the original. We advise you to copy the original, merge the new library into it, and reference the merged library in your JCL. The new merged library must be provided twice, with the link-name APSLIB and with the link-name BLSLIB.

Also for UES support, the following library must be loaded and included with the link name DDECSOJ in the session execution JCL: ADAvrs.EC00, where vrs is the version of Adabas (for example, "812").

Adabas Library Disk Space Requirements

The Adabas files and libraries require the following disk space in PAM pages where vrs is the Adabas version:

File Name Size Description
ADAvrs.MOD 1728 Module library
ADAvrs.SRC 480 Adabas source, macros, and example jobs
WALvrs.SRC 288 Adabas limited source, macros, and example jobs
WALvrs.MOD 384 BS2000-dependent modules for Adabas limited
ADAvrs.ECnn 14532 UES code pages

Disk Space Requirements for the Database

The Adabas database size is based on user requirements. For more information, refer to the Adabas DBA Tasks documentation. The following are suggested 2002 device cylinder and PAM page sizes for an initial Adabas database, allowing for limited loading of user files and the installation of Natural:

Database Component Cylinders PAM Pages
ASSOR1 (Associator) 50 7700
DATAR1 (Data Storage) 250 38000
WORKR1 (Work space) 50 7700
TEMPR1 (temporary work space) 25 3850
SORTR1 (sort work space) 25 3850

Adabas Nucleus Address Space Requirements

The typical Adabas nucleus requires at least 800-1024 KB of storage to operate. The size of the nucleus partition address space may have to be larger, depending on the ADARUN parameter settings. The address space parameters for the BS2000 user ID’s JOIN entry must also be adequate. Parameter settings are determined by the user.

Disk Space Requirements for Internal Product Data Sets

The minimum disk space requirements on the disk for the internal product libraries delivered with Adabas Version 8.1 are as follows:

Library PAM Pages
ADAvrs.ECnn 14532
APS272.LIB 2304

Using DAB-Supported Volumes

The following restrictions apply to Adabas components when located on DAB-supported volumes:

Component Recommendations/Restrictions
ASSO not recommended for read caching; prohibited for write caching
DATA not recommended for read caching; prohibited for write caching
WORK no restrictions for read caching; prohibited for write caching
CLOG/PLOG/RLOG no restrictions for read caching; prohibited for write caching
SORT/TEMP no restrictions
Sequential input no restrictions
Sequential output no restrictions

Migrating an Existing Database

Use the ADACNV utility to migrate existing databases to new releases of Adabas. See Adabas Utilities for more information.

Top of page

Installing the Adabas Release Tape

Adabas release tapes available to Software AG affiliates contain all Adabas product options. The affiliates use these release tapes to create custom installation tapes for customers according to contract agreements.

For specific information about your particular release tape, refer to the Installation Notes delivered with the installation tape.

Installation Using SMA

If you are installing Adabas using the Software AG System Maintenance Aid (SMA), refer to the System Maintenance Aid documentation and to the information provided with the installation tape for specific installation instructions.

Installation Not Using SMA

If you are not using SMA, copy the data sets from tape to disk using the procedure described below:

Step 1: Copy the Library SRVnnn.LIB from Tape to Disk

Note:
This step is not necessary if you have already copied the library SRVnnn.LIB from another Software AG tape. For more information, refer to the element #READ-ME in this library.

The library SRVnnn.LIB is stored on the tape as the sequential file SRVnnn.LIBS containing LMS commands. The current version nnn can be obtained from the Report of Tape Creation. To convert this sequential file into an LMS library, execute the following commands:

/IMPORT-FILE SUPPORT=*TAPE(FILE-NAME=SRVnnn.LIBS, -
/ VOLUME=<volser>, DEV-TYPE=<tape-device>)
/ADD-FILE-LINK LINK-NAME=EDTSAM, FILE-NAME=SRVnnn.LIBS, -
/ SUPPORT=*TAPE(FILE-SEQ=3), ACC-METH=*BY-CAT, -
/ BUF-LEN=*BY-CAT, REC-FORM=*BY-CAT, REC-SIZE=*BY-CAT
/START-EDT
@READ ’/’
@SYSTEM ’REMOVE-FILE-LINK EDTSAM’
@SYSTEM ’EXPORT-FILE FILE-NAME=SRVnnn.LIBS’
@WRITE ’SRVnnn.LIBS’
@HALT
/ASS-SYSDTA SRVnnn.LIBS
/MOD-JOB-SW ON=1
/START-PROG $LMS
/MOD-JOB-SW OFF=1
/ASS-SYSDTA *PRIMARY

<tape-device> = device type of the tape, for example, TAPE-C4
<volser> = VOLSER of tape (see Report of Tape Creation)

Step 2: Copy the Procedure COPY.PROC from Tape to Disk

Call the procedure P.COPYTAPE in the library SRVnnn.LIB to copy the procedure COPY.PROC to disk:

/CALL-PROCEDURE (SRVnnn.LIB,P.COPYTAPE), -
/ (VSNT=<volser>, DEVT=<tape-device>)

If you use a TAPE-C4 device, you can omit the parameter DEVT.

Step 3: Copy all Product Files from Tape to Disk

Enter the procedure COPY.PROC to copy all Software AG product files from tape to disk:

/ENTER-PROCEDURE COPY.PROC, DEVT=<tape-device>

If you use a TAPE-C4 device, you can omit the parameter DEVT. The results of this procedure are written to the file L.REPORT.SRV.

Top of page

Installing the Adabas License File

The product license file is supplied on the individual customer installation tape or separately via an e-mail attachment. If the license file is provided on an installation tape, you can follow the instructions in this step to install the license file. If the license file is supplied via an e-mail attachment, you must first transfer the license to your BS2000, as described in Transferring a License File from PC to a BS2000 Host Using FTP and then you can install it, as described in this step.

Start of instruction setTo install the product license file once it has been transferred:

  1. Run the LICMAKE license conversion job to load the license file into a library and assemble it.

  2. Store the assembler output module ADALIC(R) in the job library and add this to your BLSLIB concatenation.

Note:
The Adabas 81 nucleus needs a license file to start up. Either the license file is assembled as an object by ADALIC(R) into a library in the DDLIB/BLSLIB chain or the license is read from the link name DDLIC. If neither of these is the case, the nucleus will end with a DMS0A4F error because it cannot find a link name on DDLIC.

Top of page

Considerations of Device Types

The new default device type is 2002. All devices have standard block sizes that are a multiple of 4. Thus they can be used on NK4 disks.

If you do not wish to migrate the default device used by prior releases of Adabas (device 2000) to the new default (device 2002), then the JCL will need to include DEVICE=2000 in the ADARUN cards.

Devices and Spanned Records

Spanned record files are those loaded with the ADALOD SPAN option.

Writing a record over a block boundary in such a file requires an extra 50 to 100 bytes in the Work file block. In such cases, the Work file needs to have a block size of 50 to 100 bytes larger than the Data block size.

The default device 2002 has a Data block size of 8188 bytes; the Work file block is 8192 bytes. Therefore, there are not enough spare bytes in default device 2002 to span records over blocks. Device 2202, however, has a Data block size of 16280 bytes, while the Work file block is 16380 bytes, so this device can be used.

If the default device must process spanned records, the Work file block should be formatted, for example, as a 2010 device at blocksize 16380, and the ADADEF database define should set WORKDEV=2010. A zap file will be made available at a later time to address this workaround.

Top of page

The Adabas BS2000 Communication Environment

The installation of a supervisor call (SVC) to provide a communication environment for Adabas is not required on BS2000 systems. Adabas uses the BS2000 executive services common memory pool and eventing for interprocess communication.

The router functions are implemented in the form of subroutines contained in the module ADARER. ADARER is loaded into common memory pool during nucleus initialization, and is shared by all user tasks that issue Adabas calls.

For those systems running an earlier Adabas/WAL library but that wish to run with the Version 8 environment, the Version 8 system must be started first in order to create the version 8 router(ADARER) required for this version's nucleus.

Top of page

Applying Zaps

Every effort has been made to make Adabas operating system independent. However, Adabas development is done in an IBM environment and corrections and changes are prepared in this environment.

As a result, corrections are applied to Adabas modules with IMASPZAP, which determines the syntax of any zaps. When corrections must be applied to a module library at BS2000 locations, the zaps must be revised to the LMS format. The following example shows how this can be done:

Start of instruction setTo revise a zap to LMS format:

  1. Assuming a zap in the following LMS format:

    /EXEC LMS
    LIB ADAvrs.MOD,BOTH
    UPDR ADAEXAMP (a)
    *COR ADAEXAMP,12BC,X’47B0A123’=X’4720BAEE’ (b,c)
    *END
    END

    where:

    a specifies corrections to module ADAEXAMP.

    b verifies the contents at location X’12BC’. The correction is applied only if the content of this location is X’47B0A123’.

    c specifies a replacement value X’4720BAEE’ for the location X’12BC’.

  2. To verify the original data at location X’12BC’ on the BS2000 system, perform the following:

    /LOAD (ADAEXAMP,ADAvrs.MOD) Load module
    /DISPLAY L’12BC’.(L=4) Display original content
    %D C=ADAEXAMP.H’12BC’%XL4 (AID)

    If the data displayed is different from the value given on the original VER statement, do not continue with step 3.

  3. Run the LMS procedure.

  4. To ensure that the last step was performed properly, perform step 2 again. This procedure should also be used for ADARUN and ADALNK zaps, described later in this section.

Top of page

Job Variable (JV) Handling

The control job variable (JV) is filled automatically if the statement

/DEL-JV name
/SET-JOB-STEP
/CRE-JV name
/SET-JV-LINK *ADA,name

—is contained in the nucleus startup job control statements. The JV layout is as follows:

Positions Length Representation Contents
1 - 128 128 undefined unused
129 - 136 8 alphanumeric program name
137 - 140 4 numeric user abend code
141 - 145 5 numeric error number (parameter or utility)
146 - 150 5 numeric Adabas response code
151 - 157 7 numeric CPU time, program-related (sec.)
158 - 158 1 alphanumeric blank
159 - 165 7 numeric elapsed time, program-related (sec.)
166 - 178 13 alphanumeric blank, reserved

Top of page

Job Switches

Adabas uses job switch 10. The job switch is set by ADARUN and reset if the nucleus or utility session terminates normally. It can be used for session control to indicate whether or not a termination is normal. When ADARUN is called with PROGRAM=USER, no switches are set or reset.

Top of page

Linking User Exits A and B to ADALNK

One or two user exits may be linked with ADALNK:

At entry to the exit(s), the registers contain the following:

Register Content
1 Address of the UB. If the flag bit UBFINUB is reset, the contents of the halfword at Adabas + X’86’ have been moved to UBLUINFO. If those contents are greater than zero, the two bytes starting at UBINFO (UB+X’40’) have been set to zero. If UBFINUB is set, no changes can be made to the UB or ACB (except for ACBRSP).
13 Address of an 18-word save area
14 Return address
15 Entry point address: UEXITB or UEXITA

Any registers except register 15 that are modified by the user exits must be saved and restored; the address of a save area for this purpose is in register 13.

If at return from UEXITB register 15 contains a value other than zero, the command is not sent to the target but is returned to the caller. The user exit should have set ACBRSP to a non-zero value to indicate to the calling program that it has suppressed the command: response code 216 is reserved for this purpose.

The UEXITB exit may set the UB field UBLUINFO to any lesser value, including zero; an abend occurs if the user exit sets UBLUINFO to a greater value. The UBLUINFO length cannot be changed when any other exit is used; for example, Adabas Review.

The user information received by a UEXITA exit may have been modified; this modification may include decreasing its length, possibly to zero, by any of the ADANUC user exits.

Top of page

Enabling Universal Encoding Support (UES) for Your Adabas Nucleus

Prior to Adabas Version 7, Entire Net-Work converted all data for mainframe Adabas when necessary from ASCII to EBCDIC. Starting with Version 7, Adabas is delivered with its own data conversion capability called universal encoding support (UES). Entire Net-Work detects when it is connected to a target database that converts data and passes the data through to Adabas without converting it.

For Adabas Version 8.1, UES is enabled by default for the link routine ADALNK.

Note:
The use of UES-enabled link routines is transparent to applications, including applications that do not require UES translation support: it is not necessary to disable UES support.

Load Module and Translation Tables

No source module for ADALNK is delivered with Adabas 8.1. The module ADALNK already has the UES component, LNKUES, and the translation tables ASC2EBC and EBC2ASC bound to it.

The ADALNK module consists of ADALNK, ADAL2P and LNKUES. You can bind modified ASC2EBC or EBC2ASC translation tables to ADALNK-BASE using the job ALNKUES.

The two standard translation tables are:

It should only be necessary to modify these translation tables in the rare case when a country-specific character other than A-Z a-z 0-9 must be used in the Additions 1 (user ID) or Additions 3 field of the control block.

The Adabas translation table pair is provided in the section Translation Tables.

Job Steps

Job library member ALNKUES is an example job of how to link ADALNK with the UES components.

Calling LNKUES

LNKUES is called only on ADALNK requests (X‘08’), (X‘0C’) with reply (X‘10’) or (X‘1C‘) and reply (X‘20’) calls if the first byte of the communication ID contains X‘01’ and the second byte does not have the EBCDIC (X‘04’) bit set.

For requests, LNKUES receives control before UEXITB. For replies, LNKUES receives control after UEXITA.

Required Environment

The Adabas database must be UES-enabled. See Adabas DBA Tasks and the ADACMP and ADADEF utilities in Adabas Utilities for more information.

Connection Possibilities

UES-enabled databases are connected to machines with different architectures through Software AG's internal product software (APS) or through Entire Net-Work (WCP).

Adabas SQL Gateway (ACE) clients may not be strictly EBCDIC in an environment where databases are connected through Software AG’s internal product software (APS).

JCL Required for UES Support

The nucleus job statements for a UES nucleus require the following items:

Note:
The Software AG internal product software (APS) batch system will create a subtask job with the same user attributes as the UES nucleus job. This job will be stopped automatically when the UES nucleus is stopped.

Top of page

Linking LNKUES to ADALNK for Data Conversion

Adabas Version 7 was delivered with the module LNKUES for Universal Encoding Support (UES). LNKUES converts data in the Adabas buffers and byte-swaps, if necessary, depending on the data architecture of the caller. In Adabas version 7, LNKUES had to be linked to ADALNK; in version 8, LNKUES is fix bound to ADALNK.

Prior to Version 7, Entire Net-work converted all data for mainframe Adabas. When Entire Net-work Version 5.5 and above detects that it is connected to a target database that converts data, it passes the data through without converting it.

LNKUES is called only on ADALNK request (X’1C’) and reply (X’20’) calls if the first byte of the communication ID contains X’01’ and the second byte does not have the EBCDIC (X’04’) bit set.

By default, two translation tables are linked into LNKUES/ADALNK:

Note:
It should only be necessary to modify these translation tables in the rare case that some country-specific character other than "A-Z a-z 0-9" must be used in the Additions 1 (user ID) or Additions 3 field of the control block.

If you prefer to use the same translation tables that are used in Entire Net-Work:

Both the Adabas and Entire Net-Work translation table pairs are provided in section Translation Tables. You may want to modify the translation tables or create your own translation table pair. Be sure to (re)assemble the translation tables and (re)link LNKUES/ADALNK.

/ASS-SYSDTA *SYSCMD
/STA-PROG $TSOLNK
MODULE ADALNK,LIB=USER.MOD,ELEM=ADALNK
NCAL
LINK SYMBOLS *KEEP
INCLUDE ADALNK,ADABAS.MOD
INCLUDE ASC2EBC,ADABAS.MOD
INCLUDE EBC2ASC,ADABAS.MOD
BIND
/ASS-SYSDTA *PRIM

The (re)linked ADALNK must be made available to Entire Net-Work. If you are calling Adabas Version 7 and you do not have the correct LNKUES/ADALNK module, Adabas produces unexpected results: response code 022, 253, etc.

Top of page

Formatting New Adabas Data Sets

The following formatting is required when creating new data sets:

Data Set Formatting Required
ASSO the first track plus the first 30 RABN blocks
DATA the first two tracks
WORK the whole data set
PLOG / CLOG / RLOG the whole data set
SORT / TEMP no formatting required

Note:
Adabas version 8.1 knows the standard block sizes for the containers of a particular device type. These do no need to be included in the link statement.

Formatting SORT and TEMP

The SORT and TEMP files can optionally be formatted. If non-formatted files are used, the following two FILE commands must be issued:

/CREATE-FILE ADA99.SORT,PUB()
/SET-FILE-LINK DDSORTR1,ADA99.SORT,OPEN-MODE=OUTIN

Top of page

Starting Adabas

Adabas User Exit 2 for BS2000 permits two methods for specifying the /ENTER-JOB job:

For more information, see the description of User Exit 2 in the user exit and hyperexit documentation.

Top of page

Interpreting BS2000 Error Messages

When running Adabas, some BS2000 messages may indicate that a parameter is missing or is incorrect. The following are the message IDs that can occur, and their explanations in an Adabas environment:

Message Description
D922 SAM file allocation (for example, for DDOUT1) primary and secondary allocation must be a multiple of the both standard block size (16) and of the allocation unit (3). The smallest multiple allowed is 48. The standard block size may have been changed using the ADARUN parameter QBLKSIZE. If so, the standard block size is determined by dividing the sum of the QBLKSIZE value and 2047, by 2048.
DD99 Parallel access to a PAM file (for example, DATA) was attempted, but SHARUPD=YES was omitted
DDB1 Refer to the D922 description above
DDC2 SHARUPD=YES was specified for a SAM file (for example, DDSIBA)

Top of page