Skip to main content

Alteryx Copilot Setup

Install or Update Alteryx Copilot

Minimum Designer Version

Alteryx Copilot requires Designer version 2023.2.1.3.133 (Patch 3) or newer. Follow this guide to update Designer.

Once installed, Alteryx Copilot appears as a window in Designer, similar to the tool configuration window. You can dock or hide the window from the 3-dot menu.

To bring back the Copilot window, go to View and then select Alteryx Copilot.

WebView2

Alteryx Copilot relies on a new Microsoft technology called WebView2. This comes installed out-of-the-box on most Windows versions supported by Designer. However, Windows Server doesn't currently include WebView2. If Copilot detects that it's running in an environment where WebView2 is not installed, it prompts you to install it.

We recommend that an Admin user trigger the WebView2 installation and install it for all users.

Marketplace Download

  1. Go to Alteryx Marketplace and then search for Alteryx Copilot.

  2. From the Alteryx Copilot page, select Get Add-On to add it to your apps.

  3. Select Alteryx Copilot from your available applications. To view your available applications, go to Profile Menu > Account > Applications.

  4. Go to the Download Files tab to Download the latest YXI installation file.

  5. Open Designer and then open the Alteryx Copilot YXI file you just downloaded to start the installation or update process.

Alteryx One Platform Download

If you’re an Alteryx user on the new Alteryx Editions (Professional or Enterprise), you can download Alteryx Copilot via Alteryx One Platform. To download Alteryx Copilot from Alteryx One, sign in to your Alteryx One workspace and follow these steps:

  1. On the Alteryx One landing page, locate Designer Desktop and select the Download button.

  2. On the Product Downloads page, select Alteryx Copilot from the list (Alteryx Copilot is part of the Designer Desktop download options).

  3. Select Download to start the YXI file download.

  4. Open Designer and then open the Alteryx Copilot YXI file you just downloaded to start the installation or update process.

Update Alteryx Copilot

When a new version of Alteryx Copilot is available, you’ll receive an alert via a banner in the Alteryx Copilot UI.

  • You can select the Download link via the banner or select the “x” icon to dismiss the banner. The Download link opens either the Alteryx Marketplace or Alteryx One (depending on your account type), where you can download the new version of Alteryx Copilot.

  • If you dismissed the banner, go to the About tab (“i” icon) in the Alteryx Copilot UI to access the Update Copilot option.

Connect Alteryx Copilot

Note

Alteryx Copilot preview accounts are limited to 1,000 requests per user per calendar month. Requests don’t roll over month-to-month.

Connect Alteryx Copilot to Alteryx One from the chat window in Designer. If you've closed the Alteryx Copilot chat window, go to View and then select Alteryx Copilot to open it.

Designer Activation with License Keys

  1. From the Alteryx Copilot chat window, select New to Alteryx Copilot? Start a Preview. If the window isn’t open, go to View and then select Alteryx Copilot.

  2. Select Start Preview to join the Public Preview.

  3. Once authenticated, you can start using Alteryx Copilot.

Designer Activation with Alteryx One

  1. From the Alteryx Copilot chat window, select Start. If the window isn’t open, go to View and then select Alteryx Copilot.

  2. Select your Alteryx One workspace from the Available Workspaces dropdown, if it's not already selected. To add a different Alteryx One workspace...

    1. Go to File > Manage Connections > Alteryx Links.

    2. Select New and then select your cloud instance (for example, select United States if your URL starts with us1).

    3. Sign in to Alteryx One and then select the workspace you want to use.

    4. Follow the on-screen prompts and then you can select the new workspace from Alteryx Copilot.

  3. Select Continue to begin your chat with Alteryx Copilot.

Disable Alteryx Copilot

During Public Preview of Alteryx Copilot, you can restrict access to Alteryx Copilot by blocking outbound traffic to this URL pattern:

bash
https://us1.alteryxcloud.com/copilot/*

Blocking this endpoint prevents users in your organization from accessing Alteryx Copilot features, as this is the primary endpoint used by Alteryx Copilot services.

Note

This method is a temporary control mechanism applicable only during Public Preview. It might not prevent all future service interactions as Alteryx Copilot evolves.

Future Administrative Controls

With the official launch of Alteryx Copilot (timeline to be announced), administrators will have access to a built-in on/off toggle within the platform. This control will allow organizations to easily enable or disable Alteryx Copilot functionality for their users without requiring network-level configurations..

Uninstall Alteryx Copilot

To uninstall Alteryx Copilot, follow these steps…

  1. Close Designer if it's open.

  2. If you use Windows…

    Important

    You need to have hidden files visible in Windows to see these paths. To enable this option, refer to the Show hidden files section at the bottom of this page.

    • For Non-Admin Designer, go to C:\Users\<username>\AppData\Roaming\Alteryx\Extensions.

    • For Admin Designer, go to C:\ProgramData\Alteryx\Extensions.

  3. If you use a Mac…

    • For Non-Admin Designer, go to AppData\Roaming\Alteryx\Extensions.

    • For Admin Designer, go to C:\ProgramData\Alteryx\Extensions.

  4. Select the AyXChatBotExt or AyxCopilotExt folder and delete it.

    • The AyXChatBotExt folder applies to the previous version of Alteryx Copilot (available via Private Preview). Once you install the Public Preview version of Copilot from the Alteryx Marketplace, you will not need to uninstall it before you install a new version.

    • If you do need to uninstall the Public Preview version of Copilot, follow the above steps and delete the AyxCopilotExt folder instead.

  5. Open Designer.

In this section: