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


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 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 following information to provide the users in your organization 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: For http://server.ibm.com:8080/help/index.jsp, the values are:
    • Server: server.ibm.com
    • Port: 8080
    • Path: /help
  5. User: Open the product and click ? > Help content to verify that the help content displays 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