RDBMS

Amazon Redshift

Connector CategoryThis document outlines the integration of OvalEdge with the Redshift connector, enabling efficient data management through features such as crawling, profiling, query sheet, data preview, and lineage building (both automatic and manual). Additionally, it supports impact analysis, ensures secure authentication through Credential Manager, and enhances data governance with data quality, Data Access Management (DAM), and bridge functionalities.

Overview

Connector Details

Connector Category

RDBMS

OvalEdge Release Current Connector Version Release6.3.4
OvalEdge Releases Supported (Available from) Release4

Connectivity

[How OvalEdge connects to Redshift]

JDBC driver
Verified Redshift Version 1.0.109768

Note: The Redshift connector has been internally verified with the above Redshift version and is expected to be compatible with other supported versions. If you have any issues with different versions, please contact the GCS team for assistance.

Connector Features

Crawling
Delta Crawling
Profiling
Query Sheet
Data Preview
Auto Lineage
Manual Lineage
Secure Authentication via Credential Manager
Data Quality
DAM (Data Access Management)
Bridge

Getting Ready to Establish a Connection

Prerequisites

The following are the prerequisites to establish a connection between Redshift and OvalEdge:

Whitelisting Ports

Ensure the inbound port “5439” is whitelisted for OvalEdge to connect to the Redshift database.

Important: The default port number for the Redshift data source is 5439. If a different port is used, ensure it is whitelisted, and communication is established between OvalEdge and the Redshift source.

Service Account User Permissions

Important: We recommend having a separate service account to establish a connection from OvalEdge to the data source with the following minimal set of permissions.

Objects

Access Permission

Schema

USAGE

Tables

SELECT

Table Columns

SELECT, UPDATE

Views

SELECT

Functions, Stored Procedures, Source code

EXECUTE

Relationships

REFERENCES

Setup a Connection

Important: You must have the Connector Creator role to set up a connection in OvalEdge.

  1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Redshift, and complete the required parameters.
    Note: Fields marked with an asterisk (*) are mandatory for establishing a connection.

    Field Name

    Description

    Connector Type By default, "Redshift" is displayed as the selected connector type.
    Connector Settings

    Credential Manager*

    Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.

    Supported Credential Managers:

    • OE Credential Manager
    • AWS Secrets Manager
    • HashiCorp Vault
    • Azure Key Vault

    License Add Ons


    Auto Lineage

    Supported

    Data Quality

    Supported

    Data Access

    Supported

    • Select the checkbox for Auto Lineage Add-On to build data lineage automatically.
    • Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.
    • Select the checkbox for Data Access Add-On license that will enforce connector access via OvalEdge with Data Access Management (DAM) feature enabled.

    Connector Name*

    Enter a unique name for the Redshift connection              

    (Example: "Redshift_Prod").

    Connector Environment

    Select the environment (Example: PROD, STG) configured for the connector.

    Server*

    Enter the Redshift database server name or IP address (Example: xxxx-redshift.xxxx4ijtzasl.xx-south-1.rds.xxxx.com or 192.xxx.1.xx).

    Port*

    By default, the port number for the Redshift, "5439" is auto-populated. If required, the port number can be modified as per custom port number that is configured for your Redshift.

    Database*

    Enter the database name to which the service account user has access within the Redshift.

    Driver*

    By default, the Redshift driver details are auto-populated. 

    Username*

    Enter the service account username set up to access the Redshift database (Example: "oesauser").

    Password*

    Enter the password associated with the service account user.

    Connection String

    Configure the connection string for the Redshift database:

    • Automatic Mode: The system generates a connection string based on the provided credentials.
    • Manual Mode: Enter a valid connection string manually.

    Replace placeholders with actual database details.

    {sid} refers to Database Name

    Default Governance Roles

    Default Governance Roles*

    Select the appropriate users or teams for each governance role from the drop-down list. All users and teams configured in OvalEdge Security are displayed for selection.

    Admin Roles

    Admin Roles*

    Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.

    No of Archive Objects

    No Of Archive Objects*

    This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.

    Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.

    Bridge

    Select Bridge*

    If applicable, select the bridge from the drop-down list.

    The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.

  2. After entering all connection details, you can perform the following actions:
    1. Click Validate to verify the connection.
    2. Click Save to store the connection for future use.
    3. Click Save & Configure to apply additional settings before saving.
  3. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

Important: You must have the Integration Admin role in OvalEdge for crawl/profile operations.

The Crawl/Profile button allows you to select one or more schemas for crawling and profiling. 

  1. Navigate to the Connectors page and click Crawl/Profile.
  2. Select the schemas you want to crawl.
  3. The Crawl option is selected by default. Click the Crawl & Profile radio button if you want both operations.
  4. Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
  5. After a successful crawl, the information appears in the Data Catalog > Databases tab.

The Schedule checkbox allows automated crawling and profiling for a selected timeframe, from a minute to a year.

  1. Click the Schedule checkbox to enable the Select Period drop-down.
  2. Select a time period for the operation from the drop-down menu.
  3. Click Schedule to initiate metadata collection from the connected source.
  4. The system will automatically execute the selected operation (Crawl or Crawl & Profile) at the scheduled time.

Other Operations

The Connectors page in OvalEdge provides a centralized view of all configured connectors, including their health status.

Managing connectors includes:

  • Connectors Health: Displays performance using a green icon for active connections and a red icon for inactive connections, helping to monitor the connection between OvalEdge and data sources.
  • Viewing: Click the Eye icon next to the connector name to view connector details, including databases, tables, columns, and codes.

Nine Dots Menu Options:

You can view, edit, validate, build lineage, modify connector settings, and delete connectors using the Nine Dots menu.

    • Edit Connector: Update and revalidate the data source.
    • Validate Connector: Check the connection's integrity.
    • Settings: Modify connector settings.
      • Crawler: Configure data extraction.
      • Profiler: Customize data profiling rules and methods.
      • Query Policies: Define query execution rules based on roles.
      • Access Instructions: Add notes on how data can be accessed.
      • Business Glossary Settings: Manage term associations at the connector level.
      • Anomaly Detection Settings: Configure anomaly detection preferences at the connector level.
      • Others: Configure notification recipients for metadata changes.
  • Build Lineage: Automatically build data lineage using source code parsing.
  • Delete Connector: Remove a connector with confirmation.

Metadata Mapping

Source Object

Source Attribute

OvalEdge Attribute

OvalEdge Category

OvalEdge Type

Table

Table Name

Table

Tables

Table

Table Type

Type

Tables

Table

Table Comments

Source

Description

Descriptions

Source

Description

Columns

Column Name

Column

Table Columns

-

Data Type

Column Type

Table Columns

-

Description

Source

Description

Table Columns

-

Ordinal Position

Column Position

Table Columns

-

Length

Data Type Size

Table Columns

-

Views

View Name

View

Tables

View

Text

View Query

Views

View

Procedures

Routine_name

Name

Procedures

-

Description

Source

Description

Descriptions

-

Routine_definition

Procedure

Procedures

-

Functions

Routine_name

Name

Functions

-

Routine_definition

Function

Functions

-

Description

Source 

Description

Descriptions

-


                                                  Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA