Help content configurations

You can configure the web archive to access help content in one of three ways. You can access help from a remote IBM information center that is on the Internet; you can install the help content locally on your computer; or you can download and deploy the help content on a help 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

 1. 

Remote help
  • You access content directly from the information center on ibm.com.
  • Content is always the latest version.
  • Requires the smallest amount of space because only the help.war is installed.
  • An internet connection is required.
  • No additional setup is required.
  • This configuration is the default selection.

 2. 

Local help
  • Content is installed on your computer. Some products automatically install the content when the product starts for the first time; some products require you to install the content yourself.
  • An Internet connection is not required to view the content.
  • When changes are available from a remote update site, you can automatically or manually install them.

 3. 

Intranet help
  • Content is installed on a server. A single intranet information center can be used for multiple products.
  • An administrator in your organization downloads and installs the help content on a server in your intranet network.
  • Team members redirect their help clients to access the help on the local server.
  • 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 set up the help No Yes No
Users must set up the help No Yes Yes
Periodic updates are required No Yes Yes
Note: *An internet connection is not required if your help.war or media installation disk contains the full set of documentation.

Feedback