For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tableau

This article 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).

The connector establishes connectivity with Tableau through REST APIs. For Tableau On-Premises, access requires a service account username and password. For Tableau Online, token-based authentication requires a token name, token, and Content URL.

Overview

Connector Details

Connector Category

Reporting Tools

OvalEdge Release Supported

Release3.0 and later

Connectivity

[How the connection is established with Tableau]

REST APIs

Verified Tableau Versions

8.3 to 2025.1

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.

Connector Features

Feature
Availability

Crawling

✅

Delta Crawling

✅

Profiling

NA

Query Sheet

NA

Report Preview

✅

Auto Lineage

✅ To learn more, click here.

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

Report Group

Report Group

Projects

Sub Projects

Report Group

Domain

Domain

Projects

Project Descriptions

Source Description

Descriptions

Description

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

View / Visual Name

Views

View Type

Type

Reports

View

Visuals

Visual Filed

Report Column

Report Columns

Dimensions, Measures, Calculated Fields

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Service Account User Permissions

👨‍💻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.

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)

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.

Connection Configuration Steps

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

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name
Description

Connector Type

By default, "Tableau" is displayed as the selected connector type.

Credential Manager*

Select the desired credentials manager from the dropdown list. Relevant parameters will be displayed based on the selection.

Supported Credential Managers:

  • OE Credential Manager

  • AWS Secrets Manager

  • HashiCorp Vault

  • Azure Key Vault

For more details, click here.

License Add Ons

  • Select the checkbox for Auto Lineage Add-On to build data lineage automatically.

  • Select the checkbox for Data Access Add-On to enable the data access functionality.

For more details, click here.

Connector Name*

Enter a unique name for the Tableau connection

(Example: "Tableaudb").

Connector Environment

Select the environment (e.g., PROD, STG) configured for the connector. For more details, click here.

Connector Description

Enter a brief summary or details about the connector.

Host Name*

Enter the Hostname or IP address of the Tableau server.

Is Token Based Auth (Yes/No) *

Tableau consists of two types of authentication:

  1. Tableau On-Premises: If the user selects ‘No’ from the dropdown, they must enter the Service Account username and password.

  2. Tableau Online: If the user selects ‘Yes’ from the dropdown, they must provide token details.

Field Name
Description

Token Name*

Enter the Tableau's Token Name. The token name refers to the name assigned to the authentication token or key.

Token*

Enter the Token related to the specific Token name. It

could be an API key, an OAuth token, a session ID, or

any other string used to authenticate the application with the data source.

Tableau API Version*

Tableau versions supported are from 2.0 up to 3.24.

Note: The Tableau REST API version must be compatible with the Tableau Server version. For REST API version compatibility details, click here.

Connection String*

Configure the connection string:

  • Automatic Mode: The system generates a connection string based on the provided credentials.

    • Example (Tableau): https://{server}/api/3.9

  • Manual Mode: Manually enter a valid connection string by enabling the toggle.

    • Example (Tableau): https://{customized server}/api/3.9

Note: Replace placeholders with actual database details.

Content URL

Enter the name of the Tableau On-Premise site.

For more details, click here.

Note: Content URL is mandatory when Token-Based Authentication is set to Yes.

Crawl All Sites

Select Yes to crawl all sites, or No to restrict crawling to specified sites.

Alias Host Name

Enter the alias hostname used for connecting to the Tableau server.

User Name*

A username is required to connect to the Tableau server. To access the Tableau environment, enter the service account name.

Password*

Enter the password of the Tableau server.

Tableau API Version*

Tableau versions from 2.0 to 3.24 are supported.

The Tableau REST API version must be compatible with the Tableau Server version. For REST API version compatibility details, click here.

Connection String*

Configure the connection string:

  • Automatic Mode: The system generates a connection string based on the provided credentials.

    • Example (Tableau): https://{server}/api/2.6

  • Manual Mode: Manually enter a valid connection string by enabling the toggle.

    • Example (Tableau): https://{customized server}/api/2.6

Note: Replace placeholders with actual database details.

Content URL

Enter the name of the Tableau On-Premise site.

For more details, click here.

Note: This is mandatory when validating with Tableau Online.

Crawl All Sites

Select Yes to crawl all sites, or No to restrict crawling to specified sites.

Alias Host Name

Enter the alias hostname used for connecting to the Tableau server.

If the connector encounters "Access Denied" errors during crawling, verify the following configuration values:

  • Tableau REST API version is set to 3.9 or later.

  • Content URL is configured correctly.

  • Crawl All Sites is set to Yes when crawling multiple sites.

Default Governance Roles

Default Governance Roles*

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.

Admin Roles

Admin Roles*

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.

No of Archive Objects

No Of Archive Objects*

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.

Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.

Bridge

Select Bridge*

If applicable, select the bridge from the drop-down list.

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.

  1. 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.

  2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl

The Crawl/Profile button allows users to select one or more reports/report columns for crawling.

  1. Navigate to the Connectors page and click Crawl/Profile.

  2. Select the reports/report columns 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.

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.

    • Lineage: Configure Server Dialects for source code parsing and Connector Priority for table lineage connection. For more details, click here.

    • Others: Configure notification recipients for metadata changes.

  • Delete Connector: Remove a connector with confirmation.

For more details on connector settings, click here.

Limitations

Sl. No
Description

1

Tableau Hyper Reports are currently not supported in OvalEdge.

Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

Sl. No
Error Message
Error Description & Resolution

1

Error while validating connection: SSL handshake failed, unable to find valid certification path to requested target

The secured on-premises Tableau Server uses a TLS certificate that is not imported into the application.

Resolution:

  • Obtain the TLS certificate configured on the on-premises Tableau Server.

  • Import the certificate into the application using the dedicated certificate troubleshooting steps.

  • Validate the connection again after importing the certificate.

2

Error while validating connection: site not found, invalid content URL specified

The Content URL is missing or does not exactly match the Tableau site when using a personal access token.

Resolution:

  • Enter a valid site name in the Content URL field exactly as it appears in Tableau.

  • Leave the Content URL blank only when the account has server administrator access.

  • Re-enter the correct site name and validate the connection again.

3

Error while validating connection: user does not have access to the requested site

The connection account does not have sufficient access to the requested Tableau site or sites.

Resolution:

  • For access to multiple sites, request the Server Administrator role.

  • For specific sites, assign Explorer Can Publish or Site Admin Explorer individually.

  • Confirm the role change is saved in Tableau and validate the connection again.

4

Error while validating connection: unsupported API version requested

The selected API version is not supported by the connected Tableau Server or Cloud environment.

Resolution:

  • Confirm the Tableau Server or Cloud version currently in use.

  • Select the API version mapped to the Tableau version in the reference documentation.

  • If the exact version is unknown, start with the commonly supported 3.9–3.11 range and adjust based on validation results.

5

Error while validating connection: connection refused, unable to establish requested channel

The connection string does not match the security configuration of the Tableau environment.

Resolution:

  • Use https://<host>/api/<version> for Tableau Cloud and SSL-enabled on-premises Tableau Server.

  • Use http://<host>/api/<version> only when the on-premises Tableau Server does not use SSL.

  • For Tableau Cloud, always use https://.

  • For an on-premises Tableau Server that uses HTTPS with a private or self-signed certificate, import the certificate into the OvalEdge/Bridge Java truststore.

6

Error while validating connection: Error Code: 401001 Signing Error Error signing in to Tableau server.

This error occurs when the authentication request to the Tableau Server fails due to invalid or incorrect login credentials.

Resolution:

  • Verify that the Tableau Server username and password are entered correctly.

  • Re-enter the credentials and retry the connection validation.

  • Ensure that the account has the required permissions to access Tableau Server.

  • For details related to other error codes, refer to the Tableau - Handling Errors in the REST API.

FAQs

S. No
Question
Answer

1

What is the difference between a personal access token and a username and password when connecting to Tableau?

Two authentication methods are available:

  • Personal Access Token: Preferred for both Tableau Server and Tableau Cloud.

  • Username and Password: Available only for Tableau Server.

  • Tableau Cloud requires a personal access token.

  • Username and password can be used for Tableau Server when the user doesn’t want to generate a Personal Access Token.

2

Why does the Content URL field sometimes need a site name and sometimes not?

The Content URL field is used to enter the Tableau site name.

  • Personal access token: A site name is required.

  • Username and Password: The Content URL can be left empty unless the account has Server Administrator access to all sites.

3

What level of access is needed on the Tableau side to allow crawling to work correctly?

The required access depends on the number of sites being crawled:

  • Site Admin Explorer: Suitable for specific individual sites.

  • Explorer Can Publish: Can also be used for relevant sites.

  • Server Administrator: Recommended when crawling many or all sites.

  • Server Administrator access removes the need to configure roles separately for each site.

4

Is a certificate always required to connect to an on-premise Tableau server?

No. A certificate is required only when the on-premise Tableau server is secured and a TLS-related connection issue occurs.

  • No certificate is required for a non-secured server.

  • No certificate is required when a trusted secure connection is already established.

  • A certificate becomes relevant when a secure channel cannot be created.

5

How can a personal access token be generated inside Tableau?

A personal access token can be created from the Tableau account settings.

  • Enter a name for the token and create it.

  • Copy and securely store the token value immediately.

  • The token value is displayed only once and must be entered in the connection setup form.

6

How can a cloud-based Tableau environment be distinguished from a server-based environment?

The environment type is mainly identified by the host name entered during setup.

  • Server: Usually uses a private domain name or IP address.

  • Cloud: Uses a domain configured for cloud access and may use a custom domain name.

  • Token-based authentication is recommended for both environments and is mandatory for Tableau Cloud.

7

What is the Alias Host Name field used for?

The Alias Host Name field is used when the connection address and report-preview address are different.

  • The main connection address is used for validation and API calls.

  • The alias is used to open and preview reports.

  • The alias allows report previews to redirect to the domain normally used for viewing reports.

8

What does Validate check?

Validate checks only the Tableau sign-in.

  • A successful validation means Tableau returned a token.

  • A successful validation does not confirm that projects or TWB files are accessible.

  • If validation succeeds but crawling returns no content, verify the required View and Download rights, Content URL, or Crawl All Sites configuration.

9

What does error 401001 or a sign-in error indicate?

A 401001 or sign-in error can occur when the authentication details or site configuration are incorrect.

  • Verify the username, password, or personal access token.

  • Confirm that the user has access to the specified Content URL site.

  • Revalidate the connection after correcting the authentication or site details.

10

Does the connector modify Tableau content?

No. The connector performs read-only operations against Tableau.

  • Signs in to Tableau.

  • Lists metadata.

  • Downloads XML content.

  • Does not publish or delete Tableau content.

11

Are Owner, Steward, and Custodian Tableau login roles?

No. Owner, Steward, and Custodian are OvalEdge governance roles.

  • These roles are used for governance within OvalEdge.

  • These roles do not represent Tableau authentication accounts.

  • These roles do not sign in to Tableau.

12

Is the Port field used for Tableau API connectivity?

No. The connection uses the following format:

https://{host}/api/{version}

  • A separate Port value is not used.

  • The API version must match the supported XSD.

S. No
Question
Answer

1

How is the Tableau structure of site, project, workbook, and view reflected while crawling?

Tableau uses a layered content structure:

  • Site: Separate content space.

  • Project: Organizes content and controls access; projects can contain sub-projects.

  • Workbook: Located within a project and contains one or more views.

  • View: Represents a worksheet or dashboard.

During crawling, the structure is represented as Site + Project → Workbook → View.

2

What happens when a parent folder is selected for crawling instead of a specific subfolder?

Selecting a parent folder does not automatically crawl all content inside its subfolders.

  • The parent folder crawl retrieves reports and data sources directly under that folder.

  • Subfolders must remain selected to include their content.

  • Subfolders are selected by default unless deliberately turned off before crawling.

3

What is delta crawling and how does it decide what to bring in?

Delta crawling retrieves only reports that are new or changed since the previous crawl.

  • The connector checks the modified date and created date of Tableau reports.

  • Only items with a newer date than the previous crawl are retrieved.

  • This avoids crawling the entire Tableau environment again.

4

Why are dashboards, worksheets, and different chart types all shown as the same type in the catalog?

Tableau uses View as the technical term for these content types.

  • A worksheet is a view.

  • A dashboard is a view containing multiple views.

  • Chart types such as bar charts and pie charts are also represented as views.

  • The catalog therefore represents these Tableau objects consistently as View.

5

Why do some column names appear duplicated when looking at a workbook or view?

Column information at the workbook or view level combines columns used across the individual visuals.

  • The same column used in multiple visuals appears multiple times.

  • Each individual usage is counted rather than merged into one entry.

  • This is expected behavior and does not indicate an error.

  • Reviewing the specific visual in Tableau shows where the column is used.

6

Why is validation successful but the crawl returns no content?

A successful validation confirms that sign-in worked, but does not confirm access to Tableau content.

  • Verify View and Download permissions.

  • Verify the Content URL configuration.

  • Enable or verify Crawl All Sites when content from multiple sites is required.

7

Does the connector download Tableau extracts?

No. Tableau content APIs are called with includeExtract=false.

  • Hyper extract files are not downloaded.

  • The connector retrieves the required metadata and XML content instead.

8

Why is source code empty after crawling?

Lineage cannot be built when the required source code is not available.

  • Verify that the account has Download rights.

  • Recrawl the required reports so the TWB/TDS source code is stored.

  • Run the lineage process after the source code becomes available.

9

Which jobs should be run for Tableau metadata and lineage?

Use the following sequence:

  • Validate the Tableau connection.

  • Crawl the selected report groups.

  • Build Lineage after crawling.

  • Do not expect a Profile job for this workflow.

10

How are Tableau objects mapped in OvalEdge?

Tableau objects are mapped as follows:

  • Site + Project → Report Group

  • Workbook / DataSource → Report

  • View/Dashboard → Report (Sub-report)

S. No
Question
Answer

1

What is a semantic table and why does it appear in lineage?

A semantic table represents how a Tableau data source is built.

  • It can represent a direct table connection, custom SQL combining multiple tables, a file, or another combination.

  • It provides an accurate representation when the data source is not a one-to-one copy of a source table.

  • The semantic table is temporary and represents the data-source structure only.

  • It does not exist as an actual object in the original source system.

2

Why does an inline data source not appear as a separate item in the catalog?

An inline data source is embedded directly inside a workbook rather than published separately.

  • Published data source: Appears as a separate catalog item and can be reused across workbooks.

  • Inline data source: Exists only within the workbook and does not appear separately in the catalog.

  • During lineage creation, a temporary object represents the embedded data source so the lineage remains complete.

3

Does crawling build lineage automatically?

No. Crawling and lineage are separate processes.

  • The crawl stores the Tableau XML content.

  • The lineage job reads the stored source code.

  • Run the lineage job after the crawl to build lineage.

4

How does lineage work for Tableau Hyper reports?

Tableau Hyper reports use saved data extracts rather than live database connections.

  • OvalEdge creates a temporary stand-in table for the Hyper data source.

  • The temporary table is connected to the Tableau report in lineage.

  • The original database tables, such as Snowflake or MySQL, are not connected back to the Tableau report.

  • Hyper report lineage is therefore partial and does not show the complete path to the original database.

5

What is the difference between Hyper and non-Hyper lineage?

Hyper reports:

  • Use saved extracts rather than live database tables.

  • Use a temporary table in OvalEdge.

  • Provide partial lineage only.

Non-Hyper reports:

  • Can use live tables, files, or SQL.

  • Can usually connect the real source to the Tableau report.


Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA

Last updated

Was this helpful?