Microsoft SQL ServerV2
OvalEdge uses Java Database Connectivity (JDBC) to connect to SQL ServerV2, which allows it to crawl and profile data objects (Tables, Table Columns, etc.) and build Lineage.
SQL ServerV2 vs. SQL Server
This is a Case-sensitive database.
Example: Ignores case differences in identifiers and data during comparisons.
For example, SELECT * FROM MyTable and SELECT * FROM mytable would be treated the same.
This is a Case-insensitive database.
Example: Distinguishes between uppercase and lowercase letters in identifiers (like table names and column names) and data.
For example, SELECT * FROM MyTable and SELECT * FROM mytable would be treated as separate queries if the database is case-sensitive.
Overview
Connector Details
Connector Category
RDBMS System
Connector Version
6.3.4
OvalEdge Releases Supported (Available from)
Release4.3 onwards
Connectivity
[How OvalEdge connects to SQL Server ]
JDBC
SQL Server Versions Verified
SQL Server 2019
Note: The SQL Server connector has been verified internally with SQL Server 2019 and is expected to be compatible with other supported SQL Server versions. If you have any issues with different SQL Server versions, please contact CSM.
Connector Features
Crawling
✅
Delta Crawl
❌
Profiling
✅
Query Sheet
✅
Data Preview
✅
Auto Lineage
✅
Manual Lineage
✅
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 SQL Server and OvalEdge:
Service Account User Permissions
We recommend having a separate service account to establish a connection from OvalEdge to the data source with the following minimal set of permissions.
Operation
Access Permission
Connection Validation
SELECT
Crawl Schemas
SELECT
Crawl Tables
SELECT
Profile Schemas, Tables
SELECT
Lineage Building
View DEFINITION
View Source Code
View DEFINITION
Relationships
REFERENCES
Please refer to Appendix A for guidelines on creating a service account with the required permissions.
Setup a Connection
Important: You must have the Connector Creator role to set up a connection in OvalEdge.
Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for SQL Server, and complete the specific parameters.
Note: Fields marked with an asterisk (*) are mandatory for establishing a connection.
Field Name
Description
Connector Type
By default, "SQL Server" is displayed as the selected connector type.
Connector Settings
Authentication
OvalEdge supports the following three types of authentication for SQL Server:
SQL Server Authentication
Windows Authentication
Azure Active Directory - Password
OvalEdge Installed Environment
Select the installed environment from the drop-down list:
Options:
Linux/Unix
Windows
Note: This Field is available when the Authentication mechanism is selected as "Windows Authentication." This field refers to where the OvalEdge application is installed.
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
Not 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.
Auto Lineage
Supported
Data Quality
Supported
Data Access
Not Supported
Connector Name*
Enter a unique name for the SQL Server connection
(Example: "SQL Server_Prod").
Connector Environment
Select the environment (Example: PROD, STG) configured for the connector.
Server*
Enter the SQL Server database Server name or IP address (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.amazonaws.com or 192.168.1.10).
Port*
By default, the port number for the SQL Server database "1433" is auto-populated. If necessary, you can change this to a different port number.
Database*
Enter the database name to which the service account user has access within the SQL Server.
Domain
Enter the Qualified SQLServer Domain name.
Note: This field is available when the authentication mechanism is set to Windows Authentication, and the OvalEdge installed environment is Linux.
Driver*
By default, the SQL Server driver details
(Example: com.microsoft.sqlserver.jdbc.SQLServerDriver) are auto-populated. OvalEdge artifacts include the required drivers for supported databases.
Username*
Enter the service account username set up to access the SQL Server database (Example: "oesauser").
Password*
Enter the password associated with the service account user (Example: "password").
Connection String
Configure the connection string for the SQL Server database:
Automatic Mode: The system generates a connection string based on the provided credentials.
Example (SQL Server):
jdbc:sqlserver://{server}:1433;database={sid}
Manual Mode: Manually enter a valid connection string.
Example (SQL Server): jdbc:sqlserver://{server}:{Port};database={sid}
Replace placeholders with actual database details.
{sid} refers to Database Name
After entering all connection details, you can perform the following actions:
Click Validate to verify the connection.
Click Save to store the connection for future use.
Click Save & Configure to apply additional settings before saving.
The saved connection will appear on the Connectors home page.
Connectivity Troubleshooting
If incorrect parameters are provided, you may encounter error messages. To resolve these issues, ensure all input is correct. If problems persist, contact your assigned OvalEdge support team.
S.No.
Error Message(s)
Error Description / Resolution
1
Login failed for user. ClientConnectionId:xxx
Error Description:
Either username and password might be wrong.
Resolution:
You provided an incorrect username or password in the setup form's User or Password fields or formatted the User field value incorrectly.
The authorizing user has the permission required to connect the database to ovaledge.
The authorizing user is not locked out of their account or required to reset their password.
2
SQLServerException: Login failed for user.
Error Description: This issue occurs when the authorized user's password has expired or must be changed due to SQL Server's password policy.
Resolution: In SQL Server, change the password for the user referenced in the error message. For more information, see Microsoft's Alter Login documentation.
Manage Connector Operations
Crawl/Profile
Important: You must have the Integration Admin role in OvalEdge for crawl/profile operations.
A Crawl/Profile button allows you to select one or more schemas for crawling.
Navigate to the Connectors page and click Crawl/Profile. It allows you to select the schemas that need to be crawled.
The crawl option is selected by default.
Click on the Run button, which gathers all metadata from the connected source and puts it into the OvalEdge Data Catalog. After a successful crawl, all the information is displayed in the Data Catalog > Databases tab.
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 with a green (active) or red (inactive) icon, helping monitor data flow and address issues early.
Viewing: Shows connector details (e.g., Databases, Tables, Table Columns, Codes, etc) via the View icon.
Nine Dots Menu Options:
You can view, edit, validate, 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 that needs to be extracted.
Profiler: Customize data profiling rules and methods.
Query Policies: Define rules for executing queries based on roles.
Access Instructions: Specify how data can be accessed as a note.
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 connectors with confirmation.
Metadata Mapping
Source Object Name
OvaEdge Data Object
OvalEdge Data Object Type
Schemas
Schemas
-
Tables
Tables
Table
Columns
Columns
Column
Views
Tables
View
Functions
Codes
Function
Triggers
Codes
Trigger
Stored Procedures
Codes
Procedure
Limitations
S.No.
Description
Crawling
Not supporting SSH tunneling in SQL Server
Profiling
-
Lineage
-
Data Quality
NA
Data Preview
-
Appendix A
Please refer to the below sample queries to create a service account user and grant the required permissions. For more information, please refer to the SQL Server documentation or Consult your SQL Server DBA to check and execute these queries.
Create a SQL Server Login and a database user.
CREATE LOGIN <<Loginname>> WITH PASSWORD = '<<password>>';
CREATE USER <<username>> FOR LOGIN <<Loginname>>;
Grant Connection Permission.
GRANT CONNECT TO <<username>>;
Grant SELECT Permission on the Schema.
GRANT SELECT ON SCHEMA::<<schemaname>> TO <<username>>;
Grant REFERENCES Permission.
GRANT REFERENCES TO <<username>>;
Grant VIEW DEFINITION Permission.
GRANT VIEW DEFINITION TO <<username>>;
Last updated
Was this helpful?

