Spotfire.Dxp.Worker.Host.exe.config file

Settings in this configuration file affect both Web Player services and Automation Services.

For information on working with this file, see Manually editing the service configuration files.


Setting	Default value	Description
`<Spotfire.Dxp.Data.Cxx.Properties.Settings>`
`QueryCacheEntryMaxAge`	1.00:00:00 (1 day)	Use this setting to limit the lifetime for query cache data. A large value gives better response times when calculations can be reused, but the data engine query cache increases. For analyses in scheduled updates, it is a good idea to keep the cache as long as the update interval. 00:00:00 = infinity, 1.00:00:00 = 24 hours, 7.00:00:00 = 1 week, 01:00:00 = 1 hour, and so on.
`<Spotfire.Dxp.Web.Properties.Settings>`
`ProxyUsername`		If you need to use proxy handling for communication from the Web Player service or Automation Services to Spotfire Server, and the proxy server uses username and password authentication, specify the username in the `value` tags. Note: To use these proxy authentication settings, you must also add a proxy section, including the proxy address, to setting `<system.net><defaultProxy>`
`ProxyPassword`		If the proxy server uses username and password authentication, specify the password in the value tags.
`TibcoSpotfireStatisticsServicesURLs`		A list of URLs to Spotfire Statistics Services.
`TibcoSpotfireStatisticsServicesUsernames`		A list of user names for each of the URLs.
`TibcoSpotfireStatisticsServicesPasswords`		A list of passwords for each of the user names and URLs.
`DataAdapterCredentials`		If `WebConfig` is selected as authentication method for a data connector, you must add at least one credentials profile with username and password information for authentication. In the data connections that will use the credentials profile for authentication, you must specify the name of the credentials profile. You can add multiple profiles with different credentials. Credentials profile reference Each credentials profile entry should be in this format: `<entry profile="credentials_profile_name"> <allowed-usages> <entry server-regex="database\.example\.com" /> </allowed-usages> <username>my_username</username> <password>my_password</password> </entry>` `entry profile` The name of the credentials profile. The name is used to select the credentials profile for authentication in connection data sources. `allowed-usages` A list of allowed servers and connectors. You can use the credentials profile for authentication only in connections to the allowed servers, or with the allowed connectors. If `allowed-usages` is empty, you can use the credentials profile for authentication in connections to any server. Enter allowed servers as regular expressions, in the following format: `<entry server-regex="database\.example\.com" />` CAUTION: Make sure to specify the allowed servers as valid regular expressions. Values that are not valid regular expressions are ignored. If all servers are invalid, the credentials profile can be used in connections to any server. You can also enter allowed connectors. Then you can use the credentials profile for authentication in any connection that you created with that connector. For example: `<entry connector-id="Spotfire.GoogleAnalyticsAdapter" />` You can also specify both a connector id and a server in one `allowed-usages` entry, to require a specific combination of connector and server. For example: `<entry connector-id="Spotfire.SqlServerAdapter" regex="database\.example\.com">` `username` The username to use for authentication with the data source. `password` The password to use for authentication with the data source. Note: Spotfire connectors only require that the user has read privileges in the database. When you create a credentials profile, a recommended practice is to use a database user that only has the minimum required privileges for reading the data that you want to analyze in Spotfire.
`WebPlayer_AverageCpuLoadExhaustedLimit`	90	If a service instance is in the Exhausted state, no new users are routed to that instance. Specify the CPU load limit, as a percentage, that sets the state of the instance to Exhausted. Set to `-1` to disable the Exhausted limit. Note that this setting is applicable to both Web Player services and Automation Services.
`WebPlayer_AverageCpuLoadNotExhaustedLimit`	85	Specify the CPU load, as a percentage, that the instance must get below to leave the Exhausted state. Note that this setting is applicable to both Web Player services and Automation Services.
`WebPlayer_AverageCpuLoadStrainedLimit`	50	If a service instance is in the Strained state, new users are routed to other instances that are not strained or exhausted. If all instances are strained, new users are routed to the strained instance. Specify the CPU load limit, as a percentage, that sets the state of the instance to Strained. Set to `-1` to disable the strained limit. Note that this setting is applicable to both Web Player services and Automation Services.
`WebPlayer_AverageCpuLoadNotStrainedLimit`	45	Specify the CPU load, as a percentage, that the instance must get below to leave the Strained state. Note that this setting is applicable to both Web Player services and Automation Services.
`WebPlayer_AverageCpuLoadCountOnlyCurrentProcess`	False	Set to "true" to measure only the CPU load created by the instance to which a user is routed. If set to "false", the CPU load is measured for all instances on the node. Note that this setting is applicable to both Web Player services and Automation Services.
`Health_UsePagingForHealth`	True	Set to "true" to enable the use of information about data paging in determining the health status of the system.
`Health_UseTempDiskForHealth`	True	Set to "true" to enable the use of information about the temp disk in determining the health status of the system.
`Health_UseWcfStatsForHealth`	True	Set to "true" to enable the use of Windows Communication Foundation (WCF) statistics in determining the health status of the system.
`Health_ExhaustedTempDiskMb`	1500	If the amount of available disk space for the temp folder goes below this limit, the state of the instance is set to Exhausted.
`Health_LogWarnTempDiskMb`	5000	If the amount of available disk space for the temp folder is below this limit, WARN messages will be logged.
`Health_StrainedTempDiskMb`	16000	If the amount of available disk space for the temp folder goes below this limit, the state of the instance is set to Strained.
`Health_LogDebugTempDiskMb`	32000	If the amount of available disk space for the temp folder is below this limit, Debug messages will be logged.
`Health_WcfCallsPerCoreExhausted`	16	If the number of active WCF calls exceeds this limit, the state of the instance is set to Exhausted.
`Health_WcfCallsPerCoreStrained`	3	If the number of active WCF calls exceeds this limit, the state of the instance is set to Strained.
`Health_RecentPagingMinutes`	60	If the amount of recently paged out data (the latest value for `Health_RecentPagingMinutes`) in relation to the process heap is higher than `Health_StrainedRecentPagingOutShareOfHeapPercenta`ge (or `Health_StrainedRecentPagingInShareOfHeapPercentage` for paged in data), the state of the instance is set to Strained. Currently, paging will not result in an Exhausted service.
`Health_StrainedRecentPagingOutShareOfHeapPercentage`	50
`Health_StrainedRecentPagingInShareOfHeapPercentage`	20
`<Spotfire.Dxp.Internal.Properties.Settings>`		These settings should not be edited, unless instructed by Spotfire Support.
`TempFolder`	Temp	For more information, see Changing the default location of the Web Player temporary files.
`SettingsFolderName`	Spotfire Worker	/the name of the folder containing the setting for the client. These settings should not be edited unless instructed by Spotfire Support.
`SettingsRootFolder`		The path to the folder containing the settings for the client These settings should not be edited unless instructed by Spotfire Support.
`ManifestDownloadTimeoutMilliseconds`	60000	Determines the timeout, in milliseconds, for downloading the manifest.
`ClientLoadBalancing_Enabled`	True	If enabled, and if multiple Spotfire servers are used, clients will load balance requests to all Spotfire servers. These settings should not be edited unless instructed by Spotfire Support.
`AllowedTlsVersions`	Tls, Tls11, Tls12	Determines which versions of the TLS security protocol are allowed. Specify the values separated by a comma ",". For information about the possible values for this setting, refer to the .NET enum `SecurityProtocolType`. If you leave the value for this setting blank, the allowed TLS versions will be `'SystemDefault'`. If you remove the setting from the configuration file, the allowed TLS versions will be the default value; `'Tls, Tls11, Tls12'`. Note: This setting can also be changed for the Spotfire Analyst installed client, by modifying the configuration file Spotfire.Dxp.Main.dll.config.
`<Spotfire.Dxp.Application.Properties.Settings>`
`Bookmarks_MinimumSynchronizationIntervalSeconds`	60	Specifies the minimum synchronization interval for bookmarks, in seconds.
`WebServerPortAllocationCount`	-1	Determines how many ports the internal web server will bind to. All ports are bound on the loopback interface, localhost. The value for this setting should not be less than the value for `ExportRendererCount`. If a negative value is specified, this setting defaults to the number of processors on the computer.
`WebServerPortFrom`	-1	Determines the first (lowest) port that the internal web server will attempt to bind to. If a negative value is specified, this setting defaults to 8000.
`WebServerPortTo`	-1	Determines the last (highest) port that the internal web server will attempt to bind to. If a negative value is specified, this setting defaults to 65535.
`ExportRendererCount`	-1	Determines how many renderer processes are used to concurrently render pages for PDF export and other tasks. If a negative value is specified, this setting defaults to the number of processors on the computer.
`ExportRenderingTimeout`	-1	Determines the timeout, in seconds, of an export to PDF operation.
`<Spotfire.Dxp.Data.Properties.Settings>`
`DataBlockStorage_MemoryLoadExhaustedLimit`	98	If a service instance is exhausted, no new users are routed to that instance. Specify the memory load limit, as a percentage, that sets the state of the instance to Exhausted. Set to `-1` to disable the exhausted limit.
`DataBlockStorage_ MemoryLoadNotExhaustedLimit`	93	Specify the memory load, as a percentage, that the instance must get below to leave the Exhausted state.
`DataBlockStorage_MemoryLoadStrainedLimit`	75	If a service instance is strained, new users are routed to other instances that are not strained or exhausted. If all instances are strained, new users are routed to the strained instance. Specify the memory load limit, as a percentage, that sets the state of the instance to Strained. Set to `-1` to disable the strained limit.
`DataBlockStorage_MemoryLoadNotStrainedLimit`	70	Specify the memory load, as a percentage, that the instance must get below to leave the Strained state.
`DataBlockStorageStorageIOSizeKB`	64	This setting should not be edited unless instructed by Spotfire Support.
`DataOnDemand_MaxCacheTime`	01:00:00	Specify the length of time, in the format HH:MM:SS, for data on demand to be cached. This setting is used only if you configured data on demand to be cached on the web clients.
`AllowedFilePaths`		Provide the full path to directories or files on a local disk that you want to access in the web clients. Specify each file or directory in a separate `<string>` tag.
`LoadOutOfProcessExceptedFilePaths`		By default, Access, Excel, and SAS files are loaded out-of-process, which means that a separate subprocess is launched to handle loading of the file. With this setting, you can specify excepted files or directories that, when accessed in the web clients, should be loaded in-process instead. Provide the full path to directories or files that should be loaded in-process, instead of out-of-process, when accessed in the web clients. Specify each file or directory in a separate `<string>` tag. To be accessed in the web clients, the files or directories must also be included in the `AllowedFilePaths` setting. Note: Make sure that the specified files are compatible to be loaded in-process on the services from which they will be accessed.
`<Spotfire.Dxp.Data.Access.Properties.Settings>`
`AllowCustomQueries`	True	Enables custom queries for users on this service.
`<Spotfire.Dxp.Data.Access.Adapters.Settings>`
`WebAuthenticationMode`	Prompt	Specify the authentication method to use for connectors. Valid options are: `WebConfig` – Select this to require all users to connect with the credentials specified in the `Spotfire.Dxp.Web.Properties.Settings/DataAdapterCredentials` section. `Kerberos` – Select this if your system is configured to authenticate users with Kerberos. `Prompt` – Select this to prompt the users for a username and password for the external data source. `ServiceAccount` – Select this to make all users connect to the external data source using the computer account or dedicated user account that is used to run the node manager.
`<Spotfire.Dxp.Data.Adapters.MicrosoftCommon.Properties.Settings>`		Settings for the Microsoft SharePoint Online connector. The settings determine what registered app in Microsoft Azure that Spotfire uses to access SharePoint Online data. Use these settings to be able to access data with the Microsoft SharePoint Online connector in the web client.
`ClientId`		The `consumer (client) ID` of your registered app in Microsoft Azure.
`ClientSecret`		The `client secret` from your registered app in Microsoft Azure.
`<Spotfire.Dxp.Data.Adapters.SapBw.Properties.Settings>`		The settings in this group are specific to the connector for SAP BW.
`ConstrainedKerberos`	False	Determines whether you can use Kerberos authentication with constrained delegation when you access data from connections to SAP BW.
`EnableInProcessClient`	False	Determines if data connections to SAP BW are run in-process. CAUTION: When SAP BW connections run in-process, issues in the driver can cause the web player service to stop unexpectedly.
`<system.net>`
`<defaultProxy>`		If you need to use proxy handling for communication from the Web Player service or Automation Services to Spotfire Server, you must add the following proxy setting inside the `defaultProxy` tag: `<proxy proxyaddress="http://MyProxyServer:3128" scriptLocation="MyScriptLocation" />` The proxy setting is a part of the standard .NET Framework. You can find more information about this configuration at the Microsoft Developer Network (MSDN). Note: If the proxy server uses username and password authentication, you must also specify the username and password for the proxy server in the `<Spotfire.Dxp.Web.Properties.Settings>` setting.
`<appSettings>`		Configuration of third-party components. These settings should not be edited unless instructed by Spotfire Support.
`<runtime>`		Microsoft .NET configuration settings. See https://docs.microsoft.com/en-us/dotnet/framework/configure-apps/file-schema/index for more information. These settings should not be edited unless instructed by Spotfire Server.
`<startup>`
`<system.serviceModel>`