Script Based Install Guide: Synapse EP for RED10

Prerequisites For PostgreSQL Metadata

Before you begin, ensure to meet the following prerequisites:

• Create Database and ODBC DSN :
         1. Supported* version of PostgreSQL (PostgreSQL 12 or higher)
               i.   A database to house the RED Metadata Repository.
               ii.  A database for the Range Table DB (Optional)
               iii. A database to house scheduler (Optional)

Software Installations 

• WhereScape RED10 with a valid license key entered and EULA accepted.
• WhereScape Enablement Pack for target database version RED10.

Windows Powershell (64 bit) version 4 or higher

To check the Windows Powershell Version:

• Run below command in Windows Powershell: 
  

  Get-Host|Select-Object Version

• Run below command in Command Prompt:
  

  powershell $psversiontable

Run the following command using PowerShell:

• The security protocol TLS 1.0 and 1.1 used by PowerShell to communicate with PowerShell gallery has deprecated and TLS 1.2 has been made mandatory:
  

  1 [Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12
  2 Register-PSRepository -Default -Verbose
  3 Set-PSRepository -Name PSGallery -InstallationPolicy Trusted

• Progress bar placeholder info line:
  

  1 Install-Module -Name PoshProgressBar -SkipPublisherCheck -Force

Enablement Pack Setup Scripts

The Enablement Pack Install process is entirely driven by scripts. The following table outlines these scripts, their purpose and if Run as Administrator is required. 

Step-By-Step Guide

Setup and configure RED Metadata Repository

Run Powershell as Administrator:         

• Script 1 > Powershell -ExecutionPolicy Bypass -File .\Setup_Enablement_Pack.ps1 

This enablement pack will overwrite any existing Source Enablement Pack UI Configs:

To ensure existing Source Enablement Pack connections and associated Load Tables continue to browse and load, go into UI Configuration Maintenance in RED before installing this Enablement Pack and rename the affected UI Configurations.

While the updated Load Template will work with previous Source Enablement Pack's we recommend moving these previous versions of Load Tables to newly created Parser-based connections following this install. The earlier versions of the Source Enablement Pack will be deprecated following this release.  

Install or Update WhereScape Python Modules      

Run the Script as Administrator         

• Script 2 > install_WslPython_Modules.bat    

This script performs two tasks:                 

1. Installs the WhereScape WslPython modules to C:\Program Data\WhereScape\Modules\      
2. Uses PIP to download or update required Python libraries - for offline install please see the required library list for Python in the Troubleshooting section.

Install or Update WhereScape Python Templates (For Existing Installations)

Run these scripts as Administrator          

• Script 2 > install_WslPython_Modules.bat          
• Script 3 > . .\import_python_templates.ps1          
• Script 4 > . .\set_default_templates.ps1

Set Connection defaults for a Template Set (For Existing Installations)

• Script 4 > . .\set_default_templates.ps1
• Choose Python when prompted.  

Troubleshooting and Tips

Run As Administrator

Press the Windows Key on your keyboard and start typing cmd.exe, when the cmd.exe icon shows up in the search list right click it to bring up the context menu, select Run As Administrator
Now you have an admin prompt navigate to to the folder where you have unpacked your WhereScape Red Enablement Pack using the cd command:
C:\Windows\system32> cd <full path to the unpacked folder> 
Run batch (.bat) scripts from the administrator prompt by simply typing the name at the prompt and clicking enter, for example:
C:\temp\EnablementPack>install_WslPowershell_Modules.bat
Run Powershell (.ps1) scripts from the administrator prompt by typing the Powershell run script command, for example:
C:\temp\EnablementPack>Powershell -ExecutionPolicy Bypass -File .\Setup_Enablement_Pack.ps1

Windows Powershell Script Execution

On some systems, Windows Powershell script execution is disabled by default. There are several workarounds for this which can be found by searching the term "Powershell Execution Policy".
Here is the most common workaround that WhereScape suggests, which does not permanently change the execution rights:
Start a Windows CMD prompt as Administrator, change the directory to your script directory, and run the WhereScape Powershell scripts with this command:

• cmd:>Powershell -ExecutionPolicy Bypass -File .\<script_file_name.ps1>

Restarting failed scripts

Some setup scripts will track each step and output the step number when there is a failure. To restart from the failed step (or to skip the step) provide the parameter -startAtStep <step number> to the script.
Example: 
Powershell -ExecutionPolicy Bypass -File .\<script_file_name.ps1> -startAtStep 123

Python requirements for offline install

Additionally to the base Python installation being required, the WhereScape Python Template set also requires certain additional Python libraries. The install scripts use the PIP (package manager) to download these libraries, however, for offline installs, you will need to install the required libraries yourself.
Required Python libraries/add-ons:

• pywin32-ctypes
• python-tds
• pywin32
• glob2
• gzip-reader
• regex
• pyodbc

If a valid RED installation can not be found

If you have RED 10.x or higher installed but the script (Setup_Enablement_Pack.ps1) fails to find it on your system then you are most likely running the PowerShell (x86) version which does not show installed 64-bit apps by default. Please open a 64-bit version of Powershell instead and re-run the script.

AWS PrivateLink Documentation

Please refer to the link below for the configuration of AWS PrivateLink for Snowflake:
{+}https://community.snowflake.com/s/article/Setup-On-Premise-DNS-to-work-in-conjunction-with-AWS-PrivateLink+