Overview¶
Alation Cloud Service Applies to Alation Cloud Service instances of Alation
Customer Managed Applies to customer-managed instances of Alation
This connector should be used to catalog Alteryx data sources in Alation. It extracts Alteryx objects such as workflows, connections, datasets, users and other metadata. You can search and find Alteryx objects, curate the corresponding catalog object pages, and understand the transformation of the data using Lineage diagrams. The connector is available as a Zip file that can be uploaded and installed in the Alation application. The latest connector package will be delivered to the customer from the Forward Deployed Engineering team for installation. Use the instructions given in this guide to install and manage the connector
Team¶
The following administrators are required to install this connector:
Alteryx administrator:
Creates a service account for Alation
Provides the connection information including host URL of the server, client ID and client secret
Provides authentication information and assists in configuring the authentication
Alation Server administrator:
Ensures that Alation Connector Manager is installed and running or installs it
Installs the Alteryx connector
Creates and configures the Alteryx data source in the catalog
Performs initial extraction and prepares the data source for Alation users
Scope¶
The table below lists the features supported by the Alteryx enhanced connector.
Feature |
Scope |
Availability |
---|---|---|
Authentication |
||
ClientId & ClientSecret |
Authentication with a service account created on the database using the ClientId & ClientSecret |
Yes |
SSL |
Authentication with the private-public key pair |
Yes |
Metadata Extraction |
||
Default MDE |
Extraction of metadata from Alteryx based on default queries in the connector code |
Yes |
Extracted metadata objects |
||
Schemas |
List of schemas |
Yes |
Tables |
List of tables |
Yes |
Columns |
List of columns |
Yes |
Column data types |
Column data types |
Yes |
Primary keys |
Primary key information for extracted tables |
No |
Foreign keys |
Foreign key information for extracted tables |
No |
Views |
List of views, including materialized views, secure views, and secure materialized views |
No |
External tables |
Extraction of external table metadata |
N/A |
Stored procedures |
Stored procedures will appear in search results |
N/A |
Functions |
Functions will appear in the search results |
N/A |
Function Definitions |
Function definition metadata |
N/A |
Tags |
Extracts of tags |
N/A |
Policies |
Extraction of row access policies and data masking policies |
N/A |
Sampling and Profiling |
||
Table sampling |
Retrieval of data samples from extracted tables |
Yes |
Tables |
List of tables |
No |
Columns |
List of columns |
Yes |
Column data types |
Column data types |
Yes |
Primary keys |
Primary key information for extracted tables |
No |
Foreign keys |
Foreign key information for extracted tables |
No |
Column sampling |
Retrieval of data samples from extracted columns |
No |
Custom query-based column sampling |
Ability to use custom queries for profiling specific columns |
No |
Stored procedures |
Stored procedures will appear in search results |
N/A |
Deep column profiling |
Profiling of columns with the calculation of value distribution stats |
No |
Dynamic profiling |
Ability for individual users to connect with their own database accounts to retrieve table and column samples and profiles |
No |
Lineage |
||
Automatic lineage generation |
Automatic lineage generation based on extracted metadata |
Yes |
External table file lineage |
Lineage for external tables |
Yes - v2 |
Column-level lineage |
Calculation of lineage data at the column level |
Yes |
Compose |
||
Customer-managed (on-premise) Alation instances |
Compose for on-premise Alation instances network configuration, you may need to use Alation Agent to connect to your data source |
N/A |
Alation Cloud Service instances |
Compose on Alation Cloud Service instances: depending on your |
N/A |
SSO via OAuth |
Authentication in Compose using the OAuth protocol |
Yes |
Object Mapping¶
Alteryx Object |
Alation Object |
---|---|
Workflows |
Schema |
Tool/Transformation tile |
Table |
Column in tile |
Column |