Skip to main content

Machine Learning DCM Setup

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 24.1+

  • Alteryx Server 24.1+

  • Alteryx Machine Learning Designer Integration Tools 24.1+

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

Important

If you’ve previously installed the Machine Learning Integration tools, you should first update to the 2023.2.0 version before you install the 2024.1 version. Even if you’ve already installed Designer 2024.1. Note that you don’t need to uninstall previous versions before installing a new version.

  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

Go to 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.

Connect to Alteryx Machine Learning (OAuth)

For first time setup of the Machine Learning Integration tools, you must add your Alteryx Analytics Cloud (AAC) workspace as a Data Source…

  1. Add a Machine Learning Integration tool to your workflow.

  2. From the tool Configuration window, select Set Up a Connection to open the Data Connection Manager (DCM).

  3. On the Data Sources page, select New.

  4. Enter a Data Source Name that describes your AAC workspace.

  5. Enter the Base URL of your AAC workspace. For example, https://us1.alteryxcloud.com/.

  6. Enter your AAC Workspace Name.

  7. Select Save.

  8. From the Connections section, select Connect Credential.

  9. Leave OIDC as the Authentication Method.

  10. From the Credential dropdown, select your authorization credential.

    1. If you don’t have an authorization credential, select Create New Credential.

    2. Enter a Credential Name. For example, the name of your AAC workspace.

  11. Select the Allow connection for SDK checkbox.

  12. Select Link if you’ve used the Credential before, or select Create and Link if you just created it.

  13. Select Connect. Designer directs you to sign in to your AAC workspace.

If you already have a Data Source configured…

  1. Add a Machine Learning Integration tool to your workflow.

  2. From the tool Configuration window, select Set Up a Connection to open the Data Connection Manager (DCM).

  3. On the Data Sources page, select the Data Source you set up previously.

  4. Select Connect. Designer directs you to sign in to your AAC workspace.

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 New.

    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 Server Connection

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

  1. In a browser, go to your company’s instance of Server.

  2. Go to Server > DCM Data Sources page.

  3. Select your data source.

  4. From the Connections section, select the 3-dot menu and then select 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.

In this section: