Registering HCL OneTest™ API Agent with HCL OneTest™ Server
When you want to run virtual service resources that are contained in projects on HCL OneTest™ Server, you can configure HCL OneTest™ API Agent to register with HCL OneTest™ Server after you install the agents.
Before you begin
- Installed HCL OneTest™ API Agent. See Installing the product software by using the stand-alone installer.
- Created projects in HCL OneTest™ Server.
- Generated your offline user token in HCL OneTest™ Server.
About this task
After the installation of HCL OneTest™ API Agent, you can change the configuration of the agent by editing the Agent.config file. For example, you must add the details of HCL OneTest™ Server such as the hostname, port, team space alias, and the offline user token under the server section so that the agent registers with HCL OneTest™ Server.
After the agent is registered with HCL OneTest™ Server, you can run the virtual service resources that are in your HCL OneTest™ Server project on the agents.
Procedure
- Stop the agent, if it is running.
-
Open the Agent.config file, which is in the
<Agent installation directory>\config directory,
in a text editor.
The configurations that pertain to HCL OneTest™ Server are contained in the <server></server> element.
-
Enter the following HCL OneTest™ Server details:
Attribute Value enabled
true
You must verify that the enabled attribute is set to true.Note: The connection to HCL OneTest™ Server is enabled as the default action when the enabled attribute is set to true.Warning: If you change the value of the enabled attribute to false, the agent cannot connect to HCL OneTest™ Server.base-url
https://<host_name>
Where <host_name> is the hostname of the HCL OneTest™ Server instance.Notes:- The base-url value must not end with a forward slash (/).
- You can specify Internationalized Domain Names (IDN) values as the hostname in the base-url value. To update the file with the IDN value, you must open the file in UTF-8 encoding format.
team-space-id
<team_space_id>
Where <team_space_id> is the ID of the team space or the URL alias.
security-token
<offline-user_token>
Where <offline-user_token> is the token created in HCL OneTest™ Server for you.
- Save and close the Agent.config file.
- Restart the agent.
Results
You modified the Agent.config file to configure the agent to register with HCL OneTest™ Server.
What to do next
You can run the virtual service resources that are in your HCL OneTest™ Server project on the agents.