Setting ALM Help Center Modes

ALM Help Center provides you with comprehensive user assistance. You can access the ALM Help Center on the Web, or install it locally on your ALM server.

By default, when clicking context-sensitive help, ALM links directly to the online ALM Help Center. This enables you to use the most recent version available of the ALM online help.

If your organization has firewall restrictions that prevent you from using the online Help Center, switch to the local mode and install the Help Center locally on your ALM server.

Switch from Online to Local Mode

To use the local mode and install the Help Center locally, do the following:

  1. Stop the ALM service on your ALM server machine.

  2. Download a copy of the Help Center to your ALM server. Download now

  3. Extract alm_doc_library.zip to the following location on your ALM server:

    Windows

    <Deployment path>\webapps\qcbin\Help\doc_library

    (By default: C:\ProgramData\HPE\ALM\webapps\qcbin\Help\doc_library )

    Linux

    <Deployment path>/webapps/qcbin/Help/doc_library

    (By default: /var/opt/HPE/ALM/webapps/qcbin/Help/doc_library)

  4. Open ALM Site Administration. In the Site Configuration tab, add the USE_LOCAL_HELP parameter and set it to Y.

  5. Restart the ALM service.

Switch from Local to Online Mode

By default, ALM links directly to the online ALM Help Center. However, if you want to switch back from local mode to online mode, do the following:

  1. Open ALM Site Administration.
  1. In the Site Configuration tab, set the USE_LOCAL_HELP parameter to N.