Build Workflows
A workflow consists of connected tools that perform different functions to process data. When you build a workflow, you add and connect tools. You also configure those tools and workflow properties. To build a new workflow select File > New Workflow.
Workflow connections move in a downstream direction, vertically or horizontally, based on the workflow layout you choose in the Workflow Configuration window.
Add or Remove Tools
To add a tool to a workflow, select any tool from the tool palette and drag it onto the workflow canvas, or right-click the workflow to access a menu to insert tools. Go to Tool Categories for more information.
To remove a tool from a workflow, select the tool, and use the Delete key on your keyboard.
Connect Tools
To connect tools in a workflow, drag a tool from the tool palette onto the canvas near the output anchor of another tool. You can also drag the output anchor from an existing tool to the tool you just added.
Connections go in through the left side (or top) of a tool and out through the right side (or bottom) of a tool. Some tools accept multiple inputs indicated by multiple input anchors. Some tools have optional inputs indicated by a gray input anchor. All tools with an output anchor can be output to multiple streams.
Select a tool to display the incoming and outgoing connector indicators. The connector input to a tool is green, and the connector output from a tool is blue.
Select the connection and use the Delete key on your keyboard or right-click and select Delete Connection. Downstream tools are not deleted.
Select the connection and use the Connection Configuration window to select the Wireless checkbox. Alternatively, right-click the connection on the canvas and select Make Connection Wireless. When wireless, the connection arrows are set to be invisible. Input and output anchors are marked with a wireless symbol to indicate a wireless connection. The color of the bars is indicative of how many connections are coming into or out of the anchor. One bar indicates one connection, 2 bars indicate 2 connections, and 3 bars indicate 3 or more connections.
Select the connection and use the Line section of the Connection Configuration window to change its color. Alternatively, select the connection on the canvas and right-click it to select Change Connection Color.
Please note that this is a workflow-level setting and it overrides your connection color settings in User Settings > Themes > Connection Settings. Custom connection colors don't work in Designer versions prior to 24.2 but will not break your workflows.
Right-click the connection and select Insert in Connection, then select a tool.
Drag a tool from the tool palette or anywhere on the canvas and hover over an existing connection.
Right-click the output anchor and select Insert After, then select a tool.
You can view a list of possible tool connections and make multiple connections at the same time. This is useful for connecting multiple data inputs to a single downstream tool.
To make multiple connections...
Select a tool on the canvas. If the tool accepts both an input and output, specifically select the input anchor or output anchor of the tool to determine the list of possible connections to or from that anchor.
Right-click the selected anchor and select View Possible Connections.
In the Possible Connections window, select one or more tools from the Output Connections list to connect to one or more tools from the Input Connections list.
Under Connection Type, select whether to make the connection Wired or Wireless.
Select Connect.
If you view possible connections for multiple selected tools, only valid connections from output to input anchors are shown.
Double-click any connection to view and modify its properties in the Configuration window:
Name: Enter a name for the connection.
Wireless: Select to set a connection to wireless.
Line: Select the "..."button to choose a custom color for the connection.
Fields: In the table, view data going through the connection.
For wireless connections, a wireless connection icon with colored bars indicates the number of connections coming into or out of an anchor:
1 bar equals 1 connection.
2 bars equals 2 connections.
3 bars equals 3 or more connections.
The connection becomes invisible unless the tool is selected.
Workflow Tab Right-Click Options
Select a workflow tab on the canvas to open it, then right-click the tab to display a menu with these options:
Close: Close the workflow.
Close All But This: Close all open workflows except this one.
Close All: Close all open workflows.
Duplicate: Create a duplicate of this workflow.
Designer can change path dependencies from relative to absolute. Go to Workflow Dependencies for more information.
Tool Right-Click Options
Select a tool on the canvas, then right-click to display a menu with these options:
Cut: Cut the selected tool from the canvas.
Copy: Copy the selected tool.
Delete: Delete the selected tool.
Zoom: Select to...
Zoom In
Zoom Normal: Cancel zoom.
Zoom Out
All: Zoom to fit all tools in the window.
Selected tools: Zoom to fit all selected tools in the window.
View Possible Connections: View a list of possible tool connections to or from a selected tool.
Add to New Container: Add the selected tools to a Container tool. For more information, go to Tool Container Tool.
Add to New Control Container: Add the selected tools to a Control Container tool. For more information, go to Control Container Tool.
Bring to Front: If tools are overlapping, send the selected tool to the front. This is useful for layering Comment boxes or ordering overlapping tool annotations. For more information, go to Comment Tool.
Send to Back: If tools are overlapping, send the selected tool to the back. This is useful for layering Comment boxes or ordering overlapping tool annotations. For more information, go to Comment Tool.
Toggle between Make Outgoing Connections Wired and Make Outgoing Connections Wireless to change how the connections display. Input and output anchors with a wireless connection display the wireless connection icon, which presents colored bars indicating the number of connections coming into or out of an anchor (connection becomes invisible unless the tool is selected):
1 bar equals 1 connection.
2 bars equals 2 connections.
3 bars equals 3 or more connections.
Convert to Macro: Convert all or part of your workflow to a macro. Go to Convert to Macro to read about important limitations and instructions.
Cache and Run Workflow: Runs the workflow and caches all data up to the selected tool.
To cache a tool...
Right-click the tool.
Select Cache and Run Workflow. Alteryx creates multiple cache points simultaneously. You can work with multiple cache points by holding down the Control key and clicking individual cache points.
Notes and Limitations:
Please note that not all tools can be cached:
The tool can have a maximum of 5 output anchors and it can't be part of a loop.
In-DB tools, Machine Learning tools, and Python tools can't be cached.
You can use multiple caches in a single workflow.
When you interact with a tool that has been cached, you can view the tool's configuration without clearing the cache. However, changing the tool's configuration releases the cached data.
Alteryx clears caches when you close the workflow.
Clear Cache: Remove a cache. To clear cache for a tool...
Right-click the tool.
Select Clear Cache. Alteryx clears multiple cache points simultaneously. To clear the cache on one or more tools individually, select the tool or tools, and then right-click to view the menu.
Convert to Macro Input: Convert a selected input tool to a Macro Input tool.
Insert After: Select a tool to insert after the selected tool. Go to Tool Categories for more information.
Add Browse After: Add a Browse tool after the selected tool. If the selected tool has multiple output anchors, an option to add a Browse tool to each output will be available.
Properties: Place the focus on the Configuration window for the selected tool.
Select 2 or more tools to see alignment options:
Align Horizontally: The selected tools align horizontally with the selected tool that was placed on the canvas first.
Align Vertically: The selected tools align vertically with the selected tool that was placed on the canvas first.
Select 3 or more tools to see distribution options:
Distribute Horizontally: The selected tools are arranged to have even space between them along the horizontal axis.
Distribute Vertically: The selected tools are arranged to have even space between them along the vertical axis.
Annotate a Workflow
Add annotations to individual tools in the tool Configuration window > Annotation, or add a Comment tool to the workflow. Refer to these resources for more information:
Canvas Options
Run Workflow: Run the workflow. You can also use Ctrl+R to run the workflow. The icon changes to Stop Workflow while the workflow is running.
Stop Workflow: Stop the workflow. You can also use Ctrl+R to stop the workflow.
Run As Analytic App: Run the analytic application.
Add Workflow to Schedule: Schedule workflows to run at specific times and frequencies.
Active Documents: Show open workflows, apps, or macros.
New Blank Workflow: Create a new workflow (.yxmd).
Zoom In: Increase the normal zoom by 3/2.
Zoom Out: Decrease the normal zoom by 2/3.
Copy and Paste
To control where an item pastes onto the canvas, select the item, copy it (Ctrl+C), select where you want to paste the item, and then paste it (Ctrl+V). Designer pastes the item at the same point as the cursor.
Save Files
Designer prompts you to save unsaved workflows when you have one or more unsaved workflows and you attempt to exit the application. Designer displays Save changes to the following workflows? and provides these options:
Save Selected: Select the workflows you want to save and then select Save Selected. Designer saves the selected workflows and closes. Any workflows you do not select are not saved.
Discard Changes: Select Discard Changes to discard all changes and exit without saving.
Cancel: Select Cancel to return to the canvas.