Tableau

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
• Metadata Ingestion

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to connect using Airflow SDK or with the CLI.

Requirements

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

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.

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

Metadata Ingestion

1. Visit the Services Page

The first step is ingesting the metadata from your sources. Under Settings, you will find a Services link an external source system to OpenMetadata. Once a service is created, it can be used to configure metadata, usage, and profiler workflows.

To visit the Services page, select Services from the Settings menu.

Find Services under the Settings menu

2. Create a New Service

Click on the Add New Service button to start the Service creation.

Add a new Service from the Services page

3. Select the Service Type

Select Tableau as the service type and click Next.

Select your service from the list

4. Name and Describe your Service

Provide a name and description for your service as illustrated below.

Service Name

OpenMetadata uniquely identifies services by their Service Name. Provide a name that distinguishes your deployment from other services, including the other {connector} services that you might be ingesting metadata from.

Provide a Name and description for your Service

5. Configure the Service Connection

In this step, we will configure the connection settings required for this connector. Please follow the instructions below to ensure that you've configured the connector to read from your tableau service as desired.

1. Service Connection for Tableau Cloud

If you're connecting to a cloud Tableau instance, add the Site Name and Site Url with your site name.

2. Service Connection for a default tableau site

For a default tableau site Site Name and Site Url fields should be kept empty as shown in the below image

Configure the service connection for default site by filling the form

3. Service Connection for a non-default tableau site

For a non-default tableau site Site Name and Site Url fields are required.

Configure the service connection for a non-default site by filling the form

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

Test the connection and save the Service

Connection Options

• Host and Port: URL to the Tableau instance.
• Username: Specify the User to connect to Tableau. It should have enough privileges to read all the metadata.
• Password: Password for Tableau.
• API Version: Tableau API version.
• Site Name: Tableau Site Name. To be kept empty if you are using the default Tableau site
• Site Url: Tableau Site Url. To be kept empty if you are using the default Tableau site
• Personal Access Token: Access token. To be used if not logging in with user/password.
• Personal Access Token Secret: Access token Secret. To be used if not logging in with user/password.
• Environment: Tableau Environment.

6. Configure Metadata Ingestion

In this step we will configure the metadata ingestion pipeline, Please follow the instructions below

Configure Metadata Ingestion Page

Metadata Ingestion Options

• Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
• Dashboard Filter Pattern (Optional): Use to dashboard filter patterns to control whether or not to include dashboard as part of metadata ingestion.
  • Include: Explicitly include dashboards by adding a list of 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 a list of 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 Pattern (Optional): Use to chart filter patterns to control whether or not to include charts as part of metadata ingestion.
  • Include: Explicitly include charts by adding a list of 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 a list of 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.
• Database Service Name (Optional): Enter the name of Database Service which is already ingested in OpenMetadata to create lineage between dashboards and database tables.
• Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug, these logs can be viewed later in Airflow.
• Override Current Owner(toggle): Set the Override Current Owner toggle to override current owner with new owner, if that is fetched during metadata ingestion For first time of metadata ingestion, kindly make sure to keep it enabled to get the owner.

7. Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, or weekly 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.

Schedule the Ingestion Pipeline and Deploy

After configuring the workflow, you can click on Deploy to create the pipeline.

8. View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.

View the Ingestion Pipeline from the Service Page

9. Workflow Deployment Error

If there were any errors during the workflow deployment process, the Ingestion Pipeline Entity will still be created, but no workflow will be present in the Ingestion container.

You can then edit the Ingestion Pipeline and Deploy it again.

Edit and Deploy the Ingestion Pipeline

From the Connection tab, you can also Edit the Service if needed.