When you register or synchronize a Tableau Server, Data Catalog uses the Tableau APIs to ingest the Tableau metadata. Data Catalog uses different APIs depending on your version of Tableau. This happens automatically and should have little impact on the resulting assets. However, if you synchronize Tableau 2020.2 or newer, you must perform a few extra actions.
Tableau versions
The following table shows which APIs Data Catalog uses to register or synchronize a Tableau Server.
|
Tableau versions using the REST API and XML parsing |
Tableau versions using the REST API in combination with the GraphQL metadata API |
|---|---|
|
|
Warning If you upgrade to Tableau version 2020.2 or newer, but previously synchronized an older Tableau version via the REST API and XML mapping, you have to prepare the migration procedure to prevent losing manually added relations, attributes, tags, comments and stitching results.
Differences between the metadata API and XML parsing via REST API
The following table shows the differences and similarities between the metadata API and the REST API with XML parsing.
|
Part of synchronization process |
REST API and XML parsing |
Metadata API |
|---|---|---|
|
API |
Data Catalog connects to Tableau via the REST API and uses custom parsing mechanisms. The result is XML data. |
Data Catalog connects to Tableau via the REST API and the metadata API. The result is GraphQL data. Note We highly recommend that you synchronize Tableau after working hours. This is necessary to make sure that no Tableau data is added, changed, renamed or deleted on Tableau's side during the synchronization process. If there are any inconsistencies between the Tableau data collected via the REST API and Tableau data collected via the GraphQL metadata API, the corresponding Tableau assets are not synchronized in Data Catalog.
|
|
Settings |
You don't need change any settings to start Tableau synchronization. |
You have to enable the Tableau metadata API in Collibra Console before you can ingest or synchronize. Note Also make sure that the Tableau metadata API is enabled in Tableau. |
|
The resulting Tableau assets that are created after registering or synchronizing a Tableau Server are similar and mainly depend on the permissions of your Tableau user. |
||
|
Performance |
Performance results are similar. |
|
|
Collibra Data Intelligence Platformpermissions |
The required permissions are the same: a resource role with the Configure external system resource permission. |
|
|
Stitching works the same. |
||
Migration procedure
When you synchronize a Tableau Server for the first time after you upgraded to Tableau 2020.2 or newer, Data Catalog tries to match your Tableau assets that were previously ingested via the Tableau REST API in Data Catalog to their counterparts in Tableau. If the asset names match, Data Catalog changes the full name of the Tableau assets without removing manually added data and stitching results.
To make sure Collibra Data Intelligence Platform is able to match your Tableau assets in Data Catalog to their counterparts in Tableau, you must prepare the migration procedure.
Tip We highly recommend that you create a backup of your Collibra environment before synchronizing a Tableau Server asset after you upgraded to Tableau 2020.2 or newer. We also recommend that you synchronize the first time after working hours.