This document describes the installation process for the DvSum Gateway from scratch. It covers all aspects of its installation including middleware needed, and how to deploy the Gateway/Connector on your machine.
Note: Gateway, Connector, SAWS and webservice are interchangeable terms referring to the same DvSum SAWS.
System Requirements
For machine/server on you are installing SAWS, these are the minimum requirements.
| Operating System | Windows XP, 7 - 10 or Windows Server 2008, 2012 and above. |
| Disk Space | 1 GB (free) |
| Memory | 4 GB |
| Browser | Google Chrome, Mozilla Firefox, Microsoft Edge, Apple Safari |
Network Configurations
|
If DvSum Gateway is to be installed on a server where outside access is restricted to specific URLs by Firewall, contact Gateway Server Administrator to white-list following addresses on network so the gateway can communicate to DvSum web application. |
1. https://prod.dvsum.com 3. mail-smtp.us-west-2.amazonaws.com |
|
Open port for gateway communication |
1. Port 8183 (default port where SAWS runs) |
Network Diagram
Middleware
|
Check and install Java Runtime (JRE)
|
1. On your machine, go to Start > Run > type "cmd" > "Run as Administrator" 2. Type "java -version". Upon hitting Enter, this should give Java version installed on console. 2. If Java is not installed, please download and install required version of Java. For using EXCEL sources, Java 7 is required. For any other source, Java 8 or latest version will work. For EXCEL, download and Install Java 7_u79 jdk For other sources, download and Install Java 8 Note: You may be asked to create an account (sign-in) to Oracle for downloading any version of Java. |
|
Install Microsoft Access database Engine 2010 (For EXCEL only) |
1. Go to www.microsoft.com and search "Microsoft Access database engine 2010 Redistributable" If 64 bit Java is installed on system make sure to install 64 bit Microsoft Access Database Engine 2010 For more details, How to Configure EXCEL/CSV? |
| Install Python |
1. To install python, click Python installation 7. The options pre-selected on this step are to be left as it is and click install
|
|
Install Python libraries
|
1. To install python libraries, go to command prompt (Start > Run > type "cmd" > Run as administrator) 5. Type "pip install Flask", press Enter. This will install required Python libraries on your system. For more details, read Step-by-step Installation of Python
|
|
Install Python libraries (No Internet Access from SAWS Server) |
Offline python libs installation ( if internet is not accessible from SAWS server ) |
Gateway/SAWS Installation
| Step 1 | Download SAWS from DvSum |
1. Log onto https://prod.dvsum.com This folder will be the webservice root directory. |
| Step 2 | Add SAWS to DvSum account |
1. Go to https://prod.dvsum.com 3. Click on Add button to add SAWS and enter name, host (IP where SAWS will run) and port (8183 by default) Help: For your own laptop/computer, give IP as 127.0.0.1 4. Click save to have a SAWS entered for your account. |
| Step 3 | Update configuration.properties file with api.token |
Help: "configuration.properties" file is present in webservice root directory 1. From Administration > Manage Account -> SAWS tab -> copy communication key 2. Paste this communication key in configuration.properties file in front of api.token 3. Save and close file. For more details, read Add and Install SAWS as a service |
| Step 4 | Install Dvsum connector |
1. Go to downloaded webservice root directory This will install DvSum windows service Help: Verify DvSum SAWS is running by Start > type Services > open Serviecs > Search "DvSum SAWS" in the services list. |
| Step 5 | SAWS public IP white-listing |
In order to establish communication channel between SAWS and DvSum Web App, SAWS public IP should be white-listed on Dvsum WebApp
Click Add. |
| Step 6 |
Add SAWS exception to your browser (Chrome, firefox etc) |
1. go to DvSum homepage and click on SAWS icon on top right corner.
2. Click on red Cloud icon. This will open a window asking you to add an browser exception for SAWS It will take you to the web-service page which will warn you of connection not being private. 3. Click on “Show me advanced options” ->“Proceed to <<IP>>”. This is an internal company connection and it is fully secure. For more details, Why do I need to Add exception? Now the red cloud will turn green and SAWS installation is complete.
|
|
Step 7 (Required for SAP only) |
Copy SAP DLLS to c:/windows/system32 |
1. Go to webservice root directory > click on Sap Dependencies folder > SAP JARS AND DLLS
2. make sure folder address where dll has been pasted is added to system path variable i.e If c:\windows and c:\windows\system32 is added in path leave as it is otherwise add following String in the beginning of path c:\windows;c:\windows\system32; |
SAWS logs for troubleshooting
SAWS maintains logs on the machine where its running. This is an activity log file for all actions performed by SAWS. If there is an error, its easier to troubleshoot the issue by checking logs which may highlight cause for failure.
SAWS LOGS: You can check this from webservice root directory > logs folder
For each day, a separate file is created with date appended in file name. The file named SAWS is the most latest file.
SAWS Maintenance and Advanced settings
After the basic SAWS setup, there a few more feature provided for the ease of Dvsum users. You can easily manipulate the settings from SAWS configuration file.
For details, read SAWS Advanced Settings (Configuration.properties file)
SAWS Upgrade
When a newer version of SAWS is available on DvSum, you will see the notification for upgrade. It will update SAWS in one click.
For details, read SAWS Update
Other Articles Related to SAWS
0 Comments