Version 4.3.2
 —  Installation and Operations for VSE/ESA  —

Installation (Phase 1)

Adabas Review can be installed in local mode in the Adabas address space, or a hub (server) located in its own address space with an interface (client) located in the address space of the Adabas being monitored. The procedures are the same except as noted.

Adabas Review is installed in two phases: this section of the documentation describes phase one, which comprises all the steps that are independent of any particular TP monitor environment.

To complete phase 1 of the installation, include all steps that apply to the type of installation you have chosen and follow them in order.

Phase 2, which comprises the steps that are specific to the TP monitor being used, is described in in section Installation (Phase 2).

This document covers the following topics:


Top of page

The Installation Tape

Tape Contents

The following sections describe the contents of the Adabas Review installation tape, the space requirements for each dataset, and instructions for copying the contents of the installation tape to disk. Sample JCS to accomplish the transfer is also included.

Refer to the Report of Tape Creation for the volume serial number, density, media type, dataset names, and dataset sequence numbers for the SM level being installed.

The Adabas Review 4.3.2 installation tape contains the following datasets:

Dataset Created Using Contents
REV43s.INPL NATUNLD Adabas Review Natural objects
REV43s.SYSF ADAULD Adabas Review repository file
REV43s.VSEZAPS -- Adabas Review ZAP dataset
REV43s.VSELIBR LIBR BACKUP The Adabas Review sublibrary; contains relocatable objects, phases, source, and example installation jobs

Size of Adabas Review

Note:
This section applies only to Adabas Review in local mode.

The available GETVIS in the Adabas partition may need to be increased to accommodate Adabas Review. An increase of 500K is normal.

Space Requirements

The space requirements for each of the datasets on the installation tape is shown below:

Dataset Name Cylinders (3380)
INPL 15
SYSF 1 track
VSEZAPS 1
VSELIBR 10

Additionally, the alternate history file, which is created when installing Adabas Review under Adabas, requires additional space as follows:

Dataset Type Cylinders (3380)
Alternate history file 2

Sublibrary Members

The Adabas Review sublibrary members are listed below. A sublibrary name extension (a period followed by a single letter) indicates the function of each sublibrary.

Sublibrary members for Adabas Review are as follows:

Member Description
ARCHIVE.X Sample JCS to define Adabas Review 4.3.s to MSHP.
ASMLCC.X For CICS installations; sample JCS to link the Adabas Review link routine exit with the CICS/Adabas command-level link routine; used when reporting on Natural usage in CICS.
ASMLCO.X For Com-plete installations; sample JCS to assemble and link the Adabas Review link routine exit with the Com-plete/Adabas link routine; used when reporting on Natural usage in Com-plete.
ASMLCX.X Sample JCS to assemble and catalog ADALCO.OBJ.
ASMLNK.X For batch installations; sample JCS to assemble and link the Adabas Review link routine exit with the batch Adabas link routine; used when reporting on Natural usage in batch jobs.
DBFILES.X Create Review datasets.
EXPAND1.X Sample JCS to upgrade a version 4.1 repository to version 4.2.
EXPAND2.X Sample JCS to upgrade a version 4.2 repository to version 4.3.
HISTCOMP.X Sample JCS to compress history data from a batch Natural execution.
HISTDEL.X Sample JCS to delete history data from a batch Natural execution.
HISTFIX.X Sample job to run the correct history dates.
HISTVIEW.X Sample JCS to view history data from a batch Natural execution.
HUBJCS.X Sample JCS to start the Adabas Review hub server.
LINKREV.X Sample job to relink Review after applying maintenance.
LOGUEXIT.A Sample Assembler source code for an Adabas Review command logging user exit.
RAOSLUBS.A Sample Assembler code to change the default logical units used by Adabas Review.
REVFDT.A FDT control cards for the Adabas Review repository.
REVIEWB.X Sample JCS to process a sequential command log by the batch component of Adabas Review.
REVINPL.X Sample JCS to INPL the Adabas Review programs and DDMs from the INPL dataset to the Natural system files.
REVLOAD.X Sample JCS to load the Adabas Review repository file into an Adabas version 7 environment.
REVPROC.X Sample job to catalog the Review standard label procedure.
ZAPOPT.Z Review optional zaps.

Copying Contents of the Tape to Disk

Step 1: Allocate and Copy the Adabas Review 4.3.2 Installation Files to Disk

Use the sample job provided below to allocate and copy the Adabas Review 4.3.2 installation files to disk. All dataset sizes are based on 3380 device types.

  1. Replace

    vrs with the version, revision, and system maintenance level of Adabas Review
    nnnn with the starting track number;
    vvvvvv with the tape volume serial number;
    ttt with the tape unit address;
    f with the number of files to forward space; refer to the Report of Tape Creation for this information.
  2. Use the JCS in this substep to create a Software AG product library. If you already have a Software AG product library, omit this substep and proceed to substep 3.

    // JOB DEFINE
    // DLBL SAGLIB,'SAG.PRODUCT.LIBRARY',99/365
    // EXTENT,vvvvvv,1,0,nnnn,150
    // EXEC LIBR
       DEFINE LIB=SAGLIB
    /*
    /&
  3. Catalog the Adabas Review PROC.

    // JOB CATALOG
    // EXEC LIBR 
       ACCESS S=IJSYSRS.SYSLIB
       CATALOG REVvrs.PROC REPLACE=YES
    // DLBL SAGLIB,'SAG.PRODUCT.LIBRARY',99/365
    // EXTENT, vvvvvv,1,0,nnnn,150
    // LIBDEF PHASE,SEARCH=SAGLIB.REVvrs,TEMP
    // LIBDEF PHASE,CATALOG=SAGLIB.REVvrs,TEMP
    // LIBDEF SOURCE,SEARCH=SAGLIB.REVvrs,TEMP
    // LIBDEF OBJ,SEARCH=SAGLIB.REVvrs,TEMP
    /+
    /*
    /&
  4. Restore the Adabas Review sublibrary to disk.

    // JOB REVIEW
    // ASSGN SYS006,ttt
    // MTC REW,SYS006
    // MTC FSF,SYS006,f
    // EXEC PROC=REVvrs
    // EXEC LIBR
       RESTORE SUBLIB=SAGLIB.REVvrs:SAGLIB.REVvrs TAPE=SYS006 LIST=Y R=Y 
       LD SUBLIB=SAGLIB.REVvrs OUTPUT=NORMAL
    /*
    /&

Use the JCS in this substep to create a Software AG product library. If you already have a Software AG product library, omit this substep and proceed to substep 3.

// JOB DEFINE
// DLBL SAGLIB,'SAG.PRODUCT.LIBRARY',99/365
// EXTENT,vvvvvv,1,0,nnnn,150
// EXEC LIBR
   DEFINE LIB=SAGLIB
/*
/&

Catalog the Adabas Review PROC.

// JOB CATALOG
// EXEC LIBR 
   ACCESS S=IJSYSRS.SYSLIB
   CATALOG REVvrs.PROC REPLACE=YES
// DLBL SAGLIB,'SAG.PRODUCT.LIBRARY',99/365
// EXTENT, vvvvvv,1,0,nnnn,150
// LIBDEF PHASE,SEARCH=SAGLIB.REVvrs,TEMP
// LIBDEF PHASE,CATALOG=SAGLIB.REVvrs,TEMP
// LIBDEF SOURCE,SEARCH=SAGLIB.REVvrs,TEMP
// LIBDEF OBJ,SEARCH=SAGLIB.REVvrs,TEMP
/+
/*
/&

Restore the Adabas Review sublibrary to disk.

// JOB REVIEW
// ASSGN SYS006,ttt
// MTC REW,SYS006
// MTC FSF,SYS006,f
// EXEC PROC=REVvrs
// EXEC LIBR
   RESTORE SUBLIB=SAGLIB.REVvrs:SAGLIB.REVvrs TAPE=SYS006 LIST=Y R=Y 
   LD SUBLIB=SAGLIB.REVvrs OUTPUT=NORMAL
/*
/&

Top of page

Install Adabas Review under Natural

Step 1: INPL Adabas Review

This section applies to both local and hub mode installations.

Step 2: Create a Natural profile using the SYSPARM facility

  1. For Natural version 2.3, include the following parameter settings in the Natural profile:

    Parameter Requirement
    LS=250 minimum
    PS=80 minimum
    MADIO=5000 minimum
    MAXCL=0 minimum
    ESIZE=40 minimum
    ADAPRM=ON required in order to for Adabas Review to report on Natural information.
    NTWORK(7),AM=PC required for PC downloads. NTWORK is a Natural macro used to define the work file(s) to be used; 'AM' is the access method. For more information, see the Natural documentation.
  2. Add a Natural NTFILE definition for the physical database ID and file number of the Adabas Review repository file as follows:

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

    Replace dbid and fnr with the database ID and file number, respectively, of the Adabas Review repository.

    Note:
    The Adabas Review repository may not reside on a database with a database ID (DBID) of 255. If the database ID is 255, Adabas Review cannot be accessed in local or hub mode. However, a database with a DBID of 255 can send data to a hub.

  3. 3. Reassemble and link the NATPARM module to your Natural nucleus.

Add a Natural NTFILE definition for the physical database ID and file number of the Adabas Review repository file as follows:

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

Replace dbid and fnr with the database ID and file number, respectively, of the Adabas Review repository.

Note:
The Adabas Review repository may not reside on a database with a database ID (DBID) of 255. If the database ID is 255, Adabas Review cannot be accessed in local or hub mode. However, a database with a DBID of 255 can send data to a hub.

3. Reassemble and link the NATPARM module to your Natural nucleus.

Step 3: Define Adabas Review to Natural Security

Note:
If the Adabas Review application SYSREVDB is made private (i.e., the parameter PEOPLE=Y is specified), each user of Adabas Review must be linked to the SYSREVDB application.

If Natural Security is installed:

  1. Define the SYSREVDB library for the Adabas Review system.

  2. Define the following Adabas Review DDMs to Natural Security as public DDMs:

    REVIEW-ADABAS-V431-CLOG
    REVIEW-FNAT
    REVIEW-ADABAS-V431-SYSTEM

Define the following Adabas Review DDMs to Natural Security as public DDMs:

REVIEW-ADABAS-V431-CLOG
REVIEW-FNAT
REVIEW-ADABAS-V431-SYSTEM

Top of page

Install the Adabas Review Repository

This step applies to both local and hub mode installations.

The Adabas Review repository is a system file used for storing descriptions of interactive reports, target definitions, and for saving historical data accumulated by Adabas Review reports.

Any Adabas file may be used to contain the Adabas Review repository. The corresponding file number should also be reflected in the NATPARMs used to invoke Adabas Review.

Hub mode only: The Adabas Review repository can be created on any database accessible to Natural. It does not need to be on a database that is monitored by the Adabas Review hub.

Notes:

  1. The Adabas Review repository may not reside on a database with a database ID (DBID) of 255. If the database ID is 255, Adabas Review cannot be accessed in local or hub mode. However, a database with a DBID of 255 can send data to a hub.
  2. Before using an existing Adabas Review version 4.1 repository as a version 4.2 repository, you must run the Expand job from the Jobs library, which adds new fields and increases the length of some fields.

Step 1: Modify the JCS for loading the Adabas Review repository

Step 2: Load the Adabas Review repository file

Top of page

Install Adabas Review under Adabas

Step 1: Create Adabas Review-specific datasets

Use the sample JCS member DBFILES.X in the Adabas Review sublibrary to create the datasets necessary to store autostarted report definitions, parameters, and the alternate history file.

  1. Modify DBFILES.X by replacing

    s with the current system maintenance level of Adabas Review
    nnnn with the starting track number for each step in the job
    vvvvvv with the tape volume serial number
  2. Execute the modified DBFILES.X.

Execute the modified DBFILES.X.

Step 2: Modify the Adabas initialization parameters

See the section ADARUN Parameters for information about the relevant ADARUN parameters.

Step 3: Apply the required ZAPs

Step 4: Modify the Adabas start-up JCS

  1. Local Mode

    Before you modify the Adabas start-up JCS, you may need to increase the available GETVIS in the Adabas partition to accommodate Adabas Review. An increase of 500K is normal.

    RVUALT Considerations

    RVUAUT1 and RVUAUT2 Considerations

    To modify the start-up JCS for local mode

    1. Add the following statements to the Adabas start-up JCS replacing

      vrs with the current version, revision, and system maintenance level of Adabas Review
      vvvvvv with the tape volume serial number

      Note:
      In Adabas Review, each logical unit (SYS number) is assigned to a specific Adabas Review function. If these logical units conflict with the assignments already made in your environment, refer to section Operations for instructions on how to reassign Adabas Review logical units. Substitute the reassigned logical units in the following start-up JCS.

      //  ASSGN SYS005,IGN                    RVUPARM - batch parameters
      //  ASSGN SYS007,DISK,VOL=vvvvvv,SHR    RVUAUT1, RVUAUT2, RVUFLD
      //  ASSGN SYS008,DISK,VOL=vvvvvv,SHR    RVUALT - alt history file
      //  ASSGN SYS020,SYSLST             RVUPRT0 - printer
      //  ASSGN SYS021,SYSLST             RVUPRT1 - printer
      //  ASSGN SYS022,SYSLST             RVUPRT2 - printer
      //  ASSGN SYS023,SYSLST             RVUPRT3 - printer
      //  ASSGN SYS041,DISK,VOL=vvvvvv,SHR    RVUCARD - GENCARD
      //  ASSGN SYS006,DISK,VOL=vvvvvv,SHR    RVUEXI - operating env parameters
      //  ASSGN SYS019,SYSLST             RVUEXP - EXI parameters printer
      *
      //  DLBL RVUAUT1,'REVvrs.AUTO1',0
      //  EXTENT SYS007,vvvvvv,1,0,nnnn,5
      //  DLBL RVUAUT2,'REVvrs.AUTO2',0
      //  EXTENT SYS007,vvvvvv,1,0,nnnn,5
      *
      //  DLBL RVUCARD,'REVvrs.CARD.FILE',0
      //  EXTENT SYS041,vvvvvv,1,0,nnnn,5
      *
      //  DLBL RVUALT,'REVvrs.ALT.FILE',0
      //  EXTENT SYS008,vvvvvv,1,0,nnnn,30
      *
      //  DLBL RVUEXI,'REVvrs.EXI.PARAMETERS',0
      //  EXTENT SYS006,vvvvvv,1,0,nnnn,5
      *
      //  DLBL RVUFLD,'REVvrs.USER.FIELDS',0
      //  EXTENT SYS007,vvvvvv
    2. Modify the Adabas start-up JCS to execute the Adabas Review procedure and add the Review sublibrary to the LIBDEF search chain.

  2. Hub Mode: Interface Install

    To install the client interface in hub mode

    Repeat the following substeps for each database to be monitored.

    Each database to be monitored must use the same SVC as the Adabas Review hub.

    Important:
    If you are currently running Review DB 3.4, you must completely deinstall it from the Adabas start-up JCS.

    1. Provide access to the Review sublibrary in the LIBDEF concatenation.

    2. Restart Adabas.

Hub Mode: Interface Install

To install the client interface in hub mode

Repeat the following substeps for each database to be monitored.

Each database to be monitored must use the same SVC as the Adabas Review hub.

Important:
If you are currently running Review DB 3.4, you must completely deinstall it from the Adabas start-up JCS.

  1. Provide access to the Review sublibrary in the LIBDEF concatenation.

  2. Restart Adabas.

Step 5: Define Adabas Review to MSHP

Maintenance fixes are distributed in MSHP format. In order to apply these maintenance fixes, Adabas Review must be defined to MSHP as a product/component using the MSHP ARCHIVE process.

Top of page

Install the Adabas Review Hub

Step 1: Modify the sample JCS member HUBJCS.X

  1. Correct any library names or file names.

  2. Modify the ADARUN parameters:

    The ADARUN parameters supplied in the sample JCL member HUBJCS.X are the only ones recognized for setting up the hub nucleus. See section ADARUN Parameters for information about these ADARUN parameters.

    Note:
    Software AG recommends that the dispatching priority of the Adabas Review hub be set higher than that of the sending Adabas nuclei.

  3. The RVUALT DLBL statement refers to the dataset that contains the alternate history file.

    The RVUALT or "alternate history" file is used to contain history information if Adabas Review is unable to access the Adabas Review repository. You may use the same RVUALT dataset you used for earlier versions.

    Refer to section Operations for RVUALT guidelines.

  4. The RVUAUT1 and RVUAUT2 DLBL statements refer to the datasets that contain the report definitions for autostarted reports.

    You can use the distributed RVUAUT1 and RVUAUT2 files from earlier versions.

    Note:
    The reports contained in the RVUAUTn files have a TARGET= parameter that specifies the database that the report will monitor. The default setting is TARGET=001. You may wish to change this setting.

    The RVUFLD DLBL statement refers to the dataset that contains the user-defined field parameters.

Modify the ADARUN parameters:

The ADARUN parameters supplied in the sample JCL member HUBJCS.X are the only ones recognized for setting up the hub nucleus. See section ADARUN Parameters for information about these ADARUN parameters.

Note:
Software AG recommends that the dispatching priority of the Adabas Review hub be set higher than that of the sending Adabas nuclei.

The RVUALT DLBL statement refers to the dataset that contains the alternate history file.

The RVUALT or "alternate history" file is used to contain history information if Adabas Review is unable to access the Adabas Review repository. You may use the same RVUALT dataset you used for earlier versions.

Refer to section Operations for RVUALT guidelines.

The RVUAUT1 and RVUAUT2 DLBL statements refer to the datasets that contain the report definitions for autostarted reports.

You can use the distributed RVUAUT1 and RVUAUT2 files from earlier versions.

Note:
The reports contained in the RVUAUTn files have a TARGET= parameter that specifies the database that the report will monitor. The default setting is TARGET=001. You may wish to change this setting.

The RVUFLD DLBL statement refers to the dataset that contains the user-defined field parameters.

Step 2: Start the HUBJCS job

Top of page

Optional Installation Procedures

Implement Support for Adabas Native SQL

From within Adabas Native SQL, use the global ADACALL statement with the LAST parameter to specify that the Adabas call will use the seventh parameter.

Refer to the Adabas Native SQL Documentation.

Implement Support for Reporting from Batch Natural (Review 4.3.2 with Adabas 7.4.2 and Above Link Routine)

This (optional) step applies to both local and hub mode installations.

The following step is required in order to report on Natural activity from batch Natural jobs.

Link ADALNK with the Adabas Review link routine exit

Link the ADALNK for batch with the Adabas Review 4.3.2 link routine exit. Sublibrary member ASMLNK.X contains the JCS necessary to do this.

Notes:

  1. If you elect to use the link routine ADALNKX, link the batch Review routine RDBLXVSE to ADALNKR.
  2. For hub mode, Software AG recommends that the modified ADALNK not be placed in the Adabas load library. Adabas uses ADALNK to send its information to the Adabas Review hub. The link routine exits cause unnecessary overhead for this process.

Implement Support for Reporting from Batch Natural (Review 4.3.2 with Adabas 7.4.1 and Below Link Routine)

This (optional) step applies to both local and hub mode installations.

The following steps are required in order to report on Natural activity from batch Natural jobs.

Step 1. Modify, assemble, and link the Adabas batch link routine

Modify the Adabas link routine for batch (ADALNK) to specify

LRVINFO EQU 256

then assemble and link ADALNK.

Note:
If you elect to use the link routine ADALNKX rather than ADALNK, make this change to ADALNKR and then assemble and link ADALNKR.

Step 2. Link ADALNK with the Adabas Review link routine exit

Link the ADALNK for batch created in step 1 with the Adabas Review 4.3.2 link routine exit. Sublibrary member ASMLNK.X contains the JCS necessary to do this.

Notes:

  1. If you elect to use the link routine ADALNKX, link the batch Review routine to ADALNKR.
  2. For hub mode, Software AG recommends that the modified ADALNK not be placed in the Adabas load library. Adabas uses ADALNK to send its information to the Adabas Review hub. The link routine exits cause unnecessary overhead for this process.

Top of page