Registering HCL OneTest™ API Agent with HCL® Quality Server
HCL® Quality Server runs stubs on agents. Agents can also be used to run scheduled tests. During the installation of the HCL OneTest™ API Agent, the agent is configured to register with HCL® Quality Server instances so that they are available for running stubs or running scheduled tests.
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 might need to change the URL of the HCL® Quality Server instance with which the agent is registered.
- An agent can be registered with only one HCL® Quality Server instance at any given time.
- The settings in the Agent.config file are used regardless of whether the agent is run from a command prompt or as a service.
Procedure
-
Open the Agent.config file, which is in
<Agent installation directory>\config directory
in a text editor.
The configurations that pertain to HCL® Quality Server are contained in the <rtcp></rtcp> element.
-
Configure the HCL®
Quality Server settings as follows:
The attributes and the default values in the Agent.config file that you can configure are as follows:
<rtcp enabled="true" base-url="https://<host_name>:5443/RTCP" security-token="<token>" identifier="<name>">
-
Perform the actions described in the following table to configure the SSL
settings in the <ssl></ssl> element:
The attributes and the default values in the Agent.config file that you can configure are as follows:
<ssl trustAll="true" trustStore="ssl\greenhat.jks" trustStorePassword="passphrase" trustStoreType="jks" protocol="SSL_TLSv2, TLS"/>
Note: The SSL connection details that you want to use so that the agent can connect to HCL® Quality Server securely. The ssl element is optional. If the ssl element is not included, then the agent uses the Java™ keystore location and password that is found in the system properties javax.net.ssl.trustStore and javax.net.ssl.trustStorePassword files.Attribute Value Description Action trustAll true The agent trusts all certificates presented by the server.Note: This is the default value.Retain this value if you want the agent to trust all certificates that are presented by the server. Note: When set to true, the trustStore, trustStoreType, and trustStorePassword attributes are ignored.false You must set the value to false, and then you must specify and use a different truststore if you want to use your own generated certificate. Set the value to false. trustStore <keystore> The path to the keystore that contains the trusted certificates and is used to verify the certificate that is presented by HCL® Quality Server. Note: The default value is set to the path of the ssl\greenhat.jks keystore. greenhat.jks is included with the HCL OneTest™ API Agent and contains the HCL OneTest™ API Root CA certificate.Perform any of the following actions:- No action is required from you if you set true as the value for the trustAll attribute.
- Enter the path to the keystore that contains the custom certificate and the keystore that is used to verify the certificate, if you set false as the value for the trustAll attribute.
trustStoreType <keystore_type> The type attribute specifies the type of the keystore. Note: The default value is jks.Perform any of the following actions:- No action is required from you if you set true as the value for the trustAll attribute.
- Enter the keystore type that you want to use if you set false as the value for the trustAll attribute.
trustStorePassword <password> The password attribute specifies the password that is used to load the keystore file. Note: The password for the default truststore ispassphrase
.Perform any of the following actions:- No action is required from you if you set true as the value for the trustAll attribute.
- Enter the password that loads the keystore file that you want to use if you set false as the value for the trustAll attribute.
protocol <protocol> The protocol attribute defines the SSL handshake protocol that is used to connect to the server. Note: The default value is SSL_TLSv2, TLS. The specified default options are checked for availability. SSL_TLSv2 protocol is supported by the JRE and, if it is unavailable, the TLS protocol is used.Perform any of the following actions:- No action is required from you, if you want the default values for the protocol to be used.
- Enter the protocol that you want to use.
-
Uncomment the <domains> element and enter one or
more domains and environments, if you want to restrict the agent so that it is
available only for specific domains and environments.
Notes:
- If HCL OneTest™ API
Agent was installed in the agent mode, you must restrict the agent so
that it is available only for specific domains and environments.
This restriction is because the default
Agent.config
file makes the agent available for running stubs in all domains and environments that are managed by the server. - Each environment name value must end with a forward slash
(
/
). Otherwise, the XML is rendered as invalid and the agent might not start.
- If HCL OneTest™ API
Agent was installed in the agent mode, you must restrict the agent so
that it is available only for specific domains and environments.
This restriction is because the default
-
Save and close the Agent.config file.
Note: If the agent was running when you modified the Agent.config file, you must restart the agent to apply the changes that you made.
Results
You modified the Agent.config file to configure the agent to connect to HCL® Quality Server and retained or changed the SSL settings.