Enabling Google Connectors in Spotfire Web Clients

Important: If you use TIBCO Cloud™ Spotfire, you can access data from Google BigQuery and Google Analytics in the Spotfire web client right away. You do not have to make any of the following configurations.

Why is this required?

To be able to access data from Google BigQuery and Google Analytics in Spotfire web clients, you must make sure your web clients can access the Google APIs. This requires that you make some configurations in your Google project and in Spotfire:

• In your Google project, you must set up OAuth Credentials to use with Spotfire, and enter redirect URIs for the Spotfire clients.

• In Spotfire, you must configure your web player services with the Google project’s OAuth Client ID and Client Secret.

Prerequisites

The Google BigQuery and/or Google Analytics API must be enabled in your Google project.

Note: To use the Google BigQuery connector, make sure your Google project has the required OAuth 2.0 scopes for viewing and managing BigQuery data.

Configuring your Google project

In the Google API console, create OAuth credentials for Spotfire in your Google project.

See the official documentation from Google for detailed instructions on how to set up and configure OAuth credentials in Google Cloud Platform.

Client ID and Client Secret

When you create OAuth credentials for your Google Cloud Platform project, note down the Client ID and Client Secret.

Redirect URIs

In the OAuth credentials, add the following address for your Spotfire Server as Redirect URIs:

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

Configuring the Spotfire web clients

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

1. On the computer that runs Spotfire Server, export the service configuration you want to edit. 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.

2. In the file Spotfire.Dxp.Worker.Host.exe.config, locate or add the setting Spotfire.Dxp.Data.Adapters.GoogleCommon.Properties.Settings:
   
   <Spotfire.Dxp.Data.Adapters.GoogleCommon.Properties.Settings>
     <setting name="ClientId" serializeAs="String">
        <value>My client ID</value>
     </setting>
     <setting name="ClientSecret" serializeAs="String">
        <value>My client secret</value>
     </setting>
   </Spotfire.Dxp.Data.Adapters.GoogleCommon.Properties.Settings>
   

3. Add your Client ID and your Client Secret in the settings ClientId and ClientSecret respectively.

4. 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

In earlier versions of Spotfire, the method for adding the client id and client secret information was to use a set of user group preferences in Spotfire Administration Manager. This method is still available. The following preferences are available under Connectors > Google Authentication:

ClientID

ClientSecret

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 URIs in your OAuth credentials in the Google project: http://localhost:55931, http://localhost:55932