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:
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 |
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.
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 |
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.
.A is used for Assembler code, examples, etc.;
.X indicates job control statements or job streams.
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. |
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.
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. |
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 /* /&
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 /* /&
This section applies to both local and hub mode installations.
INPL the Adabas Review programs and DDMs from the INPL dataset to your Natural system files.
You may use any of your site-dependent Natural INPL JCS. Sample job REVINPL.X is provided in the Review library.
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. |
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.
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.
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:
Define the SYSREVDB library for the Adabas Review system.
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
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:
Before submitting the job REVLOAD.X provided in the Review sublibrary, change
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.
the SVC=svc parameter of the same two ADARUN statements to reflect the number of the SVC used for the database defined in the above step; and
the ADALOD LOAD FILE=fnr statement to reflect the number of the file that will contain the Adabas Review file.
Load the Adabas Review repository file using the job REVLOAD.X as modified in step 1.
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.
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 |
Execute the modified DBFILES.X.
Execute the modified DBFILES.X.
See the section ADARUN Parameters for information about the relevant ADARUN parameters.
Modify your existing Adabas ADARUN parameters to include the following:
local mode only:
ADARUN REVIEW=LOCAL
hub mode only for each database to be monitored by Adabas Review:
ADARUN REVIEW=hubid ADARUN UEX5=user-exit (optional)
where hubid is the Adabas Review hub ID and UEX5 is optional (see section User Exit 5 (Adabas Review Hub Event Handler).
Required ZAPS are delivered in the REV431.ZAPS dataset on the installation tape.
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
RVUALT refers to the dataset that contains the alternate history file. You may use the same dataset you used for earlier versions.
If Adabas Review is installed on multiple databases, a RVUALT dataset must be allocated for each database.
Refer to section RVUALT History File in Operations for RVUALT guidelines.
RVUAUT1 and RVUAUT2 Considerations
RVUAUT1 and RVUAUT2 refer to the datasets that contain the report definitions for autostarted reports.
You can use the distributed RVUAUT1 and RVUAUT2 files from earlier versions.
To modify the start-up JCS for local mode
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
Modify the Adabas start-up JCS to execute the Adabas Review procedure and add the Review sublibrary to the LIBDEF search chain.
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.
Provide access to the Review sublibrary in the LIBDEF concatenation.
Restart Adabas.
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.
Provide access to the Review sublibrary in the LIBDEF concatenation.
Restart Adabas.
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.
Modify and run the sample job stream ARCHIVE.X in the Review sublibrary to define Adabas Review to MSHP.
Correct any library names or file names.
Modify the ADARUN parameters:
Modify the ADARUN parameter REVIEW
to
reflect the TARGET ID you wish to use for the Adabas Review hub.
Modify the ADARUN parameter SVC
to reflect
the correct SVC number. This SVC must be the same as that used by the sending
Adabas nuclei.
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.
Modify the ADARUN parameters:
Modify the ADARUN parameter REVIEW
to
reflect the TARGET ID you wish to use for the Adabas Review hub.
Modify the ADARUN parameter SVC
to reflect
the correct SVC number. This SVC must be the same as that used by the sending
Adabas nuclei.
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.
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.
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 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:
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.
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.
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: