Home
Administrator Guide
This guide describes how to install HCL OneTest™ API. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
Integrations
HCL OneTest™ API supports integration with various other tools for quality management, change management, software configuration management, and deployment automation tools such as UrbanCode™ Deploy or HCL® Launch.
HCL OneTest™ API and HP Quality Center
The HCL OneTest™ API add-in for HP Quality Center provides a way to integrate the powerful test creation and execution functionality of HCL OneTest API with the organizational structures provided by Quality Center.
Setting up the integration with HP Quality Center
To integrate with HP Quality Center, a series of files are provided that enable the Quality Center client to locate and execute tests and suites from a HCL OneTest™ API project. All modifications that are required for the integration are performed on the Quality Center server. All clients that connect to such servers are automatically updated to enable the HCL OneTest API functionality.
Setting up HP Quality Center 11.x and 12.0 client
Setting up HP ALM server for auto deployment of files to the clients is a simple way to enable functionality for any client that is accessing the server. In some organizations, however, auto deployment is not a feasible scenario (for example, if security policies prohibit clients from having local admin privileges). In such cases, clients that require the integrated functionality can have the plug-in files deployed manually. In this way, the plug-in files can be targeted to only the clients that require them, rather than all HP Quality Center users.

Administrator Guide
This guide describes how to install HCL OneTest™ API. After you install the software, you can perform administration tasks such as configuration and integration of the product. This guide is intended for administrators.
- Installation of HCL OneTest™ API
  You can find information about installing HCL OneTest™ API from the HCL OneTest Studio or HCL OneTest API package.
- Installation of HCL® Quality Server
  You can find information about installing HCL® Quality Server from the HCL OneTest™ Studio, HCL OneTest Virtualization, or HCL OneTest API package.
- Uninstalling the product software
  When you no longer require the software, you can use either Installation Manager or the stand-alone installer to uninstall the products that you have installed.
- License management
  Licensing for your HCL software is administered through HCL® License & Delivery portal. This portal is FlexNet-based web application to manage software entitlements and licenses.
- Configuration of HCL OneTest™ API
- Administering HCL® Quality ServerHCL® Quality Server
  is a server-based web application providing a central repository for virtualized services. The HCL® Quality Server allows you to use virtual services published with HCL OneTest™ API to create, share, and deploy virtualized test environments in HCL OneTest Virtualization.
- Integrations
  HCL OneTest™ API supports integration with various other tools for quality management, change management, software configuration management, and deployment automation tools such as UrbanCode™ Deploy or HCL® Launch.
  - HCL OneTest™ API and Apache Maven
    Apache Maven is a software build tool that is based on the concept of a Project Object Model (POM). You can use the Maven plug-in that is provided for HCL OneTest™ API to run integration tests and test suites as part of your Maven build.
  - HCL OneTest™ API and Azure DevOps
    When you use Azure DevOps for continuous integration and continuous deployment of your application, you can create tests for your application in HCL OneTest™ API and run those tests in Azure DevOps pipelines. You can integrate Azure DevOps with HCL OneTest API by using the HCL OneTest Studio extension that is available in the Visual Studio Marketplace portal.
  - HCL OneTest™ API and change management tools
    HCL OneTest™ API can be integrated with the OSLC-compliant Change Management Integration Providers such as Rational® Team Concert™. It can also be integrated with Team Foundation Server Change Management Integration Providers (such as Microsoft™ Team Foundation Server), and Atlassian Jira. After integration, defects and projects can be tracked directly through Rational Team Concert.
  - HCL OneTest™ API and Git
    The Git integration feature provides a flexible test asset management method to track, back up, and collaborate on a project with multiple users. Collaborators in Git can import projects and test assets from shared repositories into HCL OneTest™ API and contribute their own assets and changes to the project so that everyone has access to the changes.
  - HCL OneTest and HCL Launch
    When you use HCL® Launch (HCL Launch) for automating application deployments of your application, you can run tests created for your application that are created in HCL OneTest™ API. You can run the tests from HCL Launch by using the HCL Launch plugin for HCL OneTest API or the HCL Launch plugin for HCL OneTest Virtualization
  - HCL OneTest™ API and HP Quality Center
    The HCL OneTest™ API add-in for HP Quality Center provides a way to integrate the powerful test creation and execution functionality of HCL OneTest API with the organizational structures provided by Quality Center.
    - Setting up the integration with HP Quality Center
      To integrate with HP Quality Center, a series of files are provided that enable the Quality Center client to locate and execute tests and suites from a HCL OneTest™ API project. All modifications that are required for the integration are performed on the Quality Center server. All clients that connect to such servers are automatically updated to enable the HCL OneTest API functionality.
      - Installation files for HP Quality Center
        To enable the integration of HCL OneTest™ API and Quality Center, it is necessary to modify the list of existing test types and deploy more files to the Quality Center server for some versions.
      - Setting up the HP Application Lifecycle Management 11.x server
        To enable the integration with HP Quality Center 11.x, you must deploy the HCL OneTest™ API additional files to the ALM 11.x Server.
      - Setting up the HP Application Lifecycle Management 12.0 server
        To enable the integration with HP Quality Center 12.0, you must deploy the HCL OneTest™ API additional files to the ALM 12.0 Server.
      - Setting up HP Quality Center 11.x and 12.0 client
        Setting up HP ALM server for auto deployment of files to the clients is a simple way to enable functionality for any client that is accessing the server. In some organizations, however, auto deployment is not a feasible scenario (for example, if security policies prohibit clients from having local admin privileges). In such cases, clients that require the integrated functionality can have the plug-in files deployed manually. In this way, the plug-in files can be targeted to only the clients that require them, rather than all HP Quality Center users.
      - Installing the Connectivity Add-In on the clients
        After deploying the HCL OneTest™ API files to HP Quality Center, you must install the Connectivity Add-in on the clients to execute HCL OneTest API tests from HP Quality Center.
      - Setting up the HP Application Lifecycle Management 12.2 and 12.5 server
        To enable the integration with HP Quality Center 12.x, you must deploy the HCL OneTest™ API additional files to the ALM 12.x Server.
      - Setting up HP Quality Center 12.2 and 12.5 client
        Setting up HP ALM server for auto deployment of files to the clients is a simple way to enable functions for any client that is accessing the server. However, in some organizations auto deployment is not a feasible scenario (for example, if security policies prohibit clients from having local admin privileges). In such cases, clients that require the integrated functions can deploy the plug-in file manually. In this way, the plug-in files can be targeted to only the clients that require them, rather than all HP Quality Center users.
      - Installing the Connectivity Tool and performing HP ALM Client Registration on 12.2 and 12.5 clients
        After you deploy the HCL OneTest™ API files to HP Quality Center, you must install the Connectivity Tool and perform the HP ALM Client Registration on the clients to create and run HCL OneTest API tests from HP Quality Center.
      - Example: Customizing the workflow in HP ALM Quality Center
        You can add workflow scripts to HP Quality Center to customize the user interface and add actions for users.
      - Normalizing the location of HCL OneTest™ API assets
        By normalizing the location of HCL OneTest™ API assets in HP Quality Center, multiple users can access the same resources locally.
    - Working with integration test artifacts in HP Quality Center
      You can create tests in HP Quality Center by using the GH-Tester test type. You can also link HCL OneTest™ API tests to HP Quality Center tests with the Quick Link tool.
  - HCL OneTest™ API and IBM® Engineering Test Management
    When you integrate HCL OneTest™ API with Engineering Test Management, you can run HCL OneTest API tests and suites in the centralized test management environment of Engineering Test Management.
  - HCL OneTest™ API and IBM® Rational® Quality Manager
    The integration of HCL OneTest™ API with IBM® Rational® Quality Manager enables the execution of HCL OneTest API tests and suites in Rational Quality Manager centralized test management environment.
  - Integration with Rational Software Architect Designer
    With IBM® Rational® Software Architect Designer, you can design an organization's services, which include technical description, technical documentation, and links to other technical documentation. As a tester, you can pull this information into HCL OneTest™ API by using a WSDL or WADL add operation and populate the Architecture School quickly and accurately. HCL OneTest API parses the added documents in a way that you can directly use them in your testing.
  - HCL OneTest™ API and Jenkins
    When you use Jenkins for the continuous integration (CI) of your application, you can run tests for testing your application. You can run tests created in HCL OneTest™ API for your application in Jenkins by using the Integration Tester Jenkins Plugin.
  - HCL OneTest and UrbanCode Deploy
    When you use UrbanCode™ Deploy (UCD) for automating application deployments of your application, you can run tests created for your application that are created in HCL OneTest™ API. You can run the tests from UCD by using the UCD plugin for HCL OneTest API or the UCD plugin for HCL OneTest Virtualization
  - HCL OneTest™ Virtualization with Engineering Test Management
    You can implement HCL OneTest™ Virtualization in Engineering Test Management integrated with HCL OneTest Virtualization by using HCL® Quality Server.
  - HCL OneTest™ Virtualization with Rational® Quality Manager
    You can implement HCL OneTest™ Virtualization in Rational® Quality Manager integrated with HCL OneTest Virtualization by using HCL® Quality Server.

Setting up HP Quality Center 11.x and 12.0 client

Setting up HP ALM server for auto deployment of files to the clients is a simple way to enable functionality for any client that is accessing the server. In some organizations, however, auto deployment is not a feasible scenario (for example, if security policies prohibit clients from having local admin privileges). In such cases, clients that require the integrated functionality can have the plug-in files deployed manually. In this way, the plug-in files can be targeted to only the clients that require them, rather than all HP Quality Center users.

About this task

To deploy the required files to a HP Quality Center client:

Procedure

Deploy the HCL OneTest™ API installation file GH-Tester.ini to the HP ALM server.
1. Extract the QualityCenterServerDist11_5.zip (for HP Quality Center 11.5 and 12.0) to a temporary location.
2. Copy the GH-Tester.ini from the GHTesterQCIntegration\CustomTestTypes to the ALM Deployment Directory\application\20qcbin.war\CustomTestTypes
Note: For detailed information, see Setting up the HP Application Lifecycle Management 11.x server. Do not copy any other files other than the GH-Tester.ini file.
Log in to the HP Quality Center using a browser and verify that you have all the required files in the client workstation.
Log out from the HP Quality Center and locate the HP ALM-Client folder.
By default, the location is C:\Users\user_name\AppData\Local\HP\ALM-Client\server_name , where the user_name is your operating system user name and the server_name is the name of the HP Quality Center server to which the client is connected to.
Extract the contents of QualityCenterServerDist11_5-client-only.zip to the ALM-Client folder.
Open the command prompt, change the directory to ALM-Client and run the script ITIntegrationSetup.cmd.
Each of the required components are registered in the client workstation. For more information, see the readme file that is provided with the QualityCenterServerDist11_5-client-only.zip

What to do next

Installing the Connectivity Add-In on the clients