Quick Start with Custom Tools
Creating custom tools involves working with several SDKs. For this reason, we assume you are familiar with:
- Python, C++, or Alteryx Macros
- File management
To demonstrate the process of creating a new tool, we will use a Hello World example so you can meet Alteryx Designer. Download the complete example to follow along.
If your tool uses the Python SDK as its engine, the tool name, as defined in the <Name> tag of the configuration file, cannot contain spaces or special characters. For legibility, camel case is recommended.
- Create a workspace.
- Inside your workspace, create a folder with the name of your tool.
- Create an icon to represent the tool within Alteryx. Save the icon inside the tool folder.
- Save the GUI file inside the tool folder.
- Choose which back end you want to use for your tool.
Open Alteryx Designer and navigate to the Interface category. Use these tools to create the connection between the HTML interface and the macro. Ensure the workflow type is set to a macro. Download the Hello World macro engine example.
Save your macro in a \Supporting_Macro folder within your tool folder.
Save your Python engine file in the tool folder.
- C++: For information on how to use, see C++ SDK.
Save your C++ engine file in the tool folder.
- Create a tool configuration file. This file contains the information that Designer uses when installing the tool, such as the tool name and the category in the tool palette. It also contains the location of the files that comprise the tool engine and GUI. See Tool Configuration File.
- Save the tool configuration file in the tool folder.
- Create a package configuration file. This .xml file contains the information that displays in the installer, such as the tool name, the icon that will display, and what category to expect the tool to appear in once installed. See Package a Tool.
- Save the package configuration file at the same level as the tool folder.
- Package your files in a .yxi for distribution. The .yxi file installs your tool in Alteryx Designer. See Package a Tool.
- Zip the tool folder and the package configuration file into a zip folder.
- Rename the zip folder to have a .yxi extension.
Build your own Tool Checklist
- Create a folder with the name of your tool. See Build Custom Tools.
- Create icon and save it inside the tool folder. See Build Custom Tools.
- Create a GUI file and save it inside the folder. See HTML GUI SDK.
- Create your back end and save it inside the folder. See C++ SDK, Macro, and Python SDK.
- Create a configuration file and save it inside the folder. See Tool Configuration File.
- Create a package configuration file and save it with the folder. Package a Tool.
- Package the package configuration file and tool folder as a yxi. See Package a Tool.