Spotfire® User Guide

Connectors preferences

Table 1. Apache Spark SQL preferences
Preference Description
AllowCustomProperties

Determines if you can use and configure custom properties in connection data sources, to control driver settings that are not officially supported.

When False, you cannot add or change custom properties in connection data sources. If you open a saved data connection that has custom properties, the custom properties are ignored.

Default value: True

CustomProperties

The list of driver settings available to add and use as custom properties in connection data sources.

Any setting not in the list cannot be added to a connection data source. If you open a saved data connection with a custom property that is not in the list, that custom property is ignored.

Add driver settings as a list with one value on each row.

Example:

ConnectRetryCount

ConnectRetryInterval

When empty, a default list of settings is allowed. See Custom properties for Apache Spark SQL connection data sources.

Table 2. Azure AD Authentication preferences
Note: To enable the Microsoft SharePoint Online connector in Spotfire web clients, the recommended method is to use the settings in the web service configuration files. These preference settings control the same thing, but for both installed clients and web clients. See Enabling the Microsoft SharePoint Online connector in Spotfire web clients. If you have configured both the settings in the web service configuration and the user group preferences for the logged in user, the preferences take precedence.

Settings for configuring what registered app in Microsoft Azure that Spotfire uses to be able to access data in connections to Microsoft SharePoint Online.

These settings are in effect both when you use Spotfire installed clients and Spotfire web clients.

Preference Description
ClientID The application (client) id of your registered app in Microsoft Azure.
ClientSecret The client secret from your registered app in Microsoft Azure.
TenantID The tenant id from your registered app in Microsoft Azure.
Table 3. Databricks preferences
Preference Description
AllowCustomProperties

Determines if you can use and configure custom properties in connection data sources, to control driver settings that are not officially supported.

When False, you cannot add or change custom properties in connection data sources. If you open a saved data connection that has custom properties, the custom properties are ignored.

Default value: True

CustomProperties

The list of driver settings available to add and use as custom properties in connection data sources.

Any setting not in the list cannot be added to a connection data source. If you open a saved data connection with a custom property that is not in the list, that custom property is ignored.

Add driver settings as a list with one value on each row.

Example:

ConnectRetryCount

ConnectRetryInterval

When empty, a default list of settings is allowed. See Custom properties for Databricks connection data sources .

Table 4. Google Analytics preferences

The Google Analytics preferences are used to enable the Google Analytics connector for accessing data from Google Analytics projects in Spotfire web clients.

Note: The settings for these preferences take precedence over the generic Google Authentication preferences.
Preference Description
ClientID Enter the Client ID from the OAuth credentials of your Google Cloud Platform project.
ClientSecret Enter the Client Secret from the OAuth credentials of your Google Cloud Platform project.
LocalRedirectAddressTemplate

Enter a local redirect address template to redirect OAuth responses to a custom address instead of localhost.

The format must be:

http://127.0.0.1:
{0}/authorize/code
Note: {0} will be replaced by a generated port number if you did not set one in LocalRedirectPorts.
LocalRedirectPorts

Enter the same port numbers you used in the Redirect URIs for Spotfire installed clients in the OAuth credentials of your Google Cloud Platform project.

If you specified LocalRedirectAdressTemplate, the {0} will be replaced by one of the port numbers you set here.

The default suggestion is:

55931, 55932

Note: Enter the port numbers separated by comma (,) or semicolon (;).
Table 5. Google Authentication preferences

The Google Authentication preferences are used to enable the Google Analytics and Google BigQuery connectors for accessing data in Spotfire web clients. The settings you make for these preferences affect all Google connectors.

For full instructions on how to enable the Google connectors for use in web clients, see Enabling Google connectors in Spotfire web clients.

Tip: If you want to use separate settings for each connector, use the GoogleAnalytics and Google BigQuery preferences.
Preference Description
ClientID Enter the Client ID from the OAuth credentials of your Google Cloud Platform project.
ClientSecret Enter the Client Secret from the OAuth credentials of your Google Cloud Platform project.
LocalRedirectAddressTemplate

Enter a local redirect address template to redirect OAuth responses to a custom address instead of localhost.

The format must be:

http://127.0.0.1:
{0}/authorize/code
Note: {0} will be replaced by a generated port number if you did not set one in LocalRedirectPorts.
LocalRedirectPorts

Enter the same port numbers you used in the Redirect URIs for Spotfire installed clients in the OAuth credentials of your Google Cloud Platform project.

If you specified LocalRedirectAdressTemplate, the {0} will be replaced by one of the port numbers you set here.

The default suggestion is:

55931, 55932

Note: Enter the port numbers separated by comma (,) or semicolon (;).
Table 6. Google BigQuery preferences

The Google BigQuery preferences are used to enable the Google BigQuery connector for accessing data in Spotfire web clients.

Note: The settings for these preferences take precedence over the generic Google Authentication preferences.
Preference Description
AccountsEndpoint The OpenID Connect Authorization URL, used for OAuth protocol and authentication. Google refers to it as AuthorizationServerUrl in the Google.Apis.Auth.OAuth2.Flows.AuthorizationCodeFlow.Initializer class.

Default value: https://accounts.google.com/o/oauth2/v2/auth

BigQueryEndpoint This endpoint is used to fetch the data via REST API. Google refers to it as BaseUri in the Google.Cloud.BigQuery.V2.BigQueryClientBuilder class. Configure it using this template:
https://bigquery-YOURSERVER.p.googleapis.com/bigquery/v2/

Default value: https://bigquery.googleapis.com/bigquery/v2/

ClientID Enter the Client ID from the OAuth credentials of your Google Cloud Platform project.
ClientSecret Enter the Client Secret from the OAuth credentials of your Google Cloud Platform project.
DefaultToPrivateEndpoint Determines if private endpoints will be used by default when a user creates a new data connection.

When True, users will automatically use private endpoints when creating a new data connection. If you update the private endpoints in preferences, the updated values will be taken without any further action from the users.

Default value: False.

ListAllProjects

Determines if you can see data from all your Google BigQuery projects in the Views in Connection dialog, when you create or edit a Google BigQuery connection.

When False, you can only see data from the selected billing project, as well as any additional projects specified with the Include data from additional projects setting. This can reduce the time it takes to load metadata when you open the Views in Connection dialog, especially if you have access to data in many projects.

Default value: True

LocalRedirectAddressTemplate

Enter a local redirect address template to redirect OAuth responses to a custom address instead of localhost.

LocalRedirectPorts

Enter the same port numbers you used in the Redirect URIs for Spotfire installed clients in the OAuth credentials of your Google Cloud Platform project.

If you specified LocalRedirectAdressTemplate, the {0} will be replaced by one of the port numbers you set here.

The default suggestion is:

55931, 55932

Note: Enter the port numbers separated by comma (,) or semicolon (;).
OAuth2Endpoint This endpoint gets the access token for OAuth2 authentication. Google refers to it as TokenServerUrl in the Google.Apis.Auth.OAuth2.Flows.AuthorizationCodeFlow.Initializer class.

Default value: https://oauth2.googleapis.com/token

ReadApiEndpoint This endpoint is used by the Storage Read API when you load your data on-demand, and fetches data faster. Google refers to it as Endpoint in the Google.Cloud.BigQuery.Storage.V1.BigQueryReadClientBuilder class. Configure it using this template:
bigquerystorage-YOURSERVER.p.googleapis.com:443

Default value: http://bigquerystorage.googleapis.com:443

ServerEndpoint The baseline URI for Google APIs, which is used for authentication. Google refers to it as BaseUri in the Google.Apis.Services.BaseClientService.Initializer class.

Default value: https://www.googleapis.com

ShowPublicDataCheckBox

Determine if the users can create connections to Google BigQuery where Google public datasets are available for selection.

Select from True or False.

If you select False, the check box Show public data in the Google BigQuery Connection dialog will not be available.

Table 7. IBM DB2 preferences
Preference Description
AllowCustomProperties

Determines if you can use and configure custom properties in connection data sources, to control driver settings that are not officially supported.

When False, you cannot add or change custom properties in connection data sources. If you open a saved data connection that has custom properties, the custom properties are ignored.

The default value is True.

CommandTimeout

The maximum time, in seconds, allowed for a command to be executed.

You can also set this timeout in the connection dialog, which will override the value that you specified here in the preference.

The default value of 600 seconds will be used if you neither specify a timeout in the connection dialog nor in the preference.

Note: If you set the command timeout to zero, it will be interpreted as no timeout. This means that there will be no upper limit for trying to execute the command. This is generally not recommended.
ConnectionTimeout

The maximum time, in seconds, allowed for a connection to the database to be established.

You can also set this timeout in the connection dialog, which will override the value that you specified here in the preference.

The default value of 120 seconds will be used if you neither specify a timeout in the connection dialog nor in the preference.

Note: If you set the command timeout to zero, it will be interpreted as no timeout. This means that there will be no upper limit for trying to execute the command. This is generally not recommended.
CustomProperties

The list of driver settings available to add and use as custom properties in connection data sources.

Note: Any setting not in the list cannot be added to a connection data source. If you open a saved data connection with a custom property that is not in the list, that custom property is ignored.

Add driver settings as a list with one value on each row.

Example:

ConnectRetryCount

ConnectRetryInterval

When empty, a default list of settings is allowed. See Connector for IBM DB2 — Features and settings.

Table 8. (Cloudera) Impala preferences
AllowAnalystDelegation In some environments, such as when using Kerberos, Spotfire user delegation for the Cloudera Impala connector must be allowed only for the Spotfire web client, but not for the installed client.

This setting determines whether delegation as the current Spotfire user should be allowed in the installed client. Set the preference to False to prevent delegation in the installed client.

Default value: True

AllowCustomProperties

Determines if you can use and configure custom properties in connection data sources, to control driver settings that are not officially supported.

When False, you cannot add or change custom properties in connection data sources. If you open a saved data connection that has custom properties, the custom properties are ignored.

Default value: True

CommandTimeout

The maximum time, in seconds, allowed for a command to be executed.

You can also set this timeout in the connection dialog, which will override the value that you specified here in the preference.

If you specify a timeout neither in the connection dialog nor in the preference, the default value of 1800 seconds will be used.

Note: If you set the command timeout to zero, it will be interpreted as no timeout. This means that there will be no upper limit for trying to execute the command. This is generally not recommended.
ConnectionTimeout

The maximum time, in seconds, allowed for a connection to the database to be established.

You can also set this timeout in the connection dialog, which will override the value that you specified here in the preference.

If you specify a timeout neither in the connection dialog nor in the preference, the default value of 120 seconds will be used.

Note: If you set the command timeout to zero, it will be interpreted as no timeout. This means that there will be no upper limit for trying to execute the command. This is generally not recommended.
CustomProperties

The list of driver settings available to add and use as custom properties in connection data sources.

Any setting not in the list cannot be added to a connection data source. If you open a saved data connection with a custom property that is not in the list, that custom property is ignored.

Add driver settings as a list with one value on each row.

Example:

ConnectRetryCount

ConnectRetryInterval

When empty, a default list of settings is allowed. See Custom properties for Cloudera Impala connection data sources.

Table 9. Microsoft SQL Server preferences
Preference Description
AllowCustomProperties

Determines if you can use and configure custom properties in connection data sources, to control driver settings that are not officially supported.

When False, you cannot add or change custom properties in connection data sources. If you open a saved data connection that has custom properties, the custom properties are ignored.

The default value is True.

CommandTimeout

The maximum time, in seconds, allowed for a command to be executed.

You can also set this timeout in the connection dialog, which will override the value that you specified here in the preference.

If you specify a timeout neither in the connection dialog nor in the preference, the default value of 1800 seconds will be used.

Note: If you set the command timeout to zero, it will be interpreted as no timeout. This means that there will be no upper limit for trying to execute the command. This is generally not recommended.
ConnectionTimeout

The maximum time, in seconds, allowed for a connection to the database to be established.

You can also set this timeout in the connection dialog, which will override the value that you specified here in the preference.

If you specify a timeout neither in the connection dialog nor in the preference, the default value of 120 seconds will be used.

Note: If you set the command timeout to zero, it will be interpreted as no timeout. This means that there will be no upper limit for trying to execute the command. This is generally not recommended.
CustomProperties

The list of driver settings available to add and use as custom properties in connection data sources.

Any setting not in the list cannot be added to a connection data source. If you open a saved data connection with a custom property that is not in the list, that custom property is ignored.

Add driver settings as a list with one value on each row.

Example:

ConnectRetryCount

ConnectRetryInterval

When empty, a default list of settings is allowed. See Custom properties for Microsoft SQL Server connection data sources.

Table 10. MySQL preferences
Preference Description
AllowEmbeddingCertificatesWithPrivateKeys

Determines whether users are allowed to embed certificate files that contain private keys in connection data sources. In the MySQL connector, you embed certificate files to be able to use SSL.

When set to False, you can only embed certificates with public keys.

The default value is False.

Table 11. Oracle preferences
Preference Description
AllowCustomProperties

Determines if you can use and configure custom properties in connection data sources, to control driver settings that are not officially supported.

When False, you cannot add or change custom properties in connection data sources. If you open a saved data connection that has custom properties, the custom properties are ignored.

The default value is True.

CustomProperties

The list of driver settings available to add and use as custom properties in connection data sources.

Any setting not in the list cannot be added to a connection data source. If you open a saved data connection with a custom property that is not in the list, that custom property is ignored.

Add driver settings as a list with one value on each row.

Example:

ConnectRetryCount

ConnectRetryInterval

When empty, a default list of settings is allowed. See Custom properties for Oracle connection data sources.

Table 12. PostgreSQL preferences
Preference Description
AllowEmbeddingCertificatesWithPrivateKeys

Determines whether users are allowed to embed certificate files that contain private keys in connection data sources. In the MySQL connector, you embed certificate files to be able to use SSL.

When set to False, you can only embed certificates with public keys.

The default value is False.

Fetch

The number of rows that the driver loads into memory when UseDeclareFetch is enabled.

The default value is 1000.

Note: A lower number means that less memory will be allocated, but it might cause the import to become slower.

For more information about this option, see the psqlODBC driver documentation.

UseDeclareFetch

Enable or disable the Use Declare fetch option in the driver. If enabled, the driver sends data in batches instead of loading everything into memory.

Select False to disable this option.

The default value is True.

For more information about this option, see the psqlODBC driver documentation.

Table 13. Salesforce preferences

The Salesforce connector preferences are used to configure the connector for use in Spotfire web clients.

For full instructions on how to configure the Salesforce connector for use in web clients, see the topic Configuring the Salesforce connector for Spotfire Web Clients in the Spotfire Server and Environment Installation and Administration Manual.

Preference Description
ConsumerKey Enter the consumer key obtained from your Salesforce app.
ConsumerSecret Enter the consumer secret obtained from your Salesforce app.
RedirectPorts

Enter the same port numbers used in the Callback URLs for Spotfire installed clients, that you configured in your Salesforce app.

Typically, if you followed the Salesforce configuration instructions in the Spotfire Server and Environment Installation and Administration manual, you will use the following ports:

55932, 55933, 55934

Table 14. SAP BW preferences
Preference Description
UseSapFunctionsAllowingMoreThanOneMillionCells

Enable this preference setting to allow users to work with data from SAP BW that is larger than 1M cells.

By default, this preference setting is disabled and SAP BW's MDX interface can return a maximum of 1M cells of data.

When this preference setting is enabled, Spotfire will use special functions for queries to SAP BW, which allow query results that exceed 1M cells of data.

Note: For this preference setting to have any effect, the client computer must have the BAPI driver (SAP NetWeaver RFC SDK) for the SAP BW connector installed.

For more information, see SAP Note 1232751.

Table 15. SAP HANA preferences
Preference Description
MetaDataQueryHints

Add HINTS to metadata queries in SAP HANA connections.

Specify the HINTS in an array, one HINT clause per line in the dialog:

Example:

hana_hint_1

hana_hint_2

The HINTS are included in a WITH HINT clause in the metadata queries to SAP HANA.

Example:

[…] WITH HINT ( hana_hint_1, hana_hint_2 )

Note: For information about how to use SAP HANA HINTS, see the official documentation for SAP HANA.

AllowCustomProperties

Determines if you can use and configure custom properties in connection data sources, to control driver settings that are not officially supported.

When False, you cannot add or change custom properties in connection data sources. If you open a saved data connection that has custom properties, the custom properties are ignored.

Default value: True

CustomProperties

The list of driver settings available to add and use as custom properties in connection data sources.

Any setting not in the list cannot be added to a connection data source. If you open a saved data connection with a custom property that is not in the list, that custom property is ignored.

Add driver settings as a list with one value on each row.

Example:

ConnectRetryCount

ConnectRetryInterval

When empty, a default list of settings is allowed. See Custom properties for SAP HANA connection data sources.

Table 16. Snowflake preferences
Preference Description
AllowMfaTokenCachingOnWebPlayer

Enable this preference setting to allow users to connect using the Username and password (with MFA token caching) authentication method in the web client.

By default, this preference setting is disabled.

Using this authentication method in the Spotfire web client has security implications. When you log in to a Snowflake data connection with token caching in a web client, the driver caches the token in the credentials manager on the computer running the Spotfire Web Player service. Anyone with access to the shared computer can access this token.

Table 17. TIBCO Data Virtualization preferences
Preference Description
CommandTimeout

The maximum time, in seconds, allowed for a command to be executed.

If you do not specify a value, the default value of 600 seconds will be used.

Note: If you set the command timeout to zero, it will be interpreted as no timeout. This means that there will be no upper limit for trying to execute the command. This is generally not recommended.
ConnectionTimeout

The maximum time, in seconds, allowed for a connection to the database to be established.

If you do not specify a value, the default value of 120 seconds will be used.

Note: If you set the command timeout to zero, it will be interpreted as no timeout. This means that there will be no upper limit for trying to execute the command. This is generally not recommended.
Table 18. Vertica preferences
Preference Description
AllowCustomProperties

Determines if you can use and configure custom properties in connection data sources, to control driver settings that are not officially supported.

When False, you cannot add or change custom properties in connection data sources. If you open a saved data connection that has custom properties, the custom properties are ignored.

Default value: True

CustomProperties

The list of driver settings available to add and use as custom properties in connection data sources.

Any setting not in the list cannot be added to a connection data source. If you open a saved data connection with a custom property that is not in the list, that custom property is ignored.

Add driver settings as a list with one value on each row.

Example:

ConnectRetryCount

ConnectRetryInterval

When empty, a default list of settings is allowed. See the help topic for the connector in the Spotfire User Guide.