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 : Install Guide - SetupWizard - Azure Synapse

Created by Rekha Singh, last modified by Vedant Sawant on Sep 07, 2023

WhereScape Enablement Pack for Azure Synapse EP - RED 10

This is a guide to installing the WhereScape Enablement Pack for Azure Synapse for WhereScape RED10 Table of Contents

...


Table of Contents
maxLevel2
minLevel2

...

Prerequisites For PostgreSQL Metadata

Before you begin the following prerequisites must be met:

  • Create Database and ODBC DSN  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

...

      • Code Block
        \[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 Azure Synapse Target Database

Before you begin the following prerequisites must be met:

  • Create Database and ODBC DSN  DSN:
    • Azure Synapse
      • At least one schema available to use as a RED Data Warehouse Target
  • Python 3.8 or higher
    • Select "Select Add Python 3.8 to PATH" from the installation Window
    • Pip Manager Install with the command: python -m pip install --upgrade pip

Installation Through Setup Wizard

Run Setup Wizard as administrator
Image RemovedImage Added
Create a new repository or upgrade an already existing repository.
Image RemovedImage Added
Select the created ODBC DSN, input login details, and then select "Validate". Press Click Next
Image RemovedImage Added
Select the directory that contains the unzipped Enablement Pack for installation. Press Click Next
Image RemovedImage Added
Using the check boxed checkboxed list, include or exclude the components that are to be installed. Press Click Next
Image RemovedImage Added
Configure a target connection (for example, a Data Warehouse) and its target locations. Validate and press ADD.
Image Removedclick Add
Image Added
When done, press ADD click Add and then Press click Next to advance.continue
Image RemovedImage Added
Configure a data source connection (optional) and its target locations. Validate and press ADDclick Add. Press Click Next to advance.continue
Image RemovedImage Added
Review the installation summary and click Install
Image RemovedImage Added
Clicking on the the View Logs will take you to the installation log. Click on Finish once the installation is completed successfully.
Image RemovedImage Added
Login to WhereScape RED.
Image Removed Note: Image Added

Note

There is a post-install script that will run at the first login to RED10 to complete the post-setup wizard installation process.

You will be directed to the below PowerShell window which will give brief explanation about the post-installation process.
Image RemovedImage Added
Press Click OK to start the post-installation. If pressed you select Cancel, installation will stop stops, and the user will be is directed to RED.
The user will be directed to the window below, where they have to select the target connection to be configured. Additionally, by deselecting the provided options, the user can choose not to install a particular option.
Image RemovedImage Added
You will be directed to below the PowerShell window below. Provide the directory that contains the unzipped Enablement Pack.
Image RemovedImage Added
Press Click OK
The progress bar will show the post-installation progress.
Image RemovedImage Added
User Users will have to choose the schema for the target setting that were provided. One pop-up will come for setting the default target schema for Date Dimension.
Image Removed Image Added 
After selecting the target schema progress bar will show the progress for the installation and once it's completed, you will get the below pop-up.
Image RemovedImage Added
After pressing OK RED10 will open clicking OK RED opens automatically.
Image RemovedImage Added
User The user will need to refresh the All Objects tree once.
Image RemovedImage Added

Upgrade Of Existing Repository

For upgrade of an existing repository

  • From the host script set script type of wsl_post_install_enablement_pack as Auto Execute - PowerShell Script

    Image Removed Image Added

Important Upgrade Notes
If RED upgrade upgrades the repository option is chosen. 

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

Post Install Steps – Optional

If you used the script Setup Wizard for installation then the following optional post-install steps are available.
Configure Connections
These connections added that will optionally require your attention:

  1. Connection: Data Warehouse ('Azure Synapse')- This connection was setup set as per parameters provided in Setup Wizard
    1. open it's Open 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
  2. Connection: 'Database Source System' - this connection was setup set up as an example source connection,
    1. open Open its properties and set it up for a source DB in your environment
    2. or, you can remove it if not required

Enable Script Launcher Toolbar

There are a number of Several stand-alone scripts which 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 menu item 'Home->Script Launcher' , select Home>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 hitting 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:

Note

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 several workarounds for this which can be found by searching the term "Powershell Execution Policy".
Here is the most common workaround which 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 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

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

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:

Image AddedImage Removed image2023-7-17_16-53-36.png (image/png) Image Removed image2023-7-17_16-29-14.png (image/png) Image Removed image2023-7-17_16-28-52.png (image/png) Image Removed image2023-7-17_16-28-25.png (image/png) Image Removed image2023-7-17_16-26-23.png (image/png) Image Removed image2023-7-14_11-10-34.png (image/png) Image Removed image2023-7-14_2-10-40.png (image/png) Image Removed image2023-7-14_2-8-35.png (image/png) Image Removed image2023-7-14_2-7-26.png (image/png) Image Removed image2023-7-14_1-9-27.png (image/png) Image Removed image2023-7-14_1-3-5.png (image/png) Image Removed image2023-7-14_1-1-17.png (image/png) Image Removed image2023-7-14_1-0-39.png (image/png) Image Removed image2023-7-14_1-0-3.png (image/png) Image Removed image2023-7-14_0-59-32.png (image/png) Image Removed image2023-7-14_0-55-51.png (image/png) Image Removed image2023-7-14_0-53-33.png (image/png) Image Removed image2023-7-14_0-53-8.png (image/png) Image Removed image2023-7-14_0-51-14.png (image/png) Image Removed image2023-5-17_12-57-58.png (image/png) Image Removed image2023-5-16_16-42-5.png (image/png) Image Removed image2023-5-16_16-41-53.png (image/png) Image Removed image2023-5-16_16-28-49.png (image/png) Image Removed image2023-5-16_16-28-34.png (image/png) Image Removed image2023-5-5_14-31-44.png (image/png) Image Removed image2023-5-5_14-26-46.png (image/png) Image Removed image2023-5-5_14-26-26.png (image/png) Image Removed image2023-5-5_14-26-8.png (image/png) Image Removed image2023-5-5_13-44-53.png (image/png) Image Removed image2023-5-5_13-44-1.png (image/png) Image Removed image2023-5-5_13-43-23.png (image/png) Image Removed image2023-5-5_13-42-44.png (image/png) Image Removed image2023-5-5_13-41-35.png (image/png) Image Removed image2023-5-5_13-40-48.png (image/png) Image Removed image2023-5-5_13-39-21.png (image/png) Image Removed image2023-5-5_13-37-38.png (image/png) Image Removed image2023-4-14_11-24-9.png (image/png) Image Removed image2023-4-14_11-23-56.png (image/png) Image Removed worddav8f28802bcc606872fcd1ba80d5cb0eaf.png (image/png) Image Removed worddavdac1e6d68643d40a5a4b3e012a923c54.png (image/png) Image Removed worddava135585b47137e44df62528f954ded8f.png (image/png) Image Removed worddavea8a986ace4799130486d892480d85f0.png (image/png) Image Removed worddavd2d3c877144733ebbaaba5bbf3bda2dd.png (image/png) Image Removed worddavb76394cfa31d5b6e067cbd4f1488e32c.png (image/png) Image Removed worddav8ea0cf3ea483ea7a242de789610ad2ba.png (image/png) Image Removed worddav618cb65c184392be69e3c74024e85b92.png (image/png) Image Removed worddav20b7ce4b2ab664894acee3df74dfe844.png (image/png) Image Removed worddavc59f758196e39879a0edc0510b3f5f4f.png (image/png) Image Removed worddav8f07146097a5980b0bf66a2115b913e1.png (image/png) Image Removed worddav4d85e09a0382f84205f9bb1f3aca3f93.png (image/png) Image Removed worddav9fff499c34123ad1b5397f743d3129f3.png (image/png) Image Removed worddavac27573cde744c96cd8e7abb7a2ea24f.png (image/png) Image Removed worddavb3543ca787efab25cd39165c5a6effea.png (image/png) Image Removed worddav86d9bd86d87de0c7c2f08fc947085bf6.png (image/png) Image Removed worddave5c3ccb6549cb875eddb710801253165.png (image/png) Image Removed worddav92fe2ca9c94475e1037bd2eb6a0a5880.png (image/png) Image Removed worddav216e4a806326cf33392235af376c56aa.png (image/png) Image Removed worddav9b1fca73066ca8de7c6d1cecdf6cfd2e.png (image/png) Image Removed worddav016c84efb21622d6c22ea93108b8865e.png (image/png) Image Removed worddavb9a5cb10690b8bca7ef7ab657530b2d3.png (image/png) Image Removed worddav9882c74559468d5d87f85c620de8bc68.png (image/png) Image Removed image2023-6-15_13-37-17.png (image/png) Image Removed image2023-6-15_13-38-34.png (image/png) Image Removed image2023-6-15_13-39-7.png (image/png) Image Removed image2023-6-15_13-45-42.png (image/png) Image Removed image2023-6-15_13-51-54.png (image/png) Image Removed image2023-6-15_13-53-13.png (image/png) Image Removed image2023-6-15_13-54-26.png (image/png) Image Removed image2023-6-15_13-54-49.png (image/png) Image Removed image2023-6-15_13-58-57.png (image/png) Image Removed image2023-6-15_14-56-14.png (image/png) Image Removed image2023-6-15_14-57-53.png (image/png) Image Removed image2023-6-15_15-2-9.png (image/png) Image Removed image2023-6-15_15-2-33.png (image/png) Image Removed image2023-6-15_15-12-23.png (image/png) Image Removed image2023-6-15_15-12-49.png (image/png) Image Removed image2023-6-15_15-13-52.png (image/png) Image Removed image2023-6-15_15-15-28.png (image/png) Image Removed image2023-6-15_15-40-27.png (image/png) Image Removed image2023-6-15_15-43-39.png (image/png) Image Removed image2023-6-15_15-45-13.png (image/png) Image Removed image2023-6-15_15-47-33.png (image/png) Image Removed image2023-6-16_1-46-49.png (image/png) Image Removed image2023-6-16_11-18-35.png (image/png) Image Removed image2023-6-16_11-18-55.png (image/png) Image Removed image2023-6-16_11-20-4.png (image/png) Image Removed image2023-6-16_11-30-6.png (image/png) Image Removed image2023-6-16_11-32-21.png (image/png) Image Removed image2023-6-16_11-38-21.png (image/png) Image Removed image2023-6-16_11-42-17.png (image/png) Image Removed image2023-6-16_11-43-35.png (image/png) Image Removed image2023-6-16_11-45-29.png (image/png) Image Removed image2023-6-16_11-46-27.png (image/png) Image Removed image2023-6-16_12-1-10.png (image/png) Image Removed image2023-6-16_12-2-11.png (image/png) Image Removed image2023-9-4_15-58-20.png (image/png) Image Removed image2023-9-4_15-59-32.png (image/png) Image Removed image2023-9-4_15-59-55.png (image/png) Image Removed image2023-9-4_16-2-40.png (image/png) Image Removed image2023-9-4_16-17-43.png (image/png) Image Removed image2023-9-4_16-22-54.png (image/png) Image Removed image2023-9-4_16-30-0.png (image/png) Image Removed image2023-9-4_16-30-28.png (image/png) Image Removed image2023-9-4_16-31-35.png (image/png) Image Removed image2023-9-4_17-50-27.png (image/png) Image Removed image2023-9-4_17-52-6.png (image/png) Image Removed image2023-9-4_19-34-55.png (image/png) Image Removed image2023-9-5_12-0-48.png (image/png) Image Removed image2023-9-6_18-45-36.png (image/png) Image Removed image2023-9-6_18-49-4.png (image/png) Image Removed image2023-9-6_18-49-28.png (image/png)
Document generated by Confluence on Jun 04, 2024 23:38
Atlassian