Designer DCM

Data Connection Manager (DCM) is the unified secure vault to store Credentials, Data Sources, and Connections. Use DCM to improve security by moving your credentials outside the workflow and synchronizing them across the Alteryx product suite.

With DCM you can manage data sources, credentials and connections:

  • Data source objects represent databases, cloud services, and more.

  • Credential objects represent username and password combinations and OAuth tokens.

  • Connection objects join data sources to credentials and are used by one or many tools in your workflow.

Data Connection Manager Configuration

As an administrator, you can choose to Enable DCM for your machine in DCM > General > System Settings. This will enable DCM and set selected DCM Mode for all users on selected machine or organization.

Admin Settings

There is also an option to Allow Override by User, which grants the user permission to enable or disable DCM, change DCM Mode, and choose SDK Access Mode.

These options are available to set the  credential handling and storage:

  • DCM Optional: You can choose to store passwords in DCM. Passwords are stored in a workflow by default.

  • DCM as Default: Passwords are stored in DCM by default. You can choose to store passwords in a workflows.

  • DCM Only: You can't enter passwords into a workflow. You can only choose from passwords stored in DCM. Workflows with embedded passwords will run.

  • DCM Enforced: Workflows with embedded passwords will not work.

For the SDK Tools support, there are administrative options:

  • Deny: SDK Tools are not supported, and the Allow Credential for SDK (Server) tools check box is not displayed in the credential UI.

  • Allow: SDK tools are supported, and the Allow Credential for SDK (Server) tools check box is displayed in the UI with manual selection of each credential.

  • AllowAll: SDK tools are supported, and the Allow Credential for SDK (Server) tools check box is displayed in the UI and is pre-checked for all credentials.

User Settings

If allowed by the administrator, as a user you have the permission to Override DCM Settings set for your organization, enable or disable DCM, change DCM Mode, and choose SDK Access Mode in DCM > User Settings.

These options are available to set the  credential handling and storage:

  • DCM Optional: You can choose to store passwords in DCM. Passwords are stored in a workflow by default.

  • DCM as Default: Passwords are stored in DCM by default. You can choose to store passwords in a workflows.

  • DCM Only: You can't enter passwords into a workflow. You can only choose from passwords stored in DCM. Workflows with embedded passwords will run.

  • DCM Enforced: Workflows with embedded passwords will not work.

For the SDK Tools support, there are administrative options:

  • Deny: SDK Tools are not supported, and the Allow Credential for SDK (Server) tools check box is not displayed in the credential UI.

  • Allow: SDK tools are supported, and the Allow Credential for SDK (Server) tools check box is displayed in the UI with manual selection of each credential.

  • AllowAll: SDK tools are supported, and the Allow Credential for SDK (Server) tools check box is displayed in the UI and is pre-checked for all credentials.

Connection Manager

You can control the Data Sources and Credentials that authenticate to the Data Sources in the Connection Manager. Go to File > Manage Connections.

Manage Data Sources

To add a Data Source in Connection Manager...

  1. Go to Data Sources.

  2. Select + Add.

  3. Choose Technology from the dropdown.

  4. Fill in the information needed for the technology you want to connect.

  5. Select Save.

You can combine the Data Source with the Credential to create a Connection. In the Data Sources > Connections section you can see the list of linked credentials for the Connection or link a new credential:

  1. Select + Connect Credential.

  2. Choose an Authentication Method.

  3. Fill in the credential information.

  4. Optionally you can choose to Allow connection for SDK.

  5. Select the Create and Link button.

Manage Credentials

To add a Credential in the Connection Manager, go to the Credentials section. You have these options available:

  • Add Credentials: Select + Add Credential. Enter Credential Name. Select a Method. Enter required info (for example, Client ID, Secret Key, Username, Password) for the selected method. Select Save.

  • View Credentials: Select the credential you want to view from the list.

  • Edit Credential: To edit a credential in Connection Manager, select the credential you want to edit from the list. Select Edit. Select Save.

  • Delete Credential: Select the credential you want to delete in Connection Manager. Select the trashcan icon. Select Delete.

To connect with your Connection, place the tool on the Canvas and select Set up a Connection. In the Connection Manager window, choose your Connection and use linked credentials by selecting the Connect button.

Sync Credentials

With DCM.E you can sync credentials across the Alteryx product suite.

Sync Credentials Between Designer and Server

  1. Go to File > Manage Connections to open Connection Manager.

  2. Select Synchronize.

  3. For the new Server connection:

    1. Select + Add Gallery.

    2. Enter the Server instance URL and select Connect.

    3. Enter Email and Password and select Sign In.

  4. Select Server instance to sync with.

  5. Select Synchronize.

  6. Select Done.

Add Credentials with Sync

  1. Go to File > Manage Connections to open Connection Manager.

  2. Go to Credentials.

  3. Select Add Credential.

  4. Enter credential details.

  5. Select Save.

  6. Perform steps 2 to 5 from the Sync Credentials Between Designer and Server section.

Edit Credentials with Sync

  1. Go to File > Manage Connections to open Connection Manager.

  2. Go to Credentials.

  3. Select the credential to update.

  4. Select Edit.

  5. Update credential details.

  6. Select Save.

  7. Perform steps 2 to 5 from the Sync Credentials Between Designer and Server section.

Delete Credentials with Sync

  1. Go to File > Manage Connections to open Connection Manager.

  2. Go to Credentials.

  3. Select the credential you want to delete.

  4. Select the trashcan icon.

  5. Select Delete to confirm.

  6. Perform steps 2 to 5 from the Sync Credentials Between Designer and Server section.

Sync Workflow with DCM Credentials

  1. Perform workflow upload or download as per the Workflows article.

  2. Perform steps 2 to 5 from the Sync Credentials Between Designer and Server section.

Backup & Restore

You can backup your DCM storage and restore it from the backup file.

Important

This feature is based on your Designer licensing. You are only able to restore a backup that was made with the same license as you have active. The backup and restore doesn't work in the trial version or with multiple licenses active.

Backup

  1. Go to File > Manage Connections to open Connection Manager.

  2. Select Backup.

  3. Enter your backup file password.

  4. Select the Backup.

  5. Choose a location and optionally a name for your backup file.

  6. Select Save.

Restore

  1. Go to File > Manage Connections to open Connection Manager.

  2. Select Restore.

  3. Enter your backup file password.

  4. Select the Restore.

Synchronize DCM Between Server and Designer

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

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

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

Supported Tools and Connectors

This is the list of tools and connectors for which DCM is supported.

Tool or Connector Technology (if applicable) Available in 21.4
Input and Output Data    
Oracle ODBC Yes
  Quick Connect Yes
  OCI Yes
  OleDB Not Needed
  Bulkload Yes
MSSQL Quick Connect Yes
  ODBC Yes
  OleDB Not Needed
  Bulkload Yes
HDFS   Yes
Amazon Athena ODBC Yes
  Bulkload Yes
Amazon Aurora ODBC Yes
Amazon Redshift ODBC Yes
  Bulkload Yes
Amazon Redshift Spectrum ODBC Yes
  Bulkload Yes
Cassandra ODBC Yes
Databricks ODBC Yes
EXASOL ODBC Yes
Hive ODBC Yes
IBM DB2 ODBC Yes
  OleDB Not Needed
IBM Netezza ODBC Yes
Impala ODBC Yes
Microsoft Analytics Platform System ODBC Yes
  Bulkload Yes
  OleDB Not Needed
Microsoft Azure SQL Data Warehouse ODBC Yes
  Bulkload Yes
  OleDB Not Needed
Microsoft Azure SQL Database ODBC Yes
  Bulkload Yes
MySQL ODBC Yes
NetSuite ODBC Yes
Pivotal Greenplum ODBC Yes
PostgreSQL ODBC Yes
  Bulkload Yes
SAP Hana ODBC Yes
Snowflake ODBC Yes
  Bulkload Yes
Spark ODBC Yes
Teradata ODBC Yes
  OleDB Not Needed
  Bulkload Yes
Teradata Aster ODBC Yes
  OleDB Not Needed
Vertica ODBC Yes
Gallery Tools    
Adobe Analytics   No
Google Analytics   No
Google BigQuery   No
Google Sheets   No
Marketo   No
Microsoft Azure Data Lake Store   No
Microsoft Cognitive Services   No
Microsoft Dynamics CRM   No
Microsoft OneDrive   No
Salesforce   No
Built-in Tools    
Sharepoint List Input and Output   Yes
MongoDB Input and Output   Yes
Amazon S3 Download and Upload   Yes
Dynamic Input   Yes
Download   No
Email   No
Macro Support   No
In-Database    
Amazon Redshift   No
MongoDB Input and Output   No
Apache Spark Direct   No
Apache Spark ODBC   No
Apache Spark on Databricks   No
Apache Spark on Microsoft Azure HDInsight   No
Databricks   No
EXASQL   No
Greenplum   No
Hive   No
IBM Netezza   No
Impala   No
MS Analytics Platform System   No
MS Azure SQL DWH   No
MS Azure SQL DB   No
MySQL   No
Oracle   No
SAP Hana   No
Snowflake   No
Teradata   No
Vertica   No