DCM - Designer

Version:
2022.3
Last modified: January 11, 2023

Data Connection Manager (DCM) is a centralized storage for Database and Cloud interoperable connections (credentials linked to data sources) that facilitates workflow connection management and collaboration across Alteryx products. Use DCM to enter and use your connections and credentials among tools and workflows.

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.

See the Supported Connectors and Tools.

Data Connection Manager Configuration

As an administrator, you can choose to Enable DCM for your Organization in Options - Advanced Options - System Settings - DCM. This will enable DCM and set the selected DCM Mode for all users on the 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 – Connections (including passwords) are stored in a workflow by default. You can choose to store and manage connections in DCM.  

  • DCM as Default – Connections (including passwords) are stored and managed in DCM by default. You can choose to store them in a workflow.  

  • DCM Only –You can't configure connections in a workflow. You can only select connections 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 tools checkbox is not displayed in the credential UI. 

  • Allow –SDK tools are supported, and the Allow Credential for SDK tools checkbox is displayed in the UI with manual selection of each credential. 

  • AllowAll –SDK tools are supported and the Allow Credential for SDK tools checkbox is not displayed in the credential UI. 

User Settings 

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

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

  • DCM Optional – Connections (including passwords) are stored in a workflow by default. You can choose to store and manage connections in DCM.  

  • DCM as Default – Connections (including passwords) are stored and managed in DCM by default. You can choose to store them in a workflow.  

  • DCM Only –You can't configure connections in a workflow. You can only select connections 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 tools checkbox is not displayed in the credential UI. 

  • Allow –SDK tools are supported, and the Allow Credential for SDK tools checkbox is displayed in the UI with manual selection of each credential. 

  • AllowAll –SDK tools are supported, and the Allow Credential for SDK tools checkbox is not displayed in the credential UI. 

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.

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

  • Go to File > Manage Connections to open Connection Manager.
  • Select Backup.
  • Enter your backup file password.
  • Select the Backup.
  • Choose a location and optionally a name for your backup file.
  • Select Save.

Restore

  • Go to File > Manage Connections to open Connection Manager.
  • Select Restore.
  • Enter your backup file password.
  • Select the Restore.

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. 

Supported Connectors and Tools

For the list of the tools and Connectors supported by DCM, see DCM Supported Connectors and Tools.

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.