Overview

In this article, we provide instructions to install qTest Scenario and Pulse for OP 9.0 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 Scenario and Pulse only work with qTest Manager 9.0 or later.

Read the following:

• Getting Started with qTest OnPremise 9.0 Spring 2018 
• Recommended Hardware Requirements

Most of the installation steps you will perform on Terminal. We highly recommend that you copy and paste the command/scripts to your Terminal and execute it.

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 to qTest Pulse database
• Install MongoDB as a Windows service

Download qTest Scenario/Pulse

Note: if you are installing qTest Scenario/Pulse 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 Scenario/Pulse on a separate server, follow the steps below to download qTest Scenario/Pulse.

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 Scenario/Pulse

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

Configure Applications

If you are installing qTest Pulse on a separate server, make sure there is 'pulse, scenario' in apps list

apps = ['pulse']

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

apps = ['manager', 'pulse', 'scenario']

Configure Database

Enter these values in the external 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: localhost: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 Scenario/Pulse 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 Pulse

In the qtest.config file, navigate to the section pulse to configure qTest Pulse.
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 Pulse will be listening
• URL: qTest Pulse URL

Below is an example of a qTest Pulse configuration. 

...
pulse {
 port = [qTest Pulse Running Port] 
   url = "[qTest Pulse URL]:${pulse.port}"
...
}

Press ESC and save the configuration with the following command:

:wq

Configure qTest Scenario

In qtest.config file, navigate to the section scenario to configure qTest Scenario.

• url: The base url/domain name of the server that Scenario server is installed and running. This can be a cloud or local instance and should point to either the reverse proxy that Scenario Server is running behind or directly to the web address of the web server that Scenario Server is installed on (a computer bound to port 80/443 depending on if your traffic is HTTP or HTTPS based). This is the url the Scenario Server Jira add-on should be configured to point to post-installation via the Configure button in the Settings > Add-ons > Manage add-ons section. The Scenario Server Jira add-on is most often configured to point to http://localhost:4000 by default. This is a placeholder value for the actual Scenario Server domain name/host address which is typically identified post-installation. You may also point the Scenario Server Jira add-on to a cloud instance of Scenario Server. Support for US West - Oregon, EU - Ireland, and additional datacenters will be available in the future. Until that time, use the US East Scenario server URL:
  • US East - N Virginia (current default) - https://scenario-v2-0.qas-labs.com
• port: The local port number that Scenario Server should bind to when launched (this would be something other than port 80 if Scenario Server is running behind a reverse proxy such an nginx. In this case, scenario.url should be configured to point to the nginx address).
• mongo: The address, credentials, etc. of the MongoDB instance that Scenario server should connect to. This should reference the mongo configuration for qTest Pulse as they connect to the same database.

Below is an example of a qTest Scenario configuration. 

...
scenario { 
  port = 6080
  url = "https://scenario-server-domain-name.com"
  mongo {
    host = pulse.mongo.host
    replSet = pulse.mongo.replSet
    auth {
      db = pulse.mongo.auth.db
      user = pulse.mongo.auth.user
      pass = pulse.mongo.auth.pass
      ssl = pulse.mongo.auth.ssl
    }
    db = pulse.mongo.db
  }
}

Press ESC and save the configuration with the following command:

:wq

Below is an example of the qTest Scenario Server Jira add-on configuration page made available via the Configure button under Settings > Add-ons > Manage add-ons.

Configure qTest Manager

In qtest.config file, navigate to section pulse to configure qTest Pulse.

• url: qTest Manager URL

Below is an example of qTest Pulse configuration. 

...
manager { 
url = "[qTest Manager URL]:${manager.port}" }
 ...
}

Start qTest Scenario/Pulse

C:\qtestctl> qtestctl.bat start

Install qTest Scenario/Pulse as a Windows Service

To enable qTest Scenario and Pulse to automatically start when Windows starts, you need to install them 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 Pulse if it is running.
   Note: if you plan to install qTest Scenario or Pulse 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

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

Configure qTest Manager to Connect to qTest Scenario

For Scenario 2.0 there is no configuration required within qTest Manager. The Scenario placeholder visible inside of qTest Manager is no longer a valid component with Scenario 2.0. To configure Scenario with your Jira application and Git repository, read here.

Configure qTest Manager to Connect to qTest Pulse

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.
     
5. In the Pulse section, enter the URL of your qTest Pulse server.
   Note: Pulse requires both the http:// and https:// ports
   • http://[qTest_Pulse_IP_Address]:[HTTP_Port] if you installed qTest Pulse without SSL certificate
   • https://[qTest_Pulse_IP_Address]:[HTTPS_Port] if you installed qTest Pulse with SSL certificate.
     NOTE: Please make sure that you have completed the SSL configuration for qTest Manager if you want to install qTest Pulse with SSL protocol.
     
6. Select Test Connection and wait for qTest Manager to show the message "Connected to server successfully." then Save.

Access qTest Pulse

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

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

Next Steps:

• Scenario Quick Start Guide
• Pulse Quick Start Guide
• Pulse Rules