1. Working with Oracle Forms
  2. Forms References
  3. Web Configuration Parameters

Web Configuration Parameters

This chapter describes configuration parameters and applet parameters.

These notes apply to the following table.

  • Required: A parameter is required if Forms requires a non-null value (from formsweb.cfg or, where allowed, from the URL) 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, "Specifies whether"), the valid values are TRUE or FALSE (case-insensitive), except for runform parameters (see following table), in which case the valid values are YES, Y, ON, or NO, N, OFF (case-insensitive). Numeric values should be integers specified as decimal numbers, unless indicated otherwise. The elements in lists of files or directories should be separated by ':' [Unix] or ';' [Windows] unless indicated otherwise.
  • Default: For required parameters, the parameter description lists the default value from the default section of the formsweb.cfg that is shipped with the product (or at least indicates that it specifies an appropriate value). For optional parameters, the parameter description may show a non-null default value from the default section of the formsweb.cfg that is shipped with the product. In addition, the parameter description may show the default value that is assumed if no value is specified. (This is the non-null value that produces the same behavior as an unspecified or null value). When the description for an optional parameter simply shows an unqualified default value, the implication is that this value is both the default value from the default section of the formsweb.cfg that is shipped with the product, and also the default value that is assumed if no value is specified. When the description for an optional parameter does not explicitly specify a default value, the implication is that the default value is null.
  • Application system parameters: The descriptions for some configuration parameters indicate that they are application system parameters. Such a parameter applies to an application that has been launched via a URL. Its value is taken from the default config section or from the config section specified by the config parameter in the URL. A value specified for an application system parameter in the URL is ignored.
  • Global system parameters: The descriptions for some configuration parameters indicate that they are global system parameters. Such a parameter applies to the installation as a whole. Its value is taken from specific config section(s); the exact semantics are spelled out in the description of the parameter.
  • Application user parameters: If a configuration parameter is not described as an application system parameter or a global system parameter, the implication is that it is an application user parameter. Such parameters are similar to application system parameters, but a value taken from a config section may be overridden by a value specified for the parameter in the URL.
  • Runform parameters: The descriptions for some parameters indicate that they are runform parameters. They are passed to the frmweb process using the serverArgs config or applet parameter. For such a parameter, when specifying a value that contains special characters, follow the syntax rules listed in Specifying Special Characters in Values of Runform Parameters.
  • Sub-arguments for otherparams: The descriptions for some parameters indicate that they are sub-arguments for otherparams. That means that in order for the parameter to take effect (when specified in formsweb.cfg or the URL), it must appear in the form name=%name% within the value of the otherparams parameter. So, for example, if you are adding the array parameter (with a value ofno) to a configuration section, you must also add array=%array% to the value of the otherparams parameter. Notice that these parameters are all runform parameters (because the otherparams parameter is itself a runform parameter), and so when specifying a value that contains special characters adhere to the syntax rules described in Specifying Special Characters in Values of Runform Parameters. These parameters are treated as application system parameters if the otherparams parameter is specified in the restrictedURLparams parameter.

The value specified for Category is one of 11 possible values.

  • The value for a preconfigured configuration parameter is one of the 8 values in the Show list in the Enterprise Manager Web Configuration page. These are basic, sso, trace, plugin, html, applet, advanced, and all.
  • A value of add-on indicates a configuration parameter that's not preconfigured. Such a parameter can be added to a configuration section as described in Managing Parameters. Once added, the Enterprise Manager Web Configuration page will show the parameter as advanced.
  • Values of applet add-on and sso add-on are similar to add-on, but the Enterprise Manager Web Configuration page will show the parameter as applet or sso if it's added to a configuration section.
  • A value of add-on applet param indicates a parameter which can be added to applet definition template files that you have created by modifying the templates provided by Oracle, as described in Creating Your Own Applet Definition Template Files. For added flexibility (for example, if you wish to allow end users to specify the value in the URL), the applet parameter can specify that its value is the value of a configuration parameter (typically of the same name). Such a parameter can be added to a configuration section as described in Managing Parameters. When added, the Enterprise Manager Web Configuration page will show the parameter as advanced.

Table -66 Web Configuration Parameters

Parameter Category Description
allowAlertClipboard advanced

Specifies whether an alert dialog should be presented if the system clipboard is inaccessible. Specifying FALSE will cause failed access to the clipboard to be reported on the Java Console.

Default: TRUE
allowLservletDebug add-on

Specifies whether to allow debug messages (and other messages with log level less than NOTIFICATION) to be written from the Listener Servlet (/forms/lservlet) to the Oracle Diagnostic Log, in the (normal) case where the Listener Servlet was launched from the Forms Servlet.

Note:

In a case where the Listener Servlet was not launched from the Forms Servlet (for example, by submitting static HTML or entering a /forms/lservlet URL in a browser), the allowLservletDebug lservlet initialization parameter specifies whether to allow debug messages to be written from the Listener Servlet to the Oracle Diagnostic Log.

This parameter is an application system parameter.

Default: FALSE
allowNewConnections advanced

Specifies whether new Forms sessions are allowed.

This parameter is a global system parameter. It must be specified in the default config section of formsweb.cfg. The value is read from formsweb.cfg on every request to the Forms servlet.

Default: TRUE
allow_debug advanced

A value of TRUE or TESTMODE allows debug messages (and other messages with log level less than NOTIFICATION) to be written from the Forms Servlet (/forms/frmservlet) to the Oracle Diagnostic Log, and also allows certain test commands, such as info, admin, setcookie, setcookiesess, checkcookie, and proctest to be executed. You can execute these commands by specifying them in the frmservlet URL, for example /forms/frmservlet/info or /forms/frmservlet?ifcmd=info. A value of TESTMODE also causes the page displayed by the admin command to contain the Listener Servlet version number and links to various other test commands. A value of FALSE suppresses diagnostic messages with log level less than NOTIFICATION and disallows test commands.

Note:

Even when TRUE or TESTMODE is specified, certain debug messages produced before the Forms Servlet has read the allow_debug parameter will be suppressed. To see these messages (in addition to other debug messages), specify a value of TRUE or YES for the testMode frmservlet initialization parameter. This will override any value that was specified (or defaulted) for the allow_debug configuration parameter.

This parameter is an application system parameter.

Default: FALSE
alwaysOnTop applet add-on

Specifies whether the Forms separate frame will remain on top of all other open windows. When used with separateFrame=true, the Forms separate frame will remain on top of all other open windows. If separateFrame=false, setting this parameter will have no effect on the frame. This is not supported with Web Start.

Default: FALSE

applet_name advanced Configuration for JavaScript integration. This is name of the Forms applet that users can use to refer to it from a JavaScript code.
archive plugin

Comma-separated list of archive files that are used or downloaded to the client. For each file, include the file name if the file is in the codebase directory, or include the virtual path and file name.

Required.

Default: frmall.jar
array add-on

Set this parameter to NO to suppress array processing. This causes Forms to send only a single row at a time to the database for an INSERT, UPDATE, or DELETE, and it causes the database to return only a single row of query results at a time. This usually results in the first retrieved record displaying faster, but the total time to display all rows in the query result is longer.

This parameter is a sub-argument for otherparams.

Default: YES

background applet

Specifies the image file that should appear in the background of the main applet window. Specify NO for no background. Leave empty to use the default background.

Supported image formats are: gif, png, and jpg.

baseHTML html

Specifies the applet definition template file to be used for an application that's not Web Start or Standalone, if the client browser is not on Microsoft Windows or does not support the <OBJECT> tag, or if the baseHTMLjpi parameter is unspecified or empty. The file can be specified as a full path, or as the name of a file within $DOMAIN_HOME/config/fmwconfig/components/FORMS/instances/<Forms Instance Name>/server.

This parameter is an application system parameter.

Required.

Default: base.htm
baseHTMLjpi html

Specifies the applet definition template file to be used for an application that's not Web Start or Standalone, if the client browser is on Microsoft Windows and supports the <OBJECT> tag. The file can be specified as a full path, or as the name of a file within $DOMAIN_HOME/config/fmwconfig/components/FORMS/instances/<Forms Instance Name>/server.

This parameter is an application system parameter.

Required.

Default: basejpi.htm
basejnlp html

Specifies the applet definition template file to be used for a Web Start application or an embedded JNLP file. The file can be specified as a full path, or as the name of a file within $DOMAIN_HOME/config/fmwconfig/components/FORMS/instances/<Forms Instance Name>/server.

This parameter is an application system parameter.

Required.

Default: base.jnlp
baseSAAfile html

Specifies the applet definition template file to be used for a Standalone application. The file can be specified as a full path, or as the name of a file within $DOMAIN_HOME/config/fmwconfig/components/FORMS/instances/<Forms Instance Name>/server.

This parameter is an application system parameter.

Required.

Default: basesaa.txt
centerOnStartup applet add-on

Specifies whether the Forms separate frame will start centered on the screen. When used with separateFrame=true, the Forms separate frame will start centered on the screen. If separateFrame=false, setting this parameter will have no effect on the frame.

Default: FALSE
clientDPI add-on Dots per inch (DPI). Overrides the DPI setting returned by the JVM, allowing you to manage varying DPI settings per platform. Oracle recommends that you use an integer between 50 and 200.
clientDPIRatio advanced

Specifies the percentage of the usable display that the application's MDI window should scale to. The window is scaled based on the display size but retains the HEIGHT to WIDTH ratio set in the Forms Web Configuration. This ensures that neither dimension becomes larger than the display size and that the application window does not become distorted.

This is only supported when configured to run with Java Web Start (JWS), FSAL, or embedded with separateFrame=true.

Note:

If clientDPI is set, clientDPIRatio is ignored.

Values: Integers from 10 to 100. Invalid values are ignored.

codebase plugin

The virtual directory you define to point to the physical directory ORACLE_HOME/forms/java, where, by default, the applet JAR files are downloaded from.

Required.

Default: /forms/java
colorScheme applet

Specifies the application's color scheme.

Valid values [case-insensitive]: Teal, Titanium, Red, Khaki, Blue, BLAF, SWAN, Olive, Purple.

Note:

colorScheme is ignored if LookAndFeel is set to Generic.

Default: SWAN
connectionDisallowedURL add-on

The URL to which Forms Servlet requests are redirected when connections to new Forms sessions are disallowed.

This parameter is an application system parameter.
consoleUseRegistryFont add-on applet param Specifies whether the application's console (or message bar) uses the default font attributes specified in Font and Icon Mapping (Registry.dat).
cursorBlinkRate add-on applet param

The duration (in milliseconds) that the cursor is visible during a blink cycle. This is also the duration that the cursor is invisible. A value of 0 disables blinking and the cursor remains visible all the time.

Default: 600. The cursor completes one full blink every 1.2 seconds

customColorScheme advanced The name of the custom colorscheme created in Registry.dat. Setting this will override the colorscheme parameter.
darkLook add-on

Specifies whether Forms should attempt to adjust the color of graphic objects and boiler text if the background and foreground colors are such that the foreground is not visible—for example, when the background and foreground are both black. In a scenario where there is black (dark) text on a dark background, the text is automatically changed to white if this parameter is set to TRUE.

This setting is ignored if lookandfeel=generic.

Note:

Although "dark" in Forms is any color with a luminance value less than 139, there are some cases where Forms may not be able to make an appropriate correction of the foreground color.

The default value of 139 luminance can be overridden by setting the Registry.dat parameter default.luminance.dark to the desired value. See Font, Image, and Style Mapping.

Default: FALSE
darkMode add-on

Specifies whether Forms should try to determine if the canvas background color is so dark that graphic text (boiler plate) on it cannot be easily read—for example, if the text is black and the canvas is dark brown. If so, and this setting is TRUE, Forms makes the dark text white.

Default: FALSE
debug trace

Allows running in debug mode.

This parameter is a runform parameter.

Default: NO
debug_messages add-on

Set this parameter to YES to cause Forms to display ongoing messages about trigger execution while the form runs.

This parameter is a sub-argument for otherparams.

Default: NO
defaultcharset add-on

The character set to be used in servlet requests and responses.

Defaults to ISO-8859-1 (also known as Latin-1). Ignored if the servlet request specifies a character set (for example, in the content-type header of a POST).

The values of this parameter may be specified either as an IANA character set name (for example, SHIFT_JIS) or as an Oracle character set name (for example, JA16SJIS). It should match the character set specified in the NLS_LANG environment variable, and it should also be a character set that the browser can display. Also, if the browser allows multibyte characters to be entered directly into a URL, for example, using the IME, as opposed to URL escape sequences, and if end users should be allowed to do this, then the value of this parameter should match the character set that the browser uses to convert the entered characters into byte sequences.

Note:

If your configuration file contains configuration sections with names that contain characters other than 7-bit ASCII characters, then the following rules apply. If a config parameter is specified in a URL or in the body of a POST request with no specified character set, and the value contains non-7-bit ASCII characters, then the value is interpreted using a character set named in the defaultcharset parameter. However, only the language-dependent default section and the language-independent default section of the configuration file is searched for the defaultcharset parameter. No other configuration section is searched because the name is not yet known.

This parameter is an application system parameter.
digitSubstitution advanced

Specifies the shape of decimal digits in BIDI environments.

Valid values [case-insensitive]:

  • None, which indicates European digits, regardless of the field direction.
  • National, which indicates Arabic-Indic digits (U+066x or Hindi format), regardless of the field direction.
  • Context, which indicates European digits in a left-to-right field, and Arabic-Indic digits in a right-to-left field.

Default: Context
disableMDIScrollbars add-on

Specifies whether to disable horizontal and vertical scroll bars in the Forms main applet window.

Default: FALSE
disableValidateClipboard advanced

Specifies whether to disable validation of the clipboard when focus moves. This may improve performance. However, the PASTE menu bar icon will be enabled whenever the item that now has focus is editable, even if it an attempt to paste into it would fail.

Default: FALSE
dynamicLayout add-on applet param

Specifies whether the Forms applet should redraw the parent window (and notify the server) while resizing the window. Enabling causes an increase of network traffic while resizing is in progress.

Default: TRUE
enableJavaScriptEvent advanced

Specifies whether JavaScript events can be raised on the client, and whether the WEB.JAVASCRIPT_EVAL_EXPR procedure or WEB.JAVASCRIPT_EVAL_FUNC function can be executed on the server.

Default: TRUE
EndUserMonitoringEnabled trace

Specifies whether End User Monitoring integration is enabled.

Default: FALSE
EndUserMonitoringURL trace Specifies where to record End User Monitoring data.
envFile basic

The name of the environment configuration file.

This parameter is an application system parameter.

Required.

Default: default.env
escapeparams advanced

If set to FALSE, runform will treat special characters in runform parameters as it did in releases earlier than 9.0.4. This parameter has no effect unless it is the first sub-argument of the serverArgs config or applet parameter, in which case it specifies whether to escape certain special characters in values extracted from the URL for subsequent runform parameters in the serverArgs parameter.

This parameter is an application system parameter.

Default: TRUE

Default if unspecified: FALSE
form basic

The name of the top-level (initial) Forms module (fmx file) to run.

This parameter is a runform parameter.

Required.

Default: test.fmx
formsMessageListener advanced The class that the Forms client uses to enable recording of Forms messages for Tool Vendor Interface (TVI)/Intercept Server.
fsalcheck advanced

Specifies whether to perform checksum comparison of Forms standalone app launcher. When enabled, it triggers a comparison to be made on server. The checksum of FSAL on the client machine will be compared with the checksum of FSAL archived on the server.

Setting this parameter to FALSE also disables automatic updating for FSAL when needed. To disable automatic updating while retaining fsalCheck functionality, set fsalEnableAutoUpdate to FALSE. Setting fsalCheck to FALSE is not recommended.

This parameter is an application system parameter.

Default: TRUE
fsalEnableAutoUpdate advanced Specifies whether to update the FSAL utility automatically if the user's detected version is not compatible with the server.
fsalJavaVersion advanced

Specifies which Java version is to be used on the end-user environment.

Example values:

  • 1.8.0_351 or 17.0.5: Runs this version only.
  • 1.8* or 1.8.0*: Runs any version in the Java 8 family, but no family earlier or later than Java 8.
  • 1.8.0_351*: Runs only the specified version or later in the Java 8 family.
  • 17* or 17.0*: Runs any version in the Java 17 family, but no family earlier or later than Java 17.
  • 17.0.5*: Runs only the specified version or later in the Java 17 family.
  • 1.8+ or 1.8.0+: Runs any version in the Java 8 family or any family newer.
  • 1.8.0_351+: Runs the specified version or later in the Java 8 family or any version in a later family.
  • 17+ or 17.0+: Runs any version in the Java 17 or later family.
  • 17.0.5+: Runs the specified version or later in the Java 17 family or any version in a later family.
fsalUpdateDialogText add-on Specifies the text that is presented in the Forms Standalone Launcher Updater dialog. If no value is specified, the default text provided by Oracle Forms is displayed. If a value is set, its maximum length cannot exceed 128 characters. Any text beyond 128 characters is truncated.
guiMode applet

Specifies the visibility of the default Windows menu bar and the Windows title bar.

Note:

This parameter is applicable for a menu bar only when no menu is specified for a form in the Form Builder; if there is any menu associated with the form, then this parameter is not applicable. In case of window-bars, this parameter is applicable even if there is a menu specified for that form in the Form Builder. This parameter does not affect title bars in alert windows or pop-up windows.

Valid values are:

  • 0. Indicates that the Windows title bar and the default Windows menu bar are both visible.
  • 1. Indicates that the Windows title bar is visible, but the default Windows menu bar is not visible (unless it has children).
  • 2. Indicates that the Windows title bar is not visible, but the default Windows menu bar is visible.
  • 3. Indicates that the Windows title bar is not visible, and the default Windows menu bar is also not visible (unless it has children).

Default: 0
gzipCompressApplet add-on

Specifying TRUE will cause the Forms Servlet to attempt compressing the html/jnlp content sent to the client. This assumes that the request coming from the client indicates support for compression in its HTTP Accept-Encoding header. Enabling this parameter can help to reduce application start up time. This setting may interfere with some testing tools. If such a problem occurs, simply disable this parameter while testing is being performed.

This parameter is an application system parameter.

Default: FALSE
heartBeat add-on

The interval, in minutes, at which a client sends a packet to the server to indicate that it is still running. Fractional values are allowed, for example 0.5 for 30 seconds.

Caution:

Setting this value too low will cause a significant increase in network traffic and therefore should be used cautiously.

Keep in mind:

  • This parameter is similar to maxeventwait: the lower interval takes precedence.
  • If the heartBeat is less than the value specified by the FORMS_TIMEOUT environment variable, the user's session is kept active, even if they are not actively using the form.

    Note:

    It is not recommended to set the value of heartBeat greater than the value of FORMS_TIMEOUT because this will result in the termination of the user's existing session. Terminating the running form in this manner will result in the user session becoming unresponsive.
  • If heartBeat is higher than the parameter, session-timeout, then the value of session-timeout takes precedence over heartBeat. To increase the value of heartBeat, the value of session-timeout must be greater than heartBeat. For information about this parameter, see Session Timeout in Developing Web Applications, Servlets, and JSPs for Oracle WebLogic Server.

This parameter is an application system parameter.

Default: 2 minutes
height basic

The height of the form applet, in pixels.

You can also specify the value of the height as a percentage. This value is relative to the size of the content area of the browser. The value should not exceed 100% or be less than 1%.

To use a percentage value, the numeric value must be followed by a percentage (%) sign, like this: HEIGHT=75%. This example specifies that the applet height is 75% of the size of the browser's content area.

Required.

Default: 600
hideActivityBar add-on applet param

Specifies whether the Forms activity bar (also known as progress bar) should be hidden.

Default: FALSE
hideAppletVersion add-on applet param

Specifies whether to display the Forms applet version in the client side console.

This parameter is an application system parameter.

Default: FALSE
hideClientExceptions add-on applet param

Specifies whether Java exceptions should not be displayed to the end-user in both the Java console and error message dialog.

Default: FALSE
hideWindowMenuItem add-on

Specifies whether to hide a "Window" menu item in the Forms menu bar. When set to TRUE, the Window menu item does not appear if the form does not have a custom or default menu.

Note:

When set to TRUE, the menu bar logo still appears unless it is disabled or hidden by setting the logo parameter to FALSE and/or if the guiMode parameter is set to 1 or 3.

Default: FALSE
highContrast advanced

When highContrast is set to TRUE, frame labels are black if foreground and background colors are not specified.

Default: FALSE
honorLineWidth add-on

Specifies whether to use the line width size specified at design-time for graphic objects like lines, rectangles, frames, and so on. Set to TRUE to enable this functionality.

Default: FALSE
host trace

Specifies the host for the debugging session. This parameter is necessary for debugging purposes only. It identifies the host on which the forms engine process is started.

This parameter is a runform parameter.
HTMLafterForm html HTML content to be added to the page below the area where the Forms application is displayed.
HTMLbeforeForm html HTML content to be added to the page above the area where the Forms application is displayed.
HTMLbodyAttrs html Attributes for the <BODY> tag of the HTML page.
HTMLdelimiter advanced

The delimiter for variable parameters in the base HTML files.

This parameter is an application system parameter.

Default: %
idleTimeout advanced

Specifies, in seconds, how much idle time can elapse before a SYSTEM_CLIENT_IDLE event will fire.

This parameter is an application system parameter.
ignoreMissingSaaArchives advanced

Specifies whether the application should continue initializing and/or running even if a needed resource, such as a JAR file, cannot be found. This parameter is intended for troubleshooting purposes only. Even though an application may continue to run with a missing resource, errors may still be presented.

Default: FALSE
ignoreSaaCache add-on applet param

Specifies whether the Oracle Forms Standalone Application Launcher should ignore files specified by the archive configuration parameter (for example, frmall.jar) that were originally downloaded from the Forms server but have been cached on the java client machine from which the Oracle Forms Standalone Application Launcher is being run. If FALSE (the default) is specified, then a cached file will be used if its path corresponds (modulo some hashing) to the full URL of the file on the Forms server and the timestamp of the cached file matches the timestamp of the Forms server file. If TRUE is specified, then cached files are ignored: all files specified by the archive configuration parameter are downloaded from the Forms server.

Default: FALSE
imageBase plugin

Specifies where icon or image files are stored.

Valid values:

  • codeBase, which indicates that the icon search path is relative to the directory that contains the Java classes. Use this value if you store your icons or images in a JAR file (recommended).
  • documentBase, which indicates that the icon search path is relative to the Forms webapp's directory. The Forms webapp's directory is located at $DOMAIN_HOME/servers/WLS_FORMS/tmp/_WL_user/formsapp_12.2.1/<random string>/war.

Default: codeBase

Default if unspecified: documentBase
isResizable applet add-on

Specifies whether the Forms separate frame resizing ability is enabled. When used with separateFrame=true, the Forms separate frame resizing ability can be enabled or disabled. If separateFrame=false, setting this parameter will have no effect on the frame.

Default: TRUE
JavaScriptBlocksHeartBeat advanced

Specifies whether HeartBeat is blocked when a JavaScript call is a blocking call.

Default: FALSE
java_version plugin

Specifies which Java version is to be used on the end-user environment. This parameter is ignored when using the Forms Standalone Launcher (FSAL). For FSAL, use fsalJavaVersion instead. Refer to the entry for fsalJavaVersion in this table for details.

Required.

Default: 1.7+
jnlpMatchIP add-on

Specifies whether a JNLP file is rejected if launched from an IP address that differs from the IP address where the JNLP file was generated. This can help ensure the JNLP file is not moved from one machine to another.

Note:

This parameter may not work correctly when used behind some proxy servers, such as a load balancer or Oracle HTTP Server. In such a case, disable this setting.

Default: FALSE
jnlpTimeout add-on

Specifies the duration (in seconds) a Java Web Start (JWS) jnlp file should be valid. After the timeout period, the jnlp file is no longer valid and must be refreshed in order to run the application.

Valid values: Whole numbers (0 or greater). 0 or an invalid value disables the timeout.

Default: 600 seconds when using JWS with SSO and 0 when using JWS without SSO.

jnlp2FA add-on

Specifies whether to enforce the use of a verification code in order to start the application when launched using Java Web Start (JWS/jnlp).

When enabled, a verification code will be presented in the browser if the application was requested through the Forms Servlet (dynamically). This code must be entered in the application when prompted.

This behavior is similar to two-factor authentication except that the code is provided on the same device from where the initial request was made. This ensures the jnlp file is launched on the same machine from where it was requested and it has not been shared.

Default: FALSE
jpi_classid plugin

The Oracle Java Plug-in class ID. formsweb.cfg specifies an appropriate value. This parameter is required.

Note:

This parameter applies to the Java Plugin and embedded applets. The feature is desupported but retained for backward compatibility only. It is recommended that Java Web Start or the Forms Standalone Launcher be used to run applications.

Default: clsid:8AD9C840-044E-11D1-B3E9-00805F499D93
jpi_codebase plugin The location from which the Java Plug-in (not the applet) can be downloaded if necessary. Currently unused because Java itself no longer provides a default location that would work with this value.
jpi_download_page plugin

The Oracle Java Plug-in download page. formsweb.cfg specifies an appropriate value.

Note:

This parameter applies to the Java Plugin and embedded applets. The feature is desupported but retained for backward compatibility only. It is recommended that Java Web Start or the Forms Standalone Launcher be used to run applications.

Default: https://www.oracle.com/java/technologies/downloads

jpi_mimetype plugin

The value of the TYPE applet parameter.

Required.

Default: application/x-java-applet
legacy_lifecycle advanced

Applet parameter for Oracle Java Plug-in. A value of TRUE causes a running applet to be reused when requested. This parameter also affects the contents of the initial page that is generated as the response from the Forms servlet, to ensure the reusability of the applet when legacy_lifecycle is set to TRUE. When set to TRUE, JavaScript must be enabled on the Java client.

Note:

This parameter applies to the Java Plugin and embedded applets. The feature is desupported but retained for backward compatibility only. It is recommended that Java Web Start or the Forms Standalone Launcher be used to run applications.

Default: FALSE
log trace

Supports tracing and logging. The value of this parameter, if set, is the file name of the trace log file.

This parameter is a sub-argument for otherparams. This parameter is treated as an application system parameter even if the otherparams parameter is not specified in the restrictedURLparams parameter.

logo applet Specifies the image file that should appear at the Forms menu bar. Specify NO for no logo. Leave empty to use the default Oracle logo.
logoClickURL add-on

Specifies a URL for the menu bar logo icon hyperlink. When a value is provided, users see a mouse hand icon when hovering over the logo. Clicking the logo opens the specified URL in a web browser.
logoutTargetURLParamName advanced

The name of the URL parameter which specifies the URL to which Oracle Access Manager will redirect after performing a logout.

This parameter is an application system parameter.

Default: end_url
lookAndFeel applet

Specifies the application's look-and-feel.

Valid values [case-insensitive]: Oracle or Generic (Windows look-and-feel)

Default: Oracle
maxeventwait add-on

The interval, in milliseconds, at which a client sends a packet to the server to indicate that it is still running and check for new events that might have occurred. This parameter is similar to heartbeat: the lower interval takes precedence.

This parameter is an application system parameter.

Caution:

Setting this value too low will cause a significant increase in network traffic and therefore should be use cautiously.
maxRuntimeProcesses add-on

The maximum allowable number of concurrent Forms run-time processes. It should be set a value that reflects the customer's hardware configuration (and the portion that can be used by Forms applications). A value of 0 (the default) indicates that there is no explicit limit. This default is not recommended, because it leaves the system vulnerable to Denial of Service attacks.

This parameter is a global system parameter. It must be specified in the default config section of formsweb.cfg. The value is read from formsweb.cfg on every request to the Forms servlet.

Default: 0
networkRetries advanced

Number of times the client should retry if a network failure occurs.

Default: 0
networkStats add-on applet param

Specifies whether to enable the display of the aggregate statistics in the status bar and the display of round-trip statistics in the Java console.

Default: FALSE
oam_redirect_root servlet

Used in cases where mixed protocols are used between the end-user, OHS, Forms, and OAM.

Valid values include HTTP, HTTPS, or a fully qualified URL to the server hosting Forms—for example,<protocol>://<client-visible-host-name.domain>:<client-visible-port>.
OAuth2AuthorizationTimeout advanced

Specifies the amount of time, in seconds, to wait for OAuth2 authorization to be completed and control to return to the Forms application.

Default: 300
obr advanced

For internal use only.

This parameter is a sub-argument for otherparams.

Default: NO

otherparams advanced

Command line parameters to pass to the Forms run-time process in addition to form and userid.

This parameter is a runform parameter.

Note:

Special syntax rules apply to this parameter when it is specified in a URL: a + may be used to separate multiple name=value pairs. See Specifying Special Characters in Values of Runform Parameters. For production environments, include the otherparams parameter in the value of the restrictedURLparams parameter, in order to provide better control over which runform parameters end users can specify in a URL.

Default: obr=%obr% record=%record% tracegroup=%tracegroup% log=%log% term=%term% ssoProxyConnect=%ssoProxyConnect%
pageTitle html

HTML page title.

Default: Oracle Fusion Middleware Forms Services
pingStats add-on applet param

Specifies whether to enable the pinging of the managed server by the Java applet when Forms is being rendered. The ping result is, then, displayed on the Java console.

Default: FALSE
pingWait add-on applet param

The maximum amount of time (in milliseconds) that pinging of the managed server (specified by the pingStats parameter) must wait to receive a response from the server.

Default: 300
port trace

Port to use for debugging. The value of this parameter identifies the port on which the forms engine process is listening and is used for debugging purposes only. This parameter is ignored if serverURL has been specified.

This parameter is a runform parameter.

Default: 9000

preserveHttpSessionId add-on

Specifies whether the HTTP session ID should be preserved after being made visible. This can happen during SSO authentication in two cases:

  • For a Web Start application, the HTTP session ID will be visible in the generated JNLP file.
  • For a Standalone application, the HTTP session ID will be visible in the browser's URL address bar in the dynamic resource creation page, if URL rewriting is being used for session management [cookies-enabled specified as false in weblogic.xml or weblogic-application.xml].

A value of FALSE indicates that the HTTP session ID should be changed after being made visible.

Caution:

Changing the HTTP session ID might break certain load balancer configurations.

This parameter is an application system parameter.

Default: FALSE
prestartIncrement add-on

The number of run-time processes to be created when the number of prestarted run-time processes is less than prestartMin.

This parameter is a global system parameter. For each config section, the value specified or inherited by that config section applies to any prestarting for the config section. The value is read from formsweb.cfg whenever a prestarted runform process is taken from the pool for the config section.

Default: 1

prestartInit add-on

The number of the run-time processes that should be spawned initially.

This parameter is a global system parameter. For each config section, the value specified or inherited by that config section applies to any prestarting for the config section. The value is read from formsweb.cfg only during frmservlet initialization.

Default: 1

prestartMin add-on

The minimum number of run-time processes to exist in the pool.

This parameter is a global system parameter. For each config section, the value specified or inherited by that config section applies to any prestarting for the config section. The value is read from formsweb.cfg whenever a prestarted runform process is taken from the pool for the config section.

Default: 0
prestartRuntimes add-on

Specifies whether run-time prestarting or pooling is enabled.

This parameter is a global system parameter. For each config section, the value specified or inherited by that config section applies to any prestarting for the config section. The value is read from formsweb.cfg only during frmservlet initialization.

Default: FALSE

prestartTimeout add-on

Time in minutes after which all the prestarted processes of this pool (configuration section) is stopped. A run-time process is removed from the prestart pool after the client connection is made and thus is not stopped.

This parameter is a global system parameter. For each config section, the value specified or inherited by that config section applies to any prestarting for the config section. The value is read from formsweb.cfg only during frmservlet initialization.

Default: 0
query_only add-on

Set this parameter to YES to prevent the end user from inserting, updating, or deleting records.

This parameter is a sub-argument for otherparams.

Default: NO

quiet add-on

Set this parameter to YES to prevent messages from producing an audible beep.

This parameter is a sub-argument for otherparams.

Default: NO

record trace

Supports tracing and logging. Valid values:

  • forms, used for standard tracing with a tracegroup.
  • names, used by external testing tools.

This parameter is a sub-argument for otherparams.

recordFileName advanced The name of the file (for example, d:\temp\out.log) that stores the recorded Forms messages.
removeCommentLinesFromApplet add-on

Specifies whether to remove comment lines from html/jnlp sent to client. This can improve start up performance and reduce the amount of content being sent to user.

This parameter is an application system parameter.

Default: FALSE

restrictedURLchars add-on

Comma-separated list of characters which are restricted from use in the request URL's query string.

This parameter is an application system parameter.
restrictedURLparams advanced

Comma-separated list of parameters which are rejected if specified in a URL.

This parameter is an application system parameter.

Default: pageTitle,HTMLbodyAttrs,HTMLbeforeForm,HTMLafterForm,log
scaleLogo add-on applet param

Specifies the scaling behavior when clientDPI is increased from the default. If set to TRUE, all objects and fonts in a running form, including the logo on the right side of the menu bar, are properly magnified across all objects of the application.

If set to FALSE, all objects and fonts, except for the logo, are sized accordingly. The logo remains unchanged.

Default: TRUE
sendHeartBeatBean add-on applet param

Set this parameter to TRUE to prevent Java Beans or PJCs that display modal dialogs/windows from blocking the Forms heartbeat.

Default: FALSE
separateFrame applet

Specifies whether the applet appears within a separate window.

Note:

This parameter applies to the Java Plugin and embedded applets. The feature is desupported but retained for backward compatibility only. It is recommended that Java Web Start or the Forms Standalone Launcher be used to run applications.

Default: FALSE
separate_jvm advanced

A Boolean parameter specifying that the applet should run in its own JVM instance on the user environment. This is useful for applets which can not tolerate any interference from other applets running in the same JVM and potentially consuming heap space or other resources. This setting only applies to running applications embedded in a browser like Microsoft Internet Explorer.

Note:

This parameter applies to the Java Plugin and embedded applets. The feature is desupported but retained for backward compatibility only. It is recommended that Java Web Start or the Forms Standalone Launcher be used to run applications.

Default: FALSE

serverApp advanced

Specifies the name of the application-specific Registry.dat entries to be used. The value of serverApp must correspond to the attribute NAME in the Registry.dat.

For example, Registry.dat may include two or more default Fontname settings:

  • default.fontMap.defaultFontname=Dialog (A default Oracle-provided setting); and
  • sales.fontMap.defaultFontname=Dialog (A custom setting for Sales).

To use the Sales custom settings, set serverApp to sales. Otherwise, leave serverApp set to the default (default).

Note:

Only entries that begin with default in Registry.dat can be customized using the serverApp parameter. See Managing Registry.dat with Fusion Middleware Control.

Default: default

serverURL advanced

The URL path to Forms Listener Servlet.

This parameter is an application system parameter.

Required.

Default: /forms/lservlet
sessionCookieName add-on

The cookie-name (if any) specified in weblogic.xml or weblogic-application.xml.

Required for SSO processing if a cookie-name other than JSESSIONID is specified in weblogic.xml or weblogic-application.xml.

This parameter is a global system parameter. It must be specified in the default config section of formsweb.cfg. The value is read from formsweb.cfg only during frmservlet initialization.

Default: JSESSIONID
sessionCookiePath add-on

The cookie-path (if any) specified in weblogic.xml or weblogic-application.xml. This is required for SSO processing if a cookie-path other than / is specified.

This parameter is a global system parameter. It must be specified in the default config section of formsweb.cfg. The value is read from formsweb.cfg only during frmservlet initialization.

Default: /

smartBarHeight add-on applet param

Specifies the desired Smartbar menu size to be used at runtime. Smartbar icons larger than the button size will be clipped. Smartbar icons smaller than the button size will scale up to fill the button, unless the smartbarIconScaling parameter is set to FALSE.

The default (for example, unset) or a setting to any value other than those listed here will result in buttons fixed to contain icons that are 16x16. These buttons will not scale if the value of clientDPI is changed.

Valid values [case-insensitive]: medium (32x32), large (48x48), dynamic (adapts based on value of clientDPI).

smartbarIconScaling add-on applet param

Specifies whether Smartbar icons smaller than the button size will scale up to fill the button.

Default: TRUE
smoothScalingMaxZoom add-on applet param

Smooth scaling often produces a significant improvement in image quality when the scaling factor is significantly lower than 100%. This improvement decreases as scale increases, and seems unnoticeable when the scaling factor is significantly greater than 100%. The downside of smooth scaling is that a large scaling factor may produce an OutOfMemoryError [which will leave the image item blank]; the probability increases as the scaling factor increases. Smooth scaling is by default not enabled. This parameter specifies the tradeoff between image quality and the probability of an OutOfMemoryError. It specifies the maximum zoom percent for which smooth scaling will be used. Fractional values are allowed.

For example, set smoothScalingMaxZoom=200. This would specify that smooth scaling should be used for all downscaling, and for upscaling up to a factor of 2 (200%). Note that smoothScalingMaxZoom can be specified in a URL. An end user might want to lower it or disable it altogether [by specifying smoothScalingMaxZoom=0] if an OutOfMemoryError occurred. [Even if the Java console is not visible, a blank image item would suggest that an OutOfMemoryError had occurred.]

splashScreen applet Specifies the image file that should appear before the applet appears. Specify NO for no splash. Leave empty to use the default splash image. Supported image formats are: gif, png, and jpg. To set the parameter include the file name (for example, myfile.gif) or the virtual path and file name (for example, images/myfile.gif).
ssoCancelUrl sso

The URL to redirect to if the user presses Cancel in the dynamic resource creation page.

This parameter is an application system parameter.
ssoDynamicResourceCreate sso

Specifies whether dynamic resource creation is enabled if the resource is not yet created in OID (Oracle Internet Directory) or OPSS (Oracle Platform Security Services). If set to TRUE, users are presented with a web page where they are prompted to provide the necessary database credentials needed to run the application.

This parameter is an application system parameter.

Default: TRUE

ssoErrorUrl sso

The URL to redirect to if ssoDynamicResourceCreate is set to FALSE.

This parameter is an application system parameter.
ssoLogout sso

Specifies whether the SSO session should be logged out while exiting the Forms application.

This parameter is an application system parameter.

Default: FALSE

ssoLogoutRedirect sso

The URL which the browser should be redirected to after SSO logout.

This parameter is an application system parameter.
ssoMode sso

Specifies whether to enable single sign-on (SSO).

This parameter is an application system parameter.

Default: FALSE
ssoProxyConnect sso

Specifies whether session should operate in proxy user support. Set ssoProxyConnect to YES to enable for particular application.

This parameter is a sub-argument for otherparams.

Default: NO

ssoSaaBrowserLaunchTimeout add-on

Specifies, in seconds, how long the Forms servlet will wait for the initial request from the browser that was spawned by the Standalone launcher for SSO authentication. If the interval expires, the fatal error FRM-93249 is reported.

This parameter is an application system parameter.

Valid values: Integers in the range 1-300

Default: 15

ssoSaaBrowserPageTimeout add-on

Specifies, in seconds, how long the Forms servlet will wait for the user to enter data into a browser page during SSO authentication for a Standalone application. If the interval expires, the fatal error FRM-93382 or FRM-93383 is reported.

This parameter is an application system parameter.

Valid values: An integer >= 15, or 0 (which indicates that the Forms servlet will wait indefinitely)

Default: 300
ssoSaaWaitInterval add-on

Specifies the interval, in seconds, at which the Standalone launcher reissues requests directly to the Forms servlet while SSO authentication is proceeding in the launched browser window. Larger values reduce network traffic but increase the chances of an intermediate agent timing out (thereby producing the fatal error FRM-93248).

This parameter is an application system parameter.

Valid values: An integer >= 5, or 0 (which indicates that the Standalone launcher should not reissue requests)

Default: 25
ssoSuccessLogonUrl sso add-on

The URL to redirect to if SSO authentication completes successfully for a Standalone application.

This parameter is an application system parameter.
tabstop add-on applet param

Specifies the tab stop size for all multi-line text fields in the application.

Valid values: A positive integer no greater than the total character width of any field in which tabs are expected to be used.

Default: 4
term advanced

The full path of a custom key binding file (to be used instead of the standard fmrweb or fmrweb_utf8 files).

This parameter is a sub-argument for otherparams.

tracegroup trace

Supports tracing and logging.

This parameter is a sub-argument for otherparams.

treeIconHeight add-on

Specifies an alternative hierarchical tree icon size. If not specified, h-trees will only display 16×16 pixel icons when added to a tree node.

Icons larger than the set size will be clipped. Icons smaller than the set size will scale up to fill the available space, unless the treeIconScaling parameter is set to FALSE. The default (not set) or any setting to a value other than those listed here will result in icons that are 16×16. These will not scale if the value of clientDPI is changed.

Note:

The space between the tree nodes is determined by the font size used in the tree. Adjusting the font size may be necessary in order to avoid having nodes overlap or become excessively spaced apart when using various icon sizes.

Valid values [case-insensitive]: medium (32×32), large (48×48), dynamic (adapts based on value of clientDPI).
treeIconScaling add-on

Specifies whether hierarchical tree (h-tree) icons that are smaller than the tree node size scale up to fill the available space.

Default: TRUE
useAntiAlias add-on

Specifies whether to use anti-aliasing for rendering Forms graphic objects like lines, rectangles, ellipse, polyline, and so on. Setting this to TRUE reduces the jagged edges that can appear with drawing objects. Although setting this to FALSE appears to sharpen the drawing objects, it does increase the jagged edges.

Default: TRUE
userid basic

Login string. Example: user1/user1@ORADB.

This parameter is a runform parameter.
websocketJSILogging add-on applet param

Specifies whether to enable WJSI logging. Output will be sent to the Java Console.

Default: FALSE
websocketJSIServerTimeout add-on applet param

The time, in minutes, that the WJSI server should continue to run while idle. After this time, the value specified by the FORMS_TIMEOUT environment variable will be honored.

Default: 0
websocketJSISessionTimeout add-on applet param

The time, in minutes, that the WJSI session should be permitted to remain idle before being terminated.

Default: 5
webstart plugin

Specifies whether Web Start should be enabled.

This parameter is an application system parameter.
webstart_codebase add-on

The URL to the application Codebase. This may be required when using Java Web Start and the Forms managed server (WLS) is behind a proxy server.

Example: webstart_codebase=http://proxy_server:port/forms/java

Note:

The use of this parameter is often not necessary when the WebLogic setting, WebLogic Plug-in, is enabled for either all associated Managed Servers (such as WLS_FORMS) or the responsible Cluster (such as cluster_forms).

This parameter is an application system parameter.
WebUtilArchive add-on

A comma-separated list of archives (JARs) needed to support a WebUtil-enabled application. The Oracle provided frmwebutil.jar file must be included in this list. Additional files are optional, based on the application design.

Note:

The contents of this list are appended to the content of the ARCHIVE parameter. Therefore, use caution to avoid duplicating entries.
WebUtilDispatchMonitorInterval add-on

Used with the WebUtil_Session package to control how often the monitor thread checks to see if the Forms session is still alive. The value is measured in seconds. Refer to the WebUtil Guide in the Builder Help.

Default: 5
WebUtilErrorMode add-on

Specifies where errors are displayed. Errors will always be displayed on the Java console but they can also be displayed elsewhere.

Valid values are: console, server, alert, and all

Note:

Refer to the WebUtil Guide in the Builder Help.

Default: CONSOLE
WebUtilLogging add-on

Specifies the logging level for WebUtil.

Valid values include: off, console, server, and all

Note:

Refer to the WebUtil Guide in the Builder Help.

Default: OFF
WebUtilLoggingDetail add-on

Specifies the level of detail WebUtil logging should record.

Valid values include: normal and detailed

Note:

Refer to the WebUtil Guide in the Builder Help.

Default: NORMAL
WebUtilMaxTransferSize add-on

Specifies the maximum segment size (in bytes) to break up a file when transferring it with WebUtil. Larger values can improve performance, but may cause failures on low bandwidth or unstable networks.

A valid value must be a whole number from 1 - 24573. A setting of 24573 is the maximum and recommended value for most cases, as it provides the best transfer performance.

Note:

Refer to the WebUtil Guide in the Builder Help.

Default: 24573
WebUtilNextGenHost add-on

Specifies whether to use the new Java security model needed to make external operating system commands when using CLIENT_HOST. In most cases, this setting should not be changed from its default.

Default: TRUE
WebUtilTrustInternal add-on Specifies whether to trust computers within an intranet. When set to TRUE (default), this indicates that all the intranet computers are trusted. When set to FALSE, users always need to type the domain suffixes to match the domain filter in TrustedDomains.txt.

Note:

Refer to the WebUtil Guide in the Builder Help.

Default: TRUE
WebUtilVersion add-on applet param

Specifies whether to display the WebUtil version in the client side console.

Default: FALSE
width basic

The width of the form applet, in pixels.

You can also specify the value of the width in percentage. This value is relative to the size of the content area of the browser. The value should not exceed 100% or be less than 1%.

To use a percentage value, the numeric value must be followed by a percentage (%) sign, like this: WIDTH=75%. This example specifies that the applet width is 75% of the size of the browser's content area.

Required.

Default: 750