How to set up Metabase

Have more questions? Submit a request
πŸ€“ Who can do this? You will probably need your Metabase administrator to follow the below steps β€” you may not have access yourself.

Create a user

To create a user for Atlan to use when integrating with Metabase:

  1. From the upper right corner of your Metabase instance, click the gear icon and then Admin Settings.
  2. At the top of the page, change to the People tab.
  3. To the upper right of the table, click the Invite someone button and enter their details:
    1. For First name enter the user's first name, for example Atlan.
    2. For Last name enter the user's last name, for example User.
    3. For Email enter the user's email address, for example a service account email address.
  4. At the bottom of the dialog, click the Create button.
  5. When prompted, click Done.

Create a group

You can only attach Metabase permissions to groups.

To create a group for Atlan to use when integrating with Metabase:

  1. From the upper right corner of your Metabase instance, click the gear icon and then Admin Settings.
  2. From the top menu bar, change to the People tab.
  3. From the left of the page, open the Groups tab.
  4. At the top right, click the Create a group button.
    1. For Group name enter Atlan.
    2. On the right of the row click the Add button.

To add the user to the group:

  1. Click the Atlan group you created.
  2. To the upper right of the table, click the Add members button.
  3. Under Members start typing the name used above (for example, Atlan User) and select it.
  4. On the right of the row, click the Add button.

Set permissions

πŸ’ͺ Did you know? We do not make any API requests or queries that will update the dashboards, collections or questions in your Metabase instance.

Minimum permissions

To set the minimum permissions required to crawl Metabase:

  1. From the upper right corner of your Metabase instance, click the gear icon and then Admin Settings.
  2. From the top menu bar, change to the Permissions tab.
  3. From the top of the page, change to the Collection permissions tab.
  4. For each collection you want to crawl in Atlan:
    1. Under the Collections heading on the left, click the collection.
    2. Under Permissions for <collection name>, for the Atlan group, under Collection access click the No access drop-down.
    3. (Optional) To crawl sub-collections, toggle the Also change sub-collections option.
    4. Select the View permission.
    5. In the upper-right of the page, click the Save changes button.
  5. When prompted with Save permissions? click the Yes button to confirm.

Partial lineage permissions

🚨 Careful! When a Metabase question uses native queries, these permissions cannot capture lineage to source tables and columns.

To set the minimal permissions for extracting lineage from Metabase:

  1. From the upper right corner of your Metabase instance, click the gear icon and then Admin Settings.
  2. From the top menu bar, change to the Permissions tab.
  3. From the top of the page, change to the Data permissions tab.
  4. Below the tab, click the Groups pill.
  5. Below the pill, select the Atlan group.
  6. Under Permissions for the Atlan group, for each database:
    1. Under Data access change the drop-down value to Unrestricted. Although Atlan does not query data, this permission is necessary to enable the next option.
    2. Under Native query editing change the drop-down value to Yes. This permission is necessary for Atlan to parse the queries that power your Metabase questions, to generate lineage.
    3. In the upper-right of the page, click the Save changes button.
  7. When prompted with Save permissions? click the Yes button to confirm.

Complete lineage permissions

To set permissions for extracting lineage from all your Metabase questions:

  1. From the upper right corner of your Metabase instance, click the gear icon and then Admin Settings.
  2. From the top menu bar, change to the People tab.
  3. On the row for the Atlan user you created above, under Groups change the drop-down value to Administrators.
πŸ’ͺ Did you know? Administrative access is necessary to get the default source database name used for queries. This is only available to Administrators. The unrestricted data access and native query editing permissions above are insufficient.

(Optional) Allowlist the Atlan IP

If you are using the IP allowlist in your Metabase instance, you must add your Atlan IP to the allowlist. Please raise a support ticket to learn your Atlan IP.

Related articles

Was this article helpful?
0 out of 0 found this helpful