This guide describes how to install and configure Worksoft SaaS wsCONNECT tunnel on your company’s infrastructure.It includes information about the following:

• Reviewing Information About This Guide
• Creating Required Directories/Folders
• Download Worksoft SaaS wsCONNECT
• Installing Worksoft SaaS wsCONNECT
• Configuring Worksoft SaaS wsCONNECT
• Verifying Operability of Worksoft SaaS wsCONNECT

1. Reviewing Information About This Guide

Tasks Described in This Guide

The procedures in this guide describe how to:

• Configure your system to support Worksoft SaaS wsCONNECT. Specifically, this involves the installation of JDK/JRE.
• Install Worksoft SaaS wsCONNECT on the local file system
• Configure wsCONNECT to connect with your company’s Worksoft SaaS domain and to all the web service deployed server(s) behind your AUTs

Results of a Successful Installation

After you successfully install Worksoft SaaS wsCONNECT:

• Test if your wsCONNECT is able to communicate with your company’s Worksoft SaaS domain

Where to Get Additional Installation Information

For more information about installing, configuring & operating Worksoft SaaS wsCONNECT, refer to one of the following:

• wsCONNECT Overview

2. Creating Required Directories/Folders

Create directory/folder with a name similar to the following, and specify the correct owner, group, and permissions for it:

• The “Worksoft SaaS” directory/folder. This directory will be referred to as $INSTALL_DIR in the rest of this guide.

3. Downloading Worksoft SaaS wsCONNECT

You can download Worksoft SaaS wsCONNECT from the Worksoft SaaS Download Center.

Once you login to your Worksoft SaaS domain, click on the “More” menu and select the “Download Center” option to go to the "Download Center".

When on the "Download Center" page, click on the "Download" button next to the "Worksoft SaaS wsCONNECT component.

4. Installing Worksoft SaaS wsCONNECT

Move/Copy the wsCONNECT zip file that is downloaded from Worksoft SaaS Download Center to the $INSTALL_DIR.

Unzip the contents of the Zip file downloaded.

You will see a folder/directory called "wsCONNECT". This directory/folder is referred to henceforth as $WSCONNECT_ROOT.

The table below lists the contents of $WSCONNECT_ROOT folder/directory.

5. Configuring Worksoft SaaS wsCONNECT

To start the Worksoft SaaS wsCONNECT component two configuration files are needed. Below section covers the two configuration files in detail.

This file contains the required properties that are needed for wsCONNECT to connect to Worksoft SaaS REST Services.

Below table represents the important properties that you must configure before starting the component.

This configuration file contains configuration information related to web services. The information which is present is the serviceURL, Username, Password, etc.

In this file, we can specify the ‘n’ number of web service configuration information as needed. As the JSON file contains key-value pairs, we can have multiple key-value pairs for each environment separated by a unique alias name.

Sample JSON content:
{
  "qaserver": {
    "serviceURL": "<Your_Webservice_URL>",
    "username": "<Your_Webservice_Name>",
    "password": "<Your_Webservice_password>",
    "authenticationType": "<Your_webservice_authenticationtype>",
    "isPasswordEncrypted": {true|false},
    }
}

In the above json content “qaserver” represents the alias name which should be mentioned at the time of scheduling a run within Worksoft SaaS application. The keys used within the JSON file are CASE-SENSITIVE.

Below table contains the description of the parameters which are needed:

6. Verifying Operability of Worksoft SaaS wsCONNECT

Worksoft SaaS wsCONNECT component has many command line options which are helpful for some additional configurations at that component level. Below table contains information about all the options.

Java (JDK or JRE) must be installed in order to run the component. The PATH environment variable has to be set before starting the component.
To check the java is installed and the PATH environment variable is set to use the below command in command prompt in case of windows or terminal in case of Linux. It should print the java version which is installed in the machine.

D:\..\Worksoft SaaS wsCONNECT>java –version

Worksoft SaaS wsCONNECT component can be started using the Start_wsCONNECT.bat for windows environment and Start_wsCONNECT.sh for Linux environment. We need to edit the startup scripts to specify the tunnel name and pass the alias name mentioned in the web service configuration file (ws.json).


Setting classpath from Command Prompt in Windows:
D:\..\wsCONNECT> SET CLASSPATH = %CLASSPATH%;wsCONNECT.jar;

Setting classpath from the terminal in Linux:
[dev@..wsCONNECT] export CLASSPATH=$CLASSPATH:wsCONNECT.jar:

After setting the classpath below command triggers the component execution common for both Windows and Linux.

D:\..\wsCONNECT> java -jar wsCONNECT.jar -name < Tunnel Name> -file <ws.json filename or filename with filepath>

Note: Path should be mentioned with either single forward-slash (/) or two backward slashes (\\)

A demon thread will create a socket on a port mentioned in config.properties file, this thread will wait for the shutdown signal to send a deregister request to the Worksoft SaaS SAAS application.

        D:\..\wsCONNECT> java com.eureqa.mtf.framework.ShutdownController -p 5656 -s s
        The above command is configured in ShutdownScripts.