Menu

Parameters 1.1 to 2.1 Single Server Upgrade Guide for Windows

Overview

In this article, we provide step-by-step instructions to upgrade qTest Parameters from 1.1 to 2.1 on a single Windows machine. Please read the instructions thoroughly before starting your installations.

To request assistance with upgrading or obtain the self-upgrade links, complete the Upgrade Request Form and reference the OnPremise Upgrades Guide.

Note: If you are performing a fresh install, use the OnPremise New Install Form and reference the OnPremise Install Guide.

Before You Begin

  • qTest Parameters 2.1 only works with qTest Manager 9.0 or later.

Read the following:

Install and Configure MongoDB

qTest Parameters requires MongoDB 3.4 to be installed. Skip this step if you have already installed MongoDB 3.4. Otherwise, make sure you follow these instructions to:

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

Upgrade to qTest Parameters 2.1

Stop qTest Parameters

  1. Open the Command Prompt as an Administrator.
  2. Execute the command below to stop qTest Parameters.
> net stop qtest

stop-qtest-service.png

Collect Current qTest Parameters Configurations

  1. Access the qtestctl folder where qTest Parameters 1.1 is located and running.
    Example: c:\qtestctl
  2. Open the qtest.config file.
  3. Collect the information as highlighted below, in blue.
external {
mongo {
host = '[MongoDB Server's IP or hostname]:[MongoDB Server Port]'
replSet = 'rs0'
auth {
db = 'admin'
user = '[MongoDB user name]'
pass = '[MongoDB user password]'
ssl = false
}
}
...
tdm {
port: [qTest Parameters Running Port]
...
qtest {
host = '[http or https]://[qTest Manager server's IP or hostname]:[HTTP port]'
}
...
}

}

Download qtestctl

Note: 

  • If you are upgrading qTest Parameters in the same server with other qTest application(s), 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 upgrade qTest Parameters on a separate server, follow the steps below to download qTest Parameters.
  • To learn more about qtestctl, refer to this article qTest OnPremise - Technical detail about qtestctl

1. Download qtestctl at <DOWNLOAD LINK>

2. Extract the downloaded file to a folder on disk.
Example: C:\qtestctl-2.1

Configure qTest Parameters 2.1

Navigate to the extracted folder at C:\qtestctl-2.1 and edit ‘qtest.config’ file in your favorite text editor.

Configure the Application List

  • If you are upgrading qTest Parameters 2.1 on a separate server, make sure there is 'tdm' in the apps list.
apps = ['tdm']
  • If you are upgrading 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 the Database

Navigate to to external section in qtest.config file as shown below then replace blue text with the actual values you collected the current qTest Parameters configurations.

  • IMPORTANT: Replace the blue text in the brackets with your custom values. Only the information listed below in blue should be updated, all other data should remain unchanged. 
external {
mongo {
host = '[MongoDB Server's IP or hostname]:[MongoDB Server Port]'
replSet = 'rs0'
auth {
db = 'admin'
user = '[MongoDB user name]'
pass = '[MongoDB user password]'
ssl = false
}
}
}

Configure SSL

If you want to upgrade qTest Parameters with SSL, navigate to the section common in qTest.config file as shown below then replace the blue text with actual values

  • IMPORTANT: Replace the blue text in the brackets with your custom values. Only the information listed below in blue should be updated, all other data should remain unchanged. 
    • enable: set to true to enable secured connection (HTTPS) between 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 qTest Parameters Application

Navigate to section tdm as shown below to configure qTest Parameters. Replace blue text with the actual values you collected the current qTest Parameters configurations.

  • IMPORTANT: Replace the blue text in the brackets with your custom values. Only the information listed below in blue should be updated, all other data should remain unchanged. 
    • port: configure server port that qTest Parameters will be listening
    • qtest: configure qTest Manager application URL
      • host: qTest Manager URL
...
tdm {
port: [qTest Parameters Running Port]
...
qtest {
host = '[http or https]://[qTest Manager server's IP or hostname]:[HTTP port]'
}
...
}

Backup Data

  1. Open a Command Prompt if you haven't done so, navigate to the C:\qtestctl-2.1 folder and execute the command below to backup data.
    C:\qtestctl-2.1> qtestctl tdm:backup
    Note: This command might take a while to complete depending on how big the database is.
  2. Once the command is successful, the backup data is stored at:
    C:\qtestctl-2.1\tdm\build\tmp\backup.tgz

Start qTest Parameters

If this step is successful, you can proceed to Install qTest Parameters as a Windows Service.

C:\qtestctl-2.1\qtestctl> qtestctl start
<===========> 75% EXECUTING [57m 45s]
> :tdm:start
> IDLE

Troubleshooting: if step above is not successful, you need to rollback qTest Parameters to version 1.1 by following the steps below:

  1. Restore backup data by running below command from the qTest Parameter 2.1 folder.
    C:\qtestctl-2.1> qtestctl tdm:restore 
    Note: The command might take a while to complete depending on how big your data is.
  2. When restore process completed, execute below command to start qTest Parameters 1.1:
    > net start qtest
  3. Contact Customer Support to troubleshoot the issue with upgrading qTest Parameters.

Install qTest Parameters as a Windows Service

Only proceed to this step when you have successfully started qTest Parameters.

You will install qTest Parameters as a Windows service to enable it to automatically start when Windows starts.

Note: if you plan to upgrade qTest Parameters with other qTest Application(s) in the same server, you only need to execute this step once and only once when you finished all the applications in this server. Refer to this article to learn more about installing qtest service.

  1. If qtestctl is running in the Command Prompt, press `ctl + c` to stop it.
  2. Access the qTest Parameters 1.1 folder.
  3. Remove the qTest Parameters 1.1 Service with the following command:
    C:\qtestctl> Uninstall.bat
    parameters-uninstall.png
  4. Navigate to the folder C:\qtestctl-2.1 then execute below command:
    C:\qtestctl-2.1> Install.bat
  5. If the service is successfully installed, you'll see it in the Task Manager > Services tab.
    qtest-service-on-task-manager.png
  6. You have finished upgrading qTest Parameters to version 2.1, now you can access the qTest Parameters site and verify the new version.

     

 

 

Subscribe To Our Blog
Powered by Zendesk