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

Microsoft SQL Server Reporting Services (SSRS)

This article outlines the integration with the Microsoft SQL Server Reporting Services (SSRS) connector, enabling streamlined metadata management through features such as crawling, report preview, and lineage building (Auto and Manual). It also ensures secure authentication via Credential Manager.

The connector supports multiple authentication methods, including SQL Server Authentication, File Authentication, and Windows Authentication, to establish secure connectivity with Microsoft SQL Server Reporting Services.

Overview

Connector Details

Connector Category

Reporting Tools

OvalEdge Release Supported

Release7.2 and later

Connectivity

[How the connection is established with Microsoft SQL Server Reporting Services]

JDBC

Verified Microsoft SQL Server Reporting Services Versions

7.1.4.jre8-preview

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

NA

Query Sheet

NA

Report Preview

✅

Auto Lineage

✅ To learn more, click here.

Manual Lineage

✅

Secure Authentication via Credential Manager

✅

Data Quality

❌

DAM (Data Access Management)

❌

'NA' indicates that the respective feature is 'Not Applicable.'

Metadata Mapping

The following objects are crawled from Microsoft SQL Server Reporting Services and mapped to the corresponding UI assets.

SSRS Object
SSRS Attribute
OvalEdge Attribute
OvalEdge Category
SSRS

Folder [Database]

Catalog.Name

Report Group

Reports

Folder [Database]

Folder [Database]

Catalog.Description

Source Description

Descriptions

Folder [Database]

Folder [File]

Name: Child Directory Name Under Base SSRS Path

Report Group

Report

Folder [File]

Report

Last Segment of Catalog.Path

Reports

Report

Report Name

Report

Literal “Report”

Report Type

Report

Report

Report [File]

.RDL Filename

Reports

Report

Report Name

Report [File]

“Report”

Report Type

Report

Report

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Authentication Type

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

  1. File Authentication

    1. Ensure the OvalEdge server can access the shared folder where SSRS File/Report are stored.

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

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

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

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

Database Connectivity Prerequisites

Whitelisting Ports

  • Whitelist the required SQL Server and SSRS Web Service ports to allow communication between OvalEdge and Microsoft SQL Server Reporting Services. Ensure the SSRS Web Service URL / Web Portal URL is accessible from the OvalEdge application server.

Service Account User Permissions

👨‍💻 Who can provide these permissions? The Microsoft SQL Server Reporting Services administrator grants these permissions, since users may not have sufficient access to assign them.

Objects
Permissions

Connector Validation

DB mode: SQL Server login or Windows Integrated Security to ReportServer DB; Network access to SQL Server. File mode: Read access to SSRS NFS path.

Crawling

DB mode: Select on {sid}.dbo.Catalog; File mode: read/execute on SSRS base path

Lineage

DB mode: Select on {sid}.dbo.Catalog; File mode: read .rdl/.rsd files

Delta Crawl

DB: Select on {sid}.dbo.Catalog (ModifiedDate).

Domains (Folders)

DB mode: Select on {sid}.dbo.Catalog. File mode: read directories under SSRS base path.

Reports (Under Domain)

Select on {sid}.dbo.Catalog

Report Fields

Select on {sid}.dbo.Catalog (RDL content) or file read (.rdl)

Source Code – RDL

Select on {sid}.dbo.Catalog or file read (.RDL)

Source Code – Datasets (RSD)

Select on {sid}.dbo.Catalog or file read (.RSD)

Connection Configuration Steps

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

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

Field Name
Description

Connector Type

By default, "Microsoft SQL Server Reporting Services" is displayed as the selected connector type.

Authentication

The following three types of authentication are supported for Microsoft SQL Server Reporting Services:

  • Sql Server Authentication

  • Windows Authentication

  • File Authentication

Field Name
Description

Credential Manager*

Select the desired credential 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.

License Add-On

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

Connector Name*

Enter a unique name for the Microsoft SQL Server Reporting Services connection.

(Example: "SSRS_Prod").

Connector Environment

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

Connector Description

Enter the description related to the connector.

Host Name*

Enter the host name or IP address of the server where Microsoft SQL Server Reporting Services (SSRS) is installed.

Port*

Enter the port number used by the Microsoft SQL Server Reporting Services instance for communication.

SID*

Enter the unique Security Identifier (SID) associated with the SQL Server Reporting Services (SSRS) instance.

SSRS Web Port

Enter the port number configured for the SSRS Web Service. This value ensures the connector can communicate with the SSRS web endpoint.

SSRS Web URL*

Enter the Web Portal URL of the SSRS server, typically in the format http://<server-name>/Reports or https://<server-name>/Reports. Ensure the URL is accessible and corresponds to the deployed SSRS instance.

Connection String*

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 server details:

  • {server} refers to the SQL Server Reporting Services host or IP address.

  • {sid} refers to the SSRS catalog database name (typically ReportServer or ReportServerTempDB).

Authentication Plugins:

jdbc:sqlserver://{server}:{port};database={sid};integratedSecurity=true

This is the default authentication string used for connecting to the SSRS database.

Username*

Enter the SQL Server account name or domain user name with access to the Reporting Services instance.

Is WebService URL (Y/N)*)

Enter the value to ‘Y’ for a Web Service URL or ‘N’ for a standard Report Manager URL.

Password*

Enter the password associated with the specified SQL Server Reporting Services account used for authentication.

Driver*

By default, SSRS uses ‘com.microsoft.sqlserver.jdbc.SQLServerDriver.’ This field is not editable.

Field Name
Description

Credential Manager*

Select the desired credential 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.

License Add-On

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

Connector Name*

Enter a unique name for the Microsoft SQL Server Reporting Services connection.

(Example: "SSRS_Prod").

Connector Environment

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

Connector Description

Enter the description related to the connector.

Host Name*

Enter the host name or IP address of the server where Microsoft SQL Server Reporting Services (SSRS) is installed.

Port*

Enter the port number used by the Microsoft SQL Server Reporting Services instance for communication.

SID*

Enter the unique Security Identifier (SID) associated with the SQL Server Reporting Services (SSRS) instance.

Domain

Enter the Windows domain associated with the SSRS server credentials.

Note: This field appears only when the installation environment is selected as Linux/Unix.

SSRS Web Port

Enter the port number configured for the SSRS Web Service. This value ensures the connector can communicate with the SSRS web endpoint.

SSRS Web URL*

Enter the Web Portal URL of the SSRS server, typically in the format http://<server-name>/Reports or https://<server-name>/Reports. Ensure the URL is accessible and corresponds to the deployed SSRS instance.

Connection String*

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 server details:

  • {server} refers to the SQL Server Reporting Services host or IP address.

  • {sid} refers to the SSRS catalog database name (typically ReportServer or ReportServerTempDB).

Authentication Plugins:

jdbc:sqlserver://{server}:{port};database={sid};integratedSecurity=true

This is the default authentication string used for connecting to the SSRS database.

Username*

Enter the SQL Server account name or domain user name with access to the Reporting Services instance.

Note: This field appears only when the installation environment is selected as Linux/Unix.

Is WebService URL (Y/N)*)

Enter the value to ‘Y’ for a Web Service URL or ‘N’ for a standard Report Manager URL.

Password*

Enter the password associated with the specified SQL Server Reporting Services account used for authentication.

Note: This field appears only when the installation environment is selected as Linux/Unix.

Driver*

By default, SSRS uses ‘com.microsoft.sqlserver.jdbc.SQLServerDriver.’ This field is not editable.

Field Name
Description

Credential Manager*

Select the desired credential 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.

License Add-On

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

Connector Name*

Enter a unique name for the Microsoft SQL Server Reporting Services connection.

(Example: "SSRS_Prod").

Connector Environment

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

Connector Description

Enter the description related to the connector.

SSRS File Path*

Enter the full file path or network location of the SSRS report file (.rdl) to be accessed by the connector. The path should point to the directory where the SSRS reports 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 and teams configured in OvalEdge Security are displayed 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 OvalEdge Security 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 configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering 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

To perform a crawl operation, users must be assigned the Integration Admin role.

The Crawl/Profile button allows users to select one or more reports/report groups for crawling.

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

  2. Select the reports/report groups to crawl.

  3. Click Run to collect metadata from the connected source and load it into the Data Catalog.

  4. After a successful crawl, the information appears in the Data Catalog > Report / Report Column tab.

The Schedule checkbox allows automated crawling for a selected timeframe, 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 and their health status.

Managing connectors includes:

  • Connector Health: Displays the current status of each connector, with a green icon for active connections and a red icon for inactive connections, helping monitor connectivity to 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 integrity of the connection.

  • Settings: Modify connector settings.

    • Crawler: Configure data extraction.

    • Access Instructions: Add notes on how data can be accessed.

    • Business Glossary Settings: Manage term associations at the connector level.

    • Lineage: Configure Server Dialects for source code parsing and Connector Priority for table lineage connection. For more details, click here.

    • Others: Configure notification recipients for metadata changes.

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

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
Error Description & Resolution

1

Error while validating connection: unable to authenticate with SQL server login

The SQL login user provided for SQL Server authentication is either incorrect or does not have the required access to the report server database.

Resolution:

  • Confirm the SQL login username and password entered are correct.

  • Confirm the SQL login has SELECT permission granted on the report server database catalog table.

  • Create a dedicated SQL login for this connection if no suitable existing account is available.

2

Error while validating connection: Windows authentication failed

The domain or Active Directory account used for Windows authentication does not have the required database-level access on the report server.

Resolution:

  • Confirm the domain account entered is valid and active in Active Directory.

  • Confirm the account has been granted SELECT permission on the report server and the report server temp DB, under the default DBO schema.

  • Retry validation once the required access has been confirmed.

3

Connection details appear correct but validation still fails

Incorrect values entered for the host name, user name, password, or port most commonly produce a direct validation error, distinct from issues related to the report preview fields.

Resolution:

  • Confirm the host name, username, password, and port entered are all accurate.

  • Confirm network connectivity exists between the application and the SQL server hosting the report server database.

  • Confirm the required web service port has been whitelisted to permit communication for metadata extraction.

4

Report preview does not load after a successful connection validation

The SSRS Web URL is used to build the report preview and visualization link. Connection validation only checks the SQL Server / Report Catalog connection and does not verify that the Web URL is reachable or correct. As a result, Validate Connection can succeed while report preview still fails to load.

Note: SSRS Web Port is collected on the connection form but is not used to build the preview URL. The host and port must be included in the SSRS Web URL itself.

Resolution:

  • Confirm the SSRS Web URL points to the correct Report Server or Web Portal base URL, including the correct port in the URL if required.

  • Confirm the Is WebService URL (Y/N) matches the URL type (Y for ReportServer-style, N for Web Portal-style).

  • Open the same Web URL in a browser to confirm it loads outside OvalEdge.

  • Confirm the SSRS reporting service or portal is available in that environment (service, network, authentication, or license issues can block preview even when connection validation succeeds).

S. No
Error Message
Error Description & Resolution

1

Report columns are not appearing after a crawl

Report column crawling is a separate option from report crawling and is not enabled automatically by default.

Resolution:

  • Open the crawler settings and confirm that the report columns option has been enabled.

  • Recrawl the connector after enabling this option.

  • Confirm the reports containing the expected columns have themselves been successfully crawled first.

2

Only some reports appear after a repeat crawl, or expected updates are missing

Delta Crawl: When enabled, only reports that have been updated since the previous crawl are picked up for crawling, instead of recrawling all reports.

Resolution:

  • Confirm whether delta crawl is enabled and whether the missing report was actually modified since the last crawl.

  • Disable delta crawl temporarily and run a full crawl if a complete refresh is needed.

  • Confirm the report in question exists in the expected folder on the report server.

3

Datasets or datasources do not appear in the catalog after crawling

These object types depend on the relevant report server environment being available and properly configured, and may not be present if the environment lacks sample datasets or Datasources.

Resolution:

  • Confirm datasets and datasources exist on the report server environment being connected to.

  • Confirm the RDL and RSD files, where used, are placed in the folder path provided during connection setup.

  • Confirm read access is available on the configured folder path containing these files.

S. No
Error Message
Error Description & Resolution

1

Lineage shows a temporary table instead of the actual source table

This occurs when the SQL Server connector representing the underlying source tables used in the report query has not been crawled and catalogued separately.

Resolution:

  • Confirm the relevant SQL Server connector has already been catalogued in the application.

  • Rebuild lineage after that source connector is crawled, so actual table names resolve correctly.

  • Expect temporary placeholder names to continue appearing until the source connector is catalogued.

2

Lineage does not extend to the subreport level

Subreport-level lineage is not currently supported, since subreports are not crawled as part of this connector at this time.

Resolution:

  • Note that lineage will stop at the main report level and will not include subreport details.

  • Rely on the main report's data set and data source associations for the available lineage information.

  • Escalate to the development team if subreport-level lineage is specifically required, as this is a planned enhancement area.

3

Lineage fails to resolve certain queries or expressions used in a report

Some queries or expressions may not be recognized by the standard parsing method used to build lineage.

Resolution:

  • Confirm the lineage sync method setting reflects the intended parsing approach for the environment.

  • Enable the alternate parser option in the lineage settings if the regular parser is unable to process a specific query or expression.

  • Confirm the connector version in use supports the alternate parser, as this capability was introduced from a later version.

4

Lineage priority is unclear when multiple SQL server connectors are catalogued

When more than one SQL Server connector has been crawled, the lineage settings determine which connector is treated as the priority source for resolving report tables.

Resolution:

  • Open the lineage settings and confirm the correct priority connector has been selected.

  • Update the priority connector setting if lineage is resolving against the wrong SQL Server source.

  • Rebuild lineage after updating the priority setting.

FAQs

S. No
Question
Answer

1

What authentication types are available for connecting to SSRS?

The following authentication types are available:

  • SQL Server authentication: Uses a SQL login user and requires SELECT permission on the report server database.

  • Windows authentication: Uses a domain or Active Directory account and requires the same SELECT permission on the report server database.

  • File authentication: Uses RDL and RSD files from a configured folder path and requires read access to that path.

2

What is the difference between RDL files and RSD files?

  • RDL (report definition language): Contains the report definition, including its columns, dependencies, and display structure.

  • RSD (report server data source or definition): Contains information about the data sources and data sets used by reports.

A single RSD file can be shared across multiple reports.

3

What is the SSRS web port field used for, and is it always required?

The SSRS web port is the network port used to access the SSRS reporting service.

It is optional for the core connection in many cases. However, the SSRS web service URL is required for report preview because they allow the report visualization to be fetched and displayed.

4

Why does the web service URL field behave differently from other connection fields during validation?

The SSRS Web URL is used only for report preview. It is not used for connection validation or metadata crawl.

Therefore, Validate Connection can succeed even if the SSRS Web URL is incorrect or unavailable. However, report preview may fail.

5

What permissions are needed for the report server database access?

For both SQL Server authentication and Windows authentication, SELECT permission is required on the report server database.

This permission allows the connector to read the catalog table, which contains the report metadata.

The default schema is DBO. The databases are typically:

  • report server

  • report server temp

6

Is there a requirement around network or port access for this connector?

Yes. The required web service port must be allow-listed to allow communication between the database and the application.

Confirm the required port access as part of the initial environment setup.

S. No
Question
Answer

1

What gets crawled from an SSRS instance, and how is it organized?

SSRS objects are crawled in the following hierarchy:

  • Folders: Represent domains or report groups.

  • Reports, shared data sets, and subreports: Located within folders.

  • Data sources and report parameters: Associated with individual reports.

  • Report items: Represent subreports.

  • Report columns: Include fields used by visualizations such as text boxes, tables, and charts.

2

Are report columns crawled by default?

No. Report crawling is enabled by default, but report column crawling is a separate option.

Enable report column crawling in the crawler settings to collect report columns. Subsequent crawls will then include the report columns.

3

Does this connector support delta crawling?

Yes. Delta crawl functionality is supported.

When enabled, a recrawl picks up only reports that have been updated since the previous crawl instead of processing every report.

4

Are subreports and their visual objects fully catalogued?

Subreports are catalogued to the extent that their associated columns are extracted.

Visual objects such as panels, charts, and text boxes are not catalogued as separate objects. Instead, the columns used by these visual elements are captured and associated with the parent report.

5

What versions of SSRS are supported?

SSRS 2012 and later versions are supported.

6

Why is the report preview feature sometimes unavailable even though the connector is working?

Report preview depends on access to the SSRS web service URL.

If the web service is unavailable or the environment hosting it has an expired license, report preview will not load. However, metadata crawling and lineage can continue to work through the database connection.

This is separate from core connector validation, which does not depend on the web service being reachable.

7

Can data sets be crawled directly?

Yes. Data sets are supported as a catalogued object type.

However, their availability depends on the SSRS environment and whether shared data sets are configured there. If shared data sets are not configured or used, they will not appear in the catalog.

S. No
Question
Answer

1

How is lineage built for an SSRS report?

Lineage is built by:

  1. Extracting the data source information from the RSD file.

  2. Connecting the data source to the report.

  3. Extracting fields, relationships, and underlying queries from the report.

  4. Parsing the queries to identify the source tables and columns.

This creates the end-to-end lineage from the data source through the report to the source tables.

2

Why might lineage show a temporary table name instead of the real source table?

This occurs when the SQL Server connector containing the source tables has not yet been crawled.

Until the source system is catalogued, a temporary table name is displayed. After the source connector is catalogued, rebuild lineage to resolve the reference to the actual table.

3

Is subreport level lineage available?

No. Subreport-level lineage is not currently supported.

Lineage is available at the main report level, but does not extend into individual subreports.

4

What is the alternate parser option in the lineage settings used for?

The alternate parser is used when the regular parser cannot process a query or expression correctly.

If the regular parser encounters an error, enabling the alternate parser allows the system to try processing the content again and extract the relevant source objects where possible.

This option is available from a specific later connector version onward.

5

What happens when multiple SQL server connectors are catalogued and a report could match more than one?

Use the priority connector option in the lineage settings to specify which SQL Server connector should be used to resolve the source tables.

Setting the priority connector ensures that lineage is linked to the intended source system when multiple matching connectors exist.


Copyright © 2026, OvalEdge LLC, Peachtree Corners, GA, USA.

Last updated

Was this helpful?