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 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.
Creating a pipeline script from Jenkins
You must create a pipeline script to run test assets from the Jenkins Pipeline project.

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.
  - 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.
    - Generating a Jenkins project configuration file for running tests or suites
      After you create tests or test suites for your application in HCL DevOps Test Integrations and APIs (Test Integrations and APIs), you can generate a project configuration file for the tests.
    - Setting up the integration with Jenkins
      You can run HCL DevOps Test Integrations and APIs (Test Integrations and APIs) tests and view the results. You must set up the integration with Jenkins by deploying the Integration Tester Jenkins Plugin on the Jenkins primary server.
    - Configuring a Jenkins environment for viewing test results
      The Integration Tester Test Execution plugin helps to run the test suites. You can also view the test suite results. The Jenkins environment must have the Integration Tester Results plugin for Jenkins installed.
    - Configuring the Freestyle project by using the Integration Tester Jenkins Plugin
      After you install the Integration Tester Jenkins Plugin on the Jenkins server, you can configure the Jenkins Freestyle project environment to run the Integration Tester tests as a Jenkins build.
    - Configuring the Freestyle project by using the Ant script
      After you install the Integration Tester Jenkins Plugin on the Jenkins server, you can configure the Jenkins Freestyle project environment to run the Integration Tester tests as an Ant task by using the test configuration file generated by HCL DevOps Test Integrations and APIs (Test Integrations and APIs).
    - Creating a pipeline script from Jenkins
      You must create a pipeline script to run test assets from the Jenkins Pipeline project.
    - Configuring the Pipeline project to use created scripts
      You can configure a Pipeline project directly from the Jenkins UI by using pipeline scripts to run test assets from Jenkins.
    - Configuring the Pipeline project to use scripts from an SCM
      You can configure a Pipeline project to use pipeline scripts from a Source Code Management (SCM) source to run tests from Jenkins.
    - Running tests from Jenkins
      You can run test assets either from the Jenkins Freestyle or the Pipeline project on the Jenkins server to test an application under test.
    - Viewing test results in Jenkins
      After you run tests that are in a Jenkins Freestyle project or a Jenkins Pipeline project, you can view the test results within the Jenkins interface.
  - 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.

Creating a pipeline script from Jenkins

You must create a pipeline script to run test assets from the Jenkins Pipeline project.

Before you begin

You must have completed the following tasks:

Installed the Integration Tester Jenkins Plugin. See Setting up the integration with Jenkins.
Created an Agent in Jenkins.
Created a Pipeline project in Jenkins.

Procedure

Open the Jenkins Pipeline project on the Jenkins Dashboard, and then click Configure.
Select the Pipeline tab.
Click Pipeline Syntax to generate a pipeline script.
Select the step: General Build Step option from the drop-down list in the Sample Step field.
Select Run Integration Tester Tests option from the Build Step list.

The build step is displayed.

Enter values for the following fields:


Field	Value
Installation directory	Enter the path to the installation directory of Test Integrations and APIs.
Project	Enter the path to the folder containing the project and the name of the project
Environment	Enter the name of the environment that is configured in the project.
Tests	Enter the name of the test that you want to run.

If you leave the Installation directory blank, the following environment variables are queried during runtime to find the directory:

INTEGRATION_TESTER_AGENT_HOME and INTEGRATION_TESTER_HOME.

Note: In HCL DevOps Test Integrations and APIs (Test Integrations and APIs) 10.2.2 or later, the environment variables INTEGRATION_TESTER_HOME and INTEGRATION_TESTER_AGENT_HOME are automatically created at the time of installing the product software.

The job fails if the value is blank. These variables must be visible to the user or the service account that is running the Jenkins primary or secondary server. If you update either of the environment variables, you must restart the Jenkins primary or secondary server for the values to take effect.

Click Advanced to view and update the other fields that are relevant for the test.
Click Generate Pipeline Script.

The pipeline script for the build step is created.

Results

You have created the script that you can use in your Pipeline project to run the build step.

What to do next

You can configure your Pipeline project to use the scrip that you created to run tests from the Jenkins server. See Running tests from Jenkins.