Specifying Reporting Options

This document describes the Adabas Review reporting options you can specify. Adabas Review reporting options are specified on the Report Options screen. Different options are available, depending on whether the report selected is a detailed or a summary report.

For detailed reports, data is collected continuously while the database is active. Such reports are straight recordings of commands processed. Detailed reports cannot be viewed online. However, a display program is generated that may be used to view history data online if the report collects history data. Results of detailed reports are printed at database termination. For detailed reports, the following options are available:

11:06:18                  A D A B A S  -  R E V I E W                2020-02-10
REVIEW-DB (10,252)                                            Hub Target: 296  
                                                                               
+--- Detail Rpt Options ------- Detailed Logging ------------- History -------+
|  AutoStart .......... N    Log ................ N    History ............ N |
|  Print .............. Y    File ........... RVDET    History Int ... ______ |
|  Limit ....... 99999999    Num of Logs ....... _2    History DBID ... __123 |
|  Page/Line .. _55 / 133    Log Size ..... __99999    History FNR .... ___45 |
|  Rstrt/Intrvl Y  ______    User Exit ... ________    History SVC ...... 234 |
|                                                                             |
|  -- Raw Data Output ---   ---- Buffers to Log ---   ----- Detail Exit ----- |
|  Write Raw Data...... N    FB: Y    SB: Y   RB: Y    Exit name.... ________ |
|  Write Header ....... N    VB: Y    IB: Y   IO: Y                           |
|  Data Dlmitrs?... N   #                                                     |
|  Raw Data File... RAWDT                                                     |
|  Num of Files....... _2                                                     |
|  Log Size ..... ___9999                                                     |
|  Switch Exit.. ________                                                     |
+-----------------------------------------------------------------------------+
                                                                               
                                                                               
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help        Exit              Accpt        +    Dflts             Menu
11:07:13                  A D A B A S  -  R E V I E W                2020-02-10
REVIEW-DB (10,252)                                            Hub Target: 296  
                                                                               
+-- Scheduling Options ------------------------------------------------------ +
|  Scheduling Active .. Y                                                     |
|  Date/Time From ..... 2018-04-24 13:07                                      |
|  Date/Time To ....... 2018-04-25 13:07                                      |
|  Duration ........... 5_____ M (Min/Hour/Day)                               |
|  Interval ........... 1_____ H (Min/Hour/Day)                               |
|                                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
|                                                                             |
+-----------------------------------------------------------------------------+
                                                                               
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help        Exit              Accpt  -          Dflts PrSet Clear Menu

Summary reports present a summary of information for a particular field (e.g., command, user ID, program, etc.). Results may be viewed online or printed at database termination. For summary reports, the following options are available:

11:07:57                  A D A B A S  -  R E V I E W                2020-02-10
REVIEW-DB (10,252)                                            Hub Target: 296  
                                                                               
+-- Summary Rpt Options ------- Summary Logging ------------ History ---------+
|  AutoStart .......... N    Summary Log ........ N    History ............ N |
|  Break .............. Y    Summary File ... RVSUM    History Int ... ______ |
|  Wrapping ........... N    Num of Logs ....... _2    History DBID ... __123 |
|  Print .............. Y    Log Size ....  __99999    History FNR .... ___45 |
|  Rstrt/Intrvl Y  ______    Log Full Exit ________    History SVC ...... 234 |
|  Max Restarts .. 999999                                                     |
|  Max K ......... _____8    -- Raw Data Output ---    --- Summary Exit ----- |
|  ADALimit ...... _____1    Write Raw Data ..... N    Exit Name ... ________ |
|  Display By ..   SORTED    Write Header ....... N    Cmd ............... CL |
|  Entries ....... 999999    Data Dlmitrs ..... N #    Sum ................ Y |
|  Limit ....... 99999999    Raw Data File .. RAWSM                           |
|  Page/Line .. _55 / 133    Num of Files ...... _2                           |
|                            Log Size ..... ___9999                           |
|                            Switch Exit . ________                           |
+-----------------------------------------------------------------------------+
                                                                               
                                                                               
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help        Exit              Accpt        +    Dflts             Menu

The Scheduling options for summary reports are the same as for detailed reports.

Several categories of reporting options can be specified, although the options differ for detailed and summary reports. For more information, select the option category below.

Report Option Category Describes the...
General Report Options Characteristics of the report. These options are available for both detailed and summary reports.
Logging Options Command log file, summary log file, and raw log file reporting options available to you for your reports.
  • Command log file options are only available for detailed reports.

  • Summary log file options are only available for summary reports.

  • Raw log file options are available for both detailed and summary reports.

History Options Location of history information and the frequency with which it is collected. These options are available for both detailed and summary reports.
Report Exit Options Report user exits. Report exit options are available for both detailed and summary reports.
Scheduling Options Start and end time and duration and interval in minutes may be specified. The parameters determine when a report is active and when it is waiting.

General Report Options

The following table describes (in alphabetic order) the general report options that can appear on the Report Options screen. The "Valid for Report Type" column in the table indicates whether the option is valid for detailed reports or summary reports (or both).

Report Option Description Possible Values Default Valid for Report Type?
ADALimit Specify a minimum command count for printing on a summary report. If ADALIMIT=100, only entries with a command count of 100 or higher are printed on the report. The default value (1) means that all entries are printed. count 1 Summary only
Autostart Specify whether or not a saved report is started by issuing a START command (N) or automatically when Adabas Review is activated (Y).

When a report is saved with AUTOSTART=Y, its report definition is automatically written to the data sets identified by the RVUAUT1 and RVUAUT2 job control statements. The next time Adabas Review is started, the report is automatically started.

Y | N N Detailed and Summary
Break Specify whether or not subtotals are printed at control breaks (Y) or are suppressed (N) on the summary report. Y | N Y Summary only
Display By Specify the order is which the data is to be displayed on a summary report. Possible display types are:
  • SORTED: sort in ascending order by control break;

  • USAGE: sort in descending order by command count;

  • SUMFIELD: sort in descending order by the first field marked as a summary field;

  • SORTEDDE: sort in descending order by control break; or

  • DATETIME: sort in ascending order by the start date and time of the control break interval.

SORTED | USAGE | SUMFIELD | SORTEDDE | DATETIME SORTED Summary only
Entries Specify the maximum number of entries (that is, unique control breaks) that the summary report can maintain. This option is used to restrict the amount of data collected.

When the limit is reached, the report will remain active, but no further data will be collected.

1 - 999999 999999 Summary only
Intrvl This option appears on the same screen line as the Rstrt report option. The Rstrt option appears first on the line.

Specify the time interval (in minutes) for closing the report. At each interval:

  • Summary reports print their output and store any history data before the report is closed.

  • Detailed reports close. Note that output data for detailed reports, including history data, is written in an ongoing fashion while the report is running.

The report may be restarted, depending on the setting of the RESTART parameter.

For online reporting (SYSREVDB), use the Intrvl reporting option; in batch reporting, use the INTERVAL parameter. For more information about batch reporting, read REPORT Statement.

  1 - 999999 ---  Detailed and Summary
Limit

For a detailed report, specify the maximum number of input records that can be collected.

For a summary report, specify the maximum number of input records that can be collected. To limit the resulting records, use the Entries report option. The resulting records may be fewer than the limit because of the aggregation of the data in a summary report.

If a report has a RULE specified, only records that satisfy the selection criteria will be counted. The default values allow all records to be processed.

When the limit is reached, the report will remain active, but no further data will be collected.

For print info see the PRINT parameter.

1 - 99999999 99999999 Detailed and Summary
Line This option appears on the same screen line as the Page report option. The Page option appears first on the line.

Specify the line length, in characters, of the detailed or summary report. The default line length value is 133 characters. The appropriate value depends on the paper size and the point size and style of the typeface.

Use "Line" in an online environment; use LINESIZE in a batch environment.

72 - 255 133 Detailed and Summary
Max K Specify the maximum amount of storage available for a summary report.

Use "Max K" in an online environment; use MAXSTORE in a batch environment.

For more information about how storage is used for reports, read Storage for Reports.

amount in 8K increments 8 Summary only
Max Restarts Specify the maximum number of times a summary report will be restarted due to Max K   1 - 999999 999999  Summary only
Page This option appears on the same screen line as the Line report option. The Page option appears first on the line.

Specify the number of lines allowed for the detailed or summary report . The default page length value (55 lines) provides a top and bottom margin for standard printer spacing on a total page size of 66 lines.

10 - nnn 55 Detailed and Summary
Print

For a detailed report, specify whether or not the report is printed, continuously or at Review termination.

For a summary report, specify whether or not the report is printed at CL(ose) report, when its refresh/history interval is reached or at Review termination.

In Local mode Review terminates when the database terminates. In Hub mode Review terminates when the Hub terminates.

Y | N Y Detailed and Summary
Rstrt This option appears on the same screen line as the Intrvl report option. The Rstrt option appears first on the line.

Specify whether the summary report is restarted after the specified refresh/history interval or after the MAXSTORE limit (see the Max K report option) is reached.

If Y is specified for the Rstrt option, the summary report is refreshed automatically.

If N is specified for the Rstrt option, the summary report will be set with status "I" (inactive). Then, when the MAXSTORE limit or the refresh/history interval are reached, the report will be closed.

Use the "Rstrt" report option in an online report (SYSREVDB); use the RESTART parameter in a batch report. For more information about batch reporting, read REPORT Statement.

Y | N Y Detailed and Summary
Wrapping Specify whether or not the data collected for a summary report that has SEQUENCE as the first ORDER (control break) field can reuse data elements (i.e., wrap) once the total number of ENTRIES specified have been filled.

Use "Wrapping" in an online environment; use WRAP in a batch environment.

Y | N N Summary only

Logging Options

Three kinds of logging are available for Adabas Review reports, depending on the kind of report you have selected. Some logging options are shared by both types; other logging options are specific to the report type.

  • Command logging: When running detailed reports, you can elect to create a log file of detailed command data and, optionally, buffer data from the detailed report. This data can be processed at some later time in an Adabas Review batch run. The output of the command log file depends on the report processing rules specified for the report and includes only parts of the overall Adabas commands being processed. For complete information about the Adabas Review command log files, read Command Log Files.

  • Summary logging: When running summary reports, a summary log file can be created containing summary data, but it cannot be processed later in an Adabas Review batch run because the summary data already has a specific layout. This layout is described in Summary Record Layout. For complete information about the Adabas Review summary log files, read Summary Log Files.

  • Raw logging: When running detailed or summary reports, you can elect to create a raw log file of the detailed command data or summary data collected by the report. For complete information about the Adabas Review raw log files, read Raw Log Files.

Each log file type has report options specific to its processing. This section covers the following topics:

Command Log Options

For command logging, the logging options determine whether command logging is performed, what information is logged, and where the command log is written. Command log options are listed under the title" Detailed Logging" on the Report Options screen.

The following table describes (in alphabetic order) the command logging options that can appear on the Report Options screen for detailed reports.

Note:
Detailed reports can also log data to raw log files. For more information about raw log reporting options, read Raw Log Options.

Logging Option Description Possible Values Default
Buffers to Log See Buffers to Log Options. --- ---
File Specify the DD/file name prefix used to identify the file to which Adabas Review will write the command log data. Each detailed report that specifies command logging must have its own unique file name prefix. 5-byte name RVLOG
Log Specify whether Adabas Review will write command logs for a particular detailed report (Y), or whether command logging will be ignored (N). When Log=Y is selected, a report without fields may be defined. Y | N N
Log Size Specify the number of blocks to be allocated to each command log file. For more information, read Determining the Log Size Option Setting, later in this section. nnnnnnn 99999
Num of Logs Specify the number of command log files to be used by a report.

For every command log file specified in the Num of Logs option, a file name is created by appending a number to the end of the file name prefix specified in the File option. Each log file name must be coded in the Adabas startup procedure.

For example, if File=RVLOG and Num of Logs=2, command log data will be written to files RVLOG01 and RVLOG02.

1-99 2
User Exit Specify the name of the user exit that is called when a command log is filled during detailed report processing.

If an exit is not specified, Adabas Review closes the filled command log file and opens the next file; no provision is made for copying the data.

For complete information about the command logging user exit, read REVUXLOG: Command, Summary, or Raw Logging User Exit

name none

The remainder of this section on command log file options covers the following topics:

Buffers to Log Options (Detailed Reports Only)

The Buffers to Log options specify which command log buffers will be included in command logging. These can only be specified for detailed reports.

The basic command log record, the ACBX, and the CLEX (corresponding to the ADARUN LOGACB, LOGCLEX, and LOGUX parameters) will always be logged in the command log file, regardless of the settings of the Buffer to Log options. These are included in the record internally referred to as LORECR. The Buffer to Log options make it possible to log additional buffers such as the record buffer, the format buffer, and others.

You can determine whether data is logged by your report by setting the Adabas Review logging parameter that corresponds to a particular buffer (or set of buffers). The following table briefly describes the Buffers to Log options. These options are only applicable to detailed reports:

Buffer Logging Option Description Corresponding ADARUN Parameter Possible Values Default
FB Specify whether the format buffer is logged. LOGFB=YES Y | N Y
SB Specify whether the search buffer is logged. LOGRB=YES Y | N Y
RB Specify whether the record buffer is logged. LOGSB=YES Y | N Y
VB Specify whether the value buffer is logged. LOGVB=YES Y | N Y
IB Specify whether the ISN buffer is logged. LOGIB=YES Y | N Y
IO Specify whether the Adabas I/O information is logged. LOGIO=YES Y | N Y

Required Options for Command Logging

The following detailed report option settings are required for detailed reports that will log commands to the command log:

Detailed Report Option Setting Explanation
Log Y Yes indicates that the report performs command logging.
File name The five-character prefix of the DD/file name for the command log files.
Num of Logs number The total number of command log files allocated for the report.
Log Size number Number of blocks per data set. Data sets for a particular report must be the same size.

Recommended Options for Command Logging

The following detailed report option settings are suggested for efficient command logging operations:

Detailed Report Option Setting Explanation
AutoStart Y Starts the command logging report when the database is initialized.
Print N Prevents each detailed data line from being printed; eliminates redundant recording of data and waste of spool space.
User Exit exit name Filled command logs are copied to another device before they are overwritten with new command log data.

Summary Log Options

For summary report logging, the logging options determine whether summary logging is performed, what information is logged, and where the summary log is written. Summary log options are listed under the title" Summary Logging" on the Report Options screen.

The following table describes (in alphabetic order) the summary logging options that can appear on the Report Options screen for summary reports.

Note:
Summary reports can also log data to raw log files. For more information about raw log reporting options, read Raw Log Options.

Logging Option Description Possible Values Default
Log Full Exit Specify the name of the user exit that is called when a summary log is filled during summary report processing.

If an exit is not specified, Adabas Review closes the filled summary log file and opens the next file; no provision is made for copying the data. In addition, if a report is stopped and is restarted manually (not automatically restarted because the RESTART=Y option is specified), the first log data set will be reused and, if the previous data was not copied, it will be overwritten.

For complete information about the summary logging user exit, read REVUXLOG: Command, Summary, or Raw Logging User Exit

name none
Log Size Specify the number of blocks to be allocated to each summary log file. For more information, read Determining the Log Size Option Setting, later in this section. nnnnnnn 99999
Num of Logs Specify the number of summary log files to be used by a report.

For every summary log file specified in the Num of Logs option, a file name is created by appending a number to the end of the file name prefix specified in the Summary File option. Each log file name must be coded in the Adabas startup procedure.

For example, if Summary File=RVSUM and Num of Logs=3, summary log data will be written to files RVSUM01, RVSUM02, and RVSUM03.

1-99 2
Summary File Specify the DD/file name prefix used to identify the file to which Adabas Review will write the summary log data. If the file is supposed to contain output from one report only, the file name prefix of this report must be unique. Otherwise output from more than one report may be written to the log file. 5-byte name RVSUM
Summary Log Specify whether Adabas Review will write summary logs for a particular summary report (Y), or whether summary logging will be ignored (N). Y | N N

The remainder of this section on summary log file options covers the following topics:

Required Options for Summary Logging

The following summary report option settings are required for summary logging:

Summary Report Option Setting Explanation
Summary Log Y Yes indicates that the report performs summary logging.
Summary File name The five-character prefix of the DD/file name for the summary log files.
Num of Logs number The total number of summary log files allocated for the report.
Log Size number Number of blocks per data set. Data sets for a particular report must be the same size.

Recommended Options for Logging

The following summary report option settings are suggested for efficient summary logging operations:

Detailed Report Option Setting Explanation
AutoStart Y Starts the summary logging report when the database is initialized.
Print N Prevents each summary data line from being printed; eliminates redundant recording of data and waste of spool space.
Log Full Exit exit name Filled summary logs are copied to another device before they are overwritten with new summary log data.

Raw Log Options

For raw data logging, the logging options determine whether raw logging is performed, what information is logged, and where the raw log file is written. Raw log data can be logged for both detailed and summary reports.

The following table describes (in alphabetic order) the raw logging options that can appear on the Report Options screen for detailed and summary reports.

Logging Option Description Possible Values Default
Data Dlmitrs This option has two parts.
Part 1: Specify whether or not a delimiter will be used to delimit the fields in the raw log data record. Valid values are "Y" (a delimiter should be used) or "N" (a delimiter should not be used). If this is set to "N", all the fields in the record are strung together in the raw data record with no separator in between them. Y | N N
Part 2: If the first part of this option is set to Y, this part specifies the character that should be used as the delimiter between fields in the raw data record. Any EBCDIC character blank
Log Size Specify the number of blocks to be allocated to each raw log file. For more information, read Determining the Log Size Option Setting, later in this section. nnnnnnn 99999
Num of Files Specify the number of raw log files to be used by a report.

For every raw log file specified in the Num of Logs option, a file name is created by appending a number to the end of the file name prefix specified in the Raw Data File option. Each log file name must be coded in the Adabas startup procedure.

For example, if Raw Data File=RAWSM and Num of Logs=3, summary log data will be written to files RAWSM01, RAWSM02, and RAWSM03.

1-99 2
Raw Data File Specify the DD/file name prefix used to identify the file to which Adabas Review will write the raw log data. Each report that specifies raw logging must have its own unique file name prefix. 5-byte name RAWDT (detailed reports) or RAWSM (summary reports)
Switch Exit Specify the name of the user exit that is called when a raw log is filled during report processing.

If an exit is not specified, Adabas Review closes the filled raw log file and opens the next file; no provision is made for copying the data.

For complete information about the raw logging user exit, read REVUXLOG: Command, Summary, or Raw Logging User Exit

name none
Write Header Specify whether Adabas Review will write the header record at the beginning of each raw log file. Y | N N
Write Raw Data Specify whether Adabas Review will write raw logs for a particular report
  • in binary (Y) and character mixed. Fields are printed as specified in the field reference;

  • in character (C) only. Fields which are specified with Format B in the field reference table are converted to format C.

or whether raw logging will be ignored (N).

Y | N | C N

The remainder of this section on raw log file options covers the following topics:

Required Options for Raw Logging

The following summary report option settings are required for raw logging:

Summary Report Option Setting Explanation
Write Raw Data Y Yes indicates that the report performs raw data logging.
Raw Data File name The five-character prefix of the DD/file name for the raw log files.
Num of Files number The total number of raw log files allocated for the report.
Log Size number Number of blocks per data set. Data sets for a particular report must be the same size.

Determining the Log Size Option Setting

Use the Log Size reporting option for the command, summary, and raw log files to specify the number of blocks to be allocated to each command log file (detailed reports), summary log file (summary reports), or the raw log file (detailed or summary reports). If more than one log is specified (Num of Logs option), the log will be switched when the specified log size is reached; otherwise the log file will be reused from the beginning when the specified log size is reached.

Because command log records and summary log records vary in length, the number of stored records in a defined log size varies a lot. To better estimate this, consider the following log file descriptions.

  • The command log file is used by detailed reports and contains the basic record with or without any additional buffers, such as the record buffer or format buffer, depending on the report options. If only the basic record is stored, the record sizes are 1,452 bytes per record. If other buffers are logged as well the size dependent on the buffer sizes, but the maximum length of any log record written by Adabas Review is 8K (kilobytes).

  • The summary log file is used by summary reports and contains summary data. Its layout is described in Summary Record Layout. The record size of summary log records varies, depending on the fields specified for the report. The number of bytes used for each field can be determined by reviewing the Field Reference tables.

  • The raw log files are sequential data sets that contain detail or summary report data. The record size of raw log records varies, depending on the fields specified for the report and whether a header is used or not. The number of bytes used for each field can be determined by reviewing the Field Reference tables.

For Adabas Review log files, the internal blocking factor used for calculations is 10,000 bytes per block. The Log Size value can be determined using the following basic formula:

number-of-tracks * records-per-track

The number-of-tracks value can be determined by multiplying number of cylinders to use by the number of tracks per cylinder (provided by the disk vendor): number-of-tracks= number-of-cylinders * vendor-number-tracks-per-cylinder.

The records-per-track value can be calculated by dividing the number of bytes per track (provided by the disk vendor) by the blocking factor of each record and truncating the result (records-per-track = TRUNC (bytes-per-track/10000)).

Fully expanded, this calculation looks like this:

(number-of-cylinders * vendor-number-tracks-per-cylinder) * (TRUNC (bytes-per-track/10000))

The following are approximate values for tracks per cylinder, bytes per track, and records per track for 3380 and 3390 devices:

  • 3380: 15 tracks per cylinder; 47,000 bytes per track. For record block factor of 10,000 bytes, this calculates as 4 records per track (TRUNC (47000/10000)).

  • 3390: 15 tracks per cylinder; 57,000 bytes per track. For record block factor of 10,000 bytes, this calculates as 5 records per track (TRUNC (57000/10000)).

Important:
It is best to check your device vendor's documentation to see what they document as the number of records-per-track for a specific blocking factor for the device.

Example Using a Standard Blocking Factor

For example, the Log Size setting for 10 cylinders of a 3390 device with record blocking factor of 10,000 bytes is determined as follows:

  • The number-of-tracks value is calculated by multiplying 15 tracks per cylinder by 10 cylinders (15 x 10), or 150 tracks.

  • For a 3390 device, the records-per-track is calculated by dividing 57,000 bytes per track by the blocking factor (10,000 bytes), with a result of 5 records per track (TRUNC (57000/10000).

  • The Log Size value would then be calculated as 150 x 5, or 750 blocks.

Example Using a Larger Blocking Factor

To make optimal use of your disk space, you might choose to use a larger block size. If you do this, you must be sure to base the calculation for the Log Size parameter setting on the larger block size to be sure to use all provided space. Remember that Adabas Review's internal algorithm uses a fixed 10,000-byte blocking factor for log records, so when calculating Log Size for a larger block size, you must calculate the records-per-per track using the larger block size, then calculate the total number of bytes per cylinder, adjust that value for the total number of cylinders you need, and, finally, adjust the total number of bytes per cylinder by Adabas Review's required 10,000-byte blocking factor.

Note:
Adabas Review log records cannot be split over the 10,000 byte boundary. Consequently, we recommend that you leave some padding space when making your calculations.

For example, the Log Size setting for 10 cylinders of a 3390 device with a data set block size of 27,998 bytes is determined as follows:

  • For this 3390 device, the records-per-track is calculated by dividing 57,000 bytes per track by the larger data set block size (27,998 bytes), with a result of 2 records per track (TRUNC (57000/27998)).

    Important:
    It is best to check your device vendor's documentation to see what they document as the number of records-per-track for a specific blocking factor for the device.

  • To determine the number of bytes per cylinder required, you must multiply the number of tracks per cylinder (for 3390 devices, this is 15) by the data set block size (for this 3390 device it is set to 27,998 bytes) and by the number of records per track (as previously calculated for this 3390 device, this is 2). So the total number of bytes per cylinder required can be calculated as 15 * 27998 * 2, or 839,940 bytes per cylinder.

  • This example requires 10 cylinders, so the total number of bytes needed is calculated as 10 * 839,940, or 8,399,400 bytes.

  • Finally, the Log Size value is determined by adjusting the total number of required bytes by the 10,000-byte blocking factor for Adabas Review log records. The calculation would be TRUNC (8399400/10000), or 839 blocks.

Logging Guidelines

  • Using the report option parameter PRINT=N, the printed detailed or summary report may be suppressed for a command log or summary log report.

  • Processing rules may be used to restrict the collection of data for detailed reports (command logging) to certain values; e.g., all commands that return a nonzero response code.

  • Before starting a report that performs detailed command logging, command log data sets must be allocated and the corresponding job control statements must be added to the Adabas startup JCL. Likewise, before starting a report that performs summary logging, summary log data sets must be allocated and the corresponding job control statements must be added to the Adabas startup JCL.

  • If you use a user exit to copy a filled command log or summary log to another device, refer to the sample user exit code in the source library member REVvrs.SRCE(REVUXLOG). The command or summary log copy job is provided in JCL library member REVvrs.JCL(REVCLCOP).

History Options

History data is useful for monitoring database performance for a given period of time and for performing trend analysis. History options specify whether history data is collected, when it is collected, and where (that is, in which Adabas Review repository) it is stored.

Although history data may be written for both detailed and summary reports, the report type plays a key role in determining how Adabas Review processes history data.

  • A detailed report maintains a one-to-one correspondence between a command log record read or passed to ADARVU and an output record produced by Adabas Review. When the command processed by Adabas Review satisfies the report processing rules, Adabas Review builds the required format and record buffer using the current report definition and immediately stores a record in the Adabas Review repository.

  • A summary report has a many-to-one relationship between processed records and the summarized output record. Multiple records are processed (i.e., summarized) to produce one output record. When the Adabas Review interactive processor is running, information is written out to the Adabas Review repository at Adabas termination, when an interval is reached, or when the report is closed. If the Adabas Review batch processor is being executed, the data is written during end-of-file (EOF) processing.

  • For both types of reports, Adabas Review generates a Natural display program so that history data may be viewed online.

The history options that determine whether and how Adabas Review writes history data are set when you create or edit the report definition on the Report Options screen. If history data is to be written by a report running in batch mode, the history parameters are provided on the COPY statement.

The following table describes (in alphabetic order) the history options that can appear on the Report Options screen. The "Valid for Report Type" column in the table indicates whether the option is valid for detailed reports or summary reports (or both) -- although, in the case of history options, all options work for both types.

History Option Description Possible Values Default Valid for Report Type?
History Specify whether the data collected by the report is to be written to an Adabas Review repository and stored as history data. If (N), all other history options are ignored. Y | N N Detailed and Summary
History Int Specify the history interval in minutes. This is the time interval during which history data is collected by the report. At each interval, the report prints its output if PRINT=Y and stores any history data. The report is then deleted. If RESTART=Y, the report is then restarted.

If the History Int option is used, history data is written to the Adabas Review repository at the interval specified, provided the database containing the Adabas Review repository is active.

To write history data at regular intervals (e.g., every hour), you must also set the Restart report option (Rstrt) to Y, so that the report is restarted after the interval has been reached. This option is listed in the Report Options column of the Report Optionsscreen.

Note:
If the Rstrt=Y is specified, all history data for the report is written to the Adabas Review repository file if the MAX K value for the report is exceeded.

If the History Int option is not used, history data is written to the Adabas Review repository at Adabas termination.

number of minutes none Detailed and Summary
History DBID Specify the ID number of the database that is to store the history data; that is, the Adabas Review repository.

The default is the database ID of the Adabas Review repository to which you currently have access.

You may change this parameter, provided it specifies (in conjunction with the History FNR and History SVC options) a different Adabas Review repository.

dbid current DBID Detailed and Summary
History FNR Specify the file number in the Adabas Review repository that is to contain the history data.

The default is the file number in the Adabas Review repository to which you currently have access.

You may change this parameter, provided it specifies (in conjunction with the History DBID and History SVC options) a different Adabas Review repository.

fnr current file number Detailed and Summary
History SVC Specify the Adabas SVC number used to communicate with the Adabas Review repository in order to write the history data.

The default is the SVC number of the Adabas Review repository that you are currently accessing, if that database appears on the Target Definitions screen (LT function). Otherwise, the default is the SVC number of the default database listed on the Target Definitions screen.

You may change this parameter, provided it specifies (in conjunction with the History DBID and History FNR options) a different Adabas Review repository.

svc current SVC number or SVC of default DBID Detailed and Summary

Report Exit Options

Adabas Review provides two report user exits: one for detailed reports and one for summary reports.

  • A detailed report user exit is called when a command log record is selected for the report. Only records that pass the processing rules are provided to the user exit. This exit may be used to create SMF records, accounting records, or for any other purpose.

  • A summary report user exit is called when a specified Adabas command is selected for the report; and/or a report is summarized. You may control the conditions that trigger the exit.

When creating a report, the user exit name (1-8 characters) is specified on the Report Options screen or in the batch REPORT statement. The actual report user exit must be provided in an executable library accessible to Adabas Review.

For more information about these exits, read REVUXDET: Report Exit for Detailed Reports and REVUXSUM: Report Exit for Summary Reports.

Scheduling Options

If reports shall start and stop in out-off-office hours or regularly during a period of time without running permanent to save resources, the scheduling options will be useful.

To handle scheduled reports, which are waiting to be activated, a new wait queue has been setup. This queue can be displayed using the LC command.

The new command SCHEDULE (SC) will schedule a report, which has scheduling options defined and which has been set to active. The existing START (ST) command starts a report to be active permanent, although scheduling options may be defined.

Scheduled reports remain in the wait queue after the last interval ended. Data can still be viewed. When you purge an active or waiting report, it will disappear.

When you schedule a report, where Date/Time From is in the past, it may not be active immediately. It may be placed in the wait queue and will become active when the next calculated interval starts. Scheduled reports, which are suspended, will nevertheless toggle between active and wait queue.

The following table describes the scheduling options that appear on the second Report Options screen.

Scheduling Option Description Possible Values Preset (PF10)
Scheduling Active Specify whether the report may be scheduled. If (N), the scheduling command will be rejected. The report may be started normally. If (Y), the report may be scheduled or started normally. Y | N N
Date/Time From

Specify the date/time, when the report will be active for the first time.

When the date/time is in the past, the report starts when the next calculated interval starts.

Date/time must not be in the past for more than 1 day. And it must not be in the future for more than 193 days and 22 hours at time of scheduling.

Valid date/time format: YYYY-MM-DD HH:II (HH=hours, II=minutes) Special dates allowed are:

current date/time
TODAY (+/-nnn)

All items with the date of the current day.

The day can be followed by +nnn or -nnn where nnn has a maximum of 3 digits.

The resulting date is computed as the date of the current day plus or minus nnn days.

Date/Time To

Specify the date/time after which no more interval will be started.

The last interval may go beyond the Date/Time To.

Date/time must not be in the past for more than 1 day. And it must be after Date/Time From, but not more than 193 days and 22 hours.

Valid date/time format: YYYY-MM-DD HH:II (HH=hours, II=minutes) Special dates allowed are:

current date/time + 1 day
TODAY (+/-nnn)

All items with the date of the current day.

The day can be followed by +nnn or -nnn where nnn has a maximum of 3 digits.

The resulting date is computed as the date of the current day plus or minus nnn days.

Duration (Min/Hour/Day)

Specify the duration in minutes, hours or days the report will be active in one interval.

The duration must be less than the interval.

If duration = 0, then the duration is the time between Date/Time From and Date/Time To.

0 - 279620 M (minutes = 27 weeks) or
0 - 4660 H (hours) or
0 - 194 D (days).

5 M
Interval (Min/Hour/Day)

Specify the duration of one interval in minutes, hours or days.

The number of intervals will be determined from Date/Time From and Date/Time To.

If interval = 0, a report will be activated only once.

0 - 279620 M (minutes = 27 weeks) or
0 - 4660 H (hours) or
0 - 194 D (days).

60 M

Note:
The TODAY notation in a date-range will be resolved at the time when a report will be scheduled. TODAY will also be resolved at the time when the batch parameter SCHED-STRTDATE and SCHED-ENDDATE may be generated for the REPORT statement, using the GENCARD or the GENAUTO function.