Configuring the help server to provide local or intranet help

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. For example, https://localhost:9443/clmhelp/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 your web browser does not display all the options that are described in this procedure, try another browser.

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. URLs to help server tools
Help server tool URL Provides
Help content http://server:port/help-name/index.jsp Help contents and the help home page.
About http://server:port/help-name/about/about.jsp Details about the help content, including:
  • The version of the help.war that is installed.
  • The plug-ins that are installed.
  • The version of Eclipse that the help.war is built on.
Remote help configuration http://server:port/help-name/remote/remotehelp.jsp Controls for adding, enabling, and disabling connections for remote and local help. See Changing help content connections.
Network connections http://server:port/help-name/updater/proxy.jsp Network connections and proxy settings.


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

video icon Video

Jazz.net channel
Software Education channel

learn icon Courses

IoT Academy
Skills Gateway

ask icon Community

Jazz.net
Jazz.net forums
Jazz.net library

support icon Support

IBM Support Community
Deployment wiki