Article : Upgrading to Oracle Forms Services 11g

Upgrading to Oracle Forms Services 11g

This chapter describes the upgrade process from Forms 6i. For information about changed or obsolete features, see theOracle Forms Upgrading Oracle Forms 6i to Oracle Forms 11g Guide.

This chapter contains the following sections:

  • Section 13.1, "Oracle Forms Services Upgrade Items"

  • Section 13.2, "Oracle Forms Services Upgrade Tasks"

  • Section 13.3, "Validating the Oracle Forms Services Upgrade"

For upgrading from Oracle Forms 10gand prior releases, you can use the Upgrade Assistant. Refer to the following documents for more information.

  • Oracle Fusion Middleware Upgrade Planning Guide

  • Oracle Fusion Middleware Upgrade Guide for Oracle Portal, Forms, Reports, and Discoverer

Table 13-1describes the items that are upgraded. These items include files, executables, or settings that you must add, change, delete, or replace in the Oracle Forms Services installation.

Section 4.3, "Managing Environment Variables".

Section 13.2.1, "Upgrade Recommendations and Troubleshooting Tips"
  • Section 13.2.2, "Upgrading Oracle Forms Services Application Modules"

  • Section 13.2.3, "Upgrading Common Gateway Interface (CGI) to the Oracle Forms Servlet"

  • Section 13.2.4, "Upgrading Static HTML Start Files to Generic Application HTML Start Files"

  • Section 13.2.5, "Upgrading the Forms 6iListener to the Forms Listener Servlet"

  • Section 13.2.6, "Upgrading the Forms Listener Servlet Architecture to Oracle Forms Services"

  • Section 13.2.7, "Upgrading Load Balancing"

  • Section 13.2.8, "Usage Notes"

  • Oracle Forms Upgrading Oracle Forms 6ito Oracle Forms 11gat:

    http://www.oracle.com/technology/documentation/

    13.2.3Upgrading Common Gateway Interface (CGI) to the Oracle Forms Servlet

    This section provides instructions to upgradeForms CGI to the Forms servlet deployment. Follow these steps if you are using the Oracle 6i Forms Services Common Gateway Interface to dynamically render the Forms Applet start HTML file for applications.

    CGI deployment for Forms applications was introduced in Oracle Forms Services Release 6ito enable the Forms Applet Start HTML file to render dynamically.Forms CGI uses theformsweb.cfgconfiguration file and an HTML template to create the start HTML file for an application. The CGI interface is configured by an entry in the Forms HTTP configuration file6iserver.conf(it is referenced by anIncludedirective in the Oracle HTTP Serveroracle_apache.conffile), which contains aScriptAliasdirective identifyingdev60cgifor the directory structure containing theifcgi60.exefile.

    The Forms servlet renders the HTML in the same manner as the CGI, but also provides an automatic browser type detection. The Forms servlet is configured when you install Oracle Forms Services, and is namedfrmservlet.

    To access the Forms servlet, request the URL:

    http://<hostname>:<port>/forms/frmservlet

    This URL is similar to the URL used with the CGI Interface in Oracle 6iForms Services. To call an application configured asmyappin the custom configuration section of theformsweb.cfgfile, request the URL:

    http://<hostname>:<port>/forms/frmservlet?config=myapp

    The Forms servlet is automatically configured during installation. The installer creates a virtual path/forms/pointing to the Oracle Forms Services configuration,formsappandformsweb.

    Follow these steps to upgrade an Oracle 6iForms Services Release 6iCGI environment to an Oracle Forms Services servlet environment:

    1. Copy all of the application-specific configurations from<source_OH>/Forms60/Server/formsweb.cfgand append them to<destination_Domain_Dir>/config/fmwconfig/servers/WLS_FORMS/applications/formsapp_11.1.1/config/formsweb.cfg.

      Note:

      Do not copy and replace the entireformsweb.cfgfile in<source_OH>to<destination_Domain_Dir>. The file in Release 6iis different from the Oracle Forms Services file. Copy only the application configuration to<destination_Domain_Dir>/config/fmwconfig/servers/WLS_FORMS/applications/formsapp_11.1.1/config/formsweb.cfg.

    2. ConfigureForms_Pathin thedefault.envfile to point to the upgraded Oracle Forms Services application modules.

      Note:

      You can create a newenvironment file by copyingdefault.env, modifying it for use with a particular application, and addingenvFile=<created environment file>to the custom application section in theformsweb.cfgfile.
    3. If you changed the Oracle 6iForms HTML template files, then make the same changes to the Oracle Forms Services HTML template files.

      Note:

      You must make these changes inbasejpi.htmrather thanbasejini.htmbecause the servlet supports the SunJava plug-in.

    13.2.4Upgrading Static HTML Start Files to Generic Application HTML Start Files

    Each application deployed to Oracle Forms Services has a custom application definition, configured in theformsweb.cfgconfiguration file. It automatically inherits the general system settings, such as the names and locations of the base HTML template files.

    The name of the custom application definition becomes part of the Forms application URL. The following custom settings define two different applications:

    [MyHR_app]
    serverURL=/forms/lservlet
    Form = hr_main.fmx
    lookAndFeel=oracle
    Otherparams=myParam1=12
    Userid=scott/tiger@orcl
    

    The following URL invokes this application:

    http://<hostname>:<port>/forms/frmservlet?config=MyHR_app

    Another custom application definition might look like this:

    [booking_app]
    ServerURL=/forms/lservlet
    Form = book.fmx
    lookAndFeel=oracle
    Otherparams= 
    Userid=
    
    

    The following URL invokes this application:

    http://<hostname>:<port>/forms/frmservlet?config=booking_app

    For each static HTML file, you must create a custom application definition. Part of the static HTML file is thearchiveparameter directive, specifying at least thefrmall.jarfile in Oracle Forms Services. If you added a custom archive file, then thearchiveparameter directive would resemble the following:Archive=frmall.jar,custom.jar. Using the Forms servlet and theformsweb.cfgfile, the archive settings are defined under the User Parameter section. All custom application settings inherit these values, so you don't have to explicitly set this parameter, unless you add acustom.jarfile as required by an application.

    Ifcustom.jarwas added, then you can add the following lines to the custom application definition. The example below assumes that you are using another VM.

    [booking_app]
    archive=frmall.jar, custom.jar
    ServerURL=/forms/lservlet
    Form = book.fmx
    lookAndFeel=oracle
    Otherparams= 
    Userid=
    
    

    Follow these steps to upgrade applications:

    1. Edit thedefault.envfile, adding the location of the Oracle Forms Services application modules to theForms_Path.

    2. Edit theformsweb.cfgfile, appending a custom application section for each static HTML application that you want to replace.

    3. Name each custom application section, using a name that contains no spaces and is enclosed in square brackets, for example:[booking_app],[MyHR_app].

    4. Start the application using this URL:

      http://<hostname>:<port>/forms/frmservlet?config=<name>

    13.2.4.1Using Static HTML Files with Oracle Forms Services

    If you need to, you can continue to use static HTML files in Oracle Forms Services. However, with static HTML files, some features (Single Sign-On) are not available for use by Forms applications.

    The Forms Listener servlet by default points to/forms/lservletafter installation. To use static HTML files in Oracle Forms Services, you must modify each static start HTML file to include a value for theserverURLparameter. TheserverPortandserverHostparameters are no longer used, and can be left undefined.

    Follow these steps to use static HTML files with Oracle Forms Services:

    1. ConfigureForms_Pathin thedefault.envfile to point to the upgraded Oracle Forms Services application modules.

    2. Create virtual directories in the$ORACLE_INSTANCE/config/OHS//moduleconf/forms.conffile to point to the location of the static HTML start files.

    3. Modify the application start HTML files as follows:

      1. Add theserverURLvalue/forms/lservlet.

    4. Change thecodebaseparameter toforms/java.

    5. Navigate to$DOMAIN_HOME/servers/WLS_FORMS/tmp/_WL_user/formsapp_11.1.1//war/WEB-INFand edit theweb.xmlfile.

    6. Set the envFile initialization parameter for the Listener Servlet to point to the environment file (usuallydefault.env).

    After editing, the entry in theweb.xmlfile for the Formslistener servlet should resemble the following:

    <!--Forms listener servlet-->
    <servlet>
      <servlet-name>lservlet</servlet-name>
         <servlet-class>oracle.forms.servlet.ListenerServlet</servlet-class>
      <init-param>
         <param-name>envFile</param-name>
         <param-value>destination_Domain_Dir/forms/server/default.env</param-value>
      </init-param>
    </servlet>
    

    Section 13.2.2, "Upgrading Oracle Forms Services Application Modules". .
  • Edit theforms/server/default.envfile to add the location of the upgraded Forms application modules to theForms_Pathvariable.

  • Copy all of the custom application settings from<source_OH>/Forms60/Server/formsweb.cfgand append them to<destination_Domain_Dir>/config/fmwconfig/servers/WLS_FORMS/applications/formsapp_11.1.1/config/formsweb.cfg.

  • If an application requires its own environment file, then instead of defining a separate servlet alias for the Listener Servlet, set theenvFileparameter in the custom application definition section in<destination_Domain_Dir>/config/fmwconfig/servers/WLS_FORMS/applications/formsapp_11.1.1/config/formsweb.cfgto point to the new environment file. For example:

    envFile=myEnvFile.env
    
    

    wheremyEnvFile.envis located in theforms/serverdirectory.

  • If you changed the Oracle 6iForms Services HTML template files, then make the same changes to the Oracle Forms Services HTML template files.

    Note:

    If you need to change the underlying HTML files, you should make a copy of the provided template files before editing them. Save the edited HTML files under a different name, and leave the default templates provided with the installation unchanged. This prevents overwriting of yourcustomized HTML template files when patch sets are applied to the application.

    To use your own template files with applications, use these parameters in the system section, or one of your custom application definitions:baseHTML=.htm

  • Start the application with this URL:

    http://<hostname>:<port>/forms/frmservlet? config=<application>

  • 13.2.6Upgrading the Forms Listener Servlet Architecture to Oracle Forms Services

    In Oracle9iAS Forms Services Release 6i, the Listener Servlet, if not aliased, is accessed by theoracle.forms.servlet.ListenerServlet. The Listener Servlet configuration exists in thejserv.propertiesfile and thezone.propertiesfile.

    In Oracle Forms Services, the Forms Listener servlet is the same except for the servlet names, which arefrmservletandlservlet, and the servlet container. The configuration is performed during installation. The Listener Servlet configuration in Oracle WebLogic Managed Server is stored in$DOMAIN_HOME/servers/WLS_FORMS/tmp/_WL_user/formsapp_11.1.1//war/WEB-INF/web.xml. Some initialization parameters, like theenvFileparameter, need no longer be configured with the servlet engine, because they are moved to theformsweb.cfgfile.

    The Forms Listener servlet is automatically configured during the Oracle WebLogic Server installation. The installer creates a virtual path/forms/pointing to the Oracle Forms Services configuration,formsappandformsweb.

    To access the Forms Listener servlet test form, request the following URL:

    http://<hostname>:<port>/forms/frmservlet?form=test.fmx

    Ability to access this page means that the Forms Listener servlet is configured and ready to use.frmservletis the access name configured for the Forms servlet during installation. The name of the Listener Servlet islservlet.

    Follow these steps to upgrade the Listener Servlet architecture to Oracle Forms Services:

    1. Copy the Forms application files to a new directory and upgrade them to Oracle Forms Services modules.

    2. Edit theforms/server/default.envfile, adding the location of the upgraded Forms application modules to theForms_Pathvariable.

    3. Copy all of the custom application settings from<source_OH>/Forms60/Server/formsweb.cfgand append them to<destination_Domain_Dir>/config/fmwconfig/servers/WLS_FORMS/applications/formsapp_11.1.1/config/formsweb.cfg.

    4. If an application requires its own environment file, then instead of defining a servlet alias for the Listener Servlet, set the envFile parameter in the custom application definition section in<destination_Domain_Dir>/config/fmwconfig/servers/WLS_FORMS/applications/formsapp_11.1.1/config/formsweb.cfgto point to the new environment file. For example:

      envFile=myEnvFile.env
      
      

      wheremyEnvFile.envis located in theforms/serverdirectory.

    5. If you changed the Forms Services Release 6iHTML template files, then make the same changes to the Oracle Forms Services HTML template files.

      Note:

      If you need to change the underlying HTML files, you should make a copy of the provided template files before editing them. Save the edited HTML files under a different name, and leave the default templates provided with the installation unchanged. This prevents overwriting of yourcustomized HTML template files when patch sets are applied to the application.

      To use your own template files with applications, use these parameters in the system section, or one of your custom application definitions: baseHTML=.htm

    6. Start the application with this URL:

      http://<hostname>:<port>/forms/frmservlet? config=<application>

    13.2.7Upgrading Load Balancing

    The method of upgrading theload balancing in Forms Services 6idepends on the deployment method used.

    • With the Forms 6ilistener, the Metrics Server (a separate process) performs load balancing.

    • With the Forms 6iservlet, load balancing is configured with the JServ servlet engine, using round robin load balancing among JServ engines.

    • In Oracle Forms Services, load balancing is managed by Oracle WebLogic Managed Server process. It binds Web requests to the servlet container processing the Forms servlet and the Forms Listener servlet.

    13.2.8Usage Notes

    This section contains hints and tips that may be useful in the upgrade.

    13.2.8.1Deploying Icon Images with the Forms Servlet

    Using static HTML start files in Forms Services Release 6iallowed storage ofimages in a location relative to the start HTML file. The Forms servlet in Oracle Forms Services does not support this.

    The alternative is to use theimagebaseparameter with the value ofcodebaseas the location for the icon images used by applications. Thecodebasevalue refers to theforms/javadirectory, which contains all of the Forms client Java archive files. For performance reasons, it is not a good idea to store images here.

    Instead, you should bundle the icons into a separate archive file, which improves performance because archives are cached permanently on the client. Follow these steps to create this archive file.

    1. Verify that thejarcommand succeeds. If it does not, then you need to ensure that there is a JDK installed on your system with a correct PATH environment variable entry (pointing to theJDK_HOME/bindirectory).

    2. Navigate to the directory containing the application images and issue the command:

      jar -cvf <application>_images.jar *.<extension>

      where:

      • applicationis the name of the application

      • extensionis the extension of the image file (for example,.gif)

      A jar file,<application>_images.jar, is created in the current directory.

    3. Copy<application>_images.jarto theforms/javadirectory.

    4. Edit theformsweb.cfgfile, adding theimageBase=codebaseparameter to the custom application section for the application.

    5. Add the<application>_images.jarfile to the archive path used by the application by adding the following line to the custom application section:

      archive=frmall.jar,<application>_images.jar
      

    SeeSection 4.7, "Deploying Fonts, Icons, and Images Used by Forms Services"for more information on deploying custom icon files with Oracle Forms Services.

    Oracle Fusion Middleware Publishing Reports to the Web with Oracle Reports Services.

    13.2.8.3Creating Forms Listener Servlet Alias Names

    In Forms Services Release 6i, before patch 8, it was necessary to createalias names for the Forms servlet in the$ORACLE_HOME/Apache/Apache/JServ/ conf/zone.propertiesfile in order to use individual environment files for different applications. The Forms servlet in Oracle Forms Services does not require this. You can set the environment file name in theformsweb.cfgfile using theenvFileparameter, shown below:

    envFile=myApp.env

    Alias names for the Forms servlet are no longer created in$ORACLE_HOME/Apache/Apache/JServ/conf/zone.properties. Instead, they are created in$DOMAIN_HOME/servers/WLS_FORMS/tmp/_WL_user/formsapp_11.1.1//war/WEB-INF/web.xml.

    To create the alias names, copy the content between theandtags and change the servlet's name. To create a URL mapping for the new servlet alias name, add the following to the file:

    <servlet-mapping>
    <servlet-name>new servlet name</servlet-name>
    <url-pattern>/new url name*</url-pattern>
    </servlet-mapping>
    

    13.2.8.4Accessing the Listener Servlet Administration Page

    You can display a test page for the Listener Servlet in Oracle9iAS Forms Services Release 6iby accessing the following URL:

    http://<hostname>:<port>/servlet/ oracle.forms.servlet.ListenerServlet

    The information displayed depends on the value of the initialization parameterTestMode. This parameter is set in the<source_OH>/Apache/Apache/JServ/conf/zone.propertiesfile.

    You can display the test page for Oracle Forms Services with the following URL:

    http://<hostname>:<port>/forms/frmservlet/admin

    The information displayed depends on the value of the initialization parameterTestMode. This parameter is set in the$DOMAIN_HOME/servers/WLS_FORMS/tmp/_WL_user/formsapp_11.1.1//war/WEB-INF/web.xmlfile. An example is shown below:

    <init-param>
    <!-- Display sensitive options on the /admin page ? -->
        <param-name>TestMode</param-name>
        <param-value>true</param-value>
    </init-param>
    

    13.3Validating the Oracle Forms Services Upgrade

    After you complete the upgrade tasks, ensure that the upgraded version of the Oracle Forms Services is working as expected. You must devise and perform specific tests for applications and configuration elements that are unique to your site. Compare the performance and characteristics of each application in the source and destination installations.

    In Oracle9iAS Release 1 (1.0.2.2.x), the forms application URL is typically:

    http://<hostname>:<port>/servlet/<forms servlet alias>?<forms application name>

    In Oracle Forms 11g, the forms application URL is typically:

    http://<hostname>:<port>/forms/<forms servlet alias>?form=<forms application name>