Tool Configuration File

Version:
2019.3
Last modified: March 27, 2020

Each plugin requires a configuration file, gui file, engine file, and tool icon. See Build Custom Tools.

The configuration file name must be the directory name with the suffix Config and the file extension .xml.

\bin\HtmlPlugins\MyNiftyPlugin\MyNiftyPluginConfig.xml

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.

Example XML

XML
  1. <AlteryxJavaScriptPlugin>
  2. 	<EngineSettings EngineDll="Macro" 
  3. 	EngineDllEntryPoint="MyNiftyPlugin\Supporting_Macros\MyNiftyMacro.yxmc" />
  4.  	<GuiSettings Html="JavaScriptCountEngine.html" 
  5. 	Help="www.example.com/JavaScriptCountGui.html" Icon="JavaScriptCountIcon.png">
  6. 		<InputConnection>
  7. 			<Connection Name="Input1" AllowMultiple="False" Optional="True" 
  8. 			Type="Connection" Label="I" />
  9. 		</InputConnection>
  10. 		<OutputConnection>
  11. 			Connection Name="Output" AllowMultiple="True" Optional="True" 
  12. 			Type="Connection" Label="O" />
  13. 		</OutputConnection>
  14. 	</GuiSettings>
  15. 	<Properties>
  16. 		<MetaInfo>
  17. 			<NameIsFileName value="false" />
  18. 			<Name>Hello World</Name>
  19. 			<Description>Designer wants to say hello!</Description>
  20. 			<RootToolName>HelloWorldMacro.yxmc</RootToolName>
  21. 			<ToolVersion>1.0.0</ToolVersion>
  22. 			<ToolInDb value="false" />
  23. 			<CategoryName>SDK Examples</CategoryName>
  24. 			<Author>Alteryx, Inc.</Author>
  25. 			<Company>Alteryx, Inc.</Company>
  26. 			<DescriptionLink actual="" display="" />
  27. 		</MetaInfo>
  28. 	</Properties>
  29. </AlteryxJavaScriptPlugin>

The file must contain the tag <AlteryxJavaScriptPlugin> with two children:

  • EngineSettings element: How the plugin interacts with the Designer engine.

    Attribute Required Settings
    EngineDll Yes

    Set to Macro if the back end is an existing macro.

    Set to the name of the plugin if using any other plugin's Dll.

    EngineDllEntryPoint Yes

    If EngineDll is set to Macro, set to the name of the macro file.

    Otherwise, set to the name of the function entry point in the corresponding engine plugin.

    The file must adhere to the Engine Plugin API.

    SdkVersion Yes Set to any valid version number, such as 10.1.
  • GuiSettings element: How the plugin interacts with the Designer GUI.

    Attribute Required Settings
    Help No

    Leave blank to reference HTML-<plugin_directory_name>. If the directory name contains spaces, the spaces will be removed when generating the file name. The directory name cannot contain :/?#[]@!$&'(,;=

    Set to the full URL for a custom help page.

    Html Yes Set to the name of the HTML5 file containing the GUI component of your plugin.
    Icon No Set to the name of a .png file containing your plugin's icon.
    SdkVersion Yes Set to any valid version number, such as 10.1.
  • OutputConnections element: Define parameters for output data streams.

    Attribute Required Settings
    Name Yes The name of the Input tab.
    AllowMultiple No Set to True to allow multiple connections on a tab.
    Optional No Set to True if the connection is optional.
    Type No Set to Connection.
    Label No Set to a single character to create a label for the input connection.
  • InputConnections element: Define parameters for incoming data streams.

    Attribute Required Settings
    Name Yes The name of the Input tab.
    AllowMultiple No Set to True to allow multiple connections on a tab.
    Optional No Set to True if the connection is optional.
    Type No Set to Connection.
    Label No Set to a single character to create a label for the input connection.

Build your own Tool Checklist

Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.