Welcome
Administrator Guide
Typically, a user with the administrator role is responsible for certain tasks including installation, configuration, and integration of the product. This guide lists all such topics.
Integrating
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.
Integration with 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.
Prerequisites for Integration with Azure DevOps
Before you integrate HCL OneTest™ API with Azure DevOps by using the HCL OneTest Studio extension, you can find information about certain tasks that you must complete.

Release Notes
This document contains information about What's new, installation, known issues, known limitations, and contact information of HCL support.
API Tester Guide (New user)
Typically, a user with the API tester role is responsible for certain tasks including creating and running tests and virtual services to determine the quality of the API layer of the system. This guide lists all such topics to help the new API tester get started with the product.
Administrator Guide
Typically, a user with the administrator role is responsible for certain tasks including installation, configuration, and integration of the product. This guide lists all such topics.
- 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.
- 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.
- Configuring HCL OneTest™ API
- Administering HCL Quality Server
  HCL 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.
- Integrating
  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.
  - 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.
  - Integration with 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.
    - Task flow for integration with Azure DevOps
      You can find information about the tasks that you must perform for the integration with Azure DevOps by using the HCL OneTest Studio extension. You can then run the HCL OneTest API Task in the Azure DevOps pipeline.
    - Prerequisites for Integration with Azure DevOps
      Before you integrate HCL OneTest™ API with Azure DevOps by using the HCL OneTest Studio extension, you can find information about certain tasks that you must complete.
    - Installing the HCL OneTest Studio extension
      You must install the HCL OneTest Studio extension in your Azure DevOps organization before you can use the extension to run tests for your application in an Azure DevOps pipeline. The HCL OneTest Studio extension supports the running of tests that are created in HCL OneTest™ API.
    - Running tests in an Azure DevOps pipeline
      You must create tests in HCL OneTest™ API for the application that you are testing. You must install the HCL OneTest Studio extension in your organization and configure the HCL OneTest API Task that you want to run as a job in the Azure DevOps pipelines.
  - 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™ 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.
  - HCL OneTest™ API and 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 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™ 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.
Tester Guide
This guide describes the tasks that you can perform for testing various domains, technologies, and applications. To enable testing, you must configure and enable the environment for testing.
Test Manager Guide
Typically, a user with the Test Manager role is responsible for certain tasks that includes tracking the quality of the application. This guide lists all such topics.
Troubleshooting: HCL OneTest™ API
While working with HCL OneTest™ API, you might encounter some problems that you can easily troubleshoot.
HCL OneTest™ API reference
HCL OneTest™ API is a scripting-free environment for developing tests for service-oriented architecture (SOA) messaging and business process integration projects. Tests can be built by recording existing system behaviors or from requirements, by entering the data to send and the data that is expected in return.
Security Considerations
You can take certain actions to ensure that your installation is secure, customize your security settings, and set up user access controls.
Notices
This document provides information about copyright, trademarks, terms and conditions for product documentation.

Prerequisites for Integration with Azure DevOps

Before you integrate HCL OneTest™ API with Azure DevOps by using the HCL OneTest Studio extension, you can find information about certain tasks that you must complete.

You must have completed the following tasks:

Installed HCL OneTest™ API on a computer. See Installing Rational Test Workbench.
Set up your services for using Azure DevOps.
Set up your organization and project in Azure DevOps for running jobs in Azure DevOps pipelines. For more information, refer to Create an organization.
Created tests in HCL OneTest™ API for the application that you are testing in Azure DevOps.