Environment Variables
This chapter describes Forms environment variables associated with configuration.
- Required: An environment variable is required if Forms requires a non-null value in order to function correctly.
- Valid values: In a few cases, these are listed explicitly, but in most cases they can be inferred from the description.
If the description implies that the value is Boolean (for example, it states Specifies whether), the valid values are TRUE, True, true, T, t, YES, Yes, yes, Y, y, 1, or FALSE, False, false, F, f, NO, No, no N, n, 0, (case-sensitive), unless indicated otherwise. Numeric values should be integers specified as decimal numbers, optionally followed by K, M, G, or T [powers of 1024, not 1000], unless indicated otherwise. The elements in lists of files or directories should be separated by ':' [Unix] or ';' [Windows] unless indicated otherwise.
- Default: If specified, this is the non-null value that produces the same behavior as not specifying a value. If omitted, the implication is that the default value is null.
Table -62 Environment Variables
Environment Variable | Applies to | Description |
---|---|---|
CA_GPREFS
|
Builder | Specifies an alternative path for the Form Builder global preferences file. Applies to Microsoft Windows only. |
CA_UPREFS
|
Builder | Specifies an alternative path for the Form Builder user preferences file. Applies to Microsoft Windows only. |
CLASSPATH
|
Runtime, Builder |
The Java class path: a list of directories and/or JAR files. Required (for the Forms debugger and for forms using imported Java). |
COMPONENT_CONFIG_PATH
|
Runtime | Used for Reports integration. Value should point to Reports Tools component path. |
DE_PREFS_TABSIZE
|
Builder |
Specifies the number of spaces to be used when tab is pressed while in the Form Builder code editor. Default: 2 |
DE_VARIABLESHARE |
Runtime |
Specifies whether Forms should free variables shared between Program Units. Default: 0 |
FORMS_ABTERM_CLEANUP
|
Runtime |
Specifies whether to enable normal Forms cleanup after an operating system exception in the runtime process. This consists of freeing various resources (for example, database connections) which the Forms runtime process had allocated. Setting this environment variable to Default: |
FORMS_ALLOW_DB_CONNECT_STRING |
Runtime, Builder |
Specifies whether the database to be logged into can be specified as a full connect string (for example, the right-hand side of an entry in Default: |
FORMS_ALLOW_JAVASCRIPT_EVENTS |
Runtime | |
FORMS_API_COMPILE_ALL |
JDAPI |
Forces the full PL/SQL compilation of modules before generating the executable (FMX, MMX, PLX). Default: |
FORMS_API_TK_BYPASS |
JDAPI |
Specifies whether to bypass the Forms internal Toolkit (TK) when initializing the JDAPI. If using JDAPI on a Unix/Linux platform and DISPLAY is not set or accessible, set this variable to Default: |
FORMS_AQ_PORT_RANGE |
Runtime |
Specifies a port, a set of ports, or a range of ports needed for Forms to integrate with DB Advanced Queuing. The value can be a single port number, a comma-separated list of ports, a range of ports (for example, 2000-2100), or a combination of ports and ranges. If no value is provided, an available port is assigned at random. |
FORMS_ASSUME_MULTI_MONITOR |
Builder |
Specifies whether or not the Form Builder should retain window position information upon exiting. When set to Default: |
FORMS_BI_SERVER
|
Runtime | Specifies the location of the BI Publisher Service Location in the format <protocol>://<server>:<port> . If the Service Location specified in a report object is a relative URL, the value of FORMS_BI_SERVER will be prepended to it.
|
FORMS_BLOCKING_LONGLIST |
||
FORMS_BUILDER_CLASSPATH |
Builder | |
FORMS_C_STACK_TRACE_TO_FILE
|
Runtime |
Specifies where a stack trace is written in the event of an operating system exception in the runtime process. Setting this environment variable to Default: |
FORMS_CATCHTERM
|
Runtime |
Specifies whether to enable normal Forms handling of an operating system exception in the runtime process. This consists of two parts:
Setting this environment variable to Default: |
FORMS_CHANGE_PASSWORD_HINT |
Runtime | Specifies the text that should be displayed in the default logon dialog box. The total number of characters cannot exceed 255. |
FORMS_CHECK_WEB_LISTENER |
Builder |
Specifies whether the Builder should verify that the server referenced in the Application Server URL Preference setting can be reached and is responding, before attempting to run the current form when the RunForm button is pressed. Default: TRUE |
FORMS_COMPUTED_RGFS_DIVIDEND
|
Runtime |
If the Record Group Fetch Size property for a record group is set 0, the effective value is given by the environment variables Default: |
FORMS_DATETIME_LOCAL_TZ |
Runtime |
Specifies the end-user local time zone and defaults to the time zone of the Java client. Oracle Forms uses time zone data to support the ADJUST_TZ built-in and to adjust the date/time displayed in DATETIME items. Values loaded from the database or set by application logic are interpreted as being in the server time zone, whereas values displayed in DATETIME items are converted from the server time zone to the end-user local time zone. The default values for Note: When upgrading from Forms 11g (11.1.2) or older releases, addFORMS_DATETIME_LOCAL_TZ=GMT to the environment variable configuration file (such as, default.env ) to ensure that the end-user local time zone is identical to the server time zone.
|
FORMS_DATETIME_SERVER_TZ |
Runtime |
Specifies the server time zone and defaults to GMT. Oracle Forms uses time zone data to support the ADJUST_TZ built-in and to adjust the date/time displayed in DATETIME items. Values loaded from the database or set by application logic are interpreted as being in the server time zone, whereas values displayed in DATETIME items are converted from the server time zone to the end-user local time zone. The default values for |
FORMS_DB_IDLE_TIME |
Runtime | Specifies how long in seconds the connection to the database can be idle/unused before raising the SYSTEM_DB_IDLE System Event.
|
FORMS_DBALIAS_SPECIAL_CHARS |
Runtime |
Specifies whether the database to be logged into can be specified as a tns name containing ':' (used for EZCONNECT). Default: |
FORMS_DECIMAL_PREFIX |
Runtime | |
FORMS_DEFAULTFONT |
Builder |
Specifies the default font that should be used by the Builder Layout Editor when creating new objects. The syntax for this setting is: Example value: arial.10.plain.bold |
FORMS_DISABLE_UNPAD_LOV |
Runtime | |
FORMS_DISABLED_NOT_REQD |
Runtime | |
FORMS_DISCONNECT_AWARE |
Builder |
Specifies whether or not the Form Builder should detect if a previously connection with the database is still available. Default: |
FORMS_DUMP_MIRROR_GROUPS |
||
FORMS_EDITOR |
Builder |
Specifies the desired editor to use when the Use System Editor Builder Preference is enabled and the user attempts to open a multi-line property value. If no value is provided, the system default, such as Notepad on Microsoft Windows, is used. |
FORMS_EXTENDED_STRING |
Runtime |
Specifies whether columns referenced in a Record Group may contain more than 4000 characters. This is only possible if the database has this setting: Default: |
FORMS_FLAG_DIFFERENT_SUBORD |
||
FORMS_FLAG_NO_SUBORD_RANGE |
||
FORMS_FLAG_NO_SUBORD_TRIGGER |
||
FORMS_FLAG_SUBORD_REQD_FALSE |
||
FORMS_FORCE_ENCRYPT_HANDSHAKE
|
Runtime |
Specifies whether to force an encryption handshake round trip to occur during application startup. If set to Default: See also |
FORMS_FORCE_MENU_MNEMONICS |
Runtime | |
FORMS_FORCE_ROWBANDING |
Runtime |
Specifies whether or not row banding should be used even when the underlying canvas has a set background color. Default: |
FORMS_FRMBLD_STARTS_JVM |
Builder |
Specifies whether the Builder starts a Java Virtual Machine (JVM) when it starts. A JVM is required to use the Builder Help, Java Importer, and Debugger. If set to The JVM will be started on demand, for example, when attempting to open the Builder Help. Once the JVM starts, it remains running through the life of the Builder session. The Debugger will not be available. Default: |
FORMS_HIDE_LOGIN_RESET |
Runtime |
Specifies whether to hide the Change Password dialog when the database password has expired. If set to If set to Default: |
|
Builder |
Specifies whether to hide URL parameters when using "OneButtonRun" (the RunForm button) to launch a form from the Builder. Default: |
FORMS_HIDE_PASSWORD |
Runtime |
Specifies whether the Forms built-in Default: |
FORMS_HTTP_PROXY_HOST
|
Runtime, Builder |
Specifies the HTTP-enabled proxy host (if any) used for calls to Oracle BI-Publisher, or for calls to a remote server [a server other than the one where Forms is running] from server-side Java (Imported Java) in a form. You may also need to set If you are using the JVM Controller, see Network Proxies and Java Calls Using JVM Controller and the Java equivalent http.proxyHost. |
FORMS_HTTP_PROXY_PORT
|
Runtime, Builder | Used in conjunction with FORMS_HTTP_PROXY_HOST .
|
FORMS_HTTPS_PROXY_HOST
|
Runtime, Builder |
Specifies the HTTPS-enabled proxy host (if any) used for calls to Oracle BI-Publisher, or for calls to a remote server [a server other than the one where Forms is running] from server-side Java (Imported Java) in a form. You may also need to set If you are using the JVM Controller, see Network Proxies and Java Calls Using JVM Controller and the Java equivalent https.proxyHost. |
FORMS_HTTPS_PROXY_PORT
|
Runtime, Builder | Used in conjunction with FORMS_HTTPS_PROXY_HOST .
|
FORMS_INSTANCE
|
Runtime |
The directory that contains all configuration files, repositories, log files, deployed applications, and temporary files. Required. |
FORMS_LIMIT_EXTERNAL_MESSAGES
|
Runtime | Unix only. If set to '1', "external" messages [messages from components other than Oracle Forms] written to stdout or stderr are suppressed. This may occasionally be necessary to prevent disk file systems from filling up. However, external messages are sometimes useful in diagnosing problems, for example, with loading executables. Leaving this environment variable unset will cause external messages to be written to the Oracle Diagnostic Log, in the body of message FRM-93546. |
FORMS_LOGIN_DIALOG_BLANK |
Runtime |
Specifies whether the user name and database name appears in the logon dialog when presented after a failed logon attempt. Default: |
FORMS_LOGON_HINT |
Runtime | Specifies the text that should be displayed in the default logon dialog box. The total number of characters cannot exceed 255. |
FORMS_LOV_INITIAL
|
Runtime |
Used when the Interaction Mode form property is set to Non-Blocking. Specifies the time, in milliseconds, before the Cancel Query window appears after a query is initiated. Default: Related topics:
|
FORMS_LOV_MINIMUM
|
Runtime |
Used when the Interaction Mode form property is set to Non-Blocking. In conjunction with Default: Related topics:
|
FORMS_LOV_WEIGHT
|
Runtime |
Used when the Interaction Mode form property is set to Non-Blocking, in conjunction with Default: Related topics:
|
FORMS_MAP_GIF_IMAGE_TO_NATIVE |
Runtime |
Specifies if image items containing GIF images should bypass the Forms Multimedia processing layer. Bypassing the Multimedia processing layer will deliver uncompressed images to the user interface and will typically exhibit superior image quality when Native (a new Builder property for image items) is specified. However, image loading performance may be degraded. If the behavior of Native image items is desired for image items that specify an Image Format of GIF, this can be achieved without modifying or recompiling Default: |
FORMS_MAP_JFIF_IMAGE_TO_NATIVE |
Runtime |
Specifies if image items containing JFIF/JPEG/JPG images should bypass the Forms Multimedia processing layer. Bypassing the Multimedia processing layer will deliver uncompressed images to the user interface and will typically exhibit superior image quality when Native (a new Builder property for image items) is specified. However, image loading performance may be degraded. If the behavior of Native image items is desired for image items that specify an Image Format of JFIF/JPEG/JPG, this can be achieved without modifying or recompiling fmb files. Set the value of this environment variable to Default: |
FORMS_MAX_COMPUTED_RGFS
|
Runtime |
If the Record Group Fetch Size property for a record group is set Default: |
FORMS_MAX_JVM_STACKSIZE
|
Runtime |
The thread stack size passed to the JVM via the -Xss flag, if the runtime process needs spawn a JVM, for example, for certain Webutil operations, or for processing an expired password during logon when single sign-on is in effect. Specifying a large value may be necessary when a user exit allocates a large amount of memory. Valid values: A decimal number optionally followed by k, K, m, or M. |
FORMS_MESSAGE_ENCRYPTION
|
Runtime |
Specifies whether to apply proprietary obfuscation to Forms messages between the client and the server. Default: See also |
FORMS_MIN_COMPUTED_RGFS
|
Runtime |
If the Record Group Fetch Size property for a record group is set Default: |
FORMS_MMAP
|
Runtime |
Specifies whether to use memory mapped file I/O when reading forms or menus ( Default: |
FORMS_MODULE_PATH
|
Runtime |
Setting this environment variable to a non-empty value restricts the directories from which Forms applications may be launched. The significant effects are as follows: If the initial form specifies a path, it must appear either in the value of Value specified in the |
FORMS_NONBLOCKING_SLEEP
|
Runtime |
Specifies a sleep interval, in milliseconds. Used when the Interaction Mode form property is set to Non-Blocking, and a query is initiated for a datablock, a record group, or a non-longlist LOV, or when such a query is resumed after displaying or polling the Cancel Query window. If Default: Related topics:
|
FORMS_NONNAVIGABLE_NOT_REQD |
Runtime | |
FORMS_OBR_REMOVE_PATH |
Builder |
Specifies whether or not the full file system path should be included in the URL when using the Builder’s One Button Run feature. This will be helpful when the Application Server URL is set to a remote node. Default: |
FORMS_ON_MODAL_DETECT_IDLE |
Runtime |
When set to Default: |
FORMS_ORDER_PKG_SPEC_BODY |
Compiler | |
FORMS_OVERRIDE_ENV |
Runtime | |
FORMS_PATH
|
Runtime, Builder |
Required. |
FORMS_PLSQL_BHVR_COMMON_SQL |
Builder, Compiler, JDAPI | |
FORMS_PLSQLV1_NAME_RESOLUTION |
Runtime | |
FORMS_PROXY_BYPASS |
Runtime |
Specifies a list of hosts that should not be accessed using a proxy. Hosts in the list are separated by the | character. An individual host can include the wildcard character *. See |
FORMS_QUERY_LENGTH_DELTA |
Builder, Compiler, JDAPI | |
FORMS_RECMGR_ACTIVE_RECS_DELTA |
Runtime |
This environment variable is intended for users with critical performance requirements. Most users can simply use the default value. See Valid values: 3-120. Default: |
FORMS_RECMGR_ACTIVE_RECS_RATIO
|
Runtime |
This environment variable is intended for users with critical performance requirements. Most users can simply use the default value. Note: When a data block or record group is being populated after being cleared, the number of active records may temporarily exceed the "target" number specified byFORMS_RECMGR_ACTIVE_RECS_RATIO and FORMS_RECMGR_ACTIVE_RECS_DELTA (or by the Number of Records Buffered property), if the records are relatively small. The creation of archived records will be deferred until the number of records reaches a certain limit (based on the record size). If and when that limit is reached, the number of active records will be reduced to the target number.
Valid values: 1.0-5.0. Fractional values are allowed. Default: |
FORMS_RECMGR_ARCHIVE
|
Runtime |
Specifies where and how the Forms record manager stores archived records. For each data block and record group, Oracle Forms maintains a small number of active records in virtual memory. An active record is in a format which allows direct access to data values and control information for each item instance or cell in the record. The remaining records are archived. An archived record is in a packed format which does not allow direct access to item instances or cells. Archived records reside in the archive store. Valid values:
Default: Related topics: There are other environment variables which can affect the behavior of the record manager.
In addition, there are other environment variables which can affect the performance of the record manager. These are intended for users with critical performance requirements. Most users can simply use the default values.
|
FORMS_RECMGR_ARCHIVE_THRESHOLD
|
Runtime |
This environment variable is applicable only when Valid values: Integers in the range 64K-2T. The specified value will be truncated to a multiple of the O/S page size. Default: |
FORMS_RECMGR_BLOCK_SIZE
|
Runtime |
This environment variable is applicable only when Valid values: Integers in the range 32K-512K if Default: |
FORMS_RECMGR_MAX_TMPFILE_SIZE
|
Runtime |
This environment variable is applicable only when Valid values: Must be at least the segment size specified by Default: |
FORMS_RECMGR_REPORT_RECGRP_MEM
|
Runtime |
This environment variable is applicable only when Default: |
|
Runtime |
This environment variable is applicable only when
The Default: Restrictions:
|
FORMS_RECMGR_RETRY_INTERVAL
|
Runtime |
This environment variable is applicable only when Valid values: A non-negative integer < 4G. Default: |
FORMS_RECMGR_SEGMENT_SIZE
|
Runtime |
This environment variable is applicable only when Valid values: Powers of 2 no smaller than the temporary file system page size (or 16K, if the temporary file system page size exceeds that), and no larger than 1M. Default: |
FORMS_RECMGR_SEGPOOL_ENTRIES
|
Runtime |
This environment variable is applicable only when
Valid values: 1-1024. Default: |
FORMS_RECMGR_SLACK_MAX
|
Runtime |
This environment variable is applicable only when Valid values: Integers in the range 0-64K. Default: |
|
Runtime |
This environment variable is applicable only when Valid values: 0-32.0. Fractional values are allowed. Default: |
FORMS_RECMGR_TMPFILE_DENSITY
|
Runtime |
This environment variable is applicable only when The valid values (0-7) have the following meanings:
Values smaller than the default may reduce CPU time, at the cost of increased temporary file system usage. Conversely, larger values may reduce temporary file system usage, at the cost of increased CPU time. Default: |
FORMS_RECMGR_TMPPOOL_ENTRIES
|
Runtime |
This environment variable is applicable only when Valid values: 0-256. Default: |
FORMS_RECMGR_USED_FOR_RECGRPS
|
Runtime |
This environment variable is applicable only when A value of This environment variable is ignored when Default: |
FORMS_RECORD_GROUP_MAX
|
Runtime |
The maximum number of records to be fetched from any record group (including those used by LOVs). Reaching this limit is treated essentially like end of query, although it may affect completion messages displayed in, for example, LOVs. A value of 0 indicates no limit. Default: |
FORMS_REDIRECT_DATA_PROPS |
Runtime | |
FORMS_REJECT_GO_DISABLED_ITEM |
Runtime | |
FORMS_REMOTE_DEBUGGER_PORT_RANGE
|
Runtime |
Specifies a range of ports (min and max port numbers, separated by a hyphen), or a single port, via which Oracle Forms will attempt to connect to a remote Forms debugger. A value of Default: |
FORMS_REPORTSSRV_USE_SQLNET |
Runtime | |
FORMS_RESTRICT_ENTER_QUERY |
Runtime |
Specifies whether arbitrary SQL expressions are disallowed in enter-query mode. When a value of
Specify a value of Value specified in the Default if unspecified: |
FORMS_ROWID_IS_NAVIGATION_ITEM |
Runtime | |
FORMS_ROWLOCK_OPTIMIZATION |
Runtime | |
FORMS_RUEI_SEND_FORM_NAME
|
Runtime |
Specifies whether the Forms server will send the name of the form module to the client for each window that is created in the form. Specifying a value of Default: |
FORMS_SCROLL_ALL_BUT_ONE |
Runtime | |
FORMS_SELECT_ON_CLICK |
Runtime |
Specifies whether or not the text in a field should be selected when using the mouse to enter the field. Default: |
FORMS_SEPARATE_DEBUGGER |
Builder | |
FORMS_SHOW_REP_DIALOG |
Builder |
Specifies whether or not to display the Create Report dialog when creating a new report object in the Object Navigator. Setting to Default: |
FORMS_STDIN_PASSWORD |
Builder | |
FORMS_SUPPRESS_RECURSIVE_DUMPS
|
Specifies whether to suppress a core dump (or a stack trace) if an operating system exception occurs while Forms is already processing a previous operating system exception in the runtime process. Normally, this environment variable should be set to Default: |
|
FORMS_SWITCH_JAVA_EVENTS |
||
FORMS_SYSADM_MESSAGE_LEVEL |
||
FORMS_SYSTEM_EVENT_NAVIGATION |
Runtime |
Specifies whether another form can service a system event when the current form doesn't have a subscription to the event. If set to Default: |
FORMS_TIMEOUT
|
Runtime |
Specifies the elapsed time, in minutes, before the runtime process is terminated if there has been no communication from the client. Note: The value ofFORMS_TIMEOUT should always be greater that the value of the applet parameter, heartBeat . Setting it to less than the heartBeat value will cause an improper termination of the user's running session. Terminating the running form in this manner can result in the user session becoming unresponsive. See heartBeat in Web Configuration Parameters.
Valid values: Integers in the range 3-1440 (up to 1 day). Values of Default: |
FORMS_TRACE_DIR
|
Runtime |
Specifies the location (directory) of dump files produced as the result of a crash of any of the Forms runtime executables. The dump files contain diagnostic information about events at the time the process crashed. Also specifies the directory which will contain files produced when tracing is enabled. Default for Unix:
Default for Windows:
|
FORMS_UNALTERABLE_NOT_REQD |
||
FORMS_UPPERCASE_WHERE |
Runtime | |
FORMS_USE_CBO |
Runtime |
Specifies whether a Default: |
FORMS_USE_NATIVE_MALLOC |
Runtime | |
FORMS_USER_CALENDAR |
Runtime | |
FORMS_USER_DATE_FORMAT |
Runtime | |
FORMS_USER_DATETIME_FORMAT |
Runtime | |
FORMS_USEREXITS
|
Runtime |
The full paths of shared object files (Unix) or DLL files (Windows) containing foreign functions that can be invoked from a user exit. Example (Windows): |
FORMS_USERNAME_CASESENSITIVE |
Runtime | |
FORMS_WEB_CONFIG_FILE |
Runtime | |
FORMS_WJSI_OVERRIDE_TIMEOUT
|
Runtime |
Specifies the elapsed time, in minutes, before the runtime process is terminated if there has been no communication from the client while a JavaScript function or expression is being evaluated through Jetty websocket. Valid values: Integers in the range 0-1440 (up to 1 day). Values less than or equal to the value of Default: |
LD_LIBRARY_PATH
|
Runtime, Builder |
Unix system environment variable. Specifies the directories which will be searched for shared objects dynamically linked by Oracle Forms and Reports. Required on Unix platforms. |
LD_PRELOAD
|
Runtime |
Unix system environment variable. Specifies shared objects which will be preloaded (loaded before all other shared objects). Oracle Forms and Reports require that libjsig.so be preloaded, to support the signal-chaining facility offered by JVM 1.5 and above. Required on Unix platforms. Note: If there are multiple environment files, ensure that LD_PRELOAD has the same settings as indefault.env .
|
MM_USE_TIF_G4 |
Runtime | |
ORA_CLIENTTRACE_DIR |
Specifies where the middle-tier interface to the Oracle RDBMS will write trace files. | |
ORACLE_HOME
|
Runtime, Builder, Compiler, JDAPI |
The base installation directory for Oracle products. Required. |
ORACLE_PATH
|
Runtime, Builder, Compiler, JDAPI |
Required. |
ORAPLSQLLOADPATH |
||
PATH
|
Runtime, Builder |
System environment variable. Specifies the directories that contain the binary executables for Oracle products. Required. |
REPORTS_SERVERMAP |
||
SHARE_LIBRARY_DATA |
||
TK2_HIDE_EDITOR_LINE_NUMBER |
Builder | Specifies whether to show line numbers in the PL/SQL Editor in the Builder when on Microsoft Windows. |
TNS_ADMIN |
Runtime, Builder, Compiler, JDAPI |
The directory containing TNS files such as Required. |
UI_ICON |
Builder |
Specifies the physical path of the location where icons and images are stored. Only one directory path can be specified. This is used by the Builder only for the purpose of displaying icons in the Builder Layout Editor. It has no impact on runtime. Images must reside on the file system and cannot be contained in a zip or jar file. Some image formats are not supported for display in the Builder. Unsupported formats may appear black or not displayed at all. |
UI_ICON_EXTENSION |
Builder | Specifies the default image file extension to use if one is not provided in the Builder. If no value is provided, the platform default will be used, which is ICO for Microsoft Windows and XPM for Unix/Linux.
|
WEBUTIL_CONFIG
|
Runtime | The full path of the WebUtil default configuration file. |