Skip to main content

How to set up Sigma

Updated yesterday

Setup takes 20-25 minutes.

Introduction

Connecting Sigma to Foundational allows Foundational to scan and determine lineage and downstream impact for Sigma dashboards and other entities.


To make the connection, you need to:

  • Create a new account type in Sigma

  • Assign an existing account or create a new account

  • Add the Foundational account to all relevant teams

  • Create a client key and secret

  • Connect Foundational to Sigma


Prerequisites

Ensure you have Sigma admin rights.


Access permissions

The permissions you assign to Foundational enable it to:

  • Read workbook metadata. It does not read your data.

  • View datasets (under Data Modeling).

  • View workbooks (under Documents).


Create a new account type in Sigma

Foundational uses this account type to access metadata.

  1. Sign in to Sigma Computing.

  2. Select Administration.

  3. Select Create New Account Type.

  4. The New Account Type screen opens.


    Enter the details and assign the permissions:

    • Name: (#1): Enter a descriptive name e.g., Foundational Connector Type.

    • View connections (#2): Enable the checkbox.

    • View datasets (#3): Enable the checkbox.

    • View workbooks: (#4) Enable the checkbox.

  5. Click Create (#5).


Assign an account to Foundational

Foundational needs an account in Sigma to access relevant metadata. Either create a new account or assign an existing account for Foundational to use. The existing account must have the same permissions as a new account.

Option 1: Create new account

  1. From the Home page, select Administration.

  2. Select People from the left sidebar (#1).

  3. Click Invite People (#2), and in the popup (#3) enter these details:

    • The email address for the account.

    • Select Account Type: Select Foundational Connector Type from the dropdown.

  4. Click Invite (#4).

Option 2: Assign existing account

An existing account must have the same permissions as those for a new account.

  1. From the Home page, select Administration.

  2. Select People from the left sidebar.

  3. Member: Select the user you want to assign for Foundational and click Edit.

  4. Account Type: Select Foundational Connector Type from the account type dropdown.

  5. Click Confirm.


Add Foundational to relevant teams

By default, Sigma accounts only have access to the default workspace. Sigma grants access to workspaces through teams. To grant Foundational access to the relevant workspaces:

  • Add the Foundational account to all relevant teams in Sigma.

  • Once the account belongs to those teams, it can view the associated workspaces.

Add Foundational to one or more teams:

  1. From the Home screen menu, select Administration.

  2. Select Teams from the left sidebar.

  3. Select the team.

  4. Click Add Members (#1).

  5. In the search bar, type the name/account email you created or assigned to Foundational.

  6. Enable the checkbox (#2) and click Add (#3).

  7. To give Foundational access to all relevant workspaces, add Foundational to each team.


Create client key and secret

  1. In Sigma, go to Administration > Developer Access and click Create New.

  2. The Create client credentials window opens.


    Enter the details:

    • Access Credential Type: REST API.

    • Name: Enter a name for the API key. You can choose any name, e.g., ‘Foundational.’

    • Description: Optional.

    • Owner: Assign an owner for the API key. The owner must have the permissions set for the Foundational account (see the section Create a new account type in Sigma).

  3. Click Create.

  4. Copy and save the Client ID and secret. You’ll need them to set up the connection.


Connect Foundational to Sigma

  1. In Foundational, open the Connectors & Integrations page.

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

  3. Click Add Account.

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

  5. The Set Up New Connection screen opens.

    Enter the details:

    • Client ID: The ID you saved earlier.

    • Client Secret: The secret you saved earlier.

  6. Click Next.

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

That’s it! Foundational is now connected to Sigma. The connection should be live within 24 hours.

Did this answer your question?