Google Authentication

When you connect to Google from Sisense, you can authenticate your account with your Google credentials if you are working from the localhost. If however, you are connecting remotely to the Sisense server, and the address of the Sisense Web Application is something other than localhost, Google requires that you connect using the OAuth 2.0 protocol. The OAuth 2.0 authorization framework enables a third-party, in this case, Sisense, to obtain limited access to an HTTP service such as Google Sheets.

To connect to Google Services through a remote Sisense server, you need to create a Google application to obtain OAuth 2.0 client credentials from Google and then add those credentials to a manifest file on your Sisense Server.

See the tutorial below for a full walkthrough all the process of creating a Google app and configuring your Google connector.

Creating a Google Application

Google OAuth 2.0 requires you to create a Google API Console project and set up authorized JavaScript origins and redirect URIs. Sisense has built-in credentials for the default Google application so you can connect from localhost. For security reasons, you should create and set up your own Google application to support the Google OAuth 2.0 protocol. Your Sisense Administrator needs to configure it one time (for each connector with OAuth 2.0 authorization flow after each installation). The Google OAuth2.0 flow will work for all users after it.

To create a Google application:

  1. Go to the Google API Console.
  2. Select an existing project or create a new one by selecting Create.

    If you are creating a new project, go to Step 3. If you select an existing project, go to Step 4.
  3. In the New Project area, define and a project name and select a location. Click CREATE.

  4. The API Library opens. Click API Library on the top left to close it.
  5. In the sidebar under “APIs & Services”, select Credentials.
  6. Select the OAuth consent screen tab.
  7. In Application name, enter Sisense.
  8. In Authorized domains, enter the domains from where you will connect to the Google API, for example, yourcompanyname.com. Then click Save.
    Note: If you are configuring remote access for SSL setup servers (https://), make sure that both the authorized domain and the callback url are configured with the https prefix.
  9. In the Credentials tab, select the Create credentials list, and choose OAuth client ID.

  10. Under Application type, select Web application (more information here). In the Name field, you can enter the name you will see in the console.
    1. In the Authorized JavaScript origins field, enter the origin for your app – a unique combination of protocol, hostname, and port. You can enter multiple origins to allow for your app to run on different protocols, domains, or subdomains. You cannot use public IP addresses, wildcards, paths and trailing slashes. Do not use localhost for production for security reasons (only dev, test and staging environments).
      Examples of correct origins:
      http://localhost:8080
      https://myproductionurl.example.com
    2. The Authorized redirect URI is the path in your application that users are redirected to after they have authenticated with Google. The path will be appended with the authorization code for access.
      Note the following:
      • Must have a protocol
      • Cannot contain URL fragments or relative paths
      • Cannot be a public IP address
    3. The redirect URI must match the client side domain and be added to console APIs or you will get a redirect_uri_mismatch error.
      Note: If you are configuring remote access for SSL setup servers (https://), make sure that both the authorized domain and the callback url are configured with the https prefix.
      Google Sheets: http://APP_URL/oauth/R29vZ2xlIFNwcmVhZHNoZWV0cw==/callback
      Google Analytics: http://APP_URL/oauth/R29vZ2xlQW5hbHl0aWNz/callback
      Google Ads: http://APP_URL/oauth/R29vZ2xlQWR3b3Jkcw==/callback
      Google BigQuery: http://APP_URL/oauth/R29vZ2xlQmlnUXVlcnk=/callback
      For Sisense it should be in format:
      http://APP_URL/oauth/R29vZ2xlIFNwcmVhZHNoZWV0cw==/callback
      where '/oauth/R29vZ2xlIFNwcmVhZHNoZWV0cw==/callback' is a hardcoded immutable string.
      For example,
      http://sisense.com/oauth/R29vZ2xlIFNwcmVhZHNoZWV0cw==/callback
      If you are using a base URL, the format of the callback will be:
      http://BASE_URL/oauth/R29vZ2xlIFNwcmVhZHNoZWV0cw==/callback
      For example:
      https://baseurl.sisense.com/reporting/oauth/R29vZ2xlIFNwcmVhZHNoZWV0cw==/callback
      where base URL is 'https://baseurl.sisense.com/reporting'. The origin for this base URL will be 'https://baseurl.sisense.com'.
      Note: The Google OAuth2.0 redirect URL doesn’t allow spaces, so Sisense has encoded the provider’s name (Google Spreadsheets) into the base64 format – R29vZ2xlIFNwcmVhZHNoZWV0cw==. If you want to use another OAuth2.0 connector, you should add on this step redirect URL with appropriate base64 encoded provider name.
    4. Click Create.
      For example, if you install Sisense on http://test.sisense.com.
  11. In the sidebar under “APIs & Services”, select Library.

    Search for the relevant Google API, open it and click Enable (note that the first three are required if connecting to Google Sheets).
    Google Drive API

    Google Cloud Storage JSON API

    Google Sheets API
    Google Analytics Reporting API (this one is enabled by default, but it can be disabled if you have custom configuration in your project)

  12. From the resulting OAuth client dialog box, copy the Client ID and Client Secret. You need to add these credentials to a manifest file described in Configuring your Google Connector below. You may experience a delay with Google (up to 5 minutes) for applying your application’s settings.

Configuring your Google Connector

After you have created an application and retrieved the credentials, you need to add those credentials to a manifest file in your Sisense server.

To set up Google Sheets connector to work with your application, you should add your Client ID and Client Secret into connector’s manifest.

  1. Open the manifest file in a text editor. The file is located at C:\Program Files\Sisense\DataConnectors\JVMContainer\Connectors\ and the name of the Google connector. For example, Google Sheets directory looks like this: 
    C:\Program Files\Sisense\DataConnectors\JVMContainer\Connectors\Google Spreadsheets\manifest.json
  2. In the manifest.json file, find the OAuth2 block.
  3. Add your clientId and clientSecret fields that you received when you created your Google app:
    "oAuth2": {
    "authUrl": "https://accounts.google.com/o/oAuth2/v2/auth",
    "tokenUrl": "https://www.googleapis.com/oAuth2/v4/token",
    "scope": "https://www.googleapis.com/auth/spreadsheets.readonly https://www.googleapis.com/auth/drive.readonly https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
    "clientId": "YOUR_CLIENT_ID",
    "clientSecret": "YOUR_CLIENT_SECRET",
    "returnedValues": {
    "refreshToken": "dToken",
    "accessToken": "appKey",
    "userEmail": "userEmail"
    }
    }
  4. Save the file. You don’t need restart Sisense, all changes will be re-read on the fly.

LIMITATIONS

Sisense has one Google specific limitation in addition to base OAuth2.0 flow limitations: