This is a guide to installing the WhereScape Enablement Pack for Snowflake 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 the 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 the PowerShell gallery has been 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 for Target Database

Before you begin the following prerequisites must be met:

  • Access to a Hive (Target Environment) with the following connectivity information:
  1. Server Name
  2. Database Name
  3. User Name
  4. Password
  • Hive software installed
    • Hive ODBC driver (64-bit)
      1. Add ODBC DSN for Hive Database
  • Python 3.11 or higher
    • Select "Add Python 3.11 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.

1Setup_Enablement_Pack.ps1

Setup and configure a RED Metadata Repository for target database If RED repository exists then updates the repository with

  1. Templates
  2. Scripts
  3. Extended Properties
  4. Datatype Mappings
  5. UI Configurations
YesNew and Existing Installations
2nstall_WslPowershell_Modules.bat Installs or updates WslPowershell Modules on this machine.YesNew and Existing Installations
3import_powershell_templates.ps1 Imports or updates the PowerShell Templates to a RED Metadata Repository. Also includes any Script ImportsNo*Existing Installations
4 set_default_templates.ps1 Applies the RED Connection defaults in a RED Metadata Repository for Python or Powershell templates.No*Existing Installations
*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

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

  1. Connection: 'Database Source System' - this connection was setup as an example source connection,
    • open its 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_hv to Initialize Date Dimension for Target
  3. Connection: 'Hive' - this connection was setup as per parameters provided in script 1
    • open its properties and check extended properties tab, set it up for JDBC URL and JDBC DRIVER

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

If a valid RED installation cannot 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.

  • No labels