For the complete documentation index, see llms.txt. This page is also available as Markdown.

Microsoft SQL Server Integration Services (SSIS)

This article 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).

This connector integrates with SSIS project and package files stored in a shared network folder and the SQL Server SSIS catalog database to retrieve metadata required for crawling and lineage generation. It accesses the shared network folder using read permissions and authenticates to the SSIS catalog database using SQL Server database credentials.

Overview

Connector Details

Connector Category

ETL Tool

OvalEdge Release Supported

Release5.1 and later

Connectivity

[How the connection is established with SSIS]

Database Authentication (JDBC) / File Authentication (NFS)

Verified SSIS Version

4

The SSIS connector reads SSIS project and package files from a shared network folder accessible to the OvalEdge server. In addition, it connects to the SSIS catalog database (SQL Server) to retrieve metadata required for crawling and lineage generation.

The Microsoft SQL Server Integration Services (SSIS) connector has been validated with the mentioned "Verified SSIS Versions" and is expected to be compatible with other supported SSIS 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

✅ To learn more, click here

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.

SSIS Object
SSIS Attribute
OvalEdge Attribute
OvaEdge Category
OvalEdge Type

Folder

Folder Name

Code Name

Codes

SSIS_Folder

Projects

Project Name

Code Name

Codes

SSIS_Project

Package

Package Name

Code Name

Codes

SSIS_Package

Dataflow

Dataflow Component

Code Name

Codes

SSIS_Dataflow

SQL

SQL inside Dataflow component

Code Name

Codes

SSIS_SQL

Set up a Connection

Prerequisites

The following access must be configured before establishing a connection.

  • Shared Network Folder Access

  • SQL Server SSIS Catalog Database Access

Shared Network Folder Access

The SSIS project and package files must be stored in a shared network folder that is accessible from the OvalEdge server.

  • The shared folder path must be accessible from the OvalEdge server.

  • Verify that the configured shared folder path is valid.

  • Required read permissions must be granted on the shared directory.

SQL Server SSIS Catalog Database Access

Whitelisting Ports

Make sure that inbound port “1433” is whitelisted to enable successful connectivity with the SSIS database.

Service Account User Permissions

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

Operations
Objects
Access Permissions

Crawling

Datasets

  • File Authentication READ permission on the provided path.

  • Database Authentication SELECT permission on the respective tables, with the db_datareader role assigned.

The db_datareader role is the minimum recommended SQL Server database role required to execute SSIS catalog queries and retrieve metadata for crawling.

Connection Configuration Steps

  1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for SSIS, and complete the required parameters.

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

Field Name
Description

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

For more details, click here.

System Source*

Select the type of System Source from the dropdown menu.

  • File Authentication

  • Database Authentication

Field Name
Description

License Add Ons

Select the checkbox for the Auto Lineage Add-On to build data lineage automatically. For more details, click here.

Connector Name*

Enter a unique name for the SSIS connection

(Example: "SSISDB").

Connector Environment

Select the environment (Example: PROD, STG) configured for the connector. For more details, click here.

Connector Description

Enter a brief description of the connector.

SSIS Path*

Enter the folder path where SSIS packages are stored.

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.

  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

The Crawl/Profile button allows users to select one or more data objects for crawling.

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

  2. Select the data objects to crawl.

  3. The Crawl option is selected by default.

  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/<>Codes tab.

The Schedule checkbox allows automated crawling 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 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.

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.

For more details on connector settings, click here.

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 connection: Please provide valid path

Description:

An 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.

2

Invalid Path Provided

Description:

The specified shared network folder path is invalid, inaccessible, or cannot be reached.

Resolution:

  • Verify that the shared network folder path is correct.

  • Ensure the path is accessible.

  • Confirm that the required read permissions are granted on the shared folder.

3

Authentication Failed

Description:

The connector could not authenticate to the SQL Server SSIS catalog database using the provided credentials.

Resolution:

  • Verify that the SQL Server credentials are correct.

  • Ensure the account has access to the SSIS catalog database.

  • Confirm that the required permissions, including the db_datareader role, are assigned.


Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA

Last updated

Was this helpful?