The Auto Synchronization functionality automates creation of External Reports from the Tableau's Workbooks. This article shows how to set Auto Sync for Tableau External Reports and describes all specific details of Auto Syncing for Tableau plugin.
NOTE: Auto Synchronization is intended for creating/deleting objects, not for updating existing ones. Metadata is only synced once – when creating an object.
General Features
For Tableau, the system pulls Workbook Names, Descriptions, Tags, and Owners metadata during synchronization.
NOTE: To be able to pull this data, turn on Include metadata:
- v7.2.1+: On the Advanced tab of the Data Source Editor, expand Optional Tableau Parameters and activate the Include metadata checkbox.
- Before v7.2.1: In the Optional Tableau Parameters grid on the Info tab, set Include metadata to "true".
1. Enabling Auto Synchronization
Access Admin > Collection & Storage > Data Sources and open the Tableau Data Source.
In the Info tab, expand Content Creation Options:
- Activate the Enable Content Auto Synchronization toggle.
- Parent Category: External Reports, created during the synchronization process will be saved into the Category chosen here.
- Mirror Folder Hierarchy: Activate this checkbox to recreate the Tableau Project hierarchy as Categories under the Parent Category.
- External Report Template: Choose the Template from the drop-down menu.
- Auto Synchronization Rule (v7.2.2+): Choose whether each new External Report is based on the Workbook's default worksheet (Use default worksheet to represent Workbook, default) or on the Workbook itself (Use Workbook). Existing External Reports are not changed.
- Do not delete Element when the associated object is not found: By default, when the Workbook associated with the External Report is not found, the External Report is also deleted during synchronization. Select this checkbox to keep already created External Reports even if the Workbook is deleted.
- [Save]
2. Synchronizing the Content
Open the Tableau Objects tab (Source Objects before v7.2.0)
- [Refresh list & Sync Content] updates the Objects list and creates new External Reports placing them into the Category selected in Info tab.
- [Run History] provides data on all previous sync runs.
NOTE:
- Sync also runs each time the Object List Refresh Trigger refreshes the object list.
- Each new automatically created External Report is named after the Workbook of its origin.
- Metric Insights creates one Element per Tableau Workbook. They are stored in the Elements tab of Tableau Data Source Editor.
- If External Report was deleted or pointed at another Tableau object, syncing option will create a new External Report for this Workbook.
- If an External Report with the same name already exists, the new External Report's name gets a "(Version 2)" suffix.
- If an External Report on this Data Source already points at the same Tableau object, sync adds it to Auto Synchronization instead of creating a new one.