Configure an Alteryx Tool

The term “HTML5 Plugin” loosely describes a custom tool consisting of two components:

The GUI component must be written in HTML5 using the HTML GUI SDK. The engine component can be written in any of the supported languages:

To see C++ and legacy documentation, check your Alteryx installation location for \Alteryx\APIs\AlteryxSDK.zip\Documentation\AlteryxSDK.chm.

Tool location

An HTML5 Plugin and its components reside in the Alteryx installation location:

\bin\HtmlPlugins

The name of the directory is used as the label for the tool in Designer.

\bin\HtmlPlugins\MyNewPlugin

The directory must include a configuration file and all dependencies required by the tool, such as JavaScript libraries, style sheets, and help.

Tool files

A custom tool needs the following files to execute correctly. These pages can be built manually, or can be created using the Alteryx Tool Generator.