community
cancel
Showing results for 
Search instead for 
Did you mean: 

Dev Space

Customize & extend the power of Alteryx. SDKs, APIs, custom tools, and more!

Alteryx Designer .yxi Custom Tool Packager

Highlighted
Alteryx
Alteryx

NOTE: This is not an officially supported Alteryx utility

 

Overview

This post explains the process of installing and using the tool packager for Alteryx designer custom tools. This tool automates the process of packaging a custom tool as defined in this documentation: https://help.alteryx.com/developer/current/PackageTool.htm. All rules and steps for building the custom tool and setting up the directory structure are still required to be done prior to running the packaging tool up to the step of zipping the tool folder. This packaging tool handles the end of the process, starting from the step of zipping the tool.

 

Packaging Differences

The only optional difference in process when using the packaging tool vs packaging the tool manually is that the tool's Config.xml file can be placed inside the tool folder when using the packaging tool as opposed to sitting next to the tool folder when packaging manually. This optional difference exists to eliminate the need for nested tool folders.

 

Resource Location

The python script and it's installer are attached to this post as a 7z zip file. Please download the zip file and unpackage into any directory to use.

 

Windows Installation (Optional)

NOTE: The installation option is only available for users on windows machines.
Installation of the custom tool packager adds a windows explorer context menu option to run the package command.
Custom Tool Packager Menu Option.PNG

 

 

 

 

 

 

Run the batch file “alteryx_installer_context_menu.bat” as administrator to install the context menu option to run the package command (see Usage section below for usage).

 

Usage

Windows Explorer (Installation required)

To use the installer from windows explorer, please first follow the installation instructions above.
Execution: Right-click the folder containing the tool to package.
Output: Alteryx tool installer named {TOOL_NAME}_v_{VERSION}.yxi

 

Command Line

To use the installer from the command line the python script “custom_tool_packager.py” must be accessible from your local machine. This can be done by pulling the source code, running the installer, or copying the script to your local directory.
Command usage: python custom_tool_packager.py or pyton custom_tool_packager.py [-h|—help]
Command execution: python custom_tool_packager.py “{TOOL_DIRECTORY}” --append-version --verify-contents
Output: Alteryx tool installer named {TOOL_NAME}.yxi or {TOOL_NAME}_v_{VERSION}.yxi based on whether the —append-version was supplied.