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
  
• Dependency
  
• Using OHW with your ADF Application
  
• Files Included in this Release
  

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

This release is distributed with Oracle's modified version of ICESoft's ICE Browser 6.1.3. Although OHJ has a pluggable HTML architecture, the ICE Browser is the default html component used by OHJ and no other browsers are currently recommended.

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.

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

Understanding OHW-RC Deployment Workflow as Part of Web Application

Installing the OHW-RC artifacts

Configuring OHW-RC Configuration Files

<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>

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>

<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)