Prepare migration after upgrading to Tableau 2020.2 or newer

If you upgraded to Tableau version 2020.2 or newer, but previously synchronized an older version via XML mapping, Data Catalog changes the full names of your Tableau assets to match them to their counterparts in Tableau. This is necessary to prevent losing manually added relations, attributes, tags, comments and stitching results.

You only have to follow these steps once after your upgrade to Tableau 2020.2 or newer. After that, you can follow the default synchronization process.

Prerequisites

• You have registered Tableau.
• You have connected a Tableau Server asset to a Tableau Server or Tableau Online.
• You have a resource role with the Configure external system resource permission, for example, Owner.
• You have a resource role with the Asset > Update resource permission.
• You have a global role with the Catalog global permission, for example, Catalog Author.
• You have previously ingested Tableau 2020.1 or older and have since upgraded to Tableau 2020.2 or newer.
• Your Tableau user has the right permissions to synchronize Tableau 2020.2 or newer.
• You have enabled the Tableau metadata API in Tableau.

Steps

1. Match the names of all Tableau Report Attributes assets of a Tableau Workbook with their counterparts in Tableau.
   1. Open a Tableau Report Attribute asset page.
   2. Click Edit.
      The Edit <asset name> dialog box appears.
   3. Change the name of the asset to the exact name used in Tableau.
   4. Click Save.
   Tip We highly recommend that you also match the display names of Tableau Data Attribute assets, Tableau Data Entity assets and Tableau Data Model assets. While Data Catalog automatically tries to match these assets to their counterparts in Tableau based on the Tableau Report Attribute asset, making sure the Tableau assets have the same name helps to prevent issues. Unless you manually changed their names in Data Catalog, the names should already be the same as their counterparts in Tableau.
2. Optionally, create a backup of your Collibra environment.
Note We highly recommend that you create a backup before you synchronize a Tableau Server to prevent losing data in Data Catalog if something goes wrong during the migration process.
3. Enable the Tableau metadata API in Collibra Console.
4. Synchronize a Tableau Server asset after working hours.
   Note We highly recommend that you synchronize the first time after upgrading to Tableau 2020.2 or newer 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.
   1. Open a Tableau Server asset page.
   2. In the tab panebar, click Configuration. In the tab panebar, click Configuration.
   3. In the Tableau sites section, do the following:
      1. Select one or more sites.
      2. Enable or disable report images as required for each site.
         
         Note Images are never downloaded or stored in Data Catalog. Depending on the Report image setting, Data Catalog either ignores images completely or stores a link to the image on Tableau and loads that image when you open the relevant asset page.
   4. In the Tableau sites section, click Synchronize now.
      
   The synchronization job appears in the Activities list as a bulk synchronization.
   The full names of the Tableau assets are updated to include the GraphQL ID.
   The log files show a summary of the migration process.

   Example 

   "Summary of tableau xml to graphql data migration for site with id <Tableau-site-ID> and name <Tableau-site-name> executed on server"

   The log files also show how many Tableau assets were found in Data Catalog and how many were migrated to match their counterparts in Tableau.

   Example 

   "Found 50 existing xml assets to migrate.";
   "Migrated 48 assets.";

   If some Tableau assets could not be migrated, Collibra Data Intelligence Platform recreates the Tableau asset so that it matches in Tableau. The log file shows how many and which assets were recreated in Data Catalog.

   Example 

   "It was impossible to migrate 2 assets. These assets were re-created based on graphql data.";
   	List of assets that were not migrated:
   		ID: xxxxxxxx-xxxx-xxxx-xxx, Fullname: Tableau-migration > tableaumigration.xxxxx > [tableau-migration-asset-name-1] (Tableau Report Attribute).",
   		ID: xxxxxxxx-xxxx-xxxx-xxx, Fullname: Tableau-migration > tableaumigration.xxxxx > [tableau-migration-asset-name-2] (Tableau Report Attribute)."