Configuration File Example

This article provides an example of a complete JSON configuration file, with gatewaySettings and identityStore entities specified. In addition, a configuration key sets the gateway timeout to 900 seconds.

Your configuration file will look different depending on the options you need to set.

You might set multiple .json configuration files during installation. To set the values for each file in Tableau Server, you run the following command, once for each configuration file:

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

After you set the configuration files, run tsm pending-changes apply to apply the changes from all of the .json files you’ve set.

{
   "configEntities": {
      "gatewaySettings": {
         "_type": "gatewaySettingsType",
         "port": 80,
         "firewallOpeningEnabled": true,
         "sslRedirectEnabled": true,
         "publicHost": "localhost",
         "publicPort": 80
      },
      "identityStore": {
         "_type": "identityStoreType",
         "type": "local",
         "domain": "example.lan",
         "nickname": "EXAMPLE"
      }
    },
     "configKeys": {
        "gateway.timeout": "900"
     }
}

Entities vs keys

As shown in the example above, there are two classes of configuration parameters: configEntities and configKeys.

configEntities

Certain types of configuration are done through entity sets that map to specific scenarios, such as the identity store and gateway configurations. When you pass a set of configEntities with the tsm settings import -f path-to-file.json command, TSM validates the configuration. If values passed are invalid, TSM will provide an error. This enables you to make changes during the configuration process, rather than experience a configuration failure at initialization or run time.

Entities can be set only by including a configEntities block in a .json file.

Important: All files that are referenced in configEntities must be located on the local computer. Do not specify UNC paths.

configKeys

Entities cover only a small portion of the configuration values that can be set. Hundreds of keys correspond to parameters stored in .yml files. Tableau Server uses these parameters to store all of the configuration information for all services.

You can set individual keys with the tsm configuration command. But during deployment, setting them along with other configuration scenarios in JSON files, as shown above, is more convenient.

Unlike configEntities, configKeys are not validated.

Note: We do not recommend setting parameters that are not documented in tsm configuration set Options.

Thanks for your feedback! There was an error submitting your feedback. Try again or send us a message.