Configuring HCL OneTest™ API Agent

After you install HCL OneTest™ API 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
drop-ins User-created plug-in files
externalSchemaCache Search location for schema files that can be accessed frequently but may not be accessible from the client computer
features Version information for installed features/plug-ins
jre Bundled Java™ run time environment
license Licensing files
p2 Eclipse files
plug-ins HCL OneTest™ API transport plug-in JAR files
properties (Used by IBM Tivoli® software.)
scripts SQL scripts
tools Additional tools

Verify the storage of user files

HCL OneTest™ API 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 HCL OneTest™ API Agent significantly, so it is recommended that HCL OneTest™ API Agent is installed on a local drive.

HCL OneTest™ API 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 HCL OneTest™ API 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 HCL OneTest™ API 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 HCL OneTest™ API Agent with HCL® Quality Server Registering HCL OneTest API Agent with HCL Quality Server
Register HCL OneTest™ API Agent with HCL OneTest™ Server Registering HCL OneTest API Agent with HCL OneTest Server
Configure the HTTP endpoint of HCL® Quality Server Configuring the server HTTP Endpoint
Connect HCL OneTest™ API Agent to securely with HCL® Quality Server 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 HCL® Quality Server in the SSL mode of authentication. Using your own truststore for server SSL connections
Configure the network ports. Network ports

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 HCL OneTest™ API Agent on Unix-like systems. Running HCL OneTest API Agent on Unix-like systems
Configure HCL OneTest™ API Agent as an IBM® Engineering Test Management adapter. Configuring HCL OneTest API Agent as an IBM Engineering Test Management adapter
Configure HCL OneTest™ API Agent as an IBM® Rational® Quality Manager adapter. Configuring HCL OneTest API Agent as Rational Quality Manager adapter

Run HCL OneTest™ API Agent on Unix-like systems

You can run the HCL OneTest™ API Agent in several ways:
  • To run the HCL OneTest™ API 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 HCL OneTest API Agent on Unix-like systems.