Installing help content locally from an archive file

If you must access help content from a computer that does not have an Internet connection, you can install the help content from a file that you can obtain from the IBM® Local Help System Updater website. You must download the help content file by using a computer that has Internet access and copy the file to the computer without Internet access.

About this task

This task can be used to install help content on your computer or on a server.

Procedure

  1. On a computer with Internet access, download the compressed help content file for your product and version from the Help download site at http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/. The file has this format: prod_coden.n_updateSite.zip, where prod_code is the product code and n.n is the version number.
  2. On the computer where you are installing the help content, copy this compressed archive file. Do not extract the file.
  3. With your product open, click Help > Local Help Updater.
    Note: If you are installing the help content on a server where the product is not installed, you can access the Local Help Updater by opening the following Help Administration page URL in a browser: http://server:port/help/updater/admin.jsp. Then select the Update Help Content tab.
  4. On the Local Help Updater page, click the Plus sign (+).
  5. On the Add Internal Site dialog box, click Local, and enter or browse to the location of the compressed archive file in the File field.
  6. Click OK in the Add Internal Site window.
  7. On the Local Help Updater page, expand this site in the Site list.
  8. Select the help content features that you want to install from the list that is provided, and click Install. A progress bar tracks the progress of the installation.
  9. When the installation finishes, verify the installation by opening the help in the product by clicking Help > Help Contents.

Results

If you were installing the content locally to access from the product that is installed on your computer, the help that you selected is installed and is available from your product.

If you downloaded content from a remote site, that site was added to the Favorites Sites list. You can filter the Available Content site to display only the Favorites Sites.

What to do next

If you downloaded the help to either a server or your computer:
  • You can choose to enable automatic updates. By default, the Automatic Updates option is not selected in the Local Help Updater. If you select the Automatic Updates option, you receive updated content from the help update site (ibm.com) and the sites in the Favorites Sites list when the help archive file is restarted and an internet connection exists. If you choose to leave the Automatic Updates check box cleared, you can manually update content.
If you downloaded the help to a server:
  • Provide users with the server, the port, and the path to the help system to enter in the Help System Configuration page in IBM Installation Manager. Ensure that the server you provide is not localhost.
    Example: http://server.ibm.com:8080/help/index.jsp
    • Server: server.ibm.com
    • Port: 8080
    • Path: /help

Feedback