Plug-in Documentation

MicroFocus ALM (formerly HP Quality Center)

Overview

The HP Quality Center plug-in automates the creation and deletion of issues in the HP Quality Center. The plug-in also contains steps to run test sets and publish test reports.

The HP Quality Center is a web-based software testing solution, which includes requirements management, automated testing, and defect tracking.

This plug-in includes these steps:

Compatibility

This plug-in requires IBM UrbanCode Deploy version 6.0.1 or later.

This plug-in runs on all operating systems that UrbanCode Deploy supports. However, it works only with HP Quality Center agents that are installed on a Windows operating system. The HP Quality Center agent uses the Internet Explorer browser. Supported versions of the Internet Explorer browser are 11.0 and 11.5.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

Troubleshooting

Troubleshooting

Review the console and log of the process that is failing for details about the problem.

Known problems

A number of issues that users have encountered with this plug-in are caused by this issue: the HP Quality Center client files are not downloaded on the same system as the UrbanCode Deploy agent. Ensure that you are logged into the HP Quality Center server that uses a supported Internet Explorer version from the system that contains the UrbanCode Deploy agent. Supported browser versions are Internet Exploxer 7 and Internet Explorer 8. Launch Internet Explorer as Administrator to avoid Windows user account control issues.

You might encounter the following error when running plug-in steps:

Microsoft VBScript runtime error: ActiveX component can't create object: 'TDApiOle80.TDConnection'

To resolve the problem, locate the OTAClient.dll file, which is typically located in the %LOCALAPPDATA%\HP\ALM-Client\HPQC_server_hostname directory. Then run the following command to register the OTAClient.dll file.

%systemroot%\SysWoW64\regsvr32\directory/OTAClient.dll

Occasionally, the Microsoft Windows Script Host stops working on the system that the Urban CodeDeploy agent is installed on, which causes unexpected behavior with the plug-in. If this happens, close the Windows Script Host dialog box on that system, and try again.

Usage

Before you begin

To use this plug-in, the HP Quality Center server 11.0 or 11.5 and agent must be installed. The HP Quality Center plug-in can be installed on any operating system that the IBM Rational Urban Code Deploy server supports. The HP Quality Center agent must be installed on a Windows operating system.

Step palette

To access this plug-in in the palette, click Quality > Suite.

Tips

To expedite process design and execution, store frequently used values for the HP Quality Center Plug-in such as these values:

  • The URL of the HP Quality Center server, which is defined in the Server URL field.
  • The user name for the HP Quality Center user, which is defined in the Username field.
  • The password for the HP Quality Center user or a script to set the password, which is defined in the Password and fields. Use only one of these fields.
  • The domain in which the HP Quality Center project is saved, which is defined in the Domain field.
  • The name of the HP Quality Center project, which is defined in the Project field.

Ensure that the HP Quality Center client files are located on the same system that the UrbanCode Deploy agent is installed on.

Register an Agent with HP ALM

The OTAClient.dll

All steps except the Run Test Sets step of the HP ALM plugin are executed using the HP ALM REST API. Therefore they do not require access to the OTAClient.dll. Due to the fact that the REST API does not offer an endpoint to run a test set, the ALM Open Test Architecture API must be utilized for the step instead. To use the OTAClient.dll, you must register the agent machine with HP ALM.

HP ALM Client Registration

To register your agent with HP ALM, you must visit the HP ALM Client Registration page from the Tools menu of your HP ALM Server. This process must be executed using an Internet Explorer 10 or 11 browser from the agent machine. This page is located at http://<hp-alm-server-name>:<port>/qcbin/CommonMode_index.html. You can also find the client registration page in the Tools menu of you HP Application Lifecycle Management home page at http://<hp-alm-server-name>:<port>/qcbin.

After visiting the HP ALM Client Registration page, you will be greeted with the following instructions on how to register your machine:

Follow the instructions, and then click Register HP ALM.

Downloading the OTAClient.dll Library

The process of HP ALM Client Registration downloads the OTAClient.dll and places it into the following path: C:\Users\<client user name>\AppData\Local\HP\ALM-Client\<server name>\OTAClient.dll. This will allow the UCD agent machine to access the OTAClient.dll, and execute the Run Test Sets step of the HP ALM plugin.

More Information

For more information on the ALM Open Test Architecture API, please visit HP ALM API References Page in the HP ALM Help Center.

Steps

Process steps in the HP Quality Center Plugin plug-in

Add Comments

Add comments to a defect in HP Quality Center.

Input properties for the Add Comments step
Name Type Description Required
Additional Comments String Any info you wish to be added to the Quality Center comment in addition to the commit
comment. Separate multiple comments with a new line.
No
Defect Ids String A comma separated list of defect ids for defects to update in HP Quality Center. Yes
Domain String The Domain in Quality Center the defect is in. Yes
Fail Mode Enumeration:

  • fast
  • slow
  • warn
What should be done when a defect to be commented on is not found in Quality Center.
Fail-fast: fail the step immediately if a defect is not found. Fail: fail the step
after attempting to comment on all defects. Warn: log a warning when a defect is not
found.
Yes
Password Password The password to authenticate with Quality Center. No
Password Script String If a property or script should be used to set the password, leave password blank and
put the property or script here.
No
Project String The Project in Quality Center the defect is in. Yes
Server URL String The base URL of the Quality Center instance. It usually ends with /qcbin. Yes
Username String The username to authenticate with Quality Center. Yes

Check Status

Ensure the status of issues are in the expected state.

Input properties for the Check Status step
Name Type Description Required
Defect Ids String A comma separated list of defect ids for defects to update in HP Quality Center. Yes
Domain String The Domain in Quality Center the defect is in. Yes
Expected Status String The status the issues are expected to have. Yes
Fail Mode Enumeration:

  • fast
  • slow
  • warn
What should be done when a defect is not in the expected state. Fail-fast: fail the
step immediately if a defect is not found. Fail: fail the step after publishing the
report of found defects. Warn: log a warning when a defect is not found.
Yes
Password Password The password to authenticate with Quality Center. No
Password Script String If a property or script should be used to set the password, leave password blank and
put the property or script here.
No
Project String The Project in Quality Center the defect is in. Yes
Server URL String The base URL of the Quality Center instance. It usually ends with /qcbin. Yes
Username String The username to authenticate with Quality Center. Yes

Create Issue

Create a new defect in HP Quality Center.

Input properties for the Create Issue step
Name Type Description Required
Additional Fields String Additional defect fields to be added. Enter one per line, as name=value pairs. This
uses Javas java.util.Properties format.
No
Assignee String The assignee for the new defect. Yes
Detected By String Who detected the defect. Yes
Detected In Version String The version in which the defect was detected. Yes
Detected On Date String The date the defect was detected. Format is MM-DD-YYYY. Yes
Domain String The Domain in Quality Center the defect is in. Yes
Password Password The password to authenticate with Quality Center. No
Password Script String If a property or script should be used to set the password, leave password blank and
put the property or script here.
No
Priority String The priority of the new defect. Default values are ( 1-Low, 2-Medium, 3-High, 4-Very
High, 5-Urgent )
No
Project String The Project in Quality Center the defect is in. Yes
Project Key String The Project Key in Quality Center. No
Reproducible String Whether or not the defect is reproducible (Y/N). Yes
Server URL String The base URL of the Quality Center instance. It usually ends with /qcbin. Yes
Severity String The severity of the new defect. Default values are ( 1-Low, 2-Medium, 3-High, 4-Very
High, 5-Urgent )
Yes
Status String The status of the new defect. Default values are ( Closed, Fixed, New, Open, Rejected,
Reopen )
No
Subject String The Subject of the defect. Yes
Summary String A summary for the new defect. Default max length is 255. Yes
Username String The username to authenticate with Quality Center. Yes

Query Defects

Query and return

Input properties for the Query Defects step
Name Type Description Required
Domain String The Domain in Quality Center the defect is in. Yes
Match Criteria String The criteria names you want to filter by, newline separated. Ex: Created in Application
= XXXXX
No
Password Password The password to authenticate with Quality Center. No
Password Script String If a property or script should be used to set the password, leave password blank and
put the property or script here.
No
Project String The Project in Quality Center the defect is in. Yes
Return Fields String The fields you want to be presented in the return records, newline separated. No
Server URL String The base URL of the Quality Center instance. It usually ends with /qcbin. Yes
Username String The username to authenticate with Quality Center. Yes

Run Test Set

Run a Test Set using HP Quality Center. This step is only functional on a Windows
system capable of executing Visual Basic scripts. If a test doesnt have a Planned
Host
in the HP ALM Test Lab, you must provide a Remote Host or check the Run Locally option
to run the tests on your local HP ALM server.

Input properties for the Run Test Set step
Name Type Description Required
Domain String The Domain in Quality Center the defect is in. Yes
Folder String The folder in Quality Center the test set resides in. This usually starts with Root. Yes
Password Password The password to authenticate with Quality Center. No
Password Script String If a property or script should be used to set the password, leave password blank and
put the property or script here.
No
Project String The Project in Quality Center the defect is in. Yes
Recursive Search Boolean Check to search through all subfolders and run all test-sets in each directory. Only
applicable when not running a specific test set.
No
Remote Host String The host to run the tests on if not running locally. Leave blank to use the configuration
within HP Quality Center.
No
Run Locally Boolean Check to run the test set only on the local instance of HP Quality Center that the
agent has access to.
No
Server URL String The base URL of the Quality Center instance. It usually ends with /qcbin. Yes
Skip Output Boolean Check to skip over any output from Quality Center. No test results will be returned
to uDeploy.
No
Test Set String The test set to run. If not specified, all test-sets in the folder will be run. No
Timeout String Test run timeout, in minutes. Yes
Username String The username to authenticate with Quality Center. Yes

Update Issues

Update one or more defects in HP Quality Center.

Input properties for the Update Issues step
Name Type Description Required
Additional Fields String Any other additional defect fields to update. These should be one per line, as name=value
pairs. Adheres specifically to the java.util.Properties format.
No
Assignee String The new assignee for the defect or blank to not change. No
Comment String Optionally add a comment with this update. No
Defect Ids String Comma separated list of defect ids to update. Yes
Domain String The Domain in Quality Center the defect is in. Yes
Fail Mode Enumeration:

  • fast
  • slow
  • warn
What should be done when a defect to be updated is not found in Quality Center. Fail-fast:
fail the step immediately if a defect is not found. Fail: fail the step after attempting
to update all defects. Warn: log a warning when a defect is not found.
Yes
Password Password The password to authenticate with Quality Center. No
Password Script String If a property or script should be used to set the password, leave password blank and
put the property or script here.
No
Priority String The new priority of the defect or blank to not change. Default values are ( 1-Low,
2-Medium, 3-High, 4-Very High, 5-Urgent )
No
Project String The Project in Quality Center the defect is in. Yes
Server URL String The base URL of the Quality Center instance. It usually ends with /qcbin. Yes
Severity String The new severity of the defect or blank to not change. Default values are ( 1-Low,
2-Medium, 3-High, 4-Very High, 5-Urgent )
No
Status String The new status of the defect or blank to not change. Default values are ( Closed,
Fixed, New, Open, Rejected, Reopen )
No
Summary String A new summary for the defect or blank to not change. Default max length is 255. No
Username String The username to authenticate with Quality Center. Yes