View Component 25.1
View Component Help

# Display Online Help

The Knowledge Discovery component ZIPs include a help data file (help.dat) for each component that you can install. Each help package includes Knowledge Discovery Expert, the Knowledge Discovery Administration Guide, and the appropriate component Reference (for example the Content component Reference).

You can display the help by sending an action from your Web browser.

NOTE: For a Knowledge Discovery 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 a component

1. Start the component.

2. Send the following action from your Web browser:

       http://componentHost: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 `[Server]` section of the component configuration file).

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

   Reference | Reference links to the combined Administration Guide and Reference. The Administration Guide contains information about how to set up, configure, and administer Knowledge Discovery, while the Reference contains details of all the actions and configuration parameters that you can set in the particular 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 it can perform. You can use the 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 that you can send to the component (or a Proxy component). Actions allow you to query the component, and to instruct it to perform a variety of operations.
   Configuration Parameters | Describes the parameters that determine how the component operates. You can set configuration parameters in the component configuration file.
   Index Actions | Describes the index actions that you can send to the component. This section is available only in components that accept index actions (primarily Content, DIH, and Proxy). Index actions allow you to index content into the Content component, and to administer the data index.
   Service Actions | Describes service actions. Service actions allow you to return data about the component service, and to control the service.

Copyright 2024 Open Text
Version 25.1 | Last updated January 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery View Component 25.1

Topic Title: Display Online Help