Configuring DevOps Test Integrations and APIs Agent

After you install HCL DevOps Test Integrations and APIs Agent (Test Integrations and APIs Agent), you must edit or modify the attributes in the Agent.config file for the features that you want to test by using the agent. You need to configure the libraries to enable testing the SUT based on certain technologies and also set up the required proxies for enabling testing.

You can find the following information:

Review installed items

Depending on what is installed, the following directories are created and populated under the installation directory.

Directory Contents
config Configuration and template files for charts, reporting, projects, and test plans
configuration System configuration files
externalSchemaCache Search location for schema files that can be accessed frequently but may not be accessible from the client computer
jre Bundled Java™ run time environment
libs WMQ JAR files
license Licensing files
logs Agent and engine instance log files
p2 Eclipse files
plugins Test Integrations and APIs transport plugin JAR files
properties Property files of agent service names.
readme Readme file
scripts SQL scripts
tools Additional tools

Verify the storage of user files

Test Integrations and APIs Agent projects can be created in any location to which a user has access. However, using a remote or network location can reduce the performance of Test Integrations and APIs Agent significantly, so it is recommended that Test Integrations and APIs Agent is installed on a local drive.

Test Integrations and APIs Agent creates a .integrationtester directory in the user's home directory to store project and configuration information.

Subject to licensing agreements, a single shared location can be used to allow multiple Test Integrations and APIs Agent users on the same computer.

  • On the Windows™ platform, the directory is C:\Documents and Settings\User ID\.integrationtester or C:\Users\User ID\.integrationtester.
  • On Unix-like systems, the directory is ~/.integrationtester.

The following configuration details are stored:

  • Library Manager settings
  • Recently used project lists
  • Individual project details
  • Project workspace properties
  • Schema properties

Modifying the Agent.config file

When you want to use certain features along with Test Integrations and APIs Agent, you must edit and modify the attributes that are in the Agent.config file. Use the following table to identify the circumstances in which you must modify the Agent.config file:
When you want to... More information...
Configure the temporary storage location that is used by the agents Configuring the temporary storage location used by the agents
Register Test Integrations and APIs Agent with Test Virtualization Control Panel Registering DevOps Test Integrations and APIs Agent with DevOps Test Virtualization Control Panel
Register Test Integrations and APIs Agent with Test Hub Registering DevOps Test Integrations and APIs Agent with DevOps Test Hub
Configure the HTTP endpoint of Test Virtualization Control Panel Configuring the server HTTP Endpoint
Connect Test Integrations and APIs Agent to securely with Test Virtualization Control Panel when the domain level security is enabled. Configuring agents and proxies to use security tokens
Define custom attributes, or instance name for a running agent. Defining custom tags or instance name for a running agent
Use custom signed certificates to connect with Test Virtualization Control Panel in the SSL mode of authentication. Using your own truststore for server SSL connections
Configure the network ports. Network ports used by DevOps Test Integrations and APIs

Specify the ephemeral ports as an option to override the server socket when you use the RunTests command.

 Running tests by using the command line
Run Test Integrations and APIs Agent on Unix-like systems. Running DevOps Test Integrations and APIs Agent on Unix-like systems
Configure Test Integrations and APIs Agent as an IBM® Engineering Test Management adapter. Configuring DevOps Test Integrations and APIs Agent as an IBM Engineering Test Management adapter
Configure Test Integrations and APIs Agent as an IBM® Rational® Quality Manager adapter. Configuring DevOps Test Integrations and APIs Agent as Rational Quality Manager adapter

Run Test Integrations and APIs Agent on Unix-like systems

You can run the Test Integrations and APIs Agent in several ways:
  • To run the Test Integrations and APIs Agent on Unix-like systems, run the agent script in the top-level installation directory.
  • To run the agent as a service, the script can be included in the init script that runs at boot time. Contact your system or network administrator for assistance.

See Running DevOps Test Integrations and APIs Agent on Unix-like systems.