Package a Tool

Version:
2019.3
Last modified: October 10, 2019

The .yxi file format is an alternative to a .zip archive that displays an installer dialog, providing metainfo to the user about the tool being installed. Use .yxi packaging to package custom tools for distribution to other Alteryx users.

When installed, Designer extracts the .yxi contents to one of two paths, based on the selection by the user:

  • to the user path %APPDATA%\Alteryx
  • for all users on the machine %ALLUSERSPROFILE%\Alteryx

When installed for all users, the installation excludes files in the root of the .yxi archive.

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 back end macro of an HTML tool as Supporting_Macros\MyMacro.yxmc, Designer attempts to use each of the paths in succession.

Referencing macro paths

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.

Package Configuration File

Each tool being distributed by .yxi must contain a Config.xml file in the root. This file provides the information needed to ensure the tool is corrected installed into Alteryx Designer. The file contains 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

Image pixel limitation

Icons have a 171 x 171 pixel size limit. If your image is not rendering on the canvas, try adding a transparent border around the icon.

 

Example Config.xml

XML
  1. <?xml version="1.0"?>
  2. <Configuration>
  3. 	<Properties>
  4. 		<MetaInfo>
  5. 			<Icon>MyNiftyPlugin\MyNiftyPlugin.png</Icon>
  6. 			<Name>My Nifty Plugin</Name>
  7. 			<CategoryName>Parse</CategoryName>
  8. 			<ToolVersion>1.0.0</ToolVersion>
  9. 			<Author>Alteryx</Author>
  10. 			<Description>This is my Nifty plugin, which appears in Parse.</Description>
  11. 		</MetaInfo>
  12. 	</Properties>
  13. </Configuration>

Package Creation

  1. Create a .zip file with the folder structure:
    • Tool folder: a folder containing the custom tool assets. Include one folder per tool being installed. See Getting Started with Developer for information about the contained assets.
      • Tool configuration .xml file
      • Tool icon .png file
      • Tool engine file or Supporting_Macros folder
      • Tool .html GUI file
      • Optional: You can separate JavaScript from your .html file into a separate .js file
    • Package Config.xml file: a file at the root of the .yxi used to configure the installer dialog.
    • Package icon .png file. This can also be the icon inside the tool folder.
  2. Rename the .zip file to have a .yxi extension.

Build Your Own Tool Checklist

Was This Helpful?

Need something else? Visit the Alteryx Community or contact support.