Menu

Sessions 4.1 Single Server Installation Guide for Windows

Overview

In this article, we provide step-by-step instructions to install qTest Sessions 4.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 Sessions 4.1 only works with qTest Manager 9.0 or later.
  • You need to install qTest Manager before installing qTest Sessions.

Read the following:

Install Prerequisite Packages

Install PostgreSQL

qTest Sessions 4.1 requires PostgreSQL database engine 9.5 or 9.6 (preferred) to be installed. Skip this step if you have already installed and configured PostgreSQL. Otherwise, follow this article to install Prerequisites Applications before installing qTest Sessions.

Create qTest Sessions Database

With PostgreSQL being installed and running, follow the steps below to create a database schema for qTest Sessions.
Note: replace <version> placeholder to the actual version of PostgreSQL that you have installed on your server.

  1. Access the machine that PostgreSQL is installed.
  2. Open Command Prompt, and change the current path to the PostgreSQL installation directory:
    > cd C:\Program Files\PostgreSQL\<version>\bin
  3. Create a database schema using the command below:
    ExC:\Program Files\PostgreSQL\<version>\bin>createdb -h [POSTGRES_SERVER_IP_ADDRESS] -p [POSTGRES_SERVER_PORT] -U postgres -W [DATABASE_NAME]
    Example:
    C:\Program Files\PostgreSQL\<version>\bin>createdb -h 192.168.74.77 -p 5432 -U postgres -W sessions //postgres is the username and sessions is the schema name
    Password: [POSTGRES_PASSWORD] //enter password of user postgres
    
  4. Connect to the database:
    C:\Program Files\PostgreSQL\<version>\bin>psql -h 192.168.74.77 -U postgres -W sessions
    Password for user postgres: //enter your password here
    psql (<version>)
    WARNING: Console code page (437) differs from Windows code page (1252)
             8-bit characters might not work correctly. See psql reference
             page "Notes for Windows users" for details.
    Type "help" for help.
    
  5. List out existing schema to verify if the above one has been successfully created:
    postgres=# \l
                              List of databases
     Name             |  Owner   | Encoding |          Collate           |
     Ctype            |   Access privileges
    ------------------+----------+----------+----------------------------+----------------------------+-----------------------
     postgres         | postgres | UTF8     | English_United States.1252 | English_United States.1252 |
     template0        | postgres | UTF8     | English_United States.1252 | English_United States.1252 | 
     sessions         | postgres | UTF8     | English_United States.1252 | English_United States.1252 |
    (3 rows)
    
  6. The Sessions database has been created and listed.
  7. Quit the psql program.
    postgres-# \q

Download qtestctl

Note:

  • If you are installing qTest Sessions in the same server with other qTest application, 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 Sessions on a separate server, follow steps below to download qTest Sessions.
  • To learn more about qtestctl, refer to this article qTest OnPremise - Technical detail about qtestctl
  1. Download the qtestctl package provided to you by our Implementation Team.
  2. Extract the downloaded file to a folder on disk.

Configure qTest Sessions

  1. Navigate to the extracted folder at \path\to\qtestctl\
  2. Then open qtest.config file in your favorite text editor.

Configure the Application List

  • If you are installing qTest Sessions on a separate server, make sure there is 'sessions' in apps list.
    apps = ['sessions']
  • If you are installing qTest Sessions on the same server with other qTest application(s), e.g. qTest Manager, append sessions to the app list.
    apps = ['manager', 'sessions']

Configure qTest Sessions Database

Navigate to the external section in the qtest.config file as shown below.

  • Important: Replace the blue text with your actual value. Only information listed out here needs to be updated, other information should remain unchanged.
external {
postgres {
    host = '[PostgreSQL server's IP or hostname]'
    port = [PostgreSQL server's port number]
}
auth {
user = '[PostgreSQL username]'
pass = '[PostgreSQL user password]'
}
db {
qtest = '[Database name of qTest Manager]'
session = 'sessions'
}
}

Configure SSL

If you want to deploy qTest Sessions with SSL, navigate to the section common in the qTest.config file as shown below.

  • Important: Replace the blue text with your actual value. Only information listed out here needs to be updated, other information should remain unchanged. 
    • enable: set to true to enable a secure connection (HTTPS) between the user browser and the server. 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 the qTest Sessions Application

In qtest.config file, navigate to the sessions section shown below to configure the qTest Sessions server.

  • Important: Replace blue text with actual values. Only information listed out here needs to be updated, other information should remain unchanged.
...
sessions {
port: [qTest Sessions Running Port]
...
qtest {
host = '[http or https]://[qTest Manager's IP or Hostname]:[Port]'
mastertoken='QToy'
}
storage {
// value must be in ['amazon_s3', 'disk_storage']
// * amazon_s3: stores resource files on amazon ec2
// * disk_storage: stores resource files on local disk
type = 'disk_storage'
// if storage type is set to amazon_s3, this is the access key to access to it
accesskey = ''
// if storage type is set to amazon_s3, this is the secret key to access to it
secretkey = ''
// if storage type is set to amazon_s3, this is the bucket where resource files are stored
bucketname = ''
// if storage type is set to disk_storage, this is the path to the directory where resource files are stored
// if you prefer to use \ as path separator on Windows, make sure you use \\
rootpath = '/absolute/path/to/sessions/resources'
}
...
}

Install qTest Sessions as a Windows Service

To enable qTest Sessions to automatically start when Windows starts, you need to install it as a Windows service. For more information on installing qtest service, read the qtestctl as a Service article.

Note: If you install qTest Sessions in the same machine with other qTest application(s), you only need to execute below command once and only once when you finished installing ALL the applications in this server. 

  1. Open a Command Prompt if you haven't done so, and navigate to path\to\qtestctl folder.
  2. Execute the command below in your Command Prompt to install qTest Sessions as a Windows service.
path\to\qtestctl>Install.bat

Configure qTest Manager to Connect to qTest Sessions

  1. Login to your qTest Manager using a site Administrator account.
  2. Open the Administration page.
  3. Select the System Configuration tab.
  4. In the Miscellaneous section, enter the URL for qTest Manager.
    • http://[qTest_Manager_IPAddress]:[Port] if you installed qTest Manager without an SSL certificate.
    • Or https://[qTest_Manager_IPAddress]:[Port] if you installed qTest Manager with an SSL certificate.
      qtest-server-domain.png
  5. In the qTest Explorer|Sessions section, input the URL of your qTest Sessions server.
    • http://[qTest_Sessions_IP_Address]:[HTTP_Port] if you installed qTest Sessions without an SSL certificate.
    • Or https://[qTest_Sessions_IP_Address]:[HTTP_port] if you installed qTest Sessions with an SSL certificate.
      qtest-connect-to-sessions.png
  6. Select Test Connection and wait for qTest Manager to show a message "Connected to server successfully." Save.

Access qTest Sessions

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

  1. Select the nine box 9_box.png icon in qTest Manager's top navigation, to access qTest Sessions.
  2. In qTest Sessions homepage, select the + Session button to create a new Session.
    create-new-session.png
  3. Enter Session's Title and select Save & Close.
    save-new-session.png
  4. Verify that the Session you recently saved appears in the Query Result.
    create-new-session-result.png
  5. You have successfully installed qTest Sessions on Windows.

Next Steps:

Parameters 2.1 Single Server Install Guide for Windows

Launch 1.0 Single Server Install Guide for Windows

Subscribe To Our Blog
Powered by Zendesk