Testing remote help connections

If you are having problems with your remote help content, such as missing content, test the connection to the help server.

About this task

Your product help system can retrieve the content that is installed with the product and the content that comes from the remote IBM® Knowledge Center. The IBM Knowledge Center has the most current help content. When your product is configured to retrieve content from IBM Knowledge Center, you can access the contents of the help system by clicking ? > Help Contents.

Procedure

  1. In a browser, open the Help Administration page by typing a URL that is in this format: http://server:port/help-name/updater/admin.jsp. For example, https://localhost:9443/clmhelp/updater/admin.jsp.
    Important: To access the Help Administration page, you must first start the Jazz Team Server for your product. For a local installation of the product, the startup script is located in this folder:
    • Windows: <InstallationDir>:\<ServerInstallationFolder>\IBM\JazzTeamServerBeta\server\server.startup.bat
    • Linux: /opt//IBM/JazzTeamServerBeta/server/server.startup.sh
  2. Click the Remote help configuration tab.
  3. In the list of available help connections, find the connection for your product. Ensure that the address entry is enabled. If your connection is not listed, complete these steps:
    1. Click New.
    2. In the Add a new IBM Knowledge Center window, enter a Name for the help and the URL.
      Example:
      • Name: Rational DOORS 9.6.1 help
      • URL: http://www.ibm.com/support/knowledgecenter/SSYQBZ_9.6.1/
    3. To ensure that the URL is valid, click Test Connection.
    4. Click OK to save the changes.
    5. In the table, verify that the new connection is enabled.
  4. Select the row of the connection to test.
  5. Click Test Connection.

Results

If the connection fails, verify that your connection is accessible from your computer by entering the URL in a browser. If the help system opens without issues, verify that the order of the connections in the table is correct. If the help system still does not open, troubleshoot the connection from the computer to the help system. You might have issues with the proxy settings or firewalls.

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