## Crawl IBM Cognos Analytics

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

> Extract metadata from IBM Cognos Analytics to catalog reports, queries, and dashboards. Discover and govern your BI assets after configuring user permissions.

Extract metadata from your [IBM Cognos Analytics](https://docs.atlan.com/llms/connectors/ibm-cognos-analytics/set-up-ibm-cognos-analytics/llms.txt) environment into Atlan to catalog reports, queries, and dashboards. After configuring the necessary user permissions, you can establish a connection and crawl to extract usage and lineage information.

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

## Select source

To select IBM Cognos Analytics 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 **IBM Cognos Analytics Assets** and select it.

4. Click **Install**.

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

## Provide credentials

Choose your extraction method:

:::warning Offline extraction sunset
The offline extraction method has been sunset and is no longer available. For on-premises or network-restricted environments, use the **Agent** extraction method with [Self-Deployed Runtime](https://docs.atlan.com/llms/platform/self-deployed-runtime/llms.txt).
:::

- In **Direct** extraction, Atlan connects to your database and crawls metadata directly.

### Direct extraction method

To enter your IBM Cognos Analytics credentials:

1. For _Host Name_, enter the hostname of your IBM Cognos Analytics instance.

2. For _Port_, enter the port number of your IBM Cognos Analytics instance.

3. For _Authentication_, select the method you configured when [setting up the IBM Cognos Analytics access permissions](https://docs.atlan.com/llms/connectors/ibm-cognos-analytics/set-up-ibm-cognos-analytics/llms.txt):
 - For **Basic**, enter the [_Username_ and _Password_](https://docs.atlan.com/llms/connectors/ibm-cognos-analytics/set-up-ibm-cognos-analytics/llms.txt) you configured for the new user.
 - For **API Key**, enter the [_Username_](https://docs.atlan.com/llms/connectors/ibm-cognos-analytics/set-up-ibm-cognos-analytics/llms.txt) and [_API Key_](https://docs.atlan.com/llms/connectors/ibm-cognos-analytics/set-up-ibm-cognos-analytics/llms.txt) you configured for the new user.
 - For **OKTA**, enter the [_Username_ and _Password_](https://docs.atlan.com/llms/connectors/ibm-cognos-analytics/set-up-ibm-cognos-analytics/llms.txt) you configured for the new user in OKTA.
4. For _Namespace_, enter the [name of the namespace where you created the new user](https://docs.atlan.com/llms/connectors/ibm-cognos-analytics/set-up-ibm-cognos-analytics/llms.txt).

5. Click the **Test Authentication** button to confirm connectivity to IBM Cognos Analytics.

6. Once authentication is successful, navigate to the bottom of the screen and click **Next**.

## Configure connection

To complete the IBM Cognos Analytics 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 who are able to manage this connection, change the users or groups listed under _Connection Admins_.

 :::warning
 If you don't specify any user or group, no one can manage the connection, not even admins.
 :::

3. Navigate to the bottom of the screen and click **Next** to proceed.

## Configure crawler

Before running the IBM Cognos Analytics crawler, you can further configure it.

On the _Metadata_ page, you can override the defaults for any of these options:

- To select the assets you want to include in crawling, click **Include Folders**. (Defaults to all assets if none are specified.)
- To select the assets you want to exclude from crawling, click **Exclude Folders**. (Defaults to no assets if none are specified.)

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

:::

## Run crawler

To run the IBM Cognos Analytics crawler, after completing the steps in the previous sections:

- 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, the assets appear on Atlan's asset page! 🎉

---