From bf774e6743b61ae6fc552cce3357366840a10e78 Mon Sep 17 00:00:00 2001 From: Rounak Dhillon <162090200+RounakDhillon@users.noreply.github.com> Date: Mon, 2 Jun 2025 23:43:32 +0530 Subject: [PATCH] Doc: Tableau YAML Correction (#21526) * Doc: Tableau YAML Correction * Doc: Tableau YAML Correction --------- Co-authored-by: Rounak Dhillon --- .../connectors/dashboard/tableau/index.md | 3 +- .../connectors/dashboard/tableau/yaml.md | 32 +---------------- .../connectors/dashboard/tableau/index.md | 3 +- .../connectors/dashboard/tableau/yaml.md | 35 +------------------ 4 files changed, 6 insertions(+), 67 deletions(-) diff --git a/openmetadata-docs/content/v1.7.x/connectors/dashboard/tableau/index.md b/openmetadata-docs/content/v1.7.x/connectors/dashboard/tableau/index.md index ff74cf3d9ee..9e8b7b5733a 100644 --- a/openmetadata-docs/content/v1.7.x/connectors/dashboard/tableau/index.md +++ b/openmetadata-docs/content/v1.7.x/connectors/dashboard/tableau/index.md @@ -33,7 +33,8 @@ For more information on enabling the Tableau Metadata APIs follow the link [here {% note %} - If using a **default site** on Tableau Server, leave the **Site URL** and **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](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html#enable-the-tableau-metadata-api-for-tableau-server). +- 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](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html#enable-the-tableau-metadata-api-for-tableau-server). +- The minimum required role to retrieve owners is Site Admin Explorer. {% /note %} ## Metadata Ingestion diff --git a/openmetadata-docs/content/v1.7.x/connectors/dashboard/tableau/yaml.md b/openmetadata-docs/content/v1.7.x/connectors/dashboard/tableau/yaml.md index 3970a2f62c4..6d7b4ef9047 100644 --- a/openmetadata-docs/content/v1.7.x/connectors/dashboard/tableau/yaml.md +++ b/openmetadata-docs/content/v1.7.x/connectors/dashboard/tableau/yaml.md @@ -29,7 +29,7 @@ To create lineage between tableau dashboard and any database service via the que For more information on enabling the Tableau Metadata APIs follow the link [here](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html) {% note %} -- If using a **default site** on Tableau Server, leave the **Site URL** and **Site Name** fields **blank** in the ingestion configuration. +- If using a **default site** on Tableau Server, leave the **Site Name** field **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](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html#enable-the-tableau-metadata-api-for-tableau-server). {% /note %} @@ -86,12 +86,6 @@ This is a sample config for Tableau: {% /codeInfo %} -{% codeInfo srNumber=3 %} - -**env**: 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. - -{% /codeInfo %} - {% codeInfo srNumber=4 %} **hostPort**: URL or IP address of your installation of Tableau Server. @@ -104,18 +98,6 @@ This is a sample config for Tableau: {% /codeInfo %} -{% codeInfo srNumber=6 %} - -**siteUrl**: Tableau Site URL. Tableau Site Url. To be kept empty if you are using the default Tableau site - -{% /codeInfo %} - -{% codeInfo srNumber=7 %} - -**apiVersion**: Tableau API version. A lists versions of Tableau Server and of the corresponding REST API and REST API schema versions can be found [here](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). - -{% /codeInfo %} - {% codeInfo srNumber=11 %} **paginationLimit**: The pagination limit will be used while querying the Tableau Graphql endpoint to get the data source information. @@ -185,21 +167,12 @@ source: # personalAccessTokenName: personal_access_token_name # personalAccessTokenSecret: personal_access_token_secret ``` -```yaml {% srNumber=3 %} - env: tableau_prod -``` ```yaml {% srNumber=4 %} hostPort: http://localhost ``` ```yaml {% srNumber=5 %} siteName: site_name ``` -```yaml {% srNumber=6 %} - siteUrl: site_url -``` -```yaml {% srNumber=7 %} - apiVersion: api_version -``` ```yaml {% srNumber=11 %} paginationLimit: pagination_limit ``` @@ -258,11 +231,8 @@ source: # authType: # personalAccessTokenName: personal_access_token_name # personalAccessTokenSecret: personal_access_token_secret - env: tableau_prod hostPort: http://localhost siteName: site_name - siteUrl: site_url - apiVersion: api_version sourceConfig: config: type: DashboardMetadata diff --git a/openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/dashboard/tableau/index.md b/openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/dashboard/tableau/index.md index 75f65c1f350..95bd103a710 100644 --- a/openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/dashboard/tableau/index.md +++ b/openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/dashboard/tableau/index.md @@ -33,7 +33,8 @@ For more information on enabling the Tableau Metadata APIs follow the link [here {% note %} - If using a **default site** on Tableau Server, leave the **Site URL** and **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](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html#enable-the-tableau-metadata-api-for-tableau-server). +- 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](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html#enable-the-tableau-metadata-api-for-tableau-server). +- The minimum required role to retrieve owners is Site Admin Explorer. {% /note %} ## Metadata Ingestion diff --git a/openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/dashboard/tableau/yaml.md b/openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/dashboard/tableau/yaml.md index 3970a2f62c4..dab4187b4a1 100644 --- a/openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/dashboard/tableau/yaml.md +++ b/openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/dashboard/tableau/yaml.md @@ -29,7 +29,7 @@ To create lineage between tableau dashboard and any database service via the que For more information on enabling the Tableau Metadata APIs follow the link [here](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html) {% note %} -- If using a **default site** on Tableau Server, leave the **Site URL** and **Site Name** fields **blank** in the ingestion configuration. +- 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](https://help.tableau.com/current/api/metadata_api/en-us/docs/meta_api_start.html#enable-the-tableau-metadata-api-for-tableau-server). {% /note %} @@ -86,12 +86,6 @@ This is a sample config for Tableau: {% /codeInfo %} -{% codeInfo srNumber=3 %} - -**env**: 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. - -{% /codeInfo %} - {% codeInfo srNumber=4 %} **hostPort**: URL or IP address of your installation of Tableau Server. @@ -104,18 +98,6 @@ This is a sample config for Tableau: {% /codeInfo %} -{% codeInfo srNumber=6 %} - -**siteUrl**: Tableau Site URL. Tableau Site Url. To be kept empty if you are using the default Tableau site - -{% /codeInfo %} - -{% codeInfo srNumber=7 %} - -**apiVersion**: Tableau API version. A lists versions of Tableau Server and of the corresponding REST API and REST API schema versions can be found [here](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_versions.htm). - -{% /codeInfo %} - {% codeInfo srNumber=11 %} **paginationLimit**: The pagination limit will be used while querying the Tableau Graphql endpoint to get the data source information. @@ -185,21 +167,12 @@ source: # personalAccessTokenName: personal_access_token_name # personalAccessTokenSecret: personal_access_token_secret ``` -```yaml {% srNumber=3 %} - env: tableau_prod -``` ```yaml {% srNumber=4 %} hostPort: http://localhost ``` ```yaml {% srNumber=5 %} siteName: site_name ``` -```yaml {% srNumber=6 %} - siteUrl: site_url -``` -```yaml {% srNumber=7 %} - apiVersion: api_version -``` ```yaml {% srNumber=11 %} paginationLimit: pagination_limit ``` @@ -258,11 +231,8 @@ source: # authType: # personalAccessTokenName: personal_access_token_name # personalAccessTokenSecret: personal_access_token_secret - env: tableau_prod hostPort: http://localhost siteName: site_name - siteUrl: site_url - apiVersion: api_version sourceConfig: config: type: DashboardMetadata @@ -320,11 +290,8 @@ source: type: Tableau username: username password: password - env: tableau_prod hostPort: http://localhost siteName: openmetadata - siteUrl: openmetadata - apiVersion: api_version # If not setting user and password # personalAccessTokenName: personal_access_token_name # personalAccessTokenSecret: personal_access_token_secret