Connectors Preferences


Preference Group/Preference

Description

   Apache Spark SQL

 

      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 Analyst User Guide.

   Azure AD Authentication

Important: 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 in your version of the Spotfire Analyst User’s Guide. 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.

      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.

   Google Authentication

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 the topic "Enabling Google Connectors in Spotfire Web Clients" in the Spotfire Analyst User Guide.

Tip: If you want to use separate settings for each connector, use the GoogleAnalytics and Google BigQuery preferences.

      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 (;).

   Google BigQuery

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 genericl Google Authentication preferences.

      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 (;).

      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.

      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 project

Default value: True

   GoogleAnalytics

The GoogleAnalytics preferences are used to enable the Google Analytcs (Universal Analytics) connector for accessing data in Spotfire web clients.

Note: The settings for these preferences take precedence over the generic Google Authentication preferences.

      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 (;).

   Google Analytics (GA4)

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

Note: The settings for these preferences take precedence over the generic Google Authentication preferences.

      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 (;).

   Microsoft SQL Server

 

      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 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 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 the help topic for the connector in the Spotfire Analyst User Guide.

   MySQL

 

      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.

   PostgreSQL

 

      AllowEmbeddingCertificatesWithPrivateKeys

Determines whether users are allowed to embed certificate files that contain private keys in connection data sources. In the PostgreSQL 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.

   Salesforce

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.

      ConsumerKey

Enter the consumer key obtained from your Salesforce app.

      ConsumerSecret

Enter the client 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

   SAP BW

 

       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.

   SAP HANA

 

      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.

See also:

The Preferences tab

Viewing Preferences

Preferences Examples

Setting Primary Group