Previous Topic: NOTE CommandNext Topic: PERFORM Command


OPTION Command

(Area 1)

The OPTION command serves two functions:

The format of the OPTION command is as follows:

Note: AUTO and phasename are parameters of DBCOMM.

►►─ OPTION ─┬─────────┬─┬───────────┬─┬───────────────────┬───────────────────►
            └─ ABORT ─┘ └─ COMPILE ─┘ └─ DASH ─┬─ ON  ──┬─┘
                                               └─ OFF ──┘

 ►─┬───────────────────────────┬─┬──────────────────┬─────────────────────────►
   └─ DBCOMM= ─┬─ AUTO ──────┬─┘ └─ DBPRI=priority ─┘
               └─ phasename ─┘

 ►─┬────────────────────────────┬─┬───────────────┬───────────────────────────►
   └─┬─ DBSEQBUF= ──┬─┬─ 2  ──┬─┘ └─ DDDBID=dbid ─┘
     └─ DBSEQBUFS= ─┘ └─ nn ──┘

 ►─┬───────────────────────┬─┬───────────┬─┬─────────────────────────┬────────►
   └─┬─ DISK= ──┬─ device ─┘ └─ EXCLUDE ─┘ └─ INDEXERR= ─┬─ 1 ─────┬─┘
     └─ DISKS= ─┘                                        ├─ FIRST ─┤
                                                         └─ ABORT ─┘

 ►─┬─────────────────┬─┬───────────────────┬─┬───────┬─┬─────────────┬────────►
   └─ LANG=language ─┘ └─ LIST ─┬─ ON  ──┬─┘ └─ MAP ─┘ └─ NEWREPORT ─┘
                                └─ OFF ──┘

 ►─┬────────────────────────────────────┬─┬───────────────────────────┬───────►
   └─ OMIT ─┬─ DETAIL ─┬ ─ BLANK LINES ─┘ └─ OUTLIMnnn ─┬─ LINES ───┬─┘
            ├─ TOTAL ──┤                                ├─ RECORDS ─┤
            └─ ALL ────┘                                └─ PAGES ───┘

 ►─┬────────────┬─┬───────────────┬─┬─────────────────────┬─┬─────────┬───────►
   └─ PAGE=nnn ─┘ └─ PRINTER=nnn ─┘ └─ PRTEXIT=phasename ─┘ └─ ROUND ─┘

 ►─┬────────────────────────┬────────────────────────────────────────────────►◄
   └─ RUNDIAG= ─┬─ YES ───┬─┘
                └─ NO ────┘
►►─┬───────────────────┬─┬────────────────────┬───────────────────────────────►
   └─ SIGN= ─┬─ F ───┬─┘ └─ SORT= ─┬─ NONE ─┬─┘
             └─ C ───┘             └─ nnn ──┘

 ►─┬────────────────────────────────┬─┬────────┬─────────────────────────────►◄
   └─ WRITE ONLY ─┬───────────────┬─┘ └─ XREF ─┘
                  └─ BLOCKED nnn ─┘
ABORT

Specifies that when the OPTION command is encountered, the Reporting Facility is to abort and print a system dump. This parameter is very rarely required, but you could use it for trapping and analyzing internal abend conditions.

COMPILE

Specifies that only source statements are to be compiled. The system creates no reports or output files. The Reporting Facility terminates the run immediately following the compilation. Use this feature to ensure that a clean compile is achieved before execution takes place. When this parameter is not present, the Reporting Facility defaults to COMPILE and EXECUTE.

DASH ON|OFF

Specifies whether the Reporting Facility compiler is to accept dashes as valid characters in data names. This parameter is necessary to allow for downward compatibility with earlier versions of the Reporting Facility where dashes were not allowed as valid characters in data names. If this parameter is omitted, DASH ON is the default.

DBCOMM=AUTO|phasename

Is used in conjunction with CA Datacom/DB table access in a program. It specifies the manner in which the required CA Datacom/DB User Requirements Table (URT) is referenced. You may specify the following parameters:

AUTO

Specifies that the Reporting Facility is to generate the URT entries automatically. The system makes a single entry for each CA Datacom/DB table defined in the run and generates an entry. This option can be disallowed by site management at product modification time.

phasename

Specifies a maximum eight-character name assigned to a prelink-edited UR that contains an entry for each CA Datacom/DB table to be accessed in the run. The first character of the phase name must be in the range of A—Z and subsequent characters must be in the range of A—Z or 0—9. This option must be used if DBCOMM=NOAUTO was chosen by site management at product modification time through the IS08Z09 macro.

DBPRI=priority

Specifies the priority of the automatically generated URT. Valid options are 1—15. The default is 3.

DBSEQBUF[S]=n

Specifies the number of sequential buffers. You can specify DBSEQBUF or DBSEQBUFS. This option is valid only with GETIT processing. The default is 2. The valid entries are 2 through 128 or -2 through -128.

DDDBID=dbid

Specifies the physical database ID in which CA Datacom Datadictionary resides. The system maintains the default value in the System Resource Table associated with the active dictionary. You need this parameter only if an alternate CA Datacom Datadictionary needs to be referenced. Use this parameter only for processing COPYDD commands in the Reporting Facility program. .cp10

DISK=device

Specifies the physical disk drive device type to be used by the Reporting Facility in any of three instances:

The only way to modify the disk device type on which the DRWORK file resides is to modify the system default value.

The system establishes the default disk device type during the installation of the Reporting Facility. This parameter overrides the default value for the current execution of the Reporting Facility.

Valid entries are 3350, 3375, 3380, 3390, 9345, and FBA (z/VSE).

EXCLUDE

Specifies that all page headings on the output reports are to be suppressed. If EXCLUDE is specified, it must precede the PAGE= parameter on the OPTION command. This parameter does not affect the printing of the Reporting Facility compile listing.

INDEXERR=FIRST|1|ABORT

Specifies the default processing to be performed when an index violation occurs during processing of an array reference. An index violation occurs when:

One of three parameters can be specified:

FIRST

Specifies that the Reporting Facility is to default to using the first element in the array when an index violation occurs, then to continue processing.

1

Causes the same affect as FIRST.

ABORT

Causes the Reporting Facility to abend immediately and print a system dump when an index violation occurs.

If no parameter is specified, the Reporting Facility assumes it is FIRST. The Reporting Facility automatically prints a line showing the number of index violations that occurred during execution of the Reporting Facility program.

LANG=language

Specifies the language translation to be performed when printing the literals 'PAGE', 'GRAND TOTAL', 'END OF REPORT', and the three-character abbreviation of the alphabetic month. The 'PAGE' and month abbreviation translations print on the Reporting Facility compiler listing and on the output reports.

'GRAND TOTAL' and 'END OF REPORT' translations appear only on the output reports. The system establishes the default language during installation of the Reporting Facility, and specification of this parameter overrides the default during a single execution of the Reporting Facility. The following is a summary of valid parameters and translations:

LANG=.

PAGE

GRAND TOTAL

END OF REPORT

ARABIC

PAGE

GRAND TOTAL

END OF REPORT

DANISH

SIDE

GRAND TOTAL

RAPPORT SLUT

DUTCH

PAGE

GRAND TOTAL

END OF REPORT

ENGLISH

PAGE

GRAND TOTAL

END OF REPORT

FINNISH

SIVU

LOBBUSUMMA

END OF REPORT

FRENCH

PAGE

TOT.GENERAL

RECAPITULATION

GERMAN

SEITE

GESAMTTOTAL

END OF REPORT

GERMAN2

BLATT

GESAMTTOTAL

REPORT ENDE

ITALIAN

PAGE

TOT.GEN

END OF REPORT

JAPANESE

PAGE

GRAND TOTAL

END OF REPORT

KOREAN

PAGE

GRAND TOTAL

END OF REPORT

NORWEGIAN

SIDE

TOTAL SUM

RAPPORT SLUTT

PORTUGESE

PAG.

TOTAL GERAL

FIM DO RELATORIO

SPANISH

PAG.

TOT. GRANDE

REPORT FINIS

SPARE

PAGE

GRAND TOTAL

END OF REPORT

SWEDISH

SIDA

GRAND TOTAL

RAPPORT SLUT

	 LANG=               3-CHARACTER ALPHABETIC MONTH ABBREVIATION
     ARABIC      JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC

     DANISH      JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC

     DUTCH       JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC

     ENGLISH     JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC

     FINNISH     JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC

     FRENCH      JAN  FEV  MAR  AVR  MAI  JUN  JUL  AUO  SEP  OCT  NOV  DEC

     GERMAN      JAN  FEB  MRZ  APR  MAI  JUN  JUL  AUG  SEP  OKT  NOV  DEZ

     GERMAN2     JAN  FEB  MRZ  APR  MAI  JUN  JUL  AUG  SEP  OKT  NOV  DEZ

     ITALIAN     GEN  FEB  MAR  APR  MAG  GUI  LUG  AGO  SET  OTT  NOV  DIC

     JAPANESE    JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC

     KOREAN      JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC

     NORWEGIAN   JAN  FEB  MAR  APR  MAI  JUN  JUL  AUG  SEP  OKT  NOV  DES

     PORTUGESE   JAN  FEV  MAR  ABR  MAI  JUN  JUL  AGO  SET  OUT  NOV  DEZ

     SPANISH     ENE  FEB  MAR  ABR  MAY  JUN  JUL  AGO  SEP  OCT  NOV  DIC

     SPARE       JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC

     SWEDISH     JAN  FEB  MAR  APR  MAY  JUN  JUL  AUG  SEP  OCT  NOV  DEC
LIST ON|OFF

Controls the printing of the Reporting Facility statements during compilation. You can suspend printing by specifying LIST OFF and resume printing by specifying LIST ON. LIST ON is the default. If LIST OFF is specified as the first card in the Reporting Facility, the banner page will not be printed. Otherwise, the banner page will always be printed.

MAP

Specifies that the Reporting Facility is to print a detailed analysis of the compilation process immediately following the source listing. This MAP contains internal control block analysis, a field name cross-reference listing, input and output file analysis, and detailed descriptions of each specified report.

When certain error conditions are detected during the compile, the Reporting Facility generates a limited form of the Map Listing regardless of whether OPTION MAP is specified. Specify OPTION MAP in each Reporting Facility program. When OPTION MAP is not specified, no detailed analysis is generated.

NEWREPORT

Inserts one blank page between each report. This is useful when printing on both sides of the paper.

OMIT DETAIL|TOTAL|ALL BLANK LINES

Specifies that, during report generation, the Reporting Facility is to suppress the printing of blank lines at the detail level, the total level, or both. This option does not affect page and column headings.

OUTLIM nnn RECORDS|LINES|PAGES

Specifies the maximum number (nnn) of records, lines, or pages to be processed in a single run of the Reporting Facility. You can code multiple OUTLIM parameters in a single run, each specifying one of the three options. The line and page options are effective only during the report printing stage. The record option limits either the total number of primary input records or the number of automatically generated Hit File records.

When the maximum number of records to be processed is reached, the system generates an effective GOTO EOJ. Processing then continues as normal. When the maximum number of lines or pages is reached, the Reporting Facility generates a message and terminates the run.

PAGE=n

Defines the maximum number of lines to be printed on a page before a page eject is forced. You can specify it as any valid numeric integer in the range of 8—88. Specifying a large page depth generates reports with initial report headings, but with no further page skipping (except where forced by the effect of a NEWPAGE or SKIP parameter on a CONTROL command).

Multiple OPTION PAGE&equals.n commands can be submitted in a single Reporting Facility run, but only the last one specified influences the page depth on printed reports. The system established the default page depth during the installation of the Reporting Facility. This parameter overrides it only for the current run.

PRINTER=n

Specifies the maximum number of characters to be printed on a single print line for the current run. You can specify it as any valid numeric integer in the range of 20—144. You can submit multiple OPTION PRINTER=nnn commands in a single Reporting Facility run to allow for different printing requirements for each report. (The printer width controls the centering of detail fields on the output report.)

The user ID is centered according to the printer width in effect when the REPORT command is processed. Positioning of the page number is also calculated based on the last printer width specified at the time of the REPORT command. The system established the default printer width during the Reporting Facility installation. The parameter overrides it only for the current run.

PRTEXIT=phasename

Specifies the name of a prelink-edited subroutine (developed by you) to which control is passed by the Reporting Facility in lieu of printing any lines. This subroutine can then examine or modify each line as it is being created by the Reporting Facility.

The phasename must begin with a character in the range of A—Z and subsequent characters must be in the range of A—Z or 0—9. The maximum length of the parameter is eight characters.

ROUND

Specifies that rounding will be done on all COMPUTEs and SETs in the program before the final total is placed in the result field. If not specified here, rounding can be specified on individual COMPUTE and SET statements. The default is not to round.

RUNDIAG=YES|NO

Specifies whether run diagnostics will be produced. The default is YES.

SIGN=F|C

Specifies the default positive sign value to be forced on packed decimal numbers as a result of a command. This is necessary since it is possible for fields in packed decimal format to be referenced in logical expressions, so a "character" compare can be generated. SIGN = F is the default.

SORT=NONE|n

Specifies the sorting requirements for a single run. SORT=NONE specifies that no sort will be performed during this run, and therefore limits the scope of the run to either creating an output file (Write-Only mode) or producing a single report presented in the same sequence as the input data (Secondary mode).

If sorting is to be performed, supply n to specify the number of intermediate work areas available for the sort. In a z/OS environment, n is in the range of 3—6. In a z/VSE environment, n is in the range of 1—8. If this parameter is omitted and a sort is required, the system assigns a default value of 3 (for z/OS) or 1 (for z/VSE).

WRITE ONLY (BLOCKED n)

Specifies that the Reporting Facility is to enter the Write-Only mode. The system creates a sequential, fixed-length disk file in lieu of report generation. The FORMAT command determines the format of the output file to be created. In the absence of the FORMAT command, the output file contains records of the same format and blocking factor as the primary input file.

If BLOCKED n is specified, it denotes the blocking factor to be used for the output file, that is, the number of records in one block of output. The Reporting Facility calculates the block size, which must be within the constraints imposed by the disk storage device track capacity for the current disk device type.

XREF

Provides a cross-reference of field names in the report. Each is listed in alphabetical order with the number of the line on which it was used.

Note the following: