Previous Topic: MENUNext Topic: PRINT


OPTIONS

OPTIONS sets default options for a CA OLQ session.

Syntax:

                       ┌──────────────────────────┐
►►─── OPTions ─┬─────┬─▼─┬─┬─ ALL ◄ ─┬──────────┬─┴───────────────────────────►◄
               └─ = ─┘   │ └─ NONe ──┘          │
                         ├─┬─ CODetable ─────┬──┤
                         │ └─ NOCODetable ◄ ─┘  │
                         ├─┬─ COMments ─────┬───┤
                         │ └─ NOComments ◄ ─┘   │
                         ├─┬─ DBKey ─────┬──────┤
                         │ └─ NODbkey ◄ ─┘      │
                         ├─┬─ ECHo ◄ ─┬─────────┤
                         │ └─ NOEcho ─┘         │
                         ├─┬─ FILler ─────┬─────┤
                         │ └─ NOFiller ◄ ─┘     │
                         ├─┬─ FULl ◄ ─┬─────────┤
                         │ └─ SPArse ─┘         │
                         ├─┬─ NEAder ◄ ─┬───────┤
                         │ └─ NOHeader ─┘       │
                         ├─┬─ INTerrupt ◄ ─┬────┤
                         │ └─ NOInterrupt ─┘    │
                         ├─┬─ OLQheader ─────┬──┤
                         │ └─ NOOlqheader ◄ ─┘  │
                         ├─┬─ PAThstatus ─────┬─┤
                         │ └─ NOPathstatus ◄ ─┘ │
                         ├─┬─ PICture ─────┬────┤
                         │ └─ NOPIcture ◄ ─┘    │
                         ├─┬─ TERse ─────┬──────┤
                         │ └─ VERbose ◄ ─┘      │
                         ├─┬─ WHOle ◄ ─┬────────┤
                         │ └─ PARtial ─┘        │
                         └─┬─ SYNonym ───┬──────┘
                           └─ NOSynonym ─┘

Parameters:

ALL/NONE

Specifies whether the default internal field list contains all or none of a record's fields.

The signon default for ALL/NONE remains in effect for all records retrieved in a session until changed by a user-specified FIELDS FOR command or by a user-specified field list in a FIND/GET command.

Although the default value of ALL is usually taken, it is recommended that, for lengthy records, the internal field list be limited to only those fields the user requires. The field list can be restricted by specifying OPTIONS=NONE followed by either a FIELDS FOR command or a field-list parameter for each record retrieved.

CODETABLE/NOCODETABLE

Specifies whether code tables are used to translate internal codes in one or more report columns into a screen display format.

OPTIONS=CODETABLE requests that code tables be applied to report columns. If a stand-alone table is specified with the EDIT command, CA OLQ uses that table to format the named report column. Otherwise, if a built-in table exists for the field in the data dictionary, this table is used for formatting.

OPTIONS=NOCODETABLE requests that no code table formatting be applied to report fields.

When you issue HELP REPORT, CA OLQ lists all code tables currently associated with report columns.

COMMENTS/NOCOMMENTS

Specifies whether comments are included in the HELP report files built by the HELP RECORDS, HELP SUBSCHEMAS, and HELP QFILES commands.

DBKEY/NODBKEY

Specifies whether dbkey columns are included in report files built by multiple record retrievals. Database keys qualified by page group are only included in a report file if the DBKEY option is in effect when the report file is initially created.

Note: There is a significant storage overhead associated with retrieving a large number of records with the DBKEY option on.

ECHO/NOECHO

Specifies whether the user-entered command is repeated by CA OLQ on the 3270-type output device.

FILLER/NOFILLER

Specifies whether filler field values will be available to the user. If you specify OPTIONS=NOFILLER (default), filler fields aren't displayed and don't have to be specified along with other fields in selection criteria.

If you specify OPTIONS=FILLER, filler fields are displayed and have to be specified in selection criteria for a group. Filler fields can only be accessed when OPTIONS=FILLER is in effect. Once a record is retrieved, changing the FILLER option has no effect on the internal field list.

FULL/SPARSE

Specifies how the format of displayed path retrieval report lines. FULL displays data associated with a record type once for each retrieved occurrence.

SPARSE, used with a SELECT command, displays only the first of a repeating data value; SPARSE, used with a path command, displays only the first of a repeating record type.

HEADER/NOHEADER

Specifies whether the report built by multiple record retrievals will be displayed with a header line.

INTERRUPT/NOINTERRUPT

Sets or disables the processing interrupt feature for multiple record retrievals. INTERRUPT limits the number of retrievals that can occur without intervention. The limit is established during system generation. When interrupt occurs, you can use the OPTIONS command to change processing control before issuing a YES response to the question of Continue processing?

Example

If OPTIONS=NOINTERRUPT is specified before a YES response, all remaining records are retrieved regardless of the interrupt level.

When OPTIONS=NOINTERRUPT is specified, the entire retrieval is executed with no interruptions. We recommend, however, that the default value of INTERRUPT be chosen to permit interruption of processing at known intervals. Users who regularly execute extensive retrievals and who do not wish to monitor CA OLQ for the duration of command execution may elect to enlarge the interrupt count at installation time or change it using the SET INTERRUPT COUNT command.

Note: Authorization for a user to select the NOINTERRUPT option is enabled through the data dictionary ADD USER DDDL statement. For more information about ADD USER DDDL statement and on CA OLQ security, see Assigning Authority to Access CA OLQ.

OLQHEADER/NOOLQHEADER

Specifies whether field names or user-specified CA OLQ headers will be used as headers for displayed data.

If you specify OPTIONS=OLQHEADER, field names are replaced with associated CA OLQ headers if any are defined in the data dictionary or if any are defined by the user. If you specify OPTIONS=NOOLQHEADER (the default), field names are used as report headers.

PATHSTATUS/NOPATHSTATUS

Specifies the conditions for logical record retrieval. Path statuses are issued during execution of logical record paths. Path statuses are 1 to 32-character strings. Path statuses can be either standard or defined by the DBA in the subschema. The three standard path status values are:

When OPTIONS=NOPATHSTATUS is in effect, CA OLQ retrieves a logical record only when the path status is LR-FOUND. If a DBA-defined path status is returned, CA OLQ treats it as if LR-ERROR were the path status. No report file is generated and CA OLQ displays the following message:

OLQ 095017 08 ERROR OCCURRED WHILE ATTEMPTING TO RETRIEVE
A LOGICAL RECORD.  PATH STATUS=dba-defined-path-status

The path status can be displayed or printed; the field name is PATH STATUS. PATH STATUS is automatically added to the internal field list whenever OPTIONS=PATHSTATUS is specified.

Note: To refer to the PATH STATUS field, enclose it in quotation marks ('PATH STATUS'). For further information on the status of logical record paths, see CA IDMS Logical Record Facility Guide.

PICTURE/NOPICTURE

Specifies whether external pictures or default pictures are used to edit report fields. OPTIONS=PICTURE requests that external pictures be used to format report fields. If an external picture has been constructed with the EDIT command, this picture edits the named report field. Otherwise, if an external picture exists for the field in the data dictionary, the stored picture is used for formatting. When OPTIONS=PICTURE is in effect, user-specified pictures override external pictures defined for fields in the data dictionary.

OPTIONS=NOPICTURE requests that default pictures be used to edit report fields. Default pictures are derived from the internal pictures defined for fields in the data dictionary.

When a HELP REPORT command is issued, external pictures for report fields are listed.

TERSE/VERBOSE

Specifies the amount of identifying information provided when ON BREAK computations are requested.

When multiple computations are requested for a single output command, it is often difficult to determine which breaks and computations apply to which fields. VERBOSE provides complete field and record names for all breaks and computations. TERSE allows more information to be displayed on the terminal screen but this information may be more difficult to read.

WHOLE/PARTIAL

Specifies the content of displayed path retrieval report lines.

If OPTIONS=WHOLE is in effect, only those rows containing a retrieved occurrence for every record type specified in the path definition are displayed.

If OPTIONS=PARTIAL is in effect, all lines retrieved are displayed even if the line doesn't contain each of the records specified in the path.

SYNONYM/NOSYNONYM

Specifies that synonyms for record names are (or aren't) defined in the data dictionary and can (or can't) be used in place of record names in CA OLQ. This option only applies to the record and column screens of menu mode CA OLQ.

Examples:

Options = Nocodetable

When OPTIONS=NOCODETABLE is in effect, stored values are displayed for the START-MONTH-0415 field:

options = nocodetable ! select emp-last-name-0415 start-year-0415 start-month-0415 from employee ! edit start-month-0415 codetable montab EMPLOYEE REPORT 09/21/99 EMP-LAST-NAME-0415 START-YEAR-0415 START-MONTH-0415 LINGER 77 12 TERNER 82 5 LINGER 78 5 PENMAN 77 9 LINGER 78 1 LITERATA 80 9 WILCO 79 11 HEAROWITZ 81 9 TYRO 80 12 KAHALLY 79 9 PAPAZEUS 78 9 ARM 77 12 KING 80 8 CLOUD 77 3 - 1 -

Options = Codetable

When OPTIONS=CODETABLE is in effect, a decoded value is substituted for each encoded value found for the START-MONTH-0415 field in the report file:

options = codetable ! select emp-last-name-0415 start-year-0415 start-month-0415 from employee ! edit start-month-0415 codetable montab EMPLOYEE REPORT 09/21/99 EMP-LAST-NAME-0415 START-YEAR-0415 START-MONTH-0415 LINGER 77 DECEMBER TERNER 82 MAY LINGER 78 MAY PENMAN 77 SEPTEMBER LINGER 78 JANUARY LITERATA 80 SEPTEMBER WILCO 79 NOVEMBER HEAROWITZ 81 SEPTEMBER TYRO 80 DECEMBER KAHALLY 79 SEPTEMBER PAPAZEUS 78 SEPTEMBER ARM 77 DECEMBER KING 80 AUGUST CLOUD 77 MARCH - 1 -

Options = Dbkey

When OPTIONS=DBKEY is in effect, a database key column qualified by page group appears in any report file that is built by retrieval of more than one record:

opt dbkey!
get all sequential department ! display

When OPTIONS=NODBKEY is in effect, no column for database key values is displayed:

opt nodbkey! get all sequential department DEPARTMENT PAGE 1.1 LINE 1 DEPT-ID-0410 DEPT-NAME-0410 6666 EXECUTIVE ADMINISTRATION 2000 ACCOUNTING AND PAYROLL 1010 EXECUTIVE WEATHER MANAGEMENT 1011 WEATHER MANAGEMENT REPORTING 1000 PERSONNEL 3124 WEATHER REPORTING DIV. 3100 INTERNAL SOFTWARE 3125 ORDERING DEPARTMENT (3) 5300 BLUE SKIES 3200 COMPUTER OPERATIONS 3121 WEATHER INFORMATION SERVICES 4000 PUBLIC RELATIONS 5100 BRAINSTORMING

Options = Full

When OPTIONS=FULL is in effect, all information associated with the record type is displayed:

options=full ! select dept-id-0410, emp-last-name-0415 from department, employee where dept-employee ! display DEPARTMENT/EMPLOYEE REPORT 09/21/99 DEPT-ID-0410 EMP-LAST-NAME-0415 6666 HENDON 6666 PAPAZEUS 6666 RUPEE 6666 WILDER 2000 BLOOMER 2000 HUTTON 2000 JENSON 2000 KIMBALL 2000 KING 2000 NICEMAN 1000 FITZHUGH 1000 HEDGEHOG 1000 JOHNSON 1000 ORGRATZI - 1 -

When OPTIONS=SPARSE is in effect, repeating column values are displayed only once:

opt=sparse ! select dept-id-0410, emp-last-name-0415 from department, employee where dept-employee ! display DEPARTMENT/EMPLOYEE REPORT 09/21/99 DEPT-ID-0410 EMP-LAST-NAME-0415 6666 HENDON PAPAZEUS RUPEE WILDER 2000 BLOOMER HUTTON JENSON KIMBALL KING NICEMAN 1000 FITZHUGH HEDGEHOG JOHNSON ORGRATZI - 1 -

Options = Header

Output for OPTIONS=HEADER is shown below:

opt=header ! select dept-id-0410, emp-last-name-0415 from department, employee where dept-employee ! display DEPARTMENT/EMPLOYEE REPORT 09/21/99 DEPT-ID-0410 EMP-LAST-NAME-0415 6666 HENDON PAPAZEUS RUPEE WILDER 2000 BLOOMER HUTTON JENSON KIMBALL KING NICEMAN 1000 FITZHUGH HEDGEHOG JOHNSON ORGRATZI - 1 -

Output for OPTIONS=NOHEADER is shown below:

opt=noheader ! select dept-id-0410, emp-last-name-0415 from department, employee where dept-employee ! display 6666 HENDON PAPAZEUS RUPEE WILDER 2000 BLOOMER HUTTON JENSON KIMBALL KING NICEMAN 1000 FITZHUGH HEDGEHOG JOHNSON ORGRATZI PEOPLES 3100 DOUGH GALLWAY GARFIELD - 1 -

Options = Interrupt

In the following example, the OPTIONS=INTERRUPT is in effect and the retrieval limit before interruption is 25 records. After selecting 25 records, CA OLQ interrupts with a CONTINUE prompt. A YES or RESUME response directs CA OLQ to continue retrieving data until either the interrupt limit is reached again or processing is completed:

options= interrupt !
  set interrupt=25


  OLQ 092010 00  The interrupt count has been modified.
select dept-id-0410, emp-last-name-0415 from department, employee
 where dept-employee

  OLQ 098006 00  17 whole lines and 0 partial lines in report.
  OLQ 098007 00  25 records read.   21 records selected.
  OLQ 098008 00  17 of 47 primary record pages read.
  OLQ 098009 00  Continue (yes/no)?

When OPTIONS=NOINTERRUPT is in effect, CA OLQ retrieves all records without further interruption:

options=nointerrupt !
select dept-id-0410, emp-id-0415, emp-zip-0415
 from department, employee where dept-employee

  OLQ 098006 00  57 whole lines and 0 partial lines in report.
  OLQ 098007 00  75 records read.   66 records selected.

display cols 1,2,3 DEPARTMENT/EMPLOYEE REPORT 10/08/99 DEPT-ID-0410 EMP-ID-0415 EMP-ZIP-FIRST-FIVE-0415 6666 30 02198 6666 471 03256 6666 1 02312 6666 472 03145 2000 69 01675 2000 100 02176 2000 11 02176 2000 67 01239 2000 106 02176 2000 101 02176 1000 81 03458 1000 8683 10996 1000 51 02546 1000 91 06182 - 1 -

Options = No Olqheader

When OPTIONS=NOOLQHEADER is in effect, field names appear as report headers:

DEPARTMENT/EMPLOYEE REPORT 09/21/99 DEPT-ID-0410 EMP-LAST-NAME-0415 6666 HENDON 6666 PAPAZEUS 6666 RUPEE 6666 WILDER 2000 BLOOMER 2000 HUTTON 2000 JENSON 2000 KIMBALL 2000 KING 2000 NICEMAN 1000 FITZHUGH 1000 HEDGEHOG 1000 JOHNSON 1000 ORGRATZI - 1 -

When OPTIONS=OLQHEADER is in effect, predefined CA OLQ headers are used:

DEPARTMENT/EMPLOYEE REPORT 09/21/99 DEPT NUMBER EMPLOYEE NAME 6666 HENDON 6666 PAPAZEUS 6666 RUPEE 6666 WILDER 2000 BLOOMER 2000 HUTTON 2000 JENSON 2000 KIMBALL 2000 KING 2000 NICEMAN 1000 FITZHUGH 1000 HEDGEHOG 1000 JOHNSON 1000 ORGRATZI - 1 -

Options = Picture

When OPTIONS=NOPICTURE is in effect, default pictures are used to format report fields:

DEPARTMENT/EMPLOYEE REPORT 09/21/99 DEPT-ID-0410 EMP-LAST-NAME-0415 6666 HENDON 6666 PAPAZEUS 6666 RUPEE 6666 WILDER 2000 BLOOMER 2000 HUTTON 2000 JENSON 2000 KIMBALL 2000 KING 2000 NICEMAN 1000 FITZHUGH 1000 HEDGEHOG 1000 JOHNSON 1000 ORGRATZI - 1 -

When OPTIONS=PICTURE is in effect, external pictures are used to format report fields. In the following example, a dynamic external picture is specified with the EDIT command:

edit dept-id-0410 picture='9-999' display DEPARTMENT/EMPLOYEE REPORT mm/dd/yy DEPT-ID-0410 EMP-LAST-NAME-0415 6-666 HENDON 6-666 PAPAZEUS 6-666 RUPEE 6-666 WILDER 2-000 BLOOMER 2-000 HUTTON 2-000 JENSON 2-000 KIMBALL 2-000 KING 2-000 NICEMAN 1-000 FITZHUGH 1-000 HEDGEHOG 1-000 JOHNSON 1-000 ORGRATZI - 1 -

For more information:

Global Syntax

PAGE HEADER / FOOTER

PAGE HEADER/FOOTER enables you to locate a user-specified report page header or footer where you want it on the page or the terminal screen.

Note: The page headers should not contain the column heading.

Syntax:

►►─── PAGe ─┬─ HEAder ─┬──────────────────────────────────────────────────────►
            └─ FOOter ─┘

 ►─┬───────────────────────────────────────┬──────────────────────────────────►
   └─ SKIp blank ─┬─ BEFore ─┬─────┬─ n ─┬─┘
                  │          └─ = ─┘     │
                  └─ AFTer ─┬─────┬─ n ──┘
                            └─ = ─┘

 ►─┬───────────────────────────────────────────────────────────────┬──────────►◄
   │ ┌───────────────────────────────────────────────────────────┐ │
   └─▼- LINe n ─┬─────┬─ header-string ─┬──────────────────────┬─┴─┘
                └─ = ─┘                 └─ ALIGn ─┬─ RIGht ──┬─┘
                                                  ├─ LEFt ───┤
                                                  └─ CENter ─┘

Parameters:

PAGE HEADER

Specifies that you want to include a user-specified page header in the report.

PAGE FOOTER

Specifies that you want to include a user-specified page footer in the report.

SKIP

Specifies that a user-specified number of lines are to be skipped between the header/footer and the report.

BEFORE= n

Specifies that n lines are skipped before the report page header/footer is inserted. N must be greater than zero and less than 10.

AFTER= n

Specifies that n lines are skipped after the report page header/footer is inserted. N must be greater than zero and less than 10.

LINE n= header-string

Specifies the line number and the contents of the header/footer. For example, the following command specifies that the first line of the report page header reads 'DEPARTMENT REPORT' and the second line of the report page header reads the date the report was built:

line 1 = 'DEPARTMENT REPORT'
line 2 = '$DATE'
ALIGN RIGHT/LEFT/CENTER

Specifies that the report page header/footer line is aligned on the right, left, or centered on the page.

Example:

This example demonstrates the commands necessary to include both a user-specified report page header and footer in a report:

page header skip before 1 skip after 2 line 1 ='fiscal report' line 2 ='$date' ! page footer skip before 2 skip after 1 line 1 ='page $page' line 2 ='CA, Inc. ! display FISCAL REPORT 09/22/99 EMP-ID-0415 EMP-LAST-NAME-0415 SALARY-AMOUNT-0420 9999 LINGER 38500.00 48 TERNER 13000.00 23 LINGER 42500.00 23 LINGER 38000.00 149 PENMAN 39000.00 15 LINGER 85000.00 15 LINGER 75000.00 35 LITERATA 37500.00 349 WILCO 80000.00 PAGE 1 CA, Inc.