Oracle Help for Web Rich Client Production Release 5.0
(Requires JavaSE 5 or higher)
Date of Release : 7/1/2009

 


 

Contents

Changes In This Release

Oracle Help 5.0 is a new major release that contains significant changes.

  • Changed Jar Names

    Beware that the Oracle Help Jar file names have changed in Oracle Help 5.0. The Files Included in this Release section provides an overview of the new OHJ file names.

  • Enhanced Full Text Search

    This release includes a new version of the Oracle Help Full Text Search indexer that adds word position information into the IDX files.

    All Oracle Help 5.0 products have been updated to make use of this new position information to support exact phrase searches and to improve the result ranking mechanism (giving more points if the search terms are found near to each other). The improved result ranking is in effect for all types of searches. To search for an exact phrase, place the phrase in double quotes ("an exact phrase search").

    Oracle Help 5.0 products can read IDX files created with previous versions of the Oracle Help Indexer (they are simply searched as they were before), and you can mix and match old and new IDX files if necessary. What you cannot do, is try to use an IDX file created with the new indexer, with a previous OHJ/OHW release. Attempting to do so will cause a SearchException to be logged stating that the IDX version is not supported.

Dependency Information

Sun Microsystems Java SE 5.0 or higher is required to use OHJ 5.0. Java SE 6.0 is recommended.

Using OHW with your ADF Application

Approach 1: OHW (ohw-rcf-demo.ear) deployed as a Standalone Application and integrated with your ADF application

  • We recommend that you build you ADF application and then use the helpTopicId attribute to link your ADF application to OHW-RC. However, we recommend that you deploy OHW-RC separately from the ADF application. This keeps the setup and configuration cleaner and easier to debug and support. For example, by deploying OHW-RC separately, you can fine-tune the web.xml file for OHW-RC and your ADF Application separately to ensure each is optimized for its specific use.

Deploying OHW-RC Demos in WebLogic (WLS)

  • ohw-rcf-demo-thin.ear: Meant to be deployed through and instance of WLS that already had the adf-faces and trinidad runtime jars installed (the shared library adf.oracle.domain.webapp).
  • ohw-rcf-demo-thick.ear: Comes with local copies of the adf-faces and trindad runtime jars, and thus can be deployed through an instance of WLS that isn't configured to use adf.oracle.domain.webapp shared library.

Option 1: Deploying ohw-rcf-demo-thin.ear to a standalone WLS

  1. Start the WebLogic DefaultDomain
  2. Access http://localhost:7101/console (The WebLogic Server's administration console)
  3. Login using weblogic/weblogic1
  4. Click on the 'Deployments' Link
  5. Ensure that you have ADF installed
  6. Click the 'Install' button
  7. Navigate and select WebLogic ready application EAR file and click on the 'Next' button
  8. Select 'Install this deployment as an application' and click on 'Next' and 'Finish' and 'Save' button
  9. OHW-RCF is accessible by accessing http://localhost:7101/help-ohw-rcf-context-root/ohguide (if you haven't modified the ohw-rcf-demo-thin.ear's META-INF/application.xml, then the context root is "ohw-rcf-demo", which means http://localhost:7101/ohw-rcf-demo/ohguide will start the application)

Option2: Running the ohw-rcf-demo-thin.ear from JDeveloper

  1. Start JDeveloper 11g
  2. Select File -> New -> Application from EAR File
  3. Select the ohw-rcf-demo-thin.ear file and click 'Finish'
  4. Right-click the ohw-rcf-demo-thin project and select Deploy -> to IntegratedWLSConnection. Access the demo via http://localhost:7101/ohw-rcf-demo/ohguide (If the prior link does not work try http://localhost:7101/ohw-rcf-demo-thin/ohguide)

Approach 2: OHW as part of a Web Application

  • If for some reason you cannot deploy OHW-RC separately, you can add OHW-RC files directly to your ADF Application and deploy everything together. We do not recommend this approach as it tends to make things much arder to debug and support. For example, if you deploy OHW-RC together with your ADF App, both will share the same web.xml file, which will not allow you to fine-tune the OHW-RC application separately from the ADF Application as is often desirable.
  • There are serveral files needed to run OHW RC correctly:
    • ohw-rcf.jar
    • ohw-share.jar
    • help-share.jar
    • ohw-rcf-webapp.zip

Understanding OHW-RC Deployment as Part of Web Application

Once help authors are done with the help contents, then the OHW administrator will need to modify the web configuration to deploy the help contents using OHW-RC. One way to deploy OHW-RC  is to allow it to co-exist with your web application. The web application can be a JSF, ADF, JSP application or any JEE web application The OHW-RC could then be deployed as one of the web projects within the existing application.

Understanding OHW-RC Deployment Workflow as Part of Web Application

 Since OHW-RC will be part of an existing application, there are some steps that need to be done in the configuration of  the existing web application:
  • Veifying requirements and dependencies
  • Configuring the JEE Container
  • Installing the OHW-RC artifacts
  • Configuring OHW-RC configuration files

Verifying requirements and dependencies

To deploy OHW-RC as part of a web application, there are some requirements to be verified.

Requirement

Description

JEE Container The OHW-RC needs a JEE Container that could support Java Servlet 2.5\JSP 2.1 or later, JSF 1.2 (JEE 1.5). These containers are:
  • Oracle WebLogic Application Server Container 10.3
  • Apache Tomcat 6.x (not supported in 11gR1)
Client OHW-RC supports the browsers supported by ADF-Faces 11g. See the list of Supported Browsers.
Rich ADF Faces OHW-RC need the Rich ADF Faces libraries and their dependencies to be available. It should also be configured for ADF-based applications by installing the right jar files. This is generally done by using the adf.oracle.domain.webapp shared library. JSF 1.2 is also required

Configuring JEE Container

The existing container needs to be configured to support Rich ADF Faces since OHW-RC depends on that technology. Oracle JDeveloper, has a "ADF Runtime Installer" that will help you install the ADF libraries into the WebLogic Application Server Container.

Installing the OHW-RC artifacts

There will be serveral files you need to run the OHW-RC project: ohw-share.jar, help-share.jar, ohw-rcf.jar and ohw-rcf-webapp.zip,  which contains installable files like .jspx (xml style of a JSF page), images, css, and javascript files needed to run OHW-RC properly.
  • The ohw-rcf-webapp.zip needs to be extracted to the public html folder of the existing web application..
  • Create a helpsets directory under the public html directory.
  • Create an ohwconfig.xml file under the new helpsets directory.
  • The jar files (ohw-share.jar, help-share.jar, ohw-rcf.jar) should be put in a folder which is in the web application library path (such as public_html\WEB-INF\lib).
  • After adding the files, press the Refresh button on the Application Navigator in JDeveloper to have the window refresh.

Configuring OHW-RC Configuration Files

After all files have been placed in the right location, the OHW-RC administrator still needs to modify some configuration files to make the OHW-RC work.
  • Modify the application's web.xml file to include JSF servlet definitions and ADF Faces tags:
<context-param>
                                    

        <param-name>org.apache.myfaces.trinidad.CHANGE_PERSISTENCE</param-name>
                                    

        <param-value>oracle.adf.view.rich.change.FilteredPersistenceChangeManager</param-value>
                                    

    </context-param>
                                    

    <filter>
                                    

        <filter-name>trinidad</filter-name>
                                    

        <filter-class>org.apache.myfaces.trinidad.webapp.TrinidadFilter</filter-class>
                                    

    </filter>
                                    

    <filter-mapping>
                                    

        <filter-name>trinidad</filter-name>
                                    

        <servlet-name>Faces Servlet</servlet-name>
                                    

    </filter-mapping>
                                    

    <servlet>
                                    

        <servlet-name>Faces Servlet</servlet-name>
                                    

        <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
                                    

        <load-on-startup>1</load-on-startup>
                                    

    </servlet>
                                    

    <servlet-mapping>
                                    

        <servlet-name>Faces Servlet</servlet-name>
                                    

        <url-pattern>/faces/*</url-pattern>
                                    

    </servlet-mapping>
                                    

    <servlet>
                                    

        <servlet-name>resources</servlet-name>
                                    

        <servlet-class>org.apache.myfaces.trinidad.webapp.ResourceServlet</servlet-class>
                                    

    </servlet>
                                    

    <servlet-mapping>
                                    

        <servlet-name>resources</servlet-name>
                                    

        <url-pattern>/adf/*</url-pattern>
                                    

    </servlet-mapping>
                                    

    <servlet-mapping>
                                    

        <servlet-name>resources</servlet-name>
                                    

        <url-pattern>/afr/*</url-pattern>
                                    

    </servlet-mapping>
                                  
  • Modify web.xml to support OHW-RC front servlets and JSF filter:
servlet>
                                    

        <servlet-name>OHW Servlet 1</servlet-name>
                                    

        <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
                                    

        <init-param>
                                    

            <param-name>ohwConfigFileURL</param-name>
                                    

            <param-value>/helpsets/ohwconfig.xml</param-value>
                                    

        </init-param>
                                    

        <load-on-startup>2</load-on-startup>
                                    

    </servlet>
                                    

    <servlet>
                                    

        <servlet-name>OHW Servlet 2</servlet-name>
                                    

        <servlet-class>oracle.help.web.rich.OHWServlet</servlet-class>
                                    

        <init-param>
                                    

            <param-name>ohwConfigFileURL</param-name>
                                    

            <param-value>/helpsets2/ohwconfig.xml</param-value>
                                    

        </init-param>
                                    

        <load-on-startup>3</load-on-startup>
                                    

    </servlet>
                                    

                                     

    <servlet-mapping>
                                    

        <servlet-name>OHW Servlet 1</servlet-name>
                                    

        <url-pattern>/ohguide/*</url-pattern>
                                    

    </servlet-mapping>
                                    

    <servlet-mapping>
                                    

        <servlet-name>OHW Servlet 2</servlet-name>
                                    

        <url-pattern>/blafdoc/*</url-pattern>
                                    

    </servlet-mapping>
                                    

                                     

    <!--This mapping is to support old OHW2 bookmarked URL. If you want to support
                                    

        OHW2 URL, please find out servlet mapping from web.xml in OHW2, add it
                                    

        here but change servlet to be Faces Servlet-->
                                    

    <servlet-mapping>
                                    

        <servlet-name>Faces Servlet</servlet-name>
                                    

        <url-pattern>/help/*</url-pattern>
                                    

    </servlet-mapping>
                                    

                                     

    <filter>
                                    

        <filter-name>OHWRCFRequestFilter</filter-name>
                                    

        <filter-class>oracle.help.web.rich.OHWFilter</filter-class>
                                    

    </filter>
                                    

    <filter-mapping>
                                    

        <filter-name>OHWRCFRequestFilter</filter-name>
                                    

        <servlet-name>Faces Servlet</servlet-name>
                                    

    </filter-mapping>
                                  
  • Modify the ohwconfig.xml file you created and edit help content as needed. It specifies which helpsets to display and how to present them. You can also specify locales, branding information, and various other settings. For more information about this configuration file, please the OHW-RC Developers Guide on ohwconfig.xml. 
  • Modify faces-config.xml to add the ADF Faces render kit:
<application>
                                    

    <
                                     default-render-kit-id>oracle.adf.rich</
                                     default-render-kit-id>
                                    

    <locale-config>
                                    

      <
                                     default-locale>en</
                                     default-locale>
                                    

    </locale-config>
                                    

</application>
                                  

Files Included in this Release

  • ohw-rcf.jar (5.0 OHW main jar file -- required to run OHW-RC and bundled in the demo apps)
  • ohw-share.jar (5.0 OHW Share jar file -- required to run OHW-RC andbundled in the demo apps)
  • help-share.jar (5.0 Oracle Help Share jar file -- required to run OHW-RC and bundled in the demo apps)
  • ohw-rcf-webapp.zip (5.0 OHW Rich Client webapp -- required to run OHW-RC and the jspx page bundled in the demo apps)
  • ohw-rcf-demo-thick.ear (5.0 OHW Thick Demo app -- includes ohw-rcf.jar, ohw-share.jar, help-share.jar, adf libraries plus jspx pages from ohw-rcf-webapp.zip)
  • ohw-rcf-demo-thin.ear (5.0 OHW Thin Demo app -- includes ohw-rcf.jar, ohw-share.jar, help-share.jar plus jspx pages from ohw-rcf-webapp.zip)

 

Copyright © 2009 Oracle Corporation. All Rights Reserved.

Oracle is a registered trademark, and other Oracle product names, service names, slogans or logos referenced in this paper are trademarks or registered trademarks of Oracle Corporation. All other company, product or service names referenced in this paper are used for identification purposes only and may be trademarks of their respective owners.

Send mail to ohinfo_us@oracle.com
Left Curve
Popular Downloads
Right Curve
Untitled Document