Page History
This is a guide to installing the WhereScape Enablement Pack for PostgreSQL for WhereScape RED 8.6.1.x
Table of Contents | ||||
---|---|---|---|---|
|
Prerequisites
Before you begin the following prerequisites must be met:
- A supported* version of SQL Server or Azure SQL with
- a database to house the RED Metadata Repository
- ODBC DSN's created for these DB's
- A PostgreSQL environment with at least one schema available to use as a RED Data Warehouse Target
- PostgreSQL software installed
- PostgreSQL ODBC driver (64-bit UNICODE)
- ODBC DSN created to connect to your RED Data Warehouse on PostgreSQL
- PostgreSQL client tools installed on the system path - at a minimum, you will need psql.exe for data loads.
- WhereScape RED version 8.6.1.0 or higher
- Must be pre-installed with valid license key entered and EULA accepted
- WhereScape Enablement Pack for PostgreSQL version 8.6.1.0 or higher
- Downloaded and unpacked to a local temp folder
- Windows Powershell (64-bit) version 5 or higher
Note |
---|
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.
# | Enablement Pack Setup Scripts | Script Purpose | Run as Admin | Intended Application |
1 | install_New_RED_Repository.ps1 | Setup and configure a new RED Metadata Repository for the target database PostgreSQL | Yes | New RED installations ONLY |
2 | install_WslPowershell_Modules.bat | Installs or updates WslPowershell Modules on this machine | Yes | New and Existing installations |
3 | import_powershell_templates.ps1 | Imports or updates the Powershell Templates to a RED Metadata Repository. Also includes any Script or Procedure Imports | no* | Existing installations |
4 | set_default_templates.ps1 | Applies the RED Connection defaults in a RED Metadata Repository for Powershell templates | no* | Existing installations |
Note |
---|
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.
Step-by-step guides
Setup and configure a new RED Metadata Repository for PostgreSQL
- Double check Prerequisites section
- Run as Administrator:
Code Block Script 1 > Powershell -ExecutionPolicy Bypass -File .\install_New_RED_Repository.ps1 Script 2 > install_WslPowershell_Modules.bat
Install or Update WhereScape Powershell Templates
- Run as Administrator -
Script 2 - install_WslPowershell_Modules.bat
- Run -
Script 3 - import_powershell_templates.ps1
- Run -
Script 4 - set_default_templates.ps1
Set Connection defaults for a Template Set
- Run -
Script 4 - set_default_templates.ps1
- Choose Powershell when prompted
Source Enablement Pack Support
Source Pack Name | Supported By PostgreSQL | Supported Features |
Amazon S3 | Yes | Downloads file From Amazon S3 and uploads to PostgreSQL Table |
Azure DataLake Storage Gen2 | Yes | Downloads file From Azure DataLake Storage Gen2 and uploads to PostgreSQL Table |
Google Cloud Storage | Yes | Downloads file From Google Cloud Storage and uploads to PostgreSQL Table |
Google Drive | Yes | Downloads file From Google Drive and uploads to PostgreSQL Table |
Note |
---|
Only New line, record delimiter is supported for the current version of load to PostgreSQL |
Post Install Steps
If you used the script 'install_New_RED_Repository.ps1' then the following post-install steps are encouraged
Configure Connections
There were two connections added that will optionally require your attention:
- Target Connection PostgreSQL
- set extended properties SERVER_NAME and SERVER_PORT
- set extended property SERVERSIDE_COPY - if a Load fails with an error like "program TYPE: .. failed" then toggle this setting
- Connection: 'Database Source System' - this connection was setup as an example source connection,
- open it's properties and set it up for a source DB in your environment
- or you can remove it if not required
- Target Connection PostgreSQL
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
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 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 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.ps1
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 several workarounds for this which can be found by searching the term "Powershell Execution Policy".
Here is the most common workaround 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 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 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 your system then you are most likely running the PowerShell (x86) version which does not show the installed 64-bit apps by default. Please open a 64-bit version of PowerShell instead and re-run the script.
This is a guide to installing the WhereScape Enablement Pack for PostgreSQL for WhereScape RED 8.6.1.x