Fmdeploy.bk Vision70 A92175 132206
User Manual: vision70
Open the PDF directly: View PDF 
.
Page Count: 142
| Download | |
| Open PDF In Browser | View PDF |
Oracle9iAS Forms Services Deployment Guide Release 9.0.2 January 2002 Part No. A92175-01 Oracle9iAS Forms Services Deployment Guide, Release 9.0.2 for Windows and Solaris Part No. A92175-01 Contributing Authors: Orlando Cordero, Tom Pfaeffle, Dean Ho, Duncan Mills, Frank Nimphius, Cathy Godwin, Bryan Roberts Copyright Notice Copyright © 1993, 2002, Oracle Corporation. All rights reserved. License Restrictions & Warranty Disclaimer The Programs (which include both the software and documentation) contain proprietary information of Oracle Corporation; they are provided under a licenseagreement containing restrictions on use and disclosure and are also protected bycopyright, patent and other intellectual and industrial property laws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this document is error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation. Restricted Rights Notice If the Programs are delivered to the US Government or anyone licensing or using the Programs on behalf of the US Government, the following notice is applicable: RESTRICTED RIGHTS NOTICE Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication and disclosure of the Programs including documentation, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication and disclosure of the Programs shall be subject to the restrictions in FAR 52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065. Hazardous Applications The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be licensee's responsibility to take all appropriate fail-safe, back up, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle disclaims liability for any damages caused by such use of the Programs. Trademark Notice Oracle is a registered trademark, and JInitiator, Oracle SQL/Services, Oracle8, Oracle8i, Oracle9i, and PL/SQL are trademarks or registered trademarks of Oracle Corporation. Other names may be trademarks of their respective owners. Contents Figures List of Tables Send Us Your Comments .................................................................................................................. xiii Preface........................................................................................................................................................... xv Intended Audience ............................................................................................................................... xv Structure................................................................................................................................................. xv Related Documents............................................................................................................................. xvii 1 Introduction Introduction ......................................................................................................................................... The Oracle Internet Platform............................................................................................................ Oracle9i Application Server (Oracle9iAS) ................................................................................ Oracle9i Developer Suite (Oracle9iDS) ..................................................................................... Oracle9i Database ......................................................................................................................... Oracle 9iAS Forms Services .............................................................................................................. What’s New in Oracle9iAS Forms Services? ............................................................................ Oracle9iAS Forms Services Architecture ....................................................................................... Oracle9iAS Forms Services Components....................................................................................... Forms Listener Servlet ................................................................................................................. Forms Runtime Process ............................................................................................................... Forms Listener Servlet ....................................................................................................................... 2 1-1 1-1 1-2 1-2 1-2 1-3 1-3 1-4 1-5 1-6 1-6 1-6 Basics of Deploying Oracle9i Forms Applications Introduction ......................................................................................................................................... 2-1 iii Configuration Files............................................................................................................................. Oracle 9i Forms Configuration Files .......................................................................................... formsweb.cfg .......................................................................................................................... base.htm, basejini.htm, basejpi.htm, and baseie.htm ....................................................... ftrace.cfg.................................................................................................................................. Oracle9iAS Containers for J2EE (OC4J) Configuration Files ................................................. web.xml................................................................................................................................... Directory structure for Oracle9i Forms OC4J files............................................................ Oracle HTTP Listener Configuration Files................................................................................ forms90.conf ........................................................................................................................... Standard Fonts and Icons File..................................................................................................... registry.dat.............................................................................................................................. Environment Variables ................................................................................................................ default.env .............................................................................................................................. Application Deployment................................................................................................................... Deploying Your Application................................................................................................ Specifying Parameters........................................................................................................... Oracle9iAS Forms Services in Action ........................................................................................... Client Browser Support ................................................................................................................... Oracle JInitiator ........................................................................................................................... How Configuration Parameters and BaseHTML Files are Tied to Client Browsers ........ 3 Configuring Oracle9iAS Forms Services Introduction ......................................................................................................................................... Customizing Configuration Files .................................................................................................... formsweb.cfg ................................................................................................................................. Parameters Naming Files ..................................................................................................... Creating specific named configurations in formsweb.cfg ............................................... Parameters in the formsweb.cfg File................................................................................... Default formsweb.cfg File .................................................................................................... base.htm, basejini.htm, basejpi.htm, and baseie.htm ............................................................ Parameters and variables in the baseHTML file ............................................................. Usage Notes.......................................................................................................................... Default base.htm File .......................................................................................................... Default basejini.htm File..................................................................................................... iv 2-1 2-2 2-2 2-2 2-3 2-3 2-3 2-4 2-4 2-4 2-5 2-5 2-5 2-5 2-5 2-6 2-7 2-10 2-12 2-12 2-13 3-1 3-1 3-2 3-2 3-2 3-3 3-7 3-12 3-13 3-14 3-14 3-15 Default basejpi.htm File...................................................................................................... Default baseie.htm File ....................................................................................................... web.xml........................................................................................................................................ Default web.xml File ........................................................................................................... forms90.conf ................................................................................................................................ Default forms90.conf........................................................................................................... registry.dat................................................................................................................................... Default registry.dat ............................................................................................................. Customizing Environment Variables and Registry Settings.................................................... default.env ................................................................................................................................... Default default.env File for Windows.............................................................................. Default default.env File for UNIX..................................................................................... Creating Your Own Template HTML Files.................................................................................. Including Graphics in Your Oracle9i Forms Application......................................................... Deploying Icons and Images Used by Oracle9iAS Forms Services........................................ Icons.............................................................................................................................................. Storing Icons in a Java Archive ......................................................................................... Adding Icon Changes to Registry.dat .............................................................................. SplashScreen and Background Images.................................................................................... Custom JAR Files Containing Icons and Images ................................................................... Creating a JAR File .............................................................................................................. Using Files Within the JAR File......................................................................................... Search Path for Icons and Images ............................................................................................ DocumentBase ..................................................................................................................... CodeBase .............................................................................................................................. Using HTTPS with the Forms Listener Servlet........................................................................... Server Requirements........................................................................................................... Client Requirements: Using HTTPS with Oracle JInitiator........................................... Using the Hide User ID/Password Feature .................................................................................. Using an Authenticating Proxy to Run Oracle9i Forms Applications ................................... Enabling Language Detection ........................................................................................................ How Language Detection Works...................................................................................... Multi-Level Inheritance ...................................................................................................... 3-17 3-19 3-20 3-21 3-23 3-23 3-25 3-25 3-28 3-28 3-31 3-33 3-34 3-35 3-35 3-35 3-36 3-36 3-38 3-38 3-38 3-38 3-39 3-39 3-40 3-41 3-41 3-41 3-41 3-42 3-42 3-43 3-43 v 4 Using Oracle9iAS Forms Services with the HTTP Listener and OC4J Introduction ......................................................................................................................................... 4-1 OC4J Server Process ........................................................................................................................... 4-1 Performance/Scalability Tuning....................................................................................................... 4-2 Limit the number of HTTPD processes.............................................................................. 4-2 Set the maxClient directive to a High value ...................................................................... 4-3 Load Balancing OC4J ......................................................................................................................... 4-3 Case 1: Multiple OC4J engines on the same host as the Oracle HTTP Listener........... 4-4 Case 2: Multiple OC4J engines on a different host to the Oracle HTTP Listener. ....... 4-4 Case 3: Multiple OC4J engines and multiple Oracle HTTP Listeners on different hosts. ... 4-5 Case 4: Multiple Oracle HTTP Listeners on different hosts with multiple OC4J engines on one host 4-6 5 Using Oracle9iAS Forms Services with SSO and OID Introduction ......................................................................................................................................... Single Sign-On (SSO) ........................................................................................................................ Authentication Flow........................................................................................................................... Single Sign-On with Some Applications, Not Others................................................................. Create a second stand alone server instance ..................................................................... Add an alias name for the Forms Servlet........................................................................... Register the Oracle9i Forms alias name with mod_oc4j .................................................. 6 Enterprise Manager and Oracle9i Forms 7 Tracing and Diagnostics Forms Trace........................................................................................................................................... Configuring Forms Trace............................................................................................................. ftrace.cfg.................................................................................................................................. URL Parameter Options ....................................................................................................... Starting the Trace .......................................................................................................................... Viewing Forms Trace Output ..................................................................................................... Running the Upload/Translate Utility .............................................................................. Creating Database Tables for the Trace Data .................................................................... vi 5-1 5-1 5-2 5-4 5-5 5-5 5-6 7-2 7-2 7-2 7-3 7-5 7-5 7-5 7-6 List of Traceable Events ............................................................................................................... List of Event Details ................................................................................................................... Errors..................................................................................................................................... User Action Events.............................................................................................................. Forms Services Events ........................................................................................................ Detailed Events .................................................................................................................... Three-Tier Events ................................................................................................................ Miscellaneous....................................................................................................................... Servlet Logging Tools ...................................................................................................................... Turning on Logging ................................................................................................................... Specifying Logging in the URL ......................................................................................... Specifying Logging in the formsweb.cfg File.................................................................. Specifying Full Diagnostics in the URL Used to Invoke the Forms Servlet ............... Location of Log Files .................................................................................................................. Example Output for Each Level of Servlet Logging.............................................................. (none) .................................................................................................................................... /session................................................................................................................................. /sessionperf.......................................................................................................................... /perf ...................................................................................................................................... /debug .................................................................................................................................. Oracle Trace........................................................................................................................................ 8 7-8 7-11 7-12 7-12 7-12 7-13 7-13 7-14 7-14 7-15 7-15 7-16 7-16 7-16 7-16 7-17 7-17 7-17 7-17 7-18 7-19 Performance Tuning Considerations Introduction ......................................................................................................................................... Built-in Optimization Features of Forms Services....................................................................... Minimizing Client Resource Requirements.............................................................................. Minimizing Forms Services Resource Requirements.............................................................. Minimizing Network Usage ....................................................................................................... Maximizing the Efficiency of Packets Sent Over the Network.............................................. Rendering Application Displays Efficiently on the Client ..................................................... Tuning Oracle9iAS Forms Services Applications ........................................................................ Location of the Oracle9iAS Forms Services with Respect to the Data Server ..................... Minimizing the Application Startup Time................................................................................ Using Java Files...................................................................................................................... Oracle JInitiator .............................................................................................................. 8-1 8-1 8-2 8-2 8-3 8-3 8-4 8-4 8-5 8-6 8-6 8-7 vii IE Native JVM ................................................................................................................. All other cases (for example, Sun’s Java Plug-in) ...................................................... Using Caching........................................................................................................................ Reducing the Required Network Bandwidth........................................................................... Other Techniques to Improve Performance............................................................................ 8-8 8-8 8-8 8-9 8-11 A JInitiator Oracle JInitiator................................................................................................................................... Why Use Oracle JInitiator? .......................................................................................................... Benefits of Oracle JInitiator ......................................................................................................... Using Oracle JInitiator ................................................................................................................. Supported Configurations........................................................................................................... Windows 98, NT, 2000, XP:........................................................................................... System Requirements................................................................................................................... Using Oracle JInitiator with Netscape Navigator .................................................................... Using Oracle JInitiator with Microsoft Internet Explorer ....................................................... Setting up the Oracle JInitator Plug-in ...................................................................................... Adding Oracle JInitiator Markup to Your Base HTML File............................................ Customizing the Oracle JInitiator Download File ............................................................ Making Oracle JInitiator available for download ............................................................. Modifying the Oracle JInitiator plug-in..................................................................................... Modifying the cache size for Oracle JInitiator................................................................... Modifying the heap size for Oracle JInitiator.................................................................... Check and modify the proxy server setting for Oracle JInitiator ................................... Viewing Oracle JInitiator output......................................................................................... Modifying the base HTML file ................................................................................................... Index viii A-1 A-1 A-2 A-2 A-2 A-2 A-3 A-3 A-3 A-4 A-4 A-4 A-4 A-5 A-5 A-5 A-6 A-6 A-6 ix List of Figures 1–1 1–2 1–3 8–1 x Oracle 9iAS Forms Services architecture ........................................................................... Three-tier configuration for running a form...................................................................... Architecture using the Forms Listener Servlet.................................................................. Co-Locating the Oracle9iAS Forms Services and Database Server................................ 1-4 1-5 1-7 8-5 List of Tables 3–1 3–2 3–3 3–4 7–1 7–2 7–3 7–4 7–5 7–6 7–7 7–8 7–9 7–10 forms90.conf Virtual Paths and Servlet Mappings......................................................... Icon Location Guide............................................................................................................ Search Paths for Icons and Images.................................................................................... Icons and Images Search Paths Used by Oracle9iAS Forms Services ........................ Forms Trace Command Line Parameters .......................................................................... Translate Utility Command Line Options ......................................................................... Database Schema for Forms Trace Data............................................................................. List of Traceable Events........................................................................................................ User Action Event Details .................................................................................................. Forms Services Event Details............................................................................................. Detailed Events .................................................................................................................... Three-Tier Event Details..................................................................................................... Miscellaneous Event Details .............................................................................................. Supported logging capabilities.......................................................................................... 3-23 3-37 3-39 3-40 7-3 7-6 7-6 7-9 7-12 7-12 7-13 7-13 7-14 7-15 xi xii Send Us Your Comments Oracle9iAS Forms Services Deployment Guide, Release 9.0.2 Part No. A92175-01 Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this document. Your input is an important part of the information used for revision. ■ ■ ■ ■ ■ Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? Are the examples correct? Do you need more examples? What features did you like most? If you find any errors or have any other suggestions for improvement, please indicate the document title and part number, and the chapter, section, and page number (if available). You can send comments to us in the following ways: ■ ■ Electronic mail: oddoc_us@oracle.com Postal service: Oracle Corporation Oracle9i Forms Developer and Oracle9iAS Forms Services Documentation 200 Oracle Parkway, 2op981 Redwood Shores, CA 94065 USA If you would like a reply, please give your name, address, telephone number, and (optionally) electronic mail address. If you have problems with the software, please contact your local Oracle Support Services. xiii xiv Preface Intended Audience This manual is intended for software developers who are interested in deploying Oracle9i Forms applications to the Web with the Oracle9i Application Server. Structure This manual contains the following chapters and appendices: Chapter 1 Introduction Introduces you to deploying applications on the Oracle Internet Platform and provides an overview of the Forms Services architecture and components. Chapter 2 Basics of Deploying Oracle9i Forms Applications Introduces you to the basic files you need to configure Oracle9iAS Forms Services and describes the steps for deploying applications. Chapter 3 Configuring Oracle9iAS Forms Services Describes advanced topics in configuring Oracle9iAS Forms Services and provides guidelines and tips for designing Oracle9i Forms applications for Web deployment. Chapter 4 Using Oracle9iAS Forms Services with the HTTP Listener and OC4J Describes how Oracle9iAS Forms Services works using Oracle HTTP Listener and OC4J. xv Chapter 5 Using Oracle9iAS Forms Services with SSO and OID Describes using Oracle9iAS Forms Services with single sign-on and Oracle Internet Directory. Chapter 6 Enterprise Manager and Oracle9i Forms Describes the Oracle Enterprise Manager (OEM) system management tool. Chapter 7 Tracing and Diagnostics Describes tracing and diagnostic tools that are available with Forms allow you to analyze the performance and resource consumption of your Oracle9i Forms applications at runtime. Chapter 8 Performance Tuning Considerations Describes the tuning considerations when you deploy an application using Oracle9iAS Forms Services. Appendix A JInitiator Describes the benefits of using Oracle JInitiator and how to set up the Oracle JInitiator plug-in. xvi Related Documents For more information, see the following manuals: ■ ■ ■ ■ Oracle9i Forms Developer and Forms Services: Release Notes for Windows (Part No. A92176-01) Oracle9i Forms Developer and Forms Services: Release Notes for Solaris (Part No. A92187-01) Oracle9i Forms Developer and Forms Services: Migrating Forms Applications from Forms6i (Part No. A92183-01) Forms Developer Online Help, available from the Help menu in Forms Developer. xvii xviii 1 Introduction Introduction This guide is intended to provide information about deploying applications with Oracle9iAS Forms Services. When you choose to deploy applications to the Internet, there are many decisions to be made as to how you will go about it. This guide provides information about those decisions and offers suggestions and methods for configuring your system for Web deployment of your applications. For a description of each chapter in this guide see the Preface. This chapter contains the following sections: ■ The Oracle Internet Platform ■ Oracle 9iAS Forms Services ■ Oracle9iAS Forms Services Architecture ■ Oracle9iAS Forms Services Components ■ Forms Listener Servlet The Oracle Internet Platform With Oracle9i database to manage data, Oracle9i Developer Suite (Oracle9iDS) to build applications, and Oracle9i Application Server (Oracle9iAS) to run them, the Oracle Internet Platform is a complete solution for building any type of application and deploying it to the Web. These Oracle tools provide a scalable and highly available infrastructure that enables customers to easily accommodate growing user populations. Introduction 1-1 The Oracle Internet Platform Oracle offers a simple, complete, and integrated Internet platform composed of three core products: ■ Oracle9i Application Server (Oracle9iAS) ■ Oracle9i Developer Suite (Oracle9iDS) ■ Oracle9i Database Oracle9i Application Server (Oracle9iAS) Oracle9iAS is a scalable, secure, middle-tier aplication server. It enables you to deliver Web content, host Web applications, and connect to to back-office applications. Forms Services are an integral part of the Oracle9i Application Server bundle, which provides the technology to fully realize the benefits of Internet computing. Oracle9i Developer Suite (Oracle9iDS) Oracle9iDS combines the power of Oracle Application Development tools, Oracle Business Intelligence tools, the award-winning XML Developer's Kit (XDK) and the Portlet Development Kit (PDK) in one product. Oracle9iDS is based on Internet standards including J2EE, XML, SOAP, UDDI, and UML, and provides a highly productive environment to build applications for Oracle9iAS and the Oracle9i Database. Oracle9i Database Oracle9i Database is the latest generation of the world's most popular RDBMS. Among the numerous new capabilities are unlimited scalability and industry-leading reliability with Oracle9i Real Application Clusters; new high availability technology including advancements in standby database technology (Oracle Data Guard); and built-in OLAP, data mining and ETL functions. Oracle9i Application Server is the best application server for the Oracle9i Database and applications built with Oracle development tools. By leveraging a common technology stack, Oracle9i Application Server can transparently scale an Oracle database by caching data and application logic on the middle tier. 1-2 Oracle9iAS Forms Services Deployment Guide Oracle 9iAS Forms Services Oracle 9iAS Forms Services As part of Oracle9iAS, Oracle9iAS Forms Services is a new generation of tools that enable you to deploy new and existing Oracle9i Forms applications on the World Wide Web. Oracle9iAS Forms Services is a comprehensive application framework optimized to deploy Oracle9i Forms applications in a multi-tiered environment. It takes advantage of the ease and accessibility of the Web and elevates it from a static information-publishing mechanism to an environment capable of supporting complex applications. What’s New in Oracle9iAS Forms Services? Much of the functionality that was handled by the Web Server in Web6i has been assumed by components that are delivered with Oracle9iAS. For example, load balancing, security, scalability, HTTP/S communication handling, and deployment of Java servlets are all performed by various components delivered with Oracle9iAS, such as the Oracle HTTP Server and Oracle9iAS Containers for J2EE (OC4J). The Oracle9iAS Forms Services component of Oracle9iAS handles all processing that is specific to Oracle9i Forms applications, such as running the business logic defined in the Oracle9i Forms application and providing the connection to the Oracle database. A Java applet provides the client user interface. New features for Oracle9iAS Forms Services include: ■ ■ ■ ■ ■ ■ Support for deployment on the Web using the Forms Listener Servlet. Integration with OC4J (see Chapter 4, "Using Oracle9iAS Forms Services with the HTTP Listener and OC4J") Single Sign-On (see Chapter 5, "Using Oracle9iAS Forms Services with SSO and OID") Integration with OID (see Chapter 5, "Using Oracle9iAS Forms Services with SSO and OID") Integration with Enterprise Manager for easier administration and manageability (see Chapter 6, "Enterprise Manager and Oracle9i Forms") Tracing and logging improvements (see Chapter 7, "Tracing and Diagnostics") Introduction 1-3 Oracle9iAS Forms Services Architecture Oracle9iAS Forms Services Architecture Oracle9iAS Forms Services use a three-tier architecture to deploy database applications. Figure 1–1 shows the three tiers that make up the Oracle9iAS Forms Services architecture: ■ ■ ■ The client tier contains the Web browser, where the application is displayed. The middle tier is the application server, where application logic and server software are stored. The database tier is the database server, where enterprise data is stored . Figure 1–1 Oracle 9iAS Forms Services architecture 1-4 Oracle9iAS Forms Services Deployment Guide Oracle9iAS Forms Services Components Oracle9iAS Forms Services Components Oracle9iAS Forms Services is a middle-tier application framework for deploying complex, transactional forms applications to the Internet. Developers can build new applications with Oracle9i Forms Developer and deploy them to the Internet with Oracle9iAS Forms Services. Developers can also take current applications that were previously deployed in client/server and move them to a three-tier architecture without changing the application code. Oracle9iAS Forms Services consists of three major components, as shown in Figure 1–2: ■ The Client, which resides on the client tier. ■ The Forms Listener Servlet, which resides on the middle tier ■ The Forms Runtime Process, which also resides on the middle tier Figure 1–2 Three-tier configuration for running a form Introduction 1-5 Forms Listener Servlet Forms Listener Servlet The Forms Listener Servlet acts as a broker between the Java client and the Forms runtime process. It takes connection requests from Java client processes and initiates a Forms runtime process on their behalf. For more information, see Forms Listener Servlet. Forms Runtime Process The Forms runtime process manages application logic and processing. It maintains a connection to the database on behalf of the Java client. It uses the same forms, menus, and library files that were used for running in client/server mode. The Forms runtime process plays two roles: when it communicates with the client browser, it acts as a server by managing requests from client browsers and it sends metadata to the client to describe the user interface; when it is communicating with the database server, it acts as a client by querying the database server for requested data. Forms Listener Servlet Oracle9iAS Forms Services uses the Forms Listener Servlet (a Java servlet) to start, stop, and communicate with the Forms runtime process. The Forms runtime is what executes the code contained in a particular Oracle9i Forms application. The Forms Listener Servlet manages the creation of a Forms runtime process for each client and manages the network communications between the client and its associated Forms runtime process. The Forms Listener Servlet replaces the Forms Listener provided in previous releases of Oracle9i Forms. Note: You do not need to configure the Forms Listener Servlet as it is already set up for you in the Oracle9iAS installation process. Figure 1–3 illustrates how the client sends HTTP requests and receives HTTP responses from the Forms Server process. The HTTP Listener acts as the network endpoint for the client, keeping the other server machines and ports from being exposed at the firewall. 1-6 Oracle9iAS Forms Services Deployment Guide Forms Listener Servlet Figure 1–3 Architecture using the Forms Listener Servlet Introduction 1-7 Forms Listener Servlet 1-8 Oracle9iAS Forms Services Deployment Guide 2 Basics of Deploying Oracle9i Forms Applications Introduction This chapter describes the basic files you need to configure Oracle9iAS Forms Services, provides an overview of how Oracle9iAS Forms Services runs in Oracle9iAS, and describes the steps you need to follow to deploy Oracle9i Forms applications. After installation is complete, you can use the information in this chapter to change your initial configuration or make modifications as your needs change. This chapter contains the following sections: ■ Configuration Files ■ Application Deployment ■ Oracle9iAS Forms Services in Action ■ Client Browser Support Configuration Files This section introduces the basic files you need to configure Oracle9i Forms applications. For more advanced configuration topics, see Chapter 3, "Configuring Oracle9iAS Forms Services". This section contains the following sub-sections: ■ Oracle 9i Forms Configuration Files ■ Oracle9iAS Containers for J2EE (OC4J) Configuration Files ■ Oracle HTTP Listener Configuration Files Basics of Deploying Oracle9i Forms Applications 2-1 Configuration Files ■ Standard Fonts and Icons File ■ Environment Variables Note: Note: Location of files are given relative to the ORACLE_HOME directory. Forward slashes should be replaced by back slashes on Windows. Oracle 9i Forms Configuration Files Oracle 9i Forms configuration files allow you to specify parameters for your forms. This section contains the following sub-sections: ■ formsweb.cfg ■ base.htm, basejini.htm, basejpi.htm, and baseie.htm ■ ftrace.cfg formsweb.cfg Location: forms90/server. This is the Forms Servlet configuration file that contains the following: ■ ■ Values for Forms applet and runtime command line parameters, as well as the name of the environment file to use (envFile setting). Most of the servlet configuration parameter settings that you set during installation. You can modify these parameters, if needed. Variables (%variablename%) in the baseHTML file are replaced with the appropriate parameter values specified in the formsweb.cfg file and from query parameters in the URL request (if any). For more information about formsweb.cfg, see Chapter 3, formsweb.cfg. base.htm, basejini.htm, basejpi.htm, and baseie.htm Location: forms90/server. The baseHTML files (base.htm, basejini.htm, basejpi.htm, and baseie.htm) are used as templates by the Forms Servlet when generating the HTML page used to start up an Oracle9i Forms application. We recommend that you make configuration changes in the formsweb.cfg file and avoid editing the baseHTML files. If you need to change the baseHTML files, create 2-2 Oracle9iAS Forms Services Deployment Guide Configuration Files your own versions and reference them from the formsweb.cfg file by changing the appropriate settings. For more information about baseHTML files, see Chapter 3, base.htm, basejini.htm, basejpi.htm, and baseie.htm. ftrace.cfg Location: forms90/server. This file allows you to configure Forms Trace. Forms Trace allows you to replace the functionality that was provided with Forms Runtime Diagnostics (FRD) and Performance Event Collection Services (PECS), which were available in earlier releases of Oracle 9i Forms. Forms Trace allows you to trace the execution path through a form (for example, steps the user took while using the form). For more information about ftrace.cfg, see Chapter 7, ftrace.cfg. Oracle9iAS Containers for J2EE (OC4J) Configuration Files By default Oracle9i Forms is configured for OC4J by deploying it as a J2EE compliant application packaged in an EAR (Enterprise Archive) file called forms90app.ear. This EAR file is deployed during the Oracle9iAS installation process (if you choose to configure Oracle 9i Forms). During deployment, the EAR file is unpacked into the applications directory of the OC4J instance. This section describes: ■ web.xml ■ Directory structure for Oracle9i Forms OC4J files web.xml Location: j2ee/ProductGroup2/applications/forms90app/forms90web/WEB-INF/web.xml. Once Oracle9i Forms has been installed and configured, the web.xml file is located in the directory j2ee/ProductGroup2/applications/forms90app/forms90web/WEB-INF underneath ORACLE_HOME. It defines the aliases "f90servlet" and "l90servlet" for the Forms Servlet and the Forms Listener Servlet. For more information about web.xml, see Chapter 3, web.xml. Basics of Deploying Oracle9i Forms Applications 2-3 Configuration Files Directory structure for Oracle9i Forms OC4J files During Oracle9iAS installation and configuration, the Forms EAR file (forms90app.ear) is deployed to the "ProductGroup2" OC4J instance. This results in the following directory structure. Names with a + sign are directories: %ORACLE_HOME%/j2ee/ProductGroup2/applications/forms90app +META-INF -application.xml (defines the structure of the ear file) +forms90web +WEB-INF -web.xml (forms & listener servlet definitions, including servlet parameters) -orion-web.xml (virtual directory mappings and context parameter, only used in iDS) +lib -f90srv.jar (contains the Forms Servlet and Listener Servlet code) Oracle HTTP Listener Configuration Files This section describes the file used to configure Oracle HTTP Listener for Oracle9i Forms. forms90.conf Location: forms90/server. This is the Oracle HTTP listener configuration file for Oracle9i Forms. It is included into oracle_apache.conf, which in turn is included into httpd.conf (the master HTTP listener configuration file). Forms90.conf defines virtual directors (aliases) and servlet mount points to map URL requests to the Forms Servlets running in the OC4J servlet engine. For more information about forms90.conf, see Chapter 3, forms90.conf. 2-4 Oracle9iAS Forms Services Deployment Guide Application Deployment Standard Fonts and Icons File This section describes the file used to configure font and icon settings for Oracle9i Forms. registry.dat Location: forms90/java/oracle/forms/registry This file allows you to change the default font, font mappings, and icons that Oracle9iAS Forms Services uses. For more information about registry.dat, see Chapter 3, registry.dat. Environment Variables This section describes the default environment variable containing environment settings for the Forms runtime process. For a full list of customizable environment variables, see Chapter 3, Customizing Environment Variables and Registry Settings. default.env Location: forms90/server. This file contains environment settings for Forms runtime and can be found in the same directory as the formsweb.cfg file. On UNIX, default.env should include the PATH and LD_LIBRARY_PATH. For more information about default.env, see Chapter 3, default.env. Application Deployment Once you have created your application in Oracle9i Forms Developer , you are ready for application Web deployment. Oracle9i Forms accesses an application in Oracle9iAS through a specified URL. The URL then accesses the HTTP Listener, which communicates with the Listener Servlet. The Listener Servlet starts up ifweb90.exe for each new Oracle9i Forms module. For more information about how Oracle9iAS Forms Services runs, see Oracle9iAS Forms Services in Action. Basics of Deploying Oracle9i Forms Applications 2-5 Application Deployment Deploying Your Application To deploy a basic form with the default parameters set up by the installer: 1. Create your application in Oracle9i Forms Developer and save it. .fmb is a design time file that can only be opened in Oracle9i Forms Developer. .fmx is the runtime file created when you compile the .fmb and is used for Web deployment. For more information about Oracle9i Forms Developer, go to the Help menu in Oracle9i Forms Developer. 2. Create a configuration section in formsweb.cfg so that Oracle9i Forms can access your application module. You can do this at the end of formsweb.cfg in any open space. The syntax for creating a configuration file is as follows: [my_application] form=name_of_module For example, [application] form=hrapp.fmx In the previous example, Oracle9i Forms is running the application "application" and calling the file "hrapp.fmx". This means the Oracle9i Forms module hrapp.fmx will be callable on the Web by entering "...?config=application" in the Browser URL. Note: You can name the configuration section anything you want, as long as it does not include spaces. 3. Make sure the .fmx file location is specified in the forms90_path environment variable. For example, if your .fmx file is located in d:/my_files/applications, in the forms90_path you would include d:/my_files/applications (separated by semi-colons if listing more than one location). Forms90_Path is an environment variable that can be set using an Oracle9i Forms environment file, an ASCII file referenced by envFile=in formsweb.cfg. The deault environment file used is default.env located in the Forms90\Server directory. 2-6 Oracle9iAS Forms Services Deployment Guide Application Deployment To create your own environment file copy default.env and modify it as needed by your application. In the application configuration section in formsweb.cfg, add the following parameter: [application] form=hrapp.fmx envFile= .env 4. Enter the name of your application into the following URL: http://mymachine.com:7777/forms90/f90servlet? where "mymachine" is the name of your machine and "7777" is the port used by your HTTP Listener. Since you specified a configuration file, you will need to add "config=" and the name of the configuration section. So, using the example in step 2, the URL to access hrapp.fmx would be: http://mymachine.com:7777/forms90/f90servlet?config=application Specifying Parameters There are three ways to predefine paramter values for your Oracle9i Forms applications. You can define parameters by: ■ Editing your application settings in the default section of formsweb.cfg. The default configuration section displays the default values that will be used by Oracle9i Forms. The default configuration section contains two parts: System Parameters and User Parameters. While you can edit the existing default configuration section, you cannot create new ones. For example, the default value of the system parameter that specifies how to execute the Forms applet under Microsoft Internet Explorer 5.x is defined as follows: IE=JInitiator If you want the Forms applet to run in the browser's native JVM, edit the parameter in the formsweb.cfg file to read: IE=native You can override the system and user parameter values in the named application configuration section (see Creating configuration sections in formsweb.cfg.). For example: Basics of Deploying Oracle9i Forms Applications 2-7 Application Deployment [myApp] baseHTML=mybase.htm baseHTMLjinitiator=mybasejini.htm baseHTMLjpi=mybasejpi.htm baseHTMLie=mybaseie.htm form=myapp.fmx userid= Note: Parameters specified in the named configuration section of formsweb.cfg will override the system parameter settings. Override system parameter settings if your application requires modifications to the underlying HTML templates or another value set for the Internet Explorer virtual machine. Change the system parameter setting only if the modification must be adopted by all applications run by the server. Note: System Parameters cannot be overridden in the URL, while User Parameters can. ■ Creating configuration sections in formsweb.cfg. Under the configuration sections you created in step 2 of Deploying Your Application, you can specify parameters for your Oracle9i Forms applications. You can specify any application and system parameters that are in formsweb.cfg. For example, you can make the look and feel of the application to be the Oracle look and feel: [Human Resources] form=hrapp.fmx envFile= .env userid=scott/tiger@orcl 2-8 Oracle9iAS Forms Services Deployment Guide Application Deployment lookandfeel= oracle You can also override the default parameter values in the named configuration section. For example, to predefine the connect information of an application to scott/tiger@orcl, the parameter value for userid must be set in the named configuration section: [Human Resources] form=hrapp.fmx envFile= .env userid=scott/tiger@orcl For other parameters you can edit, see Parameters in the formsweb.cfg File. Note: Parameters specified in the configuration section will override your application default settings. ■ Editing the URL you use to access Oracle9i Forms applications. You can directly type parameters into the URL that accesses your Oracle9i Forms application. Using the previous example, instead of specifying the pageTitle parameter in your configuration file, you could also type it into the URL as follows: http://mymachine.com:7777/forms90/f90servlet?config=hr&pageTitle="My Company" You can use the ampersand (&) to call a combination of a form and named configuration parameters. For example, in the following URL: http://mymachine.com:7777/forms90/f90servlet?config=ienative&form=hrap p, you are calling the form "hrapp" with the parameter settings you specified in "ienative". Note: Parameters specified in the URL will override parameters set in the configuration section. Basics of Deploying Oracle9i Forms Applications 2-9 Oracle9iAS Forms Services in Action Oracle9iAS Forms Services in Action This sections describes how an Oracle9i Forms application runs in Oracle9iAS, and how the configuration files are used, assuming that the Forms Servlet is used to generate the initial HTML page. For simplicity, we assume the Web server is running on port 7777 on a machine called "mymachine.com". We also assume no modifications have been made to the standard configuration created during the Oracle9iAS installation process. When a user runs an Oracle9i Forms application, the following sequence of events occurs: 1. The user starts up their Web browser and goes to a URL like the following: http://mymachine.com:7777/forms90/f90servlet?config=ienative&form=hrapp In this case, the (top level) form module to be run is called "hrapp" using the configuration section called "ienative" 2. Oracle HTTP listener receives the request. It forwards the request to OC4J, since the path "/forms90/f90servlet" matches one of the OC4J mount directives in the forms90.conf file (the one for the Forms Servlet). 3. OC4J maps the request to the Oracle9i Forms application (whose context root is /forms90). It maps the request to the Forms Servlet (using the f90servlet servlet mapping specified in the web.xml file). 4. The Forms Servlet (running in OC4J) processes the request as follows: ■ ■ ■ ■ Opens the servlet configuration file (formsweb.cfg by default). If that parameter is not set, the default configuration file ( /forms90/server/formsweb.cfg) is used. Determines which configuration section to use in the formsweb.cfg file. Since the URL contains the query parameter "config=ienative", the [ienative] section will be used. Determines which baseHTML file to use, based on (a) what browser made the request, (b) what platform the browser is running on, and (c) the settings of various parameters in the formsweb.cfg file (specifically, baseHTMLie, baseHTMLjinitiator, baseHTMLjpi, baseHTML, and IE). Reads the baseHTML file, and sends the contents back as an HTML page to the user's Web browser, after doing variable substutions as follows: Whenever a variable (like %myParam%) is encountered, the Forms Servlet looks for a matching URL query parameter (for example, &myParam=xxx), or, failing that, looks for a matching parameter in the 2-10 Oracle9iAS Forms Services Deployment Guide Oracle9iAS Forms Services in Action formsweb.cfg file. If a matching parameter is found, the variable (%myParam%) is replaced with the parameter value. For example, the baseHTML file contains the text %form%. In our example, this is replaced with the value "hrapp". 5. Depending on which baseHTML file the Forms Servlet selected, the HTML page sent back to the Web browser will contain an Applet, Object or Embed tag to start up the Forms applet (thin client). The Forms applet runs in a JVM (either the Web browser's native JVM, or a "plugged in" JVM like Oracle JInitiator or Sun's Java plug-in). 6. If the baseHTML file selected was for a plug-in (Oracle JInitiator or Sun's JDK Java plug-in), and if the user does not already have that plug-in installed on their machine, they are prompted to install the plug-in. In the case of JInitiator, the download location is under the virtual path /forms90/jinitiator (a virtual path defined in the forms90.conf file). 7. In order to start up the Forms applet, its Java code must first be loaded. The location of the applet is specified by the applet codebase and archive parameters. For example, if the user is running with Oracle JInitiator, the applet code is loaded from the file http://mymachine.com:7777/forms90/java/f90all_ jinit.jar The virtual path definition in the forms90.conf file for "/forms90/java" allows the applet code to be loaded from the Web server. Note: The Forms applet code (for example, f90all_jinit.jar) is only to be loaded over the network the first time the user runs an Oracle9i Forms application (or if a newer version of Oracle9i Forms is installed on the Web server). Otherwise, it is to be loaded from the Web browser's (or the Java plug-in's) cache on the local disk. 8. Once the Forms applet is running, it starts up a Forms session by contacting the Forms Listener Servlet at URL http://mymachine.com:7777/forms90/l90servlet. 9. The Oracle HTTP listener receives the request. It forwards the request to OC4J, since the path "/forms90/l90servlet" matches one of the OC4J mount directives in the forms90.conf file (the one for the Forms Listener Servlet). 10. The Forms Listener Servlet (l90servlet) starts up a Forms runtime process (ifweb90.exe or f90webm) for the Forms session. Basics of Deploying Oracle9i Forms Applications 2-11 Client Browser Support 11. Communication continues between the Forms applet (running in the user's Web browser) and the Forms runtime process, via the Listener Servlet, until the Forms session ends. 12. The command line (such as giving the name of the form to run) is passed to the Forms runtime process. It is given as the applet parameter "serverArgs". Part of the serverArgs value in the baseHTML file was %form%, which was replaced by "hrapp". Therefore the runtime process actually runs the form in the file "hrapp.fmx". This file must either be present in the workingDirectory (which is specified in the formsweb.cfg file), or in one of the directories named in the FORMS90_ PATH environment setting, which is defined in the environment file (default.env by default). You can also specify the directory in the formsweb.cfg file (for example, form=c:\temp\myform). 13. The Forms sessions ends when one of the following occurs: ■ ■ The top level form is exited (for example, by PL/SQL trigger code which calls the "exit_form" built-in function). In this case, the user is prompted to save changes if there are unsaved changes. "exit_form(no_validate)" exits the form without prompting. The user quits their Web browser (in this case, any pending updates are lost). Client Browser Support Users can view Oracle9i Forms applications on the Web using Oracle JInitiator plug-in (using Netscape Navigator or Internet Explorer). In future patch releases other virtual machines will be supported. For more information about client browser support, including the latest supported platforms, go to the Oracle9i Forms Developer menu and choose Help | Forms on OTN... Oracle JInitiator Oracle JInitiator runs within a Web browser and is based on Sun’s JDK/JRE 1.3. It provides the ability to specify a specific Java Virtual Machine (JVM) on the client rather than using the browser's (native) default JVM. Oracle JInitiator does not replace or modify the default JVM provided by the browser. Rather, it provides an alternative JVM in the form of a plug-in for Netscape Navigator and as an ActiveX component for Internet Explorer. 2-12 Oracle9iAS Forms Services Deployment Guide Client Browser Support Oracle provides two JAR files (f90all.jar and f90all_jinit.jar) that group and zip classes together for efficient delivery across the network to the client. f90all_jinit.jar is an extra-compressed JAR file that can be used only with Oracle JInitiator to provide increased performance at download time. Once on the client, the files are cached for future use. For more information about Oracle JInitiator, see Appendix A, "JInitiator". How Configuration Parameters and BaseHTML Files are Tied to Client Browsers When an user starts a Web-enabled application (by clicking a link to the application’s URL), the Forms Servlet: 1. Detects which browser is being used; 2. Reads the formsweb.cfg file to determine the Internet Explorer parameter setting if the user is using Internet Explorer 5.5 or higher; 3. Selects the appropriate baseHTML file using the following table: Browser detected IE parameter setting Base HTML file used Internet Explorer 5.x or 6* native VM baseie.htm Internet Explorer 5.x or 6* jinitiator basejini.htm Netscape Navigator or Internet Explorer version preceding version 5 not applicable basejini.htm All other browsers not applicable base.htm * Internet Explorer 6 that has been upgraded from 5.5 only (IE 6 is not certified in the base release) ** Internet Explorer running on Windows with the Microsoft Native VM. 4. Replaces variables (%variablename%) in the baseHTML file with the appropriate parameter values specified in the Forms Servlet .initArgs file, formsweb.cfg file, and from query parameters in the URL request (if any). 5. Sends the HTML file to the user’s browser. Basics of Deploying Oracle9i Forms Applications 2-13 Client Browser Support 2-14 Oracle9iAS Forms Services Deployment Guide 3 Configuring Oracle9iAS Forms Services Introduction This chapter contains the following sections: ■ Customizing Configuration Files ■ Customizing Environment Variables and Registry Settings ■ Creating Your Own Template HTML Files ■ Including Graphics in Your Oracle9i Forms Application ■ Deploying Icons and Images Used by Oracle9iAS Forms Services ■ Using HTTPS with the Forms Listener Servlet ■ Using the Hide User ID/Password Feature ■ Using an Authenticating Proxy to Run Oracle9i Forms Applications ■ Enabling Language Detection Customizing Configuration Files During the installation, the following configuration files were installed onto your system: ■ formsweb.cfg ■ base.htm, basejini.htm, basejpi.htm, and baseie.htm ■ web.xml ■ forms90.conf ■ registry.dat Configuring Oracle9iAS Forms Services 3-1 Customizing Configuration Files When a user first starts an Oracle9iAS Forms application (by clicking a link to the application’s URL), the 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, and from query parameters in the URL request (if any). You can modify the configuration files as your needs change. formsweb.cfg For a description and the location of the Forms Servlet configuration file (formsweb.cfg), see Chapter 2, formsweb.cfg. Parameters Naming Files Make sure the EnvFile parameter specifies the physical path to the environment file that contains the environment variable settings you want to use. The four baseHTML parameters should also be set to point to appropriate files. Typically, lines like the following should appear in the default section at the start of the formsweb.cfg file: baseHTML=base.htm baseHTMLie=baseie.htm baseHTMLJinitiator=basejini.htm baseHTMLjpi=basejpi.htm envfile=default.env All of these parameters give file names. If no paths are given (as in this example), the files are assumed to be in the same directory as the Forms Servlet configuration file (formsweb.cfg), that is /forms90/servlet. Creating specific named configurations in formsweb.cfg You can create specific named configurations in the formsweb.cfg file. These configurations can be requested in the end-user’s query string of the URL used to run a form. Create special configurations by adding the name of the configuration in brackets at the end of the formsweb.cfg file. Then, specify the parameters (only those you want to change) for this special configuration. For example, to create a configuration to run forms in a separate browser window with a "generic" look and feel, add the following code to the formsweb.cfg file: 3-2 Oracle9iAS Forms Services Deployment Guide Customizing Configuration Files [sepwin] forms= separateFrame=True lookandfeel=Generic The end-user would type the following URL to launch a form that uses the "sepwin" configuration: http://server:port/forms90/f90servlet?config=sepwin You can also use Enterprise Manager to create named configuration sections (see Chapter 6, "Enterprise Manager and Oracle9i Forms"). See Default formsweb.cfg File for other examples of special configurations. Parameters in the formsweb.cfg File Parameter Required / Optional Parameter Value System parameters These parameters control the behavior of the Forms Servlet. They can only be specified in the servlet configuration file (formsweb.cfg) and cannot be specified as URL query parameters. baseHTML optional Physical path to HTML file that contains applet tags. baseHTMLJInitiator required Physical path to HTML file that contains JInitiator tags. baseHTMLjpi optional Physical path to HTML file that contains Java Plug-in tags. Used as the baseHTML file if the client browser is not on Windows and the client browser is either Netscape or IE without the IE native settings. baseHTMLie optional Physical path to the HTML file that contains Internet Explorer 5 tags, for example the CABBASE tag. The default path is baseie.htm. This is required when using the Internet Explorer native JVM. HTML delimiter required Delimiter for variable names. Defaults to %. workingDirectory required Defaults to /forms90 if not set. envFile required This is set to default.env in the formsweb.cfg file. Configuring Oracle9iAS Forms Services 3-3 Customizing Configuration Files Parameter IE Required / Optional recommended if there are users with Internet Explorer 5.0 or above browsers Parameter Value Specifies how to execute the Forms applet under Microsoft Internet Explorer 5.0 or above. If the client is using an Internet Explorer 5.0 or above browser, either the native JVM or JInitiator can be used. A setting of "JInitiator" uses the basejini.htm file and JInitiator. A setting of "Native" uses the browser's native JVM. Runform parameters (serverArgs parameters) All parameters from here on match variables (%parameterName%) in the baseHTML file. These variables are replaced with the parameter values specified in the URL query string, or failing that, in the formsweb.cfg file. form required Specifies the name of the top level Forms module (fmx file) to run. userid optional Login string. For example: scott/tiger@ORA8. otherparams optional This setting specifies command line parameters to pass to the Forms runtime process in addtion to form and userid. Default is: debug=%debug% buffer_records=%buffer% debug_ messages=%debug_messages% array=%array% query_ only=%query_only% quiet=%quiet% render=%render% host=%host% port=%port% HTML page title, attributes for the BODY tag and HTML to add before and after the form For security reasons these may not be set using URL query parameters. pageTitle optional Oracle Forms Server HTMLbodyAttrs optional Attributes for the tag of the HTML page. HTMLbeforeForm optional HTML content to add to the page above the area where the Forms application will be displayed. HTMLafterForm optional HTML content to add to the page below the area where the Forms application will be displayed. Applet or object Parameters All of the following are specified in the baseHTML file as values for object or applet parameters. For example: required /forms90/l90servlet (see Chapter 1, Forms Listener Servlet) Oracle9iAS Forms Services Deployment Guide Customizing Configuration Files Parameter Required / Optional codebase required Parameter Value Virtual directory you defined to point to the physical directory /forms90/java, where, by default, the applet JAR files are downloaded from. The default value is /forms90/java. width required Specifies the width of the form applet, in pixels. Default is 650. height required Specifies the height of the form applet, in pixels.Default is 500. separateFrame optional Determines whether the applet appears within a separate window. Legal values: True or False. splashScreen optional Specifies the .GIF file that should appear before the applet appears. Set to NO for no splash. Leave empty to use the default splash image. To set the parameter include the file name (for example, myfile.gif) or the virutal path and file name (for example, images/myfile.gif). background optional Specifies the .GIF file that should appear in the background. Set to NO for no background. Leave empty to use the default background. lookAndFeel optional Determines the applications look-and-feel. Legal values: Oracle or Generic (Windows look-and-feel). colorScheme optional Determines the application’s color scheme. Legal values: Teal, Titanium, Red, Khaki, Blue, Olive, or Purple. Note: colorScheme is ignored if lookAndFeel is set to Generic. serverApp optional Replace default with the name of your application file (if any). Use application classes for creating application-specific font mapping and icon path settings. To set the parameter include the file name if file is in OracleHome\forms90\java\oracle\forms\registry or include the virtual path and file name. archive optional Comma-separated list of archive files that are used when the browser detected is neither Internet Explorer using native JVM nor JInitiator. (The default is f90all.jar.) To set the parameter include the file name if the file is in the codebase directory or include the virtual path and file name. Configuring Oracle9iAS Forms Services 3-5 Customizing Configuration Files Parameter Required / Optional archive_jinit optional Parameter Value Comma-separated list of JAR file(s) that is used when the browser detected is JInitiator. (The default is f90all_jinit.jar.) To set the parameter include the file name if the file is in the codebase directory or include the virtual path and file name. archive_ie optional Comma-separated list of CAB file(s) that is used when the browser detected is Internet Explorer using native JVM. (The default is f90all.cab.) networkRetries optional In situations of high load or network failures, you can specify the number of times (up to 10) the client will attempt to send a request to the intended servlet engine. The default setting is 0, in which case the Forms session will terminate after one try. mapFonts optional to trigger font mapping. As a result of some font rendering code changes in JDK 1.3, the font heights set in JDK 1.1 increased in JDK 1.3. As this may cause display issues, you can map the JDK 1.3 fonts so that the font sizes are the same as they were in JDK 1.1. Parameters for JInitiator jinit_download_page required (Netscape only) If you create your own version of the Jinitiator download page, set this parameter to point to it. Default is /forms90/jinitiator/us/JInitiator/jinit.download.htm. jinit_classid required (IE only) Default is clsid:CAFECAFE-0013-0001-0002-ABCDEFABCDEF jinit_exename required Default is jinit.exe#Version=1.3.1.2 jinit_mimetype required (Netscape only) Default is application/x-jinit-applet;version=1.3.1.2 Parameters for Sun’s Java Plug-in jpi_codebase required Sun’s Java Plug-in codebase setting jpi_classid required Sun’s Java Plug-in class id jpi_download_page required Sun’s Java Plug-in download page Enterprise Manager configuration parameters 3-6 Oracle9iAS Forms Services Deployment Guide Customizing Configuration Files Parameter Required / Optional Parameter Value em_mode required 1 is to enable. 0 is to disable. Applies only to the HTML-based version of the Enterprise Manager. TRUE indicates that all Enterprise Manager information is available, including metrics and servlet status. FALSE indicates that only configuration information is available. OID (Oracle Internet Directory) configuration parameters oid_formsid required Configured during the Oracle9iAS installation, so you do not need to change this. oracle_home required Configured during the Oracle9iAS installation, so you do not need to change this. Default formsweb.cfg File The default formsweb.cfg file contains the following: # formsweb.cfg - Forms Servlet default configuration file # ------------------------------------------------------# This file defines parameter values used by the FormsServlet (f90servlet) # # # # # # # # # # # # # # # # # # ******************************** DEFAULT CONFIGURATIONS ******************************** These are the default settings. Any of them may be overridden in the Named Configurations section. If they are not overridden, then the values here will be used. System Paremeters cannot be overridden in the URL. User Parameters can. 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. Configuring Oracle9iAS Forms Services 3-7 Customizing Configuration Files # baseHTML=base.htm baseHTMLjinitiator=basejini.htm baseHTMLjpi=basejpi.htm baseHTMLie=baseie.htm HTMLdelimiter=% # # WorkingDirectory defaults to /forms90 if unset. # workingDirectory= envFile=default.env # # The next parameter specifies how to execute the Forms applet under # Microsoft Internet Explorer 5.x. Put IE=native if you want the # Forms applet to run in the browser's native JVM. # IE=JInitiator # # # # # # # # 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) # # 1) Runform arguments: # form=test.fmx userid= # # These settings support running and debugging a form from the Builder: # otherparams=debug=%debug% buffer_records=%buffer% debug_messages=%debug_ messages% array=%array% query_only=%query_only% quiet=%quiet% render=%render% host=%host% port=%port% play=%play% record=%record% debug=no buffer=no 3-8 Oracle9iAS Forms Services Deployment Guide Customizing Configuration Files debug_messages=no array=no query_only=no quiet=yes render=no host= port= # # 2) HTML page title, attributes for the BODY tag, and HTML to add before and # after the form: # pageTitle=Oracle9iAS Forms Services HTMLbodyAttrs= HTMLbeforeForm= HTMLafterForm= # # 3) Values for the Forms applet parameters: # serverURL=/forms90/l90servlet codebase=/forms90/java imageBase=DocumentBase width=650 height=500 separateFrame=false splashScreen= background= lookAndFeel=Oracle colorScheme=teal logo= serverApp=default # # The following archive settings are for # archive_jini - settings for JInitiator # archive_ie - settings for IE native JVM # archive - settings for all other cases (Java Plugin, Appletviewer, etc) # archive_jini=f90all_jinit.jar archive_ie=f90all.cab archive=f90all.jar # Configuring Oracle9iAS Forms Services 3-9 Customizing Configuration Files # Number of times client should retry if a network failure occurs. # change after having read the documentation. # networkRetries=0 Only # # 4) Parameters for JInitiator (used with Windows clients) # # # Page displayed to Netscape users to allow them to download JInitiator. # If you create your own page, you should set this parameter to point to it. # jinit_download_page=/forms90/jinitiator/us/jinit_download.htm # # Parameters related to the version of JInitiator. # jinit_classid=clsid:CAFECAFE-0013-0001-0003-ABCDEFABCDEF jinit_exename=jinit.exe#Version=1,3,1,3 jinit_mimetype=application/x-jinit-applet;version=1.3.1.3 # # 5) Parameters for the Java Plugin (used with non-Windows clients) # # # Page displayed to users to allow them to download the JPI # (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 # # Parameters related to the version of the Java Plugin # jpi_classid=clsid:8AD9C840-044E-11D1-B3E9-00805F499D93 jpi_ codebase=http://java.sun.com/products/plugin/1.3/jinstall-13-win32.cab#Version=1 ,3,0,0 jpi_mimetype=application/x-java-applet;version=1.3 # # 6) EM config parameter # Set this to "1" to enable Enterprise Manager to track Forms processes # 3-10 Oracle9iAS Forms Services Deployment Guide Customizing Configuration Files em_mode=0 # # 6) OID Config parameters (for Single Sign-On) # oid_formsid=%OID_FORMSID% oracle_home=%ORACLE_HOME% # ******************************** # NAMED CONFIGURATIONS # ******************************** # # 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= " 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". # # # Example 1: configuration to run forms in a separate browser window with # "generic" look and feel (include "config=sepwin" in the URL) # [sepwin] separateFrame=True lookandfeel=Generic # # 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 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 Configuring Oracle9iAS Forms Services 3-11 Customizing Configuration Files # # Example 4: configuration running the Forms ListenerServlet in debug mode # (debug messages will be written to the servlet engine's log file) # [debug] serverURL=/servlet/l90servlet/debug base.htm, basejini.htm, basejpi.htm, and baseie.htm For a brief description and the locations of base.htm, basejini.htm, basejpi.htm, and baseie.htm, see Chapter 2, base.htm, basejini.htm, basejpi.htm, and baseie.htm. Four baseHTML files are created for your system by the Oracle Universal Installer during Oracle9iAS 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 Oracle9i 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 formsweb.cfg, 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 formsweb.cfg file. The following baseHTML starter files are available in the /forms90/server directory: ■ ■ 3-12 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. Oracle9iAS Forms Services Deployment Guide Customizing Configuration Files ■ ■ 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 Oracle9i 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 /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 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. 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, which are defined in Parameters in the formsweb.cfg File. All variables are replaced with the appropriate parameter values at runtime. Configuring Oracle9iAS Forms Services 3-13 Customizing Configuration Files 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, Oracle9iAS 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. Default base.htm File <HTML> <!-- FILE: base.htm (Oracle Forms) --> <!---> <!-- This is the default baseHTML 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% %HTMLbeforeForm% 3-14 Oracle9iAS Forms Services Deployment Guide Customizing Configuration Files %HTMLafterForm%