Adabas Review report definitions are created using the Edit Report (ER) function. This function provides a series of fill-in-the-blank and selection screens to help you select the field information, processing rules, and report option parameters that make up a report definition.
The Edit Report screen is used to define field information; that is, the field name and order of selection. If the field type is numeric, you can specify whether the values are to be rounded, totaled, averaged, or expressed as a percentage or rate of commands per second. You can also specify that the minimum or maximum values are to be displayed.
Field information may either be entered directly on the Edit Report screen or selected from screens containing a list of fields. You can access a list of fields using PF11 , the FLDS command, or the LF command, and then selecting the appropriate categories. The order of selection is indicated by typing a number in front of the field. The chosen fields are transferred to the Edit Report screen in the order specified.
New reports may be created from existing reports by editing the original report, changing the name of the report, and saving it under the new name. New reports may also be created by using the Copy Report Definition (CR) command from the List Report Definitions (LR) function.
This document covers the following topics:
To access the Edit Report
(ER) function
Enter the ER code on the command line.
To edit a report
From any of the list function screens (LR, LS, and LH), enter the ER command on the selection line preceding the report name.
Note:
Entering ER for the Buffer Pool Report
displays the Buffer Pool Report window.
The Edit Report screen is displayed as shown below:
20:35:15 A D A B A S - R E V I E W 2003-07-07
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 |
The following PF key functions are provided on the Edit Report screen:
The Edit Report screen provides the following input fields:
| Heading | Explanation |
|---|---|
| Report Name | A unique name for the report. A maximum of 32 characters is allowed. |
| DBID | DBID of the database where the data is to be collected. |
| Field | The fields to be selected by the report. A maximum of 20 fields is allowed for each report. |
| Order | For summary reports, the order in which control breaks occur; at least one of the fields selected must be marked as an order field. For detailed reports, the order in which the fields are displayed. |
| Sum | Whether the values for the field are totaled. |
| Min | Whether the minimum value for the field is displayed. |
| Max | Whether the maximum value for the field is displayed. |
| Avg | Whether the average value is calculated for the field. |
| Pct | Whether the percentage is calculated for the field. |
| Rate | Whether the rate per second is calculated for the field. |
| Round | The amount by which the values of the field are rounded. |
A report name is required; otherwise, the report cannot be saved to the Adabas Review repository. A report name may be up to 32 characters long and must be unique. Alphanumeric and some special characters may be used in report names.
The following list of special characters may not be used in report names:
| Character | Description |
|---|---|
| (') | Apostrophe |
| (�) | Cent sign |
| (:) | Colon |
| (,) | Comma |
| ($) | Dollar sign |
| (=) | Equal sign |
| (%) | Percent sign |
| (.) | Period |
| (/) | Slash |
Use this field to identify the database for which the report is to be created. For collecting data from multiple databases simultaneously (Review in Hub mode or in Local mode) the artificial target ID 11111 can be used. This target ID effectively causes the system to collect data for the report from all databases that have a reporting link already established with Adabas Review; however, use of the target ID 11111 does not create such a link.
To create a link between Adabas Review and each database for which you want to simultaneously collect data for a report, you must create a report with the DBID to monitor set to 11111. You must then start the report for each database from which you want to collect data. To identify the collected data with a particular database, you need to include the report field DBID at the first level of the report definition.
Up to 20 fields may be selected for a single report. You may enter field names directly on the Edit Report screen or you may select the fields from a list. The fields you choose from a list are transferred automatically to the Edit Report screen.
To view the field categories
Access the field selection screens by pressing PF11 or by entering the FLDS or LF command without a category code.
The Database Field Selection screen, which lists field categories, is displayed:
13:08:01 A D A B A S - R E V I E W 2003-07-07
Database Field Selection HUB=00221
Please Mark Categories to Select
AC - Adabas Control Block Fields ............. _
BU - Adabas Buffer Fields .................... _
IN - Interval and Time Fields ................ _
IO - Adabas I/O Fields ....................... _
NA - Natural Fields .......................... _
NU - Adabas Nucleus Fields ................... _
OP - Operating System Fields ................. _
TP - Transaction Processing Monitor Fields ... _
Command: ______________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Menu |
If you need a description of a field category, use the online help system by placing a ? on the line opposite the category name.
This information is also documented in the appendix Field Reference.
Choose the field category you wish to use by typing an X in the input field opposite the category name.
To use the field categories
If you know the field category you wish to use, enter the FLDS command or the LF command followed by the code for the field category on the command line of the Edit Report screen.
Category codes are as follows:
| Code | Field Type Category |
|---|---|
| AC | Adabas control block |
| BU | Adabas buffer |
| IN | Interval and time |
| IO | Adabas I/O |
| NA | Natural |
| NU | Adabas nucleus |
| OP | Operating system |
| TP | Transaction processing monitor |
For example, to list the Adabas control block fields, you may enter either of the following:
LF AC
or
FLDS AC
Field lists for the chosen categories are displayed.
Choosing the Adabas control block fields category displays the following screen:
15:49:53 A D A B A S - R E V I E W 2003-07-07
Page 1 of 2 Adabas Control Block Fields HUB=12345
Sel Fld Name Description Sel Fld Name Description
__ ACBUSER - ACB user __ DURATION - Duration (16 millisecs)
__ ADDIT1 - Additions 1 __ ECBS - ECBS posted in CQ
__ ADDIT2 - Additions 2 __ ERRFLDNM - Error field name
__ ADDIT3 - Additions 3 __ FB - Format buffer
__ ADDIT4 - Additions 4 __ FBFIELDS - Fields in format buffer
__ ADDIT5 - Additions 5 __ FBL - Format buffer length
__ CALLTYPE - Call type __ FILE - File number
__ CID - Command ID __ FILENAME - File name
__ CMD - Adabas command __ GLOBFMID - Global format ID
__ CMDNAME - Command name __ IB - ISN buffer
__ CMDSTAT - Command status __ IBL - ISN buffer length
__ CMDTYPE - Command type __ ISN - Internal seq number
__ CMPRECL - Compressed rec length __ ISNLL - ISN lower limit
__ COP1 - Command option 1 __ ISNQ - ISN quantity
__ COP2 - Command option 2 __ ORGDURA - Unmodified duration
__ DESUPD - Nr of desc updated
Command: ____________________________________________________________________
Enter-PF1---PF2---PF3---PF4---PF5---PF6---PF7---PF8---PF9---PF10--PF11--PF12---
Help Exit Accpt - + Menu |
If you need a description of a field, use the online help system by placing a ? on the line opposite the field name.
This information is also documented in the appendix Field Reference.
Choose the fields you wish to use by typing an X on the line opposite the field name.
Specify field order by typing a number on the line opposite the field name.
For more information, refer to the section Specifying Field Order.
After completing your selections, press PF6 or enter the accept (ACCPT) command to hold your selections temporarily while you continue working on your report.
You are returned to the Edit Report screen where your field selections are transferred automatically. If you specified a field order, the numbers you entered are listed in the Order column.
The order you specify for fields in your report affects the output differently depending on the type of report:
For detailed reports, which are straight recordings of commands processed, the order indicates the order in which the fields are displayed.
For summary reports, which display summarized data, the order indicates the order in which control breaks occur.
For example, in a summary report that displays command name and response code, the data is grouped first by command name, and within each command name group, the data is grouped by response code.
To specify field order
Type a unique number in the Order column for that field and press ENTER.
Duplicate order numbers are not accepted.
To change the field order
Change the order numbers and press ENTER.
The fields are displayed in the new order.
If you add or delete a field, the remaining fields are reordered accordingly.
For summary reports, at least one of the fields selected must be marked with an order number. Order numbers are not required for all fields; fields on which calculations are performed (such as a field marked as a SUM field) are generally not used as control breaks.
Note:
These options are valid only for database summary type
reports.
For the following numeric fields, the order will not affect control break or sort processing:
| Option | Explanation |
|---|---|
| Commands | number of commands accounted for in the control break. |
| Strtdate | date of the first command encountered in the control break. |
| Strttime | time of the first command encountered in the control break. |
| Enddate | date of the last command encountered in the control break. |
| Endtime | time of the last command encountered in the control break. |
| Seconds | total number of seconds that the account entry has been active. |
Refer to the section Report Options in Report Option Parameters for more information about sorting reports by COMMANDS (USAGE), or by STRTDATE or STRTTIME (DATETIME).
For numeric fields with which calculations may be performed (such as number of I/Os or command response time), the following mathematical operations may be performed for each control break on numeric field values:
| Oper | For each control break, . . . |
|---|---|
| Sum | calculates and displays a total of the field's values. |
| Min | displays the minimum value for a field. |
| Max | displays the maximum value for a field. |
| Avg | calculates and displays the average value for a field. |
| Pct | calculates and displays the percentage for a field's values. |
| Rate | calculates and displays the rate per second for a field's value. |
| Round | rounds the field's values by the amount you specify in this column. A value in this column tells Adabas Review to take the actual field value and increment it by some value so that the result is evenly divisible by the "round" value. |
To use the numeric field options
For all options except Round, mark the appropriate column with an X and press ENTER.
Or:
For the Round option, type a number in the appropriate column and
press ENTER.
For example, to round the Adabas duration up to .05 of a second, type in .05 in the Round column for the DURATION field.
Report processing rules determine how field values are selected for your report. These rules restrict the accumulated data to certain values or conditions. For example, a processing rule can be written to restrict data collection to commands that return a nonzero response code.
To access the Report Processing Rules
screen
From the Edit Report screen, press PF10; or enter the command RULES on the command line.
The Report Processing Rules screen appears as shown in the following example:
20:38:29 A D A B A S - R E V I E W 2003-07-07
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 |
Note:
For each report, a total of twenty (20) lines are available for
processing rules.
An explanation of the input fields on this screen is provided in the table below:
| Heading | Explanation |
|---|---|
| Field | The name of the field for which the
restriction applies.
Note: |
| Op | The conditional operand that
specifies how the restriction applies. The following operands may be used: = or EQ Equal to < or LT Less than > or GT Greater than : or NE Not equal to |
| Value | The field that allows you to restrict the information accumulated by the report to a subset of the values in a particular field. Values may be specified in several formats and may be single values or ranges. |
| And/Or | Specifies the Boolean operators AND or OR to define the relationship between multiple processing rules. |
The following guidelines describe acceptable ways to specify values in a processing rule:
Depending on the field, a value may be numeric or alphanumeric.
A value may be specified as a single value, a range of values, or a list of values.
When specified as a list, values are enclosed in parentheses and separated by commas; when specified as a range, the two values are enclosed in parentheses and separated by a hyphen.
For alphanumeric fields, an asterisk (*) may be used to indicate wildcard prefixing and suffixing (see examples below).
Values may be expressed in decimal or hexadecimal format. If using hexadecimal format, the value is preceded by an "X" and enclosed in single quotes.
The length to be compared in the rule is taken from the field length, not the length of the rule value.
When using a wildcard rule value, the length to be compared in the rule is taken from the length of the rule value.
Rules cannot be specified for Adabas Buffer Segments fields such as VBSEG01. Use the actual buffer fields instead of the segment fields.
The following table shows examples of processing rules:
| Example | Explanation |
|---|---|
| RSP>0 | Single numeric value; response code greater than zero. |
| CMDNAME=FIND | Single alphanumeric value; command name equal to FIND. |
| FNR EQ (10-50) | Numeric range value; file number equals 10 to 50. |
| TRANSID=(BAT1,BAT2,BAT3) | Alphanumeric list of values; transaction ID equal to BAT1, BAT2, or BAT3. |
| VMID=T* CALLTYPE=S* |
Use of wildcard suffixing; all VM user IDs beginning with "T"; all trigger and stored procedure calls. |
| JOBNAME=*TEST | Use of wildcard prefixing; all job names ending in "TEST". |
| ACBUSER EQ X'00370014' | Use of hexadecimal format; ACBUSER equal to the hexadecimal value 00370014. |
To complete the Report Processing Rules
screen
If you know which field or fields you plan to use, enter them directly on the screen in the Field column.
To choose fields using the field selection screens, press PF11 or enter the FLDS or LF command on the command line.
Refer to the section Using the Field Selection Screens for more information.
Enter the appropriate operand, using the guidelines in the tables above.
Enter the appropriate value, using the guidelines and table above.
Report options describe additional processing aspects of the report; such as, whether it is a detail or summary report, whether it will perform physical command logging, and whether the data it collects will be written to the Adabas Review repository and stored as history data.
Adabas Review is delivered with report options defaults:
You can modify these defaults for all subsequent reports; or
You can modify the default values for a particular report, either new or existing.
The Report Options screen lists the default settings for each option; changes may be made directly on this screen.
19:30:50 ***** R E V I E W ***** 2003-07-07
Report Options For: REPORT ONE LOCL=00009
+-------- Report ------------------ Logging ----------------- History--------+
| Detail/Sum ......... S Log ................ N History............ N |
| AutoStart .......... N File ........... RVLOG History Int ...______ |
| Break ............. Y Num of Logs ....... _2 HISTORY DBID... __222 |
| 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 |
For detailed information about the parameters on the Report Options screen, see section Report Option Parameters.
Adabas Review allows you to modify and save the default report options settings.
After the report options have been modified, all new reports will have report options that default to the new settings. This will affect all new reports created by any user.
To modify the report default settings
Create a new empty report by entering ER on the Adabas Review command line.
Press PF2 or enter the command OPTNS on the command line to display the Report Options screen.
Make any desired changes.
Press PF9 (Dflts) to save the modifications.
You are returned to the Edit Report screen.
To change the options for a particular report
Create a new empty report or access and existing report by entering ER on the Adabas Review command line.
Press PF2 or enter the command OPTNS on the command line to display the Report Options screen.
Enter the changes directly on the Report Options screen.
After completing your changes, press PF6 or enter the ACCPT command.
The accept command stores your selections temporarily while you continue working on your report.
You are returned to the Edit Report screen.
