Every Oracle Forms session runs in a runtime process on the Forms server, and that process gets its environment from a file: default.env, or another environment file a configuration section names. The environment decides where forms are found, which database aliases exist, the session's language, and a set of FORMS_ switches that change the runtime's behavior.
This guide covers the Oracle Forms 14.1.2 runtime environment: the variables that matter most, using several environment files on one server, and where every other configuration file lives.
How the Environment File Is Chosen
Each runtime process gets its environment from the section's environment file, named by envFile: default.env unless a section names another, in the same directory as formsweb.cfg. The environment file is read when a runtime process starts, so a change applies to the next session.
envFile is a system parameter: it comes only from the section, never from the URL. Sections and their parameters are explained in how to configure formsweb.cfg in Oracle Forms.
The Variables That Matter Most
| Variable | Sets |
|---|---|
| FORMS_PATH | Directories searched for forms, menus, and libraries without a path |
| FORMS_MODULE_PATH | When set, the only directories from which a form may be started |
| TNS_ADMIN | The directory of tnsnames.ora and sqlnet.ora |
| NLS_LANG | Language, territory, and character set of the session |
| CLASSPATH | Java classes of the runtime: imported Java, the debugger, Reports integration |
| FORMS_INSTANCE | The Forms instance's directory, with its logs and configuration |
| WEBUTIL_CONFIG | The WebUtil configuration file |
| COMPONENT_CONFIG_PATH | The Reports Tools configuration, for RUN_REPORT_OBJECT |
| FORMS_TIMEOUT | Minutes without contact from the client before the process ends |
| FORMS_RESTRICT_ENTER_QUERY | Whether users may write their own conditions in the Query/Where dialog |
| FORMS_USER_DATE_FORMAT, FORMS_USER_DATETIME_FORMAT | Default formats for dates without a format mask |
| FORMS_RECORD_GROUP_MAX | The most records any record group may fetch |
| FORMS_BLOCK_HOST_CMD | Whether calls to HOST are blocked, silently or with an error |
| FORMS_HIDE_PASSWORD | Whether GET_APPLICATION_PROPERTY(PASSWORD) may return the password |
| FORMS_LOG_MODULE_OPEN | Whether each opened module is written to the diagnostic log |
| FORMS_SUPPRESS_LOGON | Whether the logon dialog is hidden, for applications that connect otherwise |
| FORMS_USEREXITS | Libraries of foreign functions called by user exits |
Several of these change behavior you have seen elsewhere: FORMS_PATH finds forms and libraries attached without a path, as in how to create a PL/SQL library, and FORMS_RESTRICT_ENTER_QUERY controls the Query/Where window described in how to search records using query by example.
Use Several Environment Files
Several environment files serve different needs from one server:
- A section with envFile=cwtest.env and FORMS_PATH pointing to test modules.
- Another with a different NLS_LANG, for users in another language.
- A section whose environment file sets FORMS_RESTRICT_ENTER_QUERY to FALSE, for trusted users only.
In Fusion Middleware Control, the Environment Configuration page edits default.env and the other environment files, and Duplicate File creates a new one. Without Fusion Middleware Control, copy the file with an editor, in the same directory as formsweb.cfg.
Where the Other Configuration Files Live
| File | Location | Holds |
|---|---|---|
| formsweb.cfg | Forms application's config directory | Configuration sections |
| default.env and other environment files | Same | The runtime's environment (above) |
| base.htm, basejpi.htm, base.jnlp, basesaa.txt | Forms instance's server directory | Templates of the start files |
| webutil.cfg | Forms instance's server directory | WebUtil's transfers and logging |
| ftrace.cfg | Forms instance's server directory | Forms Trace event groups |
| Registry.dat | Forms application's config/oracle/forms/registry | Font mapping, icon location (default.icons.iconpath) and extension, application-specific settings for serverApp |
| fmrweb.res, fmrweb_utf8.res | Forms instance's admin/resource/<language> | The keys of the Forms client; another file is chosen with term |
| tnsnames.ora | TNS_ADMIN, config/fmwconfig of the domain | Database aliases |
The directory of the Forms instance, forms1, is in the domain.
The Forms instance directory:
$DOMAIN_HOME/config/fmwconfig/components/FORMS/instances/forms1
In Fusion Middleware Control, Font and Icon Mapping edits Registry.dat, and Advanced Configuration edits the other files as text. Fusion Middleware Control writes the files back whole from its own copy, so do not edit the same file with another tool at the same time.
Conclusion
Each Oracle Forms runtime process takes its environment from the envFile of its configuration section, default.env by default, read when the process starts. FORMS_PATH, TNS_ADMIN, NLS_LANG, and CLASSPATH set where modules, database aliases, language, and Java classes come from, while the FORMS_ variables control timeouts, query restrictions, date formats, host commands, and more. Give different sections their own environment files for test modules or other languages, and know where the base files, webutil.cfg, ftrace.cfg, Registry.dat, and the key files live.
