Macro

A tool that uses the HTML GUI SDK for its interface component can use an Alteryx Designer macro for its engine component. To set up an existing macro as an engine component, connect data items to interface tools and match the names of the data stream connections to Macro Input and Macro Output tools.

Prerequisites

To create a macro back end for a custom tool, we assume you are familiar with:

Alteryx Macros
File management

See training videos or Alteryx Community for assistance with Alteryx Macros.

Set up files

In the directory of your tool, add a folder named /Supporting_Macros. This gives your tool access to the macro and prevents the macro from showing in the macro directories in Alteryx Designer.
Place an existing macro in the /Supporting_Macros folder.
In the Config.xml file, set the EngineSettings attribute EngineDllEntryPoint to the relative path to your macro. Set the attribute EngineDll to Macro.

<EngineSettings EngineDll="Macro" EngineDllEntryPoint="HtmlToolName\Supporting_Macros\MyMacro.yxmc" />

See Tool Configuration File.

Connect data items to interface tools

In your tool's config.xml file, set the name attribute of the data item.
In Alteryx Designer, click the corresponding interface tool. In the Configuration window, access the Annotation tab and change the tool name to match the name given to the data item. See Tool Configuration.
Verify that the terms match.

Use the XML View tab for the interface tool within the macro.
Check the connection name in the XML configuration file. See Getting Started with Developer.

Tool component	XML example
DataItem referenced in the HTML GUI page	<Value name="username"></Value>
Corresponding interface tool XML	<Name>username</Name>

Match data stream names

For each incoming or outgoing connection in your tool, your macro must have a corresponding Macro Input or Macro Output tool.

In your tool's config.xml file, set the name attribute of the connection.
In Alteryx Designer, click the corresponding Macro Input or Macro Output tool. In the Configuration window, access the Configuration tab and change the tool name to match the name given in the name property of the connection within your tool config.xml file. See Tool Configuration.
Verify that the terms match.

Use the XML View tab for the Macro Input or Output tool within the macro.
Check the connection name in the XML configuration file. See Getting Started with Developer.

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.