Types of SET Parameters

In this section:

This topic lists the types of tasks that can be accomplished, and the SET parameters that allow you to perform these tasks. If a single parameter applies to more than one activity, it appears in more than one category. For more detailed descriptions, as well as the syntax for each parameter, see SET Parameter Syntax.

The following are the types of tasks performed with SET parameters.

Calculations

Affects the way calculations are performed in FOCUS.

Data and Metadata

Determines the way data is stored and processed.

Date Manipulation Tasks

Controls the way dates are processed and displayed in reports.

Graph Tasks

Controls the processing and display of graphs.

Memory Setup and Optimization Tasks

Affects the memory and optimization of your application.

Report Code, Content, and Processing Tasks

Determines the content and processing of a request.

Report Layout and Display Tasks

Affects the display of a report.

Security Tasks

Controls user access to data sources and procedures.

Terminal Tasks

Specifies the options for display in your terminal.

Calculations

The following parameters control the behavior of calculations in FOCUS.

AGGR[RATIO]

Determines the ratio of aggregation based on retrieved records and the final size of the answer set.

CDN

Specifies the punctuation used in numeric notation.

COMPUTE

Controls the compilation of expressions.

DMPRECISION

Specifies precision of numeric values in Dialogue Manager -SET commands to calculate accurate numeric variable values.

MODCOMPUTE

Controls compilation of MODIFY calculations.

USERFCHK

Controls the level of verification applied to DEFINE FUNCTION arguments and Information Builders-supplied function arguments.

USERFNS

Determines whether an Information Builders-supplied function or a locally-written function with the same name used.

Data and Metadata

The following parameters determine the way data is stored and processed.

ACCBLN

Accepts blank or zero values for fields with ACCEPT commands in the Master File.

ASNAMES

Controls the FIELDNAME attribute in a HOLD Master File.

BLKCALC

Enables system-determined blocking for HOLD files written to DASD.

COUNTWIDTH

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

DATEFORMAT

Specifies the order of the date components (month/day/year) when date-time values are entered in a formatted-string or translated-string format.

DEFINES

Compiles virtual fields into machine code to improve performance.

DIRECTHOLD

Controls whether HOLD Files in FOCUS format are created directly.

DTSTRICT

Controls the use of strict processing for date-time fields.

EQTEST

Controls whether the characters $ and $* are treated as wildcard characters or normal characters in selection criteria.

EUROFILE

Activates the data source that contains information for the currency you want to convert.

FIELDNAME

Controls the use of long and qualified field names.

FOCALLOC

Automatically allocates FOCUS files.

HIPERFOCUS

Activates HiperFOCUS.

HIPERINSTALL

Installs or disables HiperFOCUS.

HLDCOM_TRIMANV

Controls whether trailing blanks are retained when the output is held in a delimited format.

HNODATA

Controls missing values propagated to a HOLD file.

HOLDFORMAT

Determines the default format for HOLD files.

HOLDLIST

Determines what fields in a report request are included in the HOLD file.

HOLDMISS

Distinguishes between missing data and default data (zeros or blanks) in a HOLD file.

HOLDSTAT

Determines if comments and DBA information are included in HOLD Master Files.

HTMLARCHIVE

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

HTMLENCODE

Encodes data within HTML output.

INDEX

Is the indexing scheme used for indexes.

KEEPDEFINES

Controls whether a virtual field created for a host or joined structure is retained after a JOIN command is run.

MASTER

Enables use of blank delimited (Fusion) Master File syntax, and provides increased enforcement of syntax rules in comma delimited Master File syntax.

MAXDATAEXCPT

Enables you to change the number of data exceptions allowed before the session is terminated.

MAXLRECL

Specifies the maximum length of a record described with the Master File OCCURS attribute.

MDICARDWARN

Displays a warning message when the cardinality of a dimension exceeds a specified value.

MDIENCODING

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

MDIPROGRESS

Displays messages about the progress of an MDI build.

MINIO

Determines whether a block is read more than once when reading or writing to a file.

NULL

Enables creation of a variable-length comma or tab delimited HOLD file that differentiates between a missing value and a blank string or zero value.

OLDSTYRECLEN

Determines whether the record length, LRECL, is set to the current setting of LRECL=0, or the older setting of LRECL=512.

PCOMMA

Enables retrieval of comma delimited files created by a PC application or HOLD FORMAT COM command.

PREFIX

Specifies the prefix of existing data sets automatically allocated by FOCUS.

QUALCHAR

Specifies the qualifying character to be used in qualified field names.

RANK

Determines how rank numbers are assigned in a request when multiple data values fall into the same rank category.

SAVEDMASTERS

Saves a Master File to memory after it has been used in a request.

SHADOW

Activates the Absolute File Integrity feature.

SHIFT

Controls the use of shift strings.

SUSI

See Simultaneous Usage Reference Manual for z/OS.

SUTABSIZE

See Simultaneous Usage Reference Manual for z/OS.

TRACKIO

Gathers more pages to fill a track before reading or writing the pages to disk.

WEBARCHIVE

Packages multiple EXL2K files into a single file.

WEEKFIRST

Specifies what day of the week is the start of the week.

WIDTH

Used for communication between 3270 terminals and the operating system.

WPMINWIDTH

Specifies a minimum width for format WP output files.

XRETRIEVAL

Controls the retrieval of data when previewing a report.

XFOCUSBINS

Defines the number of pages of memory to use as buffers for XFOCUS data sources.

Date Manipulation Tasks

The following parameters control the way dates are processed and displayed in reports.

BUSDAYS

Specifies which days are considered business days and which are not.

DATEDISPLAY

Controls the display of a base date

DATEFNS

Activates year 2000-compliant versions of date subroutines.

DATETIME

Sets date and time in reports .

DEFCENT

Defines a default century for your application.

EXL2KTXTDATE

Controls whether translated dates are sent as date values with format masks instead of text values.

HDAY

Specifies the holiday file from which to retrieve dates that are considered holidays.

LEADZERO

Avoids the truncation of leading zeros.

TESTDATE

Temporarily alters the system date in order to test a dynamic window.

YRTHRESH

Defines the start of a 100-year window.

Developer Studio-Specific Tasks

The following parameters control your Developer Studio environment and the display of your reports in Developer Studio.

MESSAGE

Controls the display of informational messages.

PAGESIZE

Specifies the page size for printed output.

PRINT

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

SHIFT

Controls the use of shift strings.

FUSE

Specifies files that contain user-defined functions.

MORE

Controls scrolling. ON cases display to pause when screen is full. OFF allows continuous scrolling.

WARNING

Turns off warning messages.

SORT

Sets name of file for foreign languages. The default is English.

PRINTPLUS

 

VIEWER MAX

VIEWERMULT

VIEWER PAUSE

VIEWERZOOM

Controls the Report and Desktop Viewers.

Graph Tasks

The following parameters control the processing and display of graphs. For information about these parameters, see the Creating Reports Manual.

AUTOTICK

Sets the tick mark intervals for graphs.

BARNUMB

Places summary numbers at the end of bars on bar charts, or slices on pie charts.

BARSPACE

Specifies the number of lines separating the bars on bar charts.

BARWIDTH

Specifies the number of lines per bar on bar charts.

BSTACK

Specifies whether bar chart bars are stacked or placed side by side.

DEVICE

Specifies the plotting device or terminal to be used.

FRAME

For GDDM graphics, indicates if you want a frame around your graph.

GCOLOR (or GRIBBON)

Depending on device type, determines black and white or color patterns or ribbons used.

GMISSING

Specifies whether variables with the value specified in GMISSVAL are to be ignored.

GMISSVAL

Specifies the variable value that represents missing data.

GPROMPT

Specified whether FOCUS should prompt for graph parameters.

GRIBBON

Same as GCOLOR.

GRID

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

GTREND

Specifies the use of basic linear regression to alter the X and Y axis values in a SCATTER graph.

HAUTO

Performs automatic scaling of the horizontal axis for the given values.

HAXIS

Specifies the width, in characters, of the horizontal axis.

HCLASS

Specifies the horizontal interval mark when AUTOTICK is OFF.

HISTOGRAM

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

HMAX

Sets the maximum value on the horizontal axis when automatic scaling is not used (HAUTO=OFF).

HMIN

Sets the minimum value on the horizontal axis when automatic scaling is not used (HAUTO=OFF).

PAUSE

Specifies whether there is a pause for paper adjustment on the plotter after the request is executed.

PIE

Specifies a pie chart.

PLOT

Specifies the width and height settings for certain devices.

PRINT

Specifes whether the graph is printed or displayed on the terminal.

TERM[INAL]

Specifies the plotting device or terminal to be used.

VAUTO

Performs automatic scaling of the vertical axis for the given values.

VAXIS

Specifies the length of the vertical axis, in lines.

VCLASS

Specifies the vertical interval mark when AUTOTICK is OFF.

VGRID

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

VMAX

Sets the maximum value on the vertical axis when automatic scaling is not used (VAUTO=OFF).

VMIN

Sets the minimum value on the vertical axis when automatic scaling is not used (VAUTO=OFF).

VTICK

Sets the vertical axis interval mark when AUTOTICK is OFF.

VZERO

Treats missing values on the vertical axis as zeros.

Memory Setup and Optimization Tasks

The following parameters control the memory and optimization of your application.

AUTOINDEX

Retrieves data faster by automatically taking advantage of indexed fields in a FOCUS data source.

AUTOPATH

Dynamically selects an optimal retrieval path.

AUTOSTRATEGY

Determines when FOCUS stops the search for a key field specified in a WHERE or IF test.

BINS

Specifies the number of pages of memory used for data source buffers.

CACHE

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

COMPUTE

Controls the compilation of expressions.

DEFINES

Compiles virtual fields into machine code to improve performance.

DMH_LOOPLIM

Controls the number of loop iterations allowed in Dialogue Manager.

DMH_STACKLIM

Controls the number of lines allowed in FOCSTACK.

ESTRECORDS

Passes the estimated number of records to be sorted in the request.

FIXRETRIEVE

Enables keyed retrieval from a fixed format sequential file, such as a HOLD file.

FOCSTACK

Specifies the amount of space, in thousands of bytes, used by FOCUS commands waiting for execution.

HLISUTRACE

Records the last 20 events that the FOCUS Database Server performed.

HLISUDUMP

Is used for debugging FOCUS Database Server problems.

IBMLE

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

IMMEDTYPE

Tells FOCUS where to send line mode output.

SQLTOPTTF

Enables the SQL Translator to generate TABLEF commands instead of TABLE commands.

SUWEDGE

Keeps Master Files on a FOCUS Database Server open between requests.

TEMPDIR

In Developer Studio, assigns temporary files to a specific directory.

ZIIP

Enables you to offload specific categories of FOCUS processing to a zIIP specialty engine.

Report Code, Content, and Processing Tasks

The following parameters affect the content or processing of a report.

ALL

Handles missing segment instances in a report.

ALLOWCVTERR

Controls the display of a row of data that contains an invalid date format.

ASNAMES

Controls the FIELDNAME attribute in a HOLD Master File.

AUTOTABLEF

Avoids creating the internal matrix based on the features used in the query.

BUSDAYS

Specifies which days are considered business days.

CARTESIAN

Generates a report containing all combinations of non-related data instances in a multi-path request containing a PRINT or LIST command.

CDN

Specifies punctuation used in numeric notation.

CENT-ZERO

Displays a leading zero in decimal-only numbers.

COLLATION

Controls ordering of alphanumeric values.

COMPMISS

Controls whether the missing attribute is propagated to reformatted fields in a report request.

COMPUTE

Controls the compile of expressions.

DATEDISPLAY

Controls the display of date format fields that contain the value zero.

DATEFNS

Activates year 2000-compliant versions of date subroutines.

DATETIME

Sets date and time in a report.

DBAJOIN

Controls whether DBA restrictions are treated as report filters or are added to the join conditions.

DB_INFILE

Controls whether the expression generated by the DB_INFILE function for use against a relational data source is optimized.

DEFCENT

Defines a default century for your application.

DEFECHO

Defines a default value for the &ECHO variable for your application.

EMPTYREPORT

Controls the output generated when a report request retrieves zero records.

ERROROUT

Terminates a request and returns a message when an error is encountered.

ESTRECORDS

Passes the estimated number of records to be sorted in the request.

EXL2KLANG

Specifies the language used for Microsoft® Excel requests. This language must be the same as the language of Excel on the browser machine.

EXTAGGR

Enables aggregation in an external sort.

EXTHOLD

Enables you to use an external sort to create HOLD files.

EXTRACT

Activates Structured HOLD Files for a request.

EXTSORT

Activates the external sorting feature.

FIELDNAME

Controls the use of long and qualified field names.

FILE[NAME]

Specifies a file to be used, by default, in commands.

FILTER

Activates declared filters.

FOC144

Suppresses warning message FOC144, which reads Warning Testing in Independent sets of Data.

FORMULTIPLE

Allows you to include the same value of a FOR field in multiple rows of the FML matrix.

HNODATA

Controls missing values propagated to a HOLD file.

HOLDATTR[S]

Includes the TITLE and ACCEPT attributes from the original Master File in the HOLD Master File.

HLDCOM_TRIMANV

Controls whether strict equality is required or partial key joins are supported for record-oriented adapters. JOINLM is a synonym for JOIN_LENGTH_MODE.

JOINOPT

Ensures proper alignment of report output by correcting for lagging (missing) values. Also enables joins between fields with different numeric data types.

KEEPDEFINES

Controls whether a virtual field created for a host or joined structure is retained after a JOIN command is run.

LANG[UAGE]

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 Description contains alternate language TITLE attributes.

LEADZERO

Avoids the truncation of leading zeros.

MATCHCOLUMNORDER

Controls whether MATCH requests use grouped or ungrouped processing.

MESSAGE

Controls the display of informational messages.

MULTIPATH

Controls whether a parent segment is included in report output when selection tests are done on independent paths.

NODATA

Determines the character string that indicates missing data in a report.

ONFIELD

Controls whether ON phrases are ignored for fields not referenced in a request.

PAUSE

Pauses before displaying a FOCUS report on the terminal.

PFnn

Assigns a function to a PF key.

PDFLINETERM

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

PRINTDST

Controls processing of reports that use the PRINT command in conjunction with multiple DST operators.

QUALCHAR

Specifies the qualifying character to be used in qualified field names.

SAVEMATRIX

Saves the matrix from your request to protect it from being overwritten when using Dialogue Manager commands.

SHORTPATH

Controls how tests against missing cross-referenced segment instances are processed in a left outer join.

SORTLIB

Tells FOCUS which sort package is installed at your site.

SUMMARYLINES

Permits the combination of fields with and without prefix operators on summary lines in one request.

SUMPREFIX

Allows users to choose the answer set display order when using an external sort to perform aggregation of alphanumeric or smart date formats.

TITLES

Uses predefined column titles in the Master File as column titles in report output.

Report Layout and Display Tasks

The following parameters affect the layout and display of a report.

Security Tasks

The following parameters specify user access to data sources and procedures.

DBACSENSITIV

Controls whether password validation is case-sensitive.

DBASOURCE

Controls the source of access restrictions in a multi-file structure.

PASS

Enables user access to a data source or stored procedure protected by Information Builders security.

PERMPASS

The PERMPASS parameter establishes a user password that remains in effect throughout a session or connection.

USER

In FOCUS, enables user access to a data source or stored procedure protected by Information Builders security.

Terminal Tasks

The following parameters specify options for display in your terminal.

DISPLAY

Is the PC display mode selection.

EXTTERM

Enables the use of extended terminal attributes.

HOTMENU

Automatically displays the Hot Screen PF key legend at the bottom of the Hot Screen report.

SBORDER

Generates a solid border on the screen for full-screen mode.

SCREEN

Selects the Hot Screen facility.

TRMOUT

Suppresses all output messages to the terminal.

 


Information Builders