Script Based Install Guide: Azure SQL Server EP for RED10

This is a guide to installing the WhereScape Enablement Pack for Azure SQL Server for WhereScape RED.

Prerequisites For PostgreSQL Metadata

Before you begin the following prerequisites must be met:

• Create Database and ODBC DSN:
  • Supported* version of PostgreSQL (PostgreSQL 12 or higher)
    • A database to house the RED Metadata Repository.
    • A database for the Range Table DB (Optional)
    • A database to house scheduler (Optional)
• Software Installations
  • WhereScape RED10 with 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 the below command in Windows Powershell
      

      Get-Host|Select-Object Version

• • • Run the 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
      

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

• • • Progress bar placeholder info line
      

      Install-Module -Name PoshProgressBar -SkipPublisherCheck -Force

• RED supports the following versions for the metadata repository: PostgreSQL 12 or higher 

Prerequisites Target Database

Before you begin the following prerequisites must be met:

• Access to an Azure SQL Server/SQL Server (Target Environment), with the following connectivity information:
  1. Server Name
  2. Database Name
  3. User Name
  4. Password
  5. At least one schema available to use as a RED Data Warehouse Target
• Azure SQL Server software installed
  • Azure SQL Server ODBC driver (64-bit)
    1. Add ODBC DSN for Azure SQL Server Target Database
• SQL Server software installed
  • SQL Server ODBC driver (64-bit)
    1. Add ODBC DSN for  SQL Server Target Database
• Python 3.8 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

Enablement Pack Setup Scripts

The Enablement Pack Install process is entirely driven by scripts. The below table 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 RED Metadata Repository

Run Powershell as Administrator:

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

Install or Update WhereScape Python Modules

Run Script As Administrator

 Script 2 > install_WslPython_Modules.bat 

 There are two steps in this script:
                 1. Install 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 Python Templates (For Existing Installations)

Run Script as Administrator

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

Note : Skip this step for new installations.

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

Script 4 > . .\set_default_templates.ps1 

Choose 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 two connections added that will optionally require your attention:
The below two are common for SQL Server and Azure SQL

1. 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
2. Execute Update Procedure for dim_date_azsql to Initialize Date Dimension for Target
   
   

For Azure SQL Target following extended properties will require your attention:

1. Target Connection Extended Property - Blob Storage Account
2. Target Connection Extended Property - Blob Storage Access Key
3. Target Connection Extended Property - Blob Storage Container
4. Target Connection Extended Property - Blob Data Source
5. Add exact record terminators for the files from the Windows source connection, please note \r\n and \n are considered as different record terminators. NOTE: For record terminator '\n' use hexadecimal notation'0x0A' 

NOTE: For Blob extended properties refer to the below section

Configure Azure SQL Database and Blob Storage

Run the below queries in Azure SQL database query editor.
CREATE MASTER KEY ENCRYPTION BY PASSWORD = '<MASTER_KEY>';
CREATE DATABASE SCOPED CREDENTIAL <BlobStorageCredential>  WITH IDENTITY = 'SHARED ACCESS SIGNATURE', SECRET = '<SAS_TOKEN>';
DROP EXTERNAL DATA SOURCE <Blob Data Source>;
CREATE EXTERNAL DATA SOURCE <Blob Data Source>WITH (TYPE = BLOB_STORAGE,LOCATION = 'https://<Blob Storage Account>.blob.core.windows.net/<Blob Storage Container>/<Directory>',CREDENTIAL = <BlobStorageCredential> );
NOTE: Keywords mentioned in <> in blue need to be replaced with the values that can be found on Azure

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 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

Bulk load error on SQL SERVER 

Interactive load

Scheduler load

For bulk load errors, the 'bulkadmin' permission is required.
SQL SERVER > SECURITY > LOGINS > USER > PROPERTIES >SERVER ROLES

For bulk load error Operating system error code 5(Access is denied)

Failed to load data: ('42000', '\[42000\] \[Microsoft\]\[ODBC Driver 17 for SQL Server\]\[SQL Server\]Cannot bulk load because the file "C:\WhereScape\Temp\...\xxxx.csv" could not be opened. Operating system error code 5(Access is denied.). (4861) (SQLExecDirectW)')

1. Grant SQL Server access to the bulk load folder by adjusting folder permissions. Navigate to the folder, right-click, select "Properties," go to the "Security" tab, click "Edit," then "Add." In the new window, select "Advanced," click "Find Now," and locate the appropriate SQL Server user (e.g., SQLServerMSSQLUser$UserName$SQLExpress). Confirm by clicking "OK" through all opened dialogs.
2. If the first fix doesn't resolve the issue, verify if permissions are applied to subfolders as well. Navigate to the advanced settings, and check the 'Inheritance' status. If it's 'Disabled,' enable it by using the "Allow Inheritance" button.

Row Terminator For Linux

Error Message

Failed to load data: ('42000', '[42000] [Microsoft][ODBC Driver 17 for SQL Server][SQL Server]Cannot obtain the required interface ("IID_IColumnsInfo") from OLE DB provider "BULK" for linked server "(null)". (7301) (SQLExecDirectW)')

• 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.