## Crawl Mode

URL: https://docs.atlan.com/apps/connectors/business-intelligence/mode/how-tos/crawl-mode

> Once you have [configured the Mode user permissions](/apps/connectors/business-intelligence/mode/how-tos/set-up-mode), you can establish a connection between Atlan and Mode.

Once you have [configured the Mode user permissions](https://docs.atlan.com/llms/connectors/mode/set-up-mode/llms.txt), you can establish a connection between Atlan and Mode.

To crawl metadata from Mode, review the [order of operations](https://docs.atlan.com/llms/catalog/connector-capabilities/order-workflows/llms.txt) and then complete the following steps.

## Select the source

To select Mode as your source:

1. In your Atlan workspace, click **Connectors** in the left sidebar.
 * If you are using the **Old UI (Classic)**, click **New Workflow** in the top navigation.

2. Click **Marketplace**.

3. Search for **Mode Assets** and select it.

4. Click **Install**.

5. Once installation completes, click **Setup Workflow** on the same tile.

## Provide credentials

To enter your Mode credentials:

1. For _Authentication_, _Basic_ is the default selection.

2. For _API Key ID_, enter the [API key ID you copied for your API token](https://docs.atlan.com/llms/connectors/mode/set-up-mode/llms.txt).

3. For _API Secret_, enter the [API secret you copied for your API token](https://docs.atlan.com/llms/connectors/mode/set-up-mode/llms.txt).

4. For _Workspace_, enter the name of your Mode workspace as retrieved from the API or workspace URL.

5. For _Exclude all personal collections_, change to **Yes** to exclude your [personal collections](https://mode.com/help/articles/spaces/#personal-content) or keep the default selection _No_ to include them.

6. Click the **Test Authentication** button to confirm connectivity to Mode using these details.

7. Once successful, at the bottom of the screen, click **Next**.

## Configure the connection

To complete the Mode connection configuration:

1. Provide a _Connection Name_ that represents your source environment. For example, you might use values like `production`, `development`, `gold`, or `analytics`.

2. (Optional) To change the users able to manage this connection, change the users or groups listed under _Connection Admins_.

 :::warning

 If you do not specify any user or group, nobody will be able to manage the connection - not even admins.

 :::

3. At the bottom of the screen, click **Next** to proceed.

## Configure the crawler

:::warning

If you're authenticating in Atlan using a [member API token](https://docs.atlan.com/llms/connectors/mode/set-up-mode/llms.txt), Atlan currently does not distinguish between collections you have access to and ones restricted at source. This is due to limitations with the Mode API. However, Atlan will only extract basic metadata for restricted collections and no underlying assets such as reports or queries.

:::

Before running the Mode crawler, you can further configure it.

You can override the defaults for any of these options:

- To select the collections you want to exclude from crawling, click **Exclude Collections**. (This will default to no collections, if none are specified.)
- To select the collections you want to include in crawling, click **Include Collections**. (This will default to all collections, if none are specified.)
- To disable crawling archived reports and associated queries and charts from Mode, for _Crawl Archived Reports_, change to **No**.

:::info **Did you know?** 
 If a collection appears in both the include and exclude filters, the exclude filter takes precedence.

:::

## Run the crawler

To run the Mode crawler, after completing the steps above:

1. To check for any [permissions or other configuration issues](https://docs.atlan.com/llms/connectors/mode/preflight-checks-for-mode/llms.txt) before running the crawler, click **Preflight checks**.

2. You can either:
 - To run the crawler once immediately, at the bottom of the screen, click the **Run** button.
 - To schedule the crawler to run hourly, daily, weekly, or monthly, at the bottom of the screen, click the **Schedule Run** button.

Once the crawler has completed running, you will see the assets in Atlan's asset page! 🎉

---