> ## Documentation Index > Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt > Use this file to discover all available pages before exploring further. # Tableau Pipeline Connector | OpenMetadata Pipeline Integration > Connect Tableau Pipeline to OpenMetadata to ingest Tableau Prep flows and extract refreshes with lineage and run status. Setup guide included. ![Tableau Pipeline](https://docs.open-metadata.org/public/images/connectors/tableau.webp) # Tableau Pipeline BETA This section provides guides and references to use the Tableau Pipeline connector. The connector ingests **Tableau Prep flows** as Pipelines, with the flow's input, processing, and output steps as Tasks and **flow run history** as Pipeline Status. It also ingests the **extract refreshes** of published data sources and workbooks as Pipelines, with their refresh jobs as run history. Lineage comes from the Tableau Metadata API. Configure and schedule Tableau Pipeline metadata workflows from the OpenMetadata UI: * [Requirements](#requirements) * [Lineage](#lineage) * [Metadata Ingestion](#metadata-ingestion) * [Troubleshooting](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/pipeline/tableau-pipeline/troubleshooting.md) ## Requirements OpenMetadata connects to Tableau Server or Tableau Cloud through the Tableau REST API and the Tableau Metadata API. * **Tableau Server or Tableau Cloud**: OpenMetadata must be able to reach it and authenticate with a username and password or a personal access token. * **Metadata API enabled**: Required for lineage. Without it, metadata and run status still ingest, but OpenMetadata draws no lineage edges. For more information, see [Start the Metadata API](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html). * **Permissions**: The user needs permission to list flows and flow runs, and to query the Metadata API for lineage. Users who are not administrators see only the runs of flows they can view. * **Tableau Prep Conductor**: Flows can run manually without Data Management, but scheduled flow runs need [Tableau Prep Conductor](https://help.tableau.com/current/prep/en-us/prep_conductor_overview.htm). * **Site administrator for extract refresh status**: Tableau answers extract refresh job queries only for server and site administrators. Other users still get extract refresh pipelines for the refresh tasks they own, but without run status. ### Lineage The connector reads lineage from the Tableau Metadata API: * **Input to output lineage**: Each table or published data source a flow reads is linked to the tables or published data sources it writes, with the flow shown on the lineage edge. * **Flow to flow lineage**: A flow is linked to the flows that consume its output. Only direct consumers are linked. * **Extract refresh lineage**: An extract refresh pipeline is linked to the published data source or workbook data model it refreshes. OpenMetadata resolves tables against the database services already in your instance. To restrict which services OpenMetadata searches, set **Database Service Names List** under **Lineage Information** in the metadata agent. Without it, OpenMetadata searches every database service and accepts only a single match, so a same-named table in another service never gets an edge. Published data sources and workbook extracts resolve to the data models created by the [Tableau dashboard connector](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/dashboard/tableau.md), so run the dashboard connector first. > [!NOTE] > > **Note**: Column-level lineage is not available for Tableau Pipeline. ## Metadata Ingestion To ingest metadata from Tableau Pipeline, you need to create a service connection. The service connects Tableau Pipeline with OpenMetadata. After you create the service and deploy the metadata agent, OpenMetadata starts ingesting metadata. ### Step 1: Add New Service 1. Navigate to **Settings** > **Services**. ![Navigate to Settings and Services](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/access-services.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=c95e6e79c73eea68039c10115c7f80d6) 2. Click **Add New Service**. ![Add New Service](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/add-new-service.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=13457ef6e565aa39d339db30ce1f354d) ### Step 2: Select a Service and Connector From the service type dropdown, select **Pipeline Services**, then click the **Tableau Pipeline** connector tile. ![Select Service](https://mintcdn.com/openmetadata/2JePGMl7lLCPk_br/public/images/connector2.0/metadata-ingestion/Pipeline/select-service/tableau-pipeline.png?fit=max\&auto=format\&n=2JePGMl7lLCPk_br\&q=85\&s=c22ac73dc5a5687b21fbbdb82593f158) ### 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 Tableau Pipeline services you're ingesting metadata from. * Optional: Enter a **Description** for the service. ![Add New Service Name](https://mintcdn.com/openmetadata/2JePGMl7lLCPk_br/public/images/connector2.0/metadata-ingestion/Pipeline/service-name/tableau-pipeline.png?fit=max\&auto=format\&n=2JePGMl7lLCPk_br\&q=85\&s=a179d9ec53ff1095e30e154b73b73f07) > [!NOTE] > > The service name can't be changed after it's set. ### Step 4: Configure Connection Options Specify your source credentials and verify the connection. #### Enter Connection Details Enter the connection details for Tableau Pipeline. The inline help panel in the UI describes each field. The form groups fields into **Connection**, **Authentication**, **Scope & Options**, and **Advanced Config** sections. ![Configure Service Connection](https://mintcdn.com/openmetadata/4dTw9O2XQwNnaqOD/public/images/connector2.0/metadata-ingestion/Pipeline/connection-details/tableau-pipeline.png?fit=max\&auto=format\&n=4dTw9O2XQwNnaqOD\&q=85\&s=9d31a3b178adb0c42c37267db9da1376) * **Host and Port** (required): Tableau Server URL. * **Authentication type for Tableau** (required): Choose one method. OpenMetadata stores only the credential for the method you select, and switching methods discards the other. * **BasicAuth**: Enter the **Username** and **Password** used to sign in to Tableau. * **AccessTokenAuth**: Enter the **Personal Access Token Name** and **Personal Access Token Secret**. For more information, see [Personal Access Tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm). Expand **Scope & Options** to set the optional fields: ![Scope and Options](https://mintcdn.com/openmetadata/4dTw9O2XQwNnaqOD/public/images/connector2.0/metadata-ingestion/Pipeline/connection-details/tableau-pipeline-scope.png?fit=max\&auto=format\&n=4dTw9O2XQwNnaqOD\&q=85\&s=57f55c0bcd8e709ac107c954fdf8fdda) * **Site Name** (optional): The Tableau site to ingest. Leave blank for the default site. * **API Version** (optional): Tableau REST API version. If not provided, OpenMetadata uses the version reported by the Tableau server. * **Verify SSL** (optional): Client SSL verification mode. The default is `no-ssl`. Configure **SSL Config** under **Advanced Config** when you select a mode that validates certificates. * **Number of Status** (optional, default `10`, from `1` to `100`): Number of recent runs to fetch per flow or extract refresh. * **Include Extract Refreshes** (optional, on by default): Ingest the extract refresh tasks of published data sources and workbooks as pipelines, with their refresh jobs as pipeline status. Reading refresh job history requires a site administrator. Expand **Advanced Config** to provide SSL certificates when **Verify SSL** validates certificates: ![Advanced Config SSL](https://mintcdn.com/openmetadata/4dTw9O2XQwNnaqOD/public/images/connector2.0/metadata-ingestion/Pipeline/connection-details/tableau-pipeline-ssl.png?fit=max\&auto=format\&n=4dTw9O2XQwNnaqOD\&q=85\&s=462159533049ce0947c5b74339dcd74a) * **CA Certificate**: The CA certificate used for SSL validation. Upload a `.pem`, `.crt`, or `.cer` file (maximum 1 MB), or paste the contents. * **SSL Certificate**: The client certificate, for mutual TLS. * **SSL Key**: The private key for the client certificate, for mutual TLS. #### Test Connection After you add the credentials, click **Test Connection**, then click **Save**. ![Test Connection](https://mintcdn.com/openmetadata/9G75p72jJKYgvFUQ/public/images/connectors/test-connection.png?fit=max\&auto=format\&n=9G75p72jJKYgvFUQ\&q=85\&s=4ac71a56e30fa3dd1be86f82c1f07068) ### Step 5: Configure Ingestion Options In the **What to Ingest** step, use filter patterns to control which assets OpenMetadata ingests from your Tableau Pipeline service. Filter patterns use regular expressions applied to pipeline 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 the filter pattern empty to ingest all pipelines available in the source. #### Filter Options The Pipeline section includes the following filter options: * **Pipeline**: Controls which Prep flows and extract refresh pipelines OpenMetadata ingests from Tableau. Each section provides the following controls: * **Scan Mode**: 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. ## Configure Metadata Agent and Schedule Ingestion The **Metadata Agent** extracts pipelines, tasks, 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. ![Navigate to Settings and Services](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/access-service-type.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=4471655da6e39d91776597e4a7eea513) 2. Click the service you have added. 3. Select the **Agents** tab and click **Add Agent** > **Metadata**. ![Add Metadata Agent](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/add-metadata-agent.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=a654d9700126ce64cb6c9a99b8d69b1a) 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. ![Name this Ingestion](https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/metadata-agent-name.png?fit=max\&auto=format\&n=pD1dbe0lKPSqnODv\&q=85\&s=92954c166518e3ac07589ab20865e3e7) * **Agent Setup**: Configure the core parameters for this agent. The following fields are available: | Field | Default | Description | | - | - | - | | Ownership Update Mode | replace | Set how owners from source metadata update Pipeline owners. In replace mode, resolved owners from the current source replace existing owners. In append mode, resolved owners are appended to active existing Pipeline owners. | | Db Service Names | — | List of database service names used for lineage resolution. | | Storage Service Names | — | List of storage service names used for lineage resolution. | | Messaging Service Names | — | List of messaging service names used for lineage resolution. | | Status Lookback Days | 1 | Number of days of pipeline run status history to ingest. Only runs within the last N days will be fetched. | | Include Lineage | On | Turn off to stop fetching lineage from pipelines. | | Mark Deleted Pipeline | On | Soft-delete pipelines in OpenMetadata when they are removed from the source. Associated entities like lineage are also deleted. | | Include UnDeployed Pipelines | On | Toggle whether un-deployed pipelines should be ingested. If set to false, only deployed pipelines will be ingested. | ![Agent Setup](https://mintcdn.com/openmetadata/lclr4-hP2CvWdln8/public/images/connector2.0/metadata-ingestion/Pipeline/pipeline-agent-setup.png?fit=max\&auto=format\&n=lclr4-hP2CvWdln8\&q=85\&s=081af023a6a36ef466c7974c33a6dfcd) * **Filter Patterns**: Apply include or exclude rules to scope which pipelines this agent ingests. These follow the same filter options described in **Step 5: Configure Ingestion Options**. ![Filter Patterns](https://mintcdn.com/openmetadata/lclr4-hP2CvWdln8/public/images/connector2.0/metadata-ingestion/Pipeline/pipeline-filter-pattern.png?fit=max\&auto=format\&n=lclr4-hP2CvWdln8\&q=85\&s=a299d4dd545f6eeb1189dea71005b3cf) * **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. | | Override Metadata | Off | When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. A description or display name that the source doesn't send never replaces an existing value. If the connector supplies custom properties, the values it sends are merged over the existing ones: properties the source sends overwrite, and properties it doesn't send are kept. 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. | ![Scope & Behaviour](https://mintcdn.com/openmetadata/lclr4-hP2CvWdln8/public/images/connector2.0/metadata-ingestion/Pipeline/pipeline-scope-behaviour.png?fit=max\&auto=format\&n=lclr4-hP2CvWdln8\&q=85\&s=2adc8c4f660d750cfe679bc2f8a608a6) 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. ![Schedule Interval](https://mintcdn.com/openmetadata/j50Bw6ZBiFbbFFnF/public/images/connectors/schedule.png?fit=max\&auto=format\&n=j50Bw6ZBiFbbFFnF\&q=85\&s=24b0c2f55f803efde5fb3b3bc24ed3ae) 6. Click **Add** to deploy the agent. ## Related > **[Usage Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/ingestion/workflows/usage.md)** > > Learn more about how to configure the Usage Workflow to ingest Query information from the UI. > **[Lineage Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/ingestion/workflows/lineage.md)** > > Learn more about how to configure the Lineage from the UI. > **[Profiler Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow.md)** > > Learn more about how to configure the Data Profiler from the UI. > **[Data Quality Workflow](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/configure.md)** > > Learn more about how to configure the Data Quality tests from the UI. > **[dbt Integration](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/connectors/database/dbt.md)** > > Learn more about how to ingest dbt models' definitions and their lineage. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.