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



Prerequisites Target Database

Before you begin the following prerequisites must be met:

  • Access to a Teradata (Target Environment), with the following connectivity information :
    1. Server Name
    2. Database Name
    3. User Name
    4. Password
    5. At least one database is available to use as a RED Data Warehouse Target with permissions CREATE, EXECUTE, DROP, SELECT PROCEDURE.
  • Create Database and ODBC DSN Teradata ODBC driver (64-bit)
    1. Add ODBC DSN for Teradata Target Database
    2. The 'Return Output Parameters As ResultSet' option is to be checked in the driver options setting.
  • Software installation
    • Install the necessary Teradata Tools and Utilities (TTU) (TBuild CLI Tool) as per Teradata's documentation.
  • Python 3.8 or higher
    • Select "Add Python 3.8 to PATH" from the installation Window
    • Pip Manager Install with the command: python -m pip install --upgrade pip



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 were two connections added that will optionally require your attention :

  1. Connection: 'Database Source System' - this connection was set up 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
  2. Execute Update Procedure for dim_date_td to Initialize Date Dimension for Target


Please avoid regenerating the procedure update_dim_date_td as it is a custom procedure.

Source Enablement Pack Support


Source Pack Name

Supported By Teradata

Supported Features

Prerequisites

Amazon S3

 Yes

Teradata Access Module for S3 (CSV)

Create a credential file by following the documentation linked below, and paste the directory location of the credential file into the 'Amazon S3 Config Directory' Extended Property:
{+}https://docs.teradata.com/r/Enterprise_IntelliFlex_Lake_VMware/Teradata-Tools-and-Utilities-Access-Module-Reference-20.00/Teradata-Access-Module-for-S3/The-config-and-credentials-Files+

Azure Data Lake Storage Gen2

Yes

Teradata Access Module for Azure Blob (CSV)

Create a credential file by following the documentation linked below, and paste the directory location of the credential file into the 'Azure Config Directory' Extended Property:
{+}https://docs.teradata.com/r/Enterprise_IntelliFlex_Lake_VMware/Teradata-Tools-and-Utilities-Access-Module-Reference-20.00/Teradata-Access-Module-for-Azure-Blob/The-Credentials-File+

Google Cloud Storage

 Yes

Teradata TPT

 None

Windows Parser

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

Load Template, Source Properties will have 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 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

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

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