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


Reviewing remote help configuration requirements

No configuration is required by the administrator or the user.

Procedure

  1. Install and open the product.
  2. Click Help > Help contents.


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 URL for the help system to the users in your organization to enter in their preferences.
  4. User: Install the product and enter the URL for the help system in the preferences.
    1. With the product open, click Help > Preferences > Help > Content.
    2. Click New.
    3. Enter a name for the connection.
    4. Enter the information center URL.
    5. Click Test Connection. Verify that the connection status is successful. If the connection status fails, verify that the URL was entered correctly.
    6. Click OK. The URL is saved in the following format: http://server:port/help-name.
      Note: The /index.jsp ending of the URL is not included when the URL is saved. This truncation of the URL is correct.
  5. User: Open the product and click Help > Help contents to verify that the help content displays correctly and is accessed from the server.


Reviewing local help configuration requirements

When local help is selected, some products install the help automatically when you start the product for the first time. If the help is not automatically installed, you can use these tasks to install the content.

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 > Help contents.

Feedback