Downloading help content

If you have your help configured for downloaded help content (local help) and you have an Internet connection, you can download help content from the help update site (ibm.com) as described in Step 1. If the help server does not have Internet access or the connection is slow or unreliable, you can follow Step 2 below to use another connected computer to download a compressed file from the IBM Updater website at http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/. You can use media, such as a flash drive or a CD to transfer the downloaded help content to the help server.

About this task

Tip: To find the help context root (server, port, and help-name), open the help from the product by clicking ? > Help contents. The help URL is in the form https://server:port/help-name/index.jsp .
Important: For any help administration tasks, instead of server, use localhost or 127.0.0.1. You need to be on the server that is hosting the help system.

Procedure

Follow Step 1 if you have an internet connection or Step 2 if you do not to define to source for the help and then install the help locally.

  1. If you are using an internet connection. follow these steps:
    1. On the help server, navigate to local help updater page, https://localhost:port/help-name/updater/updatewar.jsp.
      The Updater window opens.
    2. In the Sites List pane, expand the help to download. For example, click on the Plus (+) for Rational solution for Collaborative Lifecycle Management.
  2. If you are not using an internet connection, follow these steps:
    1. On a computer that has internet access, obtain the compressed help-content file for your product from IBM Updater website at http://download.boulder.ibm.com/ibmdl/pub/software/rationalsdp/documentation/updatesites/. The file name has the format prod_coden.n_updateSite.zip, where prod_code is the product code and n.n is the version number. Download this file to the computer.
    2. Move the updateSite.zip file to the location where the help WAR file is running, either the help server or the intranet server hosting the information center.
    3. On the help server, navigate to local help updater page, https://localhost:port/help-name/updater/updatewar.jsp.
      The Updater window opens.
    4. Click the Plus (+) icon in the upper-right, and add a Name for this help source. For the File, enter or browse to the location of the local updateSite.zip file.
    5. In the Sites List pane, expand the Name of the site you just added. The new site is usually at the end of the Site list.
  3. Select the help features to download. The list of features contains entries for the help that is available for download. Depending on your network connection speed, generating the list might take a few minutes. If the icon for the help feature is a page, that help feature is already installed. If the help feature has a check box, you can select it.
  4. Click Install. The help content is downloaded and installed. A progress bar opens and tracks the status of the install.
  5. When the install is completed, close the Updater.
  6. Verify the help by navigating to https://server:port/help-name/index.jsp. For example, navigate to https://myserver.com:9443/help/index.jsp or https://www.server.org:9443/clmhelp/index.jsp.

Results

The help that you selected is installed and is available from your product.
Note: If you have automatic updates set, the content will be updated every time you restart the help when the help server has an internet connection to ibm.com®. The sites in the Favorites Sites list are checked for updates. When you download content from a remote site, that site gets added to the Favorites Sites list. You can filter the Available Content site to only display the Favorites Sites.

Feedback