SET Parameter Syntax

The 3D parameter sets a chart to either three dimensions or two dimensions.

The syntax is:

SET 3D = {ON|OFF}

where:

ON

Produces a three-dimensional chart. ON is the default.

OFF

Produces a two-dimensional chart.

The ACCBLN parameter accepts blank or zero values for fields with ACCEPT commands in the Master File (see the Describing Data With TIBCO WebFOCUS® Language 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.

The ACCESSHTML parameter generates HTML report output that is compliant with Section 508-level accessibility requirements. The ACCESSHTML supersedes the ACCESSIBLE parameter (which is still supported) because it allows for future expansion to support additional accessibility standards.

HTML code that is Section 508 compliant automatically turns off pagination. Column titles and page headings are displayed only at the beginning of the report and page footings only at the end of the report.

The syntax is:

SET ACCESSHTML = {508|OFF}

where:

508

Generates HTML report output that is compliant with Section 508-level accessibility requirements.

OFF

Does not generate report output that is compliant with Section 508-level accessibility requirements. OFF is the default.

The ACCESSIBLE parameter generates report output in HTML code that is compliant with Section 508-level accessibility requirements.

HTML code that is Section 508 compliant automatically turns off pagination. Column titles and page headings are displayed only at the beginning of the report and page footings only at the end of the report.

The syntax is:

SET ACCESSIBLE = {508|OFF}

where:

508

Generates report output in HTML code that is compliant with Section 508-level accessibility requirements.

OFF

Does not generate report output that is compliant with Section 508-level accessibility requirements. OFF is the default.

The ACCESSPDF parameter generates PDF report output that is compliant with Section 508-level accessibility requirements.

The syntax is:

SET ACCESSPDF = {508|OFF}

where:

508

Generates PDF report output that is compliant with Section 508-level accessibility requirements.

OFF

Does not generate report output that is compliant with Section 508-level accessibility requirements. OFF is the default.

The ACROSSLINE parameter controls underlining of column titles on report output. TITLELINE is a synonym for ACROSSLINE.

The syntax is:

SET {ACROSSLINE|TITLELINE} = {ON|OFF|SKIP}

where:

ON

Underlines column titles on report output. ON is the default value.

OFF

Replaces the underline with a blank line.

SKIP

Specifies no underline and no blank line.

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.

In a report that uses the ACROSS sort phrase to sort values horizontally across the page, by default, two lines are generated on the report output for the ACROSS columns. The first line displays the name of the sort field (ACROSS title), and the second line displays the values for that sort field (ACROSS value). The ACROSS field name is left justified above the first ACROSS value.

The ACROSSTITLE parameter enables you to display both the ACROSS title and the ACROSS values on one line in PDF, HTML, EXL2K, or EXL07 report output. You can issue the SET ACROSSTITLE = SIDE command. This command places ACROSS titles to the left of the ACROSS values. The titles are right justified in the space above the BY field titles. The heading line that is created, by default, to display the ACROSS title will not be generated.

This feature is designed for use in requests that have both ACROSS fields and BY fields. For requests with ACROSS fields but no BY fields, the set command is ignored, and the ACROSS titles are not moved.

The syntax is:

SET ACROSSTITLE = {ABOVE|SIDE}

where:

ABOVE

Displays ACROSS titles above their ACROSS values. ABOVE is the default value.

SIDE

Displays ACROSS titles to the left of their ACROSS values, above the BY columns.

Using the SET ACRSVRBTITL command, you can control the display of an ACROSS column title in an ACROSS group. The behavior of the title is determined by the number of verb columns in the ACROSS group. The field count is affected by the following features, which add internal matrix columns to the report:

• Fields in a heading or footing.
• Fields whose display is suppressed with the NOPRINT phrase.
• Reformatted fields (which are normally counted twice).
• A COMPUTE command referencing multiple fields.

The syntax is:

SET ACRSVRBTITL = {HIDEONE|ON|OFF} 

ON TABLE SET ACRSVRBTITL {HIDEONE|ON|OFF}

where:

HIDEONE

Suppresses the title when there is only one display field, or there is only one display field and the request contains one or more of the features that add internal matrix columns to the report. This value is the default.

ON

Always displays the title even if there is only one display field.

OFF

Suppresses the title when there is only one display field. Displays the title when there is only one display field and the request contains one or more of the features that add internal matrix columns to the report. This is legacy behavior.

The ALL parameter handles missing segment instances in a report.

The command SET ALL = ON specifies a left outer join. With a left outer join, all records from the host file display on the report output. If a cross-referenced segment instance does not exist for a host segment instance, the report output displays missing values for the fields from the cross-referenced segment.

If there is a screening condition on the dependent segment, those dependent segment instances that do not satisfy the screening condition are omitted from the report output, and so are their corresponding host segment instances.

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 (for more information, 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.

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.

Note: The ALLOWCVTERR parameter is not supported for virtual fields.

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.

The ALTBACKPERLINE attribute alternates the background color by line for reports that use positioned drivers, for example PDF, DHTML, PPT, and PPTX. This enables you to wrap a long field value, and alternate the background color of each line for that value, independent of borders. In order to apply alternating background color per line, you need to explicitly add the SET ALTBACKPERLINE=ON command to procedures that use WRAP.

The syntax is:

SET ALTBACKPERLINE = {ON|OFF}

where:

ON

Alternates background color by line.

OFF

Alternates background color by row. This is the default value.

The AREXPIRE parameter enables you to set the date when an HTML active report expires and the report output can no longer be displayed.

The use of AREXPIRE is optional and by default, there is no expiration date set for an HTML active report. To reset the expiration date, rerun the report to create new output which has no expiration date.

The syntax is:

SET AREXPIRE = {yymmdd|xxxDAYS}

where:

yymmdd

Is the expiration date in the format of year, month, and day. For example, if you want the report to expire on January 1, 2009, use 090101.

xxx

Is the number of days from the current date that the report expires. Valid values are 1 to 999.

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

ON TABLE SET AREXPIRE {yymmdd|xxxDAYS}

Sets the graph engine used for rendering graphs in active technologies reports. it only has an effect when used with FORMAT AHTML or other active formats (APDF or FLEX)..

The syntax is:

SET ARGRAPHENGIN = JSCHART

The ARPASSWORD parameter enables you to set a password that is required to view HTML active report output. Prior to opening the report output, the user is prompted to enter a password to unlock the report.

The use of ARPASSWORD is optional and by default, there is no password required to access an HTML active report.

The syntax is:

SET ARPASSWORD = password

where:

password

Is any character string up to 32 characters in length.

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

ON TABLE SET ARPASSWORD password

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|MIXED|FOCUS|FLIP}

where:

OFF

Does not use the literal specified in an AS phrase as a field name in HOLD files, and does not affect the way ACROSS fields are named.

ON

Uppercases the literal specified in an AS phrase and propagates it as the field name in the HOLD Master File. Creates names for ACROSS fields that consist of the AS name value concatenated to the beginning of the ACROSS field value and controls the way ACROSS fields are named in HOLD files of any format.

MIXED

Uses the literal specified in an AS phrase for the field name, retaining the case of the AS name, and creates names for ACROSS fields that consist of the AS name value concatenated to the beginning of the ACROSS field value.

FOCUS

Uses the literal specified in an AS phrase as the field name and controls the way ACROSS fields are named only in HOLD files in FOCUS format. FOCUS is the default value.

FLIP

Propagates the field names in the original Master File to the alias names in the HOLD Master File and the alias names in the original Master File to the field names in the HOLD Master File.

The AUTODRILL parameter applies to OLAP.

It enables the end user to automatically drill down to the next level of a dimension within the body of the current report. That is, the server automatically generates a hyperlink (the <A HREF tag) in the HTML code for every output data item described by the Master File WITHIN attribute. This occurs when AUTODRILL is set to ON.

If there is no other level, and the selected field is part of a BY command in the request (that is, it is a vertical sort field), the report is generated without a column for that dimension. If there is no other level, and the selected field is part of an ACROSS command in the request (it is a horizontal sort field), the report is generated without a row for that dimension. AUTODRILL must act on a sort field (that is also defined as a dimension in the Master File).

If the OLAP Control Panel is open, the output data item selected on the screen is added to the Selection Criteria list in the panel, enabling the end user to choose multiple items before running the drill-down report.

If the OLAP Control Panel is not open, the drill-down report runs automatically, based on the output data item selected on the screen.

The syntax is:

SET AUTODRILL = {ON|OFF|ALL}

where:

ON

Automatically generates a hyperlink in the HTML source code for every output data item described by the Master File WITHIN attribute. ON is the default.

OFF

Disables the automatic generation of hyperlinks.

ALL

Allows you to drill down on any value in the report by creating every value in the report as a hyperlink, including Measures. Drilling on a measure generates a more detailed report based on the lowest drill down (BY) field.

The AUTOFIT parameter automatically resizes HTML report output to fit its window or frame and HTML5 graphs to fit their containers.

The syntax is:

SET AUTOFIT = {OFF|ON|RESIZE}

ON {GRAPH|TABLE} SET AUTOFIT {OFF|ON|RESIZE}

where:

OFF

Respects the dimensions specified by the data and styles for TABLE or by the HAXIS and VAXIS parameters for HTML5 graphs.

ON

Always resizes HTML report output to fit its window or frame and HTML5 graph output to fit its container.

RESIZE

Applies to HTML5 graphs only. Respects the dimensions specified by the HAXIS and VAXIS parameters initially, but resizes the graph output if the container is resized.

The AUTOINDEX parameter speeds data retrieval by automatically taking advantage of indexed fields in most cases where TABLE requests contain equality or range tests on those fields. This applies only to FOCUS 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. ON is the default value.

OFF

Uses indexed retrieval only when explicitly specified using an indexed view, for example, TABLE FILE filename.indexed-fieldname.

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.

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.

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.

The AUTOTICK parameter automatically sets the tick mark intervals for graphs. (See also HTICK and VTICK.)

The syntax is:

SET AUTOTICK = {ON|OFF}

where:

ON

Automatically sets the tick mark intervals. ON is the default.

OFF

Does not set the tick mark intervals. You must set them with parameters including HTICK and VTICK.

The BARNUMB parameter places summary values at the end of bars on bar charts, or slices on pie charts.

The syntax is:

SET BARNUMB = {ON|OFF}

where:

ON

Places the summary values at the ends of bars on bar charts, or slices on pie charts.

OFF

Does not include summary values. OFF is the default.

The BASEURL parameter specifies a default location where your browser searches for relative URLs referenced in the HTML documents created by WebFOCUS. 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 (/).

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 core pages used for data source buffers. Valid values are 13 to 64. The default value is two-thirds of the core remaining after you start, about 64 pages.

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)

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|.250}

where:

n

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

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.

Within a sort group, the sort field value displays only on the first line of the rows or leftmost column of the columns for its sort group. However, you can display the appropriate BY or ACROSS field on every row in a report using the SET BYDISPLAY command. Although SET BYDISPLAY is supported for all output formats, it is especially important for making your 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 = {OFF|ON|BY|ACROSS|ALL}

where:

OFF

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

ON or BY

Displays the associated BY field value on every line of report output produced. BY is a synonym for ON.

ACROSS

Displays the relevant ACROSS field value on every column of report output produced.

ALL

Displays the relevant BY field value on every line of report output and the relevant ACROSS field value on every column of report output.

The BYPANEL parameter enables display of By fields in the left portion of each panel of a multi-panel report.

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.

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.

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.

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.

The CDN parameter specifies punctuation used in numeric 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:

DOTS_COMMA or ON uses CDN. 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.

Note: Numeric parameters that use CDN ON must be separated by a comma followed by a space in calls to functions.

COMMAS_DOT or 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.

SPACES_COMMA or 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.

SPACES_DOT or SPACEP sets the decimal point as a period and the thousands separator as a space. For example, the number 3,045,000.76 is represented as 3 045 000.76.

QUOTES_COMMA or 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.

QUOTES_DOT or 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.

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.

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.

A format conversion error occurs when a field described with a numeric USAGE format contains character values.

The CNVERR parameter controls whether the data engine replaces values that cause data truncation or conversion errors with the default value (null if the column is nullable, zero otherwise).

The syntax is:

SET CNVERR = {REJECT|IGNORE}

where:

REJECT

Does not process rows with incorrect data, and issues a warning message. This is the default value.

IGNORE

Accepts rows with incorrect data, and substitutes default values (null if the column is nullable, zero otherwise).

A format conversion error occurs when a field described with a numeric USAGE format contains character values.

The CNVERRLIMIT parameter sets a limit, up to 999999, for the number of records with warnings about data conversion errors.

The syntax is:

SET CNVERRLIMIT = {0|nnnnnn}

where:

nnnnnn

Is an integer value up to 999999. When the limit is reached, processing is terminated and the system variable FOCERRNUM is set to 1346. The default value, zero (0), allows unlimited format conversion errors.

The COLLATION parameter controls the ordering and matching of all language elements that involve comparison of two alphanumeric values.

The syntax is:

SET COLLATION = {BINARY|SRV_CI|SRV_CS|CODEPAGE}

where:

BINARY

Bases the collation sequence on binary values.

SRV_CI

Bases collation sequence on the LANGUAGE setting, and is case-insensitive.

SRV_CS

Bases collation sequence on the LANGUAGE setting, and is case-sensitive.

CODEPAGE

Bases collation sequence on the code page in effect, and is case-sensitive. CODEPAGE is the default value.

In most cases, CODEPAGE is the same as BINARY. The only differences are for Danish, Finnish, German, Norwegian, and Swedish in an EBCDIC environment.

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. ON is the default value.

OFF

Displays a blank or zero for a reformatted field.

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, active report, 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 With TIBCO WebFOCUS® Language 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, AHTML, 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.

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

The syntax is:

SET COMPUTE = {COMPILED|OLD}

where:

COMPILED

Implements expression compilation at request run time, compiling only those expressions that are used in the request. COMPILED is the default value.

OLD

The value OLD has been deprecated and functions as COMPILED.

The COUNTWIDTH parameter expands the default format of COUNT fields from a five-byte integer to a nine-byte integer or a specified integer format supported in your operating environment.

The syntax is:

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

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.

n

Enables you to specify a width for the COUNT field up to the maximum integer format supported in your operating environment.

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.

This parameter defines the position of the currency symbol relative to the monetary number.

The syntax is:

SET CURRENCY_DISPLAY = pos

where:

pos

Defines the position of the currency symbol relative to a number. The default value is default, which uses the position for the format and currency symbol in effect. Valid values are:

• LEFT_FIXED. The currency symbol is left-justified preceding the number.
• LEFT_FIXED_SPACE. The currency symbol is left-justified preceding the number, with at least one space between the symbol and the number.
• LEFT_FLOAT. The currency symbol precedes the number, with no space between them.
• LEFT_FLOAT_SPACE. The currency symbol precedes the number, with one space between them.
• TRAILING. The currency symbol follows the number, with no space between them.
• TRAILING_SPACE. The currency symbol follows the number, with one space between them.

Note: This setting is not supported with FORMAT EXL2K report output.

This parameter defines the ISO code for the currency symbol to use.

The syntax is:

SET CURRENCY_ISO_CODE = iso

where:

iso

Is a standard three-character currency code such as USD for US dollars or JPY for Japanese yen. The default value is default, which uses the currency code for the configured language code.

Note: This setting is not supported with FORMAT EXL2K report output.

This parameter defines what will happen when the currency symbol cannot be displayed by the code page in effect, if the format of the field to be displayed includes the !C or :C extended currency symbol.

The syntax is:

SET CURRENCY_PRINT_ISO = {DEFAULT|ALWAYS|NEVER}

where:

DEFAULT

Replaces the currency symbol with its ISO code when the symbol cannot be displayed by the code page in effect. This is the default value.

ALWAYS

Always replaces the currency symbol with its ISO code.

NEVER

Never replaces the currency symbol with its ISO code. If the currency symbol cannot be displayed by the code page in effect, it will not be printed at all.

Note:

• Using a Unicode environment allows the printing of all currency symbols, otherwise this setting is needed.
• This parameter is not supported with FORMAT EXL2K report output.

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 (').

• 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 shekel.

The CURSYM_D parameter specifies the characters used to represent currency when a numeric format specification uses the !D, :D, !d, or :d display options which, by default, display a floating (D) or fixed (d) dollar sign to the left of the number.

The syntax is:

SET CURSYM_D = currsym

where:

currsym

Specifies up to four printable characters.

The CURSYM_E parameter specifies the characters used to represent currency when a numeric format specification uses the !E, :E, !e, or :e display options which, by default, display a floating (E) or fixed (e) euro symbol to the left of the number.

The syntax is:

SET CURSYM_E = currsym

where:

currsym

Specifies up to four printable characters.

The CURSYM_F parameter specifies the characters used to represent currency when a numeric format specification uses the !F or :F display option which, by default, places a floating euro symbol to the right of the number. This command supports adding a blank space between the number and the currency symbol.

The syntax is:

SET CURSYM_F = currsym

where:

currsym

Specifies up to four printable characters. If the characters include a blank space, they must be enclosed in single quotation marks.

The CURSYM_G parameter specifies the characters used to represent currency when a numeric format specification uses the !G or :G display option which, by default, places a floating dollar sign to the right of the number. This command supports adding a blank space between the number and the currency symbol.

The syntax is:

SET CURSYM_G= currsym

where:

currsym

Specifies up to four printable characters. If the characters include a blank space, they must be enclosed in single quotation marks.

The CURSYM_L parameter specifies the characters used to represent currency when a numeric format specification uses the !L, :L, !l, or :l display options which, by default, display a floating (L) or fixed (l) British pound symbol to the left of the number.

The syntax is:

SET CURSYM_L = currsym

where:

currsym

Specifies up to four printable characters.

The CURSYM_Y parameter specifies the characters used to represent currency when a numeric format specification uses the !Y, :Y, !y, or :y display options which, by default, display a floating (Y) or fixed (y) Japanese yen or Chinese yuan symbol to the left of the number.

The syntax is:

SET CURSYM_Y = currsym

where:

currsym

Specifies up to four printable characters.

The CUSTOM-PAGE-LENGTH parameter sets the page length of a DHTML, PDF, or PPTX output report. Use this SET parameter with PAGESIZE=CUSTOM.

The syntax is:

CUSTOM-PAGE-LENGTH = number

where:

number

Depends on the UNITS parameter (inches, centimeters, points). The default value is 11 inches.

The CUSTOM-PAGE-WIDTH parameter sets the page width of a DHTML, PDF, or PPTX output report. Use this SET parameter with PAGESIZE=CUSTOM.

The syntax is:

CUSTOM-PAGE-WIDTH = number

where:

number

Depends on the UNITS parameter (inches, centimeters, points). The default value is 8.5 inches.

This parameter defines the order of date components for display.

The syntax is:

SET DATE_ORDER = {DEFAULT|DMY|MDY|YMD}

where:

DEFAULT

Respects the original order of date components. This is the default value.

DMY

Displays all dates in day/month/year order.

MDY

Displays all dates in month/day/year order.

YMD

Displays all dates in year/month/day order.

Note:

• DATE_ORDER overrides the specified date order for all date and date-time displays. To limit the scope to a request when using DATE_ORDER, use the ON TABLE SET phrase.
• To use this setting with the Dialogue Manager system variables, (for example, &DATE, &TOD, &YMD, &DATEfmt, and &DATXfmt) append the suffix .DATE_LOCALE to the system variable. This allows system variables that are localized to coexist with non-localized system variables.
• This parameter is not supported with FORMAT EXL2K report output.

This parameter defines the separator for date components for display.

The syntax is:

SET DATE_SEPARATOR = separator

where:

separator

Can be one of the following values.

• DEFAULT, which respects the separator defined by the USAGE format of the field.
• SLASH, which uses a slash (/) to separate date components.
• DASH, which uses a dash (-) to separate date components.
• BLANK, which uses a blank to separate date components.
• DOT, which uses a dot (.) to separate date components.
• NONE, which does not separate date components.

Note:

• DATE_SEPARATOR overrides the date separator for all date and date-time displays unless they include a translation display option (T,Tr, t, or tr), in which case the specified separator is produced.
• To use this setting with the Dialogue Manager system variables, (for example, &DATE, &TOD, &YMD, &DATEfmt, and &DATXfmt) append the suffix .DATE_LOCALE to the system variable. This allows system variables that are localized to coexist with non-localized system variables.
• This parameter is not supported with FORMAT EXL2K report output.

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:

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.

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

The syntax is:

SET DATEFNS = {ON|OFF}

where:

ON

Activates the date functions that support year-2000 dates. ON is the default value.

OFF

This value is no longer functional, and operates as ON.

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 the input format of a value 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.

The DATETIME parameter sets time and date in reports and controls the format in which CREATE SYNONYM creates date-time columns in a Master File.

The syntax is:

SET DATETIME = option

where:

option

Is one of the following:

• STARTUP, which is the time and date when you began your session. STARTUP is the default value.
• CURRENT|NOW, which 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, which freezes the date and time of the current run for the rest of the session or until another SET DATETIME command is issued.

The SET DB_INFILE command controls whether the expression generated by the DB_INFILE function for use against a relational data source is optimized.

The syntax is:

SET DB_INFILE = {DEFAULT|EXPAND_ALWAYS|EXPAND_NEVER}

where:

DEFAULT

Enables DB_INFILE to create a subquery if its analysis determines that it is possible. This is the default value.

EXPAND_ALWAYS

Prevents DB_INFILE from creating a subquery and, instead, expands the expression into IF and WHERE clauses in memory.

EXPAND_NEVER

Prevents DB_INFILE from expanding the expression into IF and WHERE clauses in memory and, instead, attempts to create a subquery. If this is not possible, a FOC32585 message is generated and processing halts.

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.

The DBAJOIN parameter controls where DBA restrictions are treated as WHERE conditions in the report request or are added as join conditions.

SET DBAJOIN = {OFF|ON}

where:

OFF

Treats DBA restrictions as WHERE filters in the report request. OFF is the default value.

ON

Treats DBA restrictions as join conditions.

The DBASOURCE parameter determines which security attributes are used to grant access to multi-file structures. By default, access restrictions are based on the host file in a JOIN structure or the last file in a COMBINE structure. If you set the DBASOURCE parameter to ALL, access restrictions from all files in a JOIN or COMBINE structure will be enforced.

All files in the JOIN or COMBINE structure must have the same DBA password. If the DBA attributes are not the same, there will be no way to access the structure.

The SET DBASOURCE command can only be issued one time in a session or connection. Any attempt to issue the command additional times will be ignored. If the value is set in a profile, no user can change it at any point in the session.

When DBASOURCE=ALL:

• In a TABLE request against a JOIN structure, access to a cross-reference file or segment is allowed only if the user has at least read access to each file in the structure.
• In a MODIFY COMBINE structure, the user must have a minimum of READ access to all files in the structure. The user requires WRITE, UPDATE, or READ/WRITE access to a file in the structure when an INCLUDE, DELETE, or UPDATE request is issued against that file.

When DBASOURCE=HOST:

• In a TABLE request, the user needs read access to the host file in the JOIN structure. All security limitations come from the host file. Note that you can create and activate a DBAFILE in order to enforce security restrictions from all files in the structure.
• In a MODIFY procedure, the user needs write access to the last file in the COMBINE structure. All security limitations come from the restrictions in the last file in the structure. Note that you can create and activate a DBAFILE in order to enforce security restrictions from all files in the structure.

The syntax is:

SET DBASOURCE = {HOST|ALL}

where:

HOST

Enforces access restrictions only from the host file in a JOIN structure or the last file in a COMBINE structure unless a DBAFILE is used to enforce access restrictions to other files in the structure. HOST is the default value.

ALL

Requires the user to have read access to every file in a JOIN or COMBINE structure. The user needs W, U, or RW access to a file in a COMBINE structure when an INCLUDE, UPDATE, or DELETE command is issued against that file.

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.

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

The syntax is:

SET DEFECHO = {OFF|ON|ALL|NONE}

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.

NONE

Prevents procedure code from being displayed (echoed). Once the value of DEFECHO or &ECHO has been set to NONE, it cannot be changed during the session or connection.

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

This parameter applies to Windows, z/OS, and UNIX operating systems only.

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. COMPILED is the default value.

OLD

The value OLD has been deprecated and functions as COMPILED.

The DIRECTHOLD parameter creates a HOLD file in FOCUS format directly, without an internally generated MODIFY procedure and an intermediate sequential file.

This parameter applies to Windows and UNIX operating systems only.

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 and the only value supported. OFF is allowed for backward syntax compatibility, but it operates the same way as ON.

OFF

OFF is allowed for backward syntax compatibility, but it operates the same way as ON.

The DISPLAYROUND parameter controls rounding of floating point and double-precision numbers for display. The default value, ON, adds a very small number (unit of least precision, or ULP) before displaying the number. This corrects the display of those numbers that round down instead of up because their binary value has the fraction one-half (.1), which may convert to the decimal fraction .49999... (instead of .50000). This only affects the display of the number, not its use in calculations or storage.

The syntax is:

SET DISPLAYROUND = {ON|OFF}

where:

ON

Corrects rounding errors in the display of floating point and double-precision numbers. This is the default value.

OFF

Does not correct rounding errors in the display of floating point and double-precision numbers.

The DMH_LOOPLIM parameter sets the maximum number of Dialogue Manager loop iterations allowed, using -REPEAT or -GOTO commands.

The syntax is:

SET DMH_LOOPLIM = n

where:

n

Sets the maximum number of loop iterations allowed. The default value is zero (0), which does not limit the number of loop iterations.

DMH_LOOPLIM should be set high enough to run your existing reports and procedures without error for your entire session. It is recommended that if you set this parameter, you set it in a profile.

The DMH_STACKLIM parameter sets the maximum number of lines allowed in FOCSTACK.

The syntax is:

SET DMH_STACKLIM = n

where:

n

Sets the maximum number of lines allowed in FOCSTACK. The default value is zero (0), which does not limit the number of stacked commands.

DMH_STACKLIM should be set high enough to run your existing reports and procedures without error for your entire session. It is recommended that if you set this parameter, you set it in a profile.

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.

The DRILLMETHOD parameter provides the ability to use a POST method, instead of the GET method for drill-down requests. POST is more secure than GET since the parameters and values are not shown on the URL or in logs. In addition, you are not limited to 2048 characters (2K) on the URL.

The syntax is:

SET DRILLMETHOD={HREF|POST|GET}

ON TABLE SET DRILLMETHOD={HREF|POST|GET}

where:

HREF

Calls the WebFOCUS Servlet and passes the name of the procedure. HREF is the default value.

POST

Does not show parameters and values in the URL or store them in the logs.

GET

Shows parameters and values in the URL and stores them in the logs.

Note:

• The DRILLMETHOD parameter is only supported for HTML and DHTML reports.
• With both the POST and GET methods, the parameters and values will be visible when you view the page source.

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|BODY|HEADING|ALL}

where:

OFF

Inserts system-generated blank lines as well as empty data lines. OFF is the default value.

ON|BODY

Removes system-generated blank lines within the body of the report, for example, before and after subheads. In addition, certain data lines that may be blank and appear as blank lines on the report output will be removed from the output. BODY is a synonym for ON.

HEADING

Removes the blank lines between headings and titles and between the report body and the footing. Works in positioned formats (PDF, PS, DHTML, PPT, PPTX) when a request has a border or backcolor StyleSheet attribute anywhere in the report.

ALL

Provides both the ON and HEADING behaviors.

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.

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.

The EMBEDDABLE parameter controls the generation of document-level HTML tags (such as, <html>, <head>, <body>) in HTML5 chart output. This enables multiple HTML5 charts to be embedded in an HTML page.

The syntax is:

SET EMBEDDABLE = {OFF|ON}

where:

OFF

Generates complete HTML report output with document-level HTML tags. This is the default value.

ON

Generates report output in HTML format without document-level tags. This setting should be used when creating HTML5 graph output to be used with -HTMLFORM.

Note: SET EMBEDDABLE=ON also affects HTML report output and Java-based graph formats. For those formats, it is the equivalent of using HOLD FORMAT HTMTABLE.

The EMBEDHEADING parameter controls whether the Heading and Footing text is rendered within or outside the chart image.

The syntax is:

SET EMBEDHEADING = {ON|OFF}

where:

ON

Renders the heading and footing text as part of the chart image.

OFF

Renders the heading and footing as text elements that are separate from the chart image. This is the default value.

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

The EQTEST parameter controls whether the characters $ and $* are treated as wildcard characters or normal characters in IF tests and WHERE tests that can be converted to one or more IF tests.

The syntax is:

SET EQTEST = {WILDCARD|EXACT}

where:

WILDCARD

Treats the $ and $* characters as wildcard characters. WILDCARD is the default value.

EXACT

Treats the $ and $* characters as normal characters, not wildcards, in IF tests and in WHERE tests that can be translated to IF tests.

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

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.

The ESTRECORDS parameter passes the estimated number of records to be sorted in the request.

ESTRECORDS can only be set with the ON TABLE SET command within the TABLE, MATCH, or GRAPH request.

The syntax is:

ON TABLE SET ESTRECORDS n

where:

n

Is the estimated number of records to be sorted.

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.

The EXCELSERVURL parameter specifies the application server to be used to zip the file components that comprise an EXCEL 2007 file (.xlsx).

The machine opening the file must have Excel 2007 or Excel 2003 with the Microsoft Office conversion utility installed. For Excel 2003, you must have the XLSX file type defined and should change the Save Report redirection setting in the WebFOCUS Administration Console to yes. For additional information and instructions for changing your redirection settings, see the TIBCO WebFOCUS Security and Administration manual.

The syntax is:

SET EXCELSERVURL = url

where:

url

Is the URL (up to 256 characters) of the context root of the WebFOCUS application on the application server where the WebFOCUS Client is installed.

For example,

http://hostname/ibi_apps//IBIEXCELSERVURL

In this example,

hostname

Is the name of the application server where the WebFOCUS Client is installed.

When included in the nlscfg.err file, 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.

For additional information on setting this width, see the National Language Support for International Computing manual.

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.

The EXL2KTXTDATE parameter allows you to specify that translated dates should be sent as date values with format masks instead of text values.

The syntax is:

SET EXL2KTXTDATE = {TEXT|VALUE}

where:

TEXT

Passes date values that contain text to Excel 2000 as formatted text. TEXT is the default value.

VALUE

Passes the types of translated date values that contain text and are supported Excel date formats to Excel 2000 as standard date values with text format masks applied.

Generates an Accordion Report that expands by column.

The syntax is:

SET EXPANDABLE = {OFF|ON}

where:

OFF

Does not create an Accordion Report. OFF is the default value.

ON

Creates an Accordion report that expands by column.

Generates an Accordion Report that expands by row.

The syntax is:

SET EXPANDBYROW = {OFF|ON|ALL|n}

where:

OFF

Does not create an Accordion Report. OFF is the default value.

ON

Creates an Accordion Report which initially displays only the highest sort field level. To see rows on lower levels, click the plus sign next to one of the displayed sort field values.

ALL

Creates an Accordion Report in which all sort field levels are initially expanded. To roll up a sort field level, click the minus sign next to one of the sort field values on that level.

n

Creates an Accordion Report in which n sort field levels are initially expanded. To roll up an expanded sort field level, click the minus sign next to one of the sort field values on that level.

Generates an Accordion Report, using the enhanced interface.

The syntax is:

SET EXPANDBYROWTREE = {OFF|ON|ALL|n}
ON TABLE SET EXPANDBYROWTREE {OFF|ON|ALL|n}

where:

OFF

Does not create an accordion report, with the enhanced interface. OFF is the default value.

ON

Creates an accordion report, with the enhanced interface. This setting initially displays only the highest sort field level. To see rows on lower levels, click the plus sign (+) next to one of the displayed sort field values.

ALL

Creates an accordion report, with the enhanced interface. This setting displays all sort field levels initially expanded. To roll up a sort field level, click the minus sign (-) row next to one of the sort field values on that level.

n

Creates an accordion report, with the enhanced interface. This setting displays then sort field levels initially expanded. To roll up an expanded sort field level, click the minus sign (-) next to one of the sort field values on that level.

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.

The EXTENDNUM parameter controls whether asterisks (*) display on report output when the value to be displayed does not fit in the allotted space on report output or whether the report column is extended to display the number.

The syntax is:

SET EXTENDNUM = {ON|OFF|AUTO}

where:

ON

Displays all numbers in full, regardless of the USAGE format defined.

OFF

Displays asterisks when the value does not fit in the space allotted by the USAGE format. This is the legacy behavior.

AUTO

Applies an ON or OFF setting based on output format and SQUEEZE settings, as shown in the following table.

Format	SQUEEZE Setting	EXTENDNUM
PDF, PS, DHTML, PPT, PPTX	ON OFF	ON OFF
HTML, EXL2K, XLSX	N/A	ON
WP, other delimited formats	N/A	OFF

AUTO is the default value.

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.

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.

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.

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

This parameter value is no longer operational. It now functions as the value NEW.

Both UNIX and WebFOCUS support uppercase, lowercase, and mixed case file names and directories. Since lowercase is the default in UNIX environments, WebFOCUS offers a way to automatically convert file names and directories to lowercase.

The syntax is:

SET FILECASE = {ACTUAL|LOWER}

where:

ACTUAL

Retains file names in uppercase, lowercase, or mixed-case, exactly as they are entered. When this setting is used, WebFOCUS looks for file names exactly as they are entered (uppercase, lowercase, or mixed-case).

LOWER

Converts uppercase or mixed-case names to lowercase. When this setting is used, WebFOCUS looks for file names in lowercase.

The SET FILECOMPRESS=ON command compresses PDF output files.

The syntax is:

SET FILECOMPRESS = {ON|OFF}

where:

ON

Compresses PDF output files.

OFF

Does not compress PDF output files. OFF is the default value.

This command applies to PDF output only. It is ignored by all other output formats, such as HTML and Excel.

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.

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:

*

Denotes 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 or all data sources (*). 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 or all data sources (*). OFF is the default value.

The FIXRETRIEVE parameter enables keyed retrieval from a fixed format sequential file, such as a HOLD file. That is, the retrieval process stops when an equality or range test on a key holds true.

The syntax is:

SET FIXRET[RIEVE] = {OFF|ON}

where:

ON

Enables keyed retrieval. ON is the default.

OFF

Disables keyed retrieval.

SET FLOATMAPPING enables you to take advantage of decimal-based precision numbers available in DB2 and Oracle, and extends that functionality to all numeric processing for floating point numbers. With this processing, you gain both precision, including improved rounding, and enhanced performance.

The syntax is

SET FLOATMAPPING = {D|M|X}

where:

D

Uses the standard double-precision processing. This is the default value.

M

Uses a new internal format that provides decimal precision for double-precision floating point numbers up to 16 digits.

X

Uses a new internal format that provides decimal precision for double-precision floating point numbers up to 34 digits.

Note: If the field is passed to a HOLD file, the internal data types X or M data type will be propagated to the USAGE and ACTUAL formats in the HOLD Master File.

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.

The FOCEXURL parameter runs and executes drill downs remotely. The drill down program can be on your local machine or on a remote machine.

The syntax is:

SET FOCEXURL = path

where:

path

Is the location of the WebFOCUS Servlet. The default path for Servlet is /ibi_apps/WFServlet.

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 that number.

The FOCHTMLURL parameter allows you to access resources with an alias other than /ibi_apps/ibi_html.

To generate an alias other than /ibi_apps/ibi_html on the WebFOCUS Reporting Server, use the SET FOCHTMLURL command to set the alias that will be generated instead of /ibi_apps/ibi_html.

This command will most likely be used in a server profile (EDASPROF.PRF) or in one of the WFS files (site.wfs) to establish a default setting for the installation.

The syntax is:

SET FOCHTMLURL=/my_html

where:

my_html

Is the alias other than /ibi_apps/ibi_html that is generated on the WebFOCUS Reporting Server. Can be defined with up to 260 characters.

This setting is no longer needed, but has been left in the product so that existing applications that still include 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.

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.)

The GRAPH-PPI parameter determines the resolution to use for server-side HTML5 chart output (formats XLSX, PPTX, PDF, DHTML, and PNG). Requires that the setting GRAPHENGINE=JSCHART. The syntax is:

SET GRAPH-PPI = n

where:

n

Is an integer from 72 to 1200 that specifies the output resolution in pixels-per-inch. The default value is 192. A higher number produces a larger output file.

In WebFOCUS, the GRAPHDEFAULT parameter controls whether the WebFOCUS default graph styles (such as default colors and data label placement) or the graph API default graph styles are used for rendering the graph.

The syntax is:

SET GRAPHDEFAULT = {ON|OFF}

where:

ON

Uses WebFOCUS graph default styles. ON is the default value.

OFF

Uses the graph API default styles.

As of WebFOCUS 8.0, this parameter has been deprecated. You can use InfoAssist to edit charts.

The syntax is:

SET GRAPHEDIT = SERVER

where:

SERVER

Generates a server-side graph. A GIF graph is created on the web server and the image is returned to the client in your browser. SERVER is the default.

The GRAPHENGINE parameter determines which version of the Java-based WebFOCUS graph engine is used. The syntax is:

SET GRAPHENGINE = {GRAPH53|NEW|JSCHART}

where:

GRAPH53|NEW

Is the WebFOCUS graph engine in Version 5 Release 3 and higher. GRAPH53 is the default value. NEW is a synonym for GRAPH53.

JSCHART

Creates server-side HTML5 chart output when the LOOKGRAPH value is PPTX, XLSX, PDF, DHTML, or PNG. This setting is activated by default if the chart request uses chart attribute syntax.

The GRAPHSERVURL parameter creates an image file of the graph by sending an HTTP request to a servlet. The image file is saved on the WebFOCUS Reporting Server, where it can be used as input for an embedded image in a PDF report. It does not require running Java on the WebFOCUS Reporting Server, only on the remote machine that runs the servlet. This will work on any platform that has TCP/IP support, including z/OS.

For more details, see the Creating Reports With TIBCO WebFOCUS® Language manual.

The syntax is:

SET GRAPHSERVURL = url

where:

url

Is the URL (up to 256 characters) of the graph servlet that creates the GIF file.

For example,

http://hostname/ibi_apps/IBIGraphServlet

In this example,

hostname

Is the name of the host where the server resides.

The GRID parameter draws a grid on the graph at the horizontal and vertical class marks.

The syntax is:

SET GRID = {ON|OFF}

where:

ON

Draws a grid of lines at the horizontal and vertical class marks on the graph.

OFF

Does not draw a grid of lines at the horizontal and vertical class marks on the graph. OFF is the default.

The GRMERGE parameter generates a three-dimensional graph that reflects all output data from a request containing multiple sort fields, or creates separate graphs that collectively reflect all output data. When GRMERGE is OFF, a request containing both a BY and an ACROSS phrase generates two graphs. When it is ON, one graph results.

The syntax is:

SET GRMERGE = {ON|OFF|ADVANCED}

where:

ON

Generates a single three-dimensional graph that reflects all output data. ON is the default.

OFF

Generates separate graphs that collectively reflect all output data.

ADVANCED

Turns on the advanced merge option. This option uses three parameters to determine how to merge the graphs:

• GRMULTIGRAPH, which specifies how many sort fields to use to create multiple graphs.
• GRLEGEND, which specifies how many sort fields to place on the graph legend.
• GRXAXIS, which specifies how many sort fields to display on the X-axis. GRXAXIS must be at least 1 in order to plot the graph. A value greater than one creates nested X-axes.

Note: The sum of the sort fields used by GRMULTIGRAPH, GRLEGEND, and GRXAXIS must equal the number of sort fields in the graph request.

The GRMULTIGRAPH parameter specifies how many sort fields to use to create multiple graphs when GRMERGE is set to ADVANCED.

The syntax is:

SET GRMULTIGRAPH = n

where:

n

Specifies how many sort fields (0 through 2) to use to break the output into multiple graphs. The outermost sort fields are used to separate the graphs. When n is greater than zero, this is similar to GRMERGE=OFF, but allows an additional sort field.

The GRWIDTH parameter applies to OLAP graphs and regular report requests. However, the parameter is not under user control in the OLAP Control Panel.

The syntax is:

SET GRWIDTH = {n|0}

where:

n

Is the width, in cells, of an HTML table in which a graph is displayed. Valid values are between 0 and 512. If the parameter is set to 0, a Java applet is generated displaying multiple graphs on one page, one beneath another. 0 is the default value.

The GTREND parameter specifies the use of basic linear regression to alter the X and Y axis values in a SCATTER graph. Basic linear regression involves the average of the summation of X and Y axis values to determine a linear equation that expresses the trend of the scatter diagram.

The syntax is:

SET GTREND={ON|OFF}

where:

ON

Uses basic linear regression to alter the X and Y axis values.

OFF

Does not alter the X and Y axis values. OFF is the default.

The HAUTO parameter performs automatic scaling of the horizontal axis for the given values. If HAUTO is OFF, the horizontal axis must be scaled using the HMAX and HMIN parameters. (See HMAX and HMIN.)

The syntax is:

SET HAUTO = {ON|OFF}

where:

ON

Scales the horizontal axis automatically. ON is the default.

OFF

Does not scale the horizontal axis automatically. The end user must supply values for HMAX and HMIN.

The HAXIS parameter specifies the width, in characters, of the horizontal axis. This parameter applies to graphs generated offline. HAXIS is ignored for online displays since WebFOCUS automatically adjusts the width of the graph to the width of the page.

The syntax is:

SET HAXIS = {n|770}

where:

n

Is the width, in characters, of the horizontal axis. Acceptable values are integers between 20 and 770. 770 is the default value.

The HCLASS parameter specifies the horizontal interval mark when AUTOTICK is OFF. See also HTICK.

The syntax is:

SET HCLASS = {n|.00}

where:

n

Is a number specifying the horizontal interval mark. The default value is .00.

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.

The HIDENULLACRS parameter hides the display of ACROSS groups containing only null columns.

Hiding null ACROSS columns is supported for all styled output formats except for the EXL2K PIVOT and EXL2K FORMULA options. It is not supported for Active Technologies.

The syntax is:

SET HIDENULLACRS = {ON|OFF}

where:

ON

Hides columns with missing data in ACROSS groups within a BY-generated page break.

OFF

Does not hide columns. OFF is the default value.

The HISTOGRAM parameter draws a histogram instead of a curve when the values on the horizontal axis are not numeric.

The syntax is:

SET HISTOGRAM = {ON|OFF}

where:

ON

Draws a histogram instead of a curve when the values on the horizontal axis are not numeric. ON is the default.

OFF

Draws a curve when the values on the horizontal axis are not numeric.

The HLDCOM_TRIMANV parameter controls whether trailing blanks are retained in AnV fields in delimited output files.

The syntax is:

SET HLDCOM_TRIMANV = {OFF|ON}

where:

OFF

Retains trailing blanks in AnV fields when the output is held in a delimited format. OFF is the default value.

ON

Removes trailing blanks in AnV fields when the output is held in a delimited format.

The HMAX parameter sets the maximum value on the horizontal axis when automatic scaling is not used (HAUTO=OFF).

The syntax is:

SET HMAX = {nnn|.00}

where:

nnn

Is the maximum value on the horizontal axis when HAUTO=OFF. The default value is .00.

The HMIN parameter sets the minimum value on the horizontal axis when automatic scaling is not used (HAUTO=OFF).

The syntax is:

SET HMIN = {nnn|.00}

where:

nnn

Is the minimum value on the horizontal axis when HAUTO=OFF. The default value is .00.

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.

The HOLDATTR parameter controls which 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.

Note: HOLDATTRS is a synonym for HOLDATTR.

The syntax is:

SET HOLDATTR = {ON|OFF|FOCUS|CUBE}

where:

ON

Includes the TITLE attribute from the original Master File in HOLD Master Files for HOLD files of any format. PROPERTY attributes are also propagated. 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. PROPERTY attributes are also propagated. FOCUS is the default value.

CUBE

Propagates folders and DV_ROLE attributes, as well as TITLE attributes to the HOLD Master File. It also propagates the field name as the alias value.

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.

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|EXPLICIT}

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

Includes all fields in the HOLD or PCHOLD file, including NOPRINTed BY fields.

EXPLICIT

Includes fields in the HOLD or PCHOLD file that are explicitly omitted from the report output using the NOPRINT option in the request, but does not include fields that are implicitly NOPRINTed. For example, if a field is reformatted in the request, two versions of the field exist, the one with the new format and the one with the original format, which is implicitly NOPRINTed.

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.

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

The syntax is:

SET HOLDSTAT = {ON|OFF|name}

where:

ON

Derives comments and DBA information from the holdstat.mas or errors.mas file in UNIX and Windows. In z/OS, this information is derived from the member HOLDSTAT in the PDS allocated to the ddname MASTER or ERRORS.

OFF

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

name

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

The HSTACK parameter stacks the bars on a histogram instead of placing them side by side.

The syntax is:

SET HSTACK = {ON|OFF}

where:

ON

Stacks the bars on a histogram.

OFF

Places the bars on a histogram side by side. OFF is the default.

The HTICK parameter sets the horizontal axis interval mark when AUTOTICK is OFF. See also HCLASS.

The syntax is:

SET HTICK = {nnn|.00}

where:

nnn

Is the horizontal axis interval mark when AUTOTICK=OFF. The default value is .00.

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.

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.

The HTMLEMBEDIMG parameter activates an encoding mechanism that embeds images and graphs directly into an HTML or DHTML .htm file to ensure that all WebFOCUS reports can be accessed from any browser.

The syntax is:

SET HTMLEMBEDIMG =  {OFF|ON|AUTO}

where:

OFF

Does not affect the default behavior. If HTMLARCHIVE is set ON, .mht files are generated.

ON

Encodes images within the .htm file.

AUTO

Determines how to handle images based on the browser of the calling client. For clients in Internet Explorer, HTMLARCHIVE will be used to embed the images into an .mht file. For all other browsers, HTMLEMBEDIMG will encode the image information into an .htm file. If the displaying browser is unknown, as in reports generated using ReportCaster, AUTO will use the HTMLARCHIVE setting that is in effect.

The HTMLENCODE parameter controls whether HTML tags are encoded when these tags are stored within the actual data or created using a DEFINE or COMPUTE command.

In a WebFOCUS report, HTMLENCODE=ON causes any text set in a string to be encrypted for transportation, and then decrypted to be displayed as written on a report. This is both for security and to ensure that special characters are displayed correctly.

The syntax is:

SET HTMLENCODE {ON|OFF}

where:

ON

Encodes the HTML output that is data. This setting disables the rendering of HTML tags within a browser when these tags are stored within the actual data or created using a DEFINE or COMPUTE command.

OFF

Disables HTML encoding. OFF is the default value.

Note: Because of the new format of the zipped XLSX files, native HTML symbols, such as a caret (<), cannot be supported as tag characters. For XLSX, unlike other output formats, HTMLENCODE defaults to ON. HTMLENCODE set to OFF will cause any data containing HTML tag characters to be omitted from the cell.

The INDEX parameter determines the indexing scheme used for indexes. Indexes are fields specified with FIELDTYPE=I keywords in the Master Files. This parameter applies to indexes created in FOCUS data sources using early WebFOCUS releases.

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.

The JOIN_LENGTH_MODE (JOINLM) parameter controls processing of equality joined field pairs for the record oriented Adapters (such as VSAM, DFIX, and FIX). There are two supported modes of handling compatible but not identical joined fields:

• SQL compliance. The JOIN command processor assures strict value equality of joined fields. Detected truncation of significant characters during host to cross-referenced conversion raises a target not found condition. A shorter host field value is extended to the length of cross-referenced field with non-significant characters according to the data type.
• FOCUS reporting. The JOIN command processor assures partial value equality of joined fields.
  • When joining a shorter to a longer field, a search range is created to find all cross-referenced values that are prefixed with the host value (partial key join).
  • When joining a longer to a shorter field, the host value is unconditionally truncated to the cross-referenced field length.

The syntax is:

SET JOIN_LENGTH_MODE = {SQL|RANGE}

where:

SQL

Sets SQL compliant mode. Assures strict equality of host and cross-referenced fields. This is the default value.

RANGE

Sets FOCUS reporting mode. Supports partial key joins.

The JOINOPT parameter has two functions:

• Correcting for lagging values with a unique join. 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.
• Enabling joins with data type conversion. You can join two or more data sources containing different numeric data types. For example, you can join a field with a short packed decimal format to a field with a long packed decimal format, or a field with an integer format to a field with a packed decimal format. This provides enormous flexibility for creating reports from joined data sources.

The syntax is:

SET JOINOPT = {NEW|GNTINT|OLD}

where:

NEW

Corrects lagging values when a parent segment has multiple unique children. Also, enables joins with data type conversion.

GNTINT

Corrects lagging values when a parent segment has multiple unique children. Also, enables joins with data type conversion.

OLD

Does not correct lagging values or support joins with data type conversion. This is the default value.

The SET JPEGENCODE command allows you to select the compression methodology.

The syntax is:

SET JPEGENCODE=[FLATE|DCT]

where:

FLATE

Fixed quality defined

Is a compression method, introduced in WebFOCUS Release 7.7 Version 03, which allows images within PDF files to be individually compressed. This method is the default for WebFOCUS Release 7.7 Version 03 through WebFOCUS Release 7.7 Version 06.

DCT

Discrete Cosine Transform

Is a compression method, introduced in WebFOCUS Release 8.2 Version 01, which allows for the designation of the percentage of quality to retain. This method is the default in WebFOCUS Release 8.2 Version 01 and higher.

Note: In some images, quality loss is not noticeable when higher degrees of compression are applied. Generally, the higher the compression applied, the lower the image quality. Use SET JPEGQUALITY with the DCT setting to set the quality value.

The SET JPEGQUALITY command allows you to select image quality.

The syntax is:

SET JPEGQUALITY=n

where:

n

Is the percentage of quality used with the DCT setting. This value can be from 1-100. The default value is 100, where no quality is lost and minimal compression is applied.

The JSURLS parameter includes JavaScript or VBScript files in an HTML report (TABLE request) or graph request that generates HTML output. This allows you to customize the display of WebFOCUS HTML reports or graphs with any JavaScript or VBScript functions. The JavaScript and VBScript files are the last files loaded, and are loaded in the order they are listed, allowing complete customization of the HTML page.

In addition, when a WebFOCUS report or graph is run, a set of pre-defined JavaScript functions is invoked. Some of these functions apply to all WebFOCUS reports, others are specific to OLAP, Web Services and Table of Contents reports. Using JSURLS you can disable or modify these default functions. To view the full set of pre-defined JavaScript functions, see /ibi/WebFOCUSxx/ibi_apps/ibi_html/javaassist/ibi/html/js/ibigl.js.

The syntax is:

SET JSURLS='/file1 [/file2] [/file3]...'

where:

/file1 [/file2] [/file3]...

Are the files that contain JavaScript or VBScript. If there is more than one js file, the delimiter is a blank and the values must be enclosed in single quotes. Files must be in a location that is accessible by the web server.

You can reference files with a URL.

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.

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.

The LANG[UAGE] parameter specifies the National Language Support (NLS) environment. It sets the language of server 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 With TIBCO WebFOCUS® Language manual and the TIBCO WebFOCUS® Describing Data for FOCUS 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

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.

Displays report output from right to left for supported formats.

The syntax is:

SET LAYOUTRTL = {ON|OFF}

where:

ON

Displays report output from right to left.

OFF

Displays report output from left to right. OFF is the default value.

Leading zeros are truncated in Dialogue Manager strings. The functions in WebFOCUS, 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.

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|.250}

where:

value

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

The LINES parameter sets the maximum number of lines of printed output that appear on a page, from the heading to the footing.

It sets the maximum number of lines that appear on a logical page, from the heading at the top to the footing on the bottom. The value of LINES can range between 1 and 999999. For styled output formats, specify 999 or higher to generate continuous forms. When continuous forms are specified, but the output format has a physical page size (as is the case with PDF output), the column titles repeat at the top of the physical page, without page numbers. For unstyled output formats, specify 999999 for continuous forms.

WebFOCUS will generate HEADING and FOOTING text after each group of lines as defined with the SET parameter.

The syntax is:

SET LINES = {n|57}

where:

n

Is the maximum number of lines of output that appear on a logical page. 57 is the default value.

The LOOKGRAPH parameter specifies a graph style. This can be a number of variations of area, bar, histogram, and pie charts, among other graph styles.

The syntax is:

SET LOOKGRAPH = option

where:

option

Specifies a graph style. An extensive number of graph styles is available for WebFOCUS. For a complete list, see the Creating Reports With TIBCO WebFOCUS® Language manual.

The MATCHCOLUMNORDER parameter controls how fields in MATCH FILE requests are sequenced in the MATCH output. The new default method groups fields across files with their sort field values in the resulting HOLD file regardless of their position within the MATCH request. The old legacy method appends them to the HOLD file record as they are referenced in the request.

The syntax is:

SET MATCHCOLUMNORDER = {GROUPED|UNGROUPED}

where:

GROUPED

Groups verb objects with their highest-level common sort keys. This can result in the fields being propagated to the HOLD file in a different order from the legacy process. This can affect a subsequent request against the MATCH results if that request uses the default alias names generated in the HOLD Master File. This typically occurred when fields with the same name, not used as keys, were merged together with MATCH. The advantage of the new technique is that it supports HOLD file formats such as FORMAT FOCUS that generate an associated Master File.

UNGROUPED

Does not group verb objects with their sort keys across files when laying out the resulting HOLD file record. Fields are appended to the HOLD file record as they are referenced in the request.

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={0|maxexcpt}

where:

maxexcpt

Is a one to four-digit number that represents how many data exceptions can occur before the session is terminated. The value zero (0) allows an unlimited number of data exceptions, and is the default value. 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.

The MAXLRECL parameter defines the maximum record length for an external file that can be read. 0 is the default value. However, WebFOCUS can read a 12K lrecl 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.

Note: MAXLRECL is character-based, not byte-based. In a Unicode environment, three bytes is used to represent each character on UNIX and Windows, and four bytes is used to represent each character on z/OS. If you are using a double-byte character set, each character uses two bytes.

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.

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.

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

WebFOCUS 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:

• Only one MDI can be referred to at a time.
• Only dimensions that are part of the same parent-child hierarchy can be used simultaneously in a request. A dimension that is not part of a parent-child relationship can be used as the field in a request if it has a MAXVALUES attribute.

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.

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.

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.

When a virtual field or calculated value can have missing values, you can specify whether all or some of the field values used in the expression that creates the DEFINE or COMPUTE field must be missing to make the result field missing. If you do not specify ALL or SOME for a DEFINE or COMPUTE with MISSING ON, the default value is SOME.

The SET parameter MISS_ON enables you to specify whether SOME or ALL should be used for MISSING ON in a DEFINE or COMPUTE that does not specify which to use.

The syntax is:

SET MISS_ON = {SOME|ALL}

where:

SOME

Indicates that if at least one field in the expression has a value, the temporary field has a value (the missing values of the field are evaluated as 0 or blank in the calculation). If all of the fields in the expression are missing values, the temporary field has a missing value. SOME is the default value.

ALL

Indicates that if all the fields in the expression have values, the temporary field has a value. If at least one field in the expression has a missing value, the temporary field has a missing value.

By default, when an IF-THEN-ELSE expression is used to calculate a result and the IF expression evaluates to zero (for numeric expressions) or blank (for alphanumeric expressions), the left hand side is checked to see if it has MISSING ON. If it does, the result of the expression will be MISSING, not true or false, and the outcome returned will be MISSING, not the result of evaluating the THEN or ELSE expression, if the field only needs some missing values. You can use the SET MISSINGTEST command to eliminate the missing test for the IF expression so that either the THEN expression or the ELSE expression will be evaluated and returned as the result.

The syntax is:

SET MISSINGTEST = {NEW|OLD|SPECIAL}

where:

NEW

Excludes the IF expression from the missing values evaluation so that it results in either true or false, not MISSING. If it evaluates to true, the THEN expression is used to calculate the result. If it evaluates to false, the ELSE expression is used to calculate the result. This is the default.

OLD

Includes the IF expression in the missing values evaluation. If the IF expression evaluates to MISSING, the result is also MISSING, if the missing field only needs some missing values.

SPECIAL

Is required for passing parameters to RStat.

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 With TIBCO WebFOCUS® Language manual).

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 With TIBCO WebFOCUS® Language manual). The COMPOUND setting does not generate the (FOC144) warning message. COMPOUND is the default value.

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.

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.

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.

The OFFLINE-FMT parameter determines the format of printed report output generated from a request.

The syntax is:

SET OFFLINE-FMT = option

where:

option

Is one of the following:

STYLED formats the report according to the active StyleSheet.

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

For an OLAP graph that has multiple BY fields, or a BY and ACROSS field, determines whether these graphs are merged into a single graph.

The syntax is:

SET OLAPGRMERGE={ON|OFF}

where:

ON

Turns on the merge graph option. With this setting, AUTODRILL is disabled for the graph.

OFF

Turns off the merge graph option and creates a separate graph for every value of the outer sort field. OFF is the default value.

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 that was used prior to WebFOCUS Version 5 Release 3.4.

The syntax is:

SET OLDSTYRECLEN = {ON|OFF}

where:

ON

Determines that LRECL=512.

OFF

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

The ONFIELD parameter determines whether ON phrases that refer to fields not present in the request are ignored or cause the request to terminate. Allowing ON phrases for absent fields enables user selections at run time to determine which elements are included in each execution of the request.

Note that any field used must be present in the Master File for the data source or the following message is generated and execution terminates:

The syntax is:

SET ONFIELD = {ALL|IGNORE}

ON TABLE SET ONFIELD {ALL|IGNORE}

where:

ALL

Issues a message and terminates execution when a field referenced in an ON phrase is not present in the request. ALL is the default value.

IGNORE

Ignores ON phrases that reference fields that are not present in the request as well as ON phrases that include options not supported by the type of field specified.

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. HTML is the default.

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 specifies that the report will be displayed using a legacy character-based and line-based layout and a monospaced font.

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

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.

The OVERFLOWCHAR parameter controls the characters displayed in a numeric report column when the column does not provide enough space to display its value. The number of overflow characters displayed is the same as the length assigned to the field. By default, the displayed overflow character is the asterisk (*).

The syntax is

SET OVERFLOWCHAR = 'char'

where:

char

Is a single byte displayable character. Depending on the character specified, it may not need to be enclosed in single quotation marks (').

The following characters are not supported as the overflow character: numeric digits, comma, period, apostrophe, percent sign, minus sign, space, current currency symbol, dollar sign, Yen symbol, Pound Sterling sign, and Euro symbol. In addition, other symbols may have significance in your operating environment.

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 logical page. When PAGE is set to NOPAGE, the LINES parameter controls where column headings are printed. You can use NOLEAD in place of NOPAGE.

The PAGE-SCALE parameter scales PDF report output to fit across the width of the page instead of producing separate panels.

By default, if PDF report output is too wide to fit on a single page, the report generates multiple panels of the same page for the columns that do not fit. The page numbers specify the page and panel numbers. For example, page numbers 1.1 and 1.2 represent page 1/panel 1 and page 1/panel 2.

The syntax is:

SET PAGE-SCALE = {OFF|AUTO}

where:

OFF

Disables page scaling in PDF report output. This is the default value.

AUTO

Implements page scaling in PDF report output.

The PAGESIZE parameter specifies the paper size for report pages.

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.

CUSTOM enables you to set a custom page size for a DHTML, PDF, or PPTX report.

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.

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.

Note: The PANEL parameter affects only character-based output format. All other output formats that are not character-based ignore the PANEL parameter (HTML, AHTML, EXL2K) or perform their own paneling (PDF). To be effective, the PANEL parameter requires that SET ONLINE-FMT=STANDARD or SET ONLINE-FMT=STYLED.

When using a statistical function, you must establish the size of the partition on which the function will operate, if the request contains sort fields. You can do this using the PARTITION_ON command.

The syntax is:

SET PARTITION_ON = {FIRST|PENULTIMATE|TABLE} 

where:

FIRST

Uses the first (also called the major) sort field in the request to partition the values.

PENULTIMATE

Uses the next to last sort field where the COMPUTE is evaluated to partition the values. This is the default value.

TABLE

Uses the entire internal matrix to calculate the statistical function.

The PASS parameter enables user access to a data source or stored procedure protected by DBA 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 DBA database security.

filename

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

The PCOMMA parameter controls the retrieval of comma-delimited files.

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 = option

where:

option

Can be one of the following:

• ON, which enables the retrieval of comma-delimited data sources created by a PC application, in which 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. It can also retrieve comma-delimited data sources in which alphanumeric data is not enclosed in double quotation marks and each record is terminated with a comma and dollar sign.
• OFF, which 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.
• DFIX, which causes delimited files with SUFFIX=COM, COMT, TAB, and TABT to be processed through the Adapter for DFIX. This processing provides more complete and meaningful messages and some changes to the processing of missing values when two delimiters in a row are encountered. With DFIX processing, a missing value is assigned to the field.

  In order to be eligible for DFIX processing, the delimited file must satisfy the following requirements.

  • Each record must be completely contained on one line and terminated with the crlf (carriage return/linefeed) character combination.
  • The ENCLOSURE can be only in the first position after the delimiter for COM (new) and COMT records. Otherwise, it will not be recognized.
  • The number of fields on a line cannot exceed the number of fields defined in the Master File.

The PCTFORMAT parameter controls whether fields prefixed with the operators PCT., RPCT., and PCT.CNT. display with a percent sign or with the format associated with the original field.

The syntax is:

SET PCTFORMAT = {OLD|PERCENT}

where:

OLD

Displays columns prefixed with PCT., RPCT., and PCT.CNT. with the format associated with the original field.

PERCENT

Displays columns prefixed with PCT., RPCT., and PCT.CNT. with a percent sign. It also allows the prefixed fields to be reformatted. This is the default value.

PCT.CNT.field will always display with two decimal places, unless reformatted. For PCT.field and RPCT.field, with SET PCTFORMAT = PERCENT, if the original field has a:

• Precision-based format (F, D, M, X), the column will display with length 7 and two decimal places.
• Packed format, the column will display with its original number of decimal places.
• Integer format, the column will display with no decimal places.

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.

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 EDASPROF because it would then apply to all users.

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.

The PHONETIC_ALGORITHM parameter sets a phonetic algorithm to use with the PHONETIC function, which calculates an index for alphanumeric values such as names, based on their pronunciation, so that words that have variations in spelling can be grouped together.

The syntax is:

SET PHONETIC_ALGORITHM = {METAPHONE|SOUNDEX}

where:

METAPHONE

Uses the Metaphone algorithm for indexing. Metaphone is suitable for use with most English words, not just names. Metaphone algorithms are the basis for many popular spell checkers. METAPHONE is the default algorithm, except on z/OS.

Note: Metaphone is not optimized in the SQL sent to a relational DBMS. Therefore, if you need to optimize the request for an SQL DBMS, the SOUNDEX value should be used.

SOUNDEX

Soundex is a legacy phonetic algorithm for indexing names by sound, as pronounced in English. SOUNDEX is the default algorithm on z/OS.

The POPUPDESC parameter enables you to view a pop-up field description in an HTML report when your mouse pointer is positioned over a column title in the report output.

The syntax is:

SET POPUPDESC = {ON|OFF}

where:

ON

Enables pop-up field descriptions.

OFF

Deactivates pop-up field descriptions. OFF is the default value.

The PPTXGRAPHTYPE attribute enhances the quality of charts embedded into PowerPoint (PPTX) slides. You can use the PNG output format to enhance the image and text quality and support transparency. This is useful for a number of important scenarios, including use of templates with background color and for overlapping a chart with other components and drawing objects.

The syntax is:

SET PPTXGRAPHTYPE={PNG|PNG_NOSCALE|JPEG}

where:

PNG

Scales the PNG image to twice its dimensions to get significantly improved quality. This may cause problems if you have non-scalable items in the chart, such as text with absolute point sizes (including embedded scales headings). The output file is also larger due to the larger bitmap. Text within the chart is noticeably sharper than the legacy JPEG format.

PNG preserves font sizes in the chart when it is internally rescaled for increased resolution. It converts absolute font sizes set in the StyleSheet (*GRAPH_SCRIPT) to sizes expressed in virtual coordinates (which are relative to the dimensions of the chart) and generates font sizes for embedded headings and footings in virtual coordinates.

PNG_NOSCALE

Renders in PNG, but does not scale. This produces slightly better quality than JPEG. Going from JPEG to PNG_NOSCALE makes the chart sharper, but has only a slight effect on the text.

JPEG

Indicates legacy format. This is the default value.

The PRFTITLE parameter generates descriptive column titles for prefixed fields. These column titles have readable and translatable descriptions of the prefix operators.

The syntax is:

SET PRFTITLE = {SHORT|LONG}

where:

SHORT

Places the prefix operator name above the field name to generate the column title.

LONG

Generates descriptive column titles for prefixed fields that can be translated to other languages.

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 a browser. ONLINE is the default value.

OFFLINE

Sends report output to the system printer or to a file. Output can also be sent to a file labeled with the online ddname using the FILEDEF command.

The handling of DST operators has been improved to support multiple DST operators in the same request, and the ability to use DST with ACROSS.

With these improvements, you can control the behavior of requests that use the PRINT command with multiple DST operators to achieve independent DST values. To implement this functionality, set the PRINTDST parameter to NEW.

The syntax is:

SET PRINTDST = {OLD|NEW}

where:

OLD

Processes multiple DST operators in a PRINT request as nested BY fields, making them dependent on each other. OLD is the default value.

NEW

Processes multiple DST operators in a PRINT request as totally independent objects.

The PRINTPLUS parameter introduces printing enhancements. PRINTPLUS is not supported with StyleSheets.

The syntax is:

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

where:

ON

Handles page breaks internally to provide the correct spacing of pages. You can perform RECAPs in cases where pre-specified conditions are met. Additionally, a SUBFOOT prints above the footing instead of below it.

OFF

Does not support StyleSheets. OFF is the default value.

The PSPAGESETUP parameter causes the paper source used by a PostScript printer to match the PAGESIZE parameter setting. It enables the PAGESIZE and ORIENTATION parameter settings, which determine the size and orientation of the paper. If PSPAGESETUP is set to OFF, the settings for PAGESIZE and ORIENTATION are ignored.

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.

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.

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.

The RANK parameter determines how rank numbers are assigned when a request contains the [RANKED] BY [HIGHEST|LOWEST] n phrase and multiple data values fall into the same rank category. If the rank number for the next group of values is the next sequential integer, the ranking method is called dense. If the rank number for the next group of values is the previous rank number plus the number of multiples, the ranking method is called sparse.

The syntax is:

SET RANK = {DENSE|SPARSE}

where:

DENSE

Specifies dense ranking. With this method, each rank number is the next sequential integer, even when the same rank is assigned to multiple data values. DENSE is the default value.

SPARSE

Specifies sparse ranking. With this method, if the same rank number is assigned to multiple data values, the next rank number will be the previous rank number plus the number of multiples.

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.

The RECORDLIMIT parameter limits the number of records retrieved or displayed.

The syntax is:

SET RECORDLIMIT = {RECORDLIMIT|OUTPUTLIMIT}

where:

RECORDLIMIT

In a request with a RECORDLIMIT filter (WHERE RECORDLIMIT EQ n or IF RECORDLIMIT EQ n), limits the records displayed on the report output to the number of reads specified in the filter. RECORDLIMIT is the default.

OUTPUTLIMIT

In a request with a RECORDLIMIT filter (WHERE RECORDLIMIT EQ n or IF RECORDLIMIT EQ n), applies the RECORDLIMIT filter to the number of records displayed in the final output.

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|.250}

where:

value

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

The RPAGESET parameter controls how the number of lines per logical page are determined when output contains text created with SUBFOOT and a field value created with RECAP.

The syntax is:

SET RPAGESET = {NEW|OLD}

where:

NEW

Sets the number of lines per logical page equal to the LINES value plus two plus the number of the highest BY field with a SUBFOOT.

OLD

Sets the number of lines per logical page equal to the value of the LINES parameter. See LINES for details. OLD is the default.

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. 10 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.

The SAVEMATRIX parameter saves the matrix from your request to protect it from being overwritten when using Dialogue Manager commands.

The syntax is:

SET SAVEMATRIX = {ON|OFF}

where:

ON

Saves the internal matrix from the last report request, preventing it from being overwritten.

OFF

Overwrites the internal matrix for each request. OFF is the default.

The SHADOW parameter is only useful for activating the Absolute File Integrity feature for FOCUS database files.

The syntax is:

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

where:

ON

Activates the 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.

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.

The SHORTPATH parameter controls how screening conditions against missing cross-referenced segment instances are processed in a left outer join.

In WebFOCUS, the command SET ALL = ON or JOIN LEFT_OUTER specifies a left outer join. With a left outer join, all records from the host file display on the report output. If a cross-referenced segment instance does not exist for a host segment instance (called a short path), the report output displays missing values for the fields from the cross-referenced segment. However, the fields are not assigned missing values for testing purposes.

If there is a screening condition on the dependent segment, those dependent segment instances that do not satisfy the screening condition are omitted from the report output, and so are their corresponding host segment instances. With missing segment instances, tests for missing values fail because the fields in the segment have not been assigned missing values.

When a relational engine performs a left outer join, it processes host records with missing cross-referenced segment instances slightly differently from the way WebFOCUS processes those records when both of the following conditions apply:

• There is a screening condition on the cross-referenced segment.
• A host segment instance does not have a corresponding cross-referenced segment instance.

When these two conditions are true, WebFOCUS omits the host record from the report output, while relational engines supply null values for the fields from the dependent segment and then apply the screening condition. If the missing values pass the screening condition, the entire record is retained on the report output. This type of processing is useful for finding or counting all host records that do not have matching records in the cross-referenced file or for creating a DEFINE-based join from the cross-referenced segment with the missing instance to another dependent segment.

If you want WebFOCUS to assign null values to the fields in a missing segment instance when a left outer join is in effect, you can issue the command SET SHORTPATH=SQL.

SET SHORTPATH = {FOCUS|SQL}

where:

FOCUS

Omits a host segment from the report output when it has no corresponding cross-referenced segment and the report has a screening condition on the cross-referenced segment.

SQL

Supplies missing values for the fields in a missing cross-referenced segment in an outer join. Applies screening conditions against this record and retains the record on the report output if it passes the screening test.

Note: There must be an outer join in effect, either as a result of the SET ALL=ON command or a JOIN LEFT_OUTER command (either inside or outside of the Master File).

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.

The SORTMATRIX parameter controls whether to employ in-memory sorting with decreased use of external memory. The syntax is

SET SORTMATRIX = {SMALL|LARGE}

where:

SMALL

Creates a single sort matrix of up to 2048 rows, and uses a binary search based insertion sort with aggregation during retrieval. The maximum number of rows in this matrix has been determined to provide the best performance for this type of sort. If the sort matrix becomes full, it is written to a file called FOCSORT on disk, the in-memory matrix is emptied, and retrieval continues, writing to FOCSORT as many times as necessary. When the end of data is detected, the remaining rows are written to FOCSORT and the merge routine merges all of the sort strings in FOCSORT (which, in extreme cases, may require multiple merge phases), while also completing the aggregation.

LARGE

Creates a large matrix or multiple small matrices in memory, when adequate memory is available as determined by the SORTMEMORY parameter. LARGE is the default value. The goal of this strategy is to do as much sorting as possible in internal memory before writing any records to disk. Whether disk I/O is necessary at all in the sorting process depends on the amount of memory allocated for sorting and the size of the request output. If the amount of SORTMEMORY is not large enough to meaningfully make use of the LARGE strategy, the sort will default to the SMALL strategy. The LARGE strategy greatly reduces the need for disk I/O and, if disk I/O is required after all (for very large output), it virtually eliminates the need for multiple merge phases.

The SORTMEMORY parameter controls the amount of internal memory available for sorting. The syntax is:

SET SORTMEMORY = {n|512}

where:

n

Is the positive number of megabytes of memory available for sorting. The default value is 512.

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 one to two 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 one and eight.

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.

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.

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. OFF is the default value.

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).

In WebFOCUS, the %STRICTMATH parameter determines the behavior of a calculation when dividing by zero.

The syntax is:

SET %STRICTMATH = {'OLD'|'NEW'}

where:

OLD

Returns zero when a value is divided by zero. This value must be enclosed in single quotation marks (').

NEW

Returns zero when a value is divided by zero. The following error message is produced in the HTML source of the report output.

(FOC201) INTERRUPT. DIVISION BY ZERO

NEW is the default and must be enclosed in single quotation marks (').

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

In WebFOCUS, this 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.

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 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

Creates an HTML table using the default proportional font defined in the browser for the end user. ON is the default.

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

Creates a preformatted report using the default fixed font defined in the browser for the end user.

For a PDF or Postscript report, this uses the settings for LINES and WIDTH. The settings for UNITS, TOPMARGIN, BOTTOMMARGIN, LEFTMARGIN, RIGHTMARGIN, PAGESIZE, ORIENTATION, and SQUEEZE are ignored.

This is used when the STYLE parameter is set in an ON TABLE command. It indicates that StyleSheet commands follow and are embedded in the procedure.

The SUBTOTALS parameter specifies whether summary lines are displayed above or below the detail lines in a report. The summary commands affected include SUBTOTAL, SUB-TOTAL, RECOMPUTE, SUMMARIZE, COMPUTE, RECAP, and COLUMN-TOTAL.

The syntax is:

SET SUBTOTALS {ABOVE|BELOW}

where:

ABOVE

Places summary lines above the detail lines and displays the sort field values on every detail line of the report output.

BELOW

Places summary lines below the detail lines. BELOW is the default value.

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 = {NEW|OLD|EXPLICIT}

where:

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. NEW is the default value.

OLD

This value is no longer supported. It processes as NEW.

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.

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|MIN|MAX}

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.

MIN

Displays the minimum value in the sort order set by your server code page and configuration when alphanumeric or smart date data types are aggregated.

MAX

Displays the maximum value in the sort order set by your server code page and configuration when alphanumeric or smart date data types are aggregated.

A DATETIME field used in a drill-down will be passed using the DT function. An invalid date-time value error will occur if the called procedure also uses the DT function, as it will be specified twice. The SUPPRESSDRILLDT = ON parameter eliminates the double DT.

The syntax is:

SET SUPPRESSDRILLDT = {ON|OFF}

where:

ON

Suppresses the double DT prefixes.

OFF

Does not suppress the double DT prefixes. OFF is the default value.

The TARGETFRAME parameter includes the HTML code <BASE TARGET="framename"> in the heading of the HTML file that is displayed in your browser. All drill-down hyperlinks from the base report or graph 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 webpage in which the output from the drill-down hyperlink (either a FOCEXEC or URL) is displayed. Possible values include standard HTML frame names, such as, _blank, _self, _parent, _top, or a user-defined name.

In WebFOCUS, the TEMP parameter assigns temporary files to a specific directory.

The syntax is:

SET TEMP = directory

where:

directory

Is the directory to which all temporary files are assigned.

The TEMPERASE parameter determines if the temporary files created during a WebFOCUS connection are retained after the connection is closed. Applies to HOLD files and other files that may be created during the session.

The syntax is:

SET TEMPERASE = {ON|OFF}

where:

ON

Erases any temporary files after the WebFOCUS connection is closed. ON is the default.

OFF

Keeps any temporary files created during a WebFOCUS connection.

The TESTDATE parameter temporarily alters the system date in order to test a dynamic window allowing you to simulate clock settings to determine the behavior of your program. Only use TESTDATE for testing purposes with test data. The value of TESTDATE affects all reserved variables that retrieve the current date from the system. Setting TESTDATE also affects anywhere in FOCUS that a date is used (such as CREATE, MODIFY, MAINTAIN) but does not affect the date referenced directly from the system.

TESTDATE can either be equal to TODAY or a date in the format YYYYMMDD. If anything else is entered the following message is displayed:

TESTDATE MUST BE YYYYMMDD OR TODAY

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.

This parameter defines the separator for time components for the&TOD system variable.

The syntax is:

SET TIME_SEPARATOR = {DOT|COLON}

where:

DOT

Uses a dot (.) to separate time components. This is the default value.

COLON

Uses a colon (:) to separate time components.

The TITLELINE parameter controls underlining of column titles on report output.

The syntax is:

SET {TITLELINE|ACROSSLINE} = {ON|OFF|SKIP}

where:

ON

Underlines column titles on report output. ON is the default value.

OFF

Replaces the underline with a blank line.

SKIP

Specifies no underline and no blank line.

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, 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, 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, creates the column heading using both the prefix operator and the field name.

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|.250}

where:

value

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

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).

The USER parameter enables user access to a data source or stored procedure protected by DBA 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 DBA security.

The USERFCHK parameter controls the level of verification applied to DEFINE FUNCTION arguments and WebFOCUS-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 a profile or procedure.

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.

Note: We strongly recommend that you not use this option, as disabling parameter checking can lead to unexpected issues.

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.

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 WebFOCUS.

The syntax is:

SET USERFNS= {SYSTEM|LOCAL}

where:

SYSTEM

Gives precedence to functions supplied by WebFOCUSand 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.

The VAUTO parameter performs automatic scaling of the vertical axis for the given values. If VAUTO is OFF, the vertical axis must be scaled using the VMAX and VMIN parameters. (See VMAX and VMIN.)

The syntax is:

SET VAUTO = {ON|OFF}

where:

ON

Scales the vertical axis automatically. ON is the default.

OFF

Does not scale the horizontal axis automatically. The end user must supply values for VMAX and VMIN.

The VAXIS parameter applies to graphs generated offline.

It specifies the length of the vertical axis, in lines. VAXIS is ignored for online displays since WebFOCUS automatically adjusts the length of the graph to the height of the terminal.

The syntax is:

SET VAXIS = {n|405}

where:

n

Is the page length, in lines. Valid values are integers between 20 and 405. The default value is 405.

The VCLASS parameter specifies the vertical interval mark when AUTOTICK is OFF. See also VTICK.

The syntax is:

SET VCLASS = {nnn|0}

where:

nnn

Is the vertical interval mark.

0

Specifies zero as the vertical interval mark. The default value is 0.

The VGRID parameter draws a grid at the horizontal and vertical class marks of the graph. See also GRID.

The syntax is:

SET VGRID = {ON|OFF}

where:

ON

Draws a grid at the horizontal and vertical class marks of the graph.

OFF

Does not draw a grid. OFF is the default.

The VISBARORIENT parameter enables you to set horizontal or vertical orientation for visualization bars for ACROSS columns.

This parameter is only supported for HTML output.

The syntax is:

SET VISBARORIENT = {H|V} 

where:

H

Indicates horizontal bar orientation for visualization bars.

V

Indicates vertical bar orientation for visualization bars. This is the default value.

The VMAX parameter sets the maximum value on the vertical axis when automatic scaling is not used (VAUTO=OFF).

The syntax is:

SET VMAX = {nnn|.00}

where:

nnn

Is the maximum value on the vertical axis when VAUTO is OFF. The default value is .00.

The VMIN parameter sets the minimum value on the vertical axis when automatic scaling is not used (VAUTO=OFF).

The syntax is:

SET VMIN = {nnn|.00}

where:

nnn

Is the minimum value on the vertical axis when VAUTO is OFF. The default value is .00.

The VTICK parameter sets the vertical axis interval mark when AUTOTICK is OFF. See also VCLASS.

The syntax is:

SET VTICK = {nnn|.00}

where:

nnn

Is the vertical axis interval mark. The default value is .00.

The VZERO parameter treats missing values on the vertical axis as zeros. When VZERO is off, these values are ignored.

The syntax is:

SET VZERO = {ON|OFF}

where:

ON

Treats missing values as zeros. ON is the default.

OFF

Ignores missing values.

The WARNING parameter suppresses (FOC441) warnings. The file exists already. Create will overwrite it.

The syntax is:

SET WARNING = {ON|OFF}

where:

ON

Turns on warning messages. On is the default.

OFF

Turns off warning messages.

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).

The WEBVIEWALLPG parameter controls whether the WebFOCUS Viewer displays the All Pages button.

The syntax is:

SET WEBVIEWALLPG = {OFF|ON}

or

ON TABLE SET WEBVIEWALLPG {OFF|ON}

where:

ON

Displays the All Pages button. ON is the default value.

OFF

Does not display the All Pages button.

The WEBVIEWCLMSG parameter controls whether the WebFOCUS Viewer Close message displays when the Close option is clicked.

The syntax is:

SET WEBVIEWCLMSG = {ON|OFF|CLOSE}

where:

ON

Displays the Close message string in WebFOCUS language translation file (XXwebfoc_strings.Ing), where XX is the two character language abbreviation.

For example, ENwebfoc_strings.lng is the English language translation file. ON is the default value.

OFF

Does not display the Close message. The display page is specified by the WEBVIEWHOME parameter, which will display a blank page if it is not set.

CLOSE

Does not display the Close message and closes the browser window displaying the ODP report.

The WEBVIEWCLOSE parameter specifies whether the Close option is displayed on the WebFOCUS Viewer control bar.

The syntax is:

SET WEBVIEWCLOSE = {ON|OFF}

where:

ON

Displays the Close option. ON is the default value.

OFF

Does not display the Close option.

The WEBVIEWER parameter enables on-demand paging, and invokes the WebFOCUS Viewer. The first page of report output is displayed in the WebFOCUS Viewer while the remaining pages remain on the web or application server until requested by the user.

The syntax is:

SET WEBVIEWER = {ON|OFF}

where:

ON

Enables on-demand paging. The first page of report output is displayed in the WebFOCUS Viewer, while the remaining pages remain on the web/application server until requested by the user.

OFF

Sends all report output to your browser. The report output displays in a standard browser window. OFF is the default value.

The WEBVIEWHELP parameter controls whether the WebFOCUS Viewer displays the Help button.

The syntax is:

SET WEBVIEWHELP = {OFF|ON}

or

ON TABLE SET WEBVIEWHELP {OFF|ON}

where:

ON

Displays the Help button. ON is the default value.

OFF

Does not display the Help button.

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.

Note: For more information on enabling accessibility, see ACCESSIBLE.

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 for reports that do not have accessibility enabled.

_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. This is the default for reports that have accessibility enabled.

Note: When SET ACCESSIBLE = 508, the default for ODP is WEBVIEWTARG = OFF. For more information on enabling accessibility, see ACCESSHTML and Section 508 Accessibility in WebFOCUS.

The WEBVIEWTITLE parameter defines the title text for the window containing the WEBVIEWER instance.

The syntax is:

SET WEBVIEWTITLE='text'

or

ON TABLE SET WEBVIEWTITLE 'text'

where:

text

Is the title text for the Web Viewer window, enclosed in single quotation marks (').

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 TIBCO WebFOCUS® 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.

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.

The XLSXPAGEBRKIGNORE parameter controls whether page breaks in WebFOCUS format XLSX report output insert Excel page breaks at the same location in the output.

The syntax is:

SET XLSXPAGEBRKIGNORE = {OFF|ON}

where:

OFF

Synchronizes WebFOCUS page breaks with Excel page breaks in format XLSX report output. This is the default value.

ON

Does not synchronize WebFOCUS page breaks with Excel page breaks in format XLSX report output. This value conforms to behavior in prior releases.

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.

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.