Help content configurations

You can configure the product help content in one of three ways. You can use the default connection to the remote IBM® Knowledge Center that is on the Internet. You can download and deploy an IBM Knowledge Center locally on your computer. Or, an administrator can download and deploy an IBM Knowledge Center on a server on your network.


Descriptions of the help configurations

Consider the configuration options and select one that meets the needs of your organization.
Table 1. Help content configurations
Setup type Description
Remote help
  • This configuration is the default selection. No additional setup is required.
  • An Internet connection is required.
  • You access content directly from the public IBM Knowledge Center.
  • Content is always the current version.
  • Requires the smallest amount of space because only the infrastructure is installed.
Local help
  • Download a compressed file that contains a customer installable IBM Knowledge Center and the product help from the help download site. Extract the contents on your computer and start the IBM Knowledge Center. See Installing local help on your computer.
  • You must configure your product help to access the local IBM Knowledge Center. See Changing help content connections
  • An Internet connection is not required to view the content.
Intranet help
  • An administrator in your organization downloads a compressed file that contains a customer installable IBM Knowledge Center and the product help from the help download site. The administrator extracts the contents on a server on your intranet network and starts the IBM Knowledge Center. See Installing help on an intranet server.
  • Team members redirect their help clients to access the help on the server. See Changing help content connections.
  • This help deployment is used primarily in enterprise environments that have limited Internet access.

Considerations for selecting a configuration

Review the list of considerations to make when you are selecting a help configuration for yourself or your organization.

Table 2. Considerations for selecting a configuration
Consideration Remote help Local Help Intranet help
To configure the help, an Internet connection is required. Yes Yes* Yes*
To view the help, an Internet connection is required. Yes No No
The configuration is appropriate for an environment with limited Internet access. No Yes Yes
An administrator must install the help. Users must set a new help connection. No No Yes
Users must install the help and set a new help connection. No Yes No
Note: *An Internet connection is not required if your product is installed with the full set of documentation.

Feedback