We use cookies to improve site navigation, analyze site usage, and enhance your user experience. Click "Accept" to enable cookies or "Reject" to reject cookies. To learn more, read our Privacy Policy.

connectors

No menu items for this category
Home/Connectors/Dashboard/Tableau/Yaml
Tableau

Tableau

PROD
Available In
Feature List
Dashboards
Charts
Lineage
Owners
Datamodels
Tags
Projects
Usage

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

Configure and schedule Tableau metadata and profiler workflows from the OpenMetadata UI:

Requirements

To ingest tableau metadata, minimum Site Role: Viewer is required for the tableau user.

To create lineage between tableau dashboard and any database service via the queries provided from Tableau Metadata API, please enable the Tableau Metadata API for your tableau server. For more information on enabling the Tableau Metadata APIs follow the link here

  • If using a default site on Tableau Server, leave the Site Name fields blank in the ingestion configuration.
  • Ensure that the Metadata API is enabled for the user performing the ingestion. If it is not enabled, ingestion may fail. Follow the official Tableau documentation to enable the Metadata API.

Python Requirements

To run the Tableau ingestion, you will need to install:

Metadata Ingestion

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Tableau.

In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.

The workflow is modeled around the following JSON Schema

1. Define the YAML Config

This is a sample config for Tableau:

Source Configuration - Service Connection

For Basic Authentication:

Username: The name of the user whose credentials will be used to sign in.

Password: The password of the user.

For Access Token Authentication:

Personal Access Token: The personal access token name. For more information to get a Personal Access Token please visit this link.

Personal Access Token Secret: The personal access token value. For more information to get a Personal Access Token please visit this link.

hostPort: URL or IP address of your installation of Tableau Server.

siteName: Tableau Site Name. This corresponds to the contentUrl attribute in the Tableau REST API. The site_name is the portion of the URL that follows the /site/ in the URL.

paginationLimit: The pagination limit will be used while querying the Tableau Graphql endpoint to get the data source information.

verifySSL: Client SSL verification. Make sure to configure the SSLConfig if enabled. Supported values no-ssl, ignore, validate.

sslMode: Mode of SSL. Default is disabled. Supported modes are disable, allow, prefer, require, verify-ca, verify-full.

sslConfig: Client SSL configuration.

Source Configuration - Source Config

The sourceConfig is defined here:

  • dbServiceNames: Database Service Names for ingesting lineage if the source supports it.
  • dashboardFilterPattern, chartFilterPattern, dataModelFilterPattern: Note that all of them support regex as include or exclude. E.g., "My dashboard, My dash.*, .*Dashboard".
  • projectFilterPattern: Filter the tableau dashboards, charts and data sources by projects. Note that all of them support regex as include or exclude. E.g., "My project, My proj.*, .*Project".
  • 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.
  • includeTags: Set the 'Include Tags' toggle to control whether to include tags in metadata ingestion.
  • includeDataModels: Set the 'Include Data Models' toggle to control whether to include tags as part of metadata ingestion.
  • markDeletedDashboards: Set the 'Mark Deleted Dashboards' toggle to flag dashboards as soft-deleted if they are not present anymore in the source system.

Sink Configuration

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

filename.yaml
Example Source Configurations for default and non-default tableau sites
1. Sample config for default tableau site
For a default tableau site siteName and siteUrl fields should be kept as empty strings as shown in the below config.
1. Sample config for non-default tableau site
For a non-default tableau site siteName and siteUrl fields are required.
Note: If https://xxx.tableau.com/#/site/sitename/home represents the homepage url for your tableau site, the sitename from the url should be entered in the siteName and siteUrl fields in the config below.
Securing Tableau Connection with SSL in OpenMetadata
To establish secure connections between OpenMetadata and Tableau, in the YAML you can provide the CA certificate used for SSL validation by specifying the caCertificate. Alternatively, if both client and server require mutual authentication, you'll need to use all three parameters: ssl key, ssl cert, and caCertificate. In this case, ssl_cert is used for the client’s SSL certificate, ssl_key for the private key associated with the SSL certificate, and caCertificate for the CA certificate to validate the server’s certificate.