Installing help on an intranet server

An administrator can install and deploy the help content on an intranet server behind a firewall.

About this task

Team members can access help on their network without using the Internet or downloading content to their computers.
Important: Starting from the 7.0.2 release, the KCCI 1.5.1 version is no longer supported and you must use the KCCI 2.0 version for installing the help content locally on your computer or server. The KCCI 1.5.1 content is not compatible with the KCCI 2.0 version.


  1. Locate the IBM® Documentation that is installed with your product. Typically, it is a compressed file that is located in a kcci_install directory. The file includes KC_CI in the file name and a .zip extension.
    Note: For products that include a server component, the compressed file for the IBM Documentation is typically installed with the server. You can extract the compressed file on that server, or copy it to another server. For products that have a client only, the file is included in that installation. You can copy that file to a server on your intranet. To verify the location of the compressed file, see the installation instructions in your product release notes or downloadable files document from IBM Support.
  2. Extract the contents of the compressed file on your computer.
    If you receive an error that indicates that the path is too long, move the file to a directory with a shorter path. Use a directory such as C:\kcci and extract the file there.
  3. For information on starting, stopping, and configuring the IBM Documentation, see the instructions in this file: KnowledgeCenter/README.TXT.
  4. Download the compressed file that contains the product help:
    1. In a browser, go to the help download site.
    2. In the kcci_content directory, download the compressed file that corresponds to your installed product and its version.
    Note: An administrator can download the compressed file and place it on a server on your network. In this case, copy the compressed file from that server to your computer.
  5. Extract the contents of the compressed help file into the KnowledgeCenter directory, which is under the directory you used in step 2. If you are using KCCI 2.0, the compressed help file contains the following directories that must be merged with the existing directories of the same name in the KnowledgeCenter directory. Accept any prompts to overwrite or merge the contents of these directories.
    • kc_home
    • kc_normalized
    Attention: If you are using the KC 1.5.1 version, the compressed help file contains the usr directory that must be merged with the existing usr directory in KnowledgeCenter.
  6. Start the IBM Documentation by running one of these scripts from the KnowledgeCenter/bin directory:
    • Windows systems: startKC.bat
    • UNIX systems: ./bin/
    • OS X systems: sh

    If a Java™ error occurs when you start the IBM Documentation, see No JAVA_HOME defined error.

  7. After the server is started, the IBM Documentation is available in a browser at this default URL: http://<server_name>:9090/kc/<product_code_and_version>/. For example, for IBM Engineering Lifecycle Management version 7.0.3, this might be: http://<my_server>:9090/kc/SSYMRC_7.0.3/. To access this help from a product client, team members must add this URL as a new help content connection in their client Help Preferences. See Changing help content connections.

    If port 9090 is in use, the help uses another port when it is started. This port value is briefly displayed in the IBM Documentation startup window. After the window closes, the port number is recorded in this file: KnowledgeCenter/logs/

    Note: To ensure that the local IBM Documentation is available each time you use the product, you can create a shortcut to the startup script on your desktop and run it before you open the product client.