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). Additionally, it ensures secure authentication via Credential Manager.
Overview
Connector Details
Connector Category | Reporting Tools |
OvalEdge Release Connector Version | Release6.3.4 |
Connectivity [How OvalEdge connects to Tableau] |
REST APIs |
Tableau Versions | 2025.1 |
OvalEdge Releases Supported (Available from) | Release3.0 onwards |
Important: The Tableau connector in OvalEdge 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
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
Source Object | Source Attribute | OvalEdge Attribute | OvalEdge Category | OvalEdge Type |
---|---|---|---|---|
Projects | Top Level Project | Report Group | Reports | Projects |
Projects | Sub Projects | Report Group | - | Projects |
Projects | Project Descriptions | Source Description | Descriptions | Projects |
Workbook | Workbook Name | Report Name | Reports | Workbook |
Workbook | Workbook Description | Source Description | Description | Workbook |
Workbook | Workbook Type | Type | Reports | Workbook |
Datasource | Datasource Name | Report Name | Reports | Datasource |
Datasource | Datasource Description | Source Description | Description | Datasource |
Datasource | Datasource Type | Type | Reports | Datasource |
Views | View Name | Report Name | Reports | Views |
Views | View Type | Type | Reports | Views |
Visuals | Visual Field | Report Column | Report Columns | Visuals |
Set up a Connection
Prerequisites
The following are the prerequisites to establish a connection:
Important: 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.
Note: 👨💻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) |
NOTE: Delta crawling requires revision history permissions to be enabled. If you are a site administrator, these permissions are enabled automatically. However, if you are using Explore (Can Publish), you must enable it manually.
Connection Configuration Steps
Important: Users are required to have the Connector Creator role in order to configure a new connection.
- Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Tableau, and complete the required parameters.
Note: 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. |
||||||
Connector Settings |
|||||||
Credential Manager* |
Select the desired credentials manager from the dropdown list. Relevant parameters will be displayed based on your selection. Supported Credential Managers:
|
||||||
License Add Ons |
|
||||||
Connector Name* |
Enter a unique name for the Tableau connection (Example: "Tableau_Prod"). |
||||||
Connector Environment |
Select the environment (e.g., PROD, STG) configured for the connector. |
||||||
Host Name* |
Hostname or IP address of the Tableau server. |
||||||
Is Token Based Auth (Y/N)* |
Tableau consists of two types of Authentication:
|
||||||
Token Name* |
Enter the Tableau's Token Name. The token name refers to the name assigned to the authentication token or key. Note: This Field is available when the Token-based authentication mechanism is selected as "Y". |
||||||
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. Note: This Field is available when the Token-based authentication mechanism is selected as "Y". |
||||||
User Name* |
You need a username to connect to the Tableau server. To access the Tableau environment, enter the service account name that has been established. Note: This Field is available when the Token-based authentication mechanism is selected as "N". |
||||||
Password* |
Enter the password of the Tableau server. Note: This Field is available when the Token-based authentication mechanism is selected as "N". |
||||||
Content URL |
Enter the name of the Tableau On-Premise site. Note: This is mandatory if you are validating with Tableau online. |
||||||
Tableau API Version* |
OvalEdge supports Tableau versions from 2.8 to 3.24. Note: Each Tableau version should have a specific API version that is compatible with it. |
||||||
Alias Host Name |
Alias Host Name helps to simplify and clarify the naming of data sources. |
||||||
Connection String* |
Configure the connection string:
Note: Replace placeholders with actual database details. |
Default Governance Roles |
|
Default Governance Roles* |
Select the appropriate users or teams for each governance role from the dropdown list. All users and teams configured in OvalEdge Security are displayed 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 OvalEdge Security 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 configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules. |
- After entering all connection details, you can perform the following actions:
- Click Validate to verify the connection.
- Click Save to store the connection for future use.
- Click Save & Configure to apply additional settings before saving.
- The saved connection will appear on the Connectors home page.
Manage Connector Operations
Crawl
Important: To perform crawl operation, users must be assigned the Integration Admin role.
The Crawl/Profile button allows you to select one or more schemas for crawling.
- Navigate to the Connectors page and click Crawl/Profile.
- Select the schemas you want to crawl.
- The Crawl option is selected by default.
- Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
- After a successful crawl, the information appears in the Data Catalog > Report / Report Column tab.
The Schedule checkbox allows automated crawling for a selected timeframe, from a minute to a year.
- Click the Schedule checkbox to enable the Select Period drop-down.
- Select a time period for the operation from the drop-down menu.
- Click Schedule to initiate metadata collection from the connected source.
- The system will automatically execute the crawl operation at the scheduled time.
Other Operations
The Connectors page in OvalEdge provides a centralized view of all configured connectors and their health status.
Managing connectors includes:
- Connector Health: Displays performance using a green icon for active connections and a red icon for inactive connections, helping to monitor the connection between OvalEdge and 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:
You can view, edit, validate, build lineage, modify connector settings and delete connectors using 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