Skip Headers

Oracle Application Server Forms Services Deployment Guide 10g (9.0.4) Part Number B10470-01 |
Home | Contents | Index

# B
Sample Configuration Files

During the installation, the following configuration files were installed onto your system:

- Default formsweb.cfg File

- Platform Specific default.env Files

- base.htm, basejini.htm, basejpi.htm, and baseie.htm Files

- web.xml

- forms90.conf

- Registry.dat

## B.1 Default formsweb.cfg File

The default formsweb.cfg file contains the following:

    # formsweb.cfg defines parameter values used by the FormsServlet (f90servlet)
    # This section defines the Default settings. Any of them may be overridden in

    # the following Named Configuration sections.  If they are not overridden, then
    # the values here will be used.
    # The default settings comprise two types of parameters: System parameters,
    # which cannot be overridden in the URL, and User Parameters, which can.
    # Parameters which are not marked as System parameters are User parameters.
    #

    # SYSTEM PARAMETERS
    # -----------------
    # These have fixed names and give information required by the Forms
    # Servlet in order to function.  They cannot be specified in the URL query
    # string.  But they can be overriden in a named configuration (see below).
    # Some parameters specify file names: if the full path is not given,
    # they are assumed to be in the same directory as this file.  If a path
    # is given, then it should be a physical path, not a URL.
    #

    # USER PARAMETERS
    # ---------------
    # These match variables (e.g. %form%) in the baseHTML file. Their values
    # may be overridden by specifying them in the URL query string
    # (e.g. "http://myhost.mydomain.com/servlet/f90servlet?form=myform&width=700")
    # or by overriding them in a specific, named configuration (see below)
    [default]
    # System parameter: default base HTML file
    baseHTML=base.htm
    # System parameter: base HTML file for use with JInitiator client
    baseHTMLjinitiator=basejini.htm
    # System parameter: base HTML file for use with Sun's Java Plug-In
    baseHTMLjpi=basejpi.htm
    # System parameter: base HTML file for use with Microsoft Internet Explorer
    # (when using the native JVM)
    baseHTMLie=baseie.htm
    # System parameter: delimiter for parameters in the base HTML files
    HTMLdelimiter=%
    # System parameter: working directory for Forms runtime processes
    # WorkingDirectory defaults to <ORACLE_HOME>/forms90 if unset.
    workingDirectory=
    # System parameter: file setting environment variables for the Forms runtime
    processes
    envFile=default.env
    # System parameter: JVM option for Microsoft Internet Explorer.
    # This parameter specifies how to execute the Forms applet under
    # Microsoft Internet Explorer 5.x or above.  Put IE=native if you want
    # the Forms applet to run in the browser's native JVM.
    IE=JInitiator

    # Forms runtime argument: whether to escape certain special characters
    # in values extracted from the URL for other runtime arguments
    escapeparams=true
    # Forms runtime argument: which form module to run
    form=test.fmx
    # Forms runtime argument: database connection details
    userid=
    # Forms runtime argument: whether to run in debug mode
    debug=no
    # Forms runtime argument: host for debugging
    host=
    # Forms runtime argument: port for debugging
    port=
    # Other Forms runtime arguments: grouped together as one parameter.
    # These settings support running and debugging a form from the Builder:
    otherparams=buffer_records=%buffer% debug_messages=%debug_messages%
    array=%array% obr=%obr% query_only=%query_only% quiet=%quiet% render=%render%
    record=%record% tracegroup=%tracegroup% log=%log% term=%term%
    # Sub argument for otherparams
    buffer=no
    # Sub argument for otherparams
    debug_messages=no
    # Sub argument for otherparams
    array=no
    # Sub argument for otherparams
    obr=no
    # Sub argument for otherparams
    query_only=no
    # Sub argument for otherparams
    quiet=yes
    # Sub argument for otherparams
    render=no
    # Sub argument for otherparams
    record=
    # Sub argument for otherparams
    tracegroup=
    # Sub argument for otherparams
    log=
    # Sub argument for otherparams
    term=

    # HTML page title
    pageTitle=OracleAS Forms Services
    # HTML attributes for the BODY tag
    HTMLbodyAttrs=
    # HTML to add before the form
    HTMLbeforeForm=
    # HTML to add after the form
    HTMLafterForm=

    # Forms applet parameter: URL path to Forms ListenerServlet
    serverURL=/forms90/l90servlet
    # Forms applet parameter
    codebase=/forms90/java
    # Forms applet parameter
    imageBase=DocumentBase
    # Forms applet parameter
    width=750
    # Forms applet parameter
    height=600
    # Forms applet parameter
    separateFrame=false
    # Forms applet parameter
    splashScreen=
    # Forms applet parameter
    background=
    # Forms applet parameter
    lookAndFeel=Oracle
    # Forms applet parameter
    colorScheme=teal
    # Forms applet parameter
    logo=
    # Forms applet parameter
    restrictedURLparams=
    # Forms applet parameter
    formsMessageListener=
    # Forms applet parameter
    recordFileName=
    # Forms applet parameter
    serverApp=default
    # Forms applet archive setting for JInitiator
    archive_jini=f90all_jinit.jar
    # Forms applet archive setting for Microsoft Internet Explorer native JVM
    archive_ie=f90all.cab
    # Forms applet archive setting for other clients (Sun Java Plugin, Appletviewer,
    etc)
    archive=f90all.jar
    # Number of times client should retry if a network failure occurs.  You should
    # only change this after reading the documentation.
    networkRetries=0

    # Page displayed to Netscape users to allow them to download Oracle JInitiator.
    # Oracle JInitiator is used with Windows clients.
    # If you create your own page, you should set this parameter to point to it.
    jinit_download_page=/jinitiator/us/jinit_download.htm
    # Parameter related to the version of JInitiator
    jinit_classid=clsid:CAFECAFE-0013-0001-0009-ABCDEFABCDEF
    # Parameter related to the version of JInitiator
    jinit_exename=jinit.exe#Version=1,3,1,9
    # Parameter related to the version of JInitiator
    jinit_mimetype=application/x-jinit-applet;version=1.3.1.9

    # Page displayed to users to allow them to download Sun's Java Plugin.
    # Sun's Java Plugin is typically used for non-Windows clients.
    # (NOTE: you should check this page and possibly change the settings)
    jpi_download_page=http://java.sun.com/products/plugin/1.3/plugin-install.html
    # Parameter related to the version of the Java Plugin
    jpi_classid=clsid:8AD9C840-044E-11D1-B3E9-00805F499D93
    # Parameter related to the version of the Java Plugin
    jpi_
    codebase=http://java.sun.com/products/plugin/1.3/jinstall-13-win32.cab#Version=1
    ,3,0,0
    # Parameter related to the version of the Java Plugin
    jpi_mimetype=application/x-java-applet;version=1.3

    # EM config parameter
    # Set this to "1" to enable Enterprise Manager to track Forms processes
    em_mode=0

    # Single Sign-On OID configuration parameter
    oid_formsid=%OID_FORMSID%
    # Single Sign-On OID configuration parameter
    ORACLE_HOME=<ORACLE_HOME>
    # Single Sign-On OID configuration parameter
    formsid_group_dn=%GROUP_DN%
    # Single Sign-On OID configuration parameter: indicates whether we allow
    # dynamic resource creation if the resource is not yet created in the OID.
    ssoDynamicResourceCreate=true
    # Single Sign-On parameter: URL to redirect to if ssoDynamicResourceCreate=false
    ssoErrorUrl=
    # Single Sign-On parameter: Cancel URL for the dynamic resource creation DAS
    page.
    ssoCancelUrl=
    # Single Sign-On parameter: indicates whether the url is protected in which
    # case mod_osso will be given control for authentication or continue in
    # the FormsServlet if not. It is false by default. Set it to true in an
    # application-specific section to enable Single Sign-On for that application.
    ssoMode=false
    # The parameter allow_debug determines whether debugging is permitted.
    # Administrators should set allow_debug to "true" if servlet
    # debugging is required, or to provide access to the Forms Trace Xlate utility.
    # Otherwise these activities will not be allowed (for security reasons).
    allow_debug=false

    # Example Named Configuration Section
    # Example 1: configuration to run forms in a separate browser window with
    # "generic" look and feel (include "config=sepwin" in the URL)
    # You may define your own specific, named configurations (sets of parameters)
    # by adding special sections as illustrated in the following examples.
    # Note that you need only specify the parameters you want to change.  The
    # default values (defined above) will be used for all other parameters.
    # Use of a specific configuration can be requested by including the text
    # "config=<your_config_name>" in the query string of the URL used to run
    # a form.  For example, to use the sepwin configuration, your could issue
    # a URL like "http://myhost.mydomain.com/servlet/f90servlet?config=sepwin".
    [sepwin]
    separateFrame=True
    lookandfeel=Generic

    # Example Named Configuration Section
    # Example 2: configuration affecting users of MicroSoft Internet Explorer 5.x.
    # Forms applet will run under the browser's native JVM rather than using Oracle
    JInitiator.
    [ienative]
    IE=native

    # Example Named Configuration Section
    # Example 3: configuration forcing use of the Java Plugin in all cases (even if
    # the client browser is on Windows)
    [jpi]
    baseHTMLJInitiator=basejpi.htm
    baseHTMLie=basejpi.htm

    # Example Named Configuration Section
    # Example 4: configuration running the Forms ListenerServlet in debug mode
    # (debug messages will be written to the servlet engine's log file).
    [debug]
    serverURL=/forms90/l90servlet/debug

## B.2 Platform Specific default.env Files

There are two platform specific versions of default.env:

- Default default.env File for Windows

- Default default.env File for UNIX

### B.2.1 Default default.env File for Windows

    # default.env - default Forms environment file, Windows version
    #
    # This file is used to set the Forms runtime environment parameters.
    # If a parameter is not defined here, the value in the Windows registry
    # will be used. If no value is found in the registry, the value used will
    # be that defined in the environment in which the servlet engine (OC4J
    # or JServ) was started.
    #
    # NOTES
    # 1/ The Forms installation process should replace all occurrences of
    #    <percent>FORMS_<ORACLE_HOME><percent> with the correct <ORACLE_HOME>
    #    setting, and all occurrences of <percent>O_JDK_HOME<percent> with
    #    the location of the JDK (usually $<ORACLE_HOME>/jdk).
    #    Please make these changes manually if not.
    # 2/ Some of the variables below may need to be changed to suite your needs.
    #    Please refer to the Forms documentation for details.
    #
    ORACLE_HOME=<ORACLE_HOME>

      #
      # Search path for Forms applications (.fmx files, PL/SQL libraries)
      # If you need to include more than one directory, they should be semi-colon
      # separated (e.g. /private/dir1;/private/dir2)
      #
      # FORMS90_PATH=<ORACLE_HOME>/forms90

      #
      # The PATH setting is required in order to pick up the JVM (jvm.dll).
      # The Forms runtime executable and dll's are assumed to be in
      # <ORACLE_HOME>\bin if they are not in the PATH.
      # In addition, if you are running Graphics applications, you will need
      # to append the following to the path (where <Graphics Oracle Home> should
      # be replaced with the actual location of your Graphics 6i <ORACLE_HOME>):
      #
      # ;<Graphics Oracle Home>\bin;<Graphics Oracle Home>\jdk\bin
      #

      PATH=<ORACLE_HOME>\bin;<ORACLE_HOME>\jdk\jre\bin\client

      #
      # Settings for Graphics
      # -------------------------------
      # NOTE: These settings are only needed if Graphics applications
      # are called from Forms applications. In addition, you will need to
      # modify the PATH variable above as described above.
      #

        #
        # Please uncomment the following and put the correct 6i
        # <ORACLE_HOME> value to use Graphics applications.
        #
        #ORACLE_GRAPHICS6I_HOME=<your Graphics 6i <ORACLE_HOME> here>

        #
        # Search path for Graphics applications
        #
        #GRAPHICS60_PATH=

      #
      # Settings for forms tracing and logging
      # -----------------------------------------------
      # Note: This entry has to be uncommented to enable tracing and
      # logging.

        #FORMS90_TRACE_PATH=<ORACLE_HOME>\forms90\server

      #
      # System settings
      # ---------------
      # You should not normally need to modify these settings
      #
      FORMS90=<ORACLE_HOME>\forms90

      #
      # Java class path
      #   This is required for the Forms debugger
      #   You can append your own Java code here)
      # f90srv.jar, repository.jar and ldapjclnt9.jar are required for
      # the password expiry feature to work(#2213140).
      #
      CLASSPATH=<ORACLE_HOME>\j2ee\OC4J_BI_
    Forms\applications\forms90app\forms90web\WEB-INF\lib\f90srv.jar;<ORACLE_
    HOME>\jlib\repository.jar;<ORACLE_HOME>\jlib\ldapjclnt9.jar;<ORACLE_
    HOME>\jlib\debugger.jar;<ORACLE_HOME>\jlib\ewt3.jar;<ORACLE_
    HOME>\jlib\share.jar;<ORACLE_HOME>\jlib\utj90.jar;<ORACLE_
    HOME>\jlib\zrclient.jar;<ORACLE_HOME>\reports\jlib\rwrun.jar

### B.2.2 Default default.env File for UNIX

    # default.env - default Forms environment file, Solaris version
    #
    # This file is used to set the Forms runtime environment parameters.
    # If a parameter is not defined here, the value used will be that defined
    # in the environment in which the servlet engine (OC4J or JServ) was started.
    #
    # NOTES
    # 1/ The Forms installation process should replace all occurrences of
    #    <percent>FORMS_<ORACLE_HOME><percent> with the correct <ORACLE_HOME>
    #    setting, and all occurrences of <percent>O_JDK_HOME<percent> with
    #    the location of the JDK (usually $<ORACLE_HOME>/jdk).
    #    Please make these changes manually if not.
    # 2/ Some of the variables below may need to be changed to suite your needs.
    #    Please refer to the Forms documentation for details.
    #
    ORACLE_HOME=<ORACLE_HOME>

      #
      # Search path for Forms applications (.fmx files, PL/SQL libraries)
      #
      FORMS90_PATH=<ORACLE_HOME>/forms90

      # Java class path
      #   This is required for the Forms debugger
      #   You can append your own Java code here)
      # f90srv.jar, repository.jar and ldapjclnt9.jar are required for
      # the password expiry feature to work(#2213140).
      #
      CLASSPATH=<ORACLE_HOME>\j2ee\OC4J_BI_
    Forms\applications\forms90app\forms90web\WEB-INF\lib\f90srv.jar;<ORACLE_
    HOME>\jlib\repository.jar;<ORACLE_HOME>\jlib\ldapjclnt9.jar;<ORACLE_
    HOME>\jlib\debugger.jar;<ORACLE_HOME>\jlib\ewt3.jar;<ORACLE_
    HOME>\jlib\share.jar;<ORACLE_HOME>\jlib\utj90.jar;<ORACLE_
    HOME>\jlib\zrclient.jar;<ORACLE_HOME>\reports\jlib\rwrun.jar

      #
      # The PATH setting is not required for Forms if the Forms executables are
      # in <ORACLE_HOME>/bin. However, it is required if Graphics applications
      # are called from Forms applications.
      #
      PATH=<ORACLE_HOME>/bin

      #
      # Settings for Reports
      # -------------------------------
      # NOTE: This setting is only needed if Reports applications
      # are called from Forms applications
      # However, because of bug 2336698 where a report is started from
      # a forms debugger session with an already running JVM, then
      # the report's class path should also be included in the forms
      # class path.
    REPORTS_CLASSPATH=<ORACLE_HOME>/jlib/zrclient.jar:<ORACLE_
    HOME>/reports/jlib/rwrun.jar

      #
      #
      # Settings for Graphics
      # -------------------------------
      # NOTE: These settings are only needed if Graphics applications
      # are called from Forms applications
      #

        #
        # Please uncomment the following and put the correct 6i
        # <ORACLE_HOME> value to use Graphics applications.
        #
        #ORACLE_GRAPHICS6I_HOME=<your Graphics 6i <ORACLE_HOME> here>

        #
        # Search path for Graphics applications
        #
        GRAPHICS60_PATH=

      #
      # Settings for forms tracing and logging
      # -----------------------------------------------
      # Note: This entry has to be uncommented to enable tracing and
      # logging.

        #FORMS90_TRACE_PATH=<ORACLE_HOME>/forms90/server
      #
      # System settings
      # ---------------
      # You should not normally need to modify these settings
      #
        #
        # Path for shared library objects
        #   This is highly platform (if not machine) specific !  At install time
        #   <percent>LD_LIBRARY_PATH<percent> should be replaced with the
        #   actual value of the LD_LIBRARY_PATH environment variable (at install
        #   time).  That should ensure we have the paths for such necessities as
        #   the motif and X11 libraries.
        # Explanations:
        #   - Reports needs the path for libjava.so
        #     (/cdm/solaris/o_jdk/1_2_2_0_0/jre/lib/sparc)
        #   - Forms needs two paths to the jre, for libjvm.so and libhpi.so
        #   - In ojdk 1.3.1 the location of libjvm.so is lib/sparc (there is no
        #     classic directory) so we do not include the .../classic directory
        #     below.  There are other versions of libjvm.so (in directories server,
        #     client and hotspot) but we will use the version in lib/sparc for now.
        #
        LD_LIBRARY_PATH=<ORACLE_HOME>/lib:%O_JDK_HOME%/jre/lib/sparc:%O_JDK_
    HOME%/jre/lib/sparc/native_threads:%LD_LIBRARY_PATH%

## B.3 base.htm, basejini.htm, basejpi.htm, and baseie.htm Files

For a brief description and the locations of base.htm, basejini.htm, basejpi.htm, and baseie.htm, see Chapter 3.2.1.3, "base.htm, basejini.htm, basejpi.htm, and baseie.htm".

Four baseHTML files are created for your system by the Oracle Universal Installer during OracleAS installation and configuration. In most cases, you will not need to modify these files. If you do need to modify these files, you should create your own versions and reference them from the formsweb.cfg file. The default files may be overridden by a patch installation.

When a user first starts an Oracle Forms application (by clicking a link to the application's URL), a baseHTML file is read by Forms Servlet.

Any variables (%variablename%) in the baseHTML file are replaced with the appropriate parameter values specified in the formsweb.cfg file described in Configuring Parameters with Application Server Control, and from query parameters in the URL request (if any). Query parameter values override the values in the formsweb.cfg file.

Then, the baseHTML file is downloaded to the user's Web browser.

Note:: baseHTML variables can be changed by modifying the corresponding parameter values in the Configuring Parameters with Application Server Control file.

The following baseHTML starter files are available in the <ORACLE_HOME>/forms90/server directory:

- basejini.htm: This is a baseHTML file containing the tags required to run the Forms applet using Oracle JInitiator. It is suitable for browsers (only on Windows platforms) certified by Oracle to work in this manner (and which do not work using standard APPLET tags). See Default basejini.htm File for an example.

- basejpi.htm: This is the baseHTML file for Java Plug-in. The Forms Servlet uses this file if the client browser is not on Windows and the client browser is either Netscape or IE without the IE native setting.

- base.htm: This is a baseHTML file containing the APPLET tags required to run the Forms applet in the AppletViewer, or in any Web browser certified by Oracle whose native JVM is certified with Oracle Forms. See Default base.htm File for an example.

- baseie.htm: This is a baseHTML file containing the Internet Explorer 5 tags required to use native JVM in Internet Explorer 5. See Default baseie.htm File for an example.

##### To create a new baseHTML file:

1. Place the new baseHTML file in any directory. Update the basejini.htm, baseie.htm, basejpi.htm, or base.htm parameter in the formsweb.cfg file to contain the baseHTML file's full physical path location.

2. Copy the basejini.htm, baseie.htm, basejpi.htm, or base.htm starter file, which is located in the <ORACLE_HOME>/forms90/server directory.

3. Rename the file (for example, `order.htm).`

4. Add or modify any text that is visible to the user (for example, text contained within <TITLE> and <BODY> tags).

5. Modify the parameters as needed. It is recommended that you use variables in the baseHTML file, and specify the actual values in the formsweb.cfg file, as described in formsweb.cfg.

   The baseHTML and baseHTMLJInitiator tags can also be set in the specific named configuration section, overwriting the system default value. This is recommended if an individual custom baseHTML template needs to be used. However, if a custom template is used for all applications, then it is recommended you change the default configuration section in the formsweb.cfg file.

#### B.3.0.1 Parameters and variables in the baseHTML file

If you do not want to use a parameter tag that is provided in the base.htm or basejini.htm file, delete it from the file.

We recommend that you specify the rest of the parameter values as variables (%variablename%) in the baseHTML file. For example:

    <PARAM NAME="logo"  VALUE="%logo%">

Then, specify the actual parameter values in the formsweb.cfg file. All variables are replaced with the appropriate parameter values at runtime.

#### B.3.0.2 Usage Notes

- You can use a variable value anywhere in the baseHTML file. Variables are specified as a name enclosed in a special delimiter (the default delimiter is %). For example, you could have the following line in your HTML file:

    ARCHIVE="%Archive%"
    You must then assign a value to %Archive% either in the formsweb.cfg file or in the URL query string.
- All variables must receive values at runtime. If a variable does not receive a value, Forms Services cannot build a proper HTML file to pass back to the user's Web browser, resulting in an error.

- To streamline performance, use only one Web server as a source for Jar file downloads. This will prevent multiple downloads of the same files from different servers.

### B.3.1 Default base.htm File

    <HTML>
    <!-- FILE: base.htm (Oracle Forms)                                  -->
    <!--                                                                -->
    <!-- This is the default base HTML file for running a form on the   -->
    <!-- web using a generic APPLET tag to include Forms applet.        -->
    <!--                                                                -->
    <!-- IMPORTANT NOTES:                                               -->
    <!-- Default values for all the variables which appear below        -->
    <!-- (enclosed in percent characters) are defined in the servlet    -->
    <!-- configuration file (formsweb.cfg). It is preferable to make    -->
    <!-- changes in that file where possible, rather than this one.     -->
    <!--                                                                -->
    <!-- This file will be REPLACED if you reinstall Oracle Forms, so   -->
    <!-- you are advised to make your own version if you want to make   -->
    <!-- want to make any modifications.  You should then set the       -->
    <!-- baseHTML parameter in the Forms Servlet configuration file     -->
    <!-- (formsweb.cfg) to point to your new file instead of this one.  -->

    <HEAD><TITLE>%pageTitle%</TITLE></HEAD>

    <BODY %HTMLbodyAttrs%>
    %HTMLbeforeForm%

    <!-- Forms applet definition (start) -->
    <APPLET CODEBASE="%codebase%"
            CODE="oracle.forms.engine.Main"
            ARCHIVE="%archive%"
            WIDTH="%Width%"
            HEIGHT="%Height%">

    <PARAM NAME="serverURL" VALUE="%serverURL%">
    <PARAM NAME="networkRetries" VALUE="%networkRetries%">
    <PARAM NAME="serverArgs"
           VALUE="%escapeParams% module=%form% userid=%userid% sso_userid=%sso_
    userid% sso_formsid=%sso_formsid% sso_subDN=%sso_subDN% sso_usrDN=%sso_usrDN%
    debug=%debug% host=%host% port=%port% %otherParams%">
    <PARAM NAME="separateFrame" VALUE="%separateFrame%">
    <PARAM NAME="splashScreen"  VALUE="%splashScreen%">
    <PARAM NAME="background"  VALUE="%background%">
    <PARAM NAME="lookAndFeel"  VALUE="%lookAndFeel%">
    <PARAM NAME="colorScheme"  VALUE="%colorScheme%">
    <PARAM NAME="serverApp" VALUE="%serverApp%">
    <PARAM NAME="logo" VALUE="%logo%">
    <PARAM NAME="imageBase" VALUE="%imageBase%">
    <PARAM NAME="formsMessageListener" VALUE="%formsMessageListener%">
    <PARAM NAME="recordFileName" VALUE="%recordFileName%">

    </APPLET>
    <!-- Forms applet definition (end) -->

    %HTMLafterForm%

    </BODY>
    </HTML>

### B.3.2 Default basejini.htm File

    <HTML>
    <!-- FILE: basejini.htm (Oracle Forms)                                 -->
    <!--                                                                 -->
    <!-- This is the default base HTML file for running a form on the    -->
    <!-- web using JInitiator-style tags to include the Forms applet.    -->
    <!--                                                                 -->
    <!-- IMPORTANT NOTES:                                                -->
    <!-- Default values for all the variables which appear below         -->
    <!-- (enclosed in percent characters) are defined in the servlet     -->
    <!-- configuration file (formsweb.cfg). It is preferable to make     -->
    <!-- changes in that file where possible, rather than this one.      -->
    <!--                                                                 -->
    <!-- This file will be REPLACED if you reinstall Oracle Forms, so    -->
    <!-- you are advised to make your own version if you want to make    -->
    <!-- want to make any modifications.  You should then set the        -->
    <!-- baseHTMLJinitiator parameter in the Forms Servlet configuration -->
    <!-- file (formsweb.cfg) to point to your new file instead of this.  -->

    <HEAD><TITLE>%pageTitle%</TITLE></HEAD>

    <BODY %HTMLbodyAttrs%>
    %HTMLbeforeForm%

    <!-- Forms applet definition (start) -->
    <OBJECT classid="%jinit_classid%"
            codebase="/jinitiator/%jinit_exename%"
            WIDTH="%Width%"
            HEIGHT="%Height%"
            HSPACE="0"
            VSPACE="0">
    <PARAM NAME="TYPE"       VALUE="%jinit_mimetype%">
    <PARAM NAME="CODEBASE"   VALUE="%codebase%">
    <PARAM NAME="CODE"       VALUE="oracle.forms.engine.Main" >
    <PARAM NAME="ARCHIVE"    VALUE="%archive_jini%" >

    <PARAM NAME="serverURL" VALUE="%serverURL%">
    <PARAM NAME="networkRetries" VALUE="%networkRetries%">
    <PARAM NAME="serverArgs"
           VALUE="%escapeParams% module=%form% userid=%userid% sso_userid=%sso_
    userid% sso_formsid=%sso_formsid% sso_subDN=%sso_subDN% sso_usrDN=%sso_usrDN%
    debug=%debug% host=%host% port=%port% %otherParams%">
    <PARAM NAME="separateFrame" VALUE="%separateFrame%">
    <PARAM NAME="splashScreen"  VALUE="%splashScreen%">
    <PARAM NAME="background"  VALUE="%background%">
    <PARAM NAME="lookAndFeel"  VALUE="%lookAndFeel%">
    <PARAM NAME="colorScheme"  VALUE="%colorScheme%">
    <PARAM NAME="serverApp" VALUE="%serverApp%">
    <PARAM NAME="logo" VALUE="%logo%">
    <PARAM NAME="imageBase" VALUE="%imageBase%">
    <PARAM NAME="formsMessageListener" VALUE="%formsMessageListener%">
    <PARAM NAME="recordFileName" VALUE="%recordFileName%">
    <COMMENT>
    <EMBED SRC="" PLUGINSPAGE="%jinit_download_page%"
            TYPE="%jinit_mimetype%"
            java_codebase="%codebase%"
            java_code="oracle.forms.engine.Main"
            java_archive="%archive_jini%"
            WIDTH="%Width%"
            HEIGHT="%Height%"
            HSPACE="0"
            VSPACE="0"

            serverURL="%serverURL%"
            networkRetries="%networkRetries%"
            serverArgs="%escapeParams% module=%form% userid=%userid% sso_
    userid=%sso_userid% sso_formsid=%sso_formsid% sso_subDN=%sso_subDN% sso_
    usrDN=%sso_usrDN% debug=%debug% host=%host% port=%port% %otherparams%"
            separateFrame="%separateFrame%"
            splashScreen="%splashScreen%"
            background="%background%"
            lookAndFeel="%lookAndFeel%"
            colorScheme="%colorScheme%"
            serverApp="%serverApp%"
            logo="%logo%"
            imageBase="%imageBase%"
            formsMessageListener="%formsMessageListener%"
            recordFileName="%recordFileName%"
    >
    <NOEMBED>
    </COMMENT>
    </NOEMBED></EMBED>
    </OBJECT>
    <!-- Forms applet definition (end) -->

    %HTMLafterForm%

    </BODY>
    </HTML>

### B.3.3 Default basejpi.htm File

    <HTML>
    <!-- FILE: basejpi.htm (Oracle Forms)                                 -->
    <!--                                                                  -->
    <!-- This is the default base HTML file for running a form on the     -->
    <!-- web using the JDK Java Plugin. This is used for example when     -->
    <!-- running with Netscape on Unix.                                   -->
    <!--                                                                  -->
    <!-- IMPORTANT NOTES:                                                 -->
    <!-- Default values for all the variables which appear below          -->
    <!-- (enclosed in percent characters) are defined in the servlet      -->
    <!-- configuration file (formsweb.cfg). It is preferable to make      -->
    <!-- changes in that file where possible, rather than this one.       -->
    <!--                                                                  -->
    <!-- This file will be REPLACED if you reinstall Oracle Forms, so     -->
    <!-- you are advised to create your own version if you want to make   -->
    <!-- any modifications.  You should then set the baseHTMLjpi          -->
    <!-- parameter in the Forms Servlet configuration file (formsweb.cfg) -->
    <!-- to point to your new file instead of this one.                   -->

    <HEAD><TITLE>%pageTitle%</TITLE></HEAD>

    <BODY %HTMLbodyAttrs%>
    %HTMLbeforeForm%

    <!-- Forms applet definition (start) -->
    <OBJECT classid="%jpi_classid%"
            codebase="%jpi_codebase%"
            WIDTH="%Width%"
            HEIGHT="%Height%"
            HSPACE="0"
            VSPACE="0">
    <PARAM NAME="TYPE"       VALUE="%jpi_mimetype%">
    <PARAM NAME="CODEBASE"   VALUE="%codebase%">
    <PARAM NAME="CODE"       VALUE="oracle.forms.engine.Main" >
    <PARAM NAME="ARCHIVE"    VALUE="%archive%" >

    <PARAM NAME="serverURL" VALUE="%serverURL%">
    <PARAM NAME="networkRetries" VALUE="%networkRetries%">
    <PARAM NAME="serverArgs"
           VALUE="%escapeParams% module=%form% userid=%userid% sso_userid=%sso_
    userid% sso_formsid=%sso_formsid% sso_subDN=%sso_subDN% sso_usrDN=%sso_usrDN%
    debug=%debug% host=%host% port=%port% %otherParams%">
    <PARAM NAME="separateFrame" VALUE="%separateFrame%">
    <PARAM NAME="splashScreen"  VALUE="%splashScreen%">
    <PARAM NAME="background"  VALUE="%background%">
    <PARAM NAME="lookAndFeel"  VALUE="%lookAndFeel%">
    <PARAM NAME="colorScheme"  VALUE="%colorScheme%">
    <PARAM NAME="serverApp" VALUE="%serverApp%">
    <PARAM NAME="logo" VALUE="%logo%">
    <PARAM NAME="imageBase" VALUE="%imageBase%">
    <PARAM NAME="formsMessageListener" VALUE="%formsMessageListener%">
    <PARAM NAME="recordFileName" VALUE="%recordFileName%">
    <COMMENT>
    <EMBED SRC="" PLUGINSPAGE="%jpi_download_page%"
            TYPE="%jpi_mimetype%"
            java_codebase="%codebase%"
            java_code="oracle.forms.engine.Main"
            java_archive="%archive%"
            WIDTH="%Width%"
            HEIGHT="%Height%"
            HSPACE="0"
            VSPACE="0"

            serverURL="%serverURL%"
            networkRetries="%networkRetries%"
            serverArgs="%escapeParams% module=%form% userid=%userid% sso_
    userid=%sso_userid% sso_formsid=%sso_formsid% sso_subDN=%sso_subDN% sso_
    usrDN=%sso_usrDN% debug=%debug% host=%host% port=%port% %otherparams%"
            separateFrame="%separateFrame%"
            splashScreen="%splashScreen%"
            background="%background%"
            lookAndFeel="%lookAndFeel%"
            colorScheme="%colorScheme%"
            serverApp="%serverApp%"
            logo="%logo%"
            imageBase="%imageBase%"
            recordFileName="%recordFileName%"
    >
    <NOEMBED>
    </COMMENT>
    </NOEMBED></EMBED>
    </OBJECT>
    <!-- Forms applet definition (end) -->

    %HTMLafterForm%

    </BODY>
    </HTML>

### B.3.4 Default baseie.htm File

    <HTML>
    <!-- FILE: baseie.htm (Oracle Forms)                                -->
    <!--                                                                -->
    <!-- This is the default base HTML file for running a form on the   -->
    <!-- web with Internet Explorer version 5.0 or above, using that    -->
    <!-- browser's native JVM.                                          -->
    <!--                                                                -->
    <!-- IMPORTANT NOTES:                                               -->
    <!-- Default values for all the variables which appear below        -->
    <!-- (enclosed in percent characters) are defined in the servlet    -->
    <!-- configuration file (formsweb.cfg). It is preferable to make    -->
    <!-- changes in that file where possible, rather than this one.     -->
    <!--                                                                -->
    <!-- This file will be REPLACED if you reinstall Oracle Forms, so   -->
    <!-- you are advised to make your own version if you want to make   -->
    <!-- want to make any modifications.  You should then set the       -->
    <!-- baseHTMLie parameter in the Forms Servlet configuration file   -->
    <!-- (formsweb.cfg) to point to your new file instead of this one.  -->

    <HEAD><TITLE>%pageTitle%</TITLE></HEAD>

    <BODY %HTMLbodyAttrs%>
    %HTMLbeforeForm%

    <!-- Forms applet definition (start) -->
    <APPLET CODEBASE="%codebase%"
            CODE="oracle.forms.engine.Main"
            WIDTH="%Width%"
            HEIGHT="%Height%">

    <PARAM NAME="cabbase" VALUE="%archive_ie%">
    <PARAM NAME="serverURL" VALUE="%serverURL%">
    <PARAM NAME="networkRetries" VALUE="%networkRetries%">
    <PARAM NAME="serverArgs"
           VALUE="%escapeParams% module=%form% userid=%userid% sso_userid=%sso_
    userid% sso_formsid=%sso_formsid% sso_subDN=%sso_subDN% sso_usrDN=%sso_usrDN%
    debug=%debug% host=%host% port=%port% %otherParams%">
    <PARAM NAME="separateFrame" VALUE="%separateFrame%">
    <PARAM NAME="splashScreen"  VALUE="%splashScreen%">
    <PARAM NAME="background"  VALUE="%background%">
    <PARAM NAME="lookAndFeel"  VALUE="%lookAndFeel%">
    <PARAM NAME="colorScheme"  VALUE="%colorScheme%">
    <PARAM NAME="serverApp" VALUE="%serverApp%">
    <PARAM NAME="logo" VALUE="%logo%">
    <PARAM NAME="imageBase" VALUE="%imageBase%">
    <PARAM NAME="formsMessageListener" VALUE="%formsMessageListener%">
    <PARAM NAME="recordFileName" VALUE="%recordFileName%">

    </APPLET>
    <!-- Forms applet definition (end) -->

    %HTMLafterForm%

    </BODY>
    </HTML>

## B.4 web.xml

For a description and the location of web.xml, see Chapter 2, web.xml.

Advanced users might want to edit the web.xml file to:

- Enable extra testing options.

  If you are having difficulty running Oracle Forms in your Oracle Developer Suite (OracleiDS) or OracleAS installation, it can be useful to enable certain test options which are not usually enabled for security reasons. To use these options, edit the web.xml file to set the testMode f90servlet parameter to true. Then restart the Web server (or OC4J). The additional options are then visible on the Forms Servlet adminstration page (which can be accessed at a URL like http://<your_web_server_hostname>:<port>/forms90/f90servlet/admin).

- Use a Forms Servlet configuration file other than the standard one (which is <ORACLE_HOME>/forms90/server/formsweb.cfg).

  This can be done by uncommenting and changing the f90servlet's "configFileName" servlet parameter.

- Run Oracle Forms using static HTML pages (rather than the Forms Servlet).

  When Oracle Forms applications are run using a method other than the Forms Servlet (for example, static HTML pages, or JSPs), parameter settings in the formsweb.cfg file are not used. You may therefore need to define servlet parameters for the Listener Servlet, such as workingDirectory and envFile (specifying the current working directory for the Forms runtime processes, and the file containing environment settings to be used).

### B.4.1 Default web.xml File

    - <web-app>
      <display-name>Forms Services</display-name>
      <description>OracleAS: Forms Services</description>
    - <welcome-file-list>
      <welcome-file>l90servlet</welcome-file>
      </welcome-file-list>
    - <!--  Forms page generator servlet
      -->
    - <servlet>
      <servlet-name>f90servlet</servlet-name>
      <servlet-class>oracle.forms.servlet.FormsServlet</servlet-class>
    - <!--
     During product installation the configFileName parameter is
               specified in the orion-web.xml file as a context parameter
               override (in iDS), or as a Java system property (in iAS).
               It is set to <ORACLE_HOME>/forms90/server/formsweb.cfg.
               You can override that value here by editing and uncommenting the
               following servlet parameter setting:

      -->
    - <!--
            <init-param>
               <param-name>configFileName</param-name>
               <param-value><your configuration file name goes here></param-value>
            </init-param>

      -->
    - <init-param>
    - <!--
     Turn on or off sensitive options on the f90servlet/admin page.
                  For security reasons this should be set to false for
                  production sites.

      -->
      <param-name>testMode</param-name>
      <param-value>false</param-value>
      </init-param>
      </servlet>
    - <!--  Forms listener servlet
      -->
    - <servlet>
      <servlet-name>l90servlet</servlet-name>
      <servlet-class>oracle.forms.servlet.ListenerServlet</servlet-class>
      </servlet>
    - <!--
     Forms servlet mappings. Allow these paths to the servlets:
               /forms90/f90servlet or /forms90/f90servlet/*: FormsServlet
               /forms90/l90servlet or /forms90/l90servlet/*: ListenerServlet

      -->
    - <servlet-mapping>
      <servlet-name>f90servlet</servlet-name>
      <url-pattern>/f90servlet*</url-pattern>
      </servlet-mapping>
    - <servlet-mapping>
      <servlet-name>l90servlet</servlet-name>
      <url-pattern>/l90servlet*</url-pattern>
      </servlet-mapping>
    - <!--
     The following context parameter is only defined here so it can be
            overriden by the (site-specific) value in the orion-web.xml file.

      -->
    - <context-param>
      <param-name>configFileName</param-name>
      <param-value />
      </context-param>
      </web-app>

## B.5 forms90.conf

For a description and the location of forms90.conf, see Chapter 2, forms90.conf.

The following table describes the virtual paths and servlet mappings:

##### Table B-1 forms90.conf Virtual Paths and Servlet Mappings

URL Path | Type | Maps to | Purpose
--- | --- | --- | ---
`/forms90/java` | Alias | `<ORACLE_HOME>/forms90/java` | codebase for Forms applet. Used to download the applet code to the user's web browser.
`/forms90/html` | Alias | `<ORACLE_HOME>/forms90/html` | Access runform.htm (used to run any form for testing)
`/forms90/jinitiator` | Alias | `<ORACLE_HOME>/jinit` | Oracle JInitiator download
`/forms90/f90servlet` | Servlet mount point | Forms Servlet | Generate HTML page to run a form
`/forms90/l90servlet` | Servlet mount point | Forms Listener Servlet | Handles message traffic from the Forms applet

### B.5.1 Default forms90.conf

    # Name
    #   forms90.conf
    # Purpose
    #   Apache mod_oc4j and mod_jserv configuration file for Forms Services.
    #   This file should be included into the Oracle Apache HTTP Listener
    #   configuration file (typically by adding an include statement to the
    #   oracle_apache.conf file)
    # Remarks
    #   If Forms is to be used with JServ, the jserv.properties file needs editing
    #   to add the "forms90" servlet zone with properties file forms90.properties
    # Notes
    #   Virtual paths: We use AliasMatch when defining virtual paths for
    #   security reasons (prevents directory browsing).

      # Virtual path mapping for Forms Java jar and class files (codebase)
    AliasMatch ^/forms90/java/(..*) "<ORACLE_HOME>/forms90/java/$1"

      # Virtual path for JInitiator downloadable executable and download page
    AliasMatch ^/jinitiator/(..*) "<ORACLE_HOME>/jinit/$1"

      # Virtual path for runform.htm (used to run a form for testing purposes)
    AliasMatch ^/forms90/html/(..*) "<ORACLE_HOME>/tools/web90/html/$1"

    # Configuration for JServ (if mod_jserv.c is available and not mod_oc4j.c)
    <IfModule mod_jserv.c>
      # Only configure for JServ if mod_oc4j is NOT available:
      <IfModule !mod_oc4j.c>
        # Virtual path mapping for FormsServlet and ListenerServlet.
        # Purpose: paths to invoke the servlets should be /forms90/f90servlet
        # and /forms90/l90servlet respectively.
        # We map f90servlet to servlet.if90, and l90servlet to servlet.ifl90.
        # The apJServAction directives (below) will then remap those.
        AliasMatch ^/forms90/f90servlet(.*) "/servlet.if90"
        AliasMatch ^/forms90/l90servlet(.*) "/servlet.ifl90"
        ApJServMount /forms90/servlet /forms90
        #
        # Let the servlets be called by file extension (e.g /servlet.if90)
        #
        ApJServAction .if90 /forms90/servlet/f90servlet
        ApJServAction .ifl90 /forms90/servlet/l90servlet
        # Prevent access to the Forms Servlets by paths other than
        # /forms90/f90servlet and /forms90/l90servlet.
        # 1. Prevent access via the .if90 and .ifl90 file extensions:
        <LocationMatch ^.*\.if.*90>
          order deny,allow
          deny from all
        </LocationMatch>
        # 2. Stop access by class (by paths like
        #    /forms90/servlet/oracle.forms.servlet.FormsServlet)
        <LocationMatch ^/forms90/servlet/oracle\.forms.*>
          order deny,allow
          deny from all
        </LocationMatch>
      </IfModule>
    </IfModule>

    # Config. for OC4J
    <IfModule mod_oc4j.c>
        Oc4jMount /forms90              OC4J_BI_Forms
        Oc4jMount /forms90/f90servlet   OC4J_BI_Forms
        Oc4jMount /forms90/f90servlet/* OC4J_BI_Forms
        Oc4jMount /forms90/l90servlet   OC4J_BI_Forms
        Oc4jMount /forms90/l90servlet/* OC4J_BI_Forms
    </IfModule>

## B.6 Registry.dat

For a description and the location of Registry.dat, see Chapter 3.2.4.1, "Registry.dat".

The main reason you would want to edit this file is to change the icon settings (see Icons). You can also change the default font and font settings by changing the following section in the Registry.dat file:

    default.fontMap.defaultFontname=Dialog
    default.fontMap.defaultSize=900
    default.fontMap.defaultStyle=PLAIN

default.fontMap.defaultWeight=PLAIN

Change any of the settings above to reflect your desired font setting. For example, if you want to change your default font to Times New Roman, replace Dialog with Times New Roman.

You can change the default font face mappings:

    default.fontMap.appFontnames=Courier
    New,Courier,courier,System,Terminal,Fixed,Fixedsys,Times,Times New Roman,MS Sans
    Serif,Arial
    default.fontMap.javaFontnames=MonoSpaced,MonoSpaced,MonoSpaced,Dialog,MonoSpaced
    ,Dialog,Dialog,Serif,Serif,Dialog,SansSerif

Some fonts on NT are not supported in Java. For this reason you can specify (map) Java-supported fonts that will appear when a non-supported font is encountered. In the previous sample, each font in default.fontMap.appFontnames corresponds to a font in default.fontMap.javaFontnames.

For more samples, see Default Registry.dat.

### B.6.1 Default Registry.dat

    # This is the Registry file.
    #
    # This file contains the logical [Java] Class name and an associated
    # [numerical] identifier that will be used to refer to objects of the
    # class in order to reduce the amount of information that needs to be
    # repeatedly transmitted to the client.
    #
    # This file is of the Form understood by java.util.Properties (for now)
    #
    # The System Level sound file is relative to the CODEBASE
    #
    #
    oracle.classById.1=oracle.forms.engine.Runform
    oracle.classById.4=oracle.forms.handler.FormWindow
    oracle.classById.5=oracle.forms.handler.AlertDialog
    oracle.classById.6=oracle.forms.handler.DisplayList
    oracle.classById.7=oracle.forms.handler.LogonDialog
    oracle.classById.8=oracle.forms.handler.DisplayErrorDialog
    oracle.classById.9=oracle.forms.handler.ListValuesDialog
    oracle.classById.10=oracle.forms.handler.EditorDialog
    oracle.classById.11=oracle.forms.handler.HelpDialog
    oracle.classById.12=oracle.forms.handler.FormStatusBar
    oracle.classById.13=oracle.forms.handler.MenuInfo
    # oracle.classById.14=UNUSED
    oracle.classById.15=oracle.forms.handler.ApplicationTimer
    oracle.classById.16=oracle.forms.handler.MenuParametersDialog
    oracle.classById.17=oracle.forms.handler.PromptListItem
    oracle.classById.18=oracle.forms.handler.CancelQueryDialog
    oracle.classById.257=oracle.forms.handler.TextFieldItem
    oracle.classById.258=oracle.forms.handler.TextAreaItem
    oracle.classById.259=oracle.forms.handler.FormCanvas
    oracle.classById.261=oracle.forms.handler.ButtonItem
    oracle.classById.262=oracle.forms.handler.CheckboxItem
    oracle.classById.263=oracle.forms.handler.PopListItem
    oracle.classById.264=oracle.forms.handler.TListItem
    oracle.classById.265=oracle.forms.handler.CfmVBX
    oracle.classById.266=oracle.forms.handler.CfmOLE
    oracle.classById.267=oracle.forms.handler.RadioButtonItem
    oracle.classById.268=oracle.forms.handler.ImageItem
    oracle.classById.269=oracle.forms.handler.IconicButtonItem
    oracle.classById.270=oracle.forms.handler.BlockScroller
    oracle.classById.271=oracle.forms.handler.JavaContainer
    oracle.classById.272=oracle.forms.handler.TabControl
    oracle.classById.273=oracle.forms.handler.ComboBoxItem
    oracle.classById.274=oracle.forms.handler.TreeItem
    oracle.classById.281=oracle.forms.handler.PopupHelpItem

    #
    # Defaults for the Font details, all names are Java Font names.  Each of
    # these parameters represents the default property to use when none is
    # specified.
    #
    # defaultFontname represents the default Java fontName.
    # defaultSize     represents the default fontSize.  Note that the size is
    #                 multiplied by 100 (e.g. a 10pt font has a size of 1000).
    # defaultStyle    represents the default fontStyle, PLAIN or ITALIC.
    # defaultWeight   represents the default fontWeight, PLAIN or BOLD.
    #
    default.fontMap.defaultFontname=Dialog
    default.fontMap.defaultSize=900
    default.fontMap.defaultStyle=PLAIN
    default.fontMap.defaultWeight=PLAIN

    #
    # Default Font Face mapping.
    #
    # appFontname  represents a comma delimited list of Application Font Names.
    # javaFontname represents a comma delimited list of Java Font Names.
    #
    # The number of entries in the appFontname list should match the number in
    # the javaFontname list.  The elements of the list are comma separated and
    # *all* characters are taken literally, leading and trailing spaces are
    # stripped from Face names.
    #
    # Note that this file uses the Java 1.1 Font names in order to be able to
    # handle the NLS Plane (BUG #431051)
    #
    default.fontMap.appFontnames=Courier
    New,Courier,courier,System,Terminal,Fixed,Fixedsys,Times,Times New Roman,MS Sans
    Serif,Arial
    default.fontMap.javaFontnames=MonoSpaced,MonoSpaced,MonoSpaced,Dialog,MonoSpaced
    ,Dialog,Dialog,Serif,Serif,Dialog,SansSerif

    #
    # The Application Level icon files are relative to the DOCUMENTBASE
    #   example: icons/
    # or an absolute URL.
    #   example: http://www.forms.net/~luser/d2k_project/
    #
    default.icons.iconpath=
    default.icons.iconextension=gif
    #
    # Application level settings to control UI features
    #
    app.ui.lovButtons=false
    app.ui.requiredFieldVA=false
    #    The background color is specified as an RGB triple.
    app.ui.requiredFieldVABGColor=255,0,0

| Copyright © 2003 Oracle Corporation. All Rights Reserved. |
Contents | Index