Installation

QVscribe for Teams Server Installation

All download information and license will be provided to you and your team prior to installation.

You will receive the following items as part of your download package:

  1. QVscribe for Teams download file

  2. PostgreSQL 10.4.-1

  3. External Properties file

  4. License Key 

  5. QVscribe Client download file(s)

Creating Folder for all QTS Artifacts

All files sent to you should be copied and save the folder on your C drive. We usually suggest C:qts.

Validating Windows

Ensure you have a validated Windows edition: Windows Server 2012 R2 or above is required.

Installing PostgreSQL

Your next step is to install PostgreSQL Version 10 or above from PostgreSQL Global Development Group:

1. You can find the download file for PostgresSQL in your google drive folder provided by QRA Corp.

2. On the Select Components page, please unclick Stack Builders.

3. Fill out the following credentials during the download:

Username: postgres Port: 5432

4. Enter your created PostgreSQL password details in the external.properties file

Please note that the external.properties file is used for externalizing QTS instance-specific information necessary for it to function in different environments. At Service start up the configuration details contained in this file are applied in the initialization of the application. The particular values configured in this file need to be provided by the user in order for QTS to work as expected. 

Contents of this file by default are:

server.port.http= 8080*

server.port=8443*

server.ssl.key-store = file:c:/qts/yours.jks*

server.ssl.key-store-password = password*

server.ssl.key-password = keypairpass*

server.ssl.key-alias=solid*

postgresEnabled = true*

postgresUrl=jdbc:postgresql://127.0.0.1:5432/postgres*

postgresUsername=postgres*

postgresPassword=password*

Please be sure to update all details within the external properties file with your specific information before starting QTS.  Failures in the service successfully starting are often due to misconfiguration in this file so it is important to take care in setting them. Changing these values and restarting the service will reapply any changes made.

Installing QVscribe for Teams Server

Your next step is to run the QVscribe for Teams installer which you can find in your google drive folder provided by QRA Corp.

1. During the setup, ensure you select the folder you created in your C drive for your logs and your external properties. C:qtslogs

2. When the installation completes, the installer will automatically open a browser window and navigate to the localhost for you.

Please note: the browser opened will be the default browser on your machine. However, it is recommended to ensure QVscribe Team Server is accessed via Google Chrome to avoid any issues.

3. Please wait for QVscribe Team Server service to launch. Wait approx. 30 seconds before refreshing the page on the browser to bring up QTS. The QTS launch time may vary depending on the machine.

4. Set the QVscribe admin username and password and use the license key sent to you to initialize the server on startup. The key will create a request file.  

Please send the request file to support@qracorp.com.  The request file is a secure key that node locks the QVscribe for Teams license to your server. 

We suggest completing the installation during a call with us so we can send over the license to you on the call, and complete the installation right away.  Once you have the license file, you can login.

Once you have set the QVscribe admin username and password and are logged into the QVscribe, you should see the below dashboard.

SSL Certificate in Teams Server

Finding the external.properties file

A custom SSL certificate can be configured through external.properties. The external.properties is input to windows service. This window service and properties file location can be found.

  1. Open the Windows menu, type in “services” and select the application.

  2. Choose QTSAuth service

  1. Right-click and select Properties, scroll to find the path of external.properties

Configuring in external.properties file 

To configure the external.properties file, please follow the below steps:

  1. Uncomment the following lines in external.properties by removing the ‘#’ in the line beginnings

    1. #server.ssl.key-store =  <file path for key store file *.jks>

    2. #server.ssl.key-store-password = <key store password>

    3. #server.ssl.key-password =  <keypairpass>

    4. #server.ssl.key-alias= <key alias>

  2.  Complete the entries. 

    1. server.ssl.key-store =  <file path for key store file *.jks> The keystore file can be a jks (java key store) or pfx file. Please ensure the file path uses forward slashes versus backslashes (usually used for Windows paths).

    2. server.ssl.key-store-password = <key store password> Enter the password to open the key store

    3. server.ssl.key-password =  <keypairpass> Enter the key alias in the store

    4. server.ssl.key-alias= <key alias> Enter the password used to protect the key-alias in the store

Example : Trying to open using keystoreexplorer

Example entries once populated : 

server.ssl.key-store =  c:/qts/bdtesting.pfx

server.ssl.key-store-password = password

server.ssl.key-password =  password

server.ssl.key-alias= ssl

3. Restart windows service to restart QTS with new external.properties

a. Open the windows menu, type in “services” and select the application.

b. choose QTSAuth service

c. Restart

4. If the client trust certificate is installed on the local computer CA, opening the QTS dashboard in browser

QTS Dashboard Logs

If you or your team are experiencing errors or unexpected behavior with the Teams Server configurations or license management, please follow the below steps to locate your Log files. These may be useful to QRA engineers to help troubleshoot and find the root cause. It is a 2 step process.

Step 1: Sign in to the QVscribe dashboard, under the Metrics, Click the setting icon and click “Download all Metric Data”. This step can be ignored if you are unable to reach the QVscribe Dashboard.

Step 2 : RDP into Windows server where the QTS is hosted, open up file-explorer, and enter

“%QTS_LOG_PATH%” 

Click Enter.

Select all files, zip and send to support@qracorp.com