This section describes parameter syntax and statements to be used if you are entering the batch parameter statements manually or are making changes to statements generated by the GENCARD command.
This document covers the following topics:
A parameter statement consists of a statement name followed by at least one blank and one or more optional (positional or keyword) parameters separated by commas:
The following syntax rules pertain to parameter statements:
Statements may be entered in positions 1-71.
At least one blank must separate the statement name and the first parameter.
Multiple parameters must be separated by commas.
Blanks are not permitted within a parameter entry, except when enclosed within apostrophes.
A statement with multiple parameters may be continued by ending the line with a comma followed by a blank, and entering the next parameter on the next line beginning in any position between 1-71.
Comment lines may be inserted by entering an asterisk in position 1. Comment lines may also be inserted following the blank that ends the statement.
Positional parameters specify the data fields to be summarized and/or displayed as part of the Adabas Review report.
A positional parameter is a single value, usually an Adabas command log field name. Refer to section Field Reference for information about individual data fields.
Keyword parameters either specify input record selection criteria or define specific parameter statement options. A keyword parameter consists of a keyword name, a keyword separator, and a parameter value.
Keyword names vary depending on the particular parameter statement. Field names referencing Adabas data fields are used as keyword names when specifying input record selection criteria. When defining a specific parameter statement option, specific keyword reserved words are used as keyword names.
Valid keyword separators include:
=, <,>, and ¬
These relational symbols (equal to, less than, greater than, and not equal to, respectively) are used to define selection criteria for Adabas Review report processing.
Parameter values are numeric, alphanumeric, or hexadecimal in format. Note that a hexadecimal value must be enclosed in apostrophes and be preceded by an "X". A list of values is identified by enclosing the list in parentheses with the values separated by commas. For a range of values, a hyphen is used to separate the low and high values of the range.
A summary table of the parameter statements used by the Adabas Review processor is presented below. For information about the data fields used with the statements, refer to section Field Reference.
| Statement | Use |
|---|---|
| AVERAGE | Specifies the data fields for calculating average values in summary reports. |
| COPY | Copies input detail records or summary data records to a sequential dataset or the Adabas Review repository. |
| COST | Specifies the factors to be used in resource cost calculations for summary records. |
| DISPLAY | Defines the control break fields for summary reports, and specifies the data fields to be printed for detail reports. |
| ENV | Specifies a numerical factor for adjusting values returned in the CMDRESP field. |
| ENVIRONMENT | Allows the user to specify CPU-ID and database ID. This information is included in output generated by a COPY statement for a report. |
| EXCLUDE | Defines specific input detail records to be excluded from processing for both summary and detail reports. |
| INCLUDE | Defines specific input detail records to be included in processing for both summary and detail reports. |
| INPUT | Defines the input data to be processed by the Adabas Review processor and optional output logging parameters. |
| LOG | Specifies how Adabas Review performs physical command logging. |
| MINIMUM | Specifies the data fields for which minimum values will be printed on summary reports. |
| PERCENT | Specifies the data fields for which percentage is to be calculated for summary reports. |
| RATE | Specifies the data fields for which rate is to be calculated for summary reports. |
| REPORT | Defines the type of report to be generated along with the report format and title lines. |
| ROUND | Specifies the data fields for which rounding is to occur. |
| SUM | Specifies the data fields for which total values will be produced on summary reports. |
The AVERAGE statement specifies the data fields for which average values are to be calculated for an Adabas Review summary report.
The AVERAGE statement is applicable to summary reports only. Average values are calculated only for the valid data fields specified in this statement. Average values are summarized and printed on the summary report at each control break defined by the parameter statement for all data fields for which average values have been calculated. Average values are printed to one more rounded decimal place than the field data being averaged.
Example:
Print average values for the Adabas command log fields ASSOIO, WORKIO, and DATAIO on the summary report.
AVERAGE ASSOIO,WORKIO,DATAIO
where DBID, FILE, and
SVC represent the Adabas Review repository.
The COPY statement specifies that input detail records or summary data records are to be copied to a sequential dataset or an Adabas file.
The keyword parameter FILETYPE specifies whether
the data is to be copied to a sequential dataset or to Adabas. The following
functions can be performed using this statement:
Copy detail records to a sequential dataset.
The user can select subsets of detail log records and copy them to
different sequential datasets. These datasets can then be used as future input
to Adabas Review.
Copy detailed or summary data to Adabas.
The user can write specified information back into the Adabas Review
repository where it can be viewed using either the online history functions or
Adabas applications written by the user.
The physical command log may be created with less overhead for the Adabas nucleus by using this function with the Adabas Review processor running interactively.
The keyword parameter LIMIT specifies the
maximum number of records to be copied. The default is to copy all records.
Copy all input detail records satisfying the selection criteria specified on the INCLUDE statement to the sequential dataset RVUCOPnn, where nn is incremented sequentially beginning with 01 for the first copied file.
REPORT TYPE=DETAIL INCLUDE ... DISPLAY ... COPY FILETYPE=SEQUENTIAL
Copy all summary data records to the Adabas Review repository.
REPORT TYPE=SUMMARY DISPLAY ... COPY FILETYPE=ADABAS,DBID=133,FILE=3
The COST statement, which is used only in summary reports, specifies the factors to be used in calculating resource costs and the data fields to which the cost factors are to be applied. The costs calculated for the specified data fields are automatically printed on the output report. If costs are calculated for more than one data field, a combined total cost column is printed as the column to the far right on the summary report. The special reserved word FIXED specifies that a fixed cost is to be applied to each input detail record.
Valid arithmetic operators are: *, +, -, and @. The first three operators specify that the value of the designated data field is to be multiplied by the indicated cost factor (*), that a constant factor is to be added to the value of the data field (+), or that a constant value is to be subtracted from the value of the data field (-). The remaining operator (@) is used only with FIXED to specify that a fixed cost is to be applied to each input detail record.
Cost factors can be positive or negative numeric values containing up to four decimal places. Negative values can be used only with the operators * and @. Costs are calculated only for those data fields for which cost factors are specified.
Calculate costs by multiplying the CMDRESP field by .0025 and multiplying the total IO count by 2.50.
COST CMDRESP*.0025,IO*2.50
Calculate costs by applying a fixed cost of 5.00 to each input detail record.
COST FIXED@5.00
Calculate costs by adding 1.5 to the value of the ASSOIO field, multiplying the DATAIO field by a negative 1.25, multiplying the WORKIO field by a positive 2.
COST ASSOIO+1.5,DATAIO*-1.25,WORKIO*
The DISPLAY statement defines the control break fields for Review summary reports. Data is summarized at each control break specified in this statement for all data fields for which calculations have been performed.
One DISPLAY statement must be specified with at least one field for a summary report.
The DISPLAY statement is also used to specify the data fields to be printed on Review detail reports.
Print data summarized by Adabas COMMAND within file number (FNR) within JOBNAME on the summary report.
DISPLAY JOBNAME,FNR,COMMAND
Print the data fields SEQUENCE, DATE, USERID, and CMDRESP on the detail report in the order specified.
DISPLAY SEQUENCE,DATE,USERID,CMDRESP
Note:
Adabas Review makes no claim to be able to recover or report actual
CPU time.
If you are not satisfied with the values you receive in the Adabas Review CMDRESP field, you can use the ENV control statement to adjust the values.
"n.nnnn" is the factor to be multiplied by the value reported in the Adabas Review field CMDRESP to adjust it to the total Adabas nucleus session CPU time reported by the operating system. All digits must be specified.
To implement the ENV control statement
Run your Adabas nucleus with an autostarted Review report that shows the total of all command response time for the nucleus session (CMDRESP field).
When the database is stopped, examine the output report and note the total CMDRESP value as reported by Adabas Review.
Obtain the total CPU time used by the Adabas nucleus session as reported by the operating system.
Compare the two values and determine the relationship between them.
For the next Adabas nucleus session, you can adjust the Adabas Review value to more closely approximate the operating system value by inserting the ENV control statement into the RVUAUT1/2 or RVUPARM after the INPUT statement and before the first REPORT statement.
Review CMDRESP=100.0000; CPU time reported by the operating system=50.0000.
The ratio between the two values is 2:1 where the Adabas Review CMDRESP field value is two times the Adabas nucleus session CPU time reported by the operating system.
To adjust this for the next Adabas session, set the ENV control statement parameter ENV-FACTOR to 0.5000 so that Review divides the CMDRESP value by 2.
The RVUAUT statements may be similar to the following:
INPUT FILETYPE=SEQUENTIAL,
BUFFER-SEGMENTS=2000,
FILES=1,
REVIEW-COMMANDS=YES
ENV ENV-FACTOR=0.5000
REPORT TYPE=SUMMARY,
TITLE=`TOTAL CMDRESP',
PROGRAM=RD-00089,
RESTRART=Y,
MAXSTORE=8
DISPLAY DBNAME
SUM COMMANDS,IOS,CMDRESP
Review CMDRESP=25.0000; CPU time reported by the operating system=100.0000.
The ratio between the two values is 1:4 where the Adabas Review CMDRESP field value is one quarter of the Adabas nucleus session CPU time reported by the operating system.
To adjust this for the next Adabas session, set the ENV control
statement parameter ENV-FACTOR to 4.0000 so that Review
multiplies the CMDRESP value by 4.
The ENVIRONMENT statement specifies the identification number of the CPU or database from which the Adabas command log originated. The ENVIRONMENT statement should only be used with the COPY statement (see COPY Statement for more information).
The EXCLUDE parameter statement defines specific input detail records that are to be excluded from processing.
Relational symbols specify that input detail records are to be excluded if the value of the designated data field is equal to, less than, greater than, or not equal to the value indicated in the parameter statement:
| Symbols | Hex Equivalent | |
|---|---|---|
| Equal to | = | X'7E' |
| Less than | < | X'4C' |
| Greater than | > | X'6E' |
| Not equal to | ¬ | X'5F' |
Note:
The symbol for "not equal to" varies; it may also be "^" or "". The
hex equivalent is the same on all machines.
Parameter values may be in numeric, alphanumeric, or hexadecimal format. A hexadecimal value must be enclosed in apostrophes and preceded by an "X". A list of values is enclosed in parentheses with the values separated by commas. For a range of values, the low and high values of the range are separated by a hyphen.
For alphanumeric fields, you may use an asterisk (*) for "wildcard" prefixing and suffixing. For example, to exclude all job names beginning with "A" and all job names ending with "TEST", enter the statement as
EXCLUDE JOBNAME=(A*,*TEST)
Note:
EXCLUDE parameter statements with multiple field names have
different logical meanings if the field names are entered as multiple EXCLUDE
statements rather than as a single continuous statement. If entered as a single
statement, the Boolean operator AND is implied; if entered as multiple
statements, the Boolean operator OR is implied.
Exclude input detail records from processing if the value of the SEQUENCE field is less than 100 AND the value of the JOBNAME field is equal to AAAAAAAA or is within the range XXXXXXXX through ZZZZZZZZ.
EXCLUDE SEQUENCE<100,JOBNAME=(AAAAAAAA,XXXXXXXX-ZZZZZZZZ)
Exclude input detail records from processing if the value of the SEQUENCE field is less than 100 OR the value of the JOBNAME field is equal to AAAAAAAA or is within the range XXXXXXXX through ZZZZZZZZ.
EXCLUDE SEQUENCE<100 EXCLUDE JOBNAME=(AAAAAAAA,XXXXXXXX-ZZZZZZZZ)
The INCLUDE parameter statement defines specific input detail records to be included in processing.
Relational symbols specify that input detail records are to be included if the value of the designated data field is equal to, less than, greater than, or not equal to the value indicated in the parameter statement.
| Symbols | Hex Equivalent | |
|---|---|---|
| Equal to | = | X'7E' |
| Less than | < | X'4C' |
| Greater than | > | X'6E' |
| Not equal to | � | X'5F' |
Note:
The symbol for "not equal to" varies; it may also be "^" or "". The
hex equivalent is the same on all machines.
Parameter values may be in numeric, alphanumeric, or hexadecimal format. A hexadecimal value must be enclosed in apostrophes and must be preceded with an "X". A list of values is enclosed in parentheses with the values separated by commas. For a range of values, the low and high values of the range are separated by a hyphen.
For alphanumeric fields, you may use an asterisk (*) for "wildcard" prefixing and suffixing. For example, to include all job names beginning with "A" and all job names ending with "TEST", enter the statement as
INCLUDE JOBNAME=(A*,*TEST)
Note:
INCLUDE parameter statements with multiple field names have
different logical meanings if the field names are entered as multiple INCLUDE
statements rather than as a single continuous statement. If entered as a single
statement, the Boolean operator AND is implied; if entered as multiple
statements, the Boolean operator OR is implied.
Include input detail records in Adabas Review processing only if the value of the SEQUENCE field is greater than 100, AND the value of the JOBNAME field is equal to AAAAAAAA or ZZZZZZZZ, AND the value of the response code field (RSP) is within the range 9 through 150.
Note:
The same field name may not be used more than once for a
particular INCLUDE statement.
INCLUDE SEQUENCE>100,JOBNAME=(AAAAAAAA,ZZZZZZZZ),RSP=(9-150)
Include input detail records in Adabas Review processing if the value of the SEQUENCE field is greater than 100, OR if the value of the JOBNAME field is equal to AAAAAAAA or ZZZZZZZZ, OR if the value of the response code (RSP) field is within the range 9 through 150.
INCLUDE SEQUENCE>100 INCLUDE JOBNAME=(AAAAAAAA,ZZZZZZZZ) INCLUDE RSP=(9-150)
—where FILES is used only under VSE/ESA.
The INPUT parameter statement defines the characteristics of the input records to be processed by the Adabas Review processor. The statement format is described in the following table:
The LOG statement determines how Adabas Review is to perform physical command logging; i.e., what information is to be logged and where it is to be written.
The following table describes the parameters within the LOG statement:
The MAXIMUM parameter statement applies only to Adabas Review summary reports. It specifies the data fields for which maximum values are to be printed on these reports. Maximum values are printed only for the valid data fields specified in this statement.
Maximum values are summarized and printed on the summary report at each control break defined by the DISPLAY parameter statement for all data fields for which maximum values have been determined.
Determine maximum values for the Adabas log fields ASSOIO, WORKIO, and DATAIO and print them on the summary report.
MAXIMUM ASSOIO,WORKIO,DATAIO
The MINIMUM parameter statement applies only to Adabas Review summary reports. It specifies the data fields for which minimum values are to be printed on these reports. Minimum values are printed only for the valid data fields specified in this statement.
Minimum values are summarized and printed on the summary report at each control break defined by the DISPLAY parameter statement for all data fields for which minimum values have been determined.
Determine minimum values for the Adabas log fields ASSOIO, WORKIO, and DATAIO and print them on the summary report.
MINIMUM ASSOIO,WORKIO,DATAIO
The PERCENT parameter statement applies only to Adabas Review summary reports. It specifies the data fields for which percentage values are to be printed on these reports. Percentage values are printed only for the valid data fields specified in this statement.
Percentage values are summarized and printed on the summary report at each control break defined by the DISPLAY parameter statement for all data fields for which percentage values have been determined.
Determine percentage values for the Adabas log fields ASSOIO, WORKIO, and DATAIO and print them on the summary report. The sum of the percentage values for each specified data field is 100 percent.
PERCENT ASSOIO,WORKIO,DATAIO
The RATE parameter statement applies only to Adabas Review summary reports. It specifies the data fields for which rate values are to be printed on these reports. Rate values are printed only for the valid data fields specified in this statement.
Rate values are summarized and printed on the summary report at each control break defined by the DISPLAY parameter statement for all data fields for which rate values have been determined.
Determine rate values for the Adabas log fields ASSOIO, WORKIO, and DATAIO and print them on the summary report. The rate will be calculated as the amount of data collected per second.
RATE ASSOIO,WORKIO,DATAIO
The REPORT statement is critical in that it indicates that all of the following statements up to the next REPORT statement define the contents of the current report.
The REPORT statement defines the type of report to be generated by the Adabas Review processor. The following table describes the parameters in the REPORT statement:
| Keyword | Specifies . . . |
|---|---|
| TYPE | whether the report to be generated is a detail or summary report. This parameter must be specified; there is no default. |
| ADALIMIT | a minimum command count (number of times the command was processed) for printing. For example, if ADALIMIT=100, only entries with a command count of 100 or higher are printed. |
| BREAK | whether subtotals are printed at control breaks or suppressed. |
| DISPLAYBY | the order in which the data is
displayed:
|
| ENTRIES | the maximum number of entries that a report will process, thus restricting the amount of data collected by the summary report. |
| HISTORY-INTERVAL | the frequency (in minutes) with which history data is written. |
| LIMIT | the maximum number of detail lines to be printed on the output report. The default is to print all detail lines. A value of "99999999" indicates that there is no limit. |
| {LINESIZE | WIDTH} | the width of a report line. The line width can be stated as any numeric value of at least 72 characters and not greater than 989 characters. The default value is 132 characters. |
| MAXSTORE | the maximum amount of storage (in kilobytes) available for the report. |
| PAGESIZE | the length (in lines) of a report page. The minimum is 10 lines. The default is 55 lines, which provides a top and bottom margin for standard printer spacing on a total page size of 66 lines. |
| whether the report will be printed at database termination. | |
| PROGRAM | the name of the display program to be used if the report results are displayed online. |
| REPORT-EXIT | the name of the report user exit that is executed whenever a command log record is selected for a detail report. See the section Report Exits in Report Option Parameters for more information. |
| RESTART | whether the report is reactivated after the history interval is reached, the report is closed, or the report MAXSTORE limit is exceeded. |
| SKIP | whether to single-space or double-space the detail lines on the output report. The default is to single-space the detail lines. |
| SPACE | the number of spaces to allow between the data fields printed on the output report. This factor applies to all data fields on detail reports but only to the fields defined as control breaks by the DISPLAY parameter statement on summary reports. The default is to allow one space between data fields. |
| SUMMARY-EXIT | he name of the report user exit that is executed whenever an Adabas command or a summary record is selected for a summary report. See the section Report Exits in Report Option Parameters for more information. |
| TARGET | the database from which the report collects data. If this parameter is missing, invalid, or zero, the report is ignored and will not be started. |
| TITLE | the title line for the report when only one line is used. A maximum of 60 characters is allowed. The default value is blanks. |
| TITLE1 TITLE2 |
the title lines for the report when more than one line is used. A maximum of 60 characters is allowed for each title line. The default value is blanks. |
| WRAP | whether wrapping (i.e., reusing data elements for the report) will occur. By default, wrapping will not occur. |
Define a summary report with the title "A Report with Exit" to collect data from database 12345. The display program RD-00001 is to be used if the report results are displayed online. The maximum storage limit for the report will be 16 kilobytes and the report will be automatically reactivated when the maximum storage limit is exceeded. The user-written exit MYEXIT will be called whenever a command log record is selected for the report.
REPORT TYPE=SUMMARY,TITLE='A REPORT WITH EXIT', PROGRAM=RD-00001,TARGET=12345,RESTART=Y, REPORT-EXIT=MYEXIT,MAXSTORE=16
See the section Parameter Statement Processing for another example.
The ROUND parameter statement applies only to Adabas Review summary reports. It specifies the data fields for which rounding is to occur on these reports. The fields specified on the ROUND statement must also be specified on the DISPLAY statement.
Round the Adabas DURATION field up to .05 of a second.
ROUND DURATION=.05
The SUM parameter statement applies only to Adabas Review summary reports. It specifies the data fields for which value totals are to be calculated on these reports. Values are printed on the summary report at each control break defined by the DISPLAY parameter statement for all data fields that have been summed.
Print the summed values for the DURATION field, Associator IOs, Data Storage IOs, and Work IOs on the summary report.
SUM DURATION,ASSOIO,DATAIO,WORKIO
This section discusses the processing order of Adabas Review parameter statements and the effect of that order on the contents of detail and summary reports.
The most critical parameter statement is the REPORT statement. It indicates that all of the following statements up to the next REPORT statement define the contents of the current report.
REPORT TYPE=DETAIL INCLUDE ... DISPLAY ...
REPORT TYPE=SUMMARY EXCLUDE ... DISPLAY ... AVERAGE ... SUM ...
REPORT TYPE=DETAIL DISPLAY ...
There are three distinct reports: the first and third reports are detail reports; the second report is a summary report. Each report includes/excludes different input records; different statistics are compiled and printed for each report.
A parameter statement containing multiple parameter entries can be entered as one continuous statement or as several statements, each containing one or more parameter entries. For all parameter statements except the INCLUDE, EXCLUDE, and DISPLAY statements, either method will produce the same results.
Print the sum for the values in the data fields COMMANDS, ASSOIO, and DATAIO on the report.
SUM COMMANDS, ASSOIO, DATAIO
Example 2 produces the same results as example 1:
SUM COMMANDS SUM ASSOIO SUM DATAIO
INCLUDE/EXCLUDE parameter statements with multiple parameters have different logical meanings based on whether the parameters are entered as separate statements or as a single continuous statement.
In this example, logical AND is implied between the
SEQUENCE parameter and JOBNAME
and RSP parameters. Input detail records must satisfy
all three conditions in order to be selected for processing:
INCLUDE SEQUENCE>100,JOBNAME=AAAAAAAA,RSP<150
In this example, logical OR is implied between each INCLUDE statement. Input detail records meet the selection criteria by satisfying any of the three conditions specified in the statements:
INCLUDE SEQUENCE>100 INCLUDE JOBNAME=AAAAAAAA INCLUDE RSP<150
In this example, logical AND is implied between the
SEQUENCE parameter and the
JOBNAME and DATE parameters
entered on the first INCLUDE statement. Input detail records must satisfy
all three conditions in order to be selected for processing. No
further checking is done on the records satisfying these conditions; they are
included in the processing regardless of whether they satisfy the conditions
set by the remaining parameter statements:
INCLUDE SEQUENCE>100,JOBNAME=AAAAAAAA,DATE<90201 EXCLUDE RSP>0 INCLUDE MONTH=12,DAY>15 EXCLUDE FNR<101
Note:
It is not possible to use a field (parameter) more than once in a
single INCLUDE statement; that is, in a logical AND operation.
Input detail records that do not satisfy the conditions specified on the first INCLUDE statement are checked against the selection criteria specified on the next EXCLUDE statement. All records satisfying this condition (i.e., RSP>0) are excluded from processing and no further checking is done on these records.
The detail records that have not been specifically included or
excluded from processing by the first two parameter statements are checked
against the selection criteria specified on the next INCLUDE statement. Again,
logical AND is implied between the MONTH and
DAY parameters entered on this statement, and both
conditions must be met in order for records to be selected for processing. No
further checking is performed on the records satisfying these conditions; they
are included in the processing regardless of whether they satisfy the
conditions set by the final EXCLUDE statement. The remaining input detail
records are then checked against the final EXCLUDE statement. All records
satisfying the specified condition (i.e., FNR<101) are excluded from
processing.
Note that all records not excluded by the final EXCLUDE statement are included in the processing. If the final statement is an INCLUDE statement, all records satisfying the specified conditions for inclusion are included in the processing.