Changing help content connections

You can add remote help connections to access help from other locations in your help system. You can use these controls to add, delete, test, enable, and disable connections to IBM® Knowledge Centers. You can redirect your default help to a different location or add other product documentation to your help system.

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. The window contains a list that is similar to this example:
    The image shows a list of connection names and URLs.
  3. As necessary, enable the server URLs in the table:
    • To access remote help from the IBM® Knowledge Center:
      1. Select the row of the table that contains the connection to the IBM Knowledge Center. For most products, the remote help connection is the first row. If that row does not exist, click New, enter a name and the URL of the product help in the IBM Knowledge Center, and click OK. Select the new connection in the list.
      2. To ensure that the URL is valid, click Test Connection.
      3. Click Enable. For most products, the remote help connection is enabled by default.
      4. Optional: Select other rows in the table and click Disable. If all remote connections are disabled, only help that is installed with the product on your computer is displayed. Some products install limited help or none at all.
      5. Click Apply or OK.
    • To add a connection to access help from another location, such as a customer installable IBM® Knowledge Center on your computer or on an intranet server:
      1. Click New.
      2. In the Add a new IBM Knowledge Center window, enter a name for the help and the URL in this format:
        http://my_server:9090/kc/product_code_and_version
        The default port for customer installable IBM Knowledge Center is 9090. Your port might vary. To determine the product code and version, check the URL to the product help on the public IBM Knowledge Center. For example, Rational DOORS help includes the code SSYQBZ and the version 9.6.1 in its URL.
        Example of a connection to a local help installation:
        • Name: Rational DOORS 9.6.1 help (local)
        • URL: http://localhost:9090/kc/SSYQBZ_9.6.1/
      3. To ensure that the URL is valid, click Test Connection.
      4. Optional: Select other rows in the table and click Disable.
      5. Click OK.
  4. Create a connection order for the enabled connections. If multiple connections are enabled, each one is tested in order until an active connection is found.

    For example, in a common scenario, remote help is listed first in the table and local help is listed second. If you have an Internet connection, the remote help connection is used. When you do not have an Internet connection, the local help is used.

    To change the order of the connections:

    1. Select a row in the table.
    2. Click Up or Down to move the connection in the list.
  5. Click Apply and OK to save the changes.

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