Azure Synapse Analytics

This document outlines the integration with Azure Synapse Analytics, enabling streamlined metadata management through features such as crawling, Profiling, data preview, Data Quality, Data Access, and lineage building (Auto and Manual). It also ensures secure authentication via Credential Manager.

Overview

Connector Details

Connector Category	Data Warehouse
Connector Version	6.3.4
Releases Supported (Available from)	Legacy Connector
Connectivity [How the connection is established with Azure Synapse Analytics]	JDBC
Verified Azure Synapse Analytics Version	Above Azure SQL Server 2010

The Azure Synapse Analytics connector has been validated with the mentioned "Verified Azure SQL Server Versions" and is expected to be compatible with other supported Azure SQL Server versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.

Connector Features

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

Metadata Mapping

The following objects are crawled from the Azure Synapse Analytics and mapped to the corresponding UI assets.

Azure Synapse Analytics Object	Azure Synapse Analytics Attribute	OvalEdge Attribute	OvaEdge Category	OvalEdge Type
Schema	Schema Name	Schema	Databases	Schema
Schema	Schema Comments	Source Description	Databases	Schema
Table	Table Name	Table	Tables	table
Table	Table Type	Table	Tables	table
Table	Table Comments	Source Description	Descriptions	Source Description
Columns	Column Name	Column	Table Columns	Columns
Columns	Data Type	Column Type	Table Columns	Columns
Columns	Description	Source Description	Table Columns	Columns
Columns	Ordinal Position	Column Position	Table Columns	Columns
Columns	Length	Data Type Size	Table Columns	Columns
Views	View Name	View	Tables	view
Views	text	View Query	Views	View
Procedures	Routine_Name	Name	Procedures	Procedures
Procedures	Description	Source Description	Descriptions	Procedures
Procedures	Routine_Definition	Procedure	Procedures	Procedures
Functions	Routine_Name	Name	Functions	Functions
Functions	Routine_Definition	Function	Functions	Functions
Functions	Description	Source Description	Descriptions	Functions
Triggers	Trigger Name	Name	Triggers	Triggers
Triggers	Trigger Definition	Trigger Data	Triggers	Triggers
Triggers	Trigger Type	Type	Triggers	Triggers

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

External Supporting Files

File Name	Description
jtds - 1.3.1	Use this file when connecting to Azure Synapse Analytics databases using the jtds-1.3.1 JDBC driver. Place the file in the Third Party Jars folder.

The supporting file is required to enable connectivity with Azure Synapse Analytics databases using the jtds-1.3.1 JDBC driver. Use this file according to the installation environment. The supporting files are available for download. Extract the ZIP file and select the required files to proceed. To download the ZIP file, click here.

Whitelisting Ports

Ensure that the inbound port “1433” is whitelisted to enable successful connectivity with the Azure Synapse Analytics database.

The default port number for Azure Synapse Analytics is 1433. If a different port is used, ensure that the updated port number is specified during connection setup, the port is whitelisted, and communication between the system and Azure Synapse Analytics is properly established.

Service Account User Permissions

It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.

👨‍💻 Who can provide these permissions? These permissions are typically granted by the Azure Synapse Analytics administrator, as users may not have the required access to assign them independently.

Objects	System Tables	Access Permissions
Schema	sys.schemas	select
Tables	Information_Schema.Tables	select
Tables	extended_properties	select
Table Columns	sys.all_columns	select
Table Columns	sys.types	select
Table Columns	sys.views	select
Table Columns	Information_Schema.Columns	select
Table Columns	Information_Schema.Key_Column_Usage	select
Table Columns	Information_Schema.Table_Constraints	select
Views	information_schema.Views	View Definition
Views	sys.objects	View Definition
Functions, Stored Procedures Source code	information_schema.Routines	View Definition
Functions, Stored Procedures Source code	sys.sql_modules	View Definition
Functions, Stored Procedures Source code	sys.extended_properties	View Definition
Triggers	sys.objects	select
Triggers	sql_modules	select
Synonyms	sys.synonyms	select
Relationships	sys.foreign_keys	select

Connection Configuration Steps

Users are required to have the Connector Creator role in order to configure a new connection.

1. Log in to OvalEdge, go to Administration > Connectors, click + (New Connector), search for Azure Synapse Analytics, and complete the required parameters.

   Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name	Description
Connector Type	By default, "Azure Synapse Analytics" is displayed as the selected connector type.
Authentication	OvalEdge supports the following three types of authentication for Azure Synapse Analytics: SQL Server Authentication Windows Authentication Azure Active Directory - Password

SQL Server Authentication

Field Name	Description
Credential Manager*	Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection. Supported Credential Managers: Database HashiCorp AWS Secrets Manager 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 to enable the data access functionality.
Connector Name*	Enter a unique name for the Azure Synapse Analytics connection (Example: "Azure Synapse Analytics_Prod").
Connector Environment	Select the environment (Example: PROD, STG) configured for the connector.
Connector Description	Enter a brief description of the connector.
Server*	Enter the Azure Synapse Analytics database server name or IP address (Example: http://testsynapse.sql.azuresynapse.net).
Port*	By default, the port number for the Azure Synapse Analytics, "1433" is auto-populated. If required, the port number can be modified according to the custom port number configured for your Azure Synapse Analytics.
Database*	Enter the database name to which the service account user has access within the Azure Synapse Analytics.
Driver*	By default, the SQL Server driver details are auto-populated.
Username*	Enter the service account username set up to access the Azure Synapse Analytics database (Example: "oesauser").
Password*	Enter the password associated with the service account user.
Connection String	Configure the connection string for the Azure Synapse Analytics 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.
Plugin Server	Enter the server’s name when running as a plugin server.
Plugin Port	Enter the port number on which the plugin is running.

Windows Authentication

Azure Active Directory - Password

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.

1. After entering all connection details, the following actions can be performed:

   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.

2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl/Profile

To perform crawl and profile operations, users must be assigned the Integration Admin role.

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

1. Navigate to the Connectors page and click Crawl/Profile.

2. Select the schemas 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 Data Catalog.

5. After a successful crawl, the information appears in the Data Catalog > Databases tab.

The Schedule checkbox allows automated crawling and profiling at defined intervals, 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 provides a centralized view of all configured connectors, along with their health status.

Managing connectors includes:

• Connectors Health: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.

• Viewing: Click the Eye icon next to the connector name to view connector details, including Schemas, Tables (Table & View), Columns, and Codes (SQL & View)

Nine Dots Menu Options:

To view, edit, validate, build lineage, configure, or delete connectors, click on 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.

  • Others: Configure notification recipients for metadata changes.

• Build Lineage: Automatically build data lineage using source code parsing.

• Delete Connector: Remove a connector with confirmation.

Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

S.No.	Error Message(s)	Error Description & Resolution
1	Error while validating AZURESYNAPSE connection | Root cause: Login failed for user 'sqlserver'. ClientConnectionId:xxxxx-xxxx-4exd-xxxx-0511xxxxx18	Description: The connection to Azure Synapse failed because the login credentials for user 'sqlserver' were invalid. Resolution: Verify the username and password configured in the connection settings. Ensure that the SQL user has the correct permissions to access the Synapse database.

---

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.