Synchronize Tableau site manually

Warning The end of life of Jobserver and all related Jobserver integrations has been announced for September 30, 2024. This means that the Tableau via Jobserver integration method is deprecated and will also reach its end of life on September 30, 2024. To integrate Tableau metadata and create lineage, please use Edge or lineage harvester.

You can manually start a synchronization job of a Tableau Server asset. This can be useful if you don't want to wait for the scheduled job to synchronize your Tableau sites.

Warning You can choose which sites to synchronize after successfully connecting to Tableau. Select the same or more sites when you synchronize again. If you only synchronize some of the Tableau sites, Data Catalog deletes all other Tableau sites and their content from Collibra Data Intelligence Platform.

Tip You can also add a synchronization schedule to synchronize automatically.

Prerequisites

Tip 

The prerequisites for this procedure are different if you have Tableau 2020.1 or older you or if you have Tableau 2020.2 or newer.

  • 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 global role with the Catalog global permission, for example, Catalog Author.
  • You have a role with the following resource permissions on the Tableau community you create when you register a Tableau server:
    • Asset: add
    • Attribute: add
    • Domain: add
    • Attachment: add
  • If you want to stitch Tableau's logical data layer to Data Catalog's physical data layer, the Tableau user must have the Download/Save As permission on the data source.

  • You have enabled the Tableau metadata API in Collibra Console and in Tableau.

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.

Steps

  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. Click Save Configuration.
  5. In the Tableau sites section, click Synchronize now.
    The synchronization job appears in the Activities list as a bulk synchronization.
    Note We highly recommend that you synchronize a Tableau Server version 2020.02 and 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. 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.

Tip If your Tableau synchronization fails, go to the troubleshooting section to find a solution.

What's next?

When the synchronization finishes, the resulting assets, including their attributes and relations, are created, edited or deleted in the selected domain and in the Data Sources page of Data Catalog.

If you have stitched Tableau's logical data layer to Data Catalog's physical data layer, you have to restitch to make sure that all relations are up to date.