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: In Windows
installations only, to use these proxy authentication settings, you must also
add a proxy section, including the proxy address, to the 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
|
A list of credentials profiles for connectors. Add credentials for data sources as credentials profiles
that you can use in data connections, if the connector authentication mode is
set to
Example
To learn more, see Credentials profiles for connectors. |
|
DataAdapterCredentialsFilesDirectory
|
..\..\secrets\credentials-profiles |
The path to a directory on the computer that runs the service, where you can store files containing credentials profiles for connectors. The path can be fixed or relative. Relative paths are relative to the location of the Spotfire.Dxp.Worker.Host.exe.config file on the service. Tip: If you use the setting with the default value,
you must create the directory
..\..\secrets\credentials-profiles on
the service. The directory is not available by default.
Each file in the directory represents one credentials profile. The filename is the profile name, and the file should have no file extension. Example Filename: credentials_profile_name
Note: If there is a credentials profile with the same name in
the service configuration and in a file, the profile in the file takes
precedence.
To learn more, see Credentials profiles for connectors. |
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
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
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
If you leave the value for this setting blank, the allowed
TLS versions will be
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
|
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
|
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
|
Applicable for Windows installations only.
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
|
|
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
To be accessed in the web clients, the files or directories
must also be included in the
Note: Make sure
that the specified files are compatible to be loaded in-process on the services
from which they will be accessed.
|
|
StreamingDataThrottlingRefreshIntervals
|
Determines how often to refresh data in streaming data connections, when the CPU load exceeds specified limits. Add multiple rules for variable levels of throttling. Enter throttling rules in the following format:
CPU_LOAD is an integer for CPU load percentage. REFRESH_INTERVAL is an integer for refresh interval time in milliseconds. For example:
A value of ' By default, there are no throttling rules in the setting. Then streaming data connections refresh data continuously. Note: If the CPU load does not exceed any of the CPU load
limits you define, there is no refresh interval and streaming data connections
refresh data continuously.
|
|
<Spotfire.Dxp.Data.Access.Properties.Settings>
|
||
AllowCustomQueries
|
True | Enables custom queries for users on this service. |
<Spotfire.Dxp.Data.Access.Adapters.Settings>
|
||
OAuth2ClientRegistrations
|
Settings for adding OAuth credentials for the Spotfire Web Player from a registration in TIBCO Cloud. Used to enable the authentication method TIBCO Cloud™ Authentication for the TIBCO Spotfire Data Streams connector in the Web Player. Example
Note: Your Web Player can be registered in multiple regions
at the same time. In this case, you have several
<registration issuer="My issuer">
entries and their corresponding
<client-information> under the
OAuth2ClientRegistrations setting. This is
because the
issuer differs for each region, so you
need to add the registration information to the configuration for each region
where you have registered the Web Player.
For more information about how to obtain these settings, see Client registration command register-as-tibco-cloud-client. |
|
WebAuthenticationMode
|
Prompt | Specify the authentication method to use
for connectors. Valid options are:
|
<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.
|
|
(optional)
|
The
tenant ID of your registered app in Microsoft
Azure.
Note:
When you set the tenant ID, you use single-tenant authentication when fetching the token for your registered app. If you do this, make sure that your app is configured as single-tenant. |
|
<Spotfire.Dxp.Data.Adapters.GoogleCommon.Properties.Settings>
|
Settings for adding OAuth credentials for Spotfire from a Google Cloud Platform project. Used to enable Google BigQuery and Google Analytics connectors in the web clients. |
|
ClientId
|
The
Client ID from your Google Cloud Platform
project.
|
|
ClientSecret
|
The
Client Secret
from your Google Cloud Platform project.
|
|
<Spotfire.Dxp.Data.Adapters.Salesforce.Properties.Settings>
|
Settings for adding OAuth credentials for Spotfire from a Salesforce connected app. Used to enable the authentication method Log in with Salesforce and federated authentication for the Salesforce connector in the web clients. |
|
ClientId
|
The
Consumer Key from your connected app in
Salesforce.
|
|
ClientSecret
|
The
Consumer Secret
from your connected app in Salesforce.
|
|
<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.
|
<Spotfire.Dxp.Data.Adapters.Redshift.Properties.Settings>
|
||
SettingProfiles
|
Settings profiles for data connections to Amazon Redshift. With a settings profile you can store settings from the Settings for authentication method table (see Details on Amazon Redshift Connection in the Spotfire Analyst User's Guide). Store settings and their values without having to store the settings in the analysis file. The settings are used automatically when you open the connection in a web client or Automation Services. A settings profile is similar to a credentials profile. The main difference is that a settings profile does not include the username and password. That means that you can store some settings, which you do not want to store directly in the analysis file, and still have the user enter the username and password when they open the connection. Example
Important: To use a settings profile in a
connection to Amazon Redshift, you must specify which settings profile you want
to use when you create the connection in Spotfire Analyst.
In the Amazon Redshift Connection dialog, on the Advanced tab, enter the name of the settings profile you want to use in the Settings profile field. |
|
<system.net>
|
||
<defaultProxy>
|
Applicable for Windows installations only.
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
The proxy setting is a part of .NET. 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.
Note: This section cannot be used to configure proxy servers on
Linux. On Linux, the service will instead use the operating system's default
proxy settings. However,
ProxyUsername and
ProxyPassword in this file can be used for proxy
servers with BASIC authentication.
|
|
<appSettings>
|
Configuration of third-party components.
These settings should not be edited unless instructed by Spotfire Support. |
|
<runtime>
|
.NET configuration settings.
These settings should not be edited unless instructed by Spotfire Support. |
|
<startup>
|
||
<system.serviceModel>
|