Install Custom Tools

Version:
2019.3
Last modified: May 27, 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 .yxi tool is installed by a user, the tool is added to the tool palette in Designer and the .yxi file and supporting macros are installed in: \Users\<username>\AppData\Roaming\Alteryx\Tools\.

Administrators can optionally install a .yxi tool for all Server users, in which case the tool is installed in: \ProgramData\Alteryx\Tools. Installing a .yxi tool for all users 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.

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 click Install.

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

  • C:\Users\<username>\AppData\Roaming\Alteryx\Tools
  • C:\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.