Prerequisites

Before you begin the following prerequisites must be met:

• Create Database and ODBC DSN:
  • Supported* version of SQL Server or Azure SQL
    • A database to house the RED Metadata Repository. Note: This needs to be an Empty Database with optional permissions SELECT, INSERT, UPDATE, EXECUTE
    • A database for the Range Table DB (Optional)
  • Snowflake (ODBC driver version 2.22.2 or higher(64-bit))
    • At least one schema available to use as a RED Data Warehouse Target
    • Snowflake driver Log Level set to 0 in the Windows Registry and the Snowflake DSN Tracing set to 0

Configuring DSN using key-pair authentication:

• Generate either an encrypted version of the private key or an unencrypted version of the private key followed by public key generation. Attach the key to Snowflake account.
• Create a new DSN and enter the following details:
  • Server: <account_name>.snowflakecomputing.com
  • User: Snowflake username
  • Role/Warehouse/Database/Schema: optional defaults
  • Authenticator: snowflake_jwt
  • Private Key File Path: Path to rsa_key.p8 file
  • Private Key Password: required only if encrypted
• Click Test in the ODBC DSN setup window.
  
  

  A detailed setup document "Setup Guide_Snowflake_key-pair_authentication" is available in the Enablement Pack folder for reference.

Configuring DSN using OAUTH authentication:

• Snowflake supports the OAuth 2.0 protocol for authentication and authorization using several options. Please go through official document <https://docs.snowflake.com/en/user-guide/oauth-intro> to understand which applications are supported.
• Illustrating how to configure Snowflake as an OAuth Resource and Okta as an External OAuth authorization server.
• Create a new DSN and enter the following details:
  • Server: <your_account>.snowflakecomputing.com
  • Role/Warehouse/Database/Schema : optional defaults
  • Authenticator: oauth

Under OAuth section:

• • OAuth Client ID: <okta_client_id>
  • OAuth Client Secret: <okta_client_secret>
  • Scope: session:role:<role_name>
  • Token URL: https://<okta_domain>/oauth2/default/v1/token
  • Auth URL: https://<okta_domain>/oauth2/default/v1/authorize

Add access token in the Registry Editor following these steps:

• Press Win + R, type regedit, and press Enter.
• Navigate to:
  Computer\HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\ 
• Locate and select your DSN (Data Source Name). 
• Right-click in the right pane and select New > String Value.
• Enter the appropriate field name and value, ensuring they match the required configuration. 
  
• Click Ok.
• Now, click Test in the ODBC DSN setup window to verify the connection. 

• Python 3.11 or higher 
  • Select Add Python 3.8 to PATH from the installation Window
  • Pip Manager Install with the command: python -m pip install --upgrade pip

• Software Installations
  • WhereScape RED version 9.0.1.1 or higher with valid license key entered and EULA accepted
  • WhereScape Enablement Pack for Snowflake version 9.0.1.1 or higher
• Windows Powershell (64-bit) version 4 or higher
  • To check the Windows Powershell Version:
    • Run the below command in Windows Powershell
      

      Get-Host|Select-Object Version

• • • Run the below command in Command Prompt
      

      powershell $psversiontable

• Python 3.8 or higher
  • Select "Add Python 3.x to PATH" from installation Window
  • Pip Manager Install with command: python -m pip install --upgrade pip
• RED supports the following versions for the metadata repository: MS SQL SERVER 2012 to 2019 and Azure SQL DB 

Enablement Pack Setup Scripts

Scripts entirely drive the Enablement Pack Install process. The table below outlines these scripts, their purpose, and if Run as Administrator is required. 

Each Powershell script in the list above provides some help at the command line, this can be output by passing the -help parameter to the script. For Example > .\ Setup_Enablement_Pack.ps1 -help 

Step-By-Step Guide

Setup and configure a new RED Metadata Repository for Snowflake

Run Powershell as Administrator:
Script 1 > Powershell -ExecutionPolicy Bypass -File .\Setup_Enablement_Pack.ps1

Install or Update WhereScape Powershell Modules

Run Script As Administrator
Script 2 > install_WslPowershell_Modules.bat

Install or Update WhereScape Python Modules (Beta)

Run Script As Administrator
Script 3 > install_WslPython_Modules.bat
 There are two steps in this script:

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

Install or Update WhereScape Powershell Templates (For Existing Installations)

Run Script as Administrator
Script 2 > install_WslPowershell_Modules.bat
Script 4 > import_powershell_templates.ps1
Script 6 > set_default_templates.ps1
Note: Skip this step for new installations.

Install or Update WhereScape Python Templates (For Existing Installations)

Run Script as Administrator
Script 3 > install_WslPython_Modules.bat
Script 5 > import_python_templates.ps1
Script 6 > set_default_templates.ps1
Note: Skip this step for new installations.

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

Script 6 > set_default_templates.ps1
Choose either Powershell or Python when prompted.

Post Install Steps - Optional

If you used the script ' Setup_Enablement_Pack.ps1' then the following optional post-install steps are available

Configure Connections

There were Three connections added that will optionally require your attention:

1. Connection: 'Snowflake' - This connection was set up as per parameters provided in the installation script 1
   1. open its properties and check the extended properties tab, set it up for SNOWSQL_ACCOUNT and SNOWSQL_WAREHOUSE
2. Connection: 'Database Source System' - this connection was set up as an example source connection,
   • open it's properties and set it up for a source DB in your environment
   • or you can remove it if not required
3. Connection: 'Range Table Location' - this connection is an example target connection for your Range Table DB on SQL Server,
   • if you do not intend to use the "Ranged Loading" templates then this can be removed 
   • otherwise, open its properties and set it up to point to a suitable SQL DB target to store your control tables for Ranged Loading

Enable Script Launcher Toolbar

Several stand-alone scripts provide some features such as "Ranged Loading", these scripts have been added to the Script Launcher menu but you will need to enable the menu toolbar item to see them.
To enable the Script Launcher menu in RED, select View>Toolbars>Script Launcher

Source Enablement Pack Support

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>

Setting the Snowflake driver LogLevel setting in the Windows Registry

The default LogLevel for Snowflake driver is set too high and can produce undesired info messages on the error stream. This in turn can cause some tasks to look like failures in RED even though they were successful.
To disable the diver logging you can run the registry file provided in this Enablement Pack, or open it in a text editor to see the required changes.
Registry file: ".\Auto Execute\Disable Snowflake ODBC Driver Logging.reg"

Restarting failed scripts

Some of the 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