> ## 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. # Run the Tableau Pipeline Connector Externally > Use YAML to ingest Tableau Prep flows and extract refreshes as pipelines, with run status and lineage. ![Tableau Pipeline](https://docs.open-metadata.org/public/images/connectors/tableau.webp) # Tableau Pipeline BETA This section provides guides and references for the Tableau Pipeline connector. Configure Tableau Pipeline metadata workflows externally with YAML: * [Requirements](#requirements) * [Metadata Ingestion](#metadata-ingestion) ## How to Run the Connector Externally To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework **anywhere**. > **[External Schedulers](https://docs.open-metadata.org/v2.1.x-SNAPSHOT/deployment/ingestion.md)** > > Get more information about running the Ingestion Framework Externally ## 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. ### Python Requirements Use Python 3.10 or later. Python 3.12 is recommended, because it is what the OpenMetadata 2.0 ingestion images use. To confirm the supported range for your release, check the `Requires-Python` metadata of that release’s `openmetadata-ingestion` package. To run the Tableau Pipeline ingestion, install: ```bash theme={null} pip3 install "openmetadata-ingestion[tableaupipeline]" ``` ## Metadata Ingestion All connectors are defined as JSON Schemas. See the [Tableau Pipeline connection JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/entity/services/connections/pipeline/tableauPipelineConnection.json) for the full set of properties. To create and run a metadata ingestion workflow, create a YAML configuration. The configuration connects to the source, processes entities if needed, and reaches the OpenMetadata server. The workflow is modeled around the following [JSON Schema](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/workflow.json). ### 1. Define the YAML Config Use the following YAML configuration as a starting point. #### Source Configuration Configure the source type and service name for your Tableau Pipeline connector. #### hostPort **hostPort**: Tableau Server URL. #### authType **authType**: Choose one authentication method. * **Basic authentication**: `username` and `password` used to sign in to Tableau. * **Access token authentication**: `personalAccessTokenName` and `personalAccessTokenSecret`. For more information, see [Personal Access Tokens](https://help.tableau.com/current/server/en-us/security_personal_access_tokens.htm). #### siteName and apiVersion **siteName**: Optional Tableau site to ingest. Leave blank for the default site. **apiVersion**: Optional Tableau REST API version. If not provided, OpenMetadata uses the version reported by the Tableau server. #### numberOfStatus and includeExtractRefreshes **numberOfStatus**: Number of recent runs to fetch per flow or extract refresh. The default is `10`, and the range is `1` to `100`. **includeExtractRefreshes**: Ingest the extract refresh tasks of published data sources and workbooks as pipelines, with their refresh jobs as pipeline status. On by default. Reading refresh job history requires a site administrator. #### verifySSL and sslConfig **verifySSL**: Client SSL verification mode: `no-ssl` (default), `ignore`, or `validate`. **sslConfig**: CA certificate, and for mutual TLS the client certificate and key, used when `verifySSL` is `validate`. #### pipelineFilterPattern **pipelineFilterPattern**: Regular expressions to include or exclude pipelines by name. This matches the flow name, or ` extract refresh` for extract refresh pipelines. #### Source Config The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetadata/blob/main/openmetadata-spec/src/main/resources/json/schema/metadataIngestion/pipelineServiceMetadataPipeline.json): * **dbServiceNames**: Database Service Name for the creation of lineage, if the source supports it. * **includeTags**: Set the **Include Tags** toggle to control whether to include tags as part of metadata ingestion. * **includeUnDeployedPipelines**: Set the **Include UnDeployed Pipelines** toggle to control whether to include un-deployed pipelines as part of metadata ingestion. By default it is set to `true`. * **markDeletedPipelines**: Set the **Mark Deleted Pipelines** toggle to flag pipelines as soft-deleted if they are not present anymore in the source system. * **pipelineFilterPattern** and **chartFilterPattern**: Note that the `pipelineFilterPattern` and `chartFilterPattern` both support regex as include or exclude. * **includeOwners**: Set the **Include Owners** toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten. It supports boolean values either `true` or `false`. * **overrideLineage**: Set the **Override Lineage** toggle to control whether to override the existing lineage. It supports boolean values either `true` or `false`. * **overrideMetadata**: Set the **Override Metadata** toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If the toggle is set to true, the metadata fetched from the source will override the existing metadata in the OpenMetadata server. If the toggle is set to false, the metadata fetched from the source will not override the existing metadata in the OpenMetadata server. This is applicable for fields like description, tags, owner, and displayName. It supports boolean values either `true` or `false`. * **statusLookbackDays**: Number of days of pipeline run status history to ingest. Only runs within the last N days are fetched. Integer, default `1`. Available on all pipeline connectors, but only honored by those that ingest run-status history (currently Dagster, dbt Cloud, Databricks Pipeline, and Data360). #### Sink Configuration To send the metadata to OpenMetadata, it needs to be specified as `type: metadata-rest`. #### Workflow Configuration The main property here is `openMetadataServerConfig`, where you can define the host and security provider of your OpenMetadata installation. * **loggerLevel**: Specify the logger level depending on your needs. If you are troubleshooting an ingestion, use `DEBUG` for more detailed traces. * **JWT token**: JWT tokens allow clients to authenticate against the OpenMetadata server. See [Enable JWT Tokens](https://docs.open-metadata.org/deployment/security/enable-jwt-tokens.md) and [JWT Troubleshooting](https://docs.open-metadata.org/deployment/security/jwt-troubleshooting.md) for more information. * **storeServiceConnection**: If set to `true` (default), sensitive information is stored encrypted with the Fernet Key or externally if you have configured a [Secrets Manager](https://docs.open-metadata.org/deployment/secrets-manager.md). If set to `false`, the service is created, but the service connection information is only used by the Ingestion Framework at runtime and is not sent to the OpenMetadata server. * **SSL configuration**: If you have added SSL to the [OpenMetadata server](https://docs.open-metadata.org/deployment/security/enable-ssl.md), configure the certificates for ingestion. Set `verifySSL` to `ignore`, or set it to `validate` and provide `sslConfig.caCertificate` with a local path to the server certificate. See [SSL Troubleshooting](https://docs.open-metadata.org/deployment/security/enable-ssl/ssl-troubleshooting.md) for more information. * **ingestionPipelineFQN**: Fully qualified name of the ingestion pipeline, used to identify the current ingestion pipeline. tableaupipeline\_config.yaml Copy full code ```yaml theme={null} source: type: tableaupipeline serviceName: local_tableau_pipeline serviceConnection: config: type: TableauPipeline hostPort: # REQUIRED - Tableau Server URL authType: # REQUIRED - choose one method username: password: # # or, for access token authentication, replace username and password with: # personalAccessTokenName: # personalAccessTokenSecret: # siteName: # apiVersion: # numberOfStatus: 10 # includeExtractRefreshes: true # verifySSL: no-ssl # sslConfig: # caCertificate: # pipelineFilterPattern: # includes: # - # excludes: # - ``` ```yaml theme={null} sourceConfig: config: type: PipelineMetadata # lineageInformation: # dbServiceNames: [] # storageServiceNames: [] # markDeletedPipelines: True # includeTags: True # includeLineage: true # includeUnDeployedPipelines: true # pipelineFilterPattern: # includes: # - pipeline1 # - pipeline2 # excludes: # - pipeline3 # - pipeline4 # includeOwners: true # false # overrideLineage: false # true # overrideMetadata: false # true # statusLookbackDays: 1 # only honored by Dagster, dbt Cloud, Databricks Pipeline, Data360 ``` ```yaml theme={null} sink: type: metadata-rest config: {} ``` ```yaml theme={null} workflowConfig: loggerLevel: INFO # DEBUG, INFO, WARNING or ERROR openMetadataServerConfig: hostPort: "http://localhost:8585/api" authProvider: openmetadata securityConfig: jwtToken: "{bot_jwt_token}" ## Store the service Connection information storeServiceConnection: true # false ## Secrets Manager Configuration # secretsManagerProvider: aws, azure or noop # secretsManagerLoader: airflow or env ## If SSL, fill the following # verifySSL: validate # or ignore # sslConfig: # caCertificate: /local/path/to/certificate # ingestionPipelineFQN: . ## e.g., "my_redshift.metadata" ``` ### 2. Run with the CLI First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run: ```bash theme={null} metadata ingest -c ``` Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources. This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.