A. Environment Variables : Environment Variables for All Platforms
 
Share this page                  
Environment Variables for All Platforms
The following environment variables apply to OpenROAD on all platforms:
IIW4GL_DEBUG_3GL
Specifies that OpenROAD produces a trace listing of all 3GL procedures (defined in the Component Catalog) as they are called during execution. This can be useful for debugging.
II_4GL_DECIMAL
Specifies the decimal point character used for 4GL source input. Valid values are “.” and “,”. This variable is different from II_DECIMAL, which OpenROAD uses for data representation and database access, so you must set both to completely change the decimal point character.
Default: “.”
II_CHARSET
Specifies the name of a character set file used for string operations.
Important!  After Ingres is installed, you cannot change the character set from its current setting (II_CHARSET) at any time without risking the corruption of your data.
Ingres-supported character sets are as follows:
Character Set
Description
Format
ALT
Support of Cyrillic on DOS
Single byte
ARABIC
Arabic-449-Plus
Single byte
CHINESET
Traditional Chinese - Taiwan
Double byte
CHINESES
Simplified Chinese - PRC
Double byte
CHTBIG5
Traditional Chinese - Taiwan, BIG5
Double byte
CHTEUC
Traditional Chinese - Taiwan, EUC
Double byte
CHTHP
Traditional Chinese - Taiwan, HP ROC15
Double byte
CSGB2312
Simplified Chinese - GB2312
Double byte
CSGBK
Simplified Chinese - GBK
Double byte
CW
Cyrillic on Windows 3.1
Single byte
DECMULTI
DEC Multinational (superset of ASCII) and default for VMS
Single byte
DOSASMO
IBM DOS ASMO Arabic (cp708)
Single byte
ELOT437
Greek for PC/RS6000/SCO-UNIX
Single byte
GREEK
DEC Greek Elot
Single byte
HEBREW
DEC Hebrew
Single byte
HPROMAN8
HP Roman8 (superset of ASCII)
Single byte
IBMPC437
IBM PC Code Page 437 (US and English)
Single byte
IBMPC850
IBM PC Code Page 850 (Multilingual), includes accented characters
Single byte
IBMPC866
IBM PC 866 (Cyrillic for DOS)
Single byte
IS885915
ISO 8859/2 (Latin and some Greek). Identical to ISO 8859/1 Latin, except for eight characters, including the Euro currency symbol (€, Unicode U+20AC).
Single byte
ISO88591
ISO 8859/1 Latin and default for UNIX (superset of ASCII)
Single byte
ISO88592
8859/5 (Latin and Cyrillic)
Single byte
ISO88595
8859/9 (Latin and some Turkish) CP 920
Single byte
ISO88599
ISO 8859/15 (Latin and Euro sign)
Single byte
KANJIEUC
Japanese, EUC
Double byte
KOI18
KOI 8-bit (ISO 6937/8), Russia
Single byte
KOREAN
Korean
Double byte
PC857
IBM PC Code page 857 - Turkish
Single byte
PCHEBREW
IBM PC / MSDOS Hebrew
Single byte
SHIFTJIS
Shift-JIS Japanese
Double byte
SLAV852
IBM PC Code Page 852 (Slavic)
Single byte
THAI
DEC Thai Tis
Single byte
UTF8
Unicode encoding form UTF-8
Multi-byte
WARABIC
Arabic
Single byte
WHEBREW
Microsoft Windows Hebrew
Single byte
WIN1250
Eastern Europe: Windows page 1250
Single byte
WIN1252
Windows code page 1252 - Latin 1 (Western Europe) and default for Windows
Single byte
WTHAI
IBM/Windows Thai (cp874)
Single byte
Default: the default internal character set
For more information, see How You Can Use International Characters (see How You Can Use International Characters).
II_CHARSETxx
Specifies the name of a character set file for this OpenROAD installation. The xx suffix is the value of the II_INSTALLATION variable. If you do not define II_INSTALLATION, II_CHARSET is used instead. Default and valid values are the same as for II_CHARSET.
Important!  The value of II_CHARSETxx is set during installation and cannot be changed without corrupting data.
For more information, see How You Can Use International Characters.
II_COLORTABLE
Specifies the name of a color table file in the “files” directory of the OpenROAD installation. If neither II_COLORTABLE nor II_COLORTABLE_FILE is given, the default is wdepth4.ctb or wdepth8.ctb for Windows and depth4.ctb or depth8.ctb for UNIX, depending on the pixel depth of the display being used. Displays with fewer than 256 colors (such as 64 or 16) use the depth4 files; displays with 256 or more use the depth8 files. Specifying II_COLORTABLE_FILE overrides this variable.
For more information, see How You Can Specify Color Tables (see How You Can Specify Color Tables).
II_COLORTABLE_FILE
Specifies the full path specification of a color table file. If you do not set this, OpenROAD uses II_COLORTABLE instead.
II_CONFIG
Specifies the full location for a variety of configuration and message files used by OpenROAD and Ingres. These files include symbol.tbl, which holds other environment variable settings. These files are opened in both read-only and read-write modes. You must have read-write permissions for the directory that this variable specifies. You can set this environment variable using symbol.tbl. You can also redirect log files using II_LOG.
Default:
Windows:
%II_SYSTEM%\ingres\files
UNIX:
$II_SYSTEM/ingres/files
II_DATE_FORMAT
Specifies the date format for DATE values retrieved by a database access. This is different from the display formatting you can use to show DATE values in a form. It is defined installation-wide.
If set, it replaces the default format (the US setting) with an alternative format. The following are valid II_DATE_FORMAT settings and their output formats:
Setting
Output Format
US (default)
dd-mm-yyyy
MULTINATIONAL
dd/mm/yy
MULTINATIONAL4
dd/mm/yyyy
ISO
yymmdd
ISO4
yyyymmdd
SWEDEN or FINLAND
yyyy-mm-dd
GERMAN
dd.mm.yy
YMD
yyyy-mmm-dd
DMY
dd-mmm-yyyy
MDY
mmmm-dd-yyyy
For example, if the II_DATE_FORMAT setting is ISO, the dates are output as yymmdd. If you enter a date using a similar, six-character format, such as mmddyy, the date is interpreted on output as yymmdd. For example, if you enter the date March 9, 1912, as 030912 (mmddyy) and II_DATE_FORMAT is set to ISO, this date is interpreted as Sept. 12, 1903 (030912 as yymmdd). If the date you entered cannot be interpreted as a valid date in the output format, you receive an error message.
Note:  When using the _date4() function (MULTINATIONAL4), the output format for the year value always returns ‘yyyy’.
Default: US
II_DECIMAL
Specifies the decimal point character for floating and decimal data values retrieved by database access. It specifies the character used to separate fractional and non-fractional parts of a number. This variable is set installation-wide.
Valid characters are the period (.) (as in 12.34) or the comma (,) (as in 12,34). This is different from II_4GL_DECIMAL, which OpenROAD uses for 4GL source, so you must set both variables to completely change the decimal point character.
Default: “.” (period)
Note:  If II_DECIMAL is set to comma, be sure that when SQL syntax requires a comma (such as a list of table columns or SQL functions with several parameters), that the comma is followed by a space. For example:
select col1, ifnull(col2, 0), left(col4, 22) from t1:
II_EDIT
Specifies the location and file name of a system editor that OpenROAD uses instead of its own Script Editor for viewing or editing scripts
II_FONT_CONVENTION
Specifies a font convention file that describes mappings for font names. OpenROAD provides these files in the “files” directory of the OpenROAD installation.
To use one of these files, specify its name (without the .ff suffix) as the value of II_FONT_CONVENTION. Also see the II_FONT_FILE variable.
II_FONT_FILE
Specifies a font convention file that describes mappings for font names. If this file does not have the suffix .ff or is not located in the “files” directory of the OpenROAD installation, specify the path and full file name as the value of II_FONT_FILE.
II_FORCE_C_CONVENTION
Specifies that OpenROAD always uses the C language calling convention when calling your 3GL procedures, regardless of the language setting in the 3GL Procedure component editor. This is necessary for Windows.
Default: the language given by the 3GL procedure definition
II_INSTALLATION
Specifies a network installation code used by many subsystems of OpenROAD. It is also referred to as an instance ID. Valid values are up to three alphabetic characters, or one alphabetic and one numeric character (for example, “II” or “IJ2”).
This variable is typically set during OpenROAD installation. If you install OpenROAD and another Ingres toolset on the same computer, the values of II_INSTALLATION for the two installations must be different.
Default: the empty string for some things and II for others
II_KEYBOARD
Specifies the name of a keyboard mapping file contained in the “files” directory of your OpenROAD installation. For more information, see Speed Key Mapping (see Speed Key Mapping) and II_KEYBOARD (see II_KEYBOARD). See also the II_KEYBOARD_FILE variable.
II_KEYBOARD_FILE
Specifies the full path and file name of a keyboard mapping file that either does not have the default .kbd suffix or does not reside in the “files” directory of your OpenROAD installation. Specifying this variable overrides the II_KEYBOARD variable. For more information, see Speed Key Mapping (see Speed Key Mapping) and II_KEYBOARD_FILE (see II_KEYBOARD_FILE).
II_LANGUAGE
Specifies the language this OpenROAD installation uses for screen messages, menu items, and prompts. This variable determines the default location of the message text files and other things. Possible values are:
ENGLISH English (Default)
DEU German
ESN Spanish
FRA French
ITA Italian
JPN Japanese
PTB Brazilian Portuguese
SCH Simplified Chinese
Default: English
II_LIBU3GL
Specifies the file names of the dynamic link libraries containing your 3GL procedures. If you specify more than one file, separate file names with semicolons (;).
The path (directory) is optional. It is needed only if the DLL is not in the current directory.
II_LOG
Specifies the location for the OpenROAD log files (including w4gl.log).
On Windows, OpenROAD shortcuts are launched using orwrap.exe, a utility that automatically sets OR_LOG at the process level to the appropriate location unique for the Ingres instance in which OpenROAD is installed.
OpenROAD needs a location that the user has write access to for the II_LOG location. In an Ingres environment, the default location for II_LOG may not allow the user write access.
If II_LOG is not specified, %II_SYSTEM%\ingres\files (for Windows) or $II_SYSTEM/ingres/files (for UNIX) is used.
II_MONEY_FORMAT
Specifies the currency format to use for money values retrieved by database access. It is set installation-wide. This is different from the display formatting you can use to show money values in forms.
You can change the format by setting II_MONEY_FORMAT to a string with two symbols separated by a colon (:). The symbol to the left of the colon indicates the location of the currency symbol. It must be “L” for a leading currency symbol or a “T” for a trailing currency symbol. The symbol to the right of the colon is the currency symbol you want displayed. Currency symbols can contain up to 4 physical characters. For example:
Logical Definition Result
L:$ $100
T:DM 100DM
T:F 100F
Default: L:$
II_MONEY_PREC
Specifies the number of decimal places to be displayed for money values retrieved by database access. This is different from the display formatting you can use to show money values in forms. It is set installation-wide.
Valid values are 0, 1, and 2. The default is 2 (for decimal currency). II_MONEY_PREC is applied when a money value is converted to a character string (for printing, for example). Extra decimal places are rounded. For example, if II_MONEY_PREC is set to 0, 9.50 is rounded to 10.
Default: 2 (for decimal currency)
II_MSGDIR
Specifies the location of the OpenROAD error and information message text files. Default is the “ingres/files/language” directory. (See II_LANGUAGE for possible values.) Usually set during OpenROAD installation. Users must not change this setting.
II_REPIMAGE_DIR
Specifies the full path to the directory that contains image trim bitmaps for use with Reporter. For more information, see Disk-resident Images and Image Directories.
II_SCREEN_HEIGHT_INCHES
Specifies the height of the display in inches. If desired, you may use millimeters instead by setting II_SCREEN_HEIGHT_MMS. Setting only one of II_SCREEN_HEIGHT_xxxx or II_SCREEN_WIDTH_xxxx enables OpenROAD to calculate the other value to preserve the aspect ratio based on the pixel size of the display. These values are used to translate OpenROAD dimensions (in 1000ths of an inch) to screen pixels.
You need not specify this value. If not specified, OpenROAD calculates the values from the information provided by the windowing system.
II_SCREEN_HEIGHT_MMS
Specifies an alternative method of specifying screen height in millimeters. See II_SCREEN_HEIGHT_INCHES.
II_SCREEN_HEIGHT_PIXELS
Specifies the height of the screen on the primary display monitor in pixels.
You need not specify this value. If not specified, OpenROAD calculates the values from the information provided by the windowing system.
II_SCREEN_LOGPIXELSY
Specifies the number of pixels per logical inch along the screen height.
You need not specify this value. If not specified, OpenROAD calculates the values from the information provided by the windowing system.
II_SCREEN_LOGPIXELSX
Specifies the number of pixels per logical inch along the screen width.
You need not specify this value. If not specified, OpenROAD calculates the values from the information provided by the windowing system.
II_SCREEN_WIDTH_INCHES
Specifies the width of the display in inches. If desired, you may use millimeters instead by setting II_SCREEN_WIDTH_MMS. Setting only one of II_SCREEN_HEIGHT_xxxx or II_SCREEN_WIDTH_xxxx enables OpenROAD to calculate the other value to preserve the aspect ratio based on the pixel size of the display. These values are used to translate OpenROAD dimensions (in 1000ths of an inch) to screen pixels.
You need not specify this value. If not specified, OpenROAD calculates the values from the information provided by the windowing system.
II_SCREEN_WIDTH_PIXELS
Specifies the width of the screen on the primary display monitor in pixels.
You need not specify this value. If not specified, OpenROAD calculates the values from the information provided by the windowing system.
II_SCREEN_WIDTH_MMS
Alternative method of specifying screen width in millimeters. See II_SCREEN_WIDTH_INCHES.
II_SYSTEM
Specifies the location that is the parent directory of your OpenROAD installation (and ingres directory) where many components of your installation are located. This environment variable is usually set during the installation process and must not be changed.
II_TEMPORARY
Specifies the path name of a directory that OpenROAD uses to store temporary files. If not specified, by default, OpenROAD creates these files in the user’s current directory. II_TEMPORARY can be redefined installation-wide or locally.
II_TRACE_FONT_CREATED
Specifies whether the name of the logical fonts will be displayed at their creation. Valid values are TRUE or FALSE.
Default: FALSE
II_TRACE_SCREEN_CALCULATION
Specifies whether the variables related to the screen calculation will be displayed. Valid values are TRUE or FALSE.
Default: FALSE
II_TRUNCATE_W4GL_LOGFILE
Specifies that OpenROAD continually monitors the log file size to ensure that it never grows beyond 32768 bytes
II_VIEW
Specifies a system editor that OpenROAD uses instead of its own Script Editor for viewing or editing scripts
II_W4GLAPPS_DIR
Specifies the path for the location of OpenROAD application image files, often used for included applications. If not set, II_W4GLAPPS_SYS is used.
II_W4GLAPPS_SYS
Specifies the path for the location of the OpenROAD system image files. If not set, the following directories are used:
Windows:
%II_SYSTEM%\ingres\w4glapps
UNIX:
$II_SYSTEM/ingres/w4glapps
II_W4GL_ALLOW_NVARCHAR
Specifies whether the nchar and nvarchar data types are enabled in OpenROAD 4GL applications. After setting this environment variable to TRUE, the nchar and nvarchar data types maybe declared and used in OpenROAD 4GL applications.
Default: FALSE
II_W4GL_CACHE_LIMIT
Specifies the size, in bytes, of the Source Object Cache. Setting this environment variable causes OpenROAD to free unused objects when the size of the cache exceeds this amount. If you do not set this variable, objects are stored in the cache until OpenROAD exits.
II_W4GL_EXPORT_FORMAT
Specifies the default export format for the w4gl backupapp out command (see Command Line Method of Exporting an Application to a File (see Command Line Method of Exporting an Application to a File) and Command Line Method of Exporting Components to a File (see Command Line Method of Exporting Components to a File)). Valid values are:
EXP
Specifies OpenROAD proprietary ASCII format
XML
Specifies XML format
Default: EXP
If this environment variable is not set, or is set to any other value, EXP format will be used for export.
II_W4GL_EXPORT_INDENTED
Specifies whether XML indentation is included in export files created by the ExportApp utility (see Parameters for the ExportApp Utility) or w4gl backupapp out command (see Command Line Method of Exporting an Application to a File (see Command Line Method of Exporting an Application to a File) and Command Line Method of Exporting Components to a File (see Command Line Method of Exporting Components to a File)). Valid values are:
TRUE
Specifies that XML element indentation is used in the XML export file. Including indentation can increase export file size by 50% over OpenROAD proprietary ASCII format.
FALSE
Specifies that XML element indentation is not used. Whitespace characters (tabs, spaces, newlines) are not included. Therefore, XML elements are not separated onto different lines, and subnodes are not indented in a hierarchy.
Default: FALSE
II_W4GL_EXPORT_WITH_DEFAULTS
Specifies whether XML export of components or applications additionally writes attributes having default values into the export file. Valid values are:
TRUE
Specifies that all attributes (including those having default values) with their current values be included in the XML export file.
FALSE
Specifies that only those attributes with current values different from the attribute's default value are included in the XML export file. Attributes having default values are not included.
Default: FALSE
For example, the attribute xleft, defined for all FormField objects, has a default value of 0. If II_W4GL_EXPORT_WITH_DEFAULTS=FALSE, the attribute would appear only for those fields that have a different value (greater than 0). The exported XML would contain no occurrences of:
<xleft>0</xleft>
If II_W4GL_EXPORT_WITH_DEFAULTS=TRUE, you would find occurrences of xleft for all fields positioned at the left corner of their parent field. This situation applies to all other attributes.
Note:  This option increases export file size and decreases performance of export and import processing. For more information, see File Size and XML Element Indentation.
You may optionally set indentation for the output with II_W4GL_EXPORT_INDENTED.
For more information, see XML Import and Export, Command Line Method of Exporting an Application to a File, and Command Line Method of Exporting Components to a File.
II_W4GL_IMPORT_FORMAT
Specifies the default import format for the w4gl backupapp in command (see Command Line Method of Importing an Application from a File and Command Line Method of Importing Components from a File). Valid values are:
EXP
Specifies OpenROAD proprietary ASCII format
XML
Specifies XML format
Default: EXP
If this environment variable is not set, or is set to any other value, EXP format is tried first. If import fails, XML format is then used. See II_W4GL_IMPORT_XSD.
II_W4GL_IMPORT_XSD
Specifies the full path to a URL or a file that contains the XML schema definition for the XML export format. If this variable is set, the referenced XSD will be used for validation when importing applications or components from XML-based export files.
II_W4GL_LINEWIDTHS
Note:  Overrides the default settings for LW_MINIMUM, LW_EXTRATHIN, LW_VERYTHIN, LW_THIN, LW_MIDDLE, LW_THICK, and LW_MAXIMUM (and its equivalent, LW_VERYTHICK). For more information, see Line Width Settings in the appendix, "System Constants and Keywords," in the Language Reference Guide.
Note:  The value of this variable must be a list of six values separated by commas. Each value represents its respective line width in pixels. All values within the list must be present, and none can be 0 (zero). The list must be in a non-decreasing order, for example, the default values may be specified as 1,2,3,5,7,9,11 or 1,2,3,4,5,6,7 or 2,2,9,9,9,9,20.
II_W4GL_OPEN_IMAGES
Specifies the maximum number of image files OpenROAD keeps open at a time. If you specify 0 (zero), OpenROAD keeps an unlimited number of open image files.
Limits: minimum value is 2
Default: 10
II_W4GL_PASS_NVARCHAR_AS_WCHAR
If set to TRUE, OpenROAD will pass any user 3GL procedure parameters of the data type nvarchar as wide chars to the user 3GL procedure. If set to FALSE, nvarchars will be coerced to chars before passing them to the user 3GL procedure.
Default: FALSE
II_W4GL_PORTLETBLOCKING_DEFAULT
Specifies the default portlet blocking behavior for applications started with this environment variable set. The setting will be used for all callframe statements issued from within a portlet script.
This environment variable is checked only at application startup; therefore, changing its value within an application has no effect. Valid values include:
PB_GUESTFRAME (value = 0)
PB_HOSTFRAME (value = 1)
PB_GUESTFIELD (value = 2)
Default: PB_GUESTFRAME
For more information about portlet blocking, see the ProcExec.PortletBlocking attribute in the Language Reference Guide.
II_W4GL_QUERY_LAYER
Specifies whether the Query Layer is disabled for use with Enterprise Access on Microsoft SQL Server. When set to OFF, the Query Layer is disabled. The Query Layer is enabled by default if the database is Unicode enabled. For more information, see "Query Layer" in the Migration Guide.
II_W4GL_SYSTEMEDITOR
Specifies whether the system editor is automatically invoked instead of Workbench's built in Script Editor. Possible values are:
TRUE
Specifies that the system editor is opened
FALSE
Specifies that OpenROAD's built-in Script Editor is opened
II_W4GL_TRACE_TIMESTAMP
Specifies whether to start each trace message in the trace window and log file with the timestamp in square brackets. Possible values are:
TRUE
Specifies that each trace message is preceded with the timestamp
FALSE
Specifies that trace messages are not timestamped
II_W4GL_TRACE_WRAPPED
Specifies whether the message will be wrapped in the log file. Possible values are:
TRUE
Specifies that the messages will be wrapped in the log file in the same way they are in the Trace window
FALSE
(Default) Specifies that the messages will not be wrapped in the log file as they are in the Trace window
II_WINDOWEDIT
Specifies a system editor that OpenROAD uses instead of its own Script Editor for editing scripts.
For more information, see How You Can Use Your System Editor.
II_WINDOWVIEW
Specifies a system editor that OpenROAD uses instead of its own Script Editor for viewing scripts.
For more information, see How You Can Use Your System Editor.
ING_EDIT
Specifies the default system editor that OpenROAD uses instead of its own Script Editor for viewing or editing scripts. The default for the entire installation is set during the installation procedure. Users can also set this in their local environment.
Windows: You must set ING_EDIT to the full path name of the editor. For example:
c:\tools\vi.exe
UNIX:
/usr/ucb/vi
OR_CONFIG
Specifies the location of the OpenROAD profiles. This is set to a location that the user has write access.
You can set this environment variable using symbol.tbl (see How You Can Use the symbol.tbl File). On Windows, OpenROAD shortcuts are launched using orwrap.exe, a utility that automatically sets OR_CONFIG at the process level to the appropriate location unique for the Ingres instance in which OpenROAD is installed.
PICTURE_DIR
Specifies the path for the directory in which to store bitmap image files. This environment variable is used by field templates that display images.
STRING_DIR
Specifies the path for the directory in which to store string object files. This environment variable is used by field templates that save and load string objects from files.
VASA_FILE
Specifies a path and file name for the OpenROAD Server Manager initialization file. (The default file is vasa.ini in the %II_SYSTEM%\ingres\files directory.) This variable is checked when the Server Manager starts. If the variable is not null and points to a valid file, then that file is used instead of the default vasa.ini.
If this variable is not specified, OpenROAD then checks the II_CONFIG variable. If this variable is not null and points to a valid file, then that file is used instead of the default vasa.ini. Lastly, II_SYSTEM is checked.
For more information about the Server Manager, see the Server Reference Guide.
More information:
Writing Scripts and Procedures