Configuring the Salesforce connector for Spotfire web clients

To be able to use the authentication method Log in with Salesforce in Spotfire web clients, you must make sure your web clients are configured properly. This requires that you create a connected app in Salesforce and configure your Spotfire web clients:

About this task

In Salesforce, you need a connected app for integrating Spotfire with Salesforce.
In a Spotfire on-premises environment, you must configure your Web Player services with the OAuth Client ID and Client Secret of your connected app in Salesforce.

Configurations in Salesforce

About this task

Tip: For detailed instructions on how to create and manage a connected app in Salesforce, see the official documentation from Salesforce.

Spotfire requires that you make the following configurations in your Salesforce connected app:

Make sure OAuth settings are enabled.

Add your Spotfire Server as a Callback URL:

https://<spotfire_server>/spotfire/wp/oauth2/code

Require Secret for Web Server Flow is selected.
The following OAuth scopes are enabled:
- Access and manage your data (api)
- Provide access to your data via the Web (web)
- Perform requests on your behalf at any time (refresh_token, offline_access)

Consumer key and Consumer secret

Note down the OAuth credentials of the Salesforce connected app; the consumer key and consumer secret.

Configurations in Spotfire

About this task

Add the Consumer ID and Consumer Secret to the Web Player service configurations for your web clients. You add these settings in the config file Spotfire.Dxp.Worker.Host.exe.config.

Procedure

On the computer that runs Spotfire Server, export the service configuration you want to edit.

Tip: See the instructions in the topic Manually editing the service configuration files, in the Spotfire Server and Environment Installation and Administration Manual for your version of Spotfire.

In the file Spotfire.Dxp.Worker.Host.exe.config, locate or add the setting Spotfire.Dxp.Data.Adapters.Salesforce.Properties.Settings.

  <Spotfire.Dxp.Data.Adapters.Salesforce.Properties.Settings>
     <setting name="ClientId" serializeAs="String">
       <value>My Consumer Key</value>
     </setting>
     <setting name="ClientSecret" serializeAs="String">
       <value>My Consumer Secret</value>
     </setting>
   </Spotfire.Dxp.Data.Adapters.Salesforce.Properties.Settings>

Add your Consumer Key in the ClientId setting, and your Consumer Secret in the ClientSecret setting.
Save your changes. Then import the service configuration, by following the instructions in the Spotfire Server and Environment Installation and Administration manual.

Note: If you have multiple service configurations that you use for different web player services, make sure to add these settings in all relevant service configurations. Remember that it is not possible to edit the default service configuration.

Preferences in Administration Manager

About this task

In earlier versions of Spotfire, the method for adding the consumer key and consumer secret information was to use a user group preferences in Spotfire Administration Manager. This method is still available.

The following preferences are available under Connectors > Salesforce:

ConsumerKey
ConsumerSecret

The preferences are also in effect when you use Spotfire installed clients.

Important: If you use the preferences, you must add the following additional Redirect URLs in your connected app in Salesforce: http://localhost:55932, http://localhost:55933, http://localhost:55934 .