SET Parameter Syntax

This topic alphabetically lists the SET parameters that control the environment with a description and the syntax.

A

B

C

D

ACCBLN

ACROSSLINE

ACROSSPRT

AGGR[RATIO]

ALL

ALLOWCVTERR

ASNAMES

AUTOINDEX

AUTOPATH

AUTOSTRATEGY

AUTOTABLEF

BASEURL

BINS

BLANKINDENT

BLKCALC

BOTTOMMARGIN

BUSDAYS

BYDISPLAY

BYPANEL

BYSCROLL

CACHE

CARTESIAN

CDN

CENT-ZERO

CNOTATION

COLUMNSCROLL

COMPMISS

COMPOUND

COMPUTE

COUNTWIDTH

CSSURL

CURRSYMB

DATEDISPLAY

DATEFNS

DATEFORMAT

DATETIME

DBACSENSITIV

DEFCENT

DEFECHO

DEFINES

DIRECTHOLD

DISPLAY

DMPRECISION

DROPBLNKLINE

DTSTRICT

DUPLICATECOL

E

F

G

H

EMPTYREPORT

ERROROUT

ESTRECORDS

EUROFILE

EXL2KLANG

EXTAGGR

EXTHOLD

EXTRACT

EXTSORT

EXTTERM

FIELDNAME

FILE[NAME]

FILTER

FIXRET[RIEVE]

FOC144

FOC2GIGDB

FOCALLOC

FOCFIRSTPAGE

FOCSTACK

FORMULTIPLE

 

HIPERCACHE

HIPEREXTENTS

HIPERFILE

HIPERFOCUS

HIPERINSTALL

HIPERLOCKED

HIPERSPACE

HLISUTRACE

HLISUDUMP

HNODATA

HOLDATTR[S]

HOLDFORMAT

HOLDLIST

HOLDMISS

HOLDSTAT

HOTMENU

HTMLARCHIVE

HTMLCSS

I

J

K

L

IBMLE

IMMEDTYPE

INDEX

JOINOPT

KEEPDEFINES

KEEPFILTERS

LANG[UAGE]

LAYOUTGRID

LEADZERO

LEFTMARGIN

LINES

M

N

O

P

MASTER

MAXLRECL

MAXDATAEXCPT

MDICARDWARN

MDIENCODING

MDIPROGRESS

MESSAGE

MINIO

MODCOMPUTE

MULTIPATH

NODATA

NULL

OLDSTYRECLEN

ONLINE-FMT

ORIENTATION

PAGE[-NUM]

PAGESIZE

PANEL

PAPER

PASS

PAUSE

PCOMMA

PDFLINETERM

PFnn

POOL

PREFIX

PERMPASS

PRINT

PRINTPLUS

PSPAGESETUP

Q

R

S

T

QUALCHAR

QUALTITLES

REBUILDMSG

RECAP-COUNT

RIGHTMARGIN

SAVEDMASTERS

SAVEMATRIX

SBORDER

SCREEN

SHADOW

SHIFT

SHOWBLANKS

SORTLIB

SPACES

SQLTOPTTF

SQUEEZE

STYLEMODE

STYLE[SHEET]

SUMMARYLINES

SUMPREFIX

SUSI

SUTABSIZE

SUWEDGE

TARGETFRAME

TEMP[DISK]

TERM[INAL]

TESTDATE

TITLES

TOPMARGIN

TRACKIO

TRANTERM

TRMOUT

U

V

W

X- Z

UNITS

USER

USERFCHK

USERFNS

 

WEBTAB

WEBVIEWHOME

WEBVIEWTARG

WEBARCHIVE

WEEKFIRST

WIDTH

WPMINWIDTH

XFOCUS

XFOCUSBINS

XRETRIEVAL

YRTHRESH

ZIIP



x
ACCBLN

The ACCBLN parameter accepts blank or zero values for fields with ACCEPT commands in the Master File (see the Describing Data manual).

The syntax is:

SET ACCBLN = {ON|OFF}

where:

ON

Accepts blank and zero values for fields with ACCEPT commands unless blank or zero values are explicitly coded in the list of acceptable values. ON is the default value.

OFF

Does not accept blank and zero values for fields with ACCEPT commands unless blank or zero values are explicitly coded in the list of acceptable values.


Top of page

x
ACROSSLINE

The ACROSSLINE parameter controls underlining of horizontal sort field values on report output.

The syntax is:

SET ACROSSLINE = {ON|OFF|SKIP}

where:

ON

Underlines ACROSS objects in report headings with a dashed line. ON is the default value.

OFF

Replaces the underline with a blank line.

SKIP

Specifies no underline and no blank line.


Top of page

x
ACROSSPRT

The ACROSSPRT parameter reduces the number of report lines within each in a request that uses the PRINT command and an ACROSS phrase.

The PRINT command generates a report that has a single line for each record retrieved from the data source after screening out those that fail IF or WHERE tests. When PRINT is used in conjunction with an ACROSS phrase, many of the generated columns may be empty. Those columns display the missing data symbol.

To avoid printing such a sparse report, you can use the SET ACROSSPRT command to compress the lines in the report. The number of lines is reduced within each sort group by swapping non-missing values from lower lines with missing values from higher lines, and then eliminating any lines whose columns all have missing values.

Because data may be moved to different report lines, row-based calculations such as ROW-TOTAL and ACROSS-TOTAL in a compressed report are different from those in a non-compressed report. Column calculations are not affected by compressing the report lines.

The syntax is:

SET ACROSSPRT = {NORMAL|COMPRESS}

where:

NORMAL

Does not compress report lines.

COMPRESS

Compresses report lines by promoting data values up within a sort group.


Top of page

x
AGGR[RATIO]

The AGGR[RATIO] parameter determines the ratio of aggregation based on retrieved records and the final size of the answer set.

The syntax is:

SET AGGR[RATIO] = {n|1}

where:

n

Is the ratio of aggregation. 1 is the default value.


Top of page

x
ALL

The ALL parameter handles missing segment instances in a report.

The syntax is:

SET ALL = {ON|OFF|PASS}

where:

ON

Includes missing segment instances in a report when fields in the segment are not screened by WHERE or IF criteria in the request. The missing field values are denoted by the NODATA character, set with the NODATA parameter (see NODATA).

OFF

Omits missing segment instances from a report. OFF is the default value.

PASS

Includes missing segment instances in a report, regardless of WHERE or IF criteria in the request. This option is not supported when MULTIPATH = COMPOUND (see MULTIPATH).


Top of page

x
ALLOWCVTERR

The ALLOWCVTERR parameter applies to non-FOCUS data sources when converting from the way the date is stored (ACTUAL attribute) to the way it is formatted (FORMAT or USAGE attribute).

It controls the display of a row of data that contains an invalid date format (formerly called a smart date). When it is set to ON, the invalid date format is returned as the base date or a blank, depending on the settings for the MISSING and DATEDISPLAY parameters.

The syntax is:

SET ALLOWCVTERR = {ON|OFF}

where:

ON

Displays a row of data that contains an invalid date format. When ALLOWCVTERR is set to ON, the display of invalid dates is determined by the settings of the MISSING attribute and DATEDISPLAY command.

The results are explained in the following table:

DATEDISPLAY

MISSING

RESULT

OFF
OFF

A blank is returned.

ON

The value of the NODATA character (a period, by default) is returned. (See NODATA).

ON
OFF

The base date is returned (December 31, 1900, for dates with YMD or YYMD format; or January 1901, for dates with YM, YYM, YQ, or YYQ format).

ON

The value of the NODATA character (a period, by default) is returned.

OFF

Does not display a row of data that contains an invalid date format and generates an error message. OFF is the default value.



x
ASNAMES

The ASNAMES parameter controls the FIELDNAME attribute in a HOLD Master File. When an AS phrase is used in a TABLE request, the specified literal is used as a field name in a HOLD file. It also controls how field names are specified for the values of an ACROSS field when a HOLD file is created.

The syntax is:

SET ASNAMES = {ON|OFF|FOCUS}

where:

ON

Uses the AS phrase for the field name, and controls the way ACROSS fields are named in HOLD files in any format.

OFF

Does not use the AS phrase for the field name, or affect the way ACROSS fields are named.

FOCUS

Uses the AS phrase for the field name, and controls the way ACROSS fields are named in HOLD files only in FOCUS format. FOCUS is the default value.


Top of page

x
AUTOINDEX

The AUTOINDEX parameter speeds data retrieval by automatically taking advantage of indexed fields or multi-dimensional indexes (MDI) in most cases where TABLE requests contain equality or range tests on those fields or dimensions. This applies only to FOCUS and XFOCUS data sources.

AUTOINDEX is never performed when the TABLE request contains an alternate file view, for example, TABLE FILE filename.fieldname. Indexed retrieval is not performed when the TABLE request contains BY HIGHEST or BY LOWEST phrases and AUTOINDEX is ON.

The syntax is:

SET AUTOINDEX = {ON|OFF}

where:

ON

Uses indexed retrieval when possible.

OFF

Uses indexed retrieval only when explicitly specified via an indexed view, for example, TABLE FILE filename.indexed-fieldname. OFF is the default value.


Top of page

x
AUTOPATH

The AUTOPATH parameter dynamically selects an optimal retrieval path for accessing a FOCUS data source by analyzing the data source structure and the fields referenced, and choosing the lowest possible segment as the entry point. Use AUTOPATH only if your field is not indexed.

The syntax is:

SET AUTOPATH = {ON|OFF}

where:

ON

Dynamically selects an optimal retrieval path. ON is the default value.

OFF

Uses sequential data retrieval. The end user controls the retrieval path through filename.segname.


Top of page

x
AUTOSTRATEGY

The AUTOSTRATEGY parameter determines when FOCUS stops the search for a key field specified in a WHERE or IF test. When set to ON, the search ends when the key field is found, optimizing retrieval speed. When set to OFF, the search continues to the end of the data source.

The syntax is:

SET AUTOSTRATEGY = {ON|OFF}

where:

ON

Stops the search when a match is found. ON is the default value.

OFF

Searches the entire data source.


Top of page

x
AUTOTABLEF

The AUTOTABLEF parameter avoids creating the internal matrix based on the features used in the query. Avoiding internal matrix creation reduces internal overhead costs and yields better performance.

The syntax is:

SET AUTOTABLEF = {ON|OFF}

where:

ON

Does not create an internal matrix. ON is the default value.

OFF

Creates an internal matrix.


Top of page

x
BASEURL

The BASEURL parameter specifies a default location where your browser searches for relative URLs referenced in the HTML documents created by FOCUS. This allows you to hyperlink to files, images, and Java files using only the file names rather than the full URLs.

The syntax is:

SET BASEURL = url

where:

url

Is the fully qualified directory in which additional HTML files, graphics files, and Java applet class files reside. If the URL represents a Web server address, it must begin with http:// and end with a slash (/).


Top of page

x
BINS

The BINS parameter specifies the number of pages of memory (blocks of 4,096 bytes) used for data source buffers.

The syntax is:

SET BINS = n

where:

n

Is the number of pages used for data source buffers. Valid values are 13 to 64. 64 is the default value. This is the recommended value.


Top of page

x
BLANKINDENT

To clarify relationships within an FML hierarchy, the captions (titles) of values are indented at each level. You can use the BLANKINDENT parameter in an HTML, PDF, or PostScript report to specify the indentation between each level the hierarchy. You can use the default indentation for each hierarchy level or choose your own indentation value. To print indented captions in an HTML report, you must set the BLANKINDENT parameter to ON or to a number.

In PDF and PS reports, you may need to adjust the widths of columns to accommodate the indentations.

The syntax is:

SET BLANKINDENT = {ON|OFF|n}

where:

ON

Indents FML hierarchy captions 0.125 units for each space normally displayed before the caption. For child levels in an FML hierarchy, it indents 0.125 units for each space that would normally display between this line and the line above it.

OFF

Turns off indentations for FML hierarchy captions in an HTML report. For other formats, uses the default indentation of two spaces. OFF is the default value.

n

Is an explicit measurement in the unit of measurement defined by the UNITS parameter. This measurement is multiplied by the number of spaces that would normally display before the caption. For child levels in an FML hierarchy, it indents n units for each space that would normally display between this line and the line above it. The default number of spaces is two. Zero (0) produces the same report output as OFF. Negative values for n are not supported. They generate the following message, and the request processes as if BLANKINDENT=OFF:

VALID VALUES ARE OFF, ON OR A POSITIVE NUMBER (IN CURRENT UNITS)

Top of page

x
BLKCALC

The BLKCALC parameter applies only to z/OS.

It enables system-determined blocking for HOLD files written to DASD; files written to tape have BLKSIZE 32760, the operating-system maximum.

The SET BLKCALC command must be issued before the TABLE request and cannot be set within a request.

The syntax is:

SET BLKCALC = {NEW|OLD}

where:

NEW

Calculates optimal blocking factors for both 3380 and 3390 device types. NEW is the default value.

OLD

Uses the method of calculating BLKSIZE that was used prior to FOCUS Release 6.8.


Top of page

x
BOTTOMMARGIN

The BOTTOMMARGIN parameter sets the StyleSheet bottom boundary for report contents on a page.

This parameter applies only to PostScript and PS report formats.

The syntax is:

SET BOTTOMMARGIN = {n|.25}

where:

n

Is the bottom margin, in inches, for report contents on a page. 0.25 inches is the default value.


Top of page

x
BUSDAYS

The BUSDAYS parameter specifies which days are considered business days and which days are not if, your business does not follow the traditional Monday through Friday week.

The syntax is:

SET BUSDAYS = {week|_MTWTF_}

where:

week

Is SMTWTFS, representing the days of the week. Any day that you do not want to designate as a business day must be replaced with an underscore in the designated place for that day.

If a letter is not in its correct position, or if you replace a letter with a character other than an underscore, you receive an error message. _MTWTF_ is the default value.


Top of page

x
BYDISPLAY

Within a vertical sort group, the sort field value displays only on the first line of the rows for its sort group. However, you can display the appropriate BY field on every row in a styled report using the SET BYDISPLAY command. Although SET BYDISPLAY is supported for all styled output formats, it is especially important for making report output more usable by Excel, which cannot sort columns properly when they have blank values in some rows.

This feature may enable you to avoid specifying the sort field twice, once as a display field and once for sorting (with the NOPRINT option).

The syntax is:

SET BYDISPLAY = {ON|OFF}

where:

OFF

Displays a BY field value only on the first line of the report output for the sort group. OFF is the default value.

ON

Displays the associated BY field value on every line of report output produced in a styled format.


Top of page

x
BYPANEL

The BYPANEL parameter applies only to HOTSCREEN.

It controls the repetition of BY fields on panels. When BYPANEL is specified, the maximum number of panels is 99. When BYPANEL is OFF, the maximum number of panels is four.

The syntax is:

SET BYPANEL = option

where:

option

Is one of the following:

ON repeats the sort field values on each report panel.

OFF does not repeat sort field values on each report panel. Fields are displayed only on the first panel, and columns may split between panels. This value is the default.

0 does not repeat sort field values on each report panel, and columns do not split between panels.

n repeats n columns of sort fields on each report panel. The value for n can be equal to or less than the total number of sort fields specified in the request.


Top of page

x
BYSCROLL

The BYSCROLL parameter applies only to HOTSCREEN.

It scrolls report headings and footers scroll along with the report contents.

The syntax is:

SET {BYSCROLL|BYPANELSCROL} = {ON|OFF}

where:

ON

Scrolls report headings and footings along with report contents.

OFF

Does not scroll report headings and footings along with report contents. OFF is the default value.


Top of page

x
CACHE

The CACHE parameter controls the number of cache pages to be allocated. This command cannot be used with ON TABLE SET.

Stores 4K FOCUS data source pages in memory and buffers them between the data source and BINS.

When a procedure calls for a read of a data source page, FOCUS first searches BINS, then cache memory, and then the data source on disk. If the page is found in cache, FOCUS does not have to perform an I/O to disk.

When a procedure calls for a write of a data source page, the page is written from BINS to disk. The updated page is also copied into cache memory so that the cache and disk versions remain the same. Unlike reads, cache memory does not save disk I/Os for write procedures.

FOCSORT pages are also written to cache. When the cache becomes full, they are written to disk. For optimal results, set cache to hold the entire data source plus the size of FOCSORT for the request. To estimate the size of FOCSORT for a given request, issue the ? STAT command, then add the number of SORTPAGES listed to the number of data source pages in memory. Issue a SET CACHE command for that amount. If cache is set to 50, 50 4K pages of contiguous storage are allocated to cache. The maximum number of cache pages can be set at installation.

To clear the CACHE setting, issue a SET CACHE = n command. This command flushes the buffer (everything in cache memory is lost).

The syntax is:

SET CACHE = {0|n}

where:

0

Allocates no space to cache, which is inactive. 0 is the default value.

n

Is the number of 4K pages of contiguous storage allocated to cache memory. The minimum is two pages. The maximum is determined by the amount of memory available. If HiperFOCUS is activated, the default cache size is 256 pages (1MB) and the cache is placed in a hiperspace.


Top of page

x
CARTESIAN

The CARTESIAN parameter applies to requests containing PRINT or LIST.

It generates a report containing all combinations of non-related data instances in a multi-path request. ACROSS cancels this parameter.

The syntax is:

SET CARTESIAN = {ON|OFF}

where:

ON

Generates a report with non-related records.

OFF

Disables the Cartesian product. OFF is the default value.


Top of page

x
CDN

The CDN parameter specifies punctuation used in numerical notation.

Continental Decimal Notation (CDN) is supported for output in TABLE requests. It is not supported in DEFINE or COMPUTE commands.

The syntax is:

SET CDN = option

where:

option

Is one of the following:

ON uses CDN. ON sets the decimal separator as a comma and the thousands separator as a period. For example, the number 3,045,000.76 is represented as 3.045.000,76. ON should be used for Germany, Denmark, Italy, Spain, and Brazil.

OFF turns CDN off. For example, the number 3,045,000.76 is represented as 3,045,000.76. OFF is the default value. OFF should be used for the USA, Canada, Mexico, and the United Kingdom.

SPACE sets the decimal point as a comma, and the thousands separator as a space. For example, the number 3,045,000.76 is represented as 3 045 000,76. SPACE should be used for France, Norway, Sweden, and Finland.

QUOTE sets the decimal point as a comma and the thousands separator as an apostrophe. For example, the number 3,045,000.76 is represented as 3'045'000,76. QUOTE should be used for Switzerland.

QUOTEP sets the decimal point as a period and the thousands separator as an apostrophe. For example, the number 3,045,000.76 is represented as 3'045'000.76.

Note: If the display format of a report is Excel 2000 or later, Continental Decimal Notation is controlled by the settings on the computer. That is, numbers in report output are formatted according to the convention of the locale (location) set in regional or browser language options.


Top of page

x
CENT-ZERO

The CENT-ZERO parameter displays a leading zero in decimal-only numbers. The setting of CDN determines whether a decimal point or comma is the decimal separator.

The syntax is:

SET CENT-ZERO = {ON|OFF}

where:

ON

Displays fractions with a leading zero. The fraction is preceded by either a decimal point or comma, depending on the CDN setting.

OFF

Does not display a leading zero. The fraction is preceded by either a decimal point or comma, depending on the CDN setting. OFF is the default value.


Top of page

x
CNOTATION

Column notation assigns a sequential column number to each column in the internal matrix created for a report request. You can use column notation in COMPUTE and RECAP commands to refer to these columns in your request.

Because column numbers refer to columns in the internal matrix, they are assigned after retrieval and aggregation are completed. Columns not actually displayed on the report output may exist in the internal matrix. For example, calculated values used in the request generate one or more columns in the internal matrix. Fields with the NOPRINT option take up a column in the internal matrix, and a reformatted field generates an additional column for the reformatted value. Certain RECAP calculations such as FORECAST or REGRESS generate multiple columns in the internal matrix.

BY fields are not assigned column numbers but, by default, every other column in the internal matrix is assigned a column number, which means that you have to account for all of the internally generated columns if you want to refer to the appropriate column value in your request. You can change this default column assignment behavior with the SET CNOTATION=PRINTONLY command, which assigns column numbers only to columns that display on the report output, or the SET CNOTATION=EXPLICIT command, which assigns column numbers to columns that are referenced in the request.

The syntax is:

SET CNOTATION={ALL|PRINTONLY|EXPLICIT}

where:

ALL

Assigns column reference numbers to every column in the internal matrix. ALL is the default value.

PRINTONLY

Assigns column reference numbers only to columns that display on the report output.

EXPLICIT

Assigns column reference numbers to all fields referenced in the request, whether it is displayed or not.

Note: This setting is not supported in an ON TABLE phrase.


Top of page

x
COLUMNSCROLL

The COLUMNSCROLL parameter enables you to scroll by column within the panels of a report provided that the report is wider than the screen width.

The syntax is:

SET COLUMNSCROLL = {ON|OFF}

where:

ON

Enables column scrolling to the right and left by pressing the PF10 key and the PF11 key, respectively. To scroll up and down within the same column, use the PF7 key and the PF8 keys.

OFF

Disables column scrolling. OFF is the default value.


Top of page

x
COMPMISS

When a field is reformatted in a request (for example, SUM field/format), an internal COMPUTE field is created to contain the reformatted field value and displayed on the report output. If the original field has a missing value, that missing value can be propagated to the internal field by setting the COMPMISS parameter ON. If the missing value is not propagated to the internal field, it displays a zero (if it is numeric) or a blank (if it is alphanumeric). If the missing value is propagated to the internal field, it displays the missing data symbol on the report output.

The syntax is:

SET COMPMISS = {ON|OFF}

where:

ON

Propagates a missing value to a reformatted field.

OFF

Displays a blank or zero for a reformatted field. OFF is the default value.


Top of page

x
COMPOUND

The COMPOUND parameter, which is used to create compound reports, combines multiple reports into a single PDF or PostScript (PS) file. Using COMPOUND enables you to concatenate reports with styled report formats (PDF, HTML, Power Point, Excel). You can also embed image files, including graphs saved as images, in a compound report.

For more information about creating compound reports, see the Creating Reports manual.

For a compound report that may contain different report types, the syntax is:

SET COMPOUND = {OPEN|CLOSE} [NOBREAK]

or

ON TABLE SET COMPOUND {OPEN|CLOSE}

Note that when you are using this syntax, you must also include the following code to identify the display format of each of the different reports to be concatenated:

ON TABLE {PCHOLD|HOLD|SAVE} [AS name] FORMAT formatname

If all of the reports in the compound set are of the same type, either PDF or PS, the syntax is:

ON TABLE {PCHOLD|HOLD|SAVE} [AS name] FORMAT {PDF|PS} {OPEN|CLOSE} [NOBREAK]

where:

name

Is the name of the generated file. The name is taken from the first request in the compound report. If no name is specified in the first report, the name HOLD is used.

formatname

Is the name of the styled report format. Valid formats include PDF, PS, HTML, PPT, and EXL2K.

OPEN

Is specified with the first report, and begins the concatenation process. A report that contains the OPEN attribute must be in PDF or PS format.

CLOSE

Is specified with the last report, and ends the concatenation process.

NOBREAK

Is an optional phrase that suppresses page breaks. By default, each report is displayed on a separate page. You can use NOBREAK selectively in a request to control which reports are displayed on the same page.

Note:


Top of page

x
COMPUTE

The COMPUTE parameter controls the compilation of calculations when a request is executed.

When set to NEW, calculations in a DEFINE or MODIFY COMPUTE command are compiled into machine code at request time. This code is used to perform calculations at run time.

The syntax is:

SET COMPUTE = {NATV|NEW|OLD}

where:

NATV

Compiles calculations that are referenced at run time using native arithmetic. NATV is the default value.

NEW

Compiles COMPUTE calculations when a request is parsed.

OLD

Does not compile calculations when a request is executed.


Top of page

x
COUNTWIDTH

The COUNTWIDTH parameter expands the default format of COUNT fields from a five-byte integer to a nine-byte integer.

The syntax is:

SET {COUNTWIDTH|LISTWIDTH} = {ON|OFF}

where:

ON

Expands the default format of COUNT fields from a five-byte integer to a nine-byte integer.

OFF

Does not expand the default format of COUNT fields from a five-byte integer to a nine-byte integer. OFF is the default value.


Top of page

x
CSSURL

The CSSURL parameter links an HTML report to an external Cascading Style Sheet (CSS) file in order to style the report.

The syntax is:

SET CSSURL = link

where:

link

Is the URL location of the CSS file. This can be an absolute or relative link.


Top of page

x
CURRSYMB

The CURRSYMB parameter specifies a symbol used to represent currency when a numeric format specification uses the M or N display options. The default currency symbol depends on the code page being used.

The syntax is:

SET CURRSYMB = symbol

where:

symbol

Is any printable character or a supported currency code.

Note: In order to specify a dollar sign as the character, you must enclose it in single quotation marks ('$'). The following are supported currency codes:

USD or '$' specifies U. S. dollars.

GBP specifies the British pound.

JPY specifies the Japanese yen.

EUR specifies the Euro.

NIS specifies the Israeli new sheqel.


Top of page

x
DATEDISPLAY

The DATEDISPLAY parameter controls the display of a base date. Previously, TABLE always displayed a blank when a date read from a file matched the base date or a field with a smart date format had the value 0. The following shows the base date for each supported date format:

Format

Base Date

YMD and YYMD

1900/12/31

YM and YYM

1901/01

YQ and YYQ

1901/Q1

JUL and YYJUL

00/365 and 1900/365

 

Note: You cannot set DATEDISPLAY with the ON TABLE command.

The syntax is:

SET DATEDISPLAY = {ON|OFF}

where:

ON

Displays the base date if the data is the base date value.

OFF

Displays a blank if the date is the base date value. OFF is the default value.



x
DATEFNS

The DATEFNS parameter activates year 2000-compliant versions of date functions.

The syntax is:

SET DATEFNS = {ON|OFF}

where:

ON

Loads the year 2000-compliant versions of functions supplied by Information Builders.

OFF

Deactivates the date functions that support year-2000 dates.


Top of page

x
DATEFORMAT

The DATEFORMAT parameter specifies the order of the date components (month/day/year) when date-time values are entered in the formatted string and translated string formats. It makes a value's input format independent of the format of the variable to which it is being assigned.

The syntax is:

SET DATEFORMAT = datefmt

where:

datefmt

Can be one of the following: MDY, DMY, YMD, or MYD. MDY is the default value for the U.S. English format.


Top of page

x
DATETIME

The DATETIME parameter sets time and date in reports. This command is useful for determining (statically or dynamically) exactly when your report was run. You can display the DATETIME value using any FOCUS date variable (for example, YMD, MDY, TOD). If DATETIME is not set, the behavior of the FOCUS date variables remain the same.

The syntax is:

SET DATETIME = option

where:

option

Is one of the following:

STARTUP is the time and date when you began your session. STARTUP is the default value.

CURRENT|NOW changes each time it is interrogated. For example, if your batch job starts before midnight at 11:59 P.M., it will not complete until the next day. If DATETIME is set to NOW|CURRENT, any reference to the variable gives the current date, not the date when the job started.

RESET freezes the date and time of the current run for the rest of the session or until another SET DATETIME command is issued.


Top of page

x
DBACSENSITIV

When a DBA or user issues the SET USER, SET PERMPASS or SET PASS command, this user ID is validated before they are given access to any data source whose Master File has DBA attributes. The password is also checked when encrypting or decrypting a FOCEXEC.

The SET DBACSENSITIV command determines whether the password is converted to uppercase prior to validation.

The syntax is:

SET DBACSENSITIV = {ON|OFF}

where:

ON

Does not convert passwords to uppercase. All comparisons between the password set by the user and the password in the Master File or FOCEXEC are case sensitive.

OFF

Converts passwords to uppercase prior to validation. All comparisons between the password set by the user and the password in the Master File or FOCEXEC are not case sensitive. OFF is the default value.


Top of page

x
DEFCENT

The DEFCENT parameter defines a default century globally or on a field-level for an application that does not contain an explicit century. DEFCENT is used in conjunction with YRTHRESH to interpret the current century according to the given values. When assigned globally, the time span created by these parameters applies to every 2-digit year used by the application unless you specify file-level or field-level values. (See YRTHRESH.)

Note: This same result can be achieved by including the FDEFCENT and FYRTHRESH attributes in the Master File.

The syntax is:

SET DEFCENT = {cc|19}

where:

cc

Is the default century. 19 is the default value if one is not supplied. The value cc defaults to 19, for the twentieth century.


Top of page

x
DEFECHO

The DEFECHO parameter defines a default value for the &ECHO variable.

The syntax is:

SET DEFECHO = {OFF|ON|ALL}

where:

OFF

Establishes OFF as the default value for &ECHO. OFF is the default value.

ON

Establishes ON as the default value for &ECHO.

ALL

Establishes ALL as the default value for &ECHO.


Top of page

x
DEFINES

The DEFINES parameter increases the speed of calculations in virtual fields by compiling virtual fields into machine code.

The syntax is:

SET DEFINES = {COMPILED|OLD}

where:

COMPILED

Implements expression compilation at request run time, compiling only those DEFINEs that are used in the request.

OLD

Leaves expression compilation up to the control of the current value of the SET COMPUTE parameter. OLD is the default value.

The SET DEFINES command is not supported in an ON TABLE phrase.


Top of page

x
DIRECTHOLD

The DIRECTHOLD parameter controls whether a HOLD file in FOCUS format is created directly or whether the HOLD file is loaded using an internally generated MODIFY procedure and an intermediate sequential file called FOC$HOLD.

The syntax is:

SET DIRECTHOLD = {ON|OFF}

where:

ON

Creates a FOCUS HOLD file directly without an intermediate sequential file and MODIFY procedure. ON is the default value.

OFF

Loads a FOCUS HOLD file using an internally generated MODIFY procedure and an intermediate sequential file called FOC$HOLD.


Top of page

x
DISPLAY

The DISPLAY parameter is the PC display mode selection.

The syntax is:

SET DISPLAY = {OFF|PCCOLOR|PCMONO}

where:

option

Is one of the following:

OFF indicates no display mode is selected. OFF is the default value.

PCCOLOR indicates the display mode is color.

PCMONO indicates the display mode is black and white.


Top of page

x
DMPRECISION

The DMPRECISION parameter specifies numeric precision in Dialogue Manager -SET commands.

Without this setting, results of numeric calculations are returned as integer numbers, although the calculations themselves employ double-precision arithmetic. To return a number with decimal precision without this setting, you have to enter the calculation as input into subroutine FTOA, where you can specify the number of decimal places returned.

The syntax is:

SET DMPRECISION = {OFF|n}

where:

OFF

Specifies truncation without rounding after the decimal point. OFF is the default value.

n

Is a positive number from 0-9, indicating the point of rounding. Note that n=0 results in a rounded integer value.


Top of page

x
DROPBLNKLINE

The DROPBLNKLINE parameter suppresses blank lines around subtotals, subheadings, and subfootings when formatting a report for output. In addition, certain data lines may be blank and appear as blank lines on the report output. You can eliminate these blank lines from the report output using the SET DROPBLNKLINE=ON command.

This setting does not apply to the following output formats: HOLD/PCHOLD/SAVE formats ALPHA, INTERNAL, BINARY, COM, COMT, COMMA, TAB, TABT, FIX, DFIX, all DBMS, VSAM, LOTUS, SYLK, DIF, FOCUS, and XFOCUS.

The syntax is:

SET DROPBLNKLINE = {OFF|ON}

where:

OFF

Leaves blank lines in data and blank lines automatically inserted by FOCUS in the report output. OFF is the default value.

ON

Removes blank lines of data and blank lines automatically inserted by FOCUS from the report output.


Top of page

x
DTSTRICT

The DTSTRICT parameter controls the use of strict processing. Strict processing checks date-time values when they are input by an end user, read from a transaction file, displayed, or returned by a subroutine to ensure that they represent a valid date and time. For example, a numeric month must be between 1 and 12, and the day must be within the number of days for the specified month.

The syntax is:

SET DTSTRICT = {ON|OFF}

where:

ON

Invokes strict processing. ON is the default value.

OFF

Does not invoke strict processing. Date-time components can have any value within the constraint of the number of decimal digits allowed in the field. For example, if the field is a two-digit month, the value can be 12 or 99, but not 115.


Top of page

x
DUPLICATECOL

The DUPLICATECOL parameter reformats report requests that use multiple display commands, placing aggregated fields in the same column above the displayed field.

The syntax is:

SET DUPLICATECOL = {ON|OFF}

where:

ON

Displays the report with each field as a column. ON is the default value.

OFF

Displays the report with common fields as a row.


Top of page

x
EMPTYREPORT

The EMPTYREPORT parameter controls the output generated when a TABLE request retrieves zero records.

EMPTYREPORT is not supported with TABLEF or Excel. When a TABLEF or Excel request retrieves zero records, an empty report is generated.

Note: Using the IF TOTAL or WHERE TOTAL phrases when EMPTYREPORT is set to OFF may produce an empty report if there is no data that satisfies the TOTAL condition. This occurs because the test for report lines for EMPTYREPORT is applied before the TOTAL condition is applied.

The syntax is:

SET EMPTYREPORT={ANSI|ON|OFF} 

where:

ANSI

Produces a single-line report and displays the missing data character or a zero if a COUNT is requested. In each case, &RECORDS will be 0, and &LINES will be 1.

If the SQL Translator is invoked, ANSI automatically replaces OFF as the default setting for EMPTYREPORT.

ON

Produces an empty report (column headings with no content). This was the default behavior in prior releases.

OFF

Produces no report output. OFF is the default value except for SQL Translator requests. When the SQL Translator is invoked, ANSI replaces OFF as the default setting for the EMPTYREPORT parameter, so the results are the same as for the ANSI setting.

The command can also be issued from within a request using:

ON TABLE SET EMPTYREPORT ANSI

Top of page

x
ERROROUT

The ERROROUT parameter controls how a batch FOCUS job step responds to an error condition encountered in a procedure. This parameter cannot be set with the ON TABLE SET command.

When ERROROUT is set to ON, any error message generated terminates the job step and issues a return code of 8. Warning messages do not invoke this behavior. When ERROROUT is set to OFF, depending on the specific message, FOCUS determines whether FOCEXEC processing continues. Users can check a Dialogue Manager variable such as &FOCERRNUM and issue the following command to terminate FOCUS and set n as the return code:

-QUIT FOCUS n

On z/VM, if you include the QUEUE 'FIN' command in your batch FOCUS EXEC, and if FOCUS terminates as a result of the ERROROUT setting, the queued FIN command causes CMS to issue a return code of -3, which overwrites the ERROROUT return code. If you want to see the return code issued by Exit on Error, you can remove the QUEUE 'FIN' command from the EXEC and include the following command immediately after the 'EXEC FOCUS' command to exit and issue the return code:

exit rc

Note: The ERROROUT setting is ignored in an interactive session.

The syntax is:

SET ERROROUT = {ON|OFF}

where:

ON

When an error message is generated in a batch FOCUS job step, ON sets the return code to 8 and terminates the job step.

In addition, the following message displays to inform the user why the program terminated:

Exiting due to Exit on Error
OFF

Does not set a return code or automatically terminate a job step or procedure in response to any error message. OFF is the default value.


Top of page

x
ESTRECORDS

The ESTRECORDS parameter passes the estimated number of records to be sorted in the request. FOCUS queries using external sorts and including the parameter 'FILSZ=En' can diminish FOC909 errors. This parameter enables the sorting algorithms to estimate SORTWORK space requirements for each sort parameter request.

In order to make an accurate estimate for your ESTRECORDS setting, it is suggested that you run the report without an external sort in order to get a record count. If an attempt is made to SET ESTRECORDS from the FOCUS prompt, FOCPARM, or PROFILE FOCEXEC the following error is generated:

SET ESTRECORDS = n
(FOC36210) THE SPECIFIED PARAMETER CAN ONLY BE SET ON TABLE: 
ESTRECORDS

For CMS/SyncSort the 'FILSZ=En' parameter is ignored. Therefore, SET ESTRECORDS n has no effect.

The syntax is:

SET ESTRECORDS = n

where:

n

Is the estimated number of records to be sorted.


Top of page

x
EUROFILE

The EUROFILE parameter activates the data source that contains information for the currency you want to convert. This setting can be changed during a session to access a different currency data source. This parameter cannot be issued in a report request.

Note: You cannot set any additional parameters on the same line as EUROFILE. FOCUS ignores any other parameters specified on the same line.

The syntax is:

SET EUROFILE = {ddname|OFF}

where:

ddname

Is the name of the Master File for the currency data source you want to use. The ddname must refer to a read-only data source accessible by FOCUS. There is no default value.

OFF

Deactivates the current currency data source and removes it from memory.


Top of page

x
EXL2KLANG

When included in the NLSCFG ERRORS file on z/VM or the member NLSCFG in the ERRORS PDS on z/OS, the EXL2KLANG parameter specifies the language used for Microsoft® Excel requests. This language must be the same as the language of Excel on the browser machine in order to correctly display output.

You can code the SET EXL2KLANG command in a profile or procedure to override the setting in the errors file.

The syntax is:

EXL2KLANG = {language|ENG}

where:

language

Is the Excel language. Valid values are:

ENG for English. ENG is the default value.

FRE for French.

GER for German.

JPN for Japanese.

KOR for Korean.

SPA for Spanish.


Top of page

x
EXTAGGR

The EXTAGGR parameter uses external sorts to perform aggregation.

The syntax is:

SET EXTAGGR = {ON|OFF|NOFLOAT}

where:

ON

Allows aggregation by an external sort. ON is the default.

OFF

Does not allow aggregation by an external sort.

NOFLOAT

Allows aggregation if there are no floating data fields present.


Top of page

x
EXTHOLD

The EXTHOLD parameter enables you to create a HOLD file using an external sort.

The syntax is:

SET EXTHOLD = {ON|OFF}

where:

ON

Creates HOLD files using an external sort. ON is the default value.

OFF

Does not create HOLD files using an external sort.


Top of page

x
EXTRACT

The EXTRACT parameter activates Structured HOLD Files for a request.

This parameter is only supported in a TABLE or TABLEF request using an ON TABLE phrase.

The syntax is:

ON TABLE SET EXTRACT = {ON|*|OFF}

where:

ON

Activates Structured HOLD Files for this request and extracts all fields mentioned in the request.

*

Activates Structured HOLD Files for this request and indicates that a block of extract options follows. For example, you can exclude specific fields from the Structured HOLD File.

OFF

Deactivates Structured HOLD files for this request. OFF is the default value.


Top of page

x
EXTSORT

The EXTSORT parameter activates an external sorting feature for use with the TABLE, MATCH, and GRAPH commands.

If the report can be processed entirely in memory, external sorting does not occur.

In order to determine if the report can be processed in memory, issue the ? STAT query after the TABLE, MATCH, or GRAPH command, and check the value of the SORT USED parameter.

When StyleSheets are being used, an external sort does not work.

The syntax is:

SET EXTSORT = {ON|OFF}

where:

ON

Enables the selective use of an external sorting product to sort report. ON is the default value.

OFF

Uses the internal sorting procedure to sort reports.


Top of page

x
EXTTERM

The EXTTERM parameter enables the use of extended terminal attributes.

The syntax is:

SET EXTTERM = {ON|OFF}

where:

ON

Enables the use of attributes. ON is the default value.

OFF

Disables the use of attributes.


Top of page

x
FIELDNAME

The FIELDNAME parameter controls whether long and qualified field names are supported.

This command cannot be used with ON TABLE SET.

The syntax is:

SET FIELDNAME = {NEW|NOTRUNC|OLD}

where:

NEW

Supports long and qualified field names. NEW is the default value.

NOTRUNC

Supports long and qualified field names, but not unique truncations.

OLD

Limits field names to 12 characters. Qualified field names are not supported.


Top of page

x
FILE[NAME]

The FILE[NAME] parameter specifies a file to be used, by default, in commands. When you set a default file name, you can use that file without specifying its name.

The syntax is:

SET FILE[NAME] = filename

where:

filename

Is a default file to be used in commands.


Top of page

x
FILTER

The FILTER parameter assigns screening conditions to a data source for reporting purposes. It activates and deactivates filters.

The SET FILTER command is limited to one line. To activate more filters to fit on one line repeat the SET FILTER command.

The syntax is:

SET FILTER= {*|xx[yy zz]} IN file {ON|OFF}

where:

*

Activates all declared filters. * is the default value.

xx, yy, zz

Are the names of filters as declared in the NAME = syntax of the FILTER FILE command.

file

Is the name of the data source you are assigning screening conditions to.

ON

Activates all (*) or specifically named filters for the data source. The maximum number of filters you can activate for a data source is limited by the number of WHERE/IF phrases the filters contain, not to exceed the limit of WHERE/IF criteria in any single report request.

OFF

Deactivates (*) or specifically named filters for the data source. OFF is the default value.


Top of page

x
FIXRET[RIEVE]

FOCUS HOLD files support keyed retrieval from a fixed format sequential file, which can greatly reduce the I/Os incurred in reading extract files. The performance gains are accomplished by using the SEGTYPE= parameter in the Master File to specify that the BY fields in the request be used as a logical key for sequential files. The FIXRETRIEVE parameter allows you to stop the retrieval process when an equality test on this field holds true. This changes former behavior, as the interface previously read all of the records from the QSAM file and then passed them to FOCUS to apply the screening conditions when creating the final report.

The syntax is:

SET FIXRET[RIVE] = {ON|OFF}

where:

ON

Enables keyed retrieval. ON is the default value.

OFF

Disables keyed retrieval.


Top of page

x
FOC144

The FOC144 parameter suppresses warning message FOC144, which reads:

 "Warning: Testing in Independent sets of Data."

The syntax is:

SET FOC144 = {NEW|OLD}

where:

NEW

Displays the FOC144 warning message. NEW is the default value.

OLD

Suppresses the FOC144 warning message.


Top of page

x
FOC2GIGDB

The FOC2GIGDB parameter enables two-gigabyte FOCUS data sources. It must be set in the FOCPARM profile. However, if the data source is in a FOCUS Database Server, FOC2GIGDB must be set in HLIPROF.

The syntax is:

SET FOC2GIGDB = {ON|OFF}

where:

ON

Enables support for FOCUS data sources larger than one-gigabyte. Note that an attempt to use FOCUS data sources larger than one-gigabyte in a release prior to FOCUS Version 7.1 can cause database corruption.

OFF

Disables support for FOCUS data sources larger than one-gigabyte. OFF is the default value.


Top of page

x
FOCALLOC

The FOCALLOC parameter applies only to z/OS.

It automatically allocates FOCUS files. Allocation is done based on prefix.master. FOCUS. The DISP is SHR.

The syntax is:

SET {FOCALLOC|FALLOC} = {ON|OFF}

where:

ON

Automatically allocates FOCUS files.

OFF

Does not automatically allocate FOCUS files. OFF is the default value.


Top of page

x
FOCFIRSTPAGE

The FOCFIRSTPAGE parameter assigns a page number to the first page of output.

The syntax is:

SET FOCFIRSTPAGE = {n|1|&FOCNEXTPAGE}

where:

n

Is the number to be assigned to the first page of output. Valid values are integers with one to six characters. 1 is the default value.

&FOCNEXTPAGE

Is a variable whose value is determined by the last page number used by the last report. Its value is one more than the last page number used in the last report.


Top of page

x
FOCSTACK

This setting is no longer needed, but has been left in the product so that existing applications that included it continue to work. The FOCSTACK parameter specified the amount of memory, in thousands of bytes, used by FOCSTACK, the stack of FOCUS commands awaiting execution.

This command cannot be used with ON TABLE SET.

The syntax is:

SET FOCSTACK [SIZE] = {n|8}

where:

n

Is the maximum amount, in thousands of bytes, that can be used by FOCSTACK. The maximum value depends on your region size.

8

Allows 8000 bytes to be used by FOCSTACK. 8 is the default value.


Top of page

x
FORMULTIPLE

You can use the same value of a FOR field in many separate rows whether alone, as part of a range, or in a calculation by including the following syntax before or within an FML request:

The syntax is:

SET FORMULTIPLE = {ON|OFF} 

where:

ON

Enables you to reference the same value of a FOR field in more than one row in an FML request.

With FORMULTIPLE set to ON, a value retrieved from the data source is included on every line in the report output for which it matches the tag references.

OFF

Does not enable you to include the same value in multiple rows. OFF is the default value.

With FORMULTIPLE set to OFF, multiple tags referenced in any of these ways (OR, TO, *) are evaluated first for an exact reference or for the end points of a range, then for a mask, and finally within a range. For example, if a value is specified as an exact reference and then as part of a range, the exact reference is displayed. Note that the result is unpredictable if a value fits into more than one row whose tags have the same priority (for example, an exact reference and the end point of a range.)


Top of page

x
HDAY

The HDAY parameter specifies the holiday file from which to retrieve dates that are designated as holidays for use with the date functions DATEDIF, DATEMOV, DATECVT, and DATEADD. The file must be named HDAY, followed by two to four characters.

To clear the holiday file, use

SET HDAY = OFF

The syntax is:

SET HDAY = xxxx

where:

xxxx

Are the letters in the name of the holiday file, named HDAYxxxx. This string must be between two and four characters long.

The default is no setting for this parameter.


Top of page

x
HIPERCACHE

The HIPERCACHE parameter determines the default CACHE size in 4K pages when HiperFOCUS is activated. Can only be set in the FOCPARM ERRORS profile.

The syntax is:

SET HIPERCACHE = {cache|256}

where:

cache

Is the default CACHE size in 4k pages when HiperFOCUS is activated. 256 (1M) is the default value.


Top of page

x
HIPEREXTENTS

The HIPEREXTENTS parameter determines the permissible number of extents for HiperFOCUS (on z/OS). Can only be set in the FOCPARM ERRORS profile.

The syntax is:

SET HIPEREXTENTS = {number|127}

where:

number

Is the permissible number of extents. 127 is the default value.


Top of page

x
HIPERFILE

The HIPERFILE parameter is the maximum number of (4K) pages in an individual hiperspace. This is equivalent to the IBI Subsystem FILELIM parameter. If both are set, the lower is enforced. Can only be set in the FOCPARM ERRORS profile.

The syntax is:

SET HIPERFILE = {pages|524287}

where:

pages

Is the number of pages in an individual hiperspace. 524287 (2GB) the default value.


Top of page

x
HIPERFOCUS

The HIPERFOCUS parameter activates HiperFOCUS. If HiperFOCUS is not installed, this parameter is disabled.

The syntax is:

SET HIPERFOCUS = {ON|OFF}

where:

ON

Activates HiperFOCUS. ON is the default value.

OFF

Deactivates HiperFOCUS.


Top of page

x
HIPERINSTALL

The HIPERINSTALL parameter installs or disables HiperFOCUS. Can only be set in the FOCPARM ERRORS profile.

The syntax is:

SET HIPERINSTSALL = {ON|OFF}

where:

ON

Installs HiperFOCUS.

OFF

Disables HiperFOCUS. OFF is the default value.


Top of page

x
HIPERLOCKED

The HIPERLOCKED parameter enables or disables processing of user interface commands such as SET HIPERFOCUS. Can only be set in the FOCPARM ERRORS profile.

The syntax is:

SET HIPERLOCKED = {ON|OFF}

where:

ON

Disables processing of user interface commands.

OFF

Enables processing of user interface commands. OFF is the default value.


Top of page

x
HIPERSPACE

The HIPERSPACE parameter is the number of (4K) pages to aggregate for hiperspace. This is equivalent to the IBI Subsystem TCBLIM parameter. If both are set, the lower is enforced. Can only be set in the FOCPARM ERRORS profile.

The syntax is:

SET HIPERSPACE = {pages|524287}

where:

pages

Is the number of pages to aggregate for hiperspace. 524287 (2GB) is the default value.


Top of page

x
HLISUTRACE

Used for debugging, the HLISUTRACE parameter records the last 20 events that the FOCUS Database Server (formerly called the sink machine) performed. The information is written to memory and is intended for use when reading a dump of the SU address space. This setting may only be set in the SU profile, HLIPROF.

The syntax is:

SET HLISUTRACE = {ON|OFF}

where:

ON

Records the last 20 events that the FOCUS Database Server performed. ON is the default value.

OFF

Does not record the last 20 events that the FOCUS Database Server performed.


Top of page

x
HLISUDUMP

The HLISUDUMP parameter is only used for debugging FOCUS Database Server problems and may only be set in the SU profile, HLIPROF.

The syntax is:

SET HLISUDUMP = n

where:

n

When set to 99999, a dump of the FOCUS Database Server address space occurs for any error on the server. The user abend code is set to 275. The user code is also set to the error number.


Top of page

x
HNODATA

The HNODATA parameter controls the missing data characters that are propagated to fields with the MISSING=ON attribute in HOLD FORMAT ALPHA files. Missing values in fields that do not have the MISSING=ON attribute are propagated to a HOLD file as blank (for alphanumeric fields) or zero (for numeric fields).

The syntax is:

SET HNODATA = {charstring|,$}

where:

charstring

Is a string of up to 12 characters propagated to a HOLD FORMAT ALPHA file for missing values in a field with the MISSING=ON attribute. A period (.) is the default value.

If the string is longer than the length of the field, the value stored in:

  • An alphanumeric field is the leftmost character of the string.
  • A numeric field is a blank string.

When an alphanumeric string other than the default value (the period) is used to populate a missing numeric field, a blank is inserted in the held field to prevent a format error when displaying the data. If you use the default HNODATA value, it is inserted in numeric fields. In this way, a request against the HOLD file can recognize missing data that was propagated to the HOLD file.

If a number with decimal places is specified for HNODATA and the field with missing data is integer, the value is rounded to a whole number and inserted. In a numeric field that supports decimal places, it is rounded and inserted with the correct number of decimal digits.

,$

Indicates that nothing should be placed in the field when there is missing data. This setting can be used to support null values in non-FOCUS data sources.


Top of page

x
HOLDATTR[S]

The HOLDATTR[S] parameter controls whether the TITLE and ACCEPT attributes from the original Master File are used in the HOLD Master File. This setting does not affect the way fields are named in the HOLD Master File.

The syntax is:

SET HOLDATTR = {ON|OFF|FOCUS}

where:

ON

Includes the TITLE attribute from the original Master File in HOLD Master Files for HOLD files of any format. The ACCEPT attribute is included in the HOLD Master File when the HOLD file is in FOCUS format.

OFF

Does not include the TITLE or ACCEPT attributes from the original Master File in the HOLD Master File.

FOCUS

Includes the TITLE and ACCEPT attributes in HOLD Master Files when the HOLD file is in FOCUS format. FOCUS is the default value.


Top of page

x
HOLDFORMAT

The HOLDFORMAT parameter determines the default format for HOLD files. This value can be overridden for an individual HOLD file by issuing the ON TABLE SET HOLD FORMAT command in a request.

The syntax is:

SET HOLDFORMAT = {BINARY|ALPHA}

where:

BINARY

Creates HOLD files in binary format. BINARY is the default value.

ALPHA

Creates HOLD files in ALPHA format.


Top of page

x
HOLDLIST

The HOLDLIST parameter controls whether only displayed fields or all fields are included in the HOLD or PCHOLD file.

The syntax is:

SET HOLDLIST = {PRINTONLY|ALL|ALLKEYS}

where:

PRINTONLY

Includes only those fields in the HOLD or PCHOLD file that are specified in the report request.

ALL

Includes all fields referenced in a request in the HOLD or PCHOLD file, including both computed fields and fields referenced in a COMPUTE command. ALL is the default value. (OLD may be used as a synonym for ALL.)

Note: Vertical sort (BY) fields specified in the request with the NOPRINT option are not included in the HOLD file, even with SET HOLDLIST=ALL.

ALLKEYS

Propagates all fields to the HOLD file, including NOPRINTed BY fields.


Top of page

x
HOLDMISS

The HOLDMISS parameter enables you to distinguish between missing data and default values of blank (for character data) or zero (for numeric data) in a HOLD file.

The syntax is:

SET HOLDMISS = {OFF|ON}

where:

OFF

Does not allow you to store missing data in a HOLD file. OFF is the default value.

ON

Enables you to store missing data in a HOLD file. When TABLE generates a default value for data not found, it generates missing values.


Top of page

x
HOLDSTAT

The HOLDSTAT parameter includes comments and DBA information in HOLD Master Files. This information can be from the HOLDSTAT ERRORS file supplied by Information Builders, or a file specified by the user.

The syntax is:

SET HOLDSTAT = {ON|OFF|name}

where:

ON

Derives comments and DBA information from a HOLDSTAT file. In z/OS, this information is derived from the member HOLDSTAT in the PDS allocated to the ddname MASTER or ERRORS. In CMS, it is derived from the file HOLDSTAT MASTER or HOLDSTAT ERRORS.

OFF

Does not include information from the HOLDSTAT file in the HOLD Master File. OFF is the default value.

name

Specifies a HOLDSTAT file, created by the end user, whose information is included in the HOLD Master File.


Top of page

x
HOTMENU

The HOTMENU parameter automatically displays the Hot Screen PF key legend at the bottom of the Hot Screen report.

The syntax is:

SET HOTMENU = {ON|OFF}

where:

ON

Displays the PF key legend.

OFF

Does not display the PF key legend. To see the PF key legend, the user must press PF1. OFF is the default value.


Top of page

x
HTMLARCHIVE

The HTMLARCHIVE parameter packages HTML or DHTML reports together with image files into a single web archive document (.mht file). The only browser that supports this format for HTML is Internet Explorer.

The syntax is:

SET HTMLARCHIVE = {ON|OFF}

where:

ON

Packages HTML or DHTML reports together with image files into a single web archive document (.mht file).

OFF

Does not package multiple files into a single document. OFF is the default value.


Top of page

x
HTMLCSS

The HTMLCSS parameter creates an internal Cascading Style Sheets command in the HTML display page.

The syntax is:

SET HTMLCSS = {ON|OFF}

where:

ON

Creates an internal CSS command in the HTML page that displays the report output.

OFF

Does not create an internal CSS command in the HTML page that displays the report output. OFF is the default value.


Top of page

x
IBMLE

This parameter is no longer functional. FOCUS is fully LE compliant, and all FOCUS applications must be LE compliant.


Top of page

x
IMMEDTYPE

Used with TOE, the IMMEDTYPE parameter tells FOCUS where to send line mode output.

The syntax is:

SET IMMEDTYPE = {ON|OFF}

where:

ON

Sends all line mode output, such as -TYPE, to the Output Window as it is executed, line by line.

OFF

Buffers all line mode output. The output appears in the Output Window as a new full screen. OFF is the default value.


Top of page

x
INDEX

The INDEX parameter determines the indexing scheme used for indexes. Indexes are fields specified with FIELDTYPE=I keywords in the Master Files. The OLD setting for INDEX is no longer supported, but has been left in the product so that applications that included it continue to work.

The syntax is:

SET INDEX[TYPE] = {NEW|OLD}

where:

NEW

Creates a binary tree index. NEW is the default value.

OLD

Creates a hash index.


Top of page

x
JOINOPT

If a parent segment has two or more unique child segments so that each has multiple children, the report may incorrectly display a missing value. The remainder of the child values may then be misaligned in the report. These misaligned values are called lagging values. The JOINOPT parameter ensures proper alignment of your output by correcting for lagging values.

The syntax is:

SET JOINOPT = {NEW|OLD}

where:

NEW

Corrects lagging values when a parent segment has multiple unique children.

OLD

Does not correct lagging values. This is the default value.


Top of page

x
KEEPDEFINES

The KEEPDEFINES parameter controls whether a virtual field created for a host or joined structure is retained after a JOIN command is run. This parameter applies when a DEFINE command precedes the JOIN command.

The syntax is:

SET KEEPDEFINES = {ON|OFF}

where:

ON

Retains the virtual field after a JOIN command is run.

OFF

Clears the virtual field after a JOIN command is run. OFF is the default value.


Top of page

x
KEEPFILTERS

By default, filters defined on the host data source are cleared by a JOIN command. However, filters can be maintained when a JOIN command is issued, by issuing the SET KEEPFILTERS=ON command.

Setting KEEPFILTERS to ON reinstates filter definitions and their individual declared status after a JOIN command. The set of filters and virtual fields defined prior to each join is called a context (see your documentation on SET KEEPDEFINES and on DEFINE FILE SAVE for information about contexts as they relate to virtual fields). Each new JOIN or DEFINE FILE command creates a new context.

If a new filter is defined after a JOIN command, it cannot have the same name as any previously defined filter unless you issue the FILTER FILE command with the CLEAR option. The CLEAR option clears all filter definitions for that data source in all contexts.

When a JOIN is cleared, each filter definition that was in effect prior to the JOIN command and that was not cleared, is reinstated with its original status. Clearing a join by issuing the JOIN CLEAR join_name command removes all of the contexts and filter definitions that were created after the JOIN join_name command was issued.

The syntax is:

SET KEEPFILTERS = {OFF|ON}

where:

OFF

Does not preserve filters issued prior to a join. This is the default value.

ON

Preserves filters across joins.


Top of page

x
LANG[UAGE]

The LANG[UAGE] parameter specifies the National Language Support (NLS) environment. It sets the language of error messages and can also be used to set the language of report titles if the Master File contains alternate language TITLE attributes. For more information, see the Describing Data manual.

The syntax is:

SET LANG[UAGE] = [LNG|ln] 

where:

LNG

Is the 3-letter abbreviation used to specify a language.

ln

Is the 2-letter ISO code used to specify a language.

The abbreviations and ISO codes used to specify a language are shown in the following table.

Language Name (Code)

Displayed Language (GUI)

Language Abbreviation

Language ISO code

AMENGLISH or
ENGLISH or
UKENGLISH
English
AME or
ENG or
UKE
en
ARABIC
Arabic
ARB
ar
BALTIC
Lithuanian
BAL
lt
CZECH
Czech
CZE
cs
DANISH
Danish
DAN
da
DUTCH
Dutch
DUT
nl
FINNISH
Finnish
FIN
fi
FRENCH
French - Standard
or Canadian
FRE
fr
fc
GERMAN
German - Standard
or Austrian
GER
de
at
GREEK
Greek
GRE
el
HEBREW
Hebrew
HEB or HEW
iw
ITALIAN
Italian
ITA
it
JAPANESE
Japanese-JIS or EUC
JPN or JPE
ja or je
KOREAN
Korean
KOR
ko
POLISH
Polish
POL
po
PORTUGUESE
Portuguese- Brazil or Portugal
POR
br
pt
RUSSIAN
Russian
RUS
ru
S-CHINESE
Chinese-
Simplified GB
PRC
zh
SPANISH
Spanish
SPA
es
SWEDISH
Swedish
SWE
sv
T-CHINESE
Chinese-
Traditional Big-5
ROC
tw
THAI
Thai
THA
th
TURKISH
Turkish
TUR
tr


x
LAYOUTGRID

Displays a grid in the report output, which enables you to evaluate the correct placement of data and objects during your report design. This option is applicable only when using the PDF, PS, or DHTML report output.

The syntax is:

SET LAYOUTGRID = {ON|OFF}

where:

ON

Displays a grid in the report output.

OFF

Turns off the grid in the report output. OFF is the default value.


Top of page

x
LEADZERO

Leading zeros are truncated in Dialogue Manager strings. The functions in FOCUS, when called in Dialogue Manager, may return a numeric result. If the format of the result is YMD and contains a 00 for the year, the 00 is truncated.

The syntax is:

SET LEADZERO = {ON|OFF}

where:

ON

Allows the display of leading zeros if present.

OFF

Truncates leading zeros if present. OFF is the default value.


Top of page

x
LEFTMARGIN

The LEFTMARGIN parameter sets the StyleSheet left boundary for report contents on a page. This parameter applies to PostScript and PDF reports.

The syntax is:

SET LEFTMARGIN = {value|.25}

where:

value

Is the left boundary of report contents on a page. 0.25 inches is the default value.


Top of page

x
LINES

The LINES parameter sets the maximum number of lines of printed output that appear on a page, from the heading to the footing. If this value is less than the value set for PAPER, the difference provides a bottom margin. FOCUS never puts more lines on a page than the LINES parameter specifies, but may put less. The value of LINES can range between 1 and 999999. Specify 999999 for continuous forms.

Note: When using SKIP-LINE in a report, always set LINES to at least one less than the value for PAPER. This avoids unintentional page beaks at the bottom of the page.

When the STYLESHEET parameter is in effect, the setting for LINES is ignored.

The syntax is:

SET LINES = {n|57}

where:

n

Is the maximum number of lines of printed output that appear on a page.


Top of page

x
MASTER

The MASTER parameter enables use of blank delimited (FUSION) Master File syntax, and provides increased enforcement of syntax rules in comma delimited Master File syntax.

The syntax is:

SET MASTER = {NEW|OLD}

where:

NEW

Enables use of blank delimited (FUSION) Master File syntax. NEW is the default value.

OLD

Accepts only comma-delimited Master File syntax.

Note: The OLD setting will be deprecated in a future release.


Top of page

x
MAXDATAEXCPT

Data exceptions occur when data that is supposed to contain a numeric value is manipulated in ways unsupported by the architecture of the operating environment. You can change the number of data exceptions allowed before the session is terminated using the SET MAXDATAEXCPT command.

Note: SET MAXDATAEXCPT is functional on mainframe platforms only. All other platforms allow the syntax, but do not support the functionality.

If this command is issued in a TABLE request using the ON TABLE SET phrase, a new count is established for that request. The running session count is saved and is restored after the request executes.

The syntax is:

SET MAXDATAEXCPT={10|maxexcpt}

where:

maxexcpt

Is a one to four-digit number that represents how many data exceptions can occur before the session is terminated. 10 is the default value. The value zero (0) allows an unlimited number of data exceptions. The value one (1) terminates the session at the first data exception.

If MAXDATAEXCPT is changed in a request, a new count is established and the session counter is saved and then restored after the request executes. If you issue the command outside of a TABLE request, the running counter is reset to zero.


Top of page

x
MAXLRECL

The MAXLRECL parameter defines the maximum record length for an external file that can be read. 0 is the default value. However, FOCUS can read a 12K recl by default. This may be set to a maximum of 64K. Note that the maximum length of the internal memory area for data fields is still 32K.

The syntax is:

SET MAXLRECL = {n|0}

where:

n

Is the maximum record length for an external file with OCCURS segments. 0 is the default value.


Top of page

x
MDICARDWARN

The MDICARDWARN parameter displays a warning message every time the cardinality in a dimension exceeds a specified value, offering you the chance to study the MDI build. When the number of equal values of the data in a dimension reaches a specified percent, a warning message is issued. In order for MDICARDWARN to be reliable, the data source should contain at least 100,000 records.

Note: In addition to the warning message, a number displays in brackets. This number is the least number of equal values for the dimension mentioned in the warning message text.

The syntax is:

SET = MDICARDWARN = n

where:

n

Is a percentage value from 0 to 50.


Top of page

x
MDIENCODING

The MDIENCODING parameter enables retrieval of output from the MDI file without reading the data source.

FOCUS encodes indexed values any time a field or dimension of an MDI has a MAXVALUES attribute specified or is involved in a parent-child relationship. Encoded values are stored in the MDI file at rebuild time and can be retrieved and decoded with a TABLE request that specifies the MDIENCODING command. The MDIENCODING command allows the user to get output from the MDI file itself without having to read the data source.

The following rules apply to fields in a TABLE request that uses MDIENCODING:

The syntax is:

SET MDIENCODING = {ON|OFF}

where:

ON

Enables retrieval of output from the MDI file without reading the data source.

OFF

Requires access of the data source to allow retrieval of MDI values.

Note: This command can only be issued in an ON TABLE phrase. It has no default value.


Top of page

x
MDIPROGRESS

The MDIPROGRESS parameter displays messages about the progress of an MDI build. The messages show the number of data records accumulated for every n records inserted into the MDI as it is processed.

The syntax is:

SET MDIPROGRESS = {n|0}

where:

n

Is an integer greater than 1000, which displays a progress message for every n records accumulated in the MDI build. 100,000 is the default value.

0

Disables progress messages.


Top of page

x
MESSAGE

The MESSAGE parameter displays or suppresses informational messages in the view source of your Web browser. This parameter cannot be used with ON TABLE SET.

The syntax is:

SET {MESSAGE|MSG} = {ON|OFF}

where:

ON

Displays informational messages. ON is the default value.

OFF

Suppresses both informational messages and carets that appear when FOCUS executes commands in procedures. Error messages and the carets that prompt for input are still displayed.


Top of page

x
MINIO

The MINIO parameter applies only to z/OS.

It improves performance by reducing I/O operations up to 50% when accessing FOCUS data sources under z/OS. This is a buffering technique.

With FOCUS data sources that are not disorganized, MINIO can greatly reduce the number of I/O operations for TABLE and MODIFY commands. The actual I/O reduction varies depending on data source structure and average number of children segments per parent segment. By reducing I/O operations, elapsed time for TABLE and MODIFY commands also drop.

The syntax is:

SET MINIO = {ON|OFF}

where:

ON

Does not read a block more than once. The number of reads performed is the same as the number of tracks present. This results in an overall reduction in elapsed times when reading and writing. ON is the default value.

OFF

Disables MINIO.


Top of page

x
MODCOMPUTE

The native compiler for MODIFY processes COMPUTE, IF, and VALIDATE expressions using the arithmetic operations built into the underlying operating system. This native compiler eliminates internal format conversions and speeds up expression processing. It significantly enhances the speed of expressions that use long packed fields and date fields.

The syntax is:

SET MODCOMPUTE={NATV|NEW|OLD}

where:

NATV

Activates the native compiler for MODIFY expressions. NATV is the default value.

NEW

Compiles MODIFY expressions using the standard FOCUS compilation routines, which use high-precision floating point format for all arithmetic operations.

OLD

Does not compile MODIFY expressions.


Top of page

x
MULTIPATH

The MULTIPATH parameter controls testing on independent paths.

The syntax is:

SET MULTIPATH = {SIMPLE|COMPOUND}

where:

SIMPLE

Includes a parent segment in the report output if:

  • It has at least one child that passes its screening conditions.
  • It lacks any referenced child on a path, but the child is optional (see the Creating Reports manual).

SIMPLE is the default value.

The (FOC144) warning message is generated when a request screens data in a multi-path report.

(FOC144) WARNING. TESTING IN INDEPENDENT SETS OF DATA:
COMPOUND

Includes a parent in the report output if it has all of its required children (see the Creating Reports manual). The COMPOUND setting does not generate the (FOC144) warning message.

The segment rule is applied level by level as FOCUS descends the data source/view hierarchy. The existence of a parent segment depends on the existence of the child segment and the child segment depends on the existence of the grandchild for the full data source tree.


Top of page

x
NODATA

The NODATA parameter determines the character string that indicates missing data in a report.

The syntax is:

SET {NODATA|NA} = {string|.}

where:

string

Is the character string that indicates missing data in reports. A period (.) is the default value.


Top of page

x
NULL

The NULL parameter enables you to create a variable-length comma or tab delimited HOLD file that differentiates between a missing value and a blank string or zero value.

The HOLD formats supported for SET NULL=ON are COM, COMT, TAB, and TABT. Missing values in a record are denoted by two consecutive delimiters. A record that starts with a missing value has a delimiter in the first position, and a record that ends with a missing value has a delimiter in the last position.

The syntax is:

SET NULL = {ON|OFF}

where:

ON

Propagates missing values to a delimited HOLD file when the field has MISSING=ON in the Master File.

OFF

Propagates the value zero for a missing numeric value and blank ("") for a missing alphanumeric value to a delimited HOLD file. OFF is the default value.


Top of page

x
OLDSTYRECLEN

The OLDSTYRECLEN parameter determines whether the record length, LRECL, is set to the current setting of LRECL=0, or the older setting of LRECL=512.

The syntax is:

SET OLDSTYRECLEN = {ON|OFF}

where:

ON

Determines that LRECL=512.

OFF

Determines that LRECL=0. OFF is the default value.


Top of page

x
ONLINE-FMT

The ONLINE-FMT parameter determines the format of report output. (Applies to WebFOCUS only.)

The syntax is:

SET ONLINE-FMT = option

where:

option

Is one of the following:

HTML specifies that the report displays as an HTML page.

PDF specifies that the report displays as a PDF document (Adobe Acrobat Portable Document Format).

Excel 2000 (EXL2K) specifies that the report displays as an Excel 2000 worksheet.

Excel 97 (EXL97) specifies that the report displays as an Excel 97worksheet.

STANDARD produces the report as un-styled character-based output. STANDARD is the default value.

POSTSCRIPT (PS) specifies that the report displays, according to the current StyleSheet, as a PostScript document. You must have installed a printer capable of displaying PS.


Top of page

x
ORIENTATION

The ORIENTATION parameter specifies the page orientation for reports styled with StyleSheets.

The syntax is:

SET ORIENTATION = {PORTRAIT|LANDSCAPE}

where:

PORTRAIT

Displays the page in portrait style. PORTRAIT is the default value.

LANDSCAPE

Displays the page in landscape style.


Top of page

x
PAGE[-NUM]

The PAGE[-NUM] parameter controls the numbering of output pages.

The syntax is:

SET PAGE[-NUM] = option

where:

option

Is one of the following:

ON displays the page number on the upper left-hand corner of the page. ON is the default value.

OFF suppresses page numbering.

NOPAGE suppresses page breaks, causing the report to be printed as a continuous page. When PAGE is set to NOPAGE, the LINES parameter controls where column headings are printed. You can use NOLEAD in place of NOPAGE.

TOP omits the line at the top of each page of the report output for the page number and the blank line that follows it. The first line of report output contains the heading, if one was specified, or the column titles if there is no heading.

Note: The settings ON, TOP, and OFF include the carriage control character 1 in the first column of each page.


Top of page

x
PAGESIZE

The PAGESIZE parameter specifies the page size for StyleSheets. For optimal report appearance, the actual paper size must match your setting for PAGESIZE. If it does not, your report is cropped or contains extra blank spaces.

The syntax is:

SET PAGESIZE = size

where:

size

Specifies the page size. If the actual paper size does not match the PAGESIZE setting, your report is either cropped or contains extra blank space.

The page size options are:

LETTER sets the page size to 8.5 x 11 inches.

ENVELOPE-PERSONAL sets the page size to 3.625 x 6.5 inches.
ENVELOPE-MONARCH sets the page size to 3.875 x 7.5 inches.
ENVELOPE-9 sets the page size to 3.875 x 8.875 inches.
ENVELOPE-10 sets the page size to 4.125 x 9.5 inches.
ENVELOPE-12 sets the page size to 4.5 x 11 inches.
ENVELOPE-DL sets the page size to 4.3 x 8.6 inches.
ENVELOPE-ITALY sets the page size to 4.3 x 9.1 inches.
ENVELOPE-B4 sets the page size to 9.8 x 13.9 inches.
ENVELOPE-B5 sets the page size to 6.9 x 9.8 inches.
ENVELOPE-B6 sets the page size to 6.9 x 4.9 inches.
ENVELOPE-C3 sets the page size to 12.75 x 18 inches.
ENVELOPE-C4 sets the page size to 9 x 12.75 inches.
ENVELOPE-C5 sets the page size to 6.4 x 9 inches.
ENVELOPE-C6 sets the page size to 4.5 x 6.375 inches.
ENVELOPE-C65 sets the page size to 4.5 x 9 inches.

STATEMENT sets the page size to 5.5 x 8.5 inches.

EXECUTIVE sets the page size to 7.5 x 10.5 inches.
GERMAN-STANDARD-FANFOLD sets the page size to 8.5 x 12 inches.
GERMAN-LEGAL-FANFOLD sets the page size to 8.5 x 13 inches.
FOLIO sets the page size to 8.5 x 13 inches.
LEGAL sets the page size to 8.5 x 14 inches.
10X14 sets the page size to 10 x 14 inches.
TABLOID sets the page size to 11 x 17 inches.

A3 sets the page size to 11.7 x 16.8 inches.

A4 sets the page size to 8.25 x 11.7 inches.
A5 sets the page size to 5.8 x 8.25 inches.
B4 sets the page size to 9.8 x 13.9 inches.
B5 sets the page size to 7.2 x 10.1 inches.
C sets the page size to 17 x 22 inches.
D sets the page size to 22 x 34 inches.
E sets the page size to 34 x 44 inches.
US-STANDARD-FANFOLD sets the page size to 14.875 x 11 inches.
LEDGER sets the page size to 17 x 11 inches.
QUARTO sets the page size to 8.5 x 10.8 inches.


Top of page

x
PANEL

The PANEL parameter sets the maximum line width, in characters, of a report panel for a screen or printer. If report output exceeds this value, the output is partitioned into several panels. For example, if you set PANEL to 80, the first 80 characters of a record appear on the first panel, the second 80 characters appear on the second panel, and so on.

When printing a report to your screen, the ideal value for the PANEL parameter is the width of your screen (usually 80). When printing to your printer, the ideal value for PANEL is the print width of your printer (usually 132). If PANEL is larger or set to 0, long report lines wrap around the screen or page.

When the BYPANEL parameter is OFF, a report can be divided into a maximum of 4 panels. If SET BYPANEL has a value other than OFF, the report may be divided into 99 panels.

When the STYLESHEET parameter is in effect, PANEL is ignored.

The syntax is:

SET PANEL = {0|n}

where:

n

Is the maximum line width, in characters, of a report panel.

0

Does not divide the report into panels. Long report lines wrap around the screen or page. 0 is the default value.


Top of page

x
PAPER

The PAPER parameter specifies the physical length of the paper, in lines, for printed output. You derive this value by multiplying the length of the paper, in inches, by the number of lines printed per inch. For example, if your printer prints six lines per inch on standard 11 inch forms, PAPER should be set to 66. If you are placing a footing at the bottom of the page, this value should be less; in this case, 62. Valid values for PAPER are numbers between 1 and 999999. Specify 999999 for continuous forms.

Note: When the STYLESHEET parameter is in effect, the setting for PAPER is ignored.

The syntax is:

SET PAPER = {n|66}

where:

n

Is the length of paper, in lines, for printed output. Valid values are numbers between 1 and 999999. The value 999999 denotes the use of continuous forms. 66 is the default value.


Top of page

x
PASS

The PASS parameter enables user access to a data source or stored procedure protected by Information Builders security.

This command cannot be used with ON TABLE SET.

The syntax is:

SET PASS = password [IN filename]

where:

password

Is the password that allows access to data sources protected by Information Builders database security.

filename

Is a specific FOCUS data source or stored procedure protected by security.


Top of page

x
PAUSE

The PAUSE parameter pauses before displaying a FOCUS report on the terminal. When you use a printing terminal, this parameter allows you to adjust the paper before printing the report.

When the SCREEN parameter is ON, the PAUSE parameter is set ON (until you set the PAUSE parameter to OFF). If you set the SCREEN parameter to OFF, the PAUSE parameter is set to OFF. Note that you can change the PAUSE parameter without affecting the SCREEN parameter.

This setting does not affect offline printing (routing output to a system printer).

The syntax is:

SET PAUSE = {ON|OFF}

where:

ON

Pauses before displaying a report. ON is the default value.

OFF

Does not pause before displaying a report.


Top of page

x
PCOMMA

The PCOMMA parameter enables the retrieval of comma-delimited files created by a PC application or the HOLD FORMAT COM command.

By default, when a Master File specifies SUFFIX=COM, incoming alphanumeric values are not enclosed in double quotation marks, and each record is terminated with a comma and dollar sign (,$) character combination. This format does not support retrieval of most comma-delimited files produced by a PC application.

The syntax is:

SET PCOMMA = {ON|OFF}

where:

ON

Enables the retrieval of comma-delimited data sources created by a PC application. It indicates that alphanumeric data is enclosed in double quotation marks and each record is completely contained on one line and is terminated with a carriage return and line feed.

OFF

Does not enable the retrieval of comma-delimited data sources created by a PC application. It indicates that alphanumeric data is not enclosed in double quotation marks and each record is terminated with a comma and dollar sign. OFF is the default value.


Top of page

x
PDFLINETERM

The PDFLINETERM parameter determines if an extra space is appended to each record of a PDF output file to facilitate proper file transfer between Windows and UNIX.

In Windows systems, the end of each PDF file has a table containing the byte offset, including two line termination characters, a carriage return, and a line feed. In UNIX, files are terminated by only one character, a line feed. Transferring files between Windows and UNIX systems requires the proper use of the PDFLINETERM parameter.

The syntax is:

SET PDFLINETERM = {STANDARD|SPACE}

where:

STANDARD

Creates a PDF file without any extra characters. This file will be a valid PDF file if transferred in text mode to a Windows machine, but not to a UNIX machine. If subsequently transferred from a UNIX machine to a Windows machine in text mode, it will be a valid PDF file on the Windows machine.

SPACE

Creates a PDF file with an extra space character appended to each record. This file will be a valid PDF file if transferred in text mode to a UNIX machine, but not to a Windows machine. If subsequently transferred from an ASCII UNIX machine to a Windows machine in binary mode, it will be a valid PDF file on the Windows machine.


Top of page

x
PERMPASS

The PERMPASS parameter establishes a user password that remains in effect throughout a session or connection. You can issue this setting in any supported profile but is most useful when established for an individual user by setting it in a user profile. It cannot be set in an ON TABLE phrase. It is recommended that it not be set in FOCPARM or FOCPROF because it would then apply to all users. In a FOCUS session, SET PERMPASS can be issued in PROFILE, a FOCEXEC, or at the command prompt.

All security rules established in the DBA sections of existing Master Files are respected when PERMPASS is in effect. The user cannot issue the SET PASS or SET USER command to change to a user password with different security rules. Any attempt to do so generates the following message:

permanent PASS is in effect. Your PASS will not be honored.
VALUE WAS NOT CHANGED

Only one permanent password can be established in a session. After it is set, it cannot be changed within the session.

The syntax is:

SET PERMPASS=userpass

where:

userpass

Is the user password used for all access to data sources with DBA security rules established in their associated Master Files.


Top of page

x
PFnn

The PFnn parameter assigns a function to the PF key specified by nn, enabling you to change the current PF key setting when using FIDEL (and also, under certain conditions, within the Window facility).

The current settings are displayed by the ? PFKEY command.

The syntax is:

SET PFnn = function

where:

nn

Is the PF key you are assigning a function to.

function

Is the function to assign to the PF key specified by PFnn.


Top of page

x
POOL

The POOL parameter pools retrieval for consecutive TABLE requests that access the same data source using the same access method.

This parameter cannot be used in ON TABLE SET.

The syntax is:

SET POOL = {ON|OFF}

where:

ON

Activates pooled tables. ON is the default value.

OFF

Deactivates pooled tables.


Top of page

x
PREFIX

The PREFIX parameter applies only to z/OS.

It specifies the prefix of existing data sets automatically allocated by FOCUS.

The syntax is:

SET PREFIX = prefix

where:

prefix

Specifies of the prefix of existing data sets automatically allocated by FOCUS. The default setting in TSO is your user ID. The default setting in batch is FOCUS.


Top of page

x
PRINT

The PRINT parameter specifies the report output destination.

It determines whether report output is sent to your screen or to the printer.

You can enter ONLINE and OFFLINE as separate commands that have the same effect as specifying ONLINE and OFFLINE as PRINT settings.

The syntax is:

SET PRINT = {ONLINE|OFFLINE}

where:

ONLINE

Sends report output to the terminal. ONLINE is the default value.

OFFLINE

Sends report output to the system printer.


Top of page

x
PRINTPLUS

The PRINTPLUS parameter introduces enhancements to the display alternatives offered by the FOCUS Report Writer. To force a break at a specific spot, you must use NOSPLIT.

PRINTPLUS is not supported with StyleSheets. Problems may be encountered if HOTSCREEN is set to OFFLINE.

The syntax is:

SET {PRINTPLUS|PRTPLUS} = {ON|OFF}

where:

ON

Handles the PAGE-BREAK internally to provide the correct spacing of pages, NOSPLIT is handled internally and you can perform RECAPs in cases where pre-specified conditions are met. Additionally, a Report SUBFOOT now prints above the footing instead of below it.

OFF

Does not support StyleSheets. OFF is the default value.


Top of page

x
PSPAGESETUP

The PSPAGESETUP parameter causes the paper source used by a PostScript printer to match the PAGESIZE parameter setting.

The syntax is:

SET PSPAGESETUP = {OFF|ON}

where:

OFF

Does not include PostScript code for the selection of a PostScript printer paper source. OFF is the default value.

ON

Includes PostScript code that automatically tells a PostScript printer to set its paper source to the size specified by PAGESIZE.


Top of page

x
QUALCHAR

The QUALCHAR parameter specifies the qualifying character to be used in qualified field names.

The syntax is:

SET QUALCHAR = {character|.}

where:

character

Is a valid qualifying character. They include:

.

period

(hex 4B)

 

:

colon

(hex 7A)

 

!

exclamation point

(hex 5A)

 

%

percent sign

(hex 6C)

 

¦

broken vertical bar

(hex 6A)

 

\

backslash

(hex E0)

 

A period (.) is the default value. The use of the other qualifying characters listed above is restricted and should not be used with 66-character field names.

If the qualifying character is a period, you can use any of the other characters listed above as part of a field name. If you change the default qualifying character to a character other than the period, then you cannot use that character in a field name.

In z/VM, if the TERM tabchar is ON or if the CMS INPUT command includes the broken vertical bar (hex 6A), then the broken vertical bar cannot be the qualifying character. To query INPUT, type Q INPUT at the CMS prompt.



x
QUALTITLES

The QUALTITLES parameter uses qualified column titles in report output when duplicate field names exist in a Master File. A qualified column title distinguishes between identical field names by including the segment name.

The syntax is:

SET QUALTITLES = {ON|OFF}

where:

ON

Uses qualified column titles when duplicate field names exist and FIELDNAME is set to NEW.

OFF

Disables qualified column titles. OFF is the default value.


Top of page

x
REBUILDMSG

The REBUILDMSG parameter allows for direct control over the frequency with which REBUILD issues messages.

The syntax is:

SET {REBUILDMSG|REMSG} = n

where:

n

Is any number.


Top of page

x
RECAP-COUNT

The RECAP-COUNT parameter includes lines containing a value created with RECAP when counting the number of lines per logical page for printed output.

The number of lines per page is determined by the LINES parameter.

The syntax is:

SET RECAP-COUNT = {ON|OFF}

where:

ON

Counts lines containing a value created with RECAP.

OFF

Does not count lines containing a value created with RECAP. OFF is the default value.


Top of page

x
RIGHTMARGIN

The RIGHTMARGIN parameter sets the StyleSheet right boundary for report contents on a page. This parameter applies to PostScript and PDF reports.

The syntax is:

SET RIGHTMARGIN = {value|.25}

where:

value

Is the right boundary of report contents on a page. 0.25 inches is the default value.


Top of page

x
SAVEDMASTERS

The SAVEDMASTERS parameter saves a Master File in memory after it is used in a request. Saving a Master File prevents re-parsing the Master File when referenced in subsequent requests, resulting in performance improvement.

Up to 99 Master Files can be saved to memory.

This parameter cannot be set in the ON TABLE SET command.

The syntax is:

SET SAVEDMASTERS = n

where:

n

Is an integer between 0 and 99 that specifies the maximum number of Master Files on the SAVEDMASTERS list. 0 is the default value.

Note that the most recently used Master File is always stored in memory, even with SAVEDMASTERS set to zero. However, the zero setting does not generate the list of saved Master Files.


Top of page

x
SAVEMATRIX

The SAVEMATRIX parameter preserves the internal matrix and keeps it available for subsequent RETYPE, HOLD, SAVE, SAVB, and REPLOT commands when followed by Dialogue Manager commands.

The syntax is:

SET SAVEMATRIX = {ON|OFF}

where:

ON

Saves the last internal matrix generated.

OFF

Does not guarantee that the internal matrix is available. OFF is the default value.


Top of page

x
SBORDER

The SBORDER parameter generates a solid border on the screen for full-screen mode.

If the screen appears to be generated incorrectly, it is possible that the terminal does not support this new feature; change the setting to OFF to correct the situation.

The amper variable &FOCSBORDER contains the value of the SBORDER setting. &FOCSBORDER may be included in the Dialogue Manager -TYPE command.

The syntax is:

SET SBORDER = {ON|OFF}

where:

ON

Enables solid borders. ON is the default value.

OFF

Enables dashed (nonsolid) borders.


Top of page

x
SCREEN

The SCREEN parameter selects the Hot Screen facility.

When the SCREEN parameter is ON, the PAUSE parameter is set ON (until you set the PAUSE parameter OFF). If you set the SCREEN parameter OFF, the PAUSE parameter is set OFF. Note that you can change the PAUSE parameter without affecting the SCREEN parameter.

The syntax is:

SET SCREEN = {ON|OFF|PAPER}

where:

ON

Activates the Hot Screen facility. ON is the default value.

OFF

Deactivates the Hot Screen facility.

PAPER

Activates the Hot Screen facility and causes FOCUS to use the settings for LINES and PAPER parameters to format screen display.


Top of page

x
SHADOW

The SHADOW parameter activates the Absolute File Integrity feature for FOCUS files (but not XFOCUS files).

The syntax is:

SET SHADOW [PAGE] = {ON|OFF|OLD}

where:

ON

Activates the FOCUS Absolute File Integrity feature. The maximum number of pages shadowed is 256K.

OFF

Deactivates the Absolute File Integrity feature. OFF is the default value.

OLD

Indicates that your FOCUS file was created before Version 7.0. This means that the maximum number of pages shadowed is 63,551.


Top of page

x
SHIFT

The SHIFT parameter controls the use of "shift" strings.

The syntax is:

SET SHIFT = {ON|OFF}

where:

ON

Specifies a shift string for Hebrew or DBCS (double-byte character support).

OFF

Indicates that SHIFT is not in effect. OFF is the default value.


Top of page

x
SHOWBLANKS

The SHOWBLANKS parameter preserves leading and internal blanks in HTML and EXL2K report output.

The syntax is:

SET SHOWBLANKS = {OFF|ON}

where:

OFF

Removes leading and internal blanks in HTML and EXL2K report output. OFF is the default value.

ON

Preserves leading and internal blanks in HTML and EXL2K report output.


Top of page

x
SORTLIB

The SORTLIB parameter tells FOCUS which sort package is installed at your site.

The syntax is:

SET SORTLIB = {option|DEFAULT}

where:

option

Is one of the following:

DEFAULT is the default setting. It assumes that one of the common sort packages has been set as the site default.

VMSORT is the VMSORT sort package.

SYNCSORT is the SYNCSORT sort package.

DFSORT is the DFSORT sort package.

SITEDEFINED is used for a sort package other than VMSORT, SYNCSORT, or DFSORT. This sort package must be installed in SORTLIB TXTLIB in order for FOCUS to find it.


Top of page

x
SPACES

The SPACES parameter sets the number of spaces between columns in a report.

This parameter does not work with HTML, PDF, or styled reports.

The syntax is:

SET SPACES = {AUTO|n}

where:

AUTO

Automatically places either 1 to 2 spaces between columns. AUTO is the default value.

n

Is the number of spaces to place between columns of a report. Valid values are integers between 1 and 8.


Top of page

x
SQLTOPTTF

The SQLTOPTTF parameter enables the SQL Translator to generate TABLEF commands instead of TABLE commands.

The syntax is:

SET SQLTOPTTF = {ON|OFF}

where:

ON

Generates TABLEF commands when possible. For example, a TABLEREF command is generated if there is no JOIN or GROUP BY command. ON is the default value. ON is the default value.

OFF

Always generates TABLE commands.


Top of page

x
SQUEEZE

The SQUEEZE parameter applies only to the StyleSheet feature.

It determines the column width in report output. The column width is based on the size of the data value or column title, or on the field format defined in the Master File.

The syntax is:

SET SQUEEZE = {ON|OFF|n}

where:

ON

Assigns column widths based on the widest data value or widest column title, whichever is longer. ON is the default value for reports displayed in HTML format.

OFF

Assigns column widths based on the field format specified in the Master File. This value pads the column width to the length of the column title or field format descriptions, whichever is greater.

n

Represents a specific numeric value, based on the UNITS parameter setting, to which the column width can be set (valid only in PDF and PS).


Top of page

x
STYLEMODE

The STYLEMODE parameter determines the type of HTML generated for report output.

Note: The SQUEEZE parameter must be set to OFF to align data columns from one page to the next.

The syntax is:

SET STYLEMODE = {FULL|FIXED|PAGED}

where:

FULL

Displays normal HTML output. FULL is the default value.

FIXED

Generates <PRE tag in HTML to indicate preformatted text which is not to be treated as HTML.

PAGED

Displays a report output in multiple HTML tables where each table is a separate report page. These smaller HTML files are retrieved from the Web server quicker than a single large file.


Top of page

x
STYLE[SHEET]

The STYLE[SHEET] parameter controls the format of report output by accepting or rejecting StyleSheet parameters. The parameters specify formatting options such as page size, orientation, and margins.

The syntax is:

SET STYLE[SHEET] = {stylesheet|ON|OFF}

where:

stylesheet

Is the name of the StyleSheet file. For UNIX and Windows, this is the name of the StyleSheet file without the file extension .sty. For z/OS, this is the member name in the PDS allocated to ddname FOCSTYLE. For CMS, this is the name of a file with file type FOCSTYLE.

For a PDF or PostScript report, it uses the page layout settings for UNITS, TOPMARGIN, BOTTOMMARGIN, LEFTMARGIN, RIGHTMARGIN, PAGESIZE, ORIENTATION, and SQUEEZE. The settings for LINES, PAPER, PANEL, and WIDTH are ignored.

ON

Uses the page layout settings for UNITS, TOPMARGIN, BOTTOMMARGIN, LEFTMARGIN, RIGHTMARGIN, PAGESIZE, ORIENTATION, and SQUEEZE. The settings for LINES, PAPER, PANEL, and WIDTH are ignored.

For a PDF or PostScript report, uses the page layout settings for UNITS, TOPMARGIN, BOTTOMMARGIN, LEFTMARGIN, RIGHTMARGIN, PAGESIZE, ORIENTATION, and SQUEEZE; the settings for LINES and WIDTH are ignored.

OFF

This uses the settings for LINES, PAPER, PANEL, and WIDTH. The settings for UNITS, TOPMARGIN, BOTTOMMARGIN, LEFTMARGIN, RIGHTMARGIN, PAGESIZE, ORIENTATION, and SQUEEZE are ignored. OFF is the default value.


Top of page

x
SUMMARYLINES

The SUMMARYLINES parameter allows users to combine fields with and without prefix operators on summary lines in one request. Prefix operator processing is used for all summary lines. Fields without prefix operators are processed as though they were specified with the operator SUM.

This command cannot be used with ON TABLE SET.

The syntax is:

SET SUMMARYLINES = {OLD|NEW|EXPLICIT}

where:

OLD

Propagates all summary operations to the grand total line. Does not allow mixing of fields with and without prefix operators on a summary command when the first field does not have an associated prefix operator. All fields listed in any summary command are populated on all summary lines. OLD is the default value.

NEW

Propagates all summary operations to the grand total line. Uses prefix operator processing for all summary commands (all summary fields without prefix operators are processed as though they had a SUM. operator). Fields listed in a summary command are populated only on summary lines created by that summary command and on summary lines created by propagation of that summary command. Supports display of alphanumeric fields on summary lines.

EXPLICIT

Does not propagate SUBTOTAL and RECOMPUTE to the grand total line. Uses prefix operator processing for all summary commands (all summary fields without prefix operators are processed as though they had a SUM. operator). Fields listed in a summary command are populated only on summary lines created by that summary command and on summary lines created by propagation of that summary command. Supports display of alphanumeric fields on summary lines.

Note: This command is not supported in a request using the ON TABLE SET syntax.


Top of page

x
SUMPREFIX

The SUMPREFIX parameter allows users to choose the answer set display order when using an external sort to perform aggregation on alphanumeric or smart date formats.

The syntax is:

SET SUMPREFIX = {FST|LST}

where:

FST

Displays the first value when alphanumeric or smart date data types are aggregated.

LST

Displays the last value when alphanumeric or smart date data types are aggregated. LST is the default value.


Top of page

x
SUSI

See the Simultaneous Usage Reference Manual for z/OS manual.


Top of page

x
SUTABSIZE

See the Simultaneous Usage Reference Manual for z/OS manual.


Top of page

x
SUWEDGE

The SUWEDGE parameter keeps Master files in memory on a FOCUS Database Server (sink machine) even though no users are accessing the files.

Add the following command to the FOCUS Database Server profile (PROFILE HLI on z/VM, and member HLIPROF of the FOCEXEC data set on z/OS):

SET SUWEDGE = {n|ddname} [, ddname ...]

where:

n

Is a number of Master Files to be wedged open. You can specify any number, but once 128 files are wedged open, additional files will not be wedged. The default is zero.

ddname

Is the ddname of a specific file to be wedged open in addition to the n files specified by number (if any).

Note: To set both a number of files to be wedged and one or more specific DDNAMEs to be wedged, you can issue the SET SUWEDGE command multiple times or specify multiple options in one SET SUWEDGE command. Specific DDNAMEs are not counted in the number of files specified (as long as the total does not exceed the maximum number of wedged files allowed). If you specify a number multiple times, the last one specified is the one used.


Top of page

x
TARGETFRAME

The TARGETFRAME parameter includes the HTML code <BASE TARGET="framename"> in the heading of the HTML file that is displayed in your browser. All hyperlinks from the base report are directed to the specified frame unless overridden by the TARGET attribute in the StyleSheet.

The syntax is:

SET TARGETFRAME = framename

where:

framename

Is the frame on the Web page in which the output from the hyperlink is displayed. Possible values include standard HTML frame names such as, _blank, _self, _parent, _top, or a user-defined name.


Top of page

x
TEMP[DISK]

The TEMP[DISK] parameter determines the disk FOCUS uses for temporary work space, and to store extract files (HOLD and SAVE)

This parameter does not apply for z/OS.

The syntax is:

SET TEMP[DISK] = disk

where:

disk

Is the disk FOCUS uses for temporary workspace, and to store extract files.


Top of page

x
TERM[INAL]

The TERM[INAL] parameter selects the terminal type.

The syntax is:

SET TERM[INAL] = {type|IBM3270}

where:

type

Is the terminal type. The options are:

IBM3270 is the default value. It does not support DBCS.

IBM5550 specifies an IBM 5550 or a PS/55 terminal. Supports DBCS.

F6650 specifies a Facom F-6650 terminal. Supports DBCS.

H56020 specifies a Hitachi H-560/20 terminal. Supports DBCS.


Top of page

x
TESTDATE

The TESTDATE parameter temporarily alters the system date in order to test a dynamic window allowing you to simulate clock settings beyond the year 1999 to determine the behavior of your program.

The syntax is:

SET TESTDATE = {yyyymmdd|TODAY}

where:

yyyymmdd

Is an 8-digit date in the format YYYYMMDD.

TODAY

Is the current date. TODAY is the default value.


Top of page

x
TITLES

The TITLES parameter controls whether to use pre-defined column titles in the Master File as column titles in report output.

The syntax is:

SET TITLES = {ON|OFF|NOPREFIX}
ON TABLE SET TITLES {ON|OFF|NOPREFIX}

where:

ON

Displays the value of the TITLE attribute as the column heading on the report output, if a TITLE attribute exists in the Master File. If the field has a prefix operator in the report request, it creates the column heading using both the prefix operator and the TITLE attribute. If there is no TITLE attribute, the field name is used instead. ON is the default value.

OFF

Displays the field name as the column heading on the report output. If the field has a prefix operator in the report request, it creates the column heading using both the prefix operator and the field name.

NOPREFIX

Displays the value of the TITLE attribute as the column heading on the report output, if a TITLE attribute exists in the Master File. If there is no TITLE attribute, the field name is used instead. If the field has a prefix operator in the report request, it creates the column heading using both the prefix operator and the field name.


Top of page

x
TOPMARGIN

The TOPMARGIN parameter sets the top StyleSheet boundary for report contents on a page.

This parameter applies to PostScript and PDF reports.

The syntax is:

SET TOPMARGIN = {value|.25}

where:

value

Is the top boundary on a page for report output. 0.25 inches is the default value.


Top of page

x
TRACKIO

In z/OS FOCUS, the TRACKIO parameter gathers more pages to fill a track before reading or writing the pages to disk. This results in significant reductions in I/O requirements and in elapsed time for FOCUS files.

The syntax is:

SET TRACKIO = {ON|OFF}

where:

ON

Enables FOCUS to fill a track before reading or writing to disk. ON is the default value.

OFF

Does not fill a track before reading and writing to a disk.


Top of page

x
TRANTERM

The TRANTERM parameter displays extended currency symbols on TSO. By default, when displaying report output in TSO without HotScreen (SET SCREEN=OFF), the extended currency symbols do not display because the terminal I/O procedures translate all terminal output to characters that appear in USA EBCIDIC keyboard layouts and code charts.

The syntax is:

SET TRANTERM = {ON|OFF}

where:

ON

Does not display extended currency symbols. ON is the default value.

OFF

Displays extended currency symbols.


Top of page

x
TRMOUT

The TRMOUT parameter suppresses all output messages to the terminal.

The syntax is:

SET TRMOUT = {ON|OFF}

where:

ON

Displays output messages to the terminal. ON is the default value.

OFF

Suppresses messages to the terminal.


Top of page

x
UNITS

The UNITS parameter applies to PostScript and PDF reports.

It specifies the unit of measure for page margins, column positions, and column widths.

The syntax is:

SET UNITS = {INCHES|CM|PTS}

where:

INCHES

Uses inches as the unit of measure. INCHES is the default value.

CM

Uses centimeters as the unit of measure.

PTS

Uses points as the unit of measurement. (One inch = 72 points, one cm = 28.35 points).


Top of page

x
USER

The USER parameter enables user access to a data source or stored procedure protected by Information Builders security.

The syntax is:

SET USER = user

where:

user

Is the user name that, with a password, enables access to a data source or stored procedure protected by Information Builders security.


Top of page

x
USERFCHK

The USERFCHK parameter controls the level of verification applied to DEFINE FUNCTION arguments and Information Builders-supplied function arguments. It does not affect verification of the number of parameters. The correct number must always be supplied.

Note that the USERFNS=SYSTEM setting must be in effect. For details, see USERFNS.

Issue the following command in FOCPARM, FOCPROF, on the command line, in a procedure, or in an ON TABLE command.

SET USERFCHK = setting

where:

setting

Can be one of the following:

ON verifies parameters in requests, but does not verify parameters for functions used in Master File DEFINEs. If a parameter has an incorrect length, an attempt is made to fix the problem. If such a problem cannot be fixed, a message is generated and the evaluation of the affected expression is terminated. ON is the default value.

Because parameters are not verified for functions specified in a Master File, no errors are reported for those functions until the DEFINE field is used in a subsequent request when, if a problem occurs, the following message is generated:

(FOC003) THE FIELDNAME IS NOT RECOGNIZED

OFF does not verify parameters except in the following cases:

  • If a parameter that is too long would overwrite the memory area in which the computational code is stored, the size is automatically reduced without issuing a message.

    Note: The OFF setting will be deprecated in a future release.

  • If an alphanumeric parameter is too short, it is padded with blanks to the correct length.

FULL is the same as ON, but also verifies parameters for functions used in Master File DEFINEs.

ALERT verifies parameters in a request without halting execution when a problem is detected. It does not verify parameters for functions used in Master File DEFINEs. If a parameter has an incorrect length and an attempt is made to fix the problem behind the scenes, the problem is corrected with no message. If such a problem cannot be fixed, a warning message is generated. Execution then continues as though the setting were OFF.


Top of page

x
USERFNS

If your site has a locally written function with the same name as an Information Builders-supplied function, the USERFNS parameter determines which function is used.

Parameter verification can be enabled for DEFINE FUNCTIONs and functions supplied by Information Builders.

The syntax is:

SET USERFNS= {SYSTEM|LOCAL}

where:

SYSTEM

Gives precedence to functions supplied by Information Builders and to those created with the DEFINE FUNCTION command. SYSTEM is the default value.

This setting is required to enable parameter verification. For details, see USERFCHK.

LOCAL

Gives precedence to locally written functions. Parameter verification is not performed with this setting in effect.


Top of page

x
WEBARCHIVE

The WEBARCHIVE parameter packages EXL2K reports together with associated files (such as the pivot cache for the EXL2K PIVOT format) into a single web archive document (.xmh file). This format is only available for Excel 2002 and later.

The syntax is:

SET WEBARCHIVE = {ON|OFF}

where:

ON

Packages EXL2K reports together with associated files into a single web archive document (.xmh file). ON is the default value.

OFF

Does not package multiple files into a single document (creates an EXL2K report as an .xht file).


Top of page

x
WEBTAB

The WEBTAB parameter instructs FOCUS to enclose CRTFORM display fields in @ signs.

When the HTML/TP feature of Web390 generates replacement HTML forms for a 3270 screen, it can dynamically account for fields that may or may not be populated with data during execution. HTML/TP can use this technique with turnaround (T.) fields on CRTFORMs because they are enclosed in @ signs. These @-sign markers enable HTML/TP to recognize them and handle them dynamically on a customized HTML form. In contrast, CRTFORM display (D.) fields are not normally enclosed in @ signs.

Note: This setting is only for those MODIFY CRTFORM or Dialogue Manager -CRTFORM applications that are used in conjunction with the HTML/TP feature of Web390. For information about Web390 and the HTML/TP feature, see the Web390 for OS/390 and MVS Developer's Guide and Installation Manual.

The syntax is:

SET WEBTAB = {ON|OFF}

where:

ON

Adds @ signs around CRTFORM display fields. These markers may cause the fields displayed on the CRTFORM to shift slightly to the right. Use this setting only for MODIFY CRTFORM or Dialogue Manager -CRTFORM applications that are used in conjunction with the HTML/TP feature of Web390.

OFF

Does not place @ signs around CRTFORM display fields. OFF is the default value.


Top of page

x
WEBVIEWHOME

The WEBVIEWHOME parameter allows an HTML page to be displayed when the WebFOCUS Viewer is closed.

The syntax is:

SET WEBVIEWHOME = {home_URL|OFF}

where:

home_URL

Is a valid URL that displays an HTML page when you close the WebFOCUS Viewer.

OFF

Displays a blank browser window when you close the WebFOCUS Viewer. You must enter another URL to run another report. OFF is the default value.


Top of page

x
WEBVIEWTARG

The WEBVIEWTARG parameter allows the user to open the WebFOCUS Viewer in a target frame.

The syntax is:

SET WEBVIEWTARG = {target_frame|OFF}

where:

target_frame

Is the name of an existing frame in the browser or one of the following reserved HTML target frames:

_blank opens the WebFOCUS Viewer in a new browser window. This is the default.

_self opens the WebFOCUS Viewer in the same frame as the anchor.

_parent opens the WebFOCUS Viewer in the immediate parent frame that contains the anchor.

_top opens the WebFOCUS Viewer in the frame from which you ran the report.

OFF

Opens the WebFOCUS Viewer in the frame from which you ran the report.


Top of page

x
WEEKFIRST

The WEEKFIRST parameter specifies a day of the week as the start of the week. This is used in week computations by the HDIFF, HNAME, HPART, HYYWD, and HSETPT functions, described in the Using Functions manual.

The HPART and HNAME subroutines can extract a week number from a date-time value. To determine a week number, they can use ISO 8601 standard week numbering, which defines the first week of the year as the first week in January with four or more days. Any preceding days in January belong to week 52 or 53 of the preceding year.

Depending on the value of WEEKFIRST, these functions can also define the first week of the year as the first week in January with seven days.

The WEEKFIRST parameter does not change the day of the month that corresponds to each day of the week, but only specifies which day is considered the start of the week.

The syntax is:

SET WEEKFIRST = {value|7}

where:

value

Can be:

1 through 7, representing Sunday through Saturday with non-standard week numbering.

or

ISO1 through ISO7, representing Sunday through Saturday with ISO standard week numbering. Note: ISO is a synonym for ISO2.

The ISO standard establishes Monday as the first day of the week, so to be fully ISO compliant, the WEEKFIRST parameter should be set to ISO or ISO2.


Top of page

x
WIDTH

The WIDTH parameter specifies the logical record length of your output data set when using a 3270 terminal. It is used only for communication between the operating system and a 3270 terminal. It has no function when used with a terminal emulator.

The syntax is:

SET WIDTH = n

where:

n

Is the width setting for you terminal. The default value is 130.


Top of page

x
WPMINWIDTH

If you need the report width for a format WP output file to remain fixed across releases for later processing of the output file, you can set the width you need using the SET WPMINWIDTH command. This parameter specifies the minimum width of the output file. It will be automatically increased if the width you set cannot accommodate the fields propagated to the output file in the request. On z/OS, The LRECL of the output file will be four bytes more than the report width because the file is variable length and needs an additional four bytes to hold the actual length of each record instance. In other operating environments, the length of the record is the value of WPMIDWIDTH.

The syntax is:

SET WPMINWIDTH = {0|nnn}
ON TABLE SET WPMINWIDTH {0|nnn}

where:

nnn

Is the minimum width of the output file. On z/OS, the LRECL will automatically be nnn + 4 bytes. If you specify zero (0) for nnn, the width will be calculated automatically based on the report request. If the width you specify cannot accommodate the fields propagated to the output file, it will be automatically increased enough to accommodate them.


Top of page

x
XFOCUS

The XFOCUS parameter enables the use of XFOCUS data sources in addition to FOCUS data sources.

The syntax is:

SET XFOCUS = ON

where:

ON

Enables creation and use of XFOCUS data sources. This setting does not inhibit or affect the use of FOCUS data sources; it adds the ability to create and use XFOCUS data sources.

OFF

This setting has been deprecated.


Top of page

x
XFOCUSBINS

The XFOCUSBINS parameter defines the number of pages of memory to use as buffers for XFOCUS data sources.

The syntax is:

SET XFOCUSBINS = n

where:

n

Is the number of pages used for XFOCUS data source buffers. Valid values are16 to 1023. 16 is the default value.

Tip: The memory is not allocated until an XFOCUS data source is used in the session. Therefore, if you issue the ? SET XFOCUSBINS query command, you see the number of pages set for XFOCUS buffers and an indication of whether the memory has been allocated (passive for no, active for yes).


Top of page

x
XRETRIEVAL

The XRETRIEVAL parameter previews the format of a report without actually accessing any data. This parameter enables you to perform TABLE, TABLEF, or MATCH requests and produce HOLD Master Files without processing the report.

The syntax is:

SET XRETRIEVAL = {ON|OFF}

where:

ON

Performs retrieval when previewing a report. ON is the default value.

OFF

Specifies that no retrieval is to be performed.


Top of page

x
YRTHRESH

The YRTHRESH parameter defines the start of a 100-year window globally or on a field-level. Used with DEFCENT, interprets the current century according to the given values. Two-digit years greater than or equal to YRTHRESH assume the value of the default century. Two-digit years less than YRTHRESH assume the value of one more than the default century. (See DEFCENT.)

Note: This same result can be achieved by including the FDEFCENT and FYRTHRESH attributes in the Master File.

The syntax is:

SET YRTHRESH = {[-]yy|0}

where:

yy

Is the year threshold for the window. 0 is the default value.

If yy is a positive number, that number is the start of the 100-year window. Any 2-digit years greater than or equal to the threshold assume the value of the default century. Two-digit years less than the threshold assume the value of one more than the default century.

If yy is a negative number (-yy), the start date of the window is derived by subtracting that number from the current year, and the default century is automatically calculated. The start date is automatically incremented by one at the beginning of each successive year.


Top of page

x
ZIIP

The ZIIP parameter enables you to offload specific categories of FOCUS workload from the Central Processors to a zIIP specialty engine, if a zIIP engine is available at your site. For complete information, see the z/OS Guide to Operations chapter in the Overview and Operating Environments manual.

Note: IBM Workload Manager must have a policy and goals declared to allow FOCUS to access the zIIP with sufficient priority compared to other software to derive a benefit from processing on the zIIP. In addition, all load libraries must run APF authorized in order to process on the zIIP.

The syntax is:

SET ZIIP={ON[/SIMMAXZIIP]|OFF}

where:

ON

Configures FOCUS to offload processing to the zIIP engine.

FOCUS determines if the zIIP processor is accessible to the LPAR in which the job is running. If FOCUS determines that the zIIP is not accessible, it issues a message describing the reason and continues in ZIIP=OFF mode, which forwards all subsequent work to the Central Processor.

SIMMAXZIIP

Allows the job to run with processing on the zIIP and simulates full zIIP accessibility to see how much zIIP access the job would have had if the zIIP were 100 percent available for FOCUS usage. Use this option for simulation purposes only.

OFF

Configures FOCUS not to offload processing to the zIIP engine. OFF is the default value.

Note: Turn off zIIP enablement only when you know for sure that a job will not gain any advantage from using the zIIP processor or if the system operator or administrator requires that you turn it off.


Information Builders