Skip to main content

Crawl Cyera

Configure the Atlan Cyera workflow to crawl data classification metadata from your Cyera instance and enrich assets in Atlan. This guide walks through the three setup steps: credentials, connection, and Datastore mapping.

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 guide.
  • 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 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.
    • Client Secret: Enter the Client Secret from your Cyera API token.
    • Atlan API Token (optional): If provided, used to programmatically create or update required custom metadata structures (Cyera and CyeraIssues) on the tenant. For information on generating an API token, see API tokens.

  2. Click Test Authentication to confirm connectivity to Cyera.

  3. 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:

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.

  • Format: atlan_connection_qualified_name,cyera_datastore_name_or_uid

  • Use semicolons to separate multiple mappings

  • The Cyera datastore value can be either the datastore name (case-insensitive) or the datastore UID

  • Example:

    default/snowflake/123,my-snowflake-db;default/snowflake/456,PROD_WAREHOUSE

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​

See also​