Previous Topic: OLQ Statement SyntaxNext Topic: OLQ Statement Usage


OLQ Statement Parameters

ACCess is

Specifies whether CA OLQ or CA IDMS will process SQL statements used to access a CA IDMS database.

IDMssql

Indicates CA IDMS will process the SQL statements.

IDMssql, IDMs sql, and IDMS-SQL are synonyms and used interchangeably.

OLQsql

Indicates CA OLQ will process the SQL statements.

OLQ SQL is the default.

OLQsql, OLQ sql, and OLQ-SQL are synonyms and used interchangeably.

BATch CLAss is batch-class

For z/OS systems only, specifies the print class used by CA OLQ when submitting batch jobs.

Batch-class must be an integer from 0–64.

The default value of 0 indicates that online submission of OLQ batch jobs is not allowed. Assign a print class from 1–64 if you want to allow online submission. Verify that the print class is assigned to a printer associated with a SYSOUTL line.

For more information on submitting JCL via the internal reader, see the section "Writing JCL to a JES2 Internal Reader" in the Navigational DML Programming Guide

COMment character is 'comment-character'

Specifies the character that flags a remark. All text following the comment character is ignored during execution.

Comment-character must be a one-character alphanumeric value enclosed in site-standard quotation marks. The default is the semicolon (;).

CONtinuation character is 'continuation-character'

Specifies the continuation character to use in q-files or batch input when the length of a CA OLQ command is greater than one line. The continuation character is specified at the end of each line that is to be continued.

Continuation-character must be a one-character alphanumeric value enclosed in site-standard quotation marks. The default is the hyphen (-).

INPut line size is input-line-size

For 3270 terminals only, specifies the number of lines on the screen that are available for input.

Input-line-size must be an integer in the range 1 through 256. The default is 2. The maximum number of lines defined by input-line-size is limited to the total number of lines on the screen minus the number of lines reserved for output.

INTernal storage page size is internal-storage-page-size

Specifies the size, in bytes, of the CA OLQ internal storage pages used to store control data across a pseudo-converse. These pages are written to the data dictionary scratch area (DDLDCSCR) and are returned to main memory when the CA OLQ task thread resumes execution.

Internal-storage-page-size must be an integer in the range 1 through 32,767. The default is 1,920.

INTERRupt count is interrupt-count

Specifies the number of records CA OLQ will read before issuing the following message at runtime:

CONTINUE YES/NO?
   nnn RECORDS READ nnn RECORDS SELECTED
   nnn DATA ERRORS

Interrupt-count must be an integer in the range 1 through 9,999. The default is 100.

MAXimum INTERRupt count is max-interrupt-count

Indicates the maximum interrupt count that a user can specify at runtime.

Max-interrupt-count must be an integer in the range 0 through 32,767. The default is 32,767. A value of 0 indicates the user-specified interrupt count is unlimited.

Typically, the maximum interrupt count is greater than or equal to the value specified by the INTERRUPT COUNT parameter (described above).

MAXimum report COUnt is max-report-count

Specifies the maximum number of reports that are saved in the queue area for each user.

Max-report-count must be an integer in the range 0 through 32,767. The default is 5.

MAXimum report PAGes is max-report-size

Specifies the maximum length, in pages, of a CA OLQ report written to the queue area.

Max-report-size must be an integer in the range 0 through 32,767. The default is 5.

When a CA OLQ report exceeds the MAXIMUM REPORT PAGES specification, the system ends the retrieval process and stops writing report pages. The report exists in the queue area and is available for viewing, but is incomplete. If a user attempts to sort the data or to display the last page of the report, the system returns a message indicating that an unexpected end of report was encountered.

MAXimum report RETention is

Defines the maximum length of time a user can specify when saving a CA OLQ report in the queue area. When the user issues a SAVE command and specifies a report retention period, the system automatically uses the maximum report retention period. If the specified retention period is greater than the maximum retention period, it is overridden and replaced by the maximum retention period. Reports that exceed their retention period in the queue area are deleted automatically at system startup.

max-report-retention-period

Specifies the maximum report retention period in days.

Maximum-report-retention-period must be an integer in the range 0 through 255. The default is 5. A value of 255 is synonymous with FOREVER.

FOREVER

Directs the system not to delete reports based on a retention period.

MAXimum SORt storage is max-sort-storage-size

Specifies the maximum amount of storage, in K bytes, that CA OLQ can use for sort operations.

Max-sort-storage-size must be an integer in the range 0 through 32,767. The default is 100.

Important! Specifying too low a value will prevent CA OLQ from performing sort operations.

MENu mode

Specifies whether the menu facility is available to users at runtime.

ONLy

Specifies that CA OLQ users must use the menu facility.

ALLowed

Specifies that CA OLQ users can use the menu facility.

ALLOWED is the default when you omit the MENU MODE parameter from the CA OLQ statement.

DISallowed

Specifies that CA OLQ users cannot use the menu facility.

olq transaction identifier is task-code

Specifies the task code that invokes the CA OLQ runtime system.

Task-code must be a task code previously defined in the data dictionary with a TASK statement. The default is CA OLQ.

This parameter is required to create an executable system.

PFKey MODule is qfile-name

Identifies the q-file that is executed each time a user invokes CA OLQ.

Qfile-name must be the name of a q-file defined in the data dictionary.

PRInt LINe size is print-line-size

Specifies the line length, in characters, for CA OLQ reports output on TTY-type terminals.

Print-line-size must be an integer in the range 20 through 255. The default is 80.

PRInt PAGe size is print-page-size

Specifies the page length, in lines, for CA OLQ reports output on TTY-type terminals.

Print-page-size must be an integer in the range 5 through 127. The default is 60.

REPort DICtname is dictionary-name

Identifies the data dictionary in which catalog information about CA OLQ saved reports is stored.

Dictionary-name must be the name of a data dictionary in the database name table defined for the system.

REPort FILe page size is report-file-page-size

Specifies the size, in bytes, of CA OLQ report file pages written to the queue area.

Report-file-page-size must be an integer in the range 256 through 32,767. The default is 4,000 bytes.

The specified page size must be:

REPort RETention is

Specifies the length of time the system is to retain a CA OLQ report in the queue area. The system automatically uses the REPORT RETENTION value when a user issues a SAVE command without specifying a report retention period. Reports that exceed their retention period in the queue area are deleted automatically at system startup.

report-retention-period

Specifies the report retention period in days.

Report-retention-period must be an integer in the range 0 through 255. The default is 1. A value of 255 is synonymous with FOREVER.

FORever

Directs the system not to delete reports based on a retention period.

SEParator character is 'separator-character'

Specifies the command separation character used to concatenate CA OLQ commands.

Separator-character must be a one-character alphanumeric value enclosed in site-standard quotation marks. The default is the exclamation point (!).