Reviewing the setup requirements for each configuration

As you are selecting which configuration best suits your environment, consider the setup requirements for each of the configurations.

Before you begin

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


Reviewing remote help configuration requirements

No configuration is required by the administrator or the user. The remote information center is already added as the product help preference.

Procedure

  1. Install and open the product.
  2. Click ? > Help content.


Reviewing intranet server configuration requirements

Both administrators and users must complete their required steps.

Procedure

  1. Administrator: Set up the help system on a server by following the instructions that are appropriate for the application server that is installed on your server:
  2. Administrator: Download and install the help content by following the instructions in one of the following topics:
  3. Administrator: Provide the server, port, and path to the users in your organization for them to enter in the Installation Manager Help System page.
    • Server: The name of the server
    • Port: The port number
    • Path: A slash and the help context
  4. User: Install the product. In the Installation Manager Help System Configuration page, select Access help from a server on your intranet and enter the server, port, and path to the information center.
    Example: http://server.ibm.com:8080/help-name/index.jsp
    • Server: server.ibm.com
    • Port: 8080
    • Path: /help-name
  5. User: Open the product and click ? > Help content to verify that the help content opens correctly and is accessed from the server.


Reviewing local help configuration requirements

This configuration is applicable only if you are installing the web application on your computer. In most environments, either remote help or intranet help is the appropriate setup type for use with web applications.

Procedure

  1. Install and open the product.
  2. Administrator: Download and install the help content by following the instructions in one of the following topics:
  3. To verify the installation, click ? > Help content.

Feedback