This document describes Adabas Review report types and components, and discusses the display programs used for report output:
This section provides an overview of Adabas Review reporting features.
Adabas Review retrieves performance information about Adabas by collecting data in the form of reports.
Reports capture command log information and provide information about both online and batch transactions. Reports collect data about multiple teleprocessing environments and batch programs that are all using the same database.
An Adabas Review report has two parts: a definition and a display program.
A report definition is a set of parameters that specify the data to be captured and a set of processing rules that identify the conditions under which the data is to be captured.
A report display program is a Natural program that specifies the appearance of the report output, whether viewed online or downloaded to a personal computer (PC).
The Edit Report (ER) function is used to create Adabas Review report definitions. In addition, Software AG delivers prepared report definitions called supplied reports with Adabas Review. Supplied reports may be modified to meet the requirements at a particular site. Detailed information about supplied reports is provided in the Adabas Review User's Guide.
Reports can be run in either interactive or batch mode:
In interactive mode, Adabas passes information to Adabas Review about resource usage for each command processed by the Adabas nucleus. Online reports are started with the START command.
In batch mode, Adabas Review runs as a batch job that processes sequential Adabas or Adabas Review command log data sets. Batch parameter statements are generated for the report and submitted in the job stream.
Adabas Review provides commands to
modify report definitions;
modify display programs;
control report data collection; and
direct report output.
An Adabas Review report definition comprises database fields to be monitored, processing rules, and option parameters, all either entered on screens or selected from lists:
database fields
from which a report extracts data are listed in the order
in which they are to be displayed.
processing rules
identify the conditions under which the data is to be
captured by describing how field values are to be extracted for the report.
report option parameters
specify whether Adabas Review will perform physical command
logging, and whether data accumulated by the report will be written to a
history file. History data may be used when analyzing database performance
trends.
The selection of database fields defines the subject of the Adabas Review report.
A field identifies a type of information to be collected by the report; for example, information about an Adabas command, the Natural program issuing the command, the Adabas nucleus, the teleprocessing monitor, or the operating system being used. The PF11 (Flds) option is used to display a list of all available Adabas Review report fields.
Up to 20 fields may be used in a particular report. However, the number of fields that can be displayed is limited to the total line size (250 bytes) that can be displayed when a report is viewed online.
Fields to be displayed in a report are entered on the Edit Report screen of the Edit Report (ER) function as shown in the following example:
20:35:15 A D A B A S - R E V I E W YYYY-MM-DD
Edit Report LOCL=00009
Report Name: ________________________________ DBID to Monitor: _____
+-----------------------------------------------------------------+
| Field Order Sum Min Max Avg Pct Rate Round |
|-----------------------------------------------------------------|
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
| ________ ___ _ _ _ _ _ _ ______ |
+---------------------------- Page 1 -----------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Optns Exit Save Start - + Rules Flds Menu |
Detailed information about individual fields is provided in the Adabas Review User's Guide.
Report processing rules are used to set conditions on or limit the data collected by the report.
Processing rules are entered on the Report Processing Rules screen of the Edit Report (ER) function as shown in the following example:
20:24:56 A D A B A S - R E V I E W YYYY-MM-DD
Report Processing Rules LOCL=00009
REPORT ONE
+-----------------------------------------------------------------------------+
| Field Op Value And/Or |
|-----------------------------------------------------------------------------|
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
| ________ __ ________________________________________________________ ___ |
+---------------------------------- Page 1 -----------------------------------
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Optns Exit Save Start - + Flds Menu |
An Adabas Review report processing rule is specified by a field, a relational operator (equal to, less than, greater than, not equal to), and a specific value or range of values.
If there are multiple processing rules, the appropriate logical operator (AND or OR) must also be specified.
Fields used in processing rules are not displayed in the report results unless they are listed on the Edit Report screen.
Values for report option parameters can be entered on the Report Options screen of the Edit Report (ER) function as shown in the following example:
19:30:50 ***** R E V I E W ***** YYYY-MM-DD
Report Options For: LOCL=00222
+-------- Report ------------------ Logging ----------------- History --------+
| Detail/Sum ......... S Log ................ N History ............ N |
| AutoStart .......... N File ........... RVLOG History Int ... ______ |
| Break ............. Y Num of Logs ....... _2 HISTORY DBID ... __223 |
| Wrapping ........... N Log Size ....... 99999 HISTORY FNR .... ___22 |
| Print .............. Y User Exit ... ________ History SVC ...... 237 |
| Rstrt/Intrvl Y ______ |
| Max Restarts: 999999 Report Exits |
| Max K ........... __16 Buffers to Log ---------------------- |
| ADALimit ...... _____1 ------------------------ Detail Exit.. ________ |
| Display By .. SORTED CB: Y FB: Y SB: Y Summary Exit: ________ |
| Entries ....... 999999 RB: Y VB: Y IB: Y Cmd .... CL Sum .... N |
| Limit ....... 99999999 IO: Y EX1: N EX2: N |
| Page/Line... _55 / 133 |
| |
+-----------------------------------------------------------------------------+
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Accpt Dflts Menu |
Adabas Review is delivered with report options defaults:
You can modify these defaults for all subsequent reports.
You can modify the default values for a particular report, either new or existing.
Detailed information about using the Report Options screen is provided in the Adabas Review User documentation.
Adabas Review provides two report user exits: one for detail reports and one for summary reports.
A detail report user exit is driven 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 driven 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 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.
Once data has been accumulated for a report, the results can be
saved to a file;
viewed online;
downloaded to a personal computer (PC) using Entire Connection; or
printed when the Adabas nucleus terminates.
Once a report has been defined, the SAVE command is issued and the report definition is written to the Adabas Review repository.
A unique Natural program, the Adabas Review report display program , is generated automatically whenever a report is created or modified using the Edit Report (ER) function. This program determines how the report data will be viewed online or downloaded to a PC. It controls the appearance of the report output for an active database or for historical data.
You may use the Review-generated display program as it is created, or you may modify it for your individual needs.
The display program is executed when the VIEW command is issued to display the report results online.
Note:
The output of reports that print at database termination is not
controlled by a display program. At database termination, a SYSOUT from Adabas
is written by REVIEWB. The format of this output cannot be modified by the
Adabas Review user.
Adabas Review provides three list functions for reports, which are accessible from the Adabas Review (DB system) menu:
| Code | List . . . | This function lists . . . |
|---|---|---|
| LR | Report | existing Adabas Review reports by name. Reports may be edited, started, and purged using the commands in this function. |
| LH | History Reports | reports that have accumulated history data in the Adabas Review repository. |
| LS | Started Reports | reports that are currently accumulating data. |
The lists displayed by the LH and LS functions are subsets of the list displayed by the LR function.
From the resulting lists, certain commands can be issued against a particular report that allow you to maintain report definitions, manage started reports, and manage the output they produce.
The commands are entered on the selection line preceding the name of the report.
Review record filtering can decrease the number of command log (CLOG) records passed from the database to Review. When filtering is active, only those records needed for report processing will be passed to Review. Record filtering operation is based upon the reports currently active and cannot be directly controlled. However, the Adabas ADARUN parameter REVFILTER may be used to control whether the database allows filtering. See the appropriate installation documentation for a description of the REVFILTER parameter.
Record filtering is limited to and dependent upon select Review fields (filter fields). Reports with rules based solely on filter fields are eligible to be filtering reports. Any other report is a non-filtering report. Record filtering will be active only when all reports running are filtering reports. That is, record filtering will stop if any non-filter report is started. An example of a filtering report would be the Exceptional Response Code report, which has a single rule for the RSP field. If this is the only report running, only those command logs with exceptional response codes will be sent to Review.
Note:
Record filtering is intended for those installations that ordinarily
run very few reports (e.g., Exceptional Response Codes) at a time. A
large number of active filtering reports will negate the performance benefits
of record filtering. If your installation runs many rule-based reports, running
with the ADARUN REVFILTER=NO setting is recommended. Some analysis of active
reports may be necessary to fully realize filtering performance
benefits.
The following restrictions apply for Review record filtering:
For filtering to be activated, all currently active reports must have processing rules based solely on filtering fields.
Wildcard values are not permitted. Alphanumeric values containing an asterisk (*) will result in filtering being turned off.
EXCLUDE statements are not supported. An EXCLUDE statement will result in filtering being turned off.
Special Review reports are non-filtering reports.
CLOGLAYOUT=8 is required for record filtering.
Filtering will not be active when running with LOGCLEX=YES.
In Hub mode, any active report using the artificial target ID 11111 will result in filtering being turned off.
The following Review fields can be used in rule processing in order to activate Review Record Filtering. The use of any other field in rules for active reports will cause filtering to be stopped.
See the Field Reference for detailed information about particular fields.
DBID
NUCID
CMDTYPE
JOBNAME
ASSOIO
DATAIO
WORKIO
CMD
RSP
CID
ACBDBID
FILE
ISN
ISNQ
ACBUSER
TPUSERID
TRANSID
STEPNAME
NATAPPL
NATPROG
NATUID
NATSTMT
