A script-enabled browser is required for this page to function properly.

Adding online Help to a pluggable data source

Often it is helpful to add help to a PDS. To do this, you need to create an Oracle Help for Java (OHJ) helpset. More information on how to create an OHJ helpset can be found on theOracle Technology Network, under Technologies>Java>Help. Look for the document titled Creating a helpsystem using Oracle Help. You can use a helpset authoring tool to speed up the creation of the help system. At a minimum, the helpset needs to consist of an .hs file, the HTML topic files and a set of control files (Index, TOC, Search files). The files then need to be jarred and placed in the helpset directory:

%ORACLE_HOME%/reports/doc/language_name/

Where language_name is typically US. If you want to use translated helpsets, you will need to place them in a directory with the appropriate extension. Note that this directory has to be present and the Reports help .jar files also have to reside in the directory. This is because Reports will load the help based on locale settings.

The naming of your helpset files is important. The helpset file (.hs) needs to have the following format:

htmlhelp.pds.pdsname.hs

Where pdsname is the name of your PDS. This .hs file needs to be in the top level folder of your help system and the entire helpset needs to be jarred up and named using the same convention:

htmlhelp.pds.pdsname.jar

When you have registered your PDS, your helpset will automatically be loaded into the Oracle Reports online Help when help is requested. You can make it appear under the Pluggable Data Sources node if you give the TOC view the <label> of Contents and the <title> of Pluggable Data Sources, as shown below in the .hs file:

<view>
  <label>Contents</label>
  <title>Pluggable Data Sources</title>
  <type>oracle.help.navigator.tocNavigator.TOCNavigator</type>
  <data engine="oracle.help.engine.XMLTOCEngine">toc.xml</data>
</view>

See also