Display Online Help

You can display Knowledge Discovery Expert, or the Help for a particular component (for example the Content component Help) by sending an action from your Web browser.

For a component to display help, the help data file (help.dat) must be available in the same directory as the service instance.

To display help for Knowledge Discovery

  1. Start the Knowledge Discovery component.

  2. Send the following action from your Web browser:

    http://componentHhost:port/action=Help

    where,

    componentHost is the IP address or name of the machine on which the component is installed.
    port is the ACI port by which you send actions to the component (set by the Port parameter in the component configuration file [Server] section).

    For example:

    http://12.3.4.56:9000/action=help
  3. On the help landing page, click one of the following options to open the relevant help:

    Reference The combined Help, which includes Knowledge Discovery Administration Guide and the component Reference. The Knowledge Discovery Administration Guide describes how to configure and use Knowledge Discovery, and the component Reference contains details of all the actions and configuration parameters that you can set in that component.
    Knowledge Discovery Expert Knowledge Discovery Expert provides conceptual overviews and expert knowledge of Knowledge Discovery and its features and functionality.

    If you are new to Knowledge Discovery, you can use Knowledge Discovery Expert to find out more about the different functions that Knowledge Discovery can perform. Use the Knowledge Discovery Administration Guide to get specific information about configuration and administration procedures. Use the component Reference to look up specific configuration parameters and actions.

    The navigation panel for the Reference lists the following options to display reference information:

    Tab Description
    Actions Describes the actions you can send to Knowledge Discovery. Actions allow you to query Knowledge Discovery, and to instruct it to perform a variety of operations.
    Configuration Parameters Describes the parameters that determine how the Knowledge Discovery operates. Configuration parameters are set in the Knowledge Discovery configuration file.
    Index Actions (Content component and Distributed Index Handler only) Describes the index actions you send to Knowledge Discovery. Index actions allow you to index content, and to administer the Data index.
    Service Actions Describes service actions. Service actions allow you to return data about the Knowledge Discovery service, and to control Knowledge Discovery.