Doc: Tableau YAML Correction (#21526)

* Doc: Tableau YAML Correction

* Doc: Tableau YAML Correction

---------

Co-authored-by: Rounak Dhillon <rounakdhillon@Rounaks-MacBook-Air.local>
This commit is contained in:
Rounak Dhillon 2025-06-02 23:43:32 +05:30 committed by GitHub
parent 3c5fbffeaa
commit bf774e6743
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 6 additions and 67 deletions

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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