This document describes the installation process for the DvSum Edge Gateway for DvSum Data Catalog and CADDI (DC). It covers all aspects of the installation including middleware needed and how to deploy the Gateway on a Windows machine.
For Linux, refer to DvSum Edge Gateway Installation (SAWS) for Data Catalog and CADDI on Linux.
Note: Gateway, Connector, SAWS (Stand-Alone Web Service) and webservice are used interchangeably referring to the DvSum Edge Gateway.
Installing the Gateway for DC
In order to install the on-premises gateway, we have a GUI Windows installer. First, the installer needs to be downloaded and then installation can proceed. You only need to install and execute it once and not worry about it again. Here’s how the on-premises gateway service (SAWS) can be installed:
After signing in to DvSum.ai app, go to Administration > Account Settings > Gateway tab
Step 1: Click on Download button and the on-premises gateway installer will be downloaded.
Step 2: Click on "Add" Button as shown in the image below. Provide the Web Service name, Host Name (IP address where SAWS will run) and Port (default 8183) for your SAWS and save it.
This adds a SAWS with unique communication key by which SAWS communicate with DvSum web application and your sources. Copy this unique communication key.
Step 3: Now click the installer which was downloaded in your system and start its installation.
Check the checkbox of providing API Key as plain text. Paste communication key inside the installer’s communication key field.
Click on Next button and proceed the installation. SAWS will be installed successfully on your system.
To confirm SAWS is installed and running, go to Windows > Services and search DvSum SAWS. It should be in running state.
Now the SAWS installed on your system is also configured with DvSum application. Hence, the Red Status Cloud on Gateway tab in DvSum app will turn Green.
This completes the installation and configuration of SAWS.
Note: If SAWS is configured on the server machine and the cloud in the Gateway tab still appears red, then click on the Webservice name in the gateway tab. It will open another browser tab where an exception needs to be added. Click on the "Advanced" button and then the "Proceed to" button and it will add an exception. The cloud in the gateway tab will now turn green on refresh. That means SAWS is now up and running.
Adding a Data Source when SAWS is not configured:
Another way to initiate the SAWS installation flow is through adding a data source when SAWS is not configured. If SAWS is not configured in your system and you try to add a new source, following popup will show up:
It will ask you to Download and Install the SAWS gateway like this
Click on “Download Gateway” button and two files will be downloaded, one will be the SAWS installer and other will be DvSum-api file which will contain the communication key. Also “Default Gateway” service will also be added in Gateway tab automatically (which was added manually in flow discussed earlier).
SAWS installer file and DvSum-api files are downloaded
Default Gateway which is added automatically
Now proceed with the same installation process through installer discussed above.
In this flow, whole SAWS installation process will be same except for entering the communication key, it will skip this step. The DvSum-api file contains the same communication key which is added for the Default Gateway, so installer will automatically fetch the communication key from that file during the installation process.
Note: When “Download Gateway” button is clicked, make sure that popups are enabled and are not blocked in your browser.
Once the on-premises gateway is installed, you will be able to add new data sources that connect using the gateway.
This video tutorial demonstrates installing and configuring the on-premises gateway.