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.
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.

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.
    - 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.
      - Generating VAPI-XP scripts with HP Quality Center
        You can generate a VAPI-XP script from HCL OneTest™ API by using the Integration Tester Test Execution plug-in. You can use the generated script to create tests when you want to run VAPI-XP tests in the HP Quality Center.
      - Creating the GH-Tester test type
        You must create the GH-Tester test type in HP Quality Center so that you can run HCL OneTest™ API tests and test suites in HP Quality Center. After you create the GH-Tester test type, you can also apply filters to the Test Lab module to view a reduced number of items.
      - Creating tests in HP Quality Center
        You can create tests in HP Quality Center that are based on test artifacts (tests and suites) in HCL OneTest™ API.
      - Creating test sets in HP Quality Center
        After you create tests from HCL OneTest™ API test artifacts, you create test sets in HP Quality Center and add your tests to the test sets. Test sets are groups of tests, and they are similar to test suites in HCL OneTest API.
      - Defining test environments
        After you create tests and test sets in HP Quality Center that are based on HCL OneTest™ API test artifacts, you define the environments for test execution.
      - Running tests
        After you add HCL OneTest™ API tests to a test set and set the test environment options, you are ready to run your tests.
      - Running tests and test sets on remote hosts or host groups
        You can run test instances in a test set on remote hosts.
      - Test execution results
        Results for HCL OneTest™ API test suites that are executed from HP Quality Center are displayed in the Results Gallery perspective of HCL OneTest API. However, results for HCL OneTest API tests that are executed from HP Quality Center are only displayed in the Results Gallery perspective of HCL OneTest API if the project is configured to use a test cycle.
      - Linking HCL OneTest™ API tests to HP Quality Center tests
        Linking HCL OneTest™ API tests to HP Quality Center tests are simple and easy to do. With the HCL OneTest API Quick Link tool, you can effectively "import" multiple tests from HCL OneTest API into HP Quality Center at once rather than having to link them one at a time. This tool is a significant time-saver.
  - 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.

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.

Before you can use the links in the test output in Rational® Quality Manager, you must publish the details of your results database connection from the HCL OneTest™ API project that contains the test case to HCL® Quality Server. Do this task by clicking Publish results database connection in the Project Settings dialog. For more information, see Project settings. Publishing the results database connection is mandatory for every project on the following occasions:

After you configure the results database, but before you attempt to view results in HCL® Quality Server. For more information about configuring the results database, see Configuring the project results database.
After updating the results database settings.

If you do not publish the details, the link (in the test output displayed in Rational® Quality Manager) to the Results Gallery in HCL® Quality Server does not work.

Navigating HP Quality Center

You create tests in the Test Plan module, and then create test sets and add tests to them in the Test Lab module. Test sets are collections of tests, similar to test suites in HCL OneTest™ API. You also run tests and view the execution results in the Test Lab module.

Note: When the automatic deployment option in Quality Center is enabled, clients that are accessing the server must have local administrator privileges to download and install plug-in files. If the client browser fails to load these files or hangs, verify that the current user account has the appropriate privileges.