Skip Headers

Oracle® Application Server Forms Services Deployment Guide 10g Release 2 (10.1.2) B14032-03 |
| Library | Product | Contents | Index

Previous | Next |

# C.3 base.htm, basejini.htm, and basejpi.htm Files

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

Four baseHTML files are created for your system by the Oracle Universal Installer during Oracle Application Server 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 Console, 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 Console file.

The following baseHTML starter files are available in the `ORACLE_HOME/forms/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.

To create a new baseHTML file:

1. Place the new baseHTML file in any directory. Update the basejini.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, basejpi.htm, or base.htm starter file, which is located in the `ORACLE_HOME/forms/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.

## C.3.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.

Oracle recommends 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.

### C.3.1.1 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.

## C.3.2 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%">
    <PARAM NAME="EndUserMonitoringEnabled" VALUE="%EndUserMonitoringEnabled%">
    <PARAM NAME="EndUserMonitoringURL" VALUE="%EndUserMonitoringURL%">
    <PARAM NAME="heartbeat" VALUE="%heartbeat%">

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

    %HTMLafterForm%

    </BODY>
    </HTML>

## C.3.3 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="/forms/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%">
    <PARAM NAME="EndUserMonitoringEnabled" VALUE="%EndUserMonitoringEnabled%">
    <PARAM NAME="EndUserMonitoringURL" VALUE="%EndUserMonitoringURL%">
    <PARAM NAME="heartbeat" VALUE="%heartbeat%">
    <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%"
            EndUserMonitoringEnabled="%EndUserMonitoringEnabled%"
            EndUserMonitoringURL="%EndUserMonitoringURL%"
            heartBeat="%heartBeat%"
    >
    <NOEMBED>
    </COMMENT>
    </NOEMBED></EMBED>
    </OBJECT>
    <!-- Forms applet definition (end) -->

    %HTMLafterForm%

    </BODY>
    </HTML>

## C.3.4 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%">
    <PARAM NAME="EndUserMonitoringEnabled" VALUE="%EndUserMonitoringEnabled%">
    <PARAM NAME="EndUserMonitoringURL" VALUE="%EndUserMonitoringURL%">
    <PARAM NAME="heartBeat" VALUE="%heartBeat%">
    <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%"
            EndUserMonitoringEnabled="%EndUserMonitoringEnabled%"
            EndUserMonitoringURL="%EndUserMonitoringURL%"
            heartBeat="%heartBeat%"
    >
    <NOEMBED>
    </COMMENT>
    </NOEMBED></EMBED>
    </OBJECT>
    <!-- Forms applet definition (end) -->

    %HTMLafterForm%

    </BODY>
    </HTML>