Page History

This is a guide to installing the WhereScape Enablement Pack for Redshift for WhereScape RED 8.6.1.x 

Prerequisites

Before you begin the following prerequisites must be met:

1. A supported* version of SQL Server or Azure SQL with
   • a database to house the RED Metadata Repository
   • (optionally) a database for the Range Table DB
   • ODBC DSN's created for these DB's 
2. A Redshift environment with at least one schema available to use as a RED Data Warehouse Target
3. Redshift software installed
   • Amazon Redshift ODBC driver (64-bit)
   • ODBC DSN created to connect to your RED Data Warehouse on Redshift
4. Access to a Redshift System, with the following connectivity information:
   • Server Name
   • Database Name
   • Port
   • User Name
   • Password
5. Permission to access svv_table_info. Can be added by an Administrator using: --> GRANT SELECT ON svv_table_info TO yourUserName
6. Access to an S3 bucket in the same region as your Redshift system to be used for temporary files while load loading data from windows Windows files and database tables. Specifically, you need to know:
   • Access Key, Secret Key, Region
   • Alternatively, instead of Access and Secret Keys, you could us use an Arn Key in this format: arn:aws:iam::YOUR_AWS_ACCOUNT_ID:role/YOUR_RedshiftAccessRole
   • S3 temporary or work directory folder in this format: s3://bucketName/folderName
7. WhereScape RED version 8.6.1.0 or higher
   • Must be pre-installed with valid license key entered and EULA accepted
8. WhereScape Enablement Pack for Redshift version 8.6.1.0 or higher
   • Downloaded and unpacked to a local temp folder
9. Windows Powershell (64-bit) version 5 or higher
   • Start "Windows PowerShell" As Administrator, then run these commands:

     • Wiki Markup
       \[Net.ServicePointManager\]::SecurityProtocol = \[Net.SecurityProtocolType\]::Tls12

     • Install-Module AWSPowershell

• :  RED supports the following versions for the metadata repository: MS SQL SERVER 2012 to 2019 and Azure SQL DB

Enablement Pack Setup Scripts

...

Scripts entirely drive the Enablement Pack Install process

...

. The table below

...

outlines these scripts, their purpose, and if

...

Run as Administrator

...

is required. 

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.

Step-by-step guides

Setup and configure a new RED Metadata Repository for Redshift

1. Double check Prerequisites section
2. Run as Administrator:
   • Script 1 > Powershell -ExecutionPolicy Bypass -File .\install_New_RED_Repository.ps1
   • Script 2 > install_WslPowershell_Modules.bat

Install or Update WhereScape Powershell Templates

1. Run as Administrator - Script 2 - install_WslPowershell_Modules.bat
2. Run - Script 3 - import import_powershell_templates.ps1
3. Run - Script 4 - set_default_templates.ps1

Set Connection defaults for a Template Set

1.  Run - Script 4 - set_default_templates.ps1 
   • choose "Choose Powershell" when prompted

Post Install Steps - Optional

If you used the script 'script install_New_RED_Repository.ps1' then the following optional post-install steps are available

...

1. Target Connection (Redshift) - check the extended properties section.
   1. Add ACCESS_KEY and SECRET KEY for s3 bucket
   2. Add CLOUD_WORKDIR -this is the s3 bucket directory location
   3. Add REGION of the s3 bucket
2. Connection: 'Database Source System' - this connection was setup set up as an example source connection,
   • open it's Open its properties and set it up for a source DB in your environment
   • or, you can remove it if not required
3. Connection: 'Range Table Location' - this connection is an example target connection for your Range Table DB on SQL Server,
   • if If you do not intend to use the "Ranged Loading" templates then this can be removed 
   • otherwise open it's Otherwise, open its properties and set it up to point to a suitable SQL DB target to store your control tables for Ranged Loading

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 'View->Toolbars->Script Launcher', select View>Toolbars>Script Launcher

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 '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 clicking 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 .\install_New_RED_Repository.ps1Notes:

...

...

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 "parameter -startAtStep <step number>" to the script.
Example: 
Powershell -ExecutionPolicy Bypass -File .\<script_file_name.ps1> -startAtStep 123Tip: to

If a valid RED installation can not be found

If you have Red 8.6.1.x or higher installed but the script (install_New_RED_Repository.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.
Document generated by Confluence on Jun 04, 2024 23:39
Atlassian