## Set up Metabase

URL: https://docs.atlan.com/apps/connectors/business-intelligence/metabase/how-tos/set-up-metabase

> :::warning Who can do this? You will probably need your Metabase administrator to follow the below steps - you may not have access yourself.

:::warning 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](https://www.metabase.com/docs/latest/administration-guide/04-managing-users.html#creating-accounts-for-your-team) 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](https://www.metabase.com/docs/latest/administration-guide/04-managing-users.html#groups) 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

:::info **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](https://docs.atlan.com/llms/connectors/metabase/crawl-metabase/llms.txt):

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

:::warning

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](https://www.metabase.com/docs/latest/api/dataset#post-apidatasetnative) 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**.

:::info **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](https://docs.atlan.com/support/submit-request) to learn your Atlan IP.

---