Help content configurations overview

Consider each help configuration that you can select. Depending on the needs for your organization, one help content configuration might be preferred over the other configurations.


Descriptions of the help configurations

You can configure the web archive to access help content in one of three ways.
Table 1. Help content configuration descriptions
Setup type Description Installation Manager Help System page selection

 1. 

Remote help
  • Content is accessed directly from the public information center on ibm.com®.
  • Always the latest version of the content.
  • Requires the smallest amount of space since only the help.war is installed.
  • Requires an internet connection.
  • No additional setup required.
  • Default selection.

Access help from the web

 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.
  • Internet connection not required to view the content.
  • Updates are automatically or manually installed when changes are available.

Download help and access the content locally

 3. 

Intranet help
  • Content is installed on a server. A single intranet information center can be used for help for multiple deployments.
  • Used primarily in enterprise environments.
  • System administrator sets up an intranet server behind the firewall on which the help is installed and the users can connect to.

Access help from a server on your intranet


Each of the configurations are depicted in this diagram by their corresponding numbers from the previous table:
Figure 1. Help content configurations
The three help content delivery options


Considerations for selecting a configuration

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

Table 2. Considerations for selecting a configuration
Consideration Remote help Local Help Intranet help
Internet connection is required to configure the help Yes Yes* Yes*
Internet connection is required to view the help Yes No No
Appropriate for enterprise environment No Yes Yes
Administrator setup is required No Yes No
User setup is required 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