Microsoft SQL Server Integration Services
This document outlines the integration with the Microsoft SQL Server Integration Services (SSIS) connector, enabling streamlined metadata management through features such as crawling and lineage building (both automatic and manual). It also ensures secure authentication via Credential Manager.

Overview
Connector Details
Connector Category
ETL
Connector Version
Release6.3.4
Releases Supported (Available from)
Release5.1
Connectivity
[How the connection is established with SSIS]
NFS file source/S3
Verified SSIS Version
4
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
✅
Metadata Mapping
The following objects are crawled from SSIS and mapped to the corresponding UI assets.
Folder
Folder Name
Code Name
Codes
SSIS_Folder
Projects
Project Name
Code Name
Codes
SSIS_Project
Package
-
-
Codes
SSIS_Package
Dataflow
-
-
Codes
SSIS_Dataflow
SSIS_SQLs
-
-
Codes
SSIS_SQLs
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 SSIS database.
The default port number for the SSIS data source 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 the SSIS data source 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.
Crawling
Folders
Read only
Crawling
Projects
Read only
Crawling
Packages
Read only
Connection Configuration Steps
Users are required to have the Connector Creator role in order to configure a new connection.
Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for SSIS, and complete the required parameters.
Connector Type
By default, "SSIS" is displayed as the selected connector type.
Credential Manager*
Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.
Supported Credential Managers:
OE Credential Manager
AWS Secrets Manager
HashiCorp
Azure Key Vault
System Source*
Select the type of System Source from the dropdown menu.
File Authentication
Database Authentication
License Add Ons
Auto Lineage
Supported
Data Quality
Not Supported
Data Access
Not Supported
Select the checkbox for the Auto Lineage Add-On to build data lineage automatically.
Connector Name*
Enter a unique name for the SSIS connection
(Example: "SSISdb").
Connector Environment
Select the environment (Example: PROD, STG) configured for the connector.
Connector Description
Enter a brief description of the connector.
SSIS Path*
Enter the folder path where SSIS packages are stored.
Authentication*
Select the type of Authentication from the dropdown menu.
SQL Server Authentication
Windows Authentication
License Add Ons
Auto Lineage
Supported
Data Quality
Not Supported
Data Access
Not Supported
Select the checkbox for the Auto Lineage Add-On to build data lineage automatically.
Connector Name*
Enter a unique name for the SSIS connection
(Example: "SSISdb").
Connector Environment
Select the environment (Example: PROD, STG) configured for the connector.
Connector Description
Enter a brief description of the connector.
Server*
Enter the server name or IP address of the SSIS database. (Example: 6grt-sxxxxxx.xxxx4ijxxxl.xx-xyz-1.rxs.xxxxx.com or 1xx.xyz.1.xx).
Port*
By default, the port number for SSIS, "1433" is auto-populated. If required, the port number can be modified according to the custom port number configured for the SSIS Database.
Database*
Enter the user-defined database name for the SSIS connection to crawl metadata.
Driver*
By default, the SSIS driver details are auto-populated.
Username*
Enter the username required to access the SQL Server database (Example: "oesauser").
Note: This field is available only when the authentication method is "SQL Server Authentication".
Password*
Enter the password associated with the provided username to access the SQL Server database.
Note: This field is available only when the authentication method is "SQL Server Authentication".
SSIS Login Username*
Enter the username used to log in to the SSIS machine.
SSIS Login Password*
Enter the password associated with the SSIS Login Username.
Machine Package Path*
Enter the machine path for package downloads.
Connection String
Configure the connection string for the SSIS 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 the Database Name.
Note: This field is available only when the System Source is set to "Database Authentication".
Plugin Server
Enter the server name when running this as a plugin.
Plugin Port
Enter the port number on which the plugin is running.
Default Governance Roles
Default Governance Roles*
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.
Admin Roles
Admin Roles*
Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in the security settings 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 that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.
After entering all connection details, the following actions can be performed:
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.
Manage Connector Operations
Crawl
To perform crawl operations, users must be assigned the Integration Admin role.
The Crawl/Profile button allows users to select one or more schemas for crawling.
Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to be crawled.
The Crawl option is selected by default.
Click Run to collect metadata from the connected source and load it into the Data Catalog.
After a successful crawl, the information appears in the Data Catalog > Databases/<>Codes tab.
The Schedule checkbox allows automated crawling at defined intervals, from a minute to a year.
Click the Schedule checkbox to enable the Select Period drop-down.
Select a time period for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
The system will automatically execute the crawl operation 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:
Connector 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.
Lineage: Select server dialects for parsing and setting connector priority for table lineage.
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.
1
Error while validating connection: Please provide valid path
Description:
Error occurs during connection validation due to an incorrect or invalid SSIS path.
Resolution:
Verify and update the SSIS path with the correct, valid directory before revalidating the connection.
Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA
Last updated
Was this helpful?

