Tableau Server on Windows Help

This entity is used to manage web data connector (WDC) settings. To learn more about using WDCs in Tableau Server, see Web Data Connectors in Tableau Server and tsm data-access.

Use the configuration file template below to create a .json file. After you have filled in the options with the appropriate values, pass the .json file and apply settings with the following commands:

tsm settings import -f /path/to/file.json

tsm pending-changes apply

If the pending changes require a server restart, the pending-changes apply command will display a prompt to let you know a restart will occur. This prompt displays even if the server is stopped, but in that case, there is no restart. You can suppress the prompt using the --ignore-prompt option, but this does not change the restart behaviour. If the changes do not require a restart, the changes are applied without a prompt. For more information, see tsm pending-changes apply.

Web data connector settings

The web data connector (WDC) settings in the template below specify whether WDCs are enabled, whether refresh of WDCs is enabled, and the primary and secondary safe lists. The safe lists indicate which WDC URLs are approved for use in your Tableau Server installation, and the domains or URLs that a connector can send requests to and receive requests from.

Configuration template

Use this template to configure the WDC settings.

Important: All entity options are case sensitive.

For more explanation about configuration files, entities and keys see Configuration File Example.

{
  "configEntities": {
    "web-data-connector-settings": {
      "_type": "webDataConnectorSettingsType",
      "refreshEnabled": true,
      "whitelist": {
        "https://www.example.com:443/wdc/": {
          "secondaryWhitelist": [
          "https://www.example.com/.*",
          "https://www.coolapi.com/.*"
          ]
        }
      },
      "enabled": true
    }
  }
}

{
  "configEntities": {
    "web-data-connector-settings": {
      "_type": "webDataConnectorSettingsType",
      "refreshEnabled": true,
      "whitelist": {
        "https://www.example.com:443/wdc/": {
          "secondaryWhitelist": [
          "https://www.example.com/.*"
          ]
        },
        "https://www.mysite.com:443/coolwdc/": {
          "secondaryWhitelist": [
          "https://www.mysite.com/.*",
          "https://www.coolapi.com/.*"
          ]
        }
      },
      "enabled": true
    }
  }
}

Configuration file reference

This table includes all of the options that can be included with the web-data-connector-settings entity set.

_type

Required.

Value: webDataConnectorSettingsType

Do not change.

refreshEnabled

Set to false to disable refresh of WDCs. Defaults to true.

whitelist

Required.

Can contain one or more matching sets of safe lists and secondary safe lists (one set per WDC). The first URL provided is the safe list, where you specify the WDC URL and port, formatted as follows:

<scheme>://<host>:<port>/<path>

For many WDCs, the <port> value is 443, which is the default port for HTTPS, but you can check the value for your connector by looking at the data source details on Tableau Server or Tableau Cloud.

secondaryWhitelist

Required.

Specifies the domains or URLs that a connector can send requests to and receive requests from, for example, external JavaScript libraries, REST APIs or local files. To add an entire domain to this secondary safe list, you can use a wildcard expression .* at the end of the URL, as shown in the following example:

https://www.example.com/.*

enabled

Set to false to disable use of WDCs. Defaults to true.