Linux Client Settings

To make changes to the configuration settings, edit the TabBridgeClientConfiguration.txt file, and create a new Docker container with the updated file. For more information about how to create and update a container, see Containerize an application.

Configuration Configuration Option Configurable for Linux? Description
serviceConnectionSettings serviceUrl No Tableau site URL.
  proxyServer Yes Proxy Server and port.
connection connectTimeout Yes The Bridge client wait time when trying to connect to Tableau Cloud.

Default value: 1 minute

  operationTimeout Yes The Bridge client wait time for each server (such as VizPortal) API call after successfully connecting to Tableau Cloud.

Default value: 15 minutes

  maxAttemptsToRedirectHttpRequests No An API call to a server can be redirected from POD to POD. This number specifies the maximum number of redirects per server API call.

Default value: 20

connectionPool Size No Applies to Online schedules.

The number of refresh tokens generated at the time of login. The Bridge client uses refresh tokens when a connection to Tableau Cloud is needed. Refresh jobs are processed simultaneously and each job needs a token.

Default value: 10

Minimum value: 1

Maximum value: 100.

Changing this value requires unlinking the client.

dataSourceRefreshSettings shutdownTimeoutInSeconds N/A Obsolete. Not supported.
  downloadDataSourcesInterval No The time interval for the temporary downloading the names of live data sources and extract data sources that are assigned to the client for Legacy schedules.

Default value: 30 minutes.

  checkRefreshDataSourcesInterval No The time interval for the Bridge client to check data sources assigned to the client to establish if a refresh is needed for Legacy schedules.

Default value: 5 seconds

  extractRefreshTimeout Yes Enforces a time limit for refreshes performed by the client. The timeout limit is the longest allowable time for a single extract to complete a refresh before it's canceled by the client. If an extract refresh is canceled as a result of reaching the timeout limit, you will see a message in the client and an email alert will be sent to the data source owner.

Default value: 24 hours.

For virtual connections, the default extract refresh timeout limit is 2 hours and is controlled on by Tableau Cloud The time limit can’t be controlled by the Bridge client.

  maxRemoteJobConcurrency No Applies to Online schedules.

Maximum number of remote refresh jobs allowed by the client. The value for this configuration must be the same or less than connectionPool. Adjust the maximum value to your machine's capabilities such as CPU and RAM. Requires a restart of the client.

Default value: 10

Minimum: 1

Maximum: The value for conectionPool

  JSONLogForExtractRefresh Yes When set to true, the client generates an additional log file in JSON format. The log captures the metrics of extract refreshes, for both Legacy and Remote refreshes, with one line per extract.

The format of the JSON log file is readable by Tableau Desktop and can be used as a data source to create live vizzes. For more information, see JSON File.

Changing the value of this configuration option requires a restart of the Bridge client. .

Default value: false

  dataSources No Applies to Legacy schedule refresh jobs. Not user editable.

Provides a list of mapped local file locations for file-based data sources.

loggerSettings maxLogFileSizeInMB No Maximum size of the log files in MB. When a log file exceeds the size limit, a new log file is created.

Default value: 25 MB.

  maxBackupLogFileCount No Maximum number of allowed Bridge log files. When the number of log files exceed the limit, the oldest log file is deleted.

Default is 40.

  remoteRequestLogFileLifeSpan No For each Bridge Refresh job that is sent to the client, a new set of log files is created: tabbridgeclijob_<process_id, and if the data source is JDBC-based: fjprotocolserver_<process_id>, and stdout_jprotocolserver_<process_id>.

By default, the maximum amount of time the log files remain in the Logs folder before being deleted is 8 hours if the number of log files exceeds maxBackupLogFileCount. Otherwise, these log files remain indefinitely while the number of log files is less than or equal to maxBackupLogFileCount.

<process_id> represents the Windows process ID.

Default value: 8 hours

dataSyncRestartInterval   Yes

Sets the restart interval of the Data Sync.

internetConnectionMonitorInterval   No Interval for Bridge to ping the internet to determine if there is a valid connection.

Default value: 30 seconds

secureStorageMonitorInterval   N/A Obsolete. Not supported.
cleanUpTempDirOnStartUp   No Determines whether to remove the temp files when the Bridge client starts.

Default value: true

JSONLogForLiveQuery   Yes When set to true, the client generates an additional log file in JSON format. The log captures the metrics of live query request, with one line per extract.

The format of the JSON log file is readable by Tableau Desktop and can be used as a data source to create live vizzes. For more information, see JSON File.

Changing the value of this configuration option requires a restart of the Bridge client.

Default value: true

Thanks for your feedback!