Package an Alteryx Tool

Package creation

Create a .zip file with the folder structure:
- Package name .zip file
  - Tool folder: a folder containing the custom tool assets. Include one folder per tool being installed. See Configure an Alteryx Tool for information about the contained assets.
    - Tool configuration .xml file
    - Tool icon .png file
    - Tool .html GUI file
    - Tool .js file
    - Tool engine file or Supporting_Macros folder
  - Package Config.xml file: a file at the root of the .yxi used to configure the installer dialog. See Package configuration XML file below.
  - Package icon .png file
Rename the .zip file to have a .yxi extension.

Package configuration XML file

Each .yxi must contain a Config.xml file in the root. The file should contain the metainfo for:

the installer icon
the installer name
the category the installed tools appear in
the installer version
the tool's author
the description of the installer contents

Example XML

<?xml version="1.0"?>
<Configuration>
	<Properties>
		<MetaInfo>
			<Icon>TestPlugin1\TestPlugin1Icon.png</Icon>
			<Name>Test Plugin1</Name>
			<CategoryName>Parse</CategoryName>
			<ToolVersion>1.0.0.0</ToolVersion>
			<Author>Alteryx</Author>
			<Description>This is Test Plugin1. It should appear in the Parse category for testing.</Description>
		</MetaInfo>
	</Properties>
</Configuration>

Installation paths

HTML tools and macros are found in several directories. If Designer detects the same macro installed in multiple places, the order of precedence for resolution is:

User tools path	%APPDATA%\Alteryx\Tools
Admin tools path	%ALLUSERSPROFILE%\Alteryx\Tools
HTML plugins path	<install directory>\bin\HtmlPlugins
Runtime macro path	<install directory>\bin\RuntimeData\Macros

If Designer detects the same HTML tool installed in multiple places, the order of precedence is the same.

Paths in Config.xml files can be relative to any of these paths. If you reference the backend macro of an HTML tool as Supporting_Macros\MyMacro.yxmc, Designer attempts to use each of the paths in succession.

Designer does not attempt to resolve the macro path relative to the HTML tool path. If Supporting_Macros is a subdirectory within the HTML tool, reference the macro path relative to one of the listed paths.