Main Menus
Windows and common actions can be accessed from the main menus.
File Menu
These options are specific to creating and working with workflows.
New Workflow (Ctrl+N): Creates a new workflow (*.yxmd).
Open Recent: Shows the most recently accessed and saved workflows.
Open Workflow: Open a previously created workflow.
- Browse: Open a workflow by browsing to the file location where the workflow was saved.
- My Company's Server: Open a workflow from your company's Server. If you have connected to your company's Server, the connection is listed by the connection name.
- Add New Server: Create a connection to your company's Server.
- Alteryx Platform: Open a workflow saved to your Alteryx Platform. If you have connected to Alteryx Platform, the connection is listed by the connection name. If you have not connected to Alteryx Platform, go to Options > Manage Alteryx Links and add a new Platform link.
- Open AutoRecovered Files: Opens a list of auto-recovered files. Open files are automatically saved at regular intervals. The auto-recovered interval is enabled by default and can be modified in User Settings. See User Settings.
Open Workflow Group: Opens multiple workflows that have been saved into a workflow group. See Open a Workflow Group from a File Directory.
Manage Connections: When Data Connection Manager (DCM) is enabled, go here to control the Data Sources and the Credentials to authenticate to the Data Sources.
Save (Ctrl+S): Saves the active workflow.
Save As: Saves the active workflow.
- Browse: Browses to a file loca tion and saves the workflow there.
- Alteryx Server: Save to existing Server connections.
- Add New Server: Provides the ability to create a connection to your company's Server and saves the workflow there.
- Alteryx Platform: Save the workflow to Alteryx Platform. If you have connected to Alteryx Platform, the connection is listed by the connection name. If you have not connected to Alteryx Platform, go to Options > Manage Alteryx Links and add a new Platform link.
Create Workflow Group: Save all open workflows, which previously were saved as individual workflows, as a workflow group. See Save Workflow Groups.
Print: Offers a preview of what the workflow will look like when printed .
Print Settings: Offers settings for printing a workflow.
Exit: Closes the Alteryx GUI.
Edit Menu
These options are common editing functions.
Undo (Ctrl+Z): Automatically undoes the last action. Actions are recorded historically, so you can undo up to 32 actions.
Redo (Ctrl+Y): Redoes an action that you just undid.
Cut (Ctrl+X): Deletes an object and copies it to the clipboard for immediate pasting.
Copy (Ctrl+C): Copies an object to the clipboard.
Paste (Ctrl+V): Pastes a copied object.
Delete (Del): Deletes the selected object.
Find (Ctrl+F): Opens or closes the Find tab of the Find and Replace window. More on the Find and Replace functionality below.
Replace (Ctrl+H): Opens or closes the Replace tab of the Find and Replace window. More on the Find and Replace functionality below.
Find and Replace
By default, the Find and Replace window lists the tools in your workflow, including the tool ID and Name. Select the tool you want to find from the list. The tool is indicated on the canvas and the tool's Configuration window is opened.
Find Tab
The Find and Replace window also allows you to search for keywords within your workflow. Via the Find tab...
- Use the Tool Filter section to refine your search results.
- In Search Location section, you can filter your search results by ID, Name, Column Names, Annotation, and Configuration.
- In Match section, you can indicate whether your search should be Case sensitive and whether you want to search for the Entire Phrase.
- Enter the text that you want to search for into the Find text field. The underlying XML of each tool's configuration is searched for the string of text that is entered. The search results identify and list the tools that contain the entered text.
- The search results are returned in the Matches window, showing where each value is found. The results include columns for ID, Name, Location, and Value.
- Select the column header to sort each column either ascending or descending.
- Use the Next and Previous to navigate all instances where matches exist.
- Select a specific row within the Matches section to indicate the corresponding item on the canvas.
Replace Tab
If you want to replace the text that you searched for in the Find tab, select the Replace tab.
Find and Replace Compatibility
While you can search within ID, Name, Type, Column Names, Annotation, and Configuration, you can only replace text within Name, Annotation, and Configuration locations.
Note that you cannot replace Annotations that are automatically generated by Designer.
To replace text, follow these steps:
- In the Replace field, enter the text that you want to use as a replacement for the text that you initially entered in the Find field.
- All instances of the found text appear in the Matches section. There are 2 options for replacing text:
- To replace a specific instance of the found text, select a row in the Matches section, and select the Replace button.
- To replace all instances of the found text, select the Replace All button.
- To undo a replace action, select Edit > Undo.
- Note that if an instance of text cannot be replaced, the Replace button is inactive.
View Menu
These windows can be opened or closed via this menu.
Tool Palette (Ctrl+Alt+T): Displays the tool palette underneath the menu. See User Interface.
Overview (Ctrl+Alt+V): Displays the Overview window docked in its last visible position. See Overview window.
Results (Ctrl+Alt+R): Displays the Results window docked in its last visible position. See Results window, Results Window.
Configuration (Ctrl+Alt+C): Displays the Configuration window docked in its last visible position. See Configuration window.
Interface Designer (Ctrl+Alt+D): Displays the Interface Designer window docked in its last visible position. See Interface Designer, Interface Designer Window.
Options Menu
These options provide access to workflow, scheduling, and license functionality, as well as user settings.
Run Workflow: Runs the workflow. Ctrl+R will also run the workflow. The icon changes to Stop Workflow while the workflow is running.
Schedule Workflow: Allows the user to schedule workflows to run at specific times and frequency. The Scheduler Service must be enabled as part of the Alteryx installation and the user must be licensed appropriately. The license should be installed by an Administrator to ensure all users are properly licensed and the service is properly configured. See Schedule Workflows.
View Schedules: Allows the user to schedule workflows and applications, see the jobs in queue, and view information about completed jobs. The Scheduler Service must be enabled as part of the Alteryx installation and the user must be licensed appropriately. The license should be installed by an Administrator to ensure all users are properly licensed and the service is properly configured. See Manage Schedules.
Run Analytic Apps: Opens the Choose Analytic App window that allows you to browse for apps and edit or run them. See Choose Analytic App
Export Workflow: Opens the Export Workflow window which allows the user to take the active workflow and zip it up with all of its dependencies into a *.yxzp file. See Workflow Management.
Manage Licenses: Allows the user to view, add, and delete their Alteryx licenses via the License Manager.
Manage Alteryx Links: Link Designer with the Alteryx Platform. To create a link...
-
Select Manage Alteryx Links.
-
Click the Add button.
-
Select Platform.
-
Enter your Platform URL and select the Link button. You will need to authenticate via your Platform Single Sign-On. Once you authenticate, the link to the Platform will be active over multiple sessions, but will expire. Once the authentication expires, you will need to re-authenticate.
Manage Connect Credentials: Opens the Connect Sign In window that allows you to access Connect. See Use Connect Assets.
Add Promote Connection: Opens the Promote Connection window that allows you to add connections to the Promote platform. To view all connections or delete a connection, access the Deploy Tool or Score Tool.
User Settings: Offers the ability to configure a workflow's appearance and to specify system resource usage to optimize the project's performance specific to the user. See User Settings.
- Edit User Settings: See User Settings.
- Save Layout & Settings on Exit: Saves the GUI layout and user specified settings upon exiting the program.
- Save Layout & Settings Now: Saves the GUI layout and user specified settings upon selecting this option.
- Restore Defaults: Returns the GUI layout to its original orientation.
Advanced Options
Compare Workflows: Compare 2 workflows and quickly identify the differences via visual indicators.
Lock Workflow: Saves a copy of a workflow so that it can be run, but cannot be opened and edited in Alteryx Designer. See Lock Your Workflow for instructions and additional information.
Manage Data Connections: Create and manage your data connections from a central location. View connections you created and connections shared with you, as well as add new connections. See Manage Data Connections.
Manage In-DB Connections: Create and manage your in-database connections from a central location. View existing in-database connections and add new in-database connections. See Manage In-DB Connections .
Show HTML Developer Tools: Automatically opens the Alteryx HTML Developer Tools window when you select a tool or window that uses the Chromium Embedded Framework.
System Settings: Offers the ability to specify system resource usage to optimize the application's performance. System Settings require Administrator privileges to change. See System Settings.
Workflow Dependencies: Controls the input and output paths associated with the workflow as well as specific datasets. See Workflow Dependencies.
Download Predictive Tools: The predictive tools use the R programming language. Go to Options > Download Predictive Tools and sign in to the Alteryx Downloads and Licenses portal to install R and the packages used by the R Tool.
Help Menu
These options provide quick access to help with Alteryx.
Alteryx Help: Opens Designer Help. You can also press the F1 key.
Tutorials: Opens tutorial workflows that provide an introduction to building workflows in Designer.
Sample Workflows: Opens the sample workflows that are available in Designer, including external installations such as Starter Kits. See Sample Workflows.
Sample Datasets: Opens the sample datasets that are available in Designer.
Community: Links to the Alteryx Community site where you will find access to our user forums, support questions, workflow exchange, FAQs and more.
What's New: Opens the What's New Help page for the current release version of Designer, highlighting the new features and enhancements since the last official release. See What's New.
Check for Updates: Designer checks to see if there is a newer version available than the current version. This feature requires an internet connection. See Version Updates.
Generate Support File: Generate a tech support file that contains information that helps our team properly troubleshoot your issue. The file includes Runtime Settings and your Serial Number (email address). You can upload this file when you submit your support case. Make sure to review the file contents and remove anything you might now want to include.
Alteryx Downloads: Opens the Alteryx Downloads and Licenses portal where you can download the latest version of the software.
About: Open a dialog box with the Designer version information and the unique serial number for the license.
Privacy Policy: Access the Privacy Policy.
End User License Agreement: Access the End User License Agreement.
Localization Menu (Globe Icon)
Select the language version for Designer. Your options include...
English
简体中文 (Simplified Chinese)
Français (French)
Deutsch (German)
Italiano (Italian)
日本語 (Japanese)
Português (Portuguese)
Español (Spanish)
The Localization menu also provides quick access to the Localization User Settings.