Version 4.5.1	SEARCH   INDEX   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT

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:

 22:52:49                  *****   R E V I E W   *****                2009-04-25
                  Options for detailed report: name                     HUB=15690
                                                                                
 +--- Detail Rpt Options ------- Detailed Logging ------------- History -------+
 !  AutoStart .......... N    Log ................ Y    History ............ N !
 !  Print .............. N    File .......... RVLOG_    History Int ... ______ !
 !  Limit ....... 99999999    Num of Logs ....... _2    History DBID ... __123 !
 !  Page/Line .. _55 / 133    Log Size ....... ___60    History FNR .... ___45 !
 !                            User Exit ... ________    History SVC ...... 234 !
 !                                                                             !
 !                           ---- Buffers to Log ---   ----- Detail Exit ----- !
 !                            FB: Y    SB: Y   RB: Y    Exit name.... ________ !
 !                            VB: Y    IB: Y   IO: Y                           !
 !                                                                             !
 !                                                                             !
 !                                                                             !
 !                                                                             !
 !                                                                             !
 +-----------------------------------------------------------------------------+
                                                                                
                                                                                
 Command: ______________________________________________________________________
 Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
       Help        Exit              Accpt             Dflts             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:

22:57:04                  *****   R E V I E W   *****                2009-04-25
               Options for summary report: LONG RUNNING COMMANDS      HUB=15690
                                                                               
+-- 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                             ---- Summary Exit ----- !
!  ADALimit ...... _____1                              Exit Name ... ________ !
!  Display By ..   SORTED                              Cmd ............... CL !
!  Entries ....... 999999                              Sum ................ Y !
!  Limit ....... 99999999                                                     !
!  Page/Line .. _55 / 133                                                     !
!                                                                             !
!                                                                             !
+-----------------------------------------------------------------------------+
                                                                               
                                                                               
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
      Help        Exit              Accpt             Dflts             Menu   

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.

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).

Logging Options

Two kinds of logging options are available in Adabas Review, 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, specific to Adabas Review, that can be processed at some later time in an Adabas Review batch run. The output of the detailed log file depends on the report definition and includes only parts of the overall Adabas commands being processed.

• 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.

This section covers the following topics:

• Logging Option Descriptions

• Buffers to Log Options (Detailed Reports Only)

• Required Options for Logging

• Recommended Options for Logging

• Logging Guidelines

Logging Option Descriptions

For command logging, the logging options determine whether command logging is performed, what information is logged, and where the command log is written. For summary report logging, the logging options determine whether summary logging is performed, what information is logged, and where the summary log is written.

The following table describes (in alphabetic order) the logging 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 (command logging) or summary reports (summary logging).

number-of-tracks  *   ( (bytes-per-track/9996)  - 1)

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 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:

Required Options for Logging

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

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

Recommended Options for Logging

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

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

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(LOGUEXIT). 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 make up 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.

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.

This section covers the following topics:

• Detailed Report User Exit Options

• Summary Report User Exit Options

Detailed Report User Exit Options

Adabas Review provides a detailed report user exit that 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.

To invoke the user exit:

1. Specify the name of the user exit when creating the report.

   For an online report, enter the exit name in the Exit Name field in the Detail Exit area of the Report Options screen.

   When defining batch parameters, specify TYPE=DETAIL and the REPORT-EXIT= keyword of the REPORT statement. Read REPORT Statement in Using Batch Facilities for more information.

2. Provide the detailed report user exit in an executable library accessible to Adabas Review.

The detailed report user exit receives control using standard linkage:

The parameter list contains two entries:

Summary Report User Exit Options

Adabas Review provides a summary report user exit that is called whenever:

• A specified Adabas command is selected for the report

• A report is summarized.

A report is summarized when it is:

• Closed or purged from the LS screen;

• Closed by an interval event;

• Deactivated because the MAXSTORE limit was exceeded; or

• Running when Adabas Review is terminated.

You may control the conditions that trigger the exit.

A report calling a summary exit is limited to one account (Order) field. If a summary report exit is specified and the report has multiple account fields, syntax error message REV00408 is issued.

• Invoking the Summary Exit
• Summary Exit Record
• Return Codes

Invoking the Summary Exit

To invoke the user exit:

1. Specify the name of the user exit when creating the report.

   For an online report, enter the exit name in the Exit Name field in the Summary Exit area of the Report Options screen.

   To control the conditions that drive the exit, the Report Options screen allows you to enter an Adabas command (Cmd field) and specify whether to call the exit at summarization time (Sum field). If the Adabas command field is left blank, the exit is only called when the report is summarized. If SUM is set to "N" and the Adabas command field is blank, the exit is never called.

   When defining batch parameters, specify TYPE=SUMMARY and the SUMMARY-EXIT= keyword of the REPORT statement. Read about the REPORT Statement in Using Batch Facilities for more information.

2. Provide the summary report user exit in an executable library accessible to Adabas Review.

   The summary report user exit receives control using standard linkage:

   R1	Address of the parameter list
   R13	18 fullword savearea address
   R14	Return address
   R15	Entry-point address of the user exit / Return code upon return

   The parameter list contains the following entries:

   Offset	Address of . . .
   0	the reason for being called. This is a one-byte binary bit map.
   	X'80' The exit was called because the specified command was selected. X'40' The exit was called during summary processing. X'01' If this bit is on in addition to one of the above, it indicates that this is the last account entry for the report.
   4	the Adabas command. This is a two-byte character field. If the exit was called with X'80', the field indicates the Adabas command that is used as a trigger.
   8	the report name. This is a 32-byte character field.
   12	the summary record.

Summary Exit Record

The summary record is a variable length record that contains the field names and values for the report. It has a fixed portion and a variable portion.

Note:
The layout of the summary exit record is different from the layout of the summary record written to the summary log file.

Here is the summary exit record layout:

************************************************************ 
*   FIXED PORTION OF SUMMARY RECORD                        * 
************************************************************ 
RECLEN   DS   H              TOTAL RECORD LENGTH (INCLUSIVE)  
         DS   H              UNUSED                          
SUMCOUNT DS   H              NUMBER OF SUMMARY ENTRIES       
SOFFSET  DS   H              OFFSET OF SUMMARY PORTION       
ACCLEN   DS   H              LENGTH OF ACCOUNT DATA          
ACCTNAME DS   CL8            NAME OF ACCOUNT FIELD           
*                                                            
************************************************************ 
*   VARIABLE PORTION OF SUMMARY RECORD                     * 
************************************************************ 
ACCTDATA DS   0CL1           START OF ACCOUNT DATA           
ACCTPAD  DS   0CL1           PADS OUT TO DOUBLEWORD          
SUMFLD   DS   0CL8           NAME OF SUMMARY FIELD           
SUMVAL   DS   0XL8           VALUE OF SUMMARY FIELD

The exit is called for each account entry (Order Field) in the report.

The last two fields above repeat for each summary field in the report.

All fields names are 8-byte character fields.

All summary data values are 8-byte binary fields.

The ACCTDATA field above always starts at the same offset, but its length is variable.

Return Codes

Upon returning from the exit, the user is responsible for setting a return code in R15:

www.softwareag.com

Copyright © 2014 Software AG, Darmstadt, Germany.

SEARCH   INDEX   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT