Configuring the help server to provide local or intranet help by using administration tools

The Help Administration page is available for local help or intranet help configurations. The Help Administration page provides access to all of the tools you use to administer your help server.

You can open the Help Administration page by entering this URL in a browser: http://server:port/help-name/updater/admin.jsp.

Note: The first time you access the Help Administration page, you must access it locally from the server that the help is running on. To access the Help Administration page remotely in the future, change the authentication type.
If you do not choose to use the Help Administration page, you can access most of the tools individually. To access the tools individually, refer to the URLs that are listed in the following table.
Table 1. Table 1. URLs to help server tools
Help server tool URL Corresponding Help Administration tab
Help content http://server:port/help-name/index.jsp Home page
About http://server:port/help-name/about/about.jsp About
Local help updater http://server:port/help-name/updater/updatewar.jsp Update help content
Remote help configuration http://server:port/help-name/remote/remotehelp.jsp Remote help configuration
Network connections http://server:port/help-name/updater/proxy.jsp Network connections
Accessing tools by forming URLs

If you cannot identify the server, port, and help name, copy a topic link and edit it to form a URL.

  1. From your product, click Help > Help Contents.
  2. In the navigation pane, right-click a topic and then click the menu item to copy the URL, such as Copy Link Location, Copy Shortcut, or Copy Link Address. The URL is in this format: http://server:port/help-name/topic/plug-in/topics/topic.html
  3. Log on to the server or the computer that hosts the help system.
  4. Paste the URL in a browser.
  5. Replace server with localhost, 127.0.0.1, or the name of your server.
  6. Verify the port number. Common port numbers:
    • WebSphere® Application Server: 63650
    • Apache Tomcat: 8080
  7. Remove the topic information from the end of the URL: /topic/plug-in/topics/topic.html
  8. Add the appropriate URL ending for any of the tools, as listed earlier in the table.
Example for identifying the Help Administration URL:
  • Before: http://server.ibm.com:63650/help/topic/com.ibm.help.common.rational.doc/topics/c_overview_rational.html
  • After: http://127.0.0.1:63650/help/updater/admin.jsp

Feedback