Tool Configuration

Version:
2019.3
Last modified: September 26, 2019

Tools are configured in the Configuration window. When a tool is added to an Alteryx workflow, the Configuration window displays the relevant configuration options for that tool.

Configuration

Configuration icon Use the Configuration Properties to set up the specific function of each tool. The properties here vary depending on the tool chosen.

For a detailed description on how to configure each tool, see Tool Categories.

XML View

Displays the XML for each tool's configuration as a reference.

To display this option in the Configuration window, go to Options > User Settings > Edit User Settings > Advanced and select Display XML in Properties Window.

Navigation

Display all connections icon Displays all the connections and incoming and outgoing tools connected to the selected tool.

You can double-click on the connected tool name to jump to it on the canvas. The Navigation view of the tool you jumped to will be the active in the Tool Configuration window.

Check the Wireless box Wireless icon to make the connection arrow that connects the selected tools wireless.

Tools with multiple outputs include the Filter ToolJoin ToolUnique ToolFind Nearest Tool, and Spatial Match Tool.

Annotation

Annotation tab icon The Annotation area allows you to add notes to the project, to refer to later.

Tool: displays the tool being used.

ID is indicative of how many tools have been brought into the session, regardless if they still appear in the project. If you were to delete the third tool in the stream, the next tool would be ID 4, etc.

Name: Defaults to tool name  + ID, but you can enter in any name of the choice.

Show Annotation: Some tools have a default Annotation, some do not.

  1. Using Canvas Settings: The annotation populates automatically based on the configuration properties
  2. Always: The annotation is always visible in the document.
  3. Never: The annotation is never visible in the document.

Place Annotation on the Top: The default position for annotations is beneath the tool. Check this box to force the placement of the annotation to above of the tool.

Annotation: Enter the text you wish to see associated with the tool in the document.

Tool annotations appear when the mouse hovers over the tool.

Assets

Assets, also known as dependencies, are files that are necessary for the tool to perform correctly.

Auto-detected assets: In the case of an input tool, an auto-detected asset is the file chosen as the input.

User-added assets: Use Add File(s) to add assets.

To display this option in the Configuration window, go to Options > User Settings > Edit User Settings > Advanced and select Display Asset Management in Properties Window.

Help

Help icon Opens the Help page for the selected tool.

Was This Helpful?

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