This section of the documentation provides installation procedures for Adabas Review in a BS2000 operating system environment. These procedures must be completed by all BS2000 sites installing Adabas Review.
in local mode as an extension of ADALOG;
in hub mode as a server in its own address space with client interface modules in the address space of all Adabas databases to be monitored.
Note that Adabas Review version 4.1 or above is required to monitor Adabas version 8.0 and above databases.
This document covers the following topics:
The Adabas Review installation tape can be unloaded to disk using one of the procedures described below. In these procedures, the following values must be supplied:
In the file names, replace vrs with the current version, revision, and system maintenance level of the product;
Replace xxxxxx with the volume serial number of the tape.
If you are installing Adabas Review 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.
If you are not using SMA, copy the data sets (files) from tape to disk using the procedure described below:
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)
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.
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.
To install Adabas Review under Natural, complete the following steps:
(JOB 1061, step 2600)
INPL the Adabas Review programs and DDMs from the REVvrs.INPL file to your Natural system files.
You can use any of your site-dependent Natural INPL JCL.
The Natural programs are copied into the SYSREVDB library in your FNAT file.
(Job I060 batch; Job I080 online)
To modify the Natural parameter file, complete the following
steps:
Include the minimum following parameter settings in the Natural parameter module that will be used when accessing Adabas Review:
LS=250 PS=80 MADIO=5000 MAXCL=0 ESIZE=40 NTWORK(7),AM=PC
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.
Include the following parameter in all your installation Natural parameter modules: (If this is not done, no data relating to Natural will be reported on.)
ADAPRM=ON
Add a Natural NTFILE definition for the physical database ID and file number of the Adabas Review repository file as follows:
NTFILE 241,dbid,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.
Reassemble and link the NATPARM module to your Natural nucleus.
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, complete the following steps:
Define the SYSREVDB library for the Adabas Review system.
Define the following Adabas Review DDMs to Natural Security as public DDMs:
REVIEW-Adabas-Vvrs-CLOG REVIEW-FNAT REVIEW-Adabas-Vvrs-SYSTEM
(JOB I050, step 2600)
This procedure applies to both local and hub mode installations.
The Adabas Review repository is a system file used for storing user profiles and descriptions of interactive reports, target definitions, and for saving historical data accumulated by Adabas Review reports. Any 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:
This section covers the following topics:
You can use any of your site-dependent ADALOD JCL to load the FDT from the file REVvrs.SYSF using the following ADALOD parameters:
ADALOD LOAD FILE=fnr ADALOD NAME=REVvrs-DBFILE ADALOD VERSION=5 ADALOD ASSOPFAC=10 ADALOD DATAPFAC=10 ADALOD DSSIZE=5 ADALOD NISIZE=500B ADALOD MAXISN=10000 ADALOD NUMREC=3000 ADALOD SORTSIZE=5 ADALOD TEMPSIZE=5
Before submitting the job, change:
the ADALOD LOAD FILE=fnr statement to reflect the number of the file that will contain the Adabas Review repository.
(hub mode) the DATABASE=dbid parameter in the two ADARUN statements to reflect the DBID number of the database that will contain this file.
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.
Use the job you modified in the previous step to load the Adabas Review repository file, JOB I050, step 2600.
To install Adabas Review under Adabas, complete the following steps:
Modify your existing Adabas ADARUN parameters to include the following (these ADARUN cards are generated by SMA):
ADARUN REVIEW=LOCAL
The Adabas Review hub ID value is set using the ADARUN parameter REVIEW.
ADARUN REVIEW=hubid ADARUN UEX5=user-exit
where hubid is the Adabas Review hub ID (version 4.2 and above support two-byte DBIDs) and UEX5 is optional as described in the section User Exit 5 (Adabas Review Hub Event Handler) in the section Operations.
Notes:
Note:
This step is not supported by the automated SMA installation.
The AUTO-START generator job is started automatically by Adabas Review when:
the target definition for the relevant database changes;
the AUTOSTART option in an existing report definition changes;
a new report is defined with the option AUTOSTART=Y;
the GENAUTO or GA command is entered by the user; or
the GENCARD or GC command is entered by the user.
Note:
The AUTO-START generate process is a BS2000 subtask. This is a
spawned task on BS2000. The output for this task is found in the files
L.O.tttt.RAOSAUTO.hex_timestamp
where:
| tttt | is the task number of the Adabas Review nucleus or hub; |
| hex_timestamp | is the STCK value of the clock in hex when the subtask was spawned. |
This section covers the following topics:
The base P.GENERATE job is located in the REVvrs.SRC data set (file) and should be modified appropriately for your site.
Each database running with Adabas Review and the hub needs a set of files and jobs for itself. P.GENERATE generates the files described in the rest of this section to satisfy this need.
prefix.REVvrs.RVUALT prefix.REVIEW.RVUAUT1 prefix.REVIEW.RVUAUT2 prefix.REVIEW.RVUPARM prefix.REVIEW.RVLOG01 prefix.REVIEW.RVLOG02 prefix.REVIEW.RVSUM01 prefix.REVIEW.RVSUM02 prefix.REVIEW.RVUALT.BACKUP prefix.REVIEW.RVUFLD prefix.REVIEW.RVUPRT00 prefix.REVIEW.RVUPRT01 prefix.REVIEW.RVUPRT02 prefix.REVIEW.RVUPRT03 prefix.REVIEW.RVUPRT04 prefix.REVIEW.RVUPRT05 prefix.REVIEW.RVUPRT06 prefix.REVIEW.RVUPRT07 prefix.REVIEW.RVUPRT08 prefix.REVIEW.RVUPRT09 prefix.REVIEW.RVUEXP prefix.REVIEW.RVUEXI prefix.REVIEW.RVUCARD
REVIEW.COPY.db
REVIEW.E.COPYLOG1.db REVIEW.E.COPYLOG2.db REVIEW.P.COPYALT.db
where:
| Item | P.GENERATE Parameter | Description | ||||
|---|---|---|---|---|---|---|
| &ADAL | the name of the Adabas module library | |||||
| db | &DB | Adabas Review database number (local or hub: 5 digits with leading zeros) | ||||
| &FUNC | <blank> - help information: | |||||
|
||||||
| &IDTNAME | 8-character IDT name where the Adabas Review database or hub is to run (must begin with "ADA"). | |||||
| &LOGPFX | RVLOG. This is the prefix of the logging file. | |||||
| &LOGSIZE | If "0", it operates as in Adabas Review 4.4 and the log file will be continuously written to. If a value greater than zero (>0), a file with no secondary extent will be created. When this is full, the next RVLOG (nn+1) will be opened and written to. | |||||
| prefix | &PREFIX | a prefix to the files for easy maintenance (in this documentation, the example prefix is DB099) | ||||
| &REPDB | database number (5 digits with leading zeros) of the Adabas Review repository file where the REVvrs.SYSF file was loaded. | |||||
| REVvrs | &REV | the current Adabas Review version, revision, and system maintenance level | ||||
| &REVL | the name of the Adabas Review module library | |||||
| &SUMFX | RVSUM. This is the prefix of the summary file. | |||||
| &SUMSIZE | If "0", it operates as in Adabas Review 4.4 and the summary file will be continuously written to. If a value greater than zero (>0), a file with no secondary extent will be created. When this is full, the next RVSUM (nn+1) will be opened and written to. | |||||
|
Note: |
||||||
Adabas Review report definitions specify whether the data accumulated by the report is also written to the Adabas Review repository. The reports can then be viewed again or combined with previous occurrences of the same report to produce a combined summary report.
Because Adabas Review cannot write to the Adabas Review repository directly when running in local mode, it writes an intermediate history file either at intervals or at Adabas termination. At the next Adabas startup, Adabas Review reads the file with the link name RVUALT and populates its system file with history data.
Note:
The Adabas Review history file population process is a BS2000 subtask. This
is a spawned task on BS2000. The output for this task is found in the files
L.O.tttt.RAOSHIST.hex_timestamp
where
| tttt | is the task number of the Adabas Review nucleus or hub; |
| hex_timestamp | is the STCK value of the clock in hex when the subtask was spawned. |
This section describes how to modify the Adabas local mode startup JCL and the hub mode client interface JCL.
An example Adabas Review local mode startup job is provided in REVvrs.SRC(LOCAL).
Note:
The example job LOCAL in the REVvrs.SRC
library on BS2000 does not set the DBID parameter because we believe that
setting a default DBID in this job might lead to problems in the setup of the
environment. Instead, the DBID should be specified in the Natural area of Adabas Review
for the default DBID in the user profile, or the Natural LFILE=(241,...)
parameter. And for the Adabas Review hub database, the REVIEW parameter should set the
hub DBID (or if is LOCAL, then it is its own DBID).
Modify the Adabas startup JCL as follows (these modifications are
generated by SMA):
Add the following step after the nucleus has been terminated to copy the RVUALT file to a backup file that is read by RAOSHIST:
/SET-JOB-STEP /CALL-PROC REVIEW.P.COPYALT.db
where REVIEW.P.COPYALT.db was generated by P.GENERATE above.
Add the FILE/LINK statements required for Adabas Review. Use the file REVIEW.COPY.db that was generated by P.GENERATE above.
If for some reason you do not want to use the generated file, you can add the following cards to the deck instead:
/SET-FILE-LINK RVUALT,DB099.REVIEW.RVUALT /SET-FILE-LINK RVUAUT1,DB099.REVIEW.RVUAUT1 /SET-FILE-LINK RVUAUT2,DB099.REVIEW.RVUAUT2 /SET-FILE-LINK RVUPARM,*DUMMY /SET-FILE-LINK RVLOG01,DB099.REVIEW.RVLOG01 /SET-FILE-LINK RVLOG02,DB099.REVIEW.RVLOG02 /SET-FILE-LINK RVSUM01,DB099.REVIEW.RVSUM01 /SET-FILE-LINK RVSUM02,DB099.REVIEW.RVSUM02 /SET-FILE-LINK RVUFLD,DB099.REVIEW.RVUFLD /SET-FILE-LINK RVUPRT00,DB099.REVIEW.RVUPRT00 /SET-FILE-LINK RVUPRT01,DB099.REVIEW.RVUPRT01 /SET-FILE-LINK RVUPRT02,DB099.REVIEW.RVUPRT02 /SET-FILE-LINK RVUPRT03,DB099.REVIEW.RVUPRT03 /SET-FILE-LINK RVUPRT04,DB099.REVIEW.RVUPRT04 /SET-FILE-LINK RVUPRT05,DB099.REVIEW.RVUPRT05 /SET-FILE-LINK RVUPRT06,DB099.REVIEW.RVUPRT06 /SET-FILE-LINK RVUPRT07,DB099.REVIEW.RVUPRT07 /SET-FILE-LINK RVUPRT08,DB099.REVIEW.RVUPRT08 /SET-FILE-LINK RVUPRT09,DB099.REVIEW.RVUPRT09 /SET-FILE-LINK RVUEXP,DB099.REVIEW.RVUEXP /SET-FILE-LINK RVUEXI,DB099.REVIEW.RVUEXI /SET-FILE-LINK RVUCARD,DB099.REVIEW.RVUCARD
Notes:
Set up a sequential file with the following contents:
ADALNK IDTNAME=idtname
where idtname is an 8-character IDT name where the Adabas Review is running, the same as in the ADARUN cards. The file must be a permanent file because it supplies routing and buffer information to the subtask.
Then set the following link card in the nucleus startup job
/SET-FILE-LINK DDLNKPAR,ddlnkpar_file_name
where ddlnkpar_file_name is the file name of the permanent sequential file above.
Ensure that the REVBvrs.MOD library is accessible from the executed ADARUN job by declaring the following BLSLIB card:
/START-PROGRAM (Adabas.MOD,ADARUN),RUN-MODE=ADV (ALT-LIB=YES)
Ensure that Adabas can access the Adabas Review default link name and alternative libraries as declared by BLSLIB above by including the following statement:
/SET-FILE-LINK ADALIB,ADAvrs.MOD /SET-FILE-LINK REVLIB,REVvrs.MOD /SET-FILE-LINK BLSLIB00,REVvrs.MOD /SET-FILE-LINK BLSLIB01,ADAvrs.MOD
Repeat the following four substeps for each database to be monitored.
Important: If you are currently running Adabas Review DB 3.4 or below, you must completely deinstall it from the Adabas startup JCL.
To modify the Adabas startup JCL for the hub mode client
interface:
Use the following BLSLIB structure:
*/SET-FILE-LINK DDLIB,Adabas.MOD /SET-FILE-LINK REVLIB,REVvrs.MOD /SET-FILE-LINK BLSLIB00,REVvrs.MOD /SET-FILE-LINK BLSLIB01,ADAvrs.MOD
Add a DDLOG or DDCLOGR1/DDCLOGR2 file.
This DDLOG FILE card must point to a physical output file and must not be coded as DUMMY and not be allocated as a temporary file.
Note:
If Adabas command logging (single or dual) is already being
used, this portion of this step can be omitted.
Use the following to ensure that Adabas can access alternative libraries as declared by BLSLIB above:
START-PROGRAM (Adabas.MOD,ADARUN),RUN-MODE=ADV (ALT-LIB=YES)
Restart Adabas.
Upgrade the Adabas Review module libraries with Adabas fixes.
Adapt the procedures BS2ZAP and ADAvrs.Z0000 in REVvrs.ZAPS, then run ADAvrs.ZAPS where vrs is the version, revision, and system maintenance level of the Adabas Review being installed.
Complete the steps in this section to install the Adabas Review hub.
An example Adabas Review hub mode startup job is provided in REVvrs.SRC(HUBJCL).
Note:
The example job HUBJCL in the REVvrs.SRC
library on BS2000 does not set the DBID parameter because we believe that
setting a default DBID in this job might lead to problems in the setup of the
environment. Instead, the REVIEW parameter should set the hub DBID for the hub
database (or if is LOCAL, then it is its own DBID).
Modify the Adabas startup JCL as follows (these modifications are
generated by SMA):
Correct any library names or file names.
Modify the ADARUN parameter REVIEW to reflect the target DBID you will use for the Adabas Review hub.
Specify the ADARUN parameter IDTNAME, if necessary. This value must be the same as that used by the sending Adabas nuclei.
The ADARUN parameters supplied in the sample JCL member HUBJCL are the only ones recognized for setting up the hub nucleus. See the section ADARUN Parameters for information about these ADARUN parameters.
Software AG recommends that you set the dispatching priority of the Adabas Review hub higher than that used by the sending Adabas nuclei.
Set up a sequential file with the following contents:
ADALNK IDTNAME=idtname
where idtname is an 8-character IDT name where the Adabas Review is running, the same as in the ADARUN cards. The file must be a permanent file because it supplies routing and buffer information to the subtask.
Then set the following link card in the nucleus startup job
/SET-FILE-LINK DDLNKPAR,ddlnkpar_file_name
where ddlnkpar_file_name is the file name of the permanent sequential file above
See the section Starting Adabas Review.
This section describes optional installation procedures
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.
