Install Custom Tools

Last modified: April 02, 2020

Alteryx provides several options for creating custom tools. One method for deploying a custom tool involves packaging the tool and all of its dependencies into a single .yxi file.

When a user installs a .yxi tool, the tool is added to the tool palette in Alteryx Designer, and the .yxi file and supporting macros are installed in the following directory: \Users\<username>\AppData\Roaming\Alteryx\Tools\.

Administrators can optionally install a .yxi tool for all Server users; this makes it easier for users to schedule workflows and run workflows from the Gallery. To install for all users, your account must have the appropriate permissions. .yxi tools installed for all users will be installed in the following directory: ProgramData\Alteryx\Tools.

To install a .yxi for all users:

  1. Open the Alteryx Designer instance on Alteryx Server.
  2. Open the .yxi file.
  3. Select Install for all users, and then select Install.

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.