Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  1. RED Enablement Packs
  2. Enablement Pack - Home
  3. Install Guides

RED Enablement Packs : WhereScape Enablement Pack for Azure Synapse- RED10

...

This is a guide to installing the WhereScape Enablement Pack for Azure Synapse for WhereScape RED

Table of Contents


Table of Contents
maxLevel2
minLevel2


Include Page

...

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

Wiki Markup
\[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

-WIP
Prerequisites For PostgreSQL Metadata -WIP

 Prerequisites

...

For Target Database Azure Synapse

Before you begin the following prerequisites must be met:

  • Create Database and ODBC

...

  • DSN:
    • Azure Synapse
      • At least one schema available to use as a RED Data Warehouse Target
    • 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. 

    1

    Setup_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

    2

    install_WslPython_Modules.bat

    Installs or updates WslPython Modules and required Python libraries on this machine.

                 Yes              

    New and Existing installations

    3

    import_python_templates.ps1

    Imports or updates the Python Templates  to a RED Metadata Repository. Also includes any Script Imports

                 No*           

    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

    ...

    Step-By-Step Guide

    Setup and configure RED Metadata Repository

    ...

    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

    ...

    Install or Update WhereScape Python Templates (For Existing Installations)

    ...

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

    ...

    Include Page
    Install Guides-Common
    Install Guides-Common

    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

    ...

    are some connections added that will optionally require your attention:

    1. Connection: 'Database Source System' - this connection was

    ...

    1. set up 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.
    1. Connection: 'Azure Synapse'- this connection was

    ...

    1. set as per parameters provided in script 1
      1. open

    ...

      1. its properties and check the extended properties tab, set it up for Blob Storage Account, Blob Storage Access Key, Blob Storage Container, Blob Endpoint, Blob Storage Data Source, and Azure SQL DW Connection String

    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

    Source Pack Name

    Supported By Azure Synapse

    Supported Features

    Prerequisites

    Cloud File Parser

    1. Amazon S3
    2. Azure Data Lake Storage Gen2
    3. Google Cloud Storage
    1. CSV
    2. Excel
    3. JSON
    4. XML
    5. AVRO
    6. ORC
    7. PARQUET

    Bulk load

    Refer to Windows Parser Guide

    Windows Parser

    1. CSV
    2. Excel
    3. JSON
    4. XML
    5. AVRO
    6. ORC
    7. PARQUET

    Load Template, Source Properties will have the option to select parser type to load the files.

    Refer to Windows Parser Guide

    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 batch (.bat) scripts from the administrator prompt by simply typing the name at the prompt and hit 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
    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.

    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.

    AWS PrivateLink Documentation

    Please refer to the link below for the configuration of AWS PrivateLink for Snowflake:
    {+}https://community.snowflake.com/s/article/Setup-On-Premise-DNS-to-work-in-conjunction-with-AWS-PrivateLink+Image Removed

    Attachments:

    ...

    Include Page
    Troubleshooting and Tips - RED10
    Troubleshooting and Tips - RED10