Skip to main content

User Settings

2024.1 Updates to User Settings

For the 2024.1 release, we've redesigned the Designer User Settings. The redesign simplifies the user experience via a modernized UI and more intuitive tab groupings.

If you haven't upgraded to the 2024.1 version of Designer, you can access the help content for the previous versions via the Select Version menu in the upper right of this page.

The User Settings window contains options to help you configure workflow appearance and system resource usage to optimize performance. You can access User Settings in Designer's main menu via Options > User Settings > Edit User Settings.

You can configure system resource usage in 3 different areas:

Settings configured in User Settings generally override settings in System Settings, and settings in Workflow Configuration override settings in User Settings and System Settings. System settings might prevent a user from overriding the memory limit and the default number of processing threads. If so, the user settings and workflow configuration only have the option to decrease them.

To edit user settings, navigate the tabs and edit settings, then select Save.

Note

Certain Designer processes might save your data to disk as temporary files in your designated temporary directory. In the event of an unexpected interruption or termination of the processes, temporary files might not be automatically deleted. We recommend that you occasionally check your temporary directory to remove any files that might not have been automatically deleted.

To determine the location of your temporary files, refer to the General section below. Alternatively, use the System Settings or Workflow Configuration (Runtime tab).

General

Use the General tab to configure Designer default runtime settings, override system settings, and override DCM settings.

  • Undo Levels: Set the number of actions Alteryx remembers and allows you to undo. The default value is 10. Note that an increase in this value negatively impacts performance.

  • Disable Auto Configure: Select this option to manually configure tools in a workflow. With this option selected, use the F5 keyboard key to manually refresh tool configurations. This option can optimize performance.

  • Display XML in Properties Window: Select to view the XML of the configuration for each tool in a workflow.

  • Display Asset Management in Properties Window: Select to view the file dependencies or assets for each tool in a workflow.

  • Show Start Here at Startup: Select to display the Start Here tab on the canvas when Designer starts. Start Here displays a helpful set of starter samples.

  • Autorecovery: Alteryx automatically recovers at least 1 of the files being processed in a workflow. Go to File > Open workflow > Open Autorecovered Files.

    • Interval in Minutes: Enter a value or use the up and down arrows to set the time (in minutes) Alteryx waits before it automatically saves a file. The default is 10.

    • Per File: Enter a value or use the up and down arrows to set the number of backup files that Alteryx creates. Once the limit is reached, the oldest file is deleted when a new backup file is created. The default is 3.

    • Days to Keep: Enter a value or use the up and down arrows to set the number of days to keep auto-saved files.

  • Override System Settings: Select to configure settings different from settings configured in System Settings.

    • Memory Limit: Define the maximum amount of memory the engine uses (in MB) to perform operations in a workflow. Generally, this value shouldn't be changed. For more information on how Designer uses memory, go to Memory Use.

    • Default Temporary Directory: Displays the path to the location where temporary files used in workflow processing are saved. Each workflow run uses a new subdirectory under this configured directory to hold temporary files. Use the 3-dot menu to change the location.

    • Default Workflow Template Directory: Displays the path to the location where your templates are saved. The default location is C:\Users\[USER]\AppData\Local\Alteryx\Templates. Use the 3-dot menu to change the location (this can be a shared network drive or a local directory). To learn more about Designer templates, go to Templates.

    • Logging Directory (blank for no logging): Displays the path to the location where output logs produced during workflow processing are saved. Use the 3-dot menu to set or change the location.

    • Run Designer x64 at a Lower Priority: Select to run other memory-intensive applications at the same time as Designer. This setting affects workflow processing speeds.

    • Automatically Send Crash Report to Alteryx: Alteryx uses automated crash reporting to collect debug information from Engine runs. Alteryx uses this information to analyze issues and make improvements to the product. Go to Automated Crash Reporting for details.

  • Override DCM Settings: Select to configure DCM settings different from settings configured in System Settings. You can change the DCM Mode and choose the SDK Access Mode. For more information, go to DCM.

    • DCM Mode: Select from these options:

      • DCM Optional: Connections (including passwords) are stored in a workflow by default. You can choose to store and manage connections in DCM.

      • DCM as Default : Connections (including passwords) are stored and managed in DCM by default. You can choose to store them in a workflow.

      • DCM Only: You can't configure connections in a workflow. You can only select connections stored in DCM. Workflows with embedded passwords can run.

      • DCM Enforced: Workflows with embedded passwords don't work.

    • SDK Access Mode: Select from these options:

      • Deny: SDK tools are not supported, and the Allow Credential for SDK tools check box is not displayed in the credential UI.

      • Allow: SDK tools are supported, and the Allow Credential for SDK tools check box is displayed in the UI with the option for manual selection of each credential.

      • AllowAll: SDK tools are supported, and the Allow Credential for SDK tools check box is not displayed in the credential UI.

  • Override Tool Results Settings: Select to override tool results settings. These settings control the size of the data that is displayed in the Results window for each output anchor in a workflow.

    Memory Limit per Anchor: Select to set a memory limit per anchor. Then, enter a value or click to set the memory limit value in KB. The default value is 1024 KB (1 MB).

Workflows

Use the Workflows tab to configure workflow behavior, AMP settings, as well as your workflow layout preferences.

  • Open Files as New Workflow Tab in Same Window: When selected, these Alteryx file types (YXMD, YXMC, YXWZ, YXWG, YXZP, and YXI) open as a new workflow tab when you double-click them.

  • Allow Multiple Tabs of Same File to be Open: Select this option if you need to open the same workflow in multiple tabs in Designer.

  • Collect and Display Data Profile Information: Select to enable data profiling in the Browse tool. Deselect to disable data profiling features. If disabled, the Browse tool does not show data profile information. This does not improve runtime performance.

  • AMP: Configure Alteryx Multi-threaded Processing (AMP).

    • Use AMP Engine for All New Workflows: Select to use the AMP Engine for all new workflows that you create going forward.

    • Automatically Enable Engine Compatibility Mode with AMP Engine Enablement: Select to automatically turn on Engine Compatibility Mode when AMP engine is on. This setting applies to all newly created workflows as well as existing workflows where you turn on AMP engine going forward.Engine Compatibility Mode

  • Display: Configure workflow canvas display settings.

    • Zoom Level: Select the zoom level at which to display the workflow.

    • Remember Last Zoom Level per Workflow: Select to remember the last zoom level used for the previous workflow. The zoom level is determined by the zoom level at which the workflow was last saved.

    • Layout Default: Select a Vertical or Horizontal orientation for workflows on the canvas.

Tools

Use the Tools tab to set dataset defaults and configure your macro repository.

  • Display Macro Indicator on Tools: Select to show the "+" icon on any tool that is a macro. Right-click a macro tool to open its source workflow.

  • Dataset Defaults: Set your default datasets for all tools that require an installed dataset. When the tool uses a dataset, the dataset you set as default is used. If you haven't installed a dataset, you won't have the option to select.

  • Macros: Create a repository of macros and set a default location to save macros. Alteryx displays the macros in the Tool Palette for you to use when you build workflows. Each macro must have a unique name. To create a path to the repository, follow these steps:

    1. Select the "+" icon to open the Add Search Path for Macros window.

    2. Use the Category Name field to enter a name. The default name is "Macros".

    3. In the Search Path field, select the Browse button to browse to the location where you save macros on your computer or a network. Any macro YXMC file in the selected location displays in the tool category on the Tool Palette. You can't add Subfolders in a search path individually if their parent folder already exists in the Macros repository.

    4. To set a default repository location, select the repository search path in the list and then select Set as Default. An asterisk (*) displays next to the default repository.

Themes

Use the Themes tab to customize your Designer theme, as well as the canvas, connection, and annotation appearance.

  • Designer Theme: Choose Light Mode or Dark Mode (BETA).

    • Light Mode: This is the default Designer theme.

    • Dark Mode (BETA): This is the new Dark Mode theme available as of the 2023.1 release. Please note that the initial release of Dark Mode is a Beta release. This means that only certain Designer interface components are Dark Mode compatible. Additionally, you might see certain components (including many tool configurations) that are currently only partially converted to Dark Mode. We will continue to include additional elements for Dark Mode in future releases.

  • Default Canvas Settings: Adjust your Default Canvas Settings to change how the canvas workspace appears. For more information, go to Workflow Configuration.

    • Background: Select the "..." button to choose the color of the canvas on which workflows are created.

    • Containers: Select the "..." button to choose the default color for the Tool Container tool.

    • Show Grid: Select to display a grid over the canvas.

      • Grid Color: Select the "..." button to choose the grid color.

      • Grid Size (px): Enter or click to set the width of boxes in the grid. The size is defined in pixels.

    • Snap Tools to Grid: Select to place tools and annotations so they align to the canvas grid.

  • Connection Settings: Adjust your Connection Settings to change how connections between tools appear and behave. For more information, go to Connection Configuration.

    • Type: Select the type of connection.

      • Auto Route Perpendicular: Draws connections with perpendicular bends.

      • Auto Route Bezier: (Default) Draws connections with curves.

      • Straight: Draws connections with straight lines.

    • Progress: Select when to show the progress of workflow processing. Progress displays the record count and the total record size of data passing through each connection, and the line width adjusts to the data passing through it.

    • Text Color: Customize the color of the input string number associated with the connection.

    • Lines: Select the "..." button to choose the color of the connection line.

  • Annotation Settings: Adjust your Annotation Settings to change how the tool configuration label displays on the canvas. For more information, go to Tool Configuration.

    • Text Color: Select the "..." button to choose text color.

    • Font: Select the "..." button to choose the font, font size, and font style.

    • Background: Select the "..." button to choose the annotation background color.

Proxy

Use the Proxy tab to enable and configure a proxy to access the internet.

You must manually configure a proxy in order to use this setting.

To set up a proxy, go to Network and Internet settings on your computer, or Internet Options in Internet Explorer. In Internet Explorer Internet Options, select the Connections tab, select LAN Settings and deselect Automatically Detect Settings, then select Proxy Server.

SFTP over HTTP proxy is supported for both AMP and the original Engine, as is the ability to bypass proxy. AMP supports networking via proxy. You can specify the Proxy Protocol Type (HTTP and SOCKS5h), the default is HTTP.

After you set up a proxy, select Enable Proxy Credentials and select Configure. Once configured, Designer will Autodetect proxy in use.

  • Enable Proxy Credentials: Select to use a proxy to access the internet instead of directly connecting to an internet host. These tools and connections work with a proxy:

    • Download Tool

    • Amazon Redshift Bulk Loader

    • Amazon S3 Upload Tool

    • Amazon S3 Download Tool

    • HDFS connections via the Input Data, Output Data, Data Stream In, and Write Data In-DB tools.

  • Autodetect proxy in use: After you set up a proxy, select Enable Proxy Credentials and select Configure to open the Proxy Settings window.

    1. Select the Proxy Protocol Type: HTTPSOCKS5h

    2. Select Proxy requires password.

    3. Enter the credentials in Username and Password.

    4. Select OK.

Admins can configure a proxy in System Settings. Go to Options > Advanced Options > System Settings > Engine > Proxy.

Language and Region

Use the Language and Region tab to configure internationalization and localization settings, including language and measurement conversion.

  • Interface Language: Select the language version for Designer. Choose from English, 简体中文 (Simplified Chinese), Français(French), Deutsch (German), Italiano (Italian), 日本語 (Japanese), Português (Portuguese), and Español (Spanish).

  • Tool Palette Order: Sort your tool palette to follow either Current Language Alphabetical or English Alphabetical order, even if you're running in a non-EN user interface. We don't yet support the sorting of Kanji characters.

  • Sort Method: Set the sorting method that Designer uses. This setting affects the sorting method of the Results window, Sort tool, Select tool, and other tools that use the Select functionality. This sort method doesn't affect the Tool Palette. Options include...

    • Unicode Code Point: Sort by Unicode code point.

    • Gojūon: Sort by Japanese pronunciation (Gojūon) dictionary order. Default selection for the Japanese language.

    • Pinyin: Sort by Simplified Chinese pronunciation (Pinyin) dictionary order. Default selection for the Simplified Chinese language.

    • Dictionary Order: Sort by dictionary order. Note that this is the default selection for English, French, German, Italian, Portuguese, and Spanish languages.

  • Format: Use this section to set the format for distances, dates, and numbers.

    • Default Distance Units: Select the default units for measuring distance. Spatial tools use the selected unit of measure.

    • Date Format (Messages): Choose how you want to display dates in the Messages tab of the Results window. Your options are:

      • mm/dd/yyyy (Default for English)

      • yyyy/mm/dd (Default for Japanese)

      • dd/mm/yyyy (Default for French, Italian, Portuguese, and Spanish)

      • dd.mm.yyyy (Default for German)

    • Thousand Separator*: Choose the thousand separator symbol that you want to use to display numbers in Designer. Choose from None, , (Comma), . (Period), ' (Apostrophe), and Space.

    • Decimal Symbol*: Choose the symbol to use as the decimal separator: Period or Comma.

    Number Formatting Settings

    There are 2 settings that you can customize to change how numbers display in Designer: Thousand Separator and Decimal Symbol.

    The settings don't affect the data types themselves, only how they display. This applies to all numeric values, except data in the Results grid. These settings affect how numbers display on the Designer canvas, the Results window, and the Browse tool Data Profiling. The default settings depend on the language that you select for the Designer interface, but you can always update the defaults.

    Example: As you update the Thousand Separator and Decimal Symbol settings, the Example field shows a preview of how your changes will be applied when you save.

  • Advanced: Use this section to set the system font and configure code pages.

    • Default System Font: Select the default font used by Designer.

    • Code Page: Select the code page to use in encoding your toolset in Designer. Go to Code Pages for more information.

    • Default Predictive Tools Code Page: Select the code page to use in encoding your Predictive tools in Designer.

      • This setting applies to all new workflows that you create in Designer.

      • This setting does not apply to any workflows created by another user that you open in your Designer.

      • You can customize the code page for a specific workflow via the Workflow Configuration Runtime tab. Go to Code Pages for more information.

  • Help: Use these options to customize your help settings:

    • Source: Select the source of help. By default, Auto-Detect displays online help when the Internet is available and displays offline help when the Internet is not available.

    • Language: Select the online help language.

Notifications

Use the Notifications tab to enable or disable audio and visual notifications while you work in Designer.

  • Show Dialog at Workflow Completion: Select to show a notification when a workflow finishes running. The workflow status is always displayed in the Results window.

  • Play Sound at Workflow Completion: Select to play a sound when a workflow finishes running.

In this section: