Adabas Review can be installed in local mode in the Adabas address space, or as a hub (server) 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 document describes Phase 1, which comprises all the steps that are independent of any particular TP monitor environment, as follows:
To complete Phase 1 of the installation, read the sections in Phase 1 that apply to the type of installation you have chosen and follow the steps described in those sections in order they are described in this document.
Note
Instructions for copying the tape contents to disk are provided in
Copying the Tape
Contents.
Phase 2, which comprises the steps that are specific to the TP monitor being used, is described in Installation: Phase 2
You must install a valid license file on all mainframe platforms in which your Software GmbH mainframe product 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.
For a full product list of license file names, load modules and DD/Link names, refer to the Adabas installation documentation.
Note
Forty days before the license expires (thirty if your MLC is version 1.3.8 or lower),
license check failure messages are produced. Your software product will still function,
but these messages warn you that it is time to obtain a new license.
In the following steps, you will prepare the license file and then install it:
The product license file is supplied on the individual customer installation tape or separately via an e-mail attachment. Before you can install the license, you must transfer it from e-mail or the installation tape and store it on a z/OS system. This section describes how to do this for a license distributed either by e-mail or on the installation tape.
Note
Adabas Review 5.3.1 now requires a unique product license (REVLIC) along with the
ADA zIIP license (ADARPLIC) if you have a zIIP product license. For distribution
purposes, these will be known as REVvrs.LICS and
REVvrs.LICZ.
To prepare the license file from an e-mail attachment, complete the following
steps:
Transfer the license to z/OS, as described in the Adabas documentation Software GmbH Mainframe Product Licensing > Transferring a License File from PC to a z/OS Host Using FTP.
Verify that the transferred license file is stored in an Adabas Review 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
step:
Verify that the license file is stored from the tape into an Adabas source library (with RECFM=F or FB and LRECL=80), taking care to preserve its format as ASCII.
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 (REVLIC) that is then loaded by Adabas Review.
You can reference the license file in the Adabas Review startup job by DD statement.
This section describes both methods.
To convert the license file to a load module, complete the following steps:
Review and modify sample job ASMLICAM in the ADAvrs.JOBS library, as follows:
Set the variable MLCLOAD to point to the license load library (MLCvrs.LOAD).
Set the variable USRLOAD to point to an appropriate user load library.
Note
This user load library must also be included in the STEPLIB concatenation for
Adabas Review.
Set the LICFILE parameter to point to the dataset containing the Adabas Review license file you transferred to z/OS earlier.
Set the LMOD parameter to the load module name REVLIC.
Submit sample job 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 REVLIC, which is stored in the specified user load library (USRLOAD). For more information about the LICUTIL utility, refer to the Adabas documentation's Software GmbH Mainframe Product Licensing > Using the License Utility: LICUTIL.
Update your Adabas Review to reference the user load library so REVLIC will be loaded by Adabas Review at startup.
To reference the license file in Adabas Review, complete the following steps:
Make sure any previously created REVLIC load module is inaccessible to your Adabas Review jobs. Adabas Review first tries to load REVLIC and, if unsuccessful, it reads from a dataset defined to the DD statement DDLREV.
Update your Adabas Review jobs to reference the license.
This section applies to both local and hub mode installations. It includes the following steps:
Note
The entire Adabas Review application is stored in the SYSREVDB
library. User profiles are stored in the SYSREVDU library.
INPL the Adabas Review programs and DDMs from the INPL data set to your Natural system files.
You may use any of your site-dependent Natural INPL JCL. Sample job REVINPL is provided in the Adabas Review jobs library.
Note
If you want to use Adabas Review together with Predict, your DDMs
should be stored in a valid FDIC system file. For detailed information please
refer to the relevant sections concerning DDMs in the
Predict documentation and the Natural
documentation.
Include the following parameter settings in the Natural profile:
| Parameter | Requirement |
|---|---|
| LS=250 | minimum |
| PS=80 | minimum |
| MADIO=5000 | minimum |
| MAXCL=0 | minimum |
| ESIZE=64 | minimum |
| ADAPRM=ON | required. ADAPRM=ON must be specified in order to use Adabas Review to report on Natural information. |
| NTWORK(nn),,AM=STD,DEST='WORK**' | Optional. May be used as download target when working with DISPLAY=EDITOR. The number of the work file is taken from the setting of PC-FILE in CONFIGDB. |
| NTWORK(7),AM=PC,OPEN=ACC | required for PC downloads. NTWORK
is a Natural macro used to define the work file(s) to be used; AM is the access
method. OPEN=ACC specifies that the work file will be opened when it is first
accessed by a statement. For more information, see the Natural documentation.
Note |
| NTPRINT(1) | Review uses Natural printer 1 to generate report display programs in the Natural source area. Working with DISPLAY=EDITOR respectively, the new Editor display programs you may enter a printer name, used in the DEFINE PRINTER OUTPUT syntax element. For more information see the Natural documentation. |
| COMP | Parameters for Com-plete. Set the value for NTHSIZE greater than 2400. |
Add a Natural NTLFILE definition for the physical database ID and file number of the Adabas Review repository file as follows:
NTLFILE 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.
To use the Software AG Editor display programs (DISPLAY=EDITOR in CONFIGDB), make sure the Software AG Editor is active and setup properly. Either setup a work file for the Software AG Editor, or set the EDPSIZE. For more information see section Operating the Software AG Editor in the Natural for Mainframes documentation.
If Natural Security is installed, complete the following
steps:
Define the SYSREVDB library for the Adabas Review system and the SYSREVDU library for the Adabas Review user profiles to Natural Security. Verify that the LIST command is allowed in the SYSREVDU library and that the READ command is allowed for the SYSREVDB library.
Note
If the Adabas Review application SYSREVDB is made private (i.e.,
the parameter People-protected=Y is specified), each user of Adabas Review must be
linked to the SYSREVDB application.
Define Adabas Review files to Natural Security as public DDMs:
REVIEW-ADABAS-CLOG REVIEW-ADABAS-SYSTEM
Note
AOSASM is delivered in the Adabas load library. If Adabas
Online Services (AOS) are installed, AOSASM is already available.
To make AOSASM available to the Natural nucleus
For a Com-plete or CICS environment, link the correct object module with the Natural TP nucleus.
If a split Natural nucleus is to be installed, the AOSASM module must be linked to the shared portion of the nucleus and not to the thread portion.
This section 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.
This step includes the following substeps:
Important
Users loading a new Adabas Review repository should run Steps 1 and
2 only and omit Step 3. Users converting the Adabas Review repository from a previous
release should omit Steps 1 and 2 and run Step 3
only.
Before submitting the job REVLOAD provided in the Adabas Review jobs library, change:
the DBID=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 modified in step 1.
If you used the same repository file for a version of Adabas Review older than this release, Adabas Review requires that you convert your repository file and history data prior to running any new reports in this release of Adabas Review. For complete information on doing this, read Migration from Previous Versions .
This section includes the following steps:
For information about the relevant ADARUN parameters, read ADARUN Parameters for Adabas Review. Then modify the Adabas ADARUN parameters to include the following:
local mode only:
ADARUN PROGRAM=ADANUC ADARUN REVIEW=LOCAL ADARUN CLOGLAYOUT=8
hub mode only for each database to be monitored by Adabas Review:
ADARUN PROGRAM=ADANUC ADARUN REVIEW=hubid ADARUN UEX5=user-exit (optional)
where hubid is the Adabas Review hub ID and UEX5 is optional (see Operations).
Note
For running the Review processor in local or hub mode, you can set the ADARUN
parameter LOGGING to NO, but you still need to set all
other appropriate parameters, such as LOGCB and LOGCLEX,
to YES. Setting LOGGING to NO results in no
command log being displayed, but all other parameters still pass information to
Review. If you use the command log as input for the Review batch, you need to set
LOGGING to YES just like the other parameters.
Perform one of the sets of steps below, depending on whether you are installing Adabas Review in local mode or in hub mode:
Before you modify the Adabas startup JCL, you may need to increase the REGION parameter for the Adabas nucleus job step to accommodate Adabas Review. Make sure the buffer allocated by BUFFMB fits into the REGION.
This section covers the following topics:
The RVUALT DD statement refers to the data set that contains the alternate history file. You may use the same data set you used for earlier versions.
The MAKEALT member of the jobs library contains sample JCL to create a RVUALT data set.
If Adabas Review is installed on multiple databases, a RVUALT data set must be allocated for each database.
Refer to the Operations for RVUALT guidelines.
The RVUAUT1 DD statement refers to the data set that contains the report definitions for autostarted reports. This statement points to members of a PDS; however, RVUAUT1 can be defined to point to a sequential data set if desired.
You can use the distributed RVUAUT1 file from earlier versions.
To modify the Adabas startup JCL for local mode:
Add the following DD statements to the Adabas startup JCL, replacing the vrs with the current version, revision, and system maintenance level number for Adabas Review:
//RVUEXI DD DISP=SHR,DSN=REVvrs.SRCE(RVUEXI) //RVUEXP DD SYSOUT=X,LRECL=80 //RVUALT DD DISP=SHR,DSN=REVvrs.ALTHIST //RVUAUT1 DD DISP=SHR,DSN=REVvrs.SRCE(RVUAUT1) //RVUCARD DD DISP=SHR,DSN=REVvrs.SRCE(RVUCARD) //RVUFLD DD DISP=SHR,DSN=REVvrs.SRCE(RVUFLD) //RVUPARM DD DUMMY //RVUPRT00 DD SYSOUT=X,LRECL=80 //RVUPRT01 DD SYSOUT=X,LRECL=160 //RVUPRT02 DD SYSOUT=X,LRECL=160 //RVUPRT03 DD SYSOUT=X,LRECL=160
Add the Adabas Review load library to the Adabas STEPLIB concatenation.
Note
To retain APF authorization for Adabas, you must
authorize the Adabas Review load library as well when it is added to the Adabas STEPLIB
concatenation.
To install the Adabas Review client interface, repeat the following
instructions for each database to be monitored. Note that each database to be
monitored must use the same SVC as the Adabas Review hub.
Apply the required zaps.
Ensure that an unmodified ADALNK is available to Adabas in the Adabas load library or in a library concatenated before the Adabas load library.
ADALNK is loaded by Adabas to send information to the Adabas Review hub. Link routine exits such as RDBLXMVS or UEXB are not useful for the process of sending data to the hub and create unnecessary overhead when included in the ADALNK.
Put ADALNKs that include exits into another library.
Important
If an ADALNK batch link routine has been linked or modified by other
product modules or user exits, it cannot be used in any application startups of
Adabas utility jobs or Adabas, Entire System Server, Adabas Review Hub, or Entire
Net-Work nuclei.
Modify the ADARUN parameters of the database.
If the Adabas ADARUN parameter LOGCLEX=Y is specified to write the Review specific Command Log Extension (CLEX) to the command log, the Adabas Review library must be available in the client address space. If Review modules are not available, the warning message ARVU20 is issued.
Restart Adabas.
To install the Adabas Review Hub, complete the steps described in this section:
Use the sample JCL member MAKEALT.
This 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 data set you used for earlier versions. Refer to Operations for RVUALT guidelines.
Correct any library names or file names.
Modify the ADARUN parameter REVIEW=hubid to reflect the target ID you plan 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 HUBJCL are the only ones recognized for setting up the hub nucleus. For more information about these ADARUN parameters, read ADARUN Parameters for Adabas Review.
Note
We recommends that you set the dispatching priority of the Adabas Review hub higher than
that of the sending Adabas nuclei.
The RVUALT DD statement refers to the data set that contains the alternate history file.
The RVUAUT1 DD statement refers to the data set that contains the report definitions for autostarted reports. This statement points to members of a PDS; however, RVUAUT1 can be defined to point to a sequential data set if desired.
You can use the RVUAUT1 file distributed with Adabas Review.
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.
Note
The STEPLIB needs to be APF-authorized.
The following optional installation procedures may be completed as part of Phase 1 of the Adabas Review installation:
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 both to local and hub mode installations.
To report on Natural activity from a batch Natural job:
Modify and relink the Adabas link routine for batch/TSO as described in Install Adabas Review under Batch/TSO .
