Menu

Insights 1.15.3 Single Server Installation Guide for Windows

Overview

In this article, we provide instructions to install qTest Insights for OP 1.15.3 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

Read the following:

Download qTest Insights

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

To learn more about qtestctl, refer to this article qTest OnPremise - Technical detail about qtestctl

  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 Insights

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

Configure Applications

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

apps = ['manager', 'insights']

Install Insights HTTP

external {
postgres {
  host = '<IP address of Postgres server>'
  port = <Postgres port>
    auth {
user = ‘postgres’ 
    pass = '<password of postgres user>'
  }
    db {
    qtest = '<qTest Manager database>'
    session = '<Sessions database>'
}
}
}
...

/* application configurations */
Insights {
//Insights HTTP Port, make sure the port is not being used by other application
  httpport = <qTest Insights port>
//Insights Admin Port, make sure the port is not being used by other application
  adminport = <qTest Insights admin port>
...
scheduler {
...
//Scheduler host (same machine with Insights)
server = '<qTest Insights server>'
}
}

Install Insights HTTPS

external {
postgres {
  host = '<IP address of Postgres server>'
  port = <Postgres port>
    auth {
user = ‘postgres’ 
    pass = '<password of postgres user>'
  }
    db {
    qtest = '<qTest Manager database>'
    session = '<Sessions database>'
}
}
}
...
/* common configurations */
common {
ssl {
enabled = true
cert = "<path to certificate file>"
key = "<path to private key file>"
pass = "<passphrase of the private key>"
strict = false
}
}

/* application configurations */
Insights {
//Insights HTTP Port, make sure the port is not being used by other application
  httpport = 8081
//Insights Admin Port, make sure the port is not being used by other application
  adminport = 8007
ssl {
enabled = common.ssl.enabled
port = <qTest Insights https port>
cert = common.ssl.cert
key = common.ssl.key
pass = common.ssl.pass
}
...
scheduler {
...
//Scheduler host (same machine with Insights)
server = '<qTest Insights server>'
}
}

Start Insights

  1. From the Command Prompt (run as Administrator role), change the current path to the qtestctl directory.
  2. Execute this command to initially set up the application:
    C:\[path_to_qtestctl]>qtestctl.bat --offline start
  3. The command will take control of the Command Prompt. Keep it running.
  4. Open your web browser, and access qTest Insights using its URL.
    Example: http://<Insights_host>:<Insights_http_port>
  5. Validate it has started successfully.
    HINT: Open http://<Insights_host>:<Insights_http_port>, if you get the message "Access denied. Please login again through qTest", that means Insights has started successfully.
    accessdenied.png
  6. Go back to the Command Prompt and 'CTRL + C' to stop the running process.

Install qTest Insights as a Windows Service

To enable qTest Insights 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 Pulse 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:\[path_to_qtestctl]>Install.bat
  3. Start the Windows service.
    C:\[path_to_qtestctl]>net start qtest
  4. qTest Insights is now installed and started. 

NOTE:

  • If you want to stop the server. Open the Command Prompt and execute the following as an Administrator role:
 C:\[path_to_qtestctl]>net stop qtest
  • If you want to uninstall qTest Insights. Open the Command Prompt and execute the following as an Administrator role:
 C:\[path_to_qtestctl]>uninstall.bat 

Configure qTest Manager to Connect to qTest Insights

  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 Insights section, enter the URL for qTest Insights.
    Example: http://<IP of the machine where you installed qTest Insights>:<Insights port which you've specified in the config file>
  6. Test the connection and Save the configuration.

Access qTest Insights

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

  1. From qTest Manager's top navigation, access qTest Insights from the nine box 9_box.png icon.
  2. The Insights homepage will display in a separate browser window.
  3. You have successfully installed qTest Insights on Windows.

NOTE:

In order for the Insights Scheduler (scheduled report email) to work properly, make sure that you configure your Email Server in qTest Manager's System Configuration page.

email.png

 

 

Powered by Zendesk