## Set up Domo

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

> :::warning Who can do this? You'll need your Domo administrator to complete these steps - you may not have access yourself.

:::warning Who can do this?
 You'll need your Domo administrator to complete these steps - you may not have access yourself.

:::

Atlan supports the basic authentication method for fetching metadata from Domo. This method uses the following to fetch metadata:

- [Client ID](https://docs.atlan.com/llms/connectors/domo/set-up-domo/llms.txt)
- [Client secret](https://docs.atlan.com/llms/connectors/domo/set-up-domo/llms.txt)
- [Access token](https://docs.atlan.com/llms/connectors/domo/set-up-domo/llms.txt)
- [DomoStats dataset IDs](https://docs.atlan.com/llms/connectors/domo/set-up-domo/llms.txt)

## Create client ID and secret

:::warning

Your Domo _Admin_ must create a client ID and secret for crawling [Domo datasets and dataset columns](https://docs.atlan.com/llms/connectors/domo/what-does-atlan-crawl-from-domo/llms.txt). If the user creating the client credentials doesn't have admin privileges, only datasets are crawled.

:::

You need your Domo instance name to create a client ID and secret. This is the name preceding your domo.com URL. For example, in the case of `company.domo.com`, the instance name is `company`.

To create a client ID and secret:

1. Log in to the [Domo Developer Portal](https://developer.domo.com/login) with your Domo instance name - for example, `company`.
2. Once you have entered your instance name, enter your Domo user credentials when prompted.
3. On the _Create new client_ page, enter the following details:
 1. For _Name_, enter a meaningful name for the client application - for example, `Atlan_connection`.
 2. (Optional) For _Description_, enter a brief description for the client application.
 3. For _Application Scope_, check the following boxes to assign the minimum permissions required to [crawl Domo](https://docs.atlan.com/llms/connectors/domo/crawl-domo/llms.txt):
 - **Data** - this scope lets Atlan access the [DataSet API](https://developer.domo.com/portal/72ae9b3e80374-list-data-sets).
 - **Dashboard** - this scope lets Atlan access the [Page API](https://developer.domo.com/portal/e7bc2fce783cd-list-pages).
 4. Click **Create** to complete the client application.
4. After you have registered the client application, you are redirected to the _Manage Clients_ page to view your newly provisioned client ID and secret. Copy the values for _Client ID_ and _Secret_ and store them in a secure location.
5. (Optional) To access your client ID and secret at a later time, navigate to the Domo Developer Portal homepage, and then from the left menu, click **Manage clients** to view and manage your existing client credentials.

## Generate access token

You need to create an [access token](https://domo-support.domo.com/s/article/360042934494?language=en_US) that lets Atlan generate [upstream lineage for Domo datasets](https://docs.atlan.com/llms/connectors/domo/what-does-atlan-crawl-from-domo/llms.txt).

Only a Domo _Admin_ default security role or a custom role with either the _Manage All Company Settings_ or _Manage All Access Tokens_ grant enabled can generate access tokens. If you don't have either of these privileges, request an access token from your Domo administrator.

To generate an access token:

1. Log in to your Domo instance as a Domo administrator.
2. From the tabs along the top of your Domo homepage, click **More** and then click **Admin**.
3. On the _Admin_ settings page, under _Authentication_, click **Access tokens**.
4. In the upper right of the _Manage access tokens_ page, click the **Generate access token** button.
5. To specify the token information:
 1. For _Access token description_, enter a meaningful name for your token - for example, `Atlan_connection_token`.
 2. For _Search users_, search for and select the user to assign the token.

 :::warning

 Access tokens are associated with specific user accounts and grant the same access as the user who generated the token. If the user's permissions change, the access token reflects the same.

 :::

 3. For _Expire after_, select an expiration date for the token.
 4. Click **Generate** to generate the access token.
6. From the corresponding screen, copy the access token and store it in a secure location. The token won't be displayed again after you leave the _Manage access tokens_ page.
7. (Optional) To revoke the access token, follow the steps in [Domo documentation](https://domo-support.domo.com/s/article/360042934494?language=en_US).

## Set up DomoStats connector

The [DomoStats connector](https://www.domo.com/appstore/connector/domostats/overview) lets you import usage metadata from your Domo instance. This connector is only available to Domo administrators.

Due to limitations of the Domo APIs, you need to set up the DomoStats connector to crawl metadata for Domo cards and catalog asset relationships between cards and dashboards and datasets and cards in Atlan. The DomoStats connector lets you build datasets with the required metadata. Once you have created the datasets, Atlan requires the dataset IDs to fetch the metadata from DomoStats. All three DomoStats dataset IDs are required to [crawl Domo](https://docs.atlan.com/llms/connectors/domo/crawl-domo/llms.txt).

To set up DomoStats:

1. Log in to your Domo instance as a Domo administrator.
2. From the tabs along the top of your Domo homepage, click **Appstore**.
3. In the search bar, search for and select **DomoStats**.
4. From the right panel of the _DomoStats_ page, click the **Get the Data** button.
5. In the _Create DomoStats DataSet_ page, create three DomoStats datasets for card, card-dashboard relationship, and dataset-card relationship metadata. Except step 1 below, the remaining steps are the same for all three datasets.
 1.  Under _Details_, for _Report_, click the dropdown and then:
 - Click **Cards** to create a dataset for card metadata.
 - Click **Card Pages** to create a dataset for card-dashboard relationship metadata.
 - Click **Card Datasource** to create a dataset for dataset-card relationship metadata.
 2. Click **Next** to proceed.
 3. Under _Scheduling_, you can either keep the predefined update schedule or define a custom schedule, and then click **Next**.
 4. Under _Name & Describe Your DataSet_, enter the following details:
 1. For _Dataset Name (Required)_, enter a meaningful name for your dataset.
 2. For _Dataset Description (Optional)_, enter a brief description for your dataset.
 3. For _Add Dataset to Cloud_, keep the default Domo selection.
 5. Click **Save** to finish setup.
6. Once you have completed setting up a dataset, from the corresponding page, copy the dataset ID from the URL for all three datasets and store them in a secure location. For example, if the dataset URL is `company.domo.com/datasource/ae6440eb-bef6-414a-a0e5-a5b2d58d1234/details/overview`, then the dataset ID is: `ae6440eb-bef6-414a-a0e5-a5b2d58d1234`.

---