Migration Guide : E. Features Introduced in OpenROAD 6.2 : New Features : New Environment Variables
 
Share this page          
New Environment Variables
The following environment variables are added:
II_SCINT_EDITOR
II_TIMER_FOR_CURSOR
II_W4GL_ALLOW_NVARCHAR
II_W4GL_EXPORT_WITH_DEFAULTS
II_W4GL_PASS_NVARCHAR_AS_WCHAR
II_W4GL_TRACE_PAUSE_ON_ERROR
II_W4GL_TRACE_PROC3GL_CALL
II_W4GL_UTEXE_SHARE_DBSESSION
II_SCINT_EDITOR Specifies the Scintilla-based 4GL Script Editor
II_SCINT_EDITOR makes the Scintilla-based 4GL script editor the default editor. To revert to the former EntryField-based editor, set the environment variable to FALSE.
For more information about II_SCINT_EDITOR, see the Workbench User Guide.
II_TIMER_FOR_CURSOR Specifies Time to Wait Before Displaying Busy Cursor
A new environment variable, II_TIMER_FOR_CURSOR, specifies the time in milliseconds that OpenROAD should wait before displaying the busy cursor. Setting this can be useful when the application receives untimely events so that the cursor is flashing.
The default is 1. A reasonable value is 4000. If the value is set too low, some problems may occur when clicking on a togglefield.
For more information about II_TIMER_FOR_CURSOR, see the Workbench User Guide.
II_W4GL_ALLOW_NVARCHAR Allows the Use of Nchar and Nvarchar Data Types
OpenROAD transparent Unicode support negates the need for nchar and nvarchar data types to be used in OpenROAD 4GL applications. The nchar and nvarchar data types, introduced in OpenROAD 5.0, can be used in only a limited number of ways. The varchar data type with UTF8 encoding is all that is needed for Unicode support; to prevent nchar and nvarchar data types from being used accidentally, setthe new environment variable, II_W4GL_ALLOW_NVARCHAR, to FALSE. If the variable is set to TRUE (the default), the nchar and nvarchar data types may be declared and used in OpenROAD 4GL applications.
For more information about II_W4GL_ALLOW_NVARCHAR, see the Workbench User Guide.
II_W4GL_EXPORT_WITH_DEFAULTS Includes Default Attribute Values in XML Export
This version of OpenROAD includes a new environment variable. II_W4GL_EXPORT_WITH_DEFAULTS lets you specify whether XML export of components or applications additionally writes attributes having default values into the export file. After default values are exported, they can be manipulated in the XML file before importing.
Valid values are:
TRUE
Specifies that all attributes (including those having default values) with their current values are included in the XML export file.
FALSE
(Default) 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.
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. Import processing will take longer because all of the attributes must be applied instead of only those having non-default values. File size and performance depend on the number and kind of objects included.
For more information, in the Workbench User Guide, see:
XML Import and Export
Command Line Method of Exporting an Application to a File (BackupApp)
Command Line Method of Exporting Components to a File (BackupApp)
Environment Variables for All Platforms
II_W4GL_PASS_NVARCHAR_AS_WCHAR Enables Passing Nvarchars as Wide Chars
If the environment variable II_W4GL_PASS_NVARCHAR_AS_WCHAR is set to TRUE, OpenROAD passes any user 3GL procedure parameters of the data type nvarchar as wide chars to the user 3GL procedure. If it is set to FALSE, nvarchars are coerced to chars before passing them to the user 3GL procedure. The default is FALSE.
For more information about II_W4GL_PASS_NVARCHAR_AS_WCHAR, see the Workbench User Guide.
II_W4GL_TRACE_PAUSE_ON_ERROR Enables an Error Popup Box
If the II_W4GL_TRACE_PAUSE_ON_ERROR environment variable is set to TRUE, when OpenROAD runtime encounters an unhandled exception in the 4GL code, a reminder message box pops up that must be dismissed before the application can continue.
Setting this environment variable helps to ensure any errors are noted during QA and not missed inadvertently. It also could be used during development to catch errors that might stream off the trace window. The default is FALSE.
For more information about II_W4GL_TRACE_PAUSE_ON_ERROR, see the Workbench User Guide.
II_W4GL_TRACE_PROC3GL_CALL Traces 3GL Procedure Calls
The II_W4GL_TRACE_PROC3GL_CALL environment variable specifies whether to trace 3GL procedure calls at compilation time. If set to TRUE, 3GL procedure calls will be traced.
II_W4GL_UTEXE_SHARE_DBSESSION Shares DBSession Connection
Specifies whether the 4GL DBSession connection is shared with the Query and Reporting Tools Runtime. A value of TRUE (default) passes the -X flag to the Query and Reporting Tools Runtime. A value of FALSE passes the database name and Ingres flags.