1. RED Enablement Packs
2. Enablement Pack - Home
3. Install Guides

RED Enablement Packs : WhereScape Enablement Pack for Azure SQL Server - RED10

Created by Nikhil Bhamere, last modified by Ruhulamin Sande on Feb 26, 2024
This is a guide to installing the WhereScape Enablement Pack for Azure SQL Server for WhereScape RED

Table of Contents

• Prerequisites For PostgreSQL Metadata
• Prerequisites Target Database
• Enablement Pack Setup Scripts
• Step-By-Step Guide
• Post Install Steps - Optional
• Source Enablement Pack Support
• Troubleshooting and Tips

---

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

[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 installation Window
  • Pip Manager Install with 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. 

• Note that on some systems executing Windows Powershell scripts is disabled by default, see troubleshooting for workarounds
  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
  Important Upgrade Notes
  If RED repository exists, it will prompt to upgrade the repository. This enablement pack will overwrite any existing Source Enablement Pack UI Configs:

  Connection UI Config	Load UI Config
  Amazon S3	Load From Amazon S3
  Azure Data Lake  Storage Gen2	Load From Azure Data Lake  Storage Gen2
  Google Cloud	Load From Google Cloud

  To ensure existing Source Enablement Pack connections and associated Load Tables continue to browse and load:
  Go into UI Configuration Maintenance in RED prior to 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.
  Important Upgrade Notes
  A change to the script exit code has been introduced. Whenever a load/update script is regenerated, it is essential to regenerate the linked action script. Similarly, regenerating the action scripts requires regenerating the associated load/update scripts to keep both scripts in sync.
  Install or Update WhereScape Python Modules
         Run Script As Administrator
  Script 2 > 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 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 :
  Below two are common for SQL Server and Azure SQL

1. Connection: 'Database Source System' - this connection was setup 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

NOTE: Please avoid regenerating the procedure update_dim_date_azsql as it is a custom procedure.
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 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 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 needs to be replaced with the values which 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 to 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
Notes: In the event you can not bypass the Powershell execution policy due to group policies you can instead try "-ExecutionPolicy RemoteSigned" which should allow unsigned local scripts.

Windows Powershell Script Execution

On some systems Windows Powershell script execution is disabled by default. There are a number of workarounds for this which can be found by searching the term "Powershell Execution Policy".
Here is the most common workaround which WhereScape suggests, which does not permanently change the execution rights:
Start a Windows CMD prompt as Administrator, change 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 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
Tip: to avoid having to provide all the parameters again you can copy the full command line with parameters from the first "INFO" message from the beginning of the console output.

Bulk load error on SQL SERVER 

Interactive load

Scheduler load

For bulk load error, 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)')
When you specify '\n' as a row terminator for bulk import in UNLOAD_RECORD_CHAR extended property or source properties, or implicitly use the default row terminator, BULK INSERT statement expects a carriage return-line feed combination (CRLF) as the row terminator. If your source file uses a line feed character only (LF) as the row terminator - as is typical in files generated on Unix and Linux computers - use hexadecimal notation to specify the LF row terminator. For example use '0x0A' in UNLOAD_RECORD_CHAR extended property or source properties for Unix and Linux machines.
Note: The hexadecimal notation is not required for Parquet file for Unix and Linux machines
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 uses 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 you system then you are most likely running 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.

Attachments:

image2021-5-12_16-41-37.png (image/png) image-2024-2-14_14-34-45.png (image/png) image-2024-2-14_14-39-19.png (image/png) image-2024-2-16_11-55-17.png (image/png) image-2024-2-16_12-2-48.png (image/png) image-2024-2-16_12-7-48.png (image/png) image-2024-2-16_12-8-50.png (image/png) image-2024-2-16_12-12-3.png (image/png) image-2024-2-20_10-53-28.png (image/png) image-2024-2-20_10-54-58.png (image/png)
Document generated by Confluence on Jun 04, 2024 23:39
Atlassian