Installing local help from an archive file

You can use the Local Help Updater to install the help locally on your computer. You can install the help from a help archive file that you or an administrator downloads from a help download site.

Before you begin

Before you can install local help from an internal server, you or an administrator must download a compressed help archive file that contains the help contents. The name of this file includes a product and version identifier and the suffix updateSite.zip.

Typically, this task is done on a computer where the Rational DOORS client is installed. If you are installing the help on an intranet server where Rational DOORS is not installed, you must first deploy the help system infrastructure on that server. Then, you can install the local help.

About this task

For this help configuration, you use the Local Help Updater to install local help content on your computer from a compressed archive file. The archive file can be on your computer or on a shared server on your network, as shown in this graphic.

The image shows the download of an updateSite.zip archive file to a local server, and installation of local help from that archive file.

Procedure

  1. Open the the Local Help Updater:
    • If you are installing the help content on a server where Rational DOORS is installed, open the Rational DOORS client and click Help > Contents and Index. In the Help window, click Help > Local Help Updater.
    • If you are installing the help content on a server where Rational DOORS is not installed, you can access the Local Help Updater by opening the Help Administration page at http://server:port/help/updater/admin.jsp. To determine the server name, port, and help name, see Help server administration. After the Help Administration page opens, from the Tools list, select Update Help Content.
  2. On the Local Help Updater page, in the toolbar, click the Plus sign (+).
  3. In the Add Internal Site window, click Local, and enter or browse to the location of the compressed archive file. Then, click OK.
  4. On the Local Help Updater page, expand the new internal site in the Site list.
  5. Select the help content features to install and click Install.
  6. When the installation finishes, verify the installation by opening the help from one of these locations:
    • In the Local Help Updater, click Help > Help Contents.
    • on the Help Administration page, in the Help list, click Home Page.
    • In the Rational DOORS client, click Help > Contents and Index.

What to do next

When you install content from a site, that site is added to the Favorite Sites list in the Local Help Updater. You can filter the Available Content site to display only the Favorite Sites.

If you want to automatically receive updated content from the information center and sites on the Favorite Sites list, in the toolbar, select Automatic Updates. Then, when you restart the help, you receive any new or updated content. If you leave the Automatic Updates check box cleared, you can use the Local Help Updater to manually update content.


Feedback