Menu

Parameters 2.1 Single Server Installation Guide for Windows

Overview

In this article, we provide instructions to install qTest Parameters for OP 2.1 on a single Windows machine. Please read the instructions thoroughly before starting your installations.

To request assistance with installation or obtain the self-upgrade links, complete the OnPremise New Install Form.

Note: If you are not performing a fresh install and are upgrading, use the Upgrade Request Form and reference the OnPremise Upgrades Guide.

Before You Begin

  • qTest Parameters 2.1 only works with qTest Manager 9.0 or later.
  • You need to install qTest Manager before installing qTest Parameters.

Read the following:

Install and Configure MongoDB

Skip this step if you have already installed a MongoDB version between 3.2 thru 3.6. Otherwise, make sure you follow these instructions to:

  • Install MongoDB
  • Configure MongoDB
  • Create root user to access qTest Parameters database
  • Install MongoDB as a Windows service
  • Install and Configure qTest Parameters

Download qTest Parameters

Note: if you are installing qTest Parameters on the same server with other qTest applications, e.g. qTest Manager, then you do not need to re-download this installation package but use the one you downloaded when you installed qTest Manager. Otherwise, if you plan to install qTest Parameters on a separate server, follow the steps below to download qTest Parameters.

  1. Download qtestctl from the link provided by our Implementation Team.
  2. Extract the downloaded file to a folder on your disk.
    Example: C:\qtestctl

Install and Configure qTest Parameters

  1. Navigate to the extracted folder C:\qtestctl 
  2. Open the qtest.config file in your favorite text editor to configure qTest Parameters.

Configure Applications

If you are installing qTest Parameters on a separate server, make sure there is 'tdm' in the apps list.

apps = ['tdm']

If you are installing qTest Parameters on the same server with other qTest application(s), e.g. qTest Manager, append tdm to the app list.

apps = ['manager', 'tdm']

Configure Database

Enter these values in the external mongo section in qtest.config file.

  • Important: Only the information listed out here needs to be updated. Other information should remain unchanged. Replace blue text with actual values.
external {
mongo {
host = '[MongoDB Server's IP or hostname]:[MongoDB Server Port]' // example: 192.168.155.254:27017
replSet = 'rs0'
auth {
user = 'tdm' // this is the user name you created in the step Install and Configure MongoDB
pass = 'password' // this is the password you created in the step Install and Configure MongoDB
db = 'admin'
ssl = false
}
}
}

Configure SSL

To deploy qTest Parameters with SSL, navigate to the section common in qtest.config file as shown below.
Important: Only the information listed out here needs to be updated. Other information should remain unchanged. Replace blue text with actual values.

  • enable: set to true to enable a secured connection (HTTPS) between the user browser and the server. The default value is false.
  • cert: absolute path to the certificate file on this server. Please use \\ or / in the path. It is mandatory if enable is set to true.
  • key: absolute path to the private key file on this server. Please use \\ or / in the path. It is mandatory if enable is set to true.
  • pass: passphrase of your certificate. This field is optional (default value is empty).
  • strict: set this to false to allow self-signed SSL certificate.
common {
ssl {
enabled = false
cert = "${path}/server.crt"
key = "${path}/server.key"
pass = ""
strict = false
}
}

Configure qTest Parameters

In the qtest.config file, navigate to the section tdm as shown below to configure qTest Parameters.
Important: Only the information listed out here needs to be updated. Other information should remain unchanged. Replace blue text with actual values. 

  • port: configure server port that qTest Parameters will be listening
  • qtest: configure qTest Manager application
    • host: qTest Manager URL

Below is an example of a qTest Parameters configuration. 

...
tdm {
port: [qTest Parameters Running Port]
...
qtest {
host = '[http or https]://[qTest Manager server's IP or hostname]:[HTTP port]' /* use https if SSL is enabled */
}
...
}

Start qTest Parameters

C:\qtestctl> qtestctl.bat start

start-parameters.png

Install qTest Parameters as a Windows Service

To enable qTest Parameters to automatically starts when Windows starts, you need to install it as a Windows service. Refer to this article to learn more about installing qtest service.

  1. From the Command Prompt, press 'Ctrl+C' to stop qTest Parameters if it is running.
    Note: if you plan to install qTest Parameters with other qTest Application(s) in the same server, you only need to execute the command below once and only once when you have finished installing all the applications in this server.
  2. Navigate to the folder C:\qtestctl and execute the command below.

 

C:\qtestctl>Install.bat

install-parameters-service.png

You will also see the qtest service is running in the Task Manager > Services window.

qtest-service-on-task-manager.png

Configure qTest Manager to Connect to qTest Parameters

  1. Login to your qTest Manager using a Site Administrator account.
  2. Select Administration from the drop-down that appears when you hover over your username.
  3. Select the System Configurations tab.
  4. In the Miscellaneous section, enter the URL for qTest Manager.
    • http://[qTest_Manager_IPAddress]:[Port] if you installed qTest Manager without SSL certificate
    • Or https://[qTest_Manager_IPAddress]:[Port] if you installed qTest Manager with SSL certificate.

      qtest-server-domain.png

  5. In the Parameters section, enter the URL of your qTest Parameters server.
    • http://[qTest_Parameters_IP_Address]:[HTTP_Port] if you installed qTest Parameters without SSL certificate OR
    • https://[qTest_Parameters_IP_Address]:[HTTPS_Port] if you installed qTest Parameters with SSL certificate.
      NOTE: Please make sure that you have completed the SSL configuration for qTest Manager if you want to install qTest Parameters with SSL protocol.
  6. Select Test Connection and wait for qTest Manager to show the message "Connected to server successfully" then Save.

Access qTest Parameters

Follow these steps to validate that qTest Parameters was installed and configured successfully.

  1. From qTest Manager's top navigation, access qTest Parameters from the nine box 9_box.png icon.
  2. The Parameters homepage will display in a separate browser window.

parameters-homepage.png

You have successfully installed qTest Parameters on Windows.

Next Steps:

Launch 1.0 Single Server Install Guide for Windows

 

Subscribe To Our Blog
Powered by Zendesk