Using the adapter to connect to through a proxy server

You can use the adapter to connect to the server through a proxy server. You must configure the credentials for the proxy server from the command-line interface.

Before you begin

If you are a user, ensure that you have the appropriate permissions, including execute permissions, to access the HCL OneTest™ UI adapter for . If you do not have administrator rights then use the Connector Client Access license. You can obtain this license from the administrator.

If the host name of the server is not registered with the DNS server, modify the hosts file and map the host name of the server to its IP address. Additionally, map the host name of the proxy server through which the adapter connects to the server to the proxy IP address.

About this task

If the adapter connects to the server through a proxy server, you must specify the logon credentials for the proxy server for authentication purposes. Use the command-line interface to provide the proxy server logon credentials.

Procedure

  1. At the prompt, type the following command-line arguments to run the configureadapter.bat configuration batch file:configureadapter.bat -repository https://<rqmserver>:<port>/qm -user <userid> -password <password> -adapter <adapter name> [-projectArea <projectArea>] -proxy <proxy server name> -proxyPort <proxy port number> -proxyUser <proxy server userid> -proxyPassword <proxy server password> [-configfile <configuration file>] [-interactive <true/false>]
    where:
    • <rqmserver> is the host name of the server.
    • <port> is the port where the server is running.
    • <userid> is a registered user ID in that has the license to run the adapter
    • <password> is the password for the user ID that was used.
    • <adapter name> is the name you give your adapter and by which the web UI will identify this instance of the adapter.
    • <projectArea> is the name or alias of the project to which you are logging on. If the name contains spaces, enclose the name in double quotation marks.
    • <proxy server name> is the host name of the proxy server through which the adapter connects to the server.
    • <proxy port number> is the port where the proxy server is running.
    • <proxy server userid> is the user ID that is used to authenticate the proxy server.
    • <proxy server password> is the password for the proxy server authentication user ID
    • <configuration file> is the file from which the settings for this adapter must be read. The adapter name is mandatory when you use this option.
    • [-interactive <true/false>]: If you set this value to true, the HCL OneTest™ UI Adapter dialog box opens if you have not specified values for any of the command-line arguments. You can then specify the missing value in the HCL OneTest™ UI Adapter dialog box.
    Note: If the server is renamed, complete these steps:
    1. If you have an entry for the server in the hosts file, update it with the new server name.
    2. Update the <rqmserver> argument with the new server name.
    3. Configure the adapter again to point to the new URL
  2. Start the adapter by running the startadapter.bat batch file, which is in the same location as the configureadapter.bat file. Type the following command-line arguments at the prompt: startadapter.bat -repository https://<rqmserver>:<port>/qm -user <userid> -password <password> -adapter <adapter name> -projectArea <project area> -proxy <proxy server name> -proxyPort <proxy port number> -proxyUser <proxy server userid> -proxyPassword <proxy server password> [-configfile <configuration file>]
    where:
    • <rqmserver> is the host name of the server.
    • <port> is the port where the server is running.
    • <userid> is a registered user ID in that has the license to run the adapter.
    • <password> is the password for the user ID that was used
    • <adapter name> is the name you give your adapter and by which the web UI will identify this instance of the adapter.
    • <projectArea> is the name or alias of the project to which you are logging on. If the name contains spaces, enclose the name in double quotation marks.
    • <proxy server name> is the host name of the proxy server through which the adapter connects to the server.
    • <proxy port number> is the port where the proxy server is running.
    • <proxy server userid> is the user ID that is used to authenticate the proxy server.
    • <proxy server password> is the password for the proxy server authentication user ID
    • <configuration file> is the file from which the settings for this adapter must be read. The adapter name is mandatory when you use this option.
    Note:
    • For the adapter to connect to the server through the proxy server, you must specify the proxy server name, port number and user ID.
    • If the proxy server is renamed, complete these steps:
      1. If you have an entry for the proxy server in the hosts file, update it with the new proxy server name.
      2. Update the <proxy server name> argument with the new proxy server name.