# Azure Synapse Analytics

This article outlines the integration with the Azure Synapse Analytics connector, 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.

<figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FYBHV1dNyiqk5FYjtgjPL%2Funknown.png?alt=media&#x26;token=1edea7ad-5f76-43c7-a03c-b3e0704362af" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="419.8333740234375"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>Data Warehouse</td></tr><tr><td>Connector Version</td><td>Release6.3.4</td></tr><tr><td>Releases Supported (Available from)</td><td>Release6.2</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with Azure Synapse Analytics]</p></td><td>JDBC</td></tr><tr><td>Verified Azure Synapse Analytics Version</td><td>Above Azure SQL Server 2010</td></tr></tbody></table>

{% hint style="warning" %}
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.
{% endhint %}

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| 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.

<table><thead><tr><th width="262.66668701171875">Azure Synapse Analytics Object</th><th width="279.83331298828125">Azure Synapse Analytics  Attribute</th><th width="202.6666259765625">OvalEdge Attribute</th><th width="198.8333740234375">OvalEdge Category</th><th width="176.3333740234375">OvalEdge Type</th></tr></thead><tbody><tr><td>Schema</td><td>Schema Name</td><td>Schema</td><td>Databases</td><td>Schema</td></tr><tr><td>Schema</td><td>Schema Comments</td><td>Source Description</td><td>Databases</td><td>Schema</td></tr><tr><td>Table</td><td>Table Name</td><td>Table</td><td>Tables</td><td>Table</td></tr><tr><td>Table</td><td>Table Type</td><td>Table</td><td>Tables</td><td>Table</td></tr><tr><td>Table</td><td>Table Comments</td><td>Source Description</td><td>Descriptions</td><td>Source Description</td></tr><tr><td>Columns</td><td>Column Name</td><td>Column</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Data Type</td><td>Column Type</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Description</td><td>Source Description</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Ordinal Position</td><td>Column Position</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Columns</td><td>Length</td><td>Data Type Size</td><td>Table Columns</td><td>Columns</td></tr><tr><td>Views</td><td>View Name</td><td>View</td><td>Tables</td><td>View</td></tr><tr><td>Views</td><td>Text</td><td>View Query</td><td>Views</td><td>View</td></tr><tr><td>Procedures</td><td>Routine_Name</td><td>Name</td><td>Procedures</td><td>Procedures</td></tr><tr><td>Procedures</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>Procedures</td></tr><tr><td>Procedures</td><td>Routine_Definition</td><td>Procedure</td><td>Procedures</td><td>Procedures</td></tr><tr><td>Functions</td><td>Routine_Name</td><td>Name</td><td>Functions</td><td>Functions</td></tr><tr><td>Functions</td><td>Routine_Definition</td><td>Function</td><td>Functions</td><td>Functions</td></tr><tr><td>Functions</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>Functions</td></tr><tr><td>Triggers</td><td>Trigger Name</td><td>Name</td><td>Triggers</td><td>Triggers</td></tr><tr><td>Triggers</td><td>Trigger Definition</td><td>Trigger Data</td><td>Triggers</td><td>Triggers</td></tr><tr><td>Triggers</td><td>Trigger Type</td><td>Type</td><td>Triggers</td><td>Triggers</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

### **External Supporting Files**

<table><thead><tr><th width="220.666748046875">File Name</th><th>Description</th></tr></thead><tbody><tr><td>jtds - 1.3.1</td><td>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.</td></tr></tbody></table>

{% hint style="info" %}
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](https://docs.ovaledge.com/connectors/connector-supporting-files).
{% endhint %}

### Whitelisting Ports

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

{% hint style="warning" %}
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.
{% endhint %}

### Service Account User Permissions

{% hint style="warning" %}
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.
{% endhint %}

{% hint style="info" %}
👨‍💻 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.
{% endhint %}

<table><thead><tr><th width="191.6666259765625">Objects</th><th width="331.3333740234375">System Tables</th><th>Access Permissions</th></tr></thead><tbody><tr><td>Schema</td><td>Sys.Schemas</td><td>Select</td></tr><tr><td>Tables</td><td>Information_Schema.Tables</td><td>Select</td></tr><tr><td>Tables</td><td>Extended_Properties</td><td>Select</td></tr><tr><td>Table Columns</td><td>Sys.All_Columns</td><td>Select</td></tr><tr><td>Table Columns</td><td>Sys.Types</td><td>Select</td></tr><tr><td>Table Columns</td><td>Sys.Views</td><td>Select</td></tr><tr><td>Table Columns</td><td>Information_Schema.Columns</td><td>Select</td></tr><tr><td>Table Columns</td><td>Information_Schema.Key_Column_Usage</td><td>Select</td></tr><tr><td>Table Columns</td><td>Information_Schema.Table_Constraints</td><td>Select</td></tr><tr><td>Views</td><td>Information_schema.Views</td><td>View Definition</td></tr><tr><td>Views</td><td>Sys.Objects</td><td>View Definition</td></tr><tr><td>Functions, Stored Procedures Source code</td><td>Information_Schema.Routines</td><td>View Definition</td></tr><tr><td>Functions, Stored Procedures Source code</td><td>Sys.Sql_Modules</td><td>View Definition</td></tr><tr><td>Functions, Stored Procedures Source code</td><td>Sys.Extended_Properties</td><td>View Definition</td></tr><tr><td>Triggers</td><td>Sys.Objects</td><td>Select</td></tr><tr><td>Triggers</td><td>Sql_Modules</td><td>Select</td></tr><tr><td>Synonyms</td><td>Sys.Synonyms</td><td>Select</td></tr><tr><td>Relationships</td><td>Sys.Foreign_Keys</td><td>Select</td></tr></tbody></table>

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

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

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>Fields marked with an asterisk (*) are mandatory for establishing a connection.</p></div>

<table><thead><tr><th width="219.8333740234375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Azure Synapse Analytics" is displayed as the selected connector type.</td></tr><tr><td>Authentication</td><td><p>OvalEdge supports the following three types of authentication for Azure Synapse Analytics:</p><ul><li>SQL Server Authentication</li><li>Windows Authentication</li><li>Azure Active Directory - Password</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="SQL Server Authentication" %}

<table><thead><tr><th width="219.6666259765625">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>Database</li><li>HashiCorp</li><li>AWS Secrets Manager</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</li><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li><li>Select the checkbox for Data Access Add-On to enable the data access functionality.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Azure Synapse Analytics connection              </p><p>(Example: "Azure Synapse Analytics_Prod").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Server*</td><td>Enter the Azure Synapse Analytics database server name or IP address (Example: http://testsynapse.sql.azuresynapse.net).</td></tr><tr><td>Port*</td><td>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.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Azure Synapse Analytics.</td></tr><tr><td>Driver*</td><td>By default, the SQL Server driver details are auto-populated. </td></tr><tr><td>Username*</td><td>Enter the service account username set up to access the Azure Synapse Analytics database (Example: "oesauser").</td></tr><tr><td>Password*</td><td>Enter the password associated with the service account user.</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Azure Synapse Analytics database:</p><ul><li>Automatic Mode: The system generates a connection string based on the provided credentials.</li><li>Manual Mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{sid} refers to Database Name.</p></td></tr><tr><td>Plugin Server</td><td>Enter the server’s name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>
{% endtab %}

{% tab title="Windows Authentication" %}

<table><thead><tr><th width="221.3333740234375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>OvalEdge Installed Environment</td><td><p>Select the environment in which OvalEdge has been installed.</p><ul><li>Windows</li><li>Linux/Unix</li></ul></td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>Database</li><li>HashiCorp</li><li>AWS Secrets Manager</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</li><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li><li>Select the checkbox for Data Access Add-On to enable the data access functionality.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Azure Synapse Analytics connection              </p><p>(Example: "Azure Synapse Analytics_Prod").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Server*</td><td>Enter the Azure Synapse Analytics database server name or IP address (Example: http://testsynapse.sql.azuresynapse.net).</td></tr><tr><td>Port*</td><td>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.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Azure Synapse Analytics.</td></tr><tr><td>Domain</td><td>Enter the qualified Azure Synapse Analytics domain name.
<br>Note: This field appears when the authentication type is set to Windows authentication and the OvalEdge installed Environment is selected as Linux/Unix.</td></tr><tr><td>Driver*</td><td>By default, the SQL Server driver details are auto-populated. </td></tr><tr><td>Username*</td><td><p>Enter the service account username set up to access the Azure Synapse Analytics database (Example: "oesauser").</p><p>Note: This field appears when Windows Authentication is selected as the authentication type and the installation environment is set to Linux/Unix.</p></td></tr><tr><td>Password*</td><td><p>Enter the password associated with the service account user.</p><p>Note: This field appears when Windows Authentication is selected as the authentication type and the installation environment is set to Linux/Unix.</p></td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Azure Synapse Analytics database:</p><ul><li>Automatic Mode: The system generates a connection string based on the provided credentials.</li><li>Manual Mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{sid} refers to Database Name.</p></td></tr><tr><td>Plugin Server</td><td>Enter the server’s name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>
{% endtab %}

{% tab title="Azure Active Directory - Password" %}

<table><thead><tr><th width="220.66668701171875">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.</p><p>Supported Credential Managers:</p><ul><li>Database</li><li>HashiCorp</li><li>AWS Secrets Manager</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</li><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li><li>Select the checkbox for Data Access Add-On to enable the data access functionality.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Azure Synapse Analytics connection              </p><p>(Example: "Azure Synapse Analytics_Prod").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Server*</td><td>Enter the Azure Synapse Analytics database server name or IP address (Example: http://testsynapse.sql.azuresynapse.net).</td></tr><tr><td>Port*</td><td>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.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Azure Synapse Analytics.</td></tr><tr><td>Driver*</td><td>By default, the SQL Server driver details are auto-populated. </td></tr><tr><td>Username*</td><td>Enter the service account username set up to access the Azure Synapse Analytics database (Example: "oesauser").</td></tr><tr><td>Password*</td><td>Enter the password associated with the service account user.</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Azure Synapse Analytics database:</p><ul><li>Automatic Mode: The system generates a connection string based on the provided credentials.</li><li>Manual Mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{sid} refers to Database Name.</p></td></tr><tr><td>Plugin Server</td><td>Enter the server’s name when running as a plugin server.</td></tr><tr><td>Plugin Port</td><td>Enter the port number on which the plugin is running.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="221.1666259765625"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>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.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="221"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in OvalEdge Security are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="220.16668701171875"></th><th></th></tr></thead><tbody><tr><td>No of Archive Objects*</td><td><p>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.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="220.666748046875"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.</p></td></tr></tbody></table>

2. 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.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="warning" %}
To perform crawl and profile operations, users must be assigned the Integration Admin role.
{% endhint %}

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, with a **green** icon for active connections and a **red** icon for inactive connections, helping monitor connectivity to 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.

<table><thead><tr><th width="84.6944580078125">S.No.</th><th width="247.4166259765625">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating AZURESYNAPSE connection | Root cause: Login failed for user 'sqlserver'. ClientConnectionId:xxxxx-xxxx-4exd-xxxx-0511xxxxx18</td><td>Description: The connection to Azure Synapse failed because the login credentials for user 'sqlserver' were invalid.<br><br>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.</td></tr><tr><td>2</td><td>Could not get JDBC Connection; ... The TCP/IP connection to the host ..., port 1433 has failed. ... timed out</td><td><p>Error Description: The system failed to establish a JDBC connection because the TCP/IP request to the specified SQL Server host and port 1433 timed out.</p><p></p><p>Resolution: Verify that the SQL Server instance is running and accessible over the network, ensure port 1433 is open and reachable, and confirm that the connection string and firewall settings are correctly configured.</p></td></tr><tr><td>3</td><td>No suitable driver found for jdbc:sqlserver://...</td><td><p>Error Description: The system cannot identify or load the required JDBC driver for the Azure Synapse Analytics connection, preventing the JDBC URL from being processed. This typically occurs due to missing, outdated, or incorrectly configured SQL Server JDBC drivers.</p><p></p><p>Resolution: Install or update the supported Microsoft SQL Server JDBC driver and ensure it is correctly referenced in the connector configuration. Verify that the JDBC URL format meets Azure Synapse Analytics requirements, then revalidate the connection.</p></td></tr><tr><td>4</td><td>Exception occured while getting the remote databases in SQL Server Connection : ...</td><td><p>Error Description: An exception occurred when the connector attempted to retrieve the list of remote databases from the SQL Server endpoint. The request to Azure Synapse Analytics failed due to connectivity, permission, or metadata access issues.</p><p></p><p>Resolution: Verify network access, authentication details, and required permissions for the Azure Synapse Analytics workspace. Retry the operation after ensuring the endpoint is reachable and metadata retrieval is allowed.</p></td></tr><tr><td>5</td><td>Could not get JDBC Connection; nested exception is java.sql.SQLException: The TCP/IP connection to the host ...</td><td><p>Error Description: The system failed to establish a JDBC connection because the Azure Synapse Analytics host was unreachable. This typically occurs due to network connectivity issues, incorrect server details, or blocked firewall/port settings.</p><p></p><p>Resolution: Verify the Synapse server hostname, port, and connectivity, and ensure required firewall rules allow access. Test the network path and update the configuration or credentials if the connection parameters are incorrect.</p></td></tr></tbody></table>

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.<br>