Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
maxLevel2
minLevel2


Prerequisites

  • Python 3.8 or higher
  • PIP Manager
    • From Command Prompt (Run As Administrator) run the below command
      Code Block
      titlePIP Manager Install
      python -m pip install --upgrade pip
  • Azure Data Lake Storage Gen2
    • Azure Data Lake Storage Gen2 Account Name
    • Azure Data Lake Storage Gen2 Access Key
    • Azure Data Lake Storage Gen2 SAS Token
    • Azure Data Lake Storage Gen2 File System Name (Created in Storage Explorer Preview). For example:

...

    • Install Python package - pip install azure-storage-file-datalake
    • Net Framework 4.8 or higher
    • Windows Powershell version 5 or higher
  • Run these commands in Windows PowerShell:
    Code Block
    [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
    Install-Module Az.Storage 
    Note: Use a 64-bit powershell terminal

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. 

...

Note
Note that on some systems executing Windows Powershell scripts is disabled by default, see troubleshooting for workarounds

Source Enablement Pack Installation

Run Windows Powershell as Administrator 

...

If prompted enter the source enablement pack as Azure

Azure Data Lake Storage Gen2 Connection Setup

  1. Login to RED
  2. Check-in Host Script Browse_Azure_DataLakeStorageGen2 in the objects list.                                                                                  
  3. Check UI Configurations in Menu, Tools → UI Configurations → Maintain UI Configurations
  4. Create a new connection in RED
  5. Select properties as shown below screenshot                   

...

    • Field Delimiter: This is a character that separates the fields within each record of the source file. The field delimiter identifies the end of each field. For Example, comma ( , ),pipe( | ). The token used to reader field delimiter in the script is $WSL_SRCCFG_azureDataLakeGen2FieldDelimiter$
    • Field Enclosure Delimiter: This is a character that delimits BOTH start and end of field value i.e. encapsulates value. A double quote is a common enclosure delimiter. The token used to read the field enclosure delimiter in the script is $WSL_SRCCFG_azureDataLakeGen2FieldEnclosureDelimiter$
    • Record Delimiter: This is to identify how each line/record in the source file is ended/terminated/delineated. Default is '\n' The token used to read the record delimiter value in the script is $WSL_SRCCFG_azureDataLakeGen2RecordDelimiter$          
    • Row Limit for Data Profiling: Number of records to scan for Data Profiling. Data profiling is used to get the column names and data types from the source file. By default, 100 records will be scanned. The token used to read the record delimiter value in the script is $WSL_SRCCFG_azureDataLakeGen2RowLimit$

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 Source 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 .\install_Source_Enablement_Pack.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_Source_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.