WhereScape Enablement Pack for Google BigQuery - RED 10

This is a guide to installing the WhereScape Enablement Pack for Google BigQuery for WhereScape RED 10

Prerequisites For Google BigQuery

Before you begin the following prerequisites must be met:

• Create Database and ODBC DSN:
  • Google BigQuery (ODBC driver version 3.00.xx.xxxx or higher(64-bit))
    • At least one schema available to use as a RED Data Warehouse Target
• Software Installations
  •  Google Cloud SDK for utilities GSUTIL and BQ installed and on the Windows system path
    • Download and Install Google Cloud SDK Installer from {+}https://cloud.google.com/sdk/docs/quickstart+
    • Note: To use the Google Cloud SDK and its associated tools (GSUTIL and BQ), authentication, initialization, and project configuration are required. Please refer to the provided instructions for completing this process from {+}https://cloud.google.com/sdk/docs/install-sdk+
    • Important: Google Cloud SDK and its associated tools (GSUTIL and BQ) must be authenticated again after installation. For reauthentication please refer to this process from {+}https://cloud.google.com/sdk/gcloud/reference/auth/application-default+ /login or run the below command as admin in Command Prompt and follow prompted instructions. A complete system restart is recommended after this process.  
      

      gcloud auth application-default login

• • ODBC DSN created to connect to your RED Data Warehouse on BigQuery
  • Google BigQuery Catalog Name
  • At least one storage bucket needs to be created on Google Cloud Storage.
    • Permission Required: Upload, Read and Delete File
• Python 3.8 or higher (Tested with 3.8-3.11)
  • Select Add Python 3.8 to PATH from the installation Window
  • Pip Manager Install with the command : python -m pip install --upgrade pip


    Some of the libraries might be deprecated in the newer versions of Python (Python 3.12 and higher)

Installation Through Setup Wizard

Run Setup Wizard as administrator

Create a new repository or upgrade an already existing repository.

Select the created ODBC DSN, input login details, and then select Validate. Click Next.

Select the directory that contains the unzipped Enablement Pack for installation. Click Next.

Using the checkboxed list, include or exclude the components that are to be installed. Click Next.

Configure a target connection (for example, a Data Warehouse) and its target locations.

Validate and click Add.

When done, click Add and then click Next to continue.

Configure a data source connection (optional) and its target locations. Validate and click Add. Click Next to continue.

Review the installation summary and press Install

Click View Logs to open the installation log. Click Finish once the installation is completed successfully.

Login to WhereScape RED.

You will be directed to the below PowerShell window which will give brief explanation of the post-installation process.

Click OK to start the post-installation. If you click Cancel installation stops and the user 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.

You will be directed to PowerShell window below. Provide the directory that contains the unzipped Enablement Pack.

The progress bar will show the post-installation progress.

Users will have to choose the schema for the target setting that was provided. One such pop-up will come for setting the default target schema for Date Dimension.

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.

After clicking OK RED10 opens automatically.

User will need to restart RED once.

After Restart

Upgrade Of Existing Repository

For upgrade of an existing repository

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

   
Important Upgrade Notes
If the RED repository exists, it will prompt to upgrade the repository. This enablement pack will overwrite any existing Source Enablement Pack UI Configs:

To ensure existing Source Enablement Pack connections and associated Load Tables continue to browse and load:
Go into UI Configuration Maintenance in RED before installing this  Enablement Pack and rename the affected UI Configurations. While the updated Load Template will work with previous Source Enablement Packs 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
There were Three connections added that will optionally require your attention:

1. Connection: Data Warehouse ('Google BigQuery' )- This connection was set as per parameters provided in Setup Wizard
   1. open its properties and check the extended properties tab, set it up for GBQ_BUCKET and LOCATION
2. Connection: 'Database Source System' - this connection was set up as an example source connection,
   1. 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

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

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

Setting Up Google BigQuery Configuration

1. Add a system variable GOOGLE_APPLICATION_CREDENTIALS to point to a location where credentials get generated.
   
2. Open command prompt and cereate Google BiqQuery file using gcloud auth application-default login
   
3. On running this command, the config file should be created in the location specified in the config file system variable
    
   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>

Re-install Python Libraries

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>uninstall_WslPython_Modules.bat
For the installation of Python libraries, there are two methods

• Method 1
  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_WslPython_Modules.bat

• Method 2
  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 the below command:
  python -m pip install -r requirements.txt

For upgrade of an existing repository 

In the upgrade of the existing repository if the user gets the above error then it means the script type of wsl_post_install_enablement_pack is set to PowerShell(64-bit) change the script type to Auto Execute-PowerShell before the upgrade or manually run the wsl_post_install_enablement_pack script from the host script from RED after the upgrade.

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.