Welcome
Administrator Guide
This guide describes how to install HCL DevOps Test Integrations and APIs (Test Integrations and APIs). 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 DevOps Test Integrations and APIs (Test Integrations and APIs) supports integration with various other tools for quality management, software configuration management, and deployment automation tools.
DevOps Test Integrations and APIs and IBM® Rational® Quality Manager
The integration of HCL DevOps Test Integrations and APIs (Test Integrations and APIs) with IBM® Rational® Quality Manager enables the execution of Test Integrations and APIs tests and suites in Rational Quality Manager centralized test management environment.
Working with resources in Rational Quality Manager
Once the HCL DevOps Test Integrations and APIs (Test Integrations and APIs)-IBM® Rational® Quality Manager integration is complete, you can export tests and test suites from Test Integrations and APIs into Rational Quality Manager. Exported tests and test suites are created as test cases and test scripts in Rational Quality Manager.

Release Notes
This document includes information about the new features introduced, features deprecated or removed, defects fixed, and known issues identified in this version of HCL DevOps Test Integrations and APIs (Test Integrations and APIs). You can also find the installation and upgrade instructions along with the contact information of HCL Customer Support.
System requirements
This document includes information about hardware and software requirements for HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 2024.12 (11.0.4).
Getting Started
This guide provides an overview and describes the tasks to get you started with HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
Administrator Guide
This guide describes how to install HCL DevOps Test Integrations and APIs (Test Integrations and APIs). 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 DevOps Test Integrations and APIs
  You can find information about installing HCL DevOps Test Integrations and APIs (Test Integrations and APIs) from the HCL DevOps Test Workbench or HCL DevOps Test Integrations and APIs package.
- Installation of DevOps Test Virtualization Control Panel
  You can find information about installing HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) from the HCL DevOps Test Workbench (Test Workbench), HCL DevOps Test Virtualization (Test Virtualization), or HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 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 HCL DevOps Test Integrations and APIs Agent (Test Integrations and APIs Agent) is administered through My HCLSoftware (MHS). MHS is a cloud-based web application that helps to manage software entitlements and licenses.
- Configuration of DevOps Test Integrations and APIs
- Administration of DevOps Test Virtualization Control Panel
  HCL DevOps Test Virtualization Control Panel (Test Virtualization Control Panel) is a server-based web application providing a central repository for virtualized services. The Test Virtualization Control Panel allows you to use virtual services published with HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to create, share, and deploy virtualized test environments in HCL DevOps Test Virtualization (Test Virtualization).
- Integrations
  HCL DevOps Test Integrations and APIs (Test Integrations and APIs) supports integration with various other tools for quality management, software configuration management, and deployment automation tools.
  - DevOps Test Integrations and APIs 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 DevOps Test Integrations and APIs (Test Integrations and APIs) to run integration tests and test suites as part of your Maven build.
  - DevOps Test Integrations and APIs 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 DevOps Test Integrations and APIs (Test Integrations and APIs) and run those tests in Azure DevOps pipelines. You can integrate Azure DevOps with Test Integrations and APIs by using the HCL DevOps Test Workbench extension that is available in the Visual Studio Marketplace portal.
  - DevOps Test Integrations and APIs 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 DevOps Test Integrations and APIs (Test Integrations and APIs) and contribute their own assets and changes to the project so that everyone has access to the changes.
  - DevOps Test Integrations and APIs and IBM® Engineering Test Management
    When you integrate HCL DevOps Test Integrations and APIs (Test Integrations and APIs) with Engineering Test Management, you can run Test Integrations and APIs tests and suites in the centralized test management environment of Engineering Test Management.
  - DevOps Test Integrations and APIs and IBM® Rational® Quality Manager
    The integration of HCL DevOps Test Integrations and APIs (Test Integrations and APIs) with IBM® Rational® Quality Manager enables the execution of Test Integrations and APIs tests and suites in Rational Quality Manager centralized test management environment.
    - Setting up the integration with Rational Quality Manager
      You can integrate HCL DevOps Test Integrations and APIs (Test Integrations and APIs) and IBM® Rational® Quality Manager to run Test Integrations and APIs tests and suites in Rational Quality Manager centralized test management environment.
    - Working with resources in Rational Quality Manager
      Once the HCL DevOps Test Integrations and APIs (Test Integrations and APIs)-IBM® Rational® Quality Manager integration is complete, you can export tests and test suites from Test Integrations and APIs into Rational Quality Manager. Exported tests and test suites are created as test cases and test scripts in Rational Quality Manager.
      - Exporting resources from DevOps Test Integrations and APIs
        After integrating HCL DevOps Test Integrations and APIs (Test Integrations and APIs) with IBM® Rational® Quality Manager, you can export tests and test suites from Test Integrations and APIs into Rational Quality Manager. Exported tests and test suites are presented as test cases and test scripts in Rational Quality Manager.
      - Tests and test suites in IBM® Rational® Quality Manager
        After you export tests or test suites into Rational® Quality Manager and the HCL DevOps Test Integrations and APIs (Test Integrations and APIs) adapter is configured, you can remotely run Test Integrations and APIs resources.
    - Troubleshooting: Rational Quality Manager
      You can use workarounds to common problems that you might encounter when you work with Rational® Quality Manager.
  - Integration with IBM 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 DevOps Test Integrations and APIs (Test Integrations and APIs) by using a WSDL or WADL add operation and populate the Architecture School quickly and accurately. Test Integrations and APIs parses the added documents in a way that you can directly use them in your testing.
  - DevOps Test Integrations and APIs 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 DevOps Test Integrations and APIs (Test Integrations and APIs) for your application in Jenkins by using the Integration Tester Jenkins Plugin.
  - DevOps Test Virtualization and HCL DevOps Deploy
    When you use HCL DevOps Deploy (Deploy) for automating application deployments of your application, you can run virtual services (stubs) created for your application that are created in HCL DevOps Test Integrations and APIs (Test Integrations and APIs). You can run the tests from Deploy by using the or the DevOps Deploy plugin for DevOps Test Virtualization.
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
This guide describes the tasks that you can perform for tracking the quality of the application. This guide is intended for Test Managers.
Troubleshooting
While working with HCL DevOps Test Integrations and APIs (Test Integrations and APIs), you might encounter some problems that you can easily troubleshoot.
Reference Guide
This guide provides the topics to help the API tester use the product by using the user interface, commands or scripts. This guide is intended for API testers.
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.

Working with DevOps Test Integrations and APIs resources in Rational® Quality Manager

Once the HCL DevOps Test Integrations and APIs (Test Integrations and APIs)-IBM® Rational® Quality Manager integration is complete, you can export tests and test suites from Test Integrations and APIs into Rational® Quality Manager. Exported tests and test suites are created as test cases and test scripts in Rational® Quality Manager.

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 Test Integrations and APIs project that contains the test case to Test Virtualization Control Panel. 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 Test Virtualization Control Panel. 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 Test Virtualization Control Panel does not work.

Navigating Rational® Quality Manager

Test Integrations and APIs resources can be viewed in the Construction menu of the Rational® Quality Manager console, as Test Cases and Test Scripts.

Construction menu of Rational Quality Manager

Database connection

The Test Integrations and APIs Agent, once running, can be seen as an Rational® Quality Manager Adapter by selecting Adapter Console from the Execution module.

Adapter console menu