Skip to main content

How to set up Spotfire

Updated yesterday

Setup takes about 10 minutes.

Introduction

Connecting Spotfire to Foundational allows Foundational to read BI and analytics metadata, determine lineage, and understand downstream impact. The setup is for Spotfire using OAuth 2.0 client credentials.
​

To make the connection, you need to:

  • Assign access permissions
    ​

  • Create API client credentials in Spotfire
    ​

  • Connect Foundational to Spotfire

See the Spotfire documentation on server installation and administration.

Prerequisites

Ensure you have:

  • Access to the Spotfire Server command-line tool
    ​

  • Permissions to register API clients on the Spotfire server
    ​

  • The Spotfire server URL
    ​

  • Added Foundational IP addresses to the allowlist, see the article Allowing IP access to Foundational

Access permissions

Foundational uses metadata only. It does not access underlying source data and does not change content.
​

The permissions you assign to Foundational enable it to:

  • Read Spotfire metadata
    ​

  • List dashboards and data sources
    ​

  • Understand relationships between Spotfire assets

Create API client credentials in Spotfire

Use the Spotfire Server command-line tool to register an OAuth 2.0 API client for Foundational.

  1. Open a terminal on the Spotfire Server where the Spotfire command-line tools are installed.
    ​

  2. Enter these parameters in the order listed here:
    ​

    • --name: Sets a descriptive name for the API client, e.g.,Foundational.
      ​

    • -S api.library.read: Grants read-only access to library content, including dashboards and data sources.
      ​

    • --client-profile=other: Defines a non-browser client profile.
      ​

    • -G client_credentials: Uses the OAuth 2.0 client credentials grant type.
      ​

    • --token-endpoint-auth-method=client_secret_post: Defines the authentication method for token requests.
      ​

  3. Run the following command to register the API client:
    ​

    register-api-client \
      --name "Foundational" \
      -S api.library.read \
      --client-profile=other \
      -G client_credentials \
      --token-endpoint-auth-method=client_secret_post

  4. After the command runs, Spotfire outputs a Client ID and Client Secret. Copy both values and save them. The client secret only shows once, and you’ll need these values to make the connection.

Connect Foundational to Spotfire

  1. Open the Connectors & Integrations page.
    ​

  2. In BI & Analytics, select the Spotfire card and click Connect.
    ​

  3. Click Add Account.
    ​

  4. The initial setup screen opens. Click Start Setup.
    ​

  5. The Setup New Connection screen opens.
    ​


    ​Enter the details:
    ​

    • Base URL: The base URL of your Spotfire server
      e.g., https://spotfire.example.com).
      ​

    • Port: The port number for your Spotfire server. The default is 443 for HTTPS connections.
      ​

    • Client ID: The OAuth 2.0 Client ID for API authentication that you saved earlier. This is a public identifier for your application registered in Spotfire.
      ​

    • Client Secret: The secret that you saved earlier. The OAuth 2.0 Client Secret for API authentication.
      ​

  6. Click Next.
    ​

  7. The final setup screen opens. To complete the connection, click Save.
    ​

That’s it. Foundational is now connected to Spotfire.

Related Articles
How to set up Power BI
How to set up Tableau
How to Set up Looker
How to set up Sigma
How to Set up Salesforce
Did this answer your question?