Skip to main content

Set up Alteryx Private preview

Set up real-time integration between Alteryx and Atlan using OpenLineage. This integration automatically catalogs assets and creates lineage in Atlan whenever workflows run in Alteryx, providing immediate visibility into your ETL processes.

Prerequisites​

Before you begin, make sure you have:

  • You have Admin or Workflow Admin permissions to create workflows and generate API tokens.
  • You have Administrator access to configure OpenLineage integration.
  • An API token for authentication.

Create workflow in Atlan​

Follow these steps to create an Alteryx listener workflow that receives OpenLineage events:

  1. Navigate to the Workflow section.

  2. In the top right of any screen, click New and then click New workflow.

  3. From the filters along the top, click Orchestrator.

  4. From the list of packages, select Alteryx and then click Create Listener.

Configure the connection​

Important

A single connection (namespace) must be used for only one Alteryx instance. Using the same connection across multiple instances may cause environment variables to update incorrectly, leading to unexpected behavior.

You only need to configure the connection once to enable Atlan to receive incoming OpenLineage events.
After setup, Atlan automatically processes these events as Alteryx workflows run, enabling seamless cataloging of Alteryx assets.

To configure the Alteryx connection in Atlan:

  1. For Connection Name, 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.

Important

If no user or group is specified, the connection can't be managed, not even by admins.

  1. Click Create connection at the bottom of the screen to save and activate it.

Configure the integration in Alteryx​

Did you know?

You need the Atlan API token and connection name to configure the integration in Alteryx. Contact your account manager to enable Alteryx data lineage on the Alteryx side. This enables Alteryx to connect with the OpenLineage API and send events to Atlan.

An Alteryx administrator configures the OpenLineage integration using:

  1. Navigate to the OpenLineage configuration settings in your Alteryx environment.

  2. Paste the API token you generated into the API Token field.

  3. Enter the connection name you used when creating the connection in Atlan (for example, production, analytics).

  4. Add your Atlan Hostname in the format https://your-workspace.atlan.com and click Save.

Verify the connection​

To verify that the integration is working correctly:

  1. Run a workflow in your Alteryx instance to trigger OpenLineage events.

  2. Open Atlan and check for newly created Alteryx assets under the configured connection.

  3. Confirm that lineage information from the workflow appears in the asset view.

  4. Open the Event Logs in Atlan to review the OpenLineage events and verify successful ingestion.

Atlan validates the existence of the corresponding Alteryx connection by checking that the connection name matches and the API token is valid.

Once the workflows finish running in Alteryx, Alteryx workflows and lineage generated from OpenLineage events appear automatically in Atlan.

See also​