# Microsoft SQL Server Integration Services

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). The connector supports integration by accessing SSIS project and package files from a shared network folder and retrieving additional metadata from the SSIS catalog database. 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%2FT8pNMRsf724w57iEoK0A%2Fimage.png?alt=media&#x26;token=3b3595dd-7fcb-4c09-924b-5ba39a3c4184" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                       | ETL Tool                                                         |
| ------------------------------------------------------------------------ | ---------------------------------------------------------------- |
| OvalEdge Release Supported                                               | Release5.1 and later                                             |
| <p>Connectivity</p><p>\[How the connection is established with SSIS]</p> | File System (Shared Network Folder Path) and SQL Server Database |
| Verified SSIS Version                                                    | 4                                                                |

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

{% hint style="info" %}
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.
{% 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 SSIS and mapped to the corresponding UI assets.

<table><thead><tr><th width="152.75">SSIS Object</th><th width="154.25">SSIS Attribute</th><th width="188.25">OvalEdge Attribute</th><th width="170.5">OvaEdge Category</th><th width="180.5">OvalEdge Type</th></tr></thead><tbody><tr><td>Folder</td><td>Folder Name</td><td>Code Name</td><td>Codes</td><td>SSIS_Folder</td></tr><tr><td>Projects</td><td>Project Name</td><td>Code Name</td><td>Codes</td><td>SSIS_Project</td></tr><tr><td>Package</td><td>-</td><td>-</td><td>Codes</td><td>SSIS_Package</td></tr><tr><td>Dataflow</td><td>-</td><td>-</td><td>Codes</td><td>SSIS_Dataflow</td></tr><tr><td>SSIS_SQLs</td><td>-</td><td>-</td><td>Codes</td><td>SSIS_SQLs</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

The SSIS connector requires access to both:

* A **shared file system location** (for SSIS package/project files)
* The **SQL Server SSIS catalog database** (for metadata queries)

#### File System Access Prerequisites

Ensure the OvalEdge server can access the shared folder where SSIS projects/packages are stored.

* The shared folder path must be accessible from the OvalEdge server.
* Required read permissions must be granted on the shared directory.

#### Database Connectivity Prerequisites

**Whitelisting Ports**

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

{% hint style="warning" %}
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.
{% 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 SSIS administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operations | Objects  | Required Permission |
| ---------- | -------- | ------------------- |
| Crawling   | Folders  | db\_datareader      |
| Crawling   | Projects | db\_datareader      |
| Crawling   | Packages | db\_datareader      |

{% hint style="info" %}
The db\_datareader role is the minimum recommended SQL Server database role required to execute SSIS catalog queries and retrieve metadata for crawling.
{% endhint %}

### 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 **SSIS**, 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="220.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "SSIS" is displayed as the selected connector type.</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 the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul></td></tr><tr><td>System Source*</td><td><p>Select the type of System Source from the dropdown menu.</p><ul><li>File Authentication</li><li>Database Authentication</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="File Authentication" %}

<table><thead><tr><th width="192.75">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for the Auto Lineage Add-On to build data lineage automatically.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the SSIS connection              </p><p>(Example: "SSISDB").</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>SSIS Path*</td><td>Enter the folder path where SSIS packages are stored.</td></tr></tbody></table>
{% endtab %}

{% tab title="Database Authentication" %}

<table><thead><tr><th width="195.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Authentication*</td><td><p>Select the type of Authentication from the dropdown menu.</p><ul><li>SQL Server Authentication</li><li>Windows Authentication</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for the Auto Lineage Add-On to build data lineage automatically.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the SSIS connection              </p><p>(Example: "SSISDB").</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 server name or IP address of the SSIS database. (Example: 6grt-sxxxxxx.xxxx4ijxxxl.xx-xyz-1.rxs.xxxxx.com or 1xx.xyz.1.xx).</td></tr><tr><td>Port*</td><td>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.</td></tr><tr><td>Database*</td><td>Enter the user-defined database name for the SSIS connection to crawl metadata.</td></tr><tr><td>Driver*</td><td>By default, the SSIS driver details are auto-populated.</td></tr><tr><td>Username*</td><td><p>Enter the username required to access the SQL Server database (Example: "oesauser").</p><p><em><strong>Note</strong>: This field is available only when the authentication method is "<strong>SQL Server Authentication</strong>".</em></p></td></tr><tr><td>Password*</td><td><p>Enter the password associated with the provided username to access the SQL Server database.</p><p><em><strong>Note</strong>: This field is available only when the authentication method is "<strong>SQL Server Authentication</strong>".</em></p></td></tr><tr><td>SSIS Login Username*</td><td>Enter the username used to log in to the SSIS machine.</td></tr><tr><td>SSIS Login Password*</td><td>Enter the password associated with the SSIS Login Username.</td></tr><tr><td>Machine Package Path*</td><td>Enter the machine path for package downloads.</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the SSIS 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 the Database Name.</p><p>Note: This field is available only when the System Source is set to "Database Authentication".</p></td></tr><tr><td>Plugin Server</td><td>Enter the server name when running this as a plugin.</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="220.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="220.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="219"></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.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

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

The **Crawl/Profile** button allows users to select one or more schemas for crawling.

1. Navigate to the Connectors page and click **Crawl/Profile**.
2. Select the schemas to be crawled.
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, 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.

<table><thead><tr><th width="84">S.No.</th><th width="244.5">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating connection: Please provide valid path</td><td><p><strong>Description:</strong></p><p>Error occurs during connection validation due to an incorrect or invalid SSIS path.</p><p><strong>Resolution:</strong></p><p>Verify and update the SSIS path with the correct, valid directory before revalidating the connection.</p></td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA