Work with tests and components in ALM

Relevant for: GUI tests and components and API testing


Before connecting to an ALM project, consider the following:

  • The security settings in Windows 7 may prevent you from connecting to an ALM project. This can occur when the UAC (User Account Control) option is set to ON, and you have never connected to an ALM project.

  • To connect to ALM versions earlier than 12.53 for the first time, you must disable the UAC option and restart your computer. After you successfully connect to ALM, you can turn the UAC option on again. Thereafter, you should be able to connect to ALM, as needed. For details, see UFT One program tools.

  • For details on setting up secure connections to your ALM server, see your ALM documentation.

Back to top

Connect to an ALM Project

To connect to an ALM project:

  1. In the toolbar, click the ALM Connection button . The ALM Connection dialog box opens.

  2. In the ALM Connection dialog box, enter the server name and login credentials for your users.

    Note: Ensure that the format you are using for the URL is the same as the URL you use to access ALM via your browser. For example, if you use the IP address to access the ALM server via the browser, you should use the IP address to access ALM via UFT One.

  3. Click Connect to connect to the ALM server. UFT One pauses for a few moments to connect with the ALM server.

  4. In the lower part of the ALM Connection dialog box, select the domain and project to access.

  5. Click Connect to access your ALM project.

    If you are connecting to an ALM server using external authentication, you are prompted as part of the login to select your external certificate.

  6. Select Restore connection on startup if you want UFT One to connect to the ALM server as soon as you start UFT One.

    This option is available only if you use ALM credentials and the ALM server handles the log in. If you are connecting to an ALM server using external authentication, the Restore connection on startup button is disabled, and you must initiate the ALM connection.

  7. Click Close to close the ALM Connection dialog box and begin working with your tests and components.

Back to top

Enable running tests from an ALM server using Single Sign-On (SSO)

To run UFT One tests from an ALM server that require SSO authentication you must do the following:

  1. Ensure that the credentials are imported successfully, both for the ALM server and the identity management (IDM) server.

  2. Pre-configure your ALM environment:

    ALM 14.00 SaaS: This step is mandatory.

    ALM 14.00 SaaS Patch 1 or later: This step is only required if the site parameter ENABLE_CSE_V1 exists and is not set to Y.

    Use the ALM Webgate Customization Tool to pre-configure your ALM environment. Access this tool via ALM, at:

    http(s)://<ALM server>:<ALM port>/qcbin > Tools > ALM WebGate Customization

    Where <ALM server>:<ALM port> is the address for your ALM server.

    For more details, see the ALM Webgate Customization Tool readme, provided with your ALM documentation.


    When working with an ALM server, version 14.01 or later, that requires SSO authentication, you must use ALM API Keys as credentials in the Webgate Customization Tool.

    ALM 14 SaaS: The ALM WebGate Customization Tool was known as ALM Configuration Tool.

Back to top

Enable ALM to run tests or components

In UFT One, in the in the Test Runs pane of the Options dialog box (Tools > Options > GUI Testing tab > Test Runs node), select the Allow other Micro Focus products to run tests and components option.

For security reasons, remote access to your UFT One application is not enabled by default. This option enables ALM (or other remote access clients) to open and run tests.

Back to top

Enable full access to tests from ALM

To enable full access to tests from ALM, install the UFT One Add-in for ALM from:

  • The main UFT One installation Start screen, by selecting the UFT One Add-in for ALM

  • The ALM Add-ins page by choosing Help > Add-ins Page >  ALM Connectivity in ALM

Back to top

Enable the Remote Agent

If the Windows Firewall is turned on on your computer, and you want to enable tests to be run on your computer from a remote ALM client, then you must manually create a firewall exception for the remote agent.

To enable the Remote Agent:

  1. Make sure you open the ALM or Quality Center client at least once on your computer.

  2. Run Firewall.cpl from the command line. The Windows Firewall dialog box opens.

    Note: The remaining steps in this procedure may be different in different operating systems.

  3. Click the Exceptions tab.

  4. Click the Add Program button.

  5. In the Add a Program dialog box, browse to the location where the ALM or Quality Center client is installed and select any of the following files that exist:

    • bp_exec_agent.exe

    • ComWrapperRemoteAgent.exe

    • BptRemoteAgenApplication.exe

    Note: You may have to repeat this step a few times to add all relevant files.

  6. Click OK in the Add a Program dialog box. The files you selected are added to the Programs and Services list in the Windows Firewall dialog box.

  7. Click OK to close the Windows Firewall dialog box.

Back to top

Install an external certificate for your ALM server

This is necessary when your ALM server is running in a CAC (Common Access Card) environment.

  1. Request the following from your certificate authority:

    • The certificate authority certificate in PEM format. Rename to TrustedCA.pem.

    • The web server certificate in PEM format. The full server name should appear in the certificate. Rename to WebServerPublicCert.pem.

    • The server certificate private key file in PEM format. Rename to WebServerPrivateCert.pem.

    • The software client certificate (if a Common Access Card is not used) for one user.

  2. Place the certificate files in your web server configuration directory.

    Note: If you receive certificates in different formats, you can use openssl to convert them. To install openssl, go to

    • To convert from CER, use openssl x509 -in /<webserver-directory>/conf/cert.cer -outform pem -out cert.pem.
    • To convert from PFX, do the following: 

      • Export the public key by using openssl pkcs12 -in /<webserver-directory>/conf/cert.pfx -clcerts -nokeys -out certPublic.pem.

      • Export the private key by using openssl pkcs12 -in /<webserver-directory>/conf/cert.pfx -nocerts -nodes -out certPrivate.pem.

Back to top

Create a template test

Perform this step to create a template test that has pre-defined test settings. You can then use this template test when creating new tests in ALM. For details, see Create a template GUI test.

Back to top

Set UFT One Remote Agent Preferences

To set the UFT One Remote Agent preferences:

  1. Select Start > All Programs > Micro Focus > Micro Focus UFT One > Tools > Remote Agent or <UFT One installation folder>\bin\UFTRemoteAgent.exe.

    The Remote Agent opens and the Remote Agent icon is displayed in the task bar tray.

  2. Right-click the Remote Agent icon and select Settings. The Remote Agent Settings Dialog Box dialog box opens.

  3. View or modify the settings in the dialog box. For details, see Remote Agent Settings Dialog Box.

Back to top

Disconnect from the ALM project

  1. In the toolbar, click the ALM Connection button .

  2. In the ALM Connection dialog box, in the Login to project section, click the Logout button.

  3. In the Connect to server section, click the Disconnect button.

  4. Click Close to close the ALM Connection dialog box and continue working with UFT One.

Note: When you disconnect from a project, all open documents from the project automatically close.

Back to top

See also: