Sun Java System Portal Server 7.1 Developer's Guide

Preparing Your Completion Script to Appear in the Administration Interface

If you want your cmdHook script to display as an option on the search engine administration page, you should follow these guidelines:

  1. Because the search engine Administration Interface does not scan binary files when it looks for cmdHook scripts, write your script in a run-time evaluated language instead of C or another compiled language.

  2. Place the file in PortalServer-base/bin directory.

  3. Name the file cmdHook, followed by an alphanumeric character-string, for example, cmdHook0, cmdHookAlpha, cmdHook12a.

  4. Add a description string to the file and comment it so that it does not affect the execution of the script. For example, #description="My menu choice string".