> ## Documentation Index
> Fetch the complete documentation index at: https://openmetadata-format-2-0-connector-overview-pages.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# SSRS Connector | OpenMetadata Dashboard Integration

> Connect SQL Server Reporting Services (SSRS) to OpenMetadata with our comprehensive dashboard connector guide. Step-by-step setup, configuration examples, and metadata extraction tips.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/ssrs.webp" name="SSRS" stage="BETA" availableFeatures={["Dashboards", "Charts", "Projects"]} unavailableFeatures={["Owners", "Tags", "Datamodels", "Lineage", "Column Lineage", "Usage"]} />

In this section, we provide guides and references to use the SSRS connector.

Configure and schedule SSRS metadata workflows from the OpenMetadata UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Troubleshooting](/v2.0.x-SNAPSHOT/connectors/dashboard/ssrs/troubleshooting)

## Requirements

The SSRS connector uses the [SSRS REST API](https://docs.microsoft.com/en-us/sql/reporting-services/developer/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.

<Info>
  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.
</Info>

To grant the required role:

1. Open the **SSRS Web Portal**.
2. Navigate to **Site Settings** > **Security** > **New Role Assignment**.
3. Add the service account and assign the **Browser** role.

## Metadata Ingestion

To ingest metadata from SSRS, you need to create a service connection. The service connects SSRS with OpenMetadata. Once you create a service, OpenMetadata automatically starts ingesting metadata.

### Step 1: Add New Service

1. Navigate to **Settings** > **Services**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/access-services.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=1d8b1bddab7b8b43c20d4384be39e12a" alt="Navigate to Settings and Services" width="3004" height="1578" data-path="public/images/connector2.0/metadata-ingestion/access-services.png" />

2. Click **Add New Service**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=792f4403f83940c398633345505482a0" alt="Add New Service" width="3002" height="1514" data-path="public/images/connector2.0/metadata-ingestion/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **Dashboard Services**, then click the **SSRS** connector tile.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Dashboard/select-service/ssrs.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=6206591f5a90de5fe15c4df3a672fd63" alt="Select Service" width="1972" height="1470" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/select-service/ssrs.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other SSRS services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Dashboard/service-name/ssrs.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=2cfdb4d2ff3543a889a161dd4cd175f9" alt="Add New Service Name" width="1504" height="854" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/service-name/ssrs.png" />

<Note>
  **Note**: The service name cannot be changed after it is set.
</Note>

### Step 4: Configure Connection Options

Specify your source credentials and verify the connection.

#### Enter Connection Details

Enter the connection details for SSRS. The right-hand panel in the UI displays inline help for each field.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Dashboard/connection-details/ssrs.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=b298cf6bbbe8fc150ca08ae2b82c707c" alt="Configure Service Connection" width="1448" height="1032" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/connection-details/ssrs.png" />

* **Host and Port**: The base URL of your SSRS Report Server, for example, `https://your-ssrs-server/reportserver`. The connector appends `/api/v2.0` to this URL when calling the REST API.

* **Username**: The Windows account username for NTLM authentication. Use `DOMAIN\username` format 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 SSL
  * `ignore` — SSL without certificate validation
  * `validate` — Full SSL certificate validation

* **SSL Configuration** *(optional)*: Required when `verifySSL` is set to `validate`. 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 Connection

Once the credentials have been added, click on **Test Connection** and **Save** the changes.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/2XRXwl2QkxBakIS8/public/images/connectors/test-connection.png?fit=max&auto=format&n=2XRXwl2QkxBakIS8&q=85&s=abe3b568c662295afc530c6c6819f9a5" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, use filter patterns to control which assets OpenMetadata ingests from your dashboard service. Filter patterns use regular expressions applied to asset names.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated regular expressions. OpenMetadata ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated regular expressions. OpenMetadata skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When both Include and Exclude are set, Exclude takes priority.

<Tip>
  Leave all filter patterns empty to ingest all dashboards, charts, and data models available in the source.
</Tip>

**Filter Options**

The Dashboard, Chart, and Data Model sections each include the following filter options:

* **Dashboard**: Controls which dashboards OpenMetadata ingests from the source.
* **Chart**: Controls which charts within the ingested dashboards are included.
* **Data Model**: Controls which data models are included in metadata ingestion.

Each section provides the following controls:

* **Scan Mode**: You can choose between the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. OpenMetadata saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service.

## Securing SSRS Connection with SSL in OpenMetadata

To establish secure connections between OpenMetadata and your SSRS server, set `verifySSL` to `validate` and provide the CA certificate in the SSL Configuration section. This ensures the connector validates the server's certificate during ingestion.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts dashboards, charts, data models, and other structural metadata from your source and keeps your OpenMetadata catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, OpenMetadata automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. Navigate to **Settings** > **Services** and select the service type.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/access-service-type.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=3c2d6613c061c17412ec5c800c0f3833" alt="Navigate to Settings and Services" width="2992" height="1612" data-path="public/images/connector2.0/metadata-ingestion/access-service-type.png" />

2. Click the service you have added.

3. Select the **Agents** tab and click **Add Agent** > **Metadata**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=9a59a29bca844f3035d14a7211574c57" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/connector2.0/metadata-ingestion/add-metadata-agent.png" />

   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=fa31ef8cb17d501983dd958c19e0c414" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/connector2.0/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure ingestion parameters. The following fields are available:

     | Field                    | Default | Description                                                                                                                                                                                                                                                                                                                                            |
     | ------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
     | Db Service Prefixes      | —       | List of database service name prefixes used to resolve lineage between dashboards and database assets. Accepted formats: `DBService`, `DBService.Database`, `DBService.Database.Schema`, `DBService.Database.Schema.Table`.                                                                                                                            |
     | Query Parser Type        | Auto    | Select the SQL parser used for lineage extraction from dashboard queries. **Auto** selects the best available parser automatically. **SqlGlot** is a high-performance parser with excellent dialect support; falls back to SqlParse on failure. **SqlFluff** is a comprehensive parser with strong dialect support; falls back to SqlParse on failure. |
     | Mark Deleted Dashboards  | On      | Soft-delete dashboards in OpenMetadata when they are removed from the source. Associated lineage is also deleted.                                                                                                                                                                                                                                      |
     | Mark Deleted Data Models | On      | Soft-delete data models in OpenMetadata when they are removed from the source. Associated lineage is also deleted.                                                                                                                                                                                                                                     |
     | Mark Deleted Charts      | On      | Soft-delete charts in OpenMetadata when they are removed from the source.                                                                                                                                                                                                                                                                              |
     | Include Data Models      | On      | Ingest data model metadata.                                                                                                                                                                                                                                                                                                                            |
     | Include Draft Dashboards | On      | Ingest dashboards that are in draft state.                                                                                                                                                                                                                                                                                                             |
     | Include Usage            | On      | Collect and ingest usage statistics for dashboards.                                                                                                                                                                                                                                                                                                    |

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-agent-setup.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=fdc8e18e9b10b022128262deabed33ce" alt="Agent Setup" width="1570" height="1434" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which dashboards, charts, data models, and projects this agent ingests. These follow the same filter options described in **Step 5: Configure Ingestion Options**.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-filter-pattern.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=5614c0294551a391c60cac75ed439380" alt="Filter Patterns" width="1546" height="844" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-filter-pattern.png" />

   * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     | Toggle                 | Default | Description                                                                                                                                                                                           |
     | ---------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Enable Debug Log       | Off     | Sets the ingestion log level to DEBUG. Useful for troubleshooting.                                                                                                                                    |
     | Include Current Owners | Off     | When enabled, replaces the current owner with a new owner from the source if the current owner is null. Recommended to keep enabled during the first metadata ingestion to capture owner information. |
     | Include Tags           | On      | Ingest tags from the source.                                                                                                                                                                          |
     | Override Metadata      | Off     | When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value.                      |
     | Override Lineage       | Off     | When on, existing lineage is replaced with newly extracted lineage on each run.                                                                                                                       |

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/Isfp5cI9vmUuuM5w/public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-scope-bahaviour.png?fit=max&auto=format&n=Isfp5cI9vmUuuM5w&q=85&s=68e3116b305167db50c97370027cf0e2" alt="Scope & Behaviour" width="1552" height="1014" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-scope-bahaviour.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule; trigger the agent manually when needed.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/wI1VkO40X1vdRc0T/public/images/connectors/schedule.png?fit=max&auto=format&n=wI1VkO40X1vdRc0T&q=85&s=14df1dfeef735efd1ad9fb45da8a7352" alt="Schedule Interval" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />

6. Click **Add** to deploy the agent.

## Related

<Columns cols={2}>
  <Card title="Usage Workflow" href="/v2.0.x-SNAPSHOT/connectors/ingestion/workflows/usage">
    Learn more about how to configure the Usage Workflow to ingest Query information from the UI.
  </Card>

  <Card title="Lineage Workflow" href="/v2.0.x-SNAPSHOT/connectors/ingestion/workflows/lineage">
    Learn more about how to configure the Lineage from the UI.
  </Card>

  <Card title="Profiler Workflow" href="/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow">
    Learn more about how to configure the Data Profiler from the UI.
  </Card>

  <Card title="Data Quality Workflow" href="/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/configure">
    Learn more about how to configure the Data Quality tests from the UI.
  </Card>

  <Card title="dbt Integration" href="/v2.0.x-SNAPSHOT/connectors/database/dbt">
    Learn more about how to ingest dbt models' definitions and their lineage.
  </Card>
</Columns>
