This section of the documentation describes operational procedures and processes for Adabas Review after it has been installed and initialized.
This document covers the following topics:
Adabas Review spawns the following subtask jobs:
In local mode, the Adabas Review database and in hub mode, the Adabas Review hub spawns a job where the Adabas Review subtask REVIEWB runs.
When an automatically generated report is started, a job running REVAUTO is started.
When a history report is started, a job running RAOSHIST is started.
Each of these jobs generates a SYSLST file with the following file name structure:
L.<L/O>.<task_number>,<subtask>,<timestamp>
where
The files provide important diagnostic information when errors occur within the system. They may, however, accumulate in number over time so that it becomes necessary to delete them.
To delete all accumulated Adabas Review subtask listings
Use the commands
/DELETE-FILE L.*REVIEWB#* /DELETE-FILE L.*RAOSAUTO* /DELETE-FILE L.*RAOSHIST*
The Adabas Review main task in both local and hub modes is protected by a system exit routine. In local mode, the system exit routine protects the Adabas nucleus; in hub mode, it protects the Adabas Review clients (also Adabas nuclei).
In local mode, if Adabas Review processing terminates abnormally (abends) in RAOSLOCL, the Adabas Review system exit routine is given control.
The system exit routine traps the abend, and prints diagnostic information and a dump to expedite the analysis and resolution of the abend. The routine also disables Adabas Review processing for the remainder of the Adabas nucleus session.
If you need help resolving the abend, contact your Software AG technical support representative with the printed information.
Adabas is protected from termination if Adabas Review abends. Adabas processing will continue without interruption.
Users attempting to access Adabas Review following a trapped abend will receive the following message:
Adabas Review not installed on database
The progress of the error handling routine is reported by messages written to the console.
This section describes the files used by Adabas Review:
Note:
The RVUPRT00 data set is mandatory for the Adabas Review processor.
Omitting this data set prohibits the start of the subtask and affects the
subsequent use of SYSREVDB for Adabas Review administration. For example, the TECH
command within SYSREVDB can yield unpredictable results when Adabas Review is started
without the RVUPRT00 data set. Other files described in this section can be
omitted if not needed.
The RVLOGnn files are sequential command logging files. There may be more than two command logging files. If the files are given no secondary extent, data will be continued in the next RVLOGnn (nn+1) file. When the last command logging file has filled, command logging will start overwriting the data in RVLOG01. The P.GENERATE job can be amended to create more than two command logging files, as needed by your installation.
Each report performing command logging must reference a unique file name prefix and a number of command log files associated with that file name prefix.
Note:
All command log data sets (files) for a particular report must
be the same size.
Refer to the section Command Logging Considerations for more information.
The RVSUMnn files are sequential summary logging files. There may be more than two summary logging files. If the files are given no secondary extent, data will be continued in the next RVSUMnn (nn+1) file. When the last summary logging file has filled, summary logging will start overwriting the data in RVSUM01. The P.GENERATE job can be amended to create more than two summary logging files, as needed by your installation.
Each report performing summary logging must reference a unique file name prefix and a number of summary log files associated with that file name prefix.
Note:
All summary log data sets (files) for a particular report must
be the same size.
Adabas Review summary logging under BS2000 is an optional feature. BS2000 uses its own summary logging files.
Refer to the section Summary Logging Considerations for more information.
RVUALT is an alternate sequential file used to save history data.
Adabas Review reports may specify whether the data accumulated by the report will also be written to the Adabas Review repository. Historical data is useful for monitoring database performance and for performing trend analysis.
The parameters that determine whether Adabas Review writes historical data are set when a user creates or edits a report definition. These history parameters appear on the Report Options screen of the Edit Report (ER) function.
If historical data is to be written by a report running in batch mode, the history parameters make up the COPY statement.
The Adabas Review startup job contains a RVUALT job control statement. This statement identifies an alternate file to which historical data may be written.
In situations where the Adabas Review repository is unavailable, Adabas Review receives a response code 148.
In this case, Adabas Review writes the data to the file specified by the RVUALT job control statement, if it has been assigned in the job stream. The next time the Adabas Review hub is started, another subtask is started to copy the historical data to the Adabas Review repository.
Note:
A separate RVUALT data
set (file) must be allocated for each Adabas Review hub.
For BS2000 systems, allocate this file using P.GENERATE.
Note:
Ensure that the RVUALT data set is large enough to store all
the data Adabas Review writes to it. Monitor the RVUALT data set and take appropriate
action if the data set becomes full.
RVUAUT1 and RVUAUT2 are data sets that contain the report definition control statements for autostarted reports and also some system relevant session parameters such as buffer sizes (for more information, read INPUT Statement. Adabas Review generates the statements and writes them to these files whenever online the target definition parameters are changed (read Displaying SVC Lists and Target Objects) or an autostarted report is created or changed.
When Adabas is initialized, the reports are started automatically.
For BS2000 systems, generate these files using P.GENERATE.
Note:
In a future release of Adabas Review, RVUAUT2 will no longer be
supported. RVUAUT1 only will be used for autostarted reports.
RVUCARD is a data set (file) used by the GENCARD command. The GENCARD command creates batch parameter statements from report definitions created online.
For BS2000 systems, the command requires the user to supply a DDNAME, and the generated statements are written to the corresponding file.
RVUEXI is a parameter file that contains parameters to control the Adabas Review operating environment. The Adabas Review administrator may edit the RVUEXI parameters according to the specific needs of the site.
Refer to section Editing the RVUEXI Parameter File for more information.
RVUEXP is a companion file to RVUEXI and if specified, any parameter processing errors encountered in RVUEXI will be written to the RVUEXP output file.
The RVUFLD data set (file) contains parameter control statements for creating user-defined fields. Parameters in this data set (file) define the length, type, and location of reporting fields to be determined by the user.
Software AG recommends that you set RVUPARM as a dummy data set. In previous releases, batch parameter statements were read from this file. Because these statements may now be generated using the GENCARD command, you no longer need to code batch parameters manually. Parameters may be coded in this data set (file) if desired, and Adabas Review will access this data set (file) prior to accessing data sets (files) specified by RVUAUT1 and RVUAUT2.
For BS2000 systems, use the data set (file) *DUMMY.
Notes:
RVUPRT00 is the Adabas Review logical printer for statistics about Adabas Review operations, such as number of reports, number of records processed, etc.
Note:
The RVUPRT00 data set is mandatory for the Adabas Review processor.
Omitting this data set prohibits the start of the subtask and affects the
subsequent use of SYSREVDB for Adabas Review administration. For example, the TECH
command within SYSREVDB can yield unpredictable results when Adabas Review is started
without the RVUPRT00 data set. Other files described in this section can be
omitted if not needed.
RVUPRT01 and above are Adabas Review logical printers used for reports. One logical printer is shared by all summary reports; each detail report requires its own logical printer. A job control statement corresponding to each logical printer must be added to the Adabas Review hub startup JCL (hub mode) or to the Adabas nucleus startup JCL (local mode).
Assignment of logical printers to reports depends on the order in which the reports are started:
If the first report started is a summary report, RVUPRT01 is used for all summary reports.
If the first report is a detailed report, RVUPRT01 is assigned to the detailed report, and another logical printer is used for summary reports. When a detail report is purged, the corresponding printer number is freed. The next detail report started will reuse the lowest available printer number.
RVUSEQ specifies a sequential input file that contains Adabas command log records. This file is either created by Adabas or by Adabas Review. If you use Adabas dual command logging, you must first use the Adabas utility function ADARES CLCOPY to generate a sequential command log data set suitable for input into Adabas Review.
RVUEXI is a parameter file that contains parameters which control the Adabas Review operating environment. The Adabas Review administrator may edit the following RVUEXI parameters according to the specific needs of the site:
Note:
Default values are underlined in the following tables.
| Parameter | Possible Values | Default |
|---|---|---|
| UIDT-CELLS | 100-10000 | 1000 |
The user ID table is managed using a hashing algorithm. This value is numeric and specifies the number of 8-byte cells that should be allocated to the user ID table manager.
| Parameter | Possible Values | Default |
|---|---|---|
| UCMD-TIMEOUT | 0-999 | 60 |
A small reentrant storage area is allocated for each active user of the Adabas Review online system (LIST, VIEW, START, PURGE reports functions). This area is deallocated when the user finishes each online request.
However, if the user's Natural session terminates abnormally during an Adabas Review operation, the Adabas Review nucleus may not have the opportunity to deallocate the reentrant area.
Specifying the UCMD-TIMEOUT parameter gives the Adabas Review nucleus a timeout value after which these inactive areas are deallocated. The timeout value is numeric and is specified in minutes.
| Parameter | Possible Values | Default |
|---|---|---|
| UIDT-TIMEOUT | 1-999 | 60 |
To report on the field TPTRANCT, Adabas Review must maintain a work area for each user that accesses Adabas. This area is called the user ID table.
If this field is specified in a report, the facility is activated and an area is allocated when Adabas Review receives the first call from each user. The area is deallocated when Adabas Review receives an Adabas CLOSE (CL) command for that user.
However, if the user's application does not issue a CL during termination, Adabas Review is unaware that the session has terminated.
The UIDT-TIMEOUT parameter is used to expire inactive user ID table elements. If the field TPTRANCT is not specified in any active reports, Adabas Review will not maintain user ID table elements for each user. This value is numeric and specifies the timeout value in minutes.
This section discusses administrative considerations when performing Adabas Review command logging.
Adabas Review provides you with options for determining how command logging is processed for reports. However, the Adabas Review administrator must complete the following tasks to set up the Adabas Review environment so that command logging can take place:
Allocate command log data sets (files). Command log data sets (files) must be allocated for reports.
Add job control statements to the Adabas Review hub startup JCL (hub mode) or to the Adabas nucleus startup JCL (local mode).
Each report that performs command logging must have a command log file assigned to it. For each command log file, there must be a corresponding job control statement in the startup JCL.
The name must be a five-character name followed by a sequential number (01, 02, etc.) corresponding to the number of command logs. For example, if the name is "CMLOG" and there are two data sets (files) to be defined, two statements are required with names as follows: CMLOG01 and CMLOG02. The five-character name is referenced by the report in the File command logging report option. The total number of data sets (files) is referenced by the report in the Num of Logs command logging report option. For more information about these logging options, read Logging Options.
Refer to the section RVLOG01 and RVLOG02 Command Logging Files for more information.
Adabas Review writes to command log files in sequential order. When a command log file is filled, Adabas Review closes the file, switches to the next sequential file, and continues logging. When all files have been filled, Adabas Review switches back to the oldest file to log data. If a command logging user exit is not specified, Adabas Review will write over the log data in the file containing the oldest data.
A command logging user exit can be specified so that the data contained in the command log file can be copied to a new file before the command log file is overwritten with new command log data. This user exit will be called each time a command log file is closed or opened, but it is only called if you reference it in the User Exit report logging option. For more information about this logging option, read Logging Options.
For complete information about the command logging user exit, read REVUXLOG: Command or Summary Logging User Exit
This section discusses administrative considerations when performing Adabas Review summary logging.
Adabas Review provides you with options for determining how summary logging is processed for reports. However, the Adabas Review administrator must complete the following tasks to set up the Adabas Review environment so that summary logging can take place:
Allocate summary log data sets (files).
Summary log data sets (files) must be allocated for reports.
Add job control statements to the Adabas Review hub startup JCL (hub mode) or to the Adabas nucleus startup JCL (local mode).
Each report that performs summary logging must have a summary log file assigned to it. For each summary log file, there must be a corresponding job control statement in the startup JCL.
The name must be a five-character name followed by a sequential number (01, 02, etc.) corresponding to the number of summary logs. For example, if the name is "SMLOG" and there are two data sets (files) to be defined, two statements are required with names as follows: SMLOG01 and SMLOG02. The five-character name is referenced by the report in the summary file summary logging report option. The total number of data sets (files) is referenced by the report in the Num of Logs summary logging report option. For more information about these logging options, read Logging Options.
Refer to the section RVSUM01 and RVSUM02 Summary Logging Files for more information.
Adabas Review writes to summary log files in sequential order. When a summary log file is filled, Adabas Review closes the file, switches to the next sequential file, and continues logging. When all files have been filled, Adabas Review switches back to the oldest file to log data. If a summary logging user exit is not specified, Adabas Review will write over the log data in the file containing the oldest data.
A summary logging user exit can be specified so that the data contained in the summary log file can be copied to a new file before the summary log file is overwritten with new summary log data. This user exit will be called each time a summary log file is closed or opened, but it is only called if you reference it in the Log Full Exit report logging option. For more information about this logging option, read Logging Options.
For complete information about the summary logging user exit, read REVUXLOG: Command or Summary Logging User Exit
The Adabas Review administrator can modify configuration parameter values in the Natural text member CONFIGDB.
To access and modify the CONFIGDB parameters
At the Natural NEXT prompt, type LOGON SYSREVDB and press ENTER.
Type the command EDIT CONFIGDB and press ENTER.
Type SAVE and press ENTER to save the changes.
Type MENU at the prompt to return to Adabas Review.
The rest of this section describes the CONFIGDB file parameters.
The CONFIGDB file contains parameters that affect Adabas Review. It is saved in the Natural library SYSREVDB.
| Parameter | Possible Values | Default | Description |
|---|---|---|---|
| AVG-MEAN | AVG | MEAN | AVG | Specifies whether the term "AVG" or "MEAN" appears on reports and SYSREVDB screens where average (mean) values are displayed. |
| CLOSE-DBID | YES | NO | NO | Specifies whether to issue a close (CL) command to the old Adabas Review database when a new database is accessed with the HUB= (DBID=) command. |
| CURSOR-POSITION | BOT | TOP | BOT | Specifies whether the cursor is placed on the command line (BOT) in list displays, or on the SEL field (TOP). |
| DECIMAL-CHAR | NAT|char | NAT | Specifies the decimal character to use when generating Review reports. The value specified overrides the value specified for the NATPARM DC parameter. If the value specified is NAT then the value specified in the NATPARM DC parameter is used. To determine the current setting of the NATPARM DC parameter, issue GLOBALS at the NEXT prompt. |
| MAXIMUM-MAXK | 0 | nnnn | 0 | Specifies the maximum value that can be
specified for the report option, Max K. The Max K value determines the maximum
amount of storage available for a specific report.
A value of 0 (the default) indicates that the Max K option is not restricted. When specifying a value, MAXIMUM-MAXK must be 4 or greater for z/OS. |
| OPEN-DBID | YES | NO | NO | Specifies whether an open (OP) command is issued to the new Adabas Review database when a new database is accessed with the HUB= (DBID=) command. |
| PC-FILE | 'text' | 'DOWNLOAD-PC-FILE-5' | Specifies the value to be used in the DOWNLOAD statement in the Review-generated programs. The value specified must be delimited with single apostrophes. The field is alphanumeric, maximum 20 characters. |
| REVIEWDB-UEX | name | exit not enabled | Specifies the name of the site-dependent
Natural routine to be called for validation of a user's access to an Adabas
Review function.
Refer to Natural source member N-USEXIT for more information on the calling and processing conventions for this exit. |
| RVBX-MESSAGE | YES | NO | YES | Specifies whether to display error messages about the incorrect installation of the Adabas Review link routine exits during installation verification. |
| UBAR | any valid character | --- | Specifies the character to be used in maps as the vertical border. Any character recognized by your system is valid; the default value is "|". |
| DISPLAY | BASIC | EDITOR | BASIC | Specifies whether the traditional method for generating display programs will be used (value "BASIC", default) or if display programs will be generated using the Software AG Editor (value "EDITOR"). |
| HDR-LINE-COUNT | -1 | 0 | nnnn | -1 | Specifies after how many data lines header lines will be inserted. When set to -1, a header will be inserted in every page, depending on the page size. When set to 0, one header will be inserted at the top of the data. |
| FIXED-CHARS | -1 | 0 | nnnn | -1 | Specifies the number of fixed bytes in the editor area when scrolling left/right. When set to -1, FIXED-CHARS will be set to the length of the first column. |
| MAX-NO-OF-LINES | -1 | 0 | nnnnn | 3000 | Specifies the maximum number of lines loaded into the editor buffer pool. With a limit of 3000 long loading times or overflow of the Editor buffer pool shall be avoided. For higher numbers make sure the work file for the Editor buffer pool or the EDPSIZE is big enough. A value of -1 or 0 means “no limit”. In this case the size of the Editor buffer pool is the limit. |
Adabas Review has two Natural user exits. These exits are found in the Adabas Review system library in Natural, and may be modified by using the Natural editor.
For more information about these exits, read P-UEXIT1 and P-UEXIT2: Review Natural User Exits.