## Crawl Cyera

URL: https://docs.atlan.com/apps/connectors/privacy/cyera/how-tos/crawl-cyera

> Crawl classification metadata from Cyera to enrich assets with data sensitivity and privacy information. Extract data sensitivity classifications and security issues.

Configure the Atlan [Cyera](https://docs.atlan.com/llms/connectors/cyera/set-up-cyera/llms.txt) workflow to crawl data classification metadata from your Cyera instance and enrich assets in Atlan. After completing the prerequisite setup, you can extract data sensitivity classifications, privacy labels, and security findings. Review the [order of operations](https://docs.atlan.com/llms/catalog/connector-capabilities/order-workflows/llms.txt) for metadata enrichment workflows before starting.

## Prerequisites

Before you begin, make sure you have:

- Created a Cyera API token and obtained your **Client ID** and **Client Secret**. If not, follow the [Set up Cyera](https://docs.atlan.com/llms/connectors/cyera/set-up-cyera/llms.txt) guide.
- Generated an **Atlan API token** for the Cyera App to write custom metadata structures into your workspace. See [Generate Atlan API token](https://docs.atlan.com/llms/connectors/cyera/set-up-cyera/llms.txt).
- The required permissions to configure and run the workflow:
 - **Atlan**: Admin or Workflow Admin permissions
 - **Cyera**: API token with read access to datastores, classifications, and issues
- Reviewed the [order of operations](https://docs.atlan.com/llms/catalog/connector-capabilities/order-workflows/llms.txt) for workflow execution.

## Create crawler workflow

Create a new Cyera crawler workflow in Atlan by selecting the Cyera App in the Atlan Marketplace, then completing the three configuration steps.

1. In the top right of any screen, navigate to **New** > **New Workflow**.
2. From the list of packages, select **Cyera** and click **Setup Workflow**.

### Configure credentials

Enter the Cyera credentials Atlan uses to authenticate.

1. In the **Credential** section:
 - **Cyera API URL**: The Cyera API endpoint, pre-filled as `api.cyera.io`. Don't change this value unless instructed by Cyera support.
 - **Client ID**: Enter the Client ID from your Cyera API token. See [Set up Cyera](https://docs.atlan.com/llms/connectors/cyera/set-up-cyera/llms.txt).
 - **Client Secret**: Enter the Client Secret from your Cyera API token.

2. Expand **Advanced Settings** and enter the **Atlan API Token** you generated in [Set up Cyera](https://docs.atlan.com/llms/connectors/cyera/set-up-cyera/llms.txt). The Cyera App uses this token to create the **Cyera**, **CyeraIssues**, and **CyeraIdentities** custom metadata structures in your Atlan workspace. Without it, Cyera-tagged assets in Atlan won't receive enriched custom metadata values.

3. Select an **Extraction Method**:
 - **Direct** (default): Atlan calls Cyera using credentials stored in Atlan.
 - **Self-Deployed Runtime (SDR)**: The runtime in your environment holds the credential and pushes metadata to Atlan. See [Self-Deployed Runtime](https://docs.atlan.com/llms/platform/self-deployed-runtime/llms.txt) for setup requirements.

4. Click **Test Authentication** to confirm connectivity to Cyera.

5. When the test is successful, click **Next**.

### Configure connection

Set up the Atlan connection and specify who can manage it.

1. Enter a **Connection name** that represents your Cyera environment. For example: `production`, `cyera-prod`, or `analytics`.

2. To change who can manage this connection, update the users or groups listed under **Connection Admins**. By default, your user and all admins are included.

3. Click **Next** to proceed.

### Map datastores

Map Cyera Datastores to Atlan connections, configure optional settings, and run the crawler. Choose one of two approaches to define which Cyera datastores to map to which Atlan connections:

### Bulk connection mapping (CSV)

Enter mappings as a comma-separated, semicolon-delimited list in the **Bulk Connection Mapping (CSV)** field. Use this approach when you have multiple mappings to configure at once. This option supports all mutually supported Atlan and Cyera source types, including **Snowflake and Databricks**. It's the only mapping method that supports Databricks—the Snowflake UI mapper doesn't.

- Format: `atlan_connection_qualified_name,cyera_datastore_name_or_uid`
- Use semicolons to separate multiple mappings; don't add a trailing semicolon
- The Cyera datastore value can be either the datastore name (case-insensitive) or the datastore UID
- Example (mixing a Snowflake and a Databricks connection):

 ```text
 default/snowflake/123,my-snowflake-db;default/databricks/456,my-databricks-datastore
 ```

**To build your mapping list from a Cyera export:**

1. In Cyera, navigate to the **Datastores** page and export your datastore list to CSV.
2. Open the export. **Column B** contains the Datastore Name. These are the values for the right side of each mapping pair.
3. For each datastore you want to map, find the corresponding Atlan connection's qualified name:
 - In Atlan, open the connection asset and select the **Properties** tab in the right panel.
 - Copy the **Qualified name** (for example, `default/snowflake/1234567890` for a Snowflake connection or `default/databricks/1234567890` for a Databricks connection).
4. Combine them as `atlan_qualified_name,cyera_datastore_name` and join multiple pairs with `;`. Don't add a trailing semicolon.

### Snowflake mapping (UI)

Use the **Snowflake Mapping** repeater to add mappings one at a time. Leave the CSV field empty to use this approach.

:::info
The UI mapper supports Snowflake assets only. To map Databricks (or any other source type), use the **Bulk Connection Mapping (CSV)** option instead.
:::

1. In the **Snowflake Mapping** section, select the **Atlan Connection** from the dropdown.
2. Select the **Cyera Datastore (Snowflake)** from the dropdown. If the list appears empty, click the refresh icon, then click into the dropdown field to reveal the loaded values.
3. Click **Add to Snowflake Mapping** to save the row.
4. Repeat to add additional mappings.

**Optional settings:** To clean up legacy duplicate metadata attributes from earlier app versions, configure **Legacy Metadata Cleanup**. Leave as **Off (default)** unless advised otherwise. Set to **Dry run** to preview what gets removed, or **Apply** to delete legacy attributes.

#### Run preflight checks and start crawler

1. In the **Preflight Check** section, click **Check** to run a quick test for necessary permissions before the workflow runs. Click **Show details** to review the results.

2. Choose your run option:
 - To run the crawler immediately, click **Run**.
 - To schedule the crawler to run on a recurring basis, click **Schedule & Run** and configure the schedule.

Once the crawler completes, you can view the enriched assets on Atlan's asset page.

## Need help

- **Contact Atlan support**: For issues related to the Atlan integration, [submit a support request](https://docs.atlan.com/support/submit-request).

## See also

- [What does Atlan crawl from Cyera](https://docs.atlan.com/llms/connectors/cyera/what-does-atlan-crawl-from-cyera/llms.txt): Learn what metadata Atlan extracts from Cyera.

---