Prajwal214 749cf7945e
Doc: Adding SSL Docs for Messaging & Dashboard (#17602)
Co-authored-by: Prajwal Pandit <prajwalpandit@Prajwals-MacBook-Air.local>
2024-08-27 18:46:01 -07:00

5.3 KiB
Raw Blame History

title slug
Tableau /connectors/dashboard/tableau

{% connectorDetailsHeader name="Tableau" stage="PROD" platform="OpenMetadata" availableFeatures=["Dashboards", "Charts", "Lineage", "Owners", "Datamodels", "Tags", "Projects", "Column Lineage"] unavailableFeatures=[] / %}

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:

{% partial file="/v1.4/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/dashboard/tableau/yaml"} /%}

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

Metadata Ingestion

{% partial file="/v1.4/connectors/metadata-ingestion-ui.md" variables={ connector: "Tableau", selectServicePath: "/images/v1.4/connectors/tableau/select-service.png", addNewServicePath: "/images/v1.4/connectors/tableau/add-new-service.png", serviceConnectionPath: "/images/v1.4/connectors/tableau/service-connection.png", } /%}

{% stepsContainer %} {% extraContent parentTagName="stepsContainer" %}

Connection Details

  • Host and Port: URL or IP address of your installation of Tableau Server.
  • Authentication Types:
    1. Basic Authentication
    • Username: The name of the user whose credentials will be used to sign in.
    • Password: The password of the user.
    1. 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.
  • API Version: Tableau API version. A lists versions of Tableau Server and of the corresponding REST API and REST API schema versions can be found here.
  • 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.
  • Site URL: If it is empty, the default Tableau site name will be used.
  • Environment: The config object can have multiple environments. The default environment is defined as tableau_prod, and you can change this if needed by specifying an env parameter.
  • Pagination Limit: The pagination limit will be used while querying the Tableau Graphql endpoint to get the data source information.

Site Name and Site URL

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.

3. Service Connection for a non-default tableau site

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

{% note %} If https://xxx.tableau.com/#/site/MarketingTeam/home represents the homepage url for your tableau site, the MarketingTeam from the url should be entered in the Site Name and Site Url fields. {% /note %}

Authentication Type

1. Basic Authentication

We need the name of the user whose credentials will be used to sign in and the password of the user.

2. Access Token Authentication

In this case, the personal access token name and the personal access token value are required.

For more information to get a Personal Access Token please visit this link.

{% /extraContent %}

{% partial file="/v1.4/connectors/test-connection.md" /%}

{% partial file="/v1.4/connectors/dashboard/configure-ingestion.md" /%}

{% partial file="/v1.4/connectors/ingestion-schedule-and-deploy.md" /%}

{% /stepsContainer %}

Securing Tableau Connection with SSL in OpenMetadata

To establish secure connections between OpenMetadata and Tableau, navigate to the Advanced Config section. Here, 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 clients SSL certificate, ssl_key for the private key associated with the SSL certificate, and caCertificate for the CA certificate to validate the servers certificate.

{% image src="/images/v1.4/connectors/ssl_tableau.png" alt="SSL Configuration" height="450px" caption="SSL Configuration" /%}

{% partial file="/v1.4/connectors/troubleshooting.md" /%}