Alteryx

This article outlines the integration with the Alteryx connector, enabling streamlined metadata management through features such as crawling and lineage building (both automatic and manual). The connector crawls Alteryx workflows, analytic applications, macros, and packages from supported file sources, providing metadata discovery and lineage generation.

This connector supports connectivity through local file system paths (NFS) and OneDrive locations. Local file system connectivity enables access to Alteryx files stored on shared network directories, while OneDrive connectivity enables access to files stored in Microsoft OneDrive. Authentication is established using the configured file source and the permissions required to access Alteryx files in the specified location.

The connector supports crawling Alteryx workflow, analytic application, macro, and package files with the extensions .yxmd, .yxwz, .yxmc, and .yxzp.

Overview

Connector Details

Connector Category	ETL
OvalEdge Release Supported	Release6.3.4 and later
Connectivity [How the connection is established with Alteryx]	Local File System (NFS) / OneDrive

Connector Features

Feature	Availability
Crawling	✅
Delta Crawling	❌
Profiling	❌
Data Preview	❌
Auto Lineage	✅
Manual Lineage	✅
Secure Authentication via Credential Manager	✅
Data Quality	NA
DAM (Data Access Management)	NA
Bridge	✅

"NA" indicates that the respective feature is 'Not Applicable.'

Metadata Mapping

The following objects are crawled from Alteryx and mapped to the corresponding UI assets.

Alteryx Object	Alteryx Attribute	OvalEdge Attribute	OvaEdge Category	OvalEdge Type
.yxmd file	.yxmd file	Code name	Code	AlteryxWorkFlow
.yxwz file	.yxwz file	Code name	Code	AlteryxAnalytic App
.yxmc file	.yxmc file	Code name	Code	AlteryxMacros
.yxzp file	.yxzp file	Code name	Code	AlteryxPackages

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection:

Service Account User Permissions

It is recommended to use a separate service account to establish the connection to the data source, configured with the following minimum set of permissions.

👨‍💻Who can provide these permissions? These permissions are typically granted by the Alteryx administrator, as users may not have the required access to assign them independently.

Operations	Objects	Access Permissions
Crawling	.yxmd	READ
Crawling	.yxwz	READ
Crawling	.yxmc	READ
Crawling	.yxzp	READ

Connection Configuration Steps

Users are required to have the Connector Creator role in order to configure a new connection.

1. Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Alteryx, and complete the required parameters.

Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name	Description
Connector Type	By default, "Alteryx" is displayed as the selected connector type.
Credential Manager*	Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection. Supported Credential Managers: OE Credential Manager AWS Secrets Manager HashiCorp Azure Key Vault For more details, click here.
License Add Ons	Select the checkbox for the Auto Lineage Add-On to build data lineage automatically. For more details, click here.
Connector Name*	Enter a unique name for the Alteryxconnection (Example: "Alteryxdb").
Connector Environment	Select the environment (Example: PROD, STG) configured for the connector. For more details, click here.
Connector Description	Enter a brief description of the connector.
Alteryx Files Type*	The system supports the following Alteryx file sources. Select an option from the drop-down menu: Local Files One Drive

Local Files

Field Name	Description
Local File Path*	Enter the file path that contains the Alteryx files to be crawled. The connector uses this path to access Alteryx files and retrieve metadata from supported assets.
Proxy Enabled*	Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.

One Drive

Default Governance Roles

Default Governance Roles*	Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.

Admin Roles

Admin Roles*	Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in the security settings are available for selection.

Bridge

Select Bridge*	If applicable, select the bridge from the drop-down list. The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.

1. After entering all connection details, the following actions can be performed:

   1. Click Validate to verify the connection.

   2. Click Save to store the connection for future use.

   3. Click Save & Configure to apply additional settings before saving.

2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl

To perform crawl operations, users must be assigned the Integration Admin role.

The Crawl/Profile button allows users to select one or more files for crawling.

1. Navigate to the Connectors page and click Crawl/Profile.

2. Select the files to crawl.

3. The Crawl option is selected by default.

4. Click Run to collect metadata from the connected source and load it into the Data Catalog.

5. After a successful crawl, the information appears in the Data Catalog > Databases/<>Codes tab.

The Schedule checkbox allows automated crawling at defined intervals, from a minute to a year.

1. Click the Schedule checkbox to enable the Select Period drop-down.

2. Select a time period for the operation from the drop-down menu.

3. Click Schedule to initiate metadata collection from the connected source.

4. The system will automatically execute the crawl operation at the scheduled time.

Other Operations

The Connectors page provides a centralized view of all configured connectors, along with their health status.

Managing connectors includes:

• Connector Health: Displays the current status of each connector using a green icon for active connections and a red icon for inactive connections, helping to monitor the connectivity with data sources.

• Viewing: Click the Eye icon next to the connector name to view connector details.

Nine Dots Menu Options:

To view, edit, validate, build lineage, configure, or delete connectors, click on the Nine Dots menu.

• Edit Connector: Update and revalidate the data source.

• Validate Connector: Check the connection's integrity.

• Settings: Modify connector settings.

  • Lineage: Select server dialects for parsing and setting connector priority for table lineage.

• Build Lineage: Automatically build data lineage using source code parsing.

• Delete Connector: Remove a connector with confirmation.

For more details on connector settings, click here.

Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

S. No	Error Message	Error Description & Resolution
1	Error while validating connection: Invalid Path	Error Description: The specified Local File Path or OneDrive Path is invalid, inaccessible, or does not contain the required Alteryx files. Resolution: Verify that the entered path is correct and accessible. Ensure the configured user has read permission on the specified location. Confirm that the path contains supported Alteryx files (.yxmd, .yxwz, .yxmc, or .yxzp).
2	Error while validating connection: Authentication Error	Error Description: Authentication failed while accessing the configured file source due to invalid or incorrect credentials. Resolution: Verify that the configured credentials are correct. Ensure the credentials have access to the specified local path or OneDrive location. Revalidate the connection after updating the credentials.

---

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA