Install Custom Tools

Version:
2019.4
Last modified: September 09, 2020

Alteryx provides several options for creating custom tools. One method for deploying a custom tool is to package the tool and its dependencies into a single YXI file. See Package a Tool.

Install a Custom Tool in Designer

Designer users can open a YXI file to install the custom tool for use in workflows. Installing a YXI tool, adds. it to the tool palette in Designer. Designer installs the YXI file and its supporting macros in this directory:

\Users\<username>\AppData\Roaming\Alteryx\Tools\.

Install a Custom Tool for all Server Users

Server admins can install a custom tool (YXI) for all Server users.

  1. Open Designer as an administrator on Server. To do so, right-click the Designer icon and select Run as administrator,
  2. Open the YXI file.
  3. Select Install for all users, and select Install.

Server installs YXI tools in this directory:

ProgramData\Alteryx\Tools.

Alteryx loads tools in the Designer from these locations in the following order:

  • \Users\<username>\AppData\Roaming\Alteryx\Tools
  • \ProgramData\Alteryx\Tools
  • Alteryx install folders
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.