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 help buttons, 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.

Access your local help by default

To have ALM access your local help by default, do the following:

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

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

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

  4. 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\HP\ALM\webapps\qcbin\Help\doc_library )

    Linux

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

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

  5. Restart the ALM service.

Back to top

Access online help by default

By default, ALM links directly to the online ALM Help Center.

If you are currently using your local help and you want to switch back to the online help, do the following:

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

Back to top

See also: