Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This is a guide to installing the WhereScape Enablement Pack for Microsoft Fabric in WhereScape RED10

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
        No Format
        Get-Host|Select-Object Version
      • Run the below command in the Command Prompt
        No Format
        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
        No Format
        [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
        No Format
        Install-Module -Name PoshProgressBar -SkipPublisherCheck -Force
  • RED supports the following versions for the metadata repository: PostgreSQL 12 or higher

Prerequisites For Microsoft Fabric

Before you begin the following prerequisites must be met:

  • For Windows
  • For Linux
    • Install latest Azure CLI package using command: 
      No Format
      curl -sL https://aka.ms/InstallAzureCLIDeb | bash
  1. Open the command prompt:
    No Format
    az login
    • Login using an Azure account having a Microsoft Fabric subscription.
  2. Create a Database and ODBC DSN:
    • Microsoft Fabric
      • At least one schema available to use as a RED Data Warehouse Target.
  3. Python 3.8 or higher
    • Select "Add Python 3.8 to PATH" from installation Window.
    • Pip Manager Install with command : 
      No Format
      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 

 Yes

New and Existing installations
2install_WslPython_Modules.batInstalls or updates WslPython Modules and required Python libraries on this machine.

Yes

New and Existing installations
3import_python_templates.ps1Imports or updates the Python Templates  to a RED Metadata Repository. Also includes any Script Imports

No*

Existing installations
4set_default_templates.ps1Applies 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

Step-By-Step Guide

Setup and configure RED Metadata Repository

Run Powershell as Administrator:

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

Important Upgrades Notes

If RED repository exists, it will prompt to upgrade the repository.

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:

Connection UI ConfigLoad UI Config
Amazon S3Load From Amazon S3

Azure Data Lake  Storage Gen2

Load From Azure Data Lake  Storage Gen2

Google Cloud

Load From Google Cloud

Azure One Lake

Load From Azure One Lake

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.

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

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


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


Note
titleNote
Skip this step for new installations.

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

No Format
Script 4 > . .\set_default_templates.ps1

Choose "Python" when prompted.