BI Validator supports Tableau testing using a combination of Tableau Rest API and Tableau Javascript Library to execute tests on Tableau workbooks.

Information When Tableau user account is configured using SAML Authentication (Active Directory), it does not create an account in Tableau directly. Tableau Rest API does not support SAML authentication at this point. So the user will need to be created in Tableau directly instead of using SAML authentication.

If you are looking to connect to Tableau Online, please refer to this article in our Support Portal.

High-Level Steps for Adding a Tableau Connection

Below are the high-level steps for adding a Tableau connection.

  1. Mouse hover over the BI Connection menu icon and select Tableau from the options that appear. The Add TABLEAU Connection wizard appears with the Credentials page.
  2. On the Credentials page, enter Tableau connection details, click Test to verify the connection, and click Next. The SSO/Web page appears.
  3. On the SSO/Web page, specify a connection type and template.
  4. Click Save and exit the wizard.

Tableau Connection Wizard 

The pages you need to set up in the Tableau connection wizard are described in the sequence below.

Credentials Page

This page contains the following:

Connection Name

BI Connection name to be created.

SignIn URL

Enter the Tableau's Signin URL in this format: http://<hostname>/#/signin

User Name

Enter the username of Tableau user.


Enter the password for the username.

REST Api Version

This is the Tableau REST API version.

Site ID

Enter the Site Id for Tableau. The Site Id can be found in the Tableau Projects URL. A sample Tableau URL and Site ID format look like this:; where Site Id is dgaps.

User Type

The type of the user in Tableau. Available user types are None and Impersonate. The Impersonate user type impersonates (pretends to be) the Tableau user and performs the required actions instead of the Tableau user. If you select Impersonate, you will need to enter the username for the Impersonate user.

SSO/Web Page

BI Validator uses Selenium or Active Directory to automate SSO/Web access. Select a template and apply it, or record your own Selenium template. For information on how to set up the Selenium connection, see the how-to-procedure here

This page contains the following:

Connection Type

Select the connection type from the drop-down list. The following two types of connections are available:

  • Selenium. This connection type allows you to record an automation script using Selenium.
  • Active Directory. This connection type verifies user's access to the Tableau in the Active Directory service. 


A template contains automation instructions based on the connection type. For example, you can have a template to log in to Tableau automatically from BI Validator. Selecting a template and clicking Apply loads the respective commands for Selenium and ActiveDirectory connection types. 

The following three types of default Templates are available:

  • Tableau_Server_Template. This is the template used to connect to the Tableau Server.
  • Tableau_Online_Template. This is the template used to connect to the Tableau Online.
  • Tableau_ActiveDirectory_Template. This is the template used to the Tableau using the Active Directory service.

The following commands are available in the default templates:

  • open. This command opens the login page in the browser for connecting to Tableau. If the connection type is Active Directory, the access is verified and the user will be logged in to Tableau automatically.
  • type. This command inputs the user's username and password in the web log-in page.
  • clickAndWait. This command sign in to the Tableau and waits until the landing page is loaded. 
  • verifyTitle. This command waits until the target or browser title is loaded.

For more information on Selenium commands, see here.


Allows you to get a selenium template from your computer into BI Validator. Click Import, browse and select a template, and then click Apply.  

Base Url

Enter the base Url of the Tableau connection. This is same as the Signin URL.

Use Custom Credentials

Select the checkbox and enter user credentials for the base URL. If you have different credentials for Web API, use custom credentials. These credentials replace the Rest API user credentials.


Allows you to record the SSO login process using the Selenium IDE. Before you start recording the script, ensure that the Selenium IDE is added to the browser.


Allows you to export the Selenium script.

For information about setting up a Selenium connection, see the how-to-procedure here.

If any of the above information is unknown to you, please contact your Tableau administrator.

Troubleshooting Connection Problems

Connection fails with the "401 : server authentication error" in the REST API step 
BI Validator uses Tableau REST API and Javascript to retrieve the Workbook and View details. The 401 error typically means that the SITE ID is not correct or the user you are trying does not have REST API access. You can know the SITE ID from the browser URL of your tableau environment.  

Basic How-To's

1. How to add Tableau Workbooks as favourites?

You can add Workbooks that you want to use frequently in test plans. 

  1. In the BI Connections tree, expand the Tableau connection and user containing the Workbook you want to add as your favourite.
  2. Locate and select the Workbook.
  3. Right-click on the Workbook and select Add To Favourites. The Workbook now appears under the Favourites folder beneath the Tableau user of the respective Tableau connection.

2. How to remove Workbook from favourites?

  1. In the BI Connections tree, expand the Tableau connection and user containing the Workbook you want to remove from your favourites.
  2. Expand the Favourites folder.
  3. Locate and select the Workbook.
  4. Right-click on the Workbook and select Remove Favourites


© Datagaps. All rights reserved.
Send feedback on this topic to Datagaps Support