Skip to content

Commit fb471f1

Browse files
authored
docs(tableau): clarify docs around tableau permissions (#12270)
1 parent 3316d40 commit fb471f1

File tree

1 file changed

+23
-7
lines changed

1 file changed

+23
-7
lines changed

metadata-ingestion/docs/sources/tableau/tableau_pre.md

+23-7
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,24 @@
33
In order to ingest metadata from Tableau, you will need:
44

55
- Tableau Server Version 2021.1.10 and above. It may also work for older versions.
6-
- [Enable the Tableau 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) for Tableau Server, if its not already enabled.
7-
- Tableau Credentials (Username/Password or [Personal Access Token](https://help.tableau.com/current/pro/desktop/en-us/useracct.htm#create-and-revoke-personal-access-tokens))
8-
- The user or token must have **Site Administrator Explorer** permissions.
6+
- [Enable the Tableau 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) for Tableau Server, if its not already enabled. This is always enabled for Tableau Cloud.
7+
8+
### Authentication
9+
10+
DataHub supports two authentication methods:
11+
12+
1. Username/Password
13+
2. [Personal Access Token](https://help.tableau.com/current/pro/desktop/en-us/useracct.htm#create-and-revoke-personal-access-tokens)
14+
15+
Either way, the user/token must have the **Site Administrator Explorer** site role.
16+
17+
:::info
18+
19+
We need the `Site Administrator Explorer` site role in order to get complete metadata from Tableau.
20+
21+
With any lower role, the Tableau Metadata API returns missing/partial metadata. This particularly affects data source fields and definitions, which impacts our ability to extract columns and generate column lineage. As such, other site roles like `Viewer` are insufficient with the current Tableau Metadata API.
22+
23+
:::
924

1025
### Ingestion through UI
1126

@@ -46,8 +61,8 @@ This ingestion source maps the following Source System Concepts to DataHub Conce
4661

4762
| Source Concept | DataHub Concept | Notes |
4863
| --------------------------- | ------------------------------------------------------------- | --------------------------------- |
49-
| `"Tableau"` | [Data Platform](../../metamodel/entities/dataPlatform.md) |
50-
| Project | [Container](../../metamodel/entities/container.md) | SubType `"Project"` |
64+
| `"Tableau"` | [Data Platform](../../metamodel/entities/dataPlatform.md) |
65+
| Project | [Container](../../metamodel/entities/container.md) | SubType `"Project"` |
5166
| Embedded DataSource | [Dataset](../../metamodel/entities/dataset.md) | SubType `"Embedded Data Source"` |
5267
| Published DataSource | [Dataset](../../metamodel/entities/dataset.md) | SubType `"Published Data Source"` |
5368
| Custom SQL Table | [Dataset](../../metamodel/entities/dataset.md) | SubTypes `"View"`, `"Custom SQL"` |
@@ -75,14 +90,15 @@ Lineage is emitted as received from Tableau's metadata API for
7590

7691
### Troubleshooting
7792

78-
### Why are only some workbooks/custom SQLs/published datasources ingested from the specified project?
93+
#### Why are only some workbooks/custom SQLs/published datasources ingested from the specified project?
7994

8095
This may happen when the Tableau API returns NODE_LIMIT_EXCEEDED error in response to metadata query and returns partial results with message "Showing partial results. , The request exceeded the ‘n’ node limit. Use pagination, additional filtering, or both in the query to adjust results." To resolve this, consider
8196

8297
- reducing the page size using the `page_size` config param in datahub recipe (Defaults to 10).
8398
- increasing tableau configuration [metadata query node limit](https://help.tableau.com/current/server/en-us/cli_configuration-set_tsm.htm#metadata_nodelimit) to higher value.
8499

85-
### `PERMISSIONS_MODE_SWITCHED` error in ingestion report
100+
#### `PERMISSIONS_MODE_SWITCHED` error in ingestion report
101+
86102
This error occurs if the Tableau site is using external assets. For more detail, refer to the Tableau documentation [Manage Permissions for External Assets](https://help.tableau.com/current/online/en-us/dm_perms_assets.htm).
87103

88104
Follow the below steps to enable the derived permissions:

0 commit comments

Comments
 (0)