We use cookies to improve site navigation, analyze site usage, and enhance your user experience. Click "Accept" to enable cookies or "Reject" to reject cookies. To learn more, read our Privacy Policy.

connectors

No menu items for this category
Home/Connectors/Dashboard/Thoughtspot
Collate Documentation
ThoughtSpot

ThoughtSpot

BETA
Available In
Feature List
Dashboards
Charts
Owners
Datamodels
Lineage
Projects

In this section, we provide guides and references to use the ThoughtSpot connector.

Configure and schedule ThoughtSpot metadata and profiler workflows from the OpenMetadata UI:

Ingestion Deployment

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment. If you want to install it manually in an already existing Airflow host, you can follow this guide.

If you don't want to use the OpenMetadata Ingestion container to configure the workflows via the UI, then you can check the following docs to run the Ingestion Framework in any orchestrator externally.

Run Connectors from the OpenMetadata UI

Learn how to manage your deployment to run connectors from the UI

Run the Connector Externally

Get the YAML to run the ingestion externally

External Schedulers

Get more information about running the Ingestion Framework Externally

Requirements

To access the ThoughtSpot APIs and import liveboards, charts, and data models from ThoughtSpot into OpenMetadata, you need appropriate permissions on your ThoughtSpot instance.

ThoughtSpot Account Setup and Permissions

  1. Authentication Setup
    ThoughtSpot supports multiple authentication methods:

    • Basic Authentication: Username and password authentication. The user should have appropriate permissions to read metadata from ThoughtSpot.
    • API Token Authentication: Use ThoughtSpot API tokens for authentication. Generate API tokens from your ThoughtSpot instance.

  2. API Permissions
    Ensure your ThoughtSpot user or service account has the following permissions:

    • Read access to liveboards and answers
    • Read access to worksheets and data models
    • Access to metadata APIs
    • Export permissions for TML (ThoughtSpot Modeling Language) data

  3. Multi-tenant Configuration (Optional)
    If you're using ThoughtSpot Cloud with multiple organizations:

    • Set the Organization ID parameter to specify which organization to connect to (only for ThoughtSpot Cloud).
  • For lineage extraction, ensure TML (ThoughtSpot Modeling Language) export is enabled for your user.

Connection Details

  • Host and Port:
    The URL of your ThoughtSpot instance.
    Examples:

    • Cloud: https://my-company.thoughtspot.cloud
    • On-premise: https://thoughtspot.company.com
    • Local: https://localhost
      If running ingestion in Docker and ThoughtSpot is on localhost, use host.docker.internal.

  • Authentication:
    Choose one of the following:

    • Basic Authentication:
      • Username: Your ThoughtSpot username
      • Password: Your ThoughtSpot password
    • API Token Authentication:
      • API Token: Your ThoughtSpot API token

  • API Version:
    The ThoughtSpot API version to use for metadata extraction.

    • v1: Legacy API version (callosum endpoints)
    • v2: Current API version (recommended, default)

  • Organization ID:
    For multi-tenant ThoughtSpot Cloud deployments.

    • Leave empty for single-tenant
    • Set to your org ID for multi-tenant

Metadata Ingestion

1. Visit the Services Page

Click Settings in the side navigation bar and then Services.

The first step is to ingest the metadata from your sources. To do that, you first need to create a Service connection first.

This Service will be the bridge between OpenMetadata and your source system.

Once a Service is created, it can be used to configure your ingestion workflows.

Visit Services Page

Select your Service Type and Add a New Service

2. Create a New Service

Click on Add New Service to start the Service creation.

Create a new Service

Add a new Service from the Services page

3. Select the Service Type

Select ThoughtSpot as the Service type and click Next.

Select Service

Select your Service from the list

4. Name and Describe your Service

Provide a name and description for your Service.

Service Name

OpenMetadata uniquely identifies Services by their Service Name. Provide a name that distinguishes your deployment from other Services, including the other ThoughtSpot Services that you might be ingesting metadata from.

Note that when the name is set, it cannot be changed.

Add New Service

Provide a Name and description for your Service

5. Configure the Service Connection

In this step, we will configure the connection settings required for ThoughtSpot.

Please follow the instructions below to properly configure the Service to read from your sources. You will also find helper documentation on the right-hand side panel in the UI.

Configure Service connection

Configure the Service connection by filling the form

6. Test the Connection

Once the credentials have been added, click on Test Connection and Save the changes.

Test Connection

Test the connection and save the Service

7. Configure Metadata Ingestion

In this step we will configure the metadata ingestion pipeline, Please follow the instructions below

Configure Metadata Ingestion

Configure Metadata Ingestion Page

Metadata Ingestion Options

  • Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
  • Dashboard Filter Pattern (Optional): Use it to control whether to include dashboard as part of metadata ingestion.
    • Include: Explicitly include dashboards by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be excluded.
    • Exclude: Explicitly exclude dashboards by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all dashboards with names matching one or more of the supplied regular expressions. All other dashboards will be included.
  • Chart Pattern (Optional): Use it to control whether to include charts as part of metadata ingestion.
    • Include: Explicitly include charts by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all charts with names matching one or more of the supplied regular expressions. All other charts will be excluded.
    • Exclude: Explicitly exclude charts by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all charts with names matching one or more of the supplied regular expressions. All other charts will be included.
  • Data Model Pattern (Optional): Use it to control whether to include data modes as part of metadata ingestion.
    • Include: Explicitly include data models by adding a list of comma-separated regular expressions to the 'Include' field. OpenMetadata will include all data models with names matching one or more of the supplied regular expressions. All other data models will be excluded.
    • Exclude: Explicitly exclude data models by adding a list of comma-separated regular expressions to the 'Exclude' field. OpenMetadata will exclude all data models with names matching one or more of the supplied regular expressions. All other data models will be included.
  • Database Service Name (Optional): Enter the name of Database Service which is already ingested in OpenMetadata to create lineage between dashboards and database tables.
  • Enable Debug Log (toggle): Set the 'Enable Debug Log' toggle to set the default log level to debug.
  • Include Owners (toggle): Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
  • Include Tags (toggle): Set the 'Include Tags' toggle to control whether to include tags in metadata ingestion.
  • Include Data Models (toggle): Set the 'Include Data Models' toggle to control whether to include tags as part of metadata ingestion.
  • Mark Deleted Dashboards (toggle): Set the 'Mark Deleted Dashboards' toggle to flag dashboards as soft-deleted if they are not present anymore in the source system.
  • Include Draft Dashboard (toogle): Set the 'Include Draft Dashboard' toggle to include draft dashboards. By default it will include draft dashboards.

8. Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.

Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.

If something doesn't look right, click the Back button to return to the appropriate step and change the settings as needed.

After configuring the workflow, you can click on Deploy to create the pipeline.

Schedule the Workflow

Schedule the Ingestion Pipeline and Deploy

9. View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.

View Ingestion Pipeline

View the Ingestion Pipeline from the Service Page

Note:
Lineage creation requires:

  • Database service names to be configured in the lineage information
  • Access to TML export functionality

Enable debug logging to troubleshoot issues:

This will provide detailed information about API calls, data extraction, and lineage creation.