Machine Learning DCM Setup

Version:
2022.3
Last modified: January 09, 2023

This page guides you through a step-by-step process to set up the Data Connection Manager (DCM) for the Machine Learning Send and Machine Learning Predict tools in Designer and run them with Server. DCM is the unified secure vault to store Credentials, Data Sources, and Connections. To learn more about DCM, go to the DCM page for a full overview.

System Requirements

  • Alteryx Designer 21.3+
  • Alteryx Server 21.3+
  • Alteryx Machine Learning Designer Integration Tools

Download

To use the Machine Learning Send and Machine Learning Predict tools, download the Alteryx Machine Learning Designer Integration Tools. Go to the downloads page, then Alteryx Intelligence Suite > Alteryx Intelligence Suite (your Designer version) > Alteryx Machine Learning Designer Integration Tools. Note that the integration tools are separate from the tools included in Alteryx Intelligence Suite.

Install

Designer

  1. Download the Alteryx Machine Learning Designer Integration Tools YXI file as described in the Download section.
  2. In Designer, select File > Open Workflow > Browse.
  3. Find the Alteryx Machine Learning Designer Integration Tools YXI and then select Open. The tool installer displays.
  4. Follow the prompts to install the tools.

Server

See the Install Custom Tools article for details. The basic steps are:

  1. Remote desktop into Server.
  2. Run Designer as Administrator.
  3. Install the Alteryx Machine Learning Designer Integration Tools YXI on all Server nodes.

Data Connection Manager Configuration

Configure User Settings to Enable DCM

  1. Open Designer, then go to Options > User Settings > Edit User Settings.
  2. Select the DCM tab.
  3. Check the Override DCM Settings checkbox.
  4. Configure DCM Settings.
    1. Check the Enable DCM checkbox.
    2. From the DCM Mode dropdown, select DCM as Default.
    3. From the SDK Access Mode dropdown, select Allow or AllowAll.
      1. For Designer 2021.4, only select Allow.
  5. Select Save.

Configure Server System Settings (For Server Administrators Only)

  1. Open Designer, then go to Options > Advanced Options > System Settings.
  2. Select Next until you reach the DCM page.
  3. Configure the DCM settings.
    1. Check the Enable DCM for your Organization checkbox.
    2. From the DCM Mode dropdown, select DCM as Default.
    3. From the SDK (Gallery) Tools support dropdown, select Allow or AllowAll.
      1. For Designer 2021.4, only select Allow.
    4. Check the Allow Override by User checkbox.
  4. Select Next until you reach the Finalize Your Configuration page.
  5. Select Finish to close the window.
    1. Note that this will restart the service.

Select a Data Source in the Connection Manager

  1. Place a Machine Learning Send or Machine Learning Predict tool on the canvas.
  2. Enter the URL you use to access your Alteryx Machine Learning account.
  3. Sign In to your account.
  4. Now that DCM is configured, a Connection Manager window will open to access your Data Sources.
    1. The Connection Manager at this step only shows Alteryx Platform-related Data Sources.
  5. If you already have an Alteryx Platform Data Source, select it now.
  6. To add a Data Source in Connection Manager…
    1. Select + Add Data Source.
    2. Enter a Data Source Name.
    3. Select Save.

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.

If you have an existing credential:

  1. Select + Connect Credential.
  2. From the Authentication Method dropdown, select Access Token and Refresh Token.
    1. If you selected Allow in the User Settings, check the Allow connection for SDK checkbox.
  3. Select your Credential.
  4. Select Link.

To add a new credential:

  1. Select + Connect Credential.
  2. From the Authentication Method dropdown, select Access Token and Refresh Token.
    1. If you selected Allow in the User Settings, check the Allow connection for SDK checkbox.
  3. From the Credential dropdown, select Create New Credential.
  4. Enter Credential Name.
  5. Leave Access Token and Refresh Token blank.
  6. Select Create and Link.
  7. Select Connect.

Sync Your 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 then select Connect.
    3. Enter the Email and Password of your Server account and then select Sign In.
  4. Select the Server instance to sync with.
  5. Select Synchronize on the upper right.
  6. Select Done.

Set Up Your Gallery Connection

Now that you’ve synced your connection, you need to allow it in Gallery.

  1. In a browser, go to your company’s instance of Gallery (for example, http://mycompany.com/gallery).
  2. Go to Gallery DCM Data Sources page.
  3. Select your data source.
  4. From the Connections section, select the 3-dot menu > Edit.
  5. Check the Allow connection for SDK checkbox.
  6. Select Save and Link.

Workflows that use the Machine Learning Send and Machine Learning Predict tools are now ready to run on with Server. To upload or download workflows, follow the Workflows article.

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.