Tableau Cloud Help

This topic describes the Bridge client and requirements for running and using it. In most cases, the site admin is responsible for installing and managing the client.

Client overview for Linux and Windows

• The Bridge client is required to enable connectivity between Tableau Cloud and private network data.
• The connected client option must be enabled for the site to allow Tableau Bridge clients to run unattended and, if enabled, support multi-factor authentication with Tableau authentication.
• Client sessions are managed by refresh tokens which are generated after a successful sign-in to Tableau Cloud from the Bridge client. If the refresh token has not been used in 14 days, then it expires. After the refresh token has expired, a new sign-in to Tableau Cloud is required. If a refresh token is being used regularly, their expiration period depends on when a site was activated. Refresh tokens generated on sites activated in June 2023 (Tableau 2023.2) or later expire after 180 days. Refresh tokens generated on all other sites expire after one year.
• Only one client can be installed on a machine.
• The appropriate database drivers must be installed on the machine where the client is running.
• For extract connections, the user signed in to Tableau Cloud from the client must have a Creator, Explorer (Can Publish), or one of the two types of site admin role: Site Administrator Creator or Site Administrator Explorer. If the user is not a site admin, he or she must be the content owner.
• For live connections, the user signed in to Tableau Cloud from the client must have one of the two types of site admin roles: Site Administrator Creator or Site Administrator Explorer.
• To maintain live connections, the databases that the Tableau content connect to can't be accessible from the public internet.

About the Linux Bridge Client

You can deploy the Tableau Bridge client within a container on Linux. To use Bridge on Linux you must create a customized Docker image, install the RPM package, and then run Bridge from inside the container image. See Install Bridge for Linux for Containers.

About the Windows Bridge Client

When the client is running, it's accessible from the Windows system tray on the machine where it is installed.

The client is comprised of the following parts:

1. Client name, which is also the name of the machine where the client is installed.

2. Connection status indicates whether the client is connected to Tableau Cloud.

3. Site: The Tableau Cloud site that the client is registered to.

4. Settings menu, which contains options to disable error reports and unlink the client from a site.

5. Data sources: By default, this area displays a list of live queries that are being load balanced (or pooled) by clients across the site. This list can also contain data sources that have been assigned to this specific client using Bridge (legacy) schedules.

   Note: This list does not show data sources or virtual connections that are refreshed with the Bridge refresh schedules. To see data sources or virtual connections refreshed with Bridge refresh schedules, go to the Jobs page and filter on Bridge Refreshes.

6. Pooling status: This shows whether the data source is part of the client pool.
   • Live: A Live status indicates the data source has a live connection and is part of the pool of clients. Note: Virtual connections with live connections do not show in this list.
   • Blank: A blank status indicates the client is not part of the pool. This is because the data source is using Bridge (legacy) schedules.

7. Legacy options: These options display on hover to edit or view connection information, go to the schedule, and run a manual refresh on hover for data sources that use Bridge (legacy) schedules.

8. Client mode indicates if the client is running as a Windows application or service. For more information, see the section below.

Windows Requirements for extract connections

• To refresh extracts, the client can run as a Windows service or as an application.

• If the client is set to run as an application, it completes refreshes only when the machine is powered on, and the Windows user is logged on and running Bridge.

  If the machine is turned off, if the user logs off of Windows, or if the user exits the client, updates for the data sources or virtual connections running on that client (either through the pool or manually) will not be able to reach Tableau Cloud, and the data sources or virtual connections won't get refreshed until the user signs in again. During this time, the content owner will receive refresh failure notification emails from Tableau Cloud. For more information, see Stop Keeping Data Fresh Through Bridge.

• To ensure refreshes of file-based data sources complete without any issues, a client that has been set up to run as a service must reference the full UNC path of the source file and not the mapped drive path. For example, use "\\filesrv\Data\file.csv" instead of "C:\Data\file.csv".

  For a client that has been set up to run as an application, we strongly recommend that the client also references the full UNC path. For more information, see Change the file path for a data source.

Windows Requirements for live connections

• To run live queries, the client can run as a Windows service or as a Windows application.

• Each Tableau Cloud site can have multiple clients that maintain live connections. Those clients can also be used to refresh extracts.

• If the client is set up to run as an application, live queries can only occur when the computer is on and the Windows user is logged on and running Bridge.

  If the computer is turned off, if the user logs off of Windows, or if the user exits the client, updates to the data sources or virtual connections will not be able to reach Tableau Cloud, and the content can't be kept up to date.

Application versus Service mode

A client can operate in one of two modes: Application or Service.

The mode the client can run depends on the Windows user account it's running under, the Tableau Cloud site settings that the client is registered to, and general data freshness needs.

• Application: When the client is set to run in Application mode, it runs as a Windows application.

  In this mode, the client can facilitate live queries and scheduled refreshes for content that connects to private network data while the dedicated user is logged on to Windows. If the dedicated user logs off Windows, the client cannot maintain live queries and refresh extracts on a schedule.

• Service: When the client is set to run in Service mode, it runs as a Windows service.

  In this mode, the client runs continuously even if the user is logged out of Windows. The Windows user account must be a member of the local Administrators group to run the client in service mode. This mode is recommended for pooled clients that load balance live queries and scheduled refreshes. Service mode is the default mode.

Mode guidelines

	Extract connection with scheduled refresh	Live connection
Application mode	Quickly set up and validate that the client is keeping content up to date. Have more control over when the client is performing data freshness tasks. Doesn't require the user to be a local admin on the machine. Requires the user to be logged on to Windows.
Service mode	Set up the client once — if the machine has to restart, the client reconnects to Tableau Cloud automatically. Requires the Windows user account to be a member of the local Administrators group on the machine. In addition, to refresh file-based data sources, the account must have domain access to the network shared drive where the file data is hosted. Doesn't require the user to be logged on to Windows.
	Recommended for load balancing refreshes. For more information, see Configure the Bridge Client Pool.	Recommended for load balancing live queries. For more information, see Configure the Bridge Client Pool.

 

Windows Client requirements

In order to run and use the client, a certain set of requirements must be met as well as some additional requirements that are unique to the data freshness task.

Core requirements

• Microsoft Windows 10 or later, 64-bit

• Windows Server 2016 or later

• Tableau recommends installing the Bridge client on a dedicated computer behind your firewall.

• The computer on which the client is running must be on the same Windows domain and have access to the underlying database specified in the data source or virtual connection.

• Both the computer and the Windows user account must have access to the underlying data specified in the data source or virtual connection.

• Tableau Cloud's connected clients option must remain enabled to allow the client to run unattended and, if enabled, support multi-factor authentication with Tableau authentication. For more information about the connected clients option, see Connected client requirement for Tableau Bridge.

For more information, see Bridge is designed to scale up and scale out. When configuring your Bridge deployment, consider the following:.

Additional requirements for Service mode

• To run the client in Service mode, the Windows user account running Bridge must be a member of the local Administrators group on the machine. The user doesn't need to be logged on to Windows, but the machine must be powered on with Windows running.

• When using the client in Service mode and connecting to file data hosted on a network shared drive, it's required that the account have domain access to the network shared drive.

Repair a client running in Service mode

Occasionally something causes content connections to stop functioning normally. When this happens, an alert appears, and it usually provides information that direct you toward the cause of the problem. However, if Tableau Cloud cannot provide troubleshooting information in the alert, and if you run Tableau Bridge as a service, you can use the Repair command to try to reset connections.

To help repair a client in Service mode, in the Windows system tray, right-click the Bridge icon and select Repair. This stops and restarts the service, which can be enough to resolve the issue.

Temporary files

The Bridge temporary files are located in the C:\Users\<username>\AppData\Local\Temp folder.

Temporary files are periodically removed when connected to Tableau Cloud or after you close the client.

• After a refresh, the TEMP_* files are removed.

• The hyper_ files are deleted after the Bridge client is closed.

• The TableauTemp folder isn’t removed due to system requirements.

The cleanUpTempDirOnStartUp client setting determines whether to remove the temp files when the Bridge client starts. When set to false, the temp files are not removed.