Skip to main content

Tool Configuration

You can configure tools in the Configuration window. When you add a tool to a Designer workflow, the Configuration window displays the relevant configuration options for that tool.

Configuration

Select the gear icon to access and use the Configuration properties tab. Here, you can set up the specific function of each tool. The properties vary depending on the tool. For a detailed description of how to configure each tool, go to Tools and select the tool you're working with.

XML View

Use the < > icon to display 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 > General and select Display XML in Properties Window.

Navigation

Use the arrow icon to display 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 active in the Tool Configuration window.

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

Tools with multiple outputs include the Filter tool, Join tool, Unique tool, Find Nearest tool, and Spatial Match tool.

Annotation

The Annotation area allows you to add notes to the project, for later reference. With your tool selected on the canvas, use the F2 key on your keyboard to access the tool's Annotation window.

  • Type: Displays the tool being used.

  • ID: Tool IDs are assigned as you drop tools onto the canvas. Tool IDs persist. For example, if you delete the third tool in the workflow, the next tool ID is still 4. The order of the tool ID does not guarantee the order of execution. To see a tool's ID, use the Ctrl+F keyboard shortcut. This opens the Find and Replace window and shows all tools with their IDs.

  • Name: Defaults to tool name plus the tool ID, but you can enter any name of your choice.

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

    • Using Canvas Settings: The annotation populates automatically based on the configuration properties.

    • Always: The annotation is always visible in the document.

    • Never: The annotation is never visible in the document.

  • Place Annotation on the Top: The default position for annotations is beneath the tool. Select this box to place the annotation above 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 input file.

  • User added assets: Use the Add File(s) button to add assets.

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

Help

Use the question mark icon to open the Help page for the selected tool.

Set Configuration as Default

New in 2024.2

This tool configuration setting is available as of the 2024.2 release.

Modify your tool configuration and use this option to save your settings as the default going forward. The next time you use the tool, it will open with your custom configuration preloaded. This setting can greatly speed up your workflow development process and is a great option if you frequently configure tools to do the same tasks.

To set a tool default, configure your tool and select the Set Configuration as Default pencil icon at the bottom of the configuration window. Select Save as Default to save your configuration as the new tool default. Next time you drag this tool onto your workflow canvas, it will have your saved configuration by default.

To restore the tool default to the Alteryx system default, select the Set Configuration as Default pencil icon and select Restore System Default.

Formula Tool Default

To modify the default data type in the Formula tool, you must first add a new column and give it a name. In the Formula tool expression editor, select the Select Column dropdown and select + Add Column. Enter a column name and then use the Data type dropdown at the bottom of the expression editor to set your default data type for the new column.