Outstanding Contributor.
Outstanding Contributor.

<(ALM) Support Tip> : To Restrict Users from accessing Excel/Word add-in to upload data to QC/ALM.


By default ALM allows any valid user to access Excel/Word add-in and upload data to ALM.

In order to restrict access to specific group, below Site parameters can be used.


Parameter Names:


Possible values: User group name
Default value: N/A
Description: This parameter specifies a user group name, only the users who is in this group have permission to access the Word add-in


Possible values: User group name
Default value: N/A
Description: This parameter specifies a user group name, only the users who is in this group have permission to access the Excel add-in


Above parameters are only available from below ALM/QC versions/patches.

  • ALM 11.0  Patch 19
  • ALM 11.52 Patch 06
  • ALM 12.01 Patch 02
  • ALM 12.21 Patch 01
  • ALM 12.50 GA
When your problem has been solved, accept the solution by clicking the "Accept as Solution" button to help other members in the future!

Clicking the "Kudos star" is a great way to say thanks! 🙂
Labels (1)
Tags (1)
3 Replies
New Member.

Thanks for the details. Very helpful.

We currently have a 12.55 version and see this feature of restriting is not available anymore.

Is there an alternative option for this in 12.55?

Any ideas as to why this feature has been discontinued? How can we ensure business continuity?

Any thoughts?


Acclaimed Contributor.
Acclaimed Contributor.

The parameter is still available in ALM 12.55:



And will still be there when you upgrade to ALM 12.60 in some point in future:


But the new Excel Add-Ins are using REST API which is not checking this parameter. So for the new Add-Ins the parameter is currently not in use. There is an open enhancement request for this. 

In ALM 12.60 you can at least control the Client Types that are allowed to connect to ALM. Each tool that uses REST API can define the Client Type it is using to connect to ALM.

In this screenshot you can see that I am connected two times with user "tom". The selected line shows my connection of client type "HP ALM Excel Add-in REST Client". 

Client Connections.PNG

In ALM 12.60 you can set RESTAPI_ACCESS_APIKEY_ONLY site configuratiuon parameter and specify via RESTAPI_WHITELIST_APIKEY which client types are allowed. All others are blocked.

You can find the new site parameters in the documentation page for the ALM 12.60 site parameters:



Super Contributor.. Super Contributor..
Super Contributor..

Is there a list of all Client Types available?  

we're trying to use the Jenkins plugin, and the latest version has a field for Client Type but we cannot find a list of the values to use. we're getting a not authorized error trying to connect.

Also, noticed that the configuration RESTAPI_WHITELIST_APIKEY was added to Site Admin but the value was blank.  I was able to modify the value to N but we don't know if this is causing the not authorized error or not.

The opinions expressed above are the personal opinions of the authors, not of Micro Focus. By using this site, you accept the Terms of Use and Rules of Participation. Certain versions of content ("Material") accessible here may contain branding from Hewlett-Packard Company (now HP Inc.) and Hewlett Packard Enterprise Company. As of September 1, 2017, the Material is now offered by Micro Focus, a separately owned and operated company. Any reference to the HP and Hewlett Packard Enterprise/HPE marks is historical in nature, and the HP and Hewlett Packard Enterprise/HPE marks are the property of their respective owners.