Prerequisites¶

Alation Cloud Service Applies to Alation Cloud Service instances of Alation

Customer Managed Applies to customer-managed instances of Alation

Alation Agent - Alteryx¶

The Alation Agent is required for all ACS customers.

Firewall Configuration¶

Port 80 or 443 has to be open for Inbound and Outbound traffic

Gallery URL starting with http – 80
Gallery URL starting with https – 443

If the Gallery is accessible using the browser from outside the server machine, it means the ports are open.

Authentication Requirements¶

The Alteryx connector supports:

Basic Authentication
Kerberos Authentication
NTLM Authentication

Note: If Entra ID is deployed for Alteryx authentication you can consider using Entra ID’s support for Kerberos or NTLM.

Create a Service Account¶

The connector will only extract Alteryx information that is accessible by the service account whose credentials are configured in the connector settings. Create a service account, or use an existing account, and keep a note of these credentials for the connector configuration step.

Permissions for the Service Account¶

The Alteryx administrator will need to grant permission to the service account.

Permissions for Metadata Extraction¶

Allow User Access to the Alteryx Server API

Curators (Server admin) can follow these steps to enable a user’s API access:

Go to the User Management page in the Alteryx Server Admin interface
Select a user and go to the Permissions section
Select Edit
Check the API Access box to allow the user to access the API
Select Save

Retrieve the API URL

Access the Alteryx System Settings (available on the desktop of the server machine where Alteryx Server is installed)
Navigate to Gallery > General and copy the URL as shown below
- If the URL contains localhost, you should use the server IP address or the server name when accessing from outside the server machine:
  http://serverip/webapi - example: http://12.345.345.12/webapi
or http://servername/webapi - example: http://myalteryxserver/webapi

Test the API address, ClientID and Secret

In the Server UI, select the question mark icon in the upper right corner and then select API Documentation. This will take you to the API V3 Swagger page
Paste the API key and secret into the authentication modal in Swagger. Then select any API operation. When the operation expands, select the red exclamation point in the right corner to authenticate using your account
In the pop-up that appears, enter:
- Type: Request body
- ClientID: Your API Access Key
- Secret: Your API Access Secret