Requirements
The SSRS connector uses the SSRS REST API (v2.0) and authenticates via Windows Authentication (NTLM). The account used must have at minimum Browser role on the SSRS Report Server to list folders and reports.The SSRS REST API (v2.0) requires SQL Server Reporting Services 2017 or later. Older SSRS versions using SOAP-based web services are not supported.
- Open the SSRS Web Portal.
- Navigate to Site Settings → Security → New Role Assignment.
- Add the service account and assign the Browser role.
Metadata Ingestion
Connection Details
Connection Details
-
Host and Port: The base URL of your SSRS Report Server, e.g.,
https://your-ssrs-server/reportserver. The connector appends/api/v2.0to this URL when calling the REST API. -
Username: The Windows account username for NTLM authentication. Use
DOMAIN\usernameformat for domain accounts. - Password: Password for the Windows account used for NTLM authentication.
-
Verify SSL (optional): Controls SSL certificate verification. Options:
no-ssl(default) — No SSLignore— SSL without certificate validationvalidate— Full SSL certificate validation
-
SSL Configuration (optional): Required when
verifySSLis set tovalidate. Provide the CA certificate to verify the SSRS server’s SSL certificate. - Dashboard Filter Pattern (optional): Regex to include or exclude specific SSRS reports by name.
- Chart Filter Pattern (optional): Regex to include or exclude charts by name.
- Project Filter Pattern (optional): Regex to include or exclude SSRS folders (which map to OpenMetadata projects) by name.
Test the Connection
Once the credentials have been added, click on Test Connection and Save the changes.

Configure Metadata Ingestion
After adding and testing the dashboard service, configure the metadata ingestion pipeline. To configure, follow the steps below:


- Navigate to Settings > Services > Dashboards.
- On the Dashboards services page, click the service you’ve added.
- Go to the Agents tab, and then click Add Agent > Add Metadata Agent.
- Configure the ingestion details. See Metadata Ingestion Options.

Metadata Ingestion Options
- Name: This field is the name of the ingestion pipeline. Customize it or use the generated name.
- Dashboard Filter Pattern (Optional): Use it to control whether to include dashboards as part of metadata ingestion.
- Include: Explicitly include dashboards by adding comma-separated regular expressions to the ‘Include’ field. OpenMetadata will include all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be excluded.
- Exclude: Explicitly exclude dashboards by adding comma-separated regular expressions to the ‘Exclude’ field. OpenMetadata will exclude all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be included.
- Chart Filter Pattern (Optional): Use it to control whether to include charts as part of metadata ingestion.
- Include: Explicitly include charts by adding comma-separated regular expressions to the ‘Include’ field. OpenMetadata will include all charts with names matching one or more of the supplied regular expressions. All other charts will be excluded.
- Exclude: Explicitly exclude charts by adding comma-separated regular expressions to the ‘Exclude’ field. OpenMetadata will exclude all charts with names matching one or more of the supplied regular expressions. All other charts will be included.
- Data Model Filter Pattern (Optional): Use it to control whether to include data models as part of metadata ingestion.
- Include: Explicitly include data models by adding comma-separated regular expressions to the ‘Include’ field. OpenMetadata will include all data models with names matching one or more of the supplied regular expressions. All other data models will be excluded.
- Exclude: Explicitly exclude data models by adding comma-separated regular expressions to the ‘Exclude’ field. OpenMetadata will exclude all data models with names matching one or more of the supplied regular expressions. All other data models will be included.
- Project Filter Pattern: Filter the dashboards, charts, and data sources by projects. Note that all of them support regex as include or exclude. For example, “My project, My proj.*, .*Project”.
- Enable Debug Log: Enable this toggle to use debug-level logging.

- Lineage Information (Optional): Configure this section to enable lineage between your dashboards and the database tables they are built on. OpenMetadata uses the database service name to match and draw the lineage path from table to dashboard.
- Db Service Prefixes: Enter one or more service path prefixes to tell OpenMetadata where to look for the source tables used by your dashboards. Supported formats:
DBServiceName—matches all tables in the serviceDBServiceName.DatabaseName—matches tables in a specific databaseDBServiceName.DatabaseName.SchemaName—matches tables in a specific schemaDBServiceName.DatabaseName.SchemaName.TableName—matches a specific table
- Db Service Prefixes: Enter one or more service path prefixes to tell OpenMetadata where to look for the source tables used by your dashboards. Supported formats:
- Query Parser Configuration: Controls how OpenMetadata parses SQL queries to extract lineage. Use this to select the SQL parser that best fits your data source’s dialect.
- Query Parser Type: Choose the SQL parser for lineage extraction:
- Auto (default): Automatically tries SqlGlot first, falls back to SqlFluff, then SqlParse. Recommended for best results.
- SqlGlot: High-performance parser with good dialect support. Falls back to SqlParse on failure.
- SqlFluff: Comprehensive but slower parser with strong dialect support. Falls back to SqlParse on failure.
- Query Parser Type: Choose the SQL parser for lineage extraction:
- Include Current Owners: Enable this toggle to control whether to include owners for the ingested entity if the owner email matches a user stored in the OpenMetadata server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
- Mark Deleted Dashboards: Optional configuration to soft delete dashboards in OpenMetadata if the source dashboards are deleted. After deleting, all associated entities like lineage and other related data for that dashboard will be deleted.
- Mark Deleted Data Models: Optional configuration to soft delete data models in OpenMetadata if the source data models are deleted. After deleting, all associated entities with that data model will be deleted.
- Mark Deleted Charts: Optional configuration to soft delete charts in OpenMetadata if the source charts are deleted. After deleting, all associated entities with that chart will be deleted.
- Include Tags: Enable this toggle to control whether to include tags in metadata ingestion.
- Include Data Models: Enable this toggle to control whether to include data models as part of metadata ingestion.
- Include Draft Dashboard: Enable this toggle to include draft dashboards. By default, this is enabled.
- Include Usage: Enable this toggle to control whether to include usage data as part of metadata ingestion.
- Override Metadata: Enable this toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If enabled, the metadata fetched from the source will override the existing metadata in OpenMetadata. If disabled, only fields that have no value in OpenMetadata will be updated. This is applicable for fields like description, tags, owner, and displayName.
- Override Lineage: Enable this toggle to control whether to override the existing lineage in OpenMetadata with the lineage fetched from the source. If enabled, existing lineage will be replaced. If disabled, new lineage edges will be added without removing existing ones.

Schedule the Ingestion and Deploy
Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The
timezone is in UTC. Select a Start Date to schedule for ingestion. It is
optional to add an End Date.Review your configuration settings. If they match what you intended,
click Deploy to create the service and schedule metadata ingestion.If something doesn’t look right, click the Back button to return to the
appropriate step and change the settings as needed.After configuring the workflow, you can click on Deploy to create the
pipeline.

Securing SSRS Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and your SSRS server, setverifySSL to validate and provide the CA certificate in the SSL Configuration section. This ensures the connector validates the server’s certificate during ingestion.