# Tableau

This document outlines the integration with Tableau, enabling streamlined metadata management through features such as crawling, delta crawling, report previews, and lineage building (both automatic and manual). It also supports impact analysis and ensures secure authentication via Credential Manager.

<figure><img src="https://lh7-rt.googleusercontent.com/docsz/AD_4nXdUCWtqMAeAkuKhwg4wcu3GDJaQWE0tbuCvtzxYpL90dfrN7iowrjK2sd5LB3LjfSvGysakZSb459MnYXzZTdysQjgOeWfUZXxrHQVix9YbZqa2yFIzUQ6TKKQMxpf5RLnzik1GeA?key=8gzlrbyWOn-tPoqK24xGKAbe" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

| Connector Category                                                          | Reporting Tools     |
| --------------------------------------------------------------------------- | ------------------- |
| Connector Version                                                           | Release 6.3.4       |
| <p>Connectivity</p><p>\[How the connection is established with Tableau]</p> | REST APIs           |
| Verified Tableau Versions                                                   | 8.3 to 2025.1       |
| Releases Supported (Available from)                                         | Release 3.0 onwards |

{% hint style="info" %}
*The Tableau connector has been validated with the mentioned "Verified Tableau Versions" and is expected to be compatible with other supported Tableau versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.*
{% endhint %}

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ✅      |
| Profiling                                    |      NA      |
| Query Sheet                                  |      NA      |
| Report Preview                               |       ✅      |
| Auto Lineage                                 |       ✅      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |      NA      |
| DAM (Data Access Management)                 |       ✅      |
| Bridge                                       |       ✅      |

### Metadata Mapping

The following objects are crawled from Tableau and mapped to the corresponding UI assets.

| Tableau Object | Tableau Property       | OvalEdge Attribute | OvalEdge Category | OvalEdge Type                           |
| -------------- | ---------------------- | ------------------ | ----------------- | --------------------------------------- |
| Projects       | Top Level Project      | Report Group       | Reports           | -                                       |
| Projects       | Sub Projects           | Report Group       | -                 | -                                       |
| Projects       | Project Descriptions   | Source Description | Descriptions      | -                                       |
| Workbook       | Workbook Name          | Report Name        | Reports           | Workbook                                |
| Workbook       | Workbook description   | Source Description | Description       | Description                             |
| Workbook       | Workbook type          | Type               | Reports           | Workbook                                |
| Datasource     | Datasource Name        | Report Name        | Reports           | Datasource                              |
| Datasource     | Datasource description | Source Description | Description       | Description                             |
| Datasource     | Datasource type        | Type               | Reports           | Datasource                              |
| Views          | View Name              | Report Name        | Reports           | -                                       |
| Views          | View Type              | Type               | Reports           | View                                    |
| Visuals        | Visual Filed           | Report Column      | Report Columns    | Dimensions, Measures, Calculated Fields |

## Set up a Connection&#x20;

### Prerequisites

The following are the prerequisites to establish a connection:

#### **Service Account User Permissions**

{% hint style="warning" %}
*It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.*
{% endhint %}

{% hint style="info" %}
**👨‍💻Who can provide these permissions?** These permissions are typically granted by the Tableau administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Objects              | Access Permission                           |
| -------------------- | ------------------------------------------- |
| Connector Validation | Site Administrator or Explore (Can Publish) |
| Crawling             | Site Administrator or Explore (Can Publish) |
| Lineage              | Site Administrator or Explore (Can Publish) |
| Delta Crawling       | Site Administrator                          |
| Workbooks            | Site Administrator or Explore (Can Publish) |
| Views                | Site Administrator or Explore (Can Publish) |
| Sites                | Site Administrator or Explore (Can Publish) |
| Data Sources         | Site Administrator or Explore (Can Publish) |
| Sourcecode           | Site Administrator or Explore (Can Publish) |

{% hint style="info" %}
*Delta crawling requires revision history permissions to be enabled. These permissions are enabled automatically for site administrators. For the 'Explore (Can Publish)' role, they must be enabled manually.*
{% endhint %}

### Connection Configuration Steps

{% hint style="warning" %}
*Users are required to have the Connector Creator role in order to configure a new connection.*
{% endhint %}

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for **Tableau**, and complete the required parameters.

{% hint style="info" %}
*Fields marked with an asterisk (\*) are mandatory for establishing a connection.*
{% endhint %}

<table><thead><tr><th width="219.83331298828125">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Tableau</strong>" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the dropdown list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</li><li>Select the checkbox for Data Access Add-On to enable the data access functionality.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Tableau connection</p><p>(Example: "Tableaudb").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (e.g., PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter a brief summary or details about the connector.</td></tr><tr><td>Host Name*</td><td>Enter the Hostname or IP address of the Tableau server.</td></tr><tr><td>Is Token Based Auth (Yes/No) *</td><td><p>Tableau consists of two types of authentication:</p><ol><li>Tableau On-Premises: If the user selects ‘No’ from the dropdown, they must enter the Service Account username and password.</li><li>Tableau Online: If the user selects ‘Yes’ from the dropdown, they must provide token details. </li></ol></td></tr></tbody></table>

{% tabs %}
{% tab title="Token-based authentication - Yes" %}

<table><thead><tr><th width="220.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Token Name*</td><td>Enter the Tableau's Token Name. The token name refers to the name assigned to the authentication token or key.</td></tr><tr><td>Token*</td><td><p>Enter the Token related to the specific Token name. It </p><p>could be an API key, an OAuth token, a session ID, or </p><p>any other string used to authenticate the application with the data source.</p></td></tr><tr><td>Tableau API Version*</td><td><p>Tableau versions supported are from 2.0 up to 3.24.</p><p><em><strong>Note</strong>: Each Tableau version should have a specific API version that is compatible with it.</em></p></td></tr><tr><td>Connection String*</td><td><p>Configure the connection string:</p><ul><li><p>Automatic Mode: The system generates a connection string based on the provided credentials.</p><ul><li>Example (Tableau): https://{server}/api/2.6</li></ul></li><li><p>Manual Mode: Manually enter a valid connection string by enabling the toggle.</p><ul><li>Example (Tableau): https://{customized server}/api/2.6</li></ul></li></ul><p><em><strong>Note</strong>: Replace placeholders with actual database details.</em></p></td></tr><tr><td>Content URL</td><td><p>Enter the name of the Tableau On-Premise site. </p><p>Reference document: <a href="https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm">https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm</a></p><p><em><strong>Note</strong>: This is mandatory when validating with Tableau Online.</em></p></td></tr><tr><td>Crawl All Sites</td><td>Select <strong>Yes</strong> to crawl all sites, or <strong>No</strong> to restrict crawling to specified sites.</td></tr><tr><td>Alias Host Name</td><td>Enter the alias hostname used for connecting to the Tableau server.</td></tr></tbody></table>
{% endtab %}

{% tab title="Token-based authentication - No" %}

<table data-header-hidden><thead><tr><th width="220.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>User Name*</td><td>A username is required to connect to the Tableau server. To access the Tableau environment, enter the service account name.</td></tr><tr><td>Password*</td><td>Enter the password of the Tableau server.</td></tr><tr><td>Tableau API Version*</td><td><p>Tableau versions from 2.0 to 3.24 are supported.</p><p><em><strong>Note</strong></em>: <em>Each Tableau version should have a specific API version that is compatible with it.</em></p></td></tr><tr><td>Connection String*</td><td><p>Configure the connection string:</p><ul><li><p>Automatic Mode: The system generates a connection string based on the provided credentials.</p><ul><li>Example (Tableau): https://{server}/api/2.6</li></ul></li><li><p>Manual Mode: Manually enter a valid connection string by enabling the toggle.</p><ul><li>Example (Tableau): https://{customized server}/api/2.6</li></ul></li></ul><p><em><strong>Note</strong>: Replace placeholders with actual database details.</em></p></td></tr><tr><td>Content URL</td><td><p>Enter the name of the Tableau On-Premise site. </p><p>Reference document: <a href="https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm">https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_concepts_auth.htm</a></p><p><em><strong>Note</strong>: This is mandatory when validating with Tableau Online.</em></p></td></tr><tr><td>Crawl All Sites</td><td>Select <strong>Yes</strong> to crawl all sites, or <strong>No</strong> to restrict crawling to specified sites.</td></tr><tr><td>Alias Host Name</td><td>Enter the alias hostname used for connecting to the Tableau server.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="219.8333740234375"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the dropdown list. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="220.58331298828125"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security and Governance Admin. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="219.6666259765625"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p><strong>Example</strong>: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="220.6666259765625"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl

{% hint style="warning" %}
*To perform crawl operation, users must be assigned the Integration Admin role.*
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for crawling.

1. Navigate to the Connectors page and click **Crawl/Profile.**
2. Select the schemas to crawl.
3. The **Crawl** option is selected by default.
4. Click **Run** to collect metadata from the connected source and load it into the **Data Catalog**.
5. After a successful crawl, the information appears in the **Data Catalog > Report / Report Column** tab.

The **Schedule** checkbox allows automated crawling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the **Select Period** drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the **crawl** operation at the scheduled time.

### Other Operations

The Connectors page provides a centralized view of all configured connectors, along with their health status.

#### **Managing connectors includes:**

* **Connector Health**: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.
* **Viewing**: Click the **Eye** icon next to the connector name to view connector details, including databases, tables, columns, and codes.

#### **Nine Dots Menu Options:**

To view, edit, validate, build lineage, configure, or delete connectors, click on the Nine Dots menu.

* **Edit Connector**: Update and revalidate the data source.
* **Validate Connector**: Check the connection's integrity.
* **Settings**: Modify connector settings.
  * **Crawler**: Configure data extraction.
  * **Access Instructions**: Add notes on how data can be accessed.
  * **Business Glossary Settings**: Manage term associations at the connector level.
  * **Others**: Configure notification recipients for metadata changes.
* **Delete Connector**: Remove a connector with confirmation.

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA