Skip to main content

Set up Qualytics

Configure API access in both Atlan and Qualytics to enable secure authentication and enable Atlan to sync data quality metadata from your Qualytics instance.

Prerequisites​

Before you begin, make sure you have:

  • Access to your Qualytics instance with administrative permissions
  • Admin or connection admin privileges in Atlan
  • Permissions to create API tokens in both Atlan and Qualytics
  • The base URL of your Qualytics instance (for example, https://your-company.qualytics.io)

Create Atlan persona and policy​

Create a persona and metadata policy in Atlan to control what data Qualytics can access when syncing metadata.

  1. In Atlan, navigate to Governance > Personas.

  2. Click New Persona and provide:

    • Name: Enter a descriptive name (for example, Qualytics Integration)
    • Description: Provide a brief description of the persona's purpose

  3. Click Create to create the persona.

  4. After creating the persona, click Add Policies.

  5. Select New Policy and choose Metadata Policy from the dropdown menu.

  6. Configure the metadata policy:

    • Policy name: Enter a descriptive name (for example, Qualytics Data Access)
    • Connection: Select the connection that corresponds to your data source in Qualytics
    • Permissions: Configure the permissions and assets that Qualytics can access

  7. Click Create to save the policy.

Generate Atlan API token​

  1. In Atlan, navigate to Settings > API Tokens in the Admin Center.

  2. Click Generate API Token.

  3. Provide the token details:

    • Name: Enter a descriptive name (for example, Qualytics Integration Token)
    • Description: Provide a brief description of the token's purpose
    • Persona: Select the persona you created in the previous section

  4. Click Generate to create the token.

  5. Copy and securely store the generated API Token. You'll need this for the Qualytics configuration and when setting up the crawler workflow in Atlan.

Generate API token for Qualytics​

  1. Sign in to your Qualytics instance.

  2. Navigate to Settings > API Tokens.

  3. Click Generate API Token or Create Token.

  4. Provide a name for the token (for example, Atlan Integration Token).

  5. Copy and securely store the generated API Token. You'll need this when setting up the crawler workflow in Atlan.

For detailed steps on configuring the Atlan integration in Qualytics, including authentication and synchronization options, see Configure Atlan integration in Qualytics.

Troubleshooting​

If you have any issues related to configuring the workflow, contact Atlan support.

Next steps​