> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/connectors/connector-repositories/etl-tool/alteryx.md).

# 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.

{% hint style="info" %}
The connector supports crawling Alteryx workflow, analytic application, macro, and package files with the extensions .yxmd, .yxwz, .yxmc, and .yxzp.
{% endhint %}

<div align="left"><img src="/files/SlRMyVeWJBGP38s5phLk" alt="" height="348" width="624"></div>

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="398"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>ETL</td></tr><tr><td>OvalEdge Release Supported</td><td>Release6.3.4 and later</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with Alteryx]</p></td><td>Local File System (NFS) / OneDrive</td></tr></tbody></table>

### 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                                       |       ✅      |

{% hint style="info" %}
"NA" indicates that the respective feature is 'Not Applicable.'
{% endhint %}

### Metadata Mapping

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

<table><thead><tr><th width="148">Alteryx Object</th><th width="158">Alteryx Attribute</th><th width="170">OvalEdge Attribute</th><th width="172">OvaEdge Category</th><th width="200">OvalEdge Type</th></tr></thead><tbody><tr><td>.yxmd file</td><td>.yxmd file</td><td>Code name</td><td>Code</td><td>AlteryxWorkFlow</td></tr><tr><td>.yxwz file</td><td>.yxwz file</td><td>Code name</td><td>Code</td><td>AlteryxAnalytic App</td></tr><tr><td>.yxmc file</td><td>.yxmc file</td><td>Code name</td><td>Code</td><td>AlteryxMacros</td></tr><tr><td>.yxzp file</td><td>.yxzp file</td><td>Code name</td><td>Code</td><td>AlteryxPackages</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

#### **Service Account User Permissions**

{% hint style="warning" %}
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.
{% endhint %}

{% hint style="info" %}
**👨‍💻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.
{% endhint %}

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

### Connection Configuration Steps

{% hint style="warning" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

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

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="220">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Alteryx</strong>" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul><p>For more details, click <a href="https://docs.ovaledge.com/connectors/additional-requirements/credential-manager-configuration">here</a>.</p></td></tr><tr><td>License Add Ons</td><td><p>Select the checkbox for the Auto Lineage Add-On to build data lineage automatically.</p><p>For more details, click <a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/license-types-and-add-ons">here</a>.</p></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Alteryxconnection              </p><p>(Example: "Alteryxdb").</p></td></tr><tr><td>Connector Environment</td><td><p>Select the environment (Example: PROD, STG) configured for the connector.</p><p>For more details, click <a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/prerequisites#connector-environment">here</a>.</p></td></tr><tr><td>Connector Description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Alteryx Files Type*</td><td><p>The system supports the following Alteryx file sources. Select an option from the drop-down menu:</p><ul><li>Local Files</li><li>One Drive</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="Local Files" %}

<table><thead><tr><th width="190">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Local File Path*</td><td>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.</td></tr><tr><td>Proxy Enabled*</td><td>Select <strong>Yes</strong> to route API calls through a proxy server. Select <strong>No</strong> to bypass the proxy and connect directly.</td></tr></tbody></table>
{% endtab %}

{% tab title="One Drive" %}

<table><thead><tr><th width="189">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>One Drive Path*</td><td>Enter the OneDrive folder path that contains the Alteryx files to be crawled. The connector uses this path to locate and retrieve metadata from supported files stored in OneDrive.</td></tr><tr><td>Proxy Enabled*</td><td>Select <strong>Yes</strong> to route API calls through a proxy server. Select <strong>No</strong> to bypass the proxy and connect directly.</td></tr><tr><td>One Drive Connection Id*</td><td>Enter the unique OneDrive connection identifier configured in the system. This connection is used to authenticate and access the specified OneDrive location for metadata crawling.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="220"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>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.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="220"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="220"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, select the bridge from the drop-down list.</p><p>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.</p></td></tr></tbody></table>

2. 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.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl

{% hint style="warning" %}
To perform crawl operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more files for crawling.&#x20;

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](https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/connector-settings).

### 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.

<table><thead><tr><th width="84">S. No</th><th width="150">Error Message</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating connection: Invalid Path</td><td><p><strong>Error Description</strong>: The specified Local File Path or OneDrive Path is invalid, inaccessible, or does not contain the required Alteryx files.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the entered path is correct and accessible.</li><li>Ensure the configured user has read permission on the specified location.</li><li>Confirm that the path contains supported Alteryx files (.yxmd, .yxwz, .yxmc, or .yxzp).</li></ul></td></tr><tr><td>2</td><td>Error while validating connection: Authentication Error</td><td><p><strong>Error Description</strong>: Authentication failed while accessing the configured file source due to invalid or incorrect credentials.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the configured credentials are correct.</li><li>Ensure the credentials have access to the specified local path or OneDrive location.</li><li>Revalidate the connection after updating the credentials.</li></ul></td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ovaledge.com/connectors/connector-repositories/etl-tool/alteryx.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.