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® 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.
Setting up the integration with IBM® Engineering Test Management
You can integrate HCL DevOps Test Integrations and APIs (Test Integrations and APIs) with Engineering Test Management to run Test Integrations and APIs tests and suites in the centralized test management environment of Engineering Test Management.
Configuring DevOps Test Integrations and APIs Agent as an IBM® Engineering Test Management adapter
HCL DevOps Test Integrations and APIs Agent (Test Integrations and APIs Agent) can be configured as an Engineering Test Management adapter to enable remote test runs.
Configuring the Engineering Test Management Agent as a Windows service
If you have installed only HCL DevOps Test Integrations and APIs (Test Integrations and APIs), you might want to set up Engineering Test Management Agent as a Windows service.

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.03 (11.0.1).
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 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 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.
    - Setting up the integration with IBM® Engineering Test Management
      You can integrate HCL DevOps Test Integrations and APIs (Test Integrations and APIs) with Engineering Test Management to run Test Integrations and APIs tests and suites in the centralized test management environment of Engineering Test Management.
      - Configuring IBM® Engineering Test Management integration
        You can configure one or more Engineering Test Management servers in HCL DevOps Test Integrations and APIs (Test Integrations and APIs) to be able to run integration tests and suites in the centralized test management environment of Engineering Test Management.
      - Configuring DevOps Test Integrations and APIs Agent as an IBM® Engineering Test Management adapter
        HCL DevOps Test Integrations and APIs Agent (Test Integrations and APIs Agent) can be configured as an Engineering Test Management adapter to enable remote test runs.
        Configuring the Engineering Test Management Agent as a Windows service
        If you have installed only HCL DevOps Test Integrations and APIs (Test Integrations and APIs), you might want to set up Engineering Test Management Agent as a Windows service.
    - Working with DevOps Test Integrations and APIs resources in IBM® Engineering Test Management
      After the HCL DevOps Test Integrations and APIs (Test Integrations and APIs)-Engineering Test Management integration is complete, you can export tests and test suites from Test Integrations and APIs into Engineering Test Management. Exported tests and test suites are created as test cases and test scripts in Engineering Test Management.
    - Troubleshooting: Engineering Test Management
      You can use workarounds to common problems that you might encounter when you work with Engineering Test Management.
  - DevOps Test Integrations and APIs and IBM® Engineering Test Management
    The integration of HCL DevOps Test Integrations and APIs (Test Integrations and APIs) with IBM® Engineering Test Management enables the execution of Test Integrations and APIs tests and suites in Engineering Test Management centralized test management environment.
  - 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.

Configuring the Engineering Test Management Agent as a Windows service

If you have installed only HCL DevOps Test Integrations and APIs (Test Integrations and APIs), you might want to set up Engineering Test Management Agent as a Windows service.

Before you begin

You must have configured the Agent.config file in Test Integrations and APIs as an adapter for IBM® Engineering Test Management.

Procedure

Run a command prompt as an administrator from the Test Integrations and APIs installation folder. Install the Engineering Test Management Agent as a Windows service:


prunsrv //IS//OneTestAPIRQMAgent --DisplayName="HCL
                            OneTest API RQM Agent"  --Description="HCL
                            OneTest API RQM Agent"  --Startup=auto --StartImage="C:\Program Files\HCL\DevOpsTestAPI\RQMAgent.exe" --StartPath="C:\Program Files\HCL\DevOpsTestAPI" --StartParams="-c C:\Program Files\HCL\DevOpsTestAPI\config\Agent.config"

The Java™ services are started by using the Apache Commons daemon.

Verify that the new Windows service is installed by opening the Services applet in the Control Panel by clicking Start > (All) Programs > Administrative Tools > Services.

The Windows service name is HCL OneTest API RQM Agent.
Start the service from the Service window.
Note: You can also change other properties such as the type of startup.

You can delete the service if you no longer want to run the Engineering Test Management Agent as a Windows service by performing the following action:
Run a command prompt as an administrator from the Test Integrations and APIs installation folder:
```
prunsrv //DS//OneTestAPIRQMAgent
```