# Microsoft SQL Server

This article outlines the integration with **Microsoft SQL Server** connector, enabling streamlined metadata management through features such as crawling, profiling, querying, data preview, and lineage building (both automatic and manual).

This connector supports connectivity to **Microsoft SQL Server** environments deployed across **Windows-based infrastructure**, **cloud platforms**, and **Microsoft Fabric Warehouse** via the SQL Analytics Endpoint. It provides flexible authentication options including **SQL Server Authentication**, **Windows Authentication**, **Azure Active Directory – Password**, **Managed Identity (User Assigned)**, and **Service Principal**, ensuring secure access based on deployment requirements. It also ensures secure authentication via Credential Manager.

{% hint style="info" %}
**Microsoft Fabric Warehouse** connectivity is supported through the Fabric **SQL Analytics Endpoint**, allowing metadata extraction and Data Quality execution using the same SQL Server connector.
{% endhint %}

<figure><img src="https://content.gitbook.com/content/ztcvwwOJCeaE1n6oHp4C/blobs/fMnXrRxiXBKXV1YqVAqi/image.png" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="391.3333740234375"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>RDBMS</td></tr><tr><td>OvalEdge Release Supported</td><td>Release6.3.4 and later</td></tr><tr><td>Connectivity<br>[How the connection is established with Microsoft SQL Server]</td><td>JDBC driver</td></tr><tr><td>Verified Microsoft SQL Server Versions</td><td>Microsoft SQL Server 2019 (15.0.4236.7) and later</td></tr></tbody></table>

{% hint style="info" %}
The Microsoft SQL Server connector has been validated with the mentioned "Verified Microsoft SQL Server Versions" and is expected to be compatible with other supported Microsoft 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                                     |       ✅      |
| 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 Microsoft SQL Server and mapped to the corresponding UI assets.

<table data-full-width="false"><thead><tr><th width="183">SQL Server Object</th><th width="189.5">SQL Server Property</th><th width="206">OvalEdge Attribute</th><th width="180.166748046875">OvalEdge Category</th><th width="150.666748046875">OvalEdge Type</th></tr></thead><tbody><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>-</td></tr><tr><td>Columns</td><td>Data Type</td><td>Column Type</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>Description</td><td>Source Description</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>Ordinal Position</td><td>Column Position</td><td>Table Columns</td><td>-</td></tr><tr><td>Columns</td><td>Length</td><td>Data Type Size</td><td>Table Columns</td><td>-</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>-</td></tr><tr><td>Procedures</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>-</td></tr><tr><td>Procedures</td><td>Routine_definition</td><td>Procedure</td><td>Procedures</td><td>-</td></tr><tr><td>Functions</td><td>Routine_name</td><td>Name</td><td>Functions</td><td>-</td></tr><tr><td>Functions</td><td>Routine_definition</td><td>Function</td><td>Functions</td><td>-</td></tr><tr><td>Functions</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>-</td></tr><tr><td>Triggers</td><td>Trigger Name</td><td>Name</td><td>Triggers</td><td>-</td></tr><tr><td>Triggers</td><td>Trigger Definition</td><td>Trigger Data</td><td>Triggers</td><td>-</td></tr><tr><td>Triggers</td><td>Trigger Type</td><td>Type</td><td>Triggers</td><td>-</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

#### **Whitelisting Ports**

Make sure that inbound port “**1433**” is whitelisted to enable successful connectivity with the Microsoft SQL Server database.

{% hint style="warning" %}
The default port number for Microsoft SQL Server 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 Microsoft SQL Server is properly established.
{% endhint %}

{% hint style="info" %}
Port configuration is not applicable for **Managed Identity – User Assigned** connections, as authentication and connectivity are handled through Azure identity-based access.
{% endhint %}

#### Authentication Type

The prerequisites vary depending on the authentication method selected for the SQL Server connection. To ensure a smooth and successful configuration, the required setup steps and supporting components are listed separately for each authentication type.

1. **SQL Server Authentication**
   1. A SQL Server login must exist and be active.
   2. The account must have access to the target database and required metadata objects.
   3. Ensure the SQL Server instance is configured to allow SQL Server Authentication.
2. **Windows Authentication**
   1. Windows Authentication requires additional native libraries depending on the OvalEdge release and JVM architecture.
   2. **For detailed file versions and download links, click** [**here**](https://docs.ovaledge.com/release8.0/connectors/connector-repositories/rdbms/microsoft-sql-server/external-supporting-files-for-windows-authentication)**.**
3. **Azure Active Directory – Password**
   1. Azure AD user credentials must be active and permitted for SQL access.
   2. Azure AD authentication must be enabled at the SQL endpoint.
   3. The account must have appropriate permissions in the target database.
4. **Managed Identity – User Assigned**
   1. A User Assigned Managed Identity must be created and assigned to the compute resource where OvalEdge or the Bridge/Plugin is running.
   2. The managed identity must be granted access to the SQL endpoint and required database objects.
   3. Required role assignments must be completed in Azure to allow token-based authentication.

{% hint style="info" %}
This authentication method is commonly used for Azure-hosted SQL endpoints such as Fabric Warehouse.
{% endhint %}

5. **Service Principal**
   1. An Azure AD App Registration (Service Principal) must be created.
   2. A valid client secret must be generated and available.
   3. The Service Principal must be granted appropriate database access and permissions.
   4. Tenant-level and resource-level access must be configured based on organizational security policies.

{% hint style="warning" %}
Ensure the Service Principal has access to the SQL endpoint and database objects required for metadata extraction and Data Quality execution.
{% endhint %}

{% hint style="info" %}
Service Principal authentication is supported for SQL endpoints where Azure AD application-based authentication is enabled, including Microsoft Fabric Warehouse.
{% 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" %}
&#x20;**👨‍💻Who can provide these permissions?** These permissions are typically granted by the Microsoft SQL Server administrator, as users may not have the required access to assign them independently.
{% endhint %}

<table><thead><tr><th width="172">Operation</th><th width="162">Objects</th><th width="331.25">System Tables</th><th width="174.666748046875">Access Permission</th></tr></thead><tbody><tr><td>Crawling &#x26; Profiling</td><td>Schema</td><td>sys.schemas</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Schema</td><td>extended_properties</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Tables</td><td>information_schema.tables</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Tables</td><td>fn_listextendedproperty</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Table Columns</td><td>sys.all_columns</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Table Columns</td><td>sys.types</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Table Columns</td><td>sys.views</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Table Columns</td><td>information_schema.columns</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Table Columns</td><td>information_schema.key_column_usage</td><td>SELECT</td></tr><tr><td>Crawling &#x26; Profiling</td><td>Table Columns</td><td>information_schema.table_constraints</td><td>SELECT</td></tr><tr><td>Crawling, Profiling &#x26; Lineage Building</td><td>Views</td><td>information_schema.views</td><td>View Definition</td></tr><tr><td>Crawling, Profiling &#x26; Lineage Building</td><td>Views</td><td>sys.objects</td><td>View Definition</td></tr><tr><td>Crawling &#x26; Lineage Building</td><td>Functions &#x26;<br>Stored Procedures Source code</td><td>information_schema.routines</td><td>View Definition</td></tr><tr><td>Crawling &#x26; Lineage Building</td><td>Functions &#x26;<br>Stored Procedures Source code</td><td>sys.sql_modules</td><td>View Definition</td></tr><tr><td>Crawling &#x26; Lineage Building</td><td>Functions &#x26;<br>Stored Procedures Source code</td><td>sys.extended_properties</td><td>View Definition</td></tr><tr><td>Crawling</td><td>Triggers</td><td>sys.objects</td><td>SELECT</td></tr><tr><td>Crawling</td><td>Triggers</td><td>sql_modules</td><td>SELECT</td></tr><tr><td>Crawling</td><td>Synonyms</td><td>sys.synonyms</td><td>SELECT</td></tr><tr><td>Crawling</td><td>Relationships</td><td>sys.foreign_keys</td><td>SELECT</td></tr><tr><td>Crawling</td><td>Indexes</td><td>on specified table</td><td>View Definition</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 into OvalEdge, go to **Administration > Connectors**, click **+ (New Connector)**, search for **Microsoft SQL Server**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="215.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "SQL Server" is displayed as the selected connector type.</td></tr><tr><td>Authentication</td><td><p>The following five types of authentication are supported for Microsoft SQL Server:</p><ul><li>SQL Server Authentication</li><li>Windows Authentication</li><li>Azure Active Directory - Password</li><li>Managed Identity - User Assigned</li><li>Service Principal</li></ul></td></tr></tbody></table>

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

<table><thead><tr><th width="220.25">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. The corresponding parameters will be displayed based on the selected option.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</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></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Microsoft SQL Server connection              </p><p>(Example: "SQL Server_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 Microsoft SQL server name or IP address (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.xxxxxws.com or xxx.xx8.x.10).</td></tr><tr><td>Port*</td><td>By default, the port number for the Microsoft SQL Server, "1433" is auto-populated. If required, the port number can be modified as per custom port number that is configured for the Microsoft SQL Server.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Microsoft SQL Server.</td></tr><tr><td>Driver*</td><td>By default, the Microsoft SQL Server driver details are auto-populated. </td></tr><tr><td>Username*</td><td>Enter the service account username set up to access the Microsoft SQL Server 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 Microsoft SQL Server 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="219">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>OvalEdge Installed Environment</td><td><p>Select the environment where the application 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. The corresponding parameters will be displayed based on the selected option.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><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></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Microsoft SQL Server connection              </p><p>(Example: "SQL Server_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 Microsoft SQL Server database server name or IP address (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.xxxxxnaxxws.com or 1xx.xxx.1.x0).</td></tr><tr><td>Port*</td><td>By default, the port number for the Microsoft SQL Server, "1433" is auto-populated. If required, the port number can be modified as per custom port number that is configured for the Microsoft SQL Server.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Microsoft SQL Server.</td></tr><tr><td>Domain</td><td>Enter the qualified Microsoft SQL Server domain name.<br><em><strong>Note</strong>: This field appears only when the installation environment is selected as <strong>Linux/Unix</strong>.</em></td></tr><tr><td>Driver*</td><td>By default, the Microsoft SQL Server driver details are auto-populated.</td></tr><tr><td>Username*</td><td>Enter the service account username set up to access the Microsoft SQL Server database (Example: "oesauser").<br><em><strong>Note</strong>: This field appears only when the installation environment is selected as <strong>Linux/Unix</strong>.</em></td></tr><tr><td>Password*</td><td>Enter the password associated with the service account user.<br><em><strong>Note</strong>: This field appears only when the installation environment is selected as <strong>Linux/Unix</strong>.</em></td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Microsoft SQL Server database:</p><ul><li><strong>Automatic Mode</strong>: The system generates a connection string based on the provided credentials.</li><li><strong>Manual Mode</strong>: 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.25">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. The corresponding parameters will be displayed based on the selected option.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><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></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Microsoft SQL Server connection              </p><p>(Example: "SQL Server_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 Microsoft SQL Server database server name or IP address (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.xxxxxnaws.com or 1xx.xxx.1.x0).</td></tr><tr><td>Port*</td><td>By default, the port number for the Microsoft SQL Server, "1433" is auto-populated. If required, the port number can be modified as per custom port number that is configured for the Microsoft SQL Server.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Microsoft SQL Server.</td></tr><tr><td>Driver*</td><td>By default, the Microsoft SQL Server driver details are auto-populated. </td></tr><tr><td>Username*</td><td>Enter the service account username set up to access the Microsoft SQL Server 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 Microsoft SQL Server 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="Managed Identity - User Assigned" %}

<table><thead><tr><th width="220.25">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. The corresponding parameters will be displayed based on the selected option.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><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></ul></td></tr><tr><td>Connector Name*</td><td>Enter a unique name for the Microsoft SQL Server connection (Example: "SQL Server_Prod").</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>Managed Identity Client Id*</td><td>Enter the <strong>Client ID</strong> of the User Assigned Managed Identity configured in Azure.</td></tr><tr><td>Server*</td><td>Enter the Microsoft SQL Server database server name or IP address (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.xxxxxnaws.com or 1xx.xxx.1.x0).</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Microsoft SQL Server.</td></tr><tr><td>Driver*</td><td>By default, the Microsoft SQL Server driver details are auto-populated. </td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Microsoft SQL Server 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="Service Principal" %}

<table><thead><tr><th width="220.25">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. The corresponding parameters will be displayed based on the selected option.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><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></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Microsoft SQL Server connection              </p><p>(Example: "SQL Server_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 Microsoft SQL Server database server name or IP address (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.xxxxxnaws.com or 1xx.xxx.1.x0).</td></tr><tr><td>Port*</td><td>By default, the port number for the Microsoft SQL Server, "1433" is auto-populated. If required, the port number can be modified as per custom port number that is configured for the Microsoft SQL Server.</td></tr><tr><td>Database*</td><td>Enter the database name to which the service account user has access within the Microsoft SQL Server.</td></tr><tr><td>Client Id*</td><td>Enter the Azure AD Application (Service Principal) <strong>Client ID</strong> used for authentication.</td></tr><tr><td>Client Secret*</td><td>Enter the <strong>Client Secret</strong> associated with the Azure AD application.</td></tr><tr><td>Tenant ID*</td><td>Enter the Azure AD <strong>Tenant ID</strong> where the Service Principal is registered.</td></tr><tr><td>Driver*</td><td>By default, the Microsoft SQL Server driver details are auto-populated. </td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Microsoft SQL Server 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="225.25"></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 configured in the security settings are available for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="225.25"></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 the security settings are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="225.25"></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><strong>Example</strong>: 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="225.25"></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 that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to 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.&#x20;

1. Navigate to the **Connectors page** and click **Crawl/Profile**.
2. Select the schemas to crawl.
3. The **Crawl** option is selected by default. To perform both operations, select the **Crawl & Profile** radio button.
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 interval 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 the 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 databases, tables, columns, and codes.

#### 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.
  * **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.

## 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="80.25">S. No.</th><th width="215.75">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating connection: Exception occurred while validating in SQL Server Connection: Failed to obtain JDBC Connection; nested exception is com.microsoft.sqlserver.xxx.SQxxxxrException: Login failed for user 'xxxxx'. ClientConnectionId: 9xxxxx2-6xxx-4xx2-xx13-xxxx846xx</td><td><p><strong>Error Description:</strong></p><p>Either username and password might be wrong.</p><p><strong>Resolution</strong>:</p><ul><li>Ensure the correct username and password are entered in the setup form.</li><li>Verify the username format.</li><li>Confirm the user account is active.</li></ul></td></tr><tr><td>2</td><td><p>invalid DB</p><p>Error while validating connection. Error:Exception occured while validating in SQL Server Connection: Failed to obtain JDBC Connection; nested exception is com.microsoft.sqlserver.xxx.SQLxxxException: Cannot open database "xxx" requested by the login. The login failed. ClientConnectionId:1xxxxx7a- xxxa-4xx9-bxxx-xxxxxx6bxxx7</p></td><td><p><strong>Error Description</strong>:</p><p>The database name provided is invalid.</p><p><strong>Resolution</strong>:</p><ul><li>The Database Name field in the setup form contains an incorrect value.</li><li>Ensure that the database name is correctly spelled and exists in the target system.</li></ul></td></tr><tr><td>3</td><td>The TCP/IP connection to the host <code>&#x3C;HOSTNAME></code>, port 1433 has failed. Error: "connect timed out. Verify the connection properties."</td><td><p><strong>Error Description:</strong><br>The SQL Server host is not reachable from OvalEdge. This typically occurs due to incorrect hostname/port, firewall restrictions, network routing issues, or SQL Server not running.<br><strong>Resolution:</strong></p><ul><li>Verify the server hostname/IP address is correct.</li><li>Confirm the port number is correct (default is 1433).</li><li>Ensure SQL Server service is running and listening on the configured port.</li><li>Check firewall/security group rules to ensure the port is allowed.</li><li>Test connectivity using SSMS or run <code>telnet &#x3C;host> 1433</code> from the OvalEdge server.</li></ul></td></tr><tr><td>4</td><td>Login failed for user 'test_user'. User does not have permission to perform this action.</td><td><p><strong>Error Description:</strong><br>The login credentials are incorrect, or the user does not have sufficient permissions to access the database objects required for crawling and profiling.<br><strong>Resolution:</strong></p><ul><li>Verify the username and password are correct.</li><li>Ensure the account is active and not locked.</li><li>Confirm the user has required permissions such as SELECT and VIEW DEFINITION.</li><li>For Windows/AD Authentication, ensure the environment and domain configuration are correct.</li><li>Validate access by logging into SQL Server using SSMS with the same credentials.</li></ul></td></tr><tr><td>5</td><td>Invalid object name 'sys.masked_columns'.</td><td><p><strong>Error Description:</strong><br>The system view <code>sys.masked_columns</code> is not available in the connected SQL Server version, or the environment does not support that metadata object.<br><strong>Resolution:</strong></p><ul><li>Verify the SQL Server version supports the required system views (example: <code>sys.masked_columns</code> is supported in SQL Server 2016 and later).</li><li>Confirm that the object name is correct and not misspelled.</li><li>If connecting to Azure SQL or other SQL-based platforms, verify whether the system view is supported in that environment.</li></ul></td></tr><tr><td>6</td><td>Cannot find the object 'sp_myproc' because it does not exist or you do not have permissions.</td><td><p><strong>Error Description:</strong><br>The stored procedure or function does not exist in the selected database, or the user does not have permission to view its definition.<br><strong>Resolution:</strong></p><ul><li>Confirm the stored procedure exists in the expected database and schema.</li><li>Verify the procedure name and spelling are correct.</li><li>Ensure the service account has permission to access the procedure metadata.</li><li>Grant VIEW DEFINITION permission if required.</li><li>Validate object availability using SSMS.</li></ul></td></tr><tr><td>7</td><td>Could not get JDBC Connection; nested exception is java.sql.SQLException: The TCP/IP connection to the host ..</td><td><p><strong>Error Description:</strong><br>The JDBC driver is unable to establish a connection to SQL Server. This can occur due to network issues, incorrect connection details, authentication failure, or driver compatibility issues.<br><strong>Resolution:</strong></p><ul><li>Verify the server name, database name, and port are correct.</li><li>Ensure the SQL Server instance is online and reachable.</li><li>Confirm authentication credentials and permissions are valid.</li><li>Review application logs for detailed failure information.</li><li>Upgrade the JDBC driver if required, especially when connecting to newer SQL Server versions or cloud-based SQL endpoints.</li></ul></td></tr></tbody></table>

***

&#x20;Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA