System information

Using helpTool
Page 182 Identity Manager 7.1 Update 1 • Release Notes
Using helpTool
With the Identity Manager 6.0 release, a new feature has been added that allows you to search the
online help and documentation files, which are in HTML format. The search engine is based on the
SunLabs “Nova” search engine technology.
There are two stages to using the Nova engine: indexing and retrieval. During the indexing stage, the
input documents are analyzed and an index is created which is used during the retrieval stage.
During retrieval, it is possible to pull “passages” that consist of the context in which the query
terms were found. The passage retrieval process requires the original HTML files to be present, so
these files must exist in a location in the file system accessible by the search engine.
helpTool is a Java program that performs two basic functions:
• Copies the HTML source files into a location known to the search engine
• Creates the index used during the retrieval stage
You execute helpTool from the command line, as follows:
$ java -jar helpTool.jar
usage: HelpTool
-d Destination directory
-h This help information
-i Directory or JAR containing input files, no wildcards
-n Directory for Nova index
-o Output file name
-p Indexing properties file
Rebuilding/Re-Creating the Online Help Index
The HTML files for online help are packaged in a JAR file. You must extract these files to a directory
for the search engine. Use the following procedure:
1. Unpack the helpTool distribution to a temporary directory. (Details TBD)
In this example, we will extract the files to
/tmp/helpTool .
2. In a UNIX shell or Windows command window, change directory to the location where the
Identity Manager application was deployed to your web container.
For example, a directory for Sun Java System Application Server might look like the
following:
/opt/SUNWappserver/domains/domain1/applications/j2ee-modules/idm