The OPTION command is a global command that defines cosmetic options for all reports. Entering it once sets options for all reports.
This command has the following syntax:
OPTION ([AVERAGE=[NO | YES | n ]]
[DEFERRED | DNW | IMMEDIATE]],
[CASE=UPPER],
[DATAONLY=[NO | YES]],
[DATEFRMT=[MM/DD/YY | DD/MM/YY]],
[DEFEREXT=[NO | YES]],
[DUMP=[NO | YES]][CORRUPT],
[ECHO=[YES | NO]],
[HEXID=[NO | YES]],
[IOERR=[NO | YES | BYPASS]],
[JOBZONE=[nWEST | nEAST]],
[LEAPSEC=[YES|NO|nn]],
[MAXTO=[YES | NO]],
[MONETARY=n],
[NULLID=[BLANK | 'xxxx' | n/a]],
[NULLINE=[YES | NO]],
[PERIOD=WEIGHTED]],
[PERIOD=[NO | YES]],
[PGMSTOR=[NO | YES]],
[PRODUCT=EVSE|EXPC|ESQL|EXPV],
[PRINT=GROUP],
[RANGE=WEIGHTED],
[RECAP=[NO | YES],
[RECORD=n],
[RECSTAT=[NO | YES]],
[RPTSTAT=[NO | YES | xxxxx]],
[STORAGE=[BELOW | ABOVE]],
[STORSTAT=[NO | YES],
[SUMMARY=YES | NO | n],
[TAB2SKIP=[n | PAGE],
[TRACE=[NO | STORAGE | LOADS],
[WEEK=weekday],
[XMSG=[nnn | ALL],
[ZEROFLD=[BLANK | ZERO | 'xxxx']]
['SRT=nnn']
['COPYRIGHT=NO'])
Specifies whether to print a line giving averages of the items listed in the report. If you set AVERAGE=n, the averages are printed only if the report contains n or more detail lines. For graph reports, you can specify when the average is calculated and if it is weighted.
AVERAGE=IMMEDIATE calculates the average line during data accumulation. The average is weighted.
AVERAGE=DEFERRED calculates the average line before printing the report. The average is weighted. Use this setting with the FOR operand or RANGE DEFERRED command and want the average line to reflect only the lines being printed.
AVERAGE=DNW (Deferred Not Weighted) calculates the average line before printing the report, but the average is not weighted.
AVERAGE=NO (no average line).
Default: IMMEDIATE (for graph reports)
Changes the case of the report.
Specify CASE=UPPER to force all output to uppercase. You can also use the PARM= parameter of your // EXEC statement to perform this function.
Default: Output is in mixed case.
Note: For more information, see the chapter “Writing a Report.”
Prints only lines containing report data when you specify YES. Otherwise, all lines are printed. You can also use the PARM= parameter of your // EXEC statement to perform this function.
Default: NO
Note: For more information, see the chapter “Writing a Report.”
Sets the format of dates in report output to mm/dd/yy or dd/mm/yy. You can also use the PARM= parameter of your // EXEC statement to perform this function.
Default: MM/DD/YY
Note: For more information, see the chapter “Writing a Report.”
Specifies when to call a user exit.
DEFEREXT=NO passes control to the exit before any processing is done with the current record.
DEFEREXT=YES defers the user exit call. The call processes when all selection criteria have been applied and passes to the user exit only those records passing all selection criteria. For example, ID options and RANGE commands.
For example, the ID options and RANGE commands.
Default: NO
Specifies whether to print a diagnostic dump of input records.
DUMP=YES dumps all used records.
DUMP=CORRUPT dumps all records with detected corruption.
Default: NO
Specifies whether to list your report commands before printing the report. Set the value to NO only after you verify the report commands. Any report commands preceding the ECHO=NO command in the job stream appears with the report. You can also use the PARM= parameter of your // EXEC statement to perform this function.
Default: YES
Note: For more information, see the chapter “Writing a Report.”
Specifies whether to allow nonprintable characters in identification fields.
HEXID=NO treats any identification field that contains a nonprintable character as invalid. All information regarding the resource is saved and printed under the identifier INVALID.
HEXID=YES deactivates the test for nonprintable characters. When the report prints, however, all nonprintable characters are printed as periods.
Default: YES
Determines what happens if the Report Writer encounters an I/O error in input data.
IOERR=NO causes the Report Writer to stop and no reports are printed.
IOERR=YES causes the Report Writer to treat the error as an end-of-file and produces reports defined up to that point.
IOERR=BYPASS causes the Report Writer to attempt to bypass the error condition and continue processing input.
Default: NO
Sets the job zone (the number of hours east or west of Greenwich Mean Time). Specify nEAST or nWEST, where n is an integer.
Default: Value set by the ZONE parameter of the IPL SET command.
Sets the behavior of the leap second adjustment when time-of-day values are read from records.
LEAPSEC=YES causes the leap second adjustment to be applied.
LEAPSEC=NO causes the leap second adjustment to be ignored.
LEAPSEC=nn causes a user specified value to be used in place of the assumed leap second offset, where nn is an integer.
Default: YES
Applies only if every report in the run includes a TO command. By default, an end-of-file condition is forced when the maximum TO time specified with any report is exceeded. If the input file is not in chronological order, specify MAXTO=NO to force the entire file to be read.
Default: YES
Specifies the character to precede currency numbers. You can specify any single character.
Default: $ (dollar sign)
Defines a four-character string to print in any identifier field for which no identifier exists. Specify NULLID=BLANK to print blanks in fields for which no identifier exists.
Default: The characters n/a
Specifies whether to print lines with all zero values.
Default: YES for plot reports; NO for tabular reports
Controls whether the period line of a plot report is a weighted value; that is, the average of all the detail lines. PERIOD=WEIGHTED converts the period line into a weighted value that represents a true average over the period.
Default: Not weighted
Controls whether to print the period line of a tabular report.
Default: YES
Controls whether the diagnostic storage analysis facility displays the storage acquired by each Report Writer internal program.
Default: NO
Specifies the product for DEFINE XID or DEFINE XVAR commands. Specify XPFC for Command for CICS.
Default: No default
Controls whether a report prints only group items.
Default: GROUP
Controls whether the range line of a plot report is a weighted value; that is, the average of all the detail lines. RANGE=WEIGHTED converts the range line into a weighted value.
Default: Not weighted
Specifies whether to produce a summary value for each identifier in the report. Depending on the variable, the summary line includes the total, average, maximum, or minimum values of the variable. This option is valid only for tabular reports organized by identifier and time.
Specifies the decimal value of the record type for DEFINE XID or DEFINE XVAR commands.
Default: No default
Specifies whether to print statistics about CA SYSVIEW records following your report. RECSTAT=YES prints information including the length of each record and each of its components (in the case of performance records), the percentage of the total disk space that each record or component comprises, and the time period covered by each.
This helps you determine which CICS resources to collect data for. In particular, if a given component contains a great deal of data, but you seldom run reports on this data, you may choose to stop collecting that data in order to lessen the storage required for the SMF files.
Default: NO
Controls how often the following message is issued to the console:
ERPT274I STATUS: CNT - nnnnn.
TIME - mm/dd/yy hh:mm:ss
nnnnn provides the current number of input records processed. mm/dd/yy hh:mm:ss provides the timestamp of the current record.
RPTSTAT=YES produces a status message every 10,000 records. RPTSTAT=nnnnn produces a status message every nnnnn records. You can also specify HOUR, DAY, or WEEK to generate the status message on a hourly, daily, or weekly interval.
Default: NO
If 31 bit addressing is available, specifies whether storage is acquired above or below the 16 MB line.
Default: ABOVE
Specifies whether to print storage statistics following the last report. STORSTAT=YES prints the storage amounts allocated to each report and the total amount of unused virtual storage.
Default: NO
Pertains only to tabular reports using an ID option. SUMMARY=YES prints a summary line. If you specify SUMMARY=n, summary lines are printed only if the report contains at least n lines. Depending on the variable, the summary line includes the total, average, maximum, or minimum values of the variable.
Default: YES
For TAB2 reports only, controls how much space is left between identifiers listed by the TAB command. Either specify TAB2SKIP=n, where n is the number of lines to be skipped, or specify TAB2SKIP=PAGE to generate a page break after each identifier.
Default: 0 (no space)
Controls the diagnostic tracing facility. TRACE=STORAGE causes message ERPT267I to print every time an internal storage request is processed. This message shows the name of the internal program requesting storage and shows how much storage the program is requesting.
TRACE=LOADS causes message ERPT283I to print whenever a Report Writer module is loaded or freed. This message shows the name of the module.
Default: NO
Specifies the first day of the week (SUNday, MONday, TUESday, WEDnesday, THURsday, FRIday, or SATurday). If you specify the EACH nnn WEEKs command, you can use this operand to specify whether a week is Monday through Sunday, Tuesday through Monday, and so on.
Default: MONday
Excludes messages from printing and from displaying on the console. XMSG=nnn excludes message ERPTnnn from output. XMSG=ALL excludes all messages.
Default: No messages are excluded.
Defines a value to replace any zero values. ZEROFLD=BLANK replaces any zero value with a blank. ZEROFLD=ZERO prints a zero. ZEROFLD=xxxx replaces each zero value with xxxx.
Default: BLANK for tabular reports; ZERO for graph and plot reports.
Specifies a new default decimal value for the CA SYSVIEW record type.
For example, specifying SRT=250 changes the default record type from 255 to 250.
Default: 255
Note: The CA EXPLORE Report Writer automatically recognizes whether CA SYSVIEW produced the SMF record. Using the SRT option disables automatic recognition.
Controls whether to print the copyright statement lines. Specifying COPYRIGHT=NO prevents the copyright statement from printing. Notice that first statement is printed before the options are processed. To stop the first statement from printing, include the EXEC parameter of COPYRIGHT=NO.
Note: For more information, see the chapter “Writing a Report.”
Example: OPTION Command
The sample OPTION command does the following:
OPTION(ZEROFLD=ZERO,NULLINE=YES,AVERAGE=5)
|
Copyright © 2013 CA.
All rights reserved.
|
|