Data Connection Manager: Server UI

Version:
2022.3
Last modified: November 29, 2022

Data Connection Manager (DCM) is a secure, unified vault for storing user credentials for data connections. DCM improves security because it provides access control and a way to share connections. It improves the manageability of password credentials because the credential resolves at runtime, so it only needs to be updated once to serve multiple workflows. DCM allows you to synchronize credentials between Server and Designer. Go to the DCM help page for Designer for more info.

To configure DCM for your Server, visit the Data Connection Manager (DCM) help page. 

In the Server UI, Data Connection Manager consists of 3 parts: DCM Data Sources, DCM Vaults, and DCM Credentials.  

Add a Credential

To add a credential, go to DCM Credentials in the Server UI.  

  1. Select Add Credential.
  2. Enter a Credential Name. This is a user-friendly name for the credential. We recommend using a name that will help you to keep the usage for this credential obvious and keep the names distinct.
  3. Select DCM in Vault dropdown.
  4. Select Method for the credential. Select 1 of the authentication methods:   
    • AWS IAM Access Keys: Enter Access Key ID and Secret Access Key. Use this method to access S3 download/upload, Redshift bulk output, Athena bulk output, and Snowflake bulk output. 

    • Azure SharePoint App-Only: Enter Client ID and Secret Key. Use this method to access SharePoint Lists input/output. 

    • Azure User-Assigned Managed Service Identity: Enter Object ID. Use this method to access Azure SQL (such as Analytics Platform, SQL Data Warehouse, Azure SQL, and more). 

    • Microsoft Azure SQL Database Service Principal: Enter Client ID and Client Secret. Use this method to access Azure SQL. 

    • Username: Enter a Username. Use this method to access almost all data sources. 

    • Username and password: Enter a Username and Password. Use this method to access almost all data sources.   

  5. Select Save.

The credential displays in the DCM Credentials list. 

Add a Data Source

To add a data source, go to DCM Data Sources in the Server UI.  

  1. Select Add Data Source
  2. Select Technology.   
  3. Enter the required information, which depends on the selected Technology, such as Datasource Name, Server, Driver, Host, or Database
  4. Select Save.  

The data source displays in the DCM Data Sources list. 

Create a Connection

To connect a credential to a data source, go to DCM Data sources in the Server UI.  

  1. In the data source list, select the data source you want to connect to a credential. 
  2. In the data source details page, select Connect Credential.  
  3. Select the Authentication Method from the drop-down list.  
  4. Select the desired credential in the Credential drop-down.  
  5. Select Link.  

The combination of a data source with a linked credential is considered a connection. The created connection displays in Connections for the selected data source. 

Edit a Connection

To edit an existing connection, go to DCM Data sources in the Server UI.

  1. In the data source list, select the data source for which you want to edit an existing connection. 
  2. In the three-dot menu, select Edit
  3. Update the connection and select Save and Link

Share a Connection with Users and Groups

After you create a connection, you can share it with users or custom groups so that they can run your workflows on the Server. If you want users to be able access connections from the Server to use in their own Designer, you'll need to have the Server Administrator set up Server Data Connections

  1. On the DCM Data Sources page, select the connection you want to share. 
  2. In the three-dot menu, select Share.  
  3. In the Share Connection window, select Users or Custom Groups, then Add User or Add Group
  4. Enter the name of a user or group. 
  5. Select the user or group.  
  6. Select Add. The added users or custom groups display in the Users or Custom Groups list.  
  7. Select Done

The user or group you share the connection with is listed on the corresponding tab. Go to the DCM help page in the Designer help to see how users access and manage shared credentials in Designer.

Revoke Access to a Connection 

You can revoke a user's or group's access to a connection.  

  1. On the DCM Data Sources page, select the connection of a data source you want to share. 
  2. In the three-dot menu, select Share.  
  3. In the Share Connection window, select the trash icon next to the user or group name. To confirm, select Remove.  
  4. Select Done

Remove a Connection 

To remove an existing connection, go to DCM Data sources in the Server UI. 

  1. In the data source list, select the data source for which you want to remove an existing connection. 
  2. In the three-dot menu, select Unlink
  3. To remove the connection, select Delete in the pop-up window. 

Synchronize DCM between Server and Designer 

To synchronize DCM between Server and Designer, follow these steps: 

  1. Go to Designer > File > Manage Connections to open Connection Manager. Then select Synchronize in the menu.  
  2. Select from the list the Server you want to synchronize. 
  3. Select Synchronize.

After you have synchronized DCM between Server and Designer, any credentials you own and all data sources you have access to will be visible and ready for use in Connection Manager.  

Technology List

When you are adding a data source, you can select Technology from this list: 

Technology
  • SharePoint List (Application Only)
  • SharePoint List (Online/Office 365)
  • SharePoint List
  • Athena Bulk
  • PostgreSQL Bulk
  • Redshift Bulk
  • Snowflake Bulk (AWS S3 Staging)
  • Snowflake Bulk (Local Staging Named)
  • Snowflake Bulk (Local Staging Table)
  • Snowflake Bulk (Local Staging User)
  • Teradata Bulk
  • Microsoft SQL Server Bulk
  • PostgreSQL Bulk
  • Redshift Bulk
  • Snowflake Bulk (AWS S3 Staging)
  • Snowflake Bulk (Local Staging Named)
  • Snowflake Bulk (Local Staging Table)
  • Snowflake Bulk (Local Staging User)
  • Teradata ODBC
  • HDFS HTTPFS
  • HDFS Knox Gateway
  • HDFS WebHDFS
  • Mongo
  • Oracle Quick Connect
  • Oracle OCI
  • Athena Quick Connect
  • Azure ODBC
  • Teradata Aster ODBC
  • Athena ODBC
  • Aurora ODBC
  • Microsoft Azure SQL Data Warehouse ODBC
  • Microsoft Azure SQL Database ODBC
  • Google BigQuery ODBC
  • Cassandra ODBC
  • Apache Spark ODBC
  • EXASOL ODBC
  • Generic ODBC
  • Pivotal Greenplum ODBC
  • SAP Hana ODBC
  • Hive ODBC
  • IBM DB2 ODBC
  • IBM Netezza ODBC
  • Impala ODBC
  • Microsoft Analytics Platform System ODBC
  • Microsoft SQL Server ODBC
  • MySQL ODBC
  • NetSuit ODBC
  • Oracle ODBC
  • PostgreSQL ODBC
  • Redshift ODBC
  • Salesforce ODBC
  • Snowflake ODBC
  • Spark ODBC
  • Spectrum ODBC
  • Teradata ODBC
  • Vertica ODBC
  • Microsoft SQL Server Quick Connect
  • Redshift Quick Connect
  • Snowflake ODBC
  • Email SMTP
  • S3 Bulk
Was This Page Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support. Can't submit this form? Email us.