Skip to main content

HTML Developer Tools

The Alteryx HTML GUI SDK tools interface uses a Chromium Embedded Framework (CEF). CEF is a framework for embedding Chromium-based browsers in other applications. You can take advantage of the Chrome Developer Tools to debug the interface of your tool.

To enable Chrome Developer Tools, follow these steps:

Designer Versions 2021.1 and Newer

  1. Open Alteryx Designer and access the main menu.

  2. Select Options > Advanced Options > Show HTML Developer Tools.

The Alteryx HTML Developer Tools window automatically opens when you select a tool or window that uses the Chromium Embedded Framework.

Designer Versions Prior to 2021.1

Note

In previous versions, the process to enable developer tools involves additional steps. To enable Chrome Developer Tools...

  1. Enter regedit.exe in the command prompt, or search from the Start menu, to open the Registry Editor.

  2. Browse to HKEY_CURRENT_USER\Software\SRC\Alteryx.

  3. Right-click the folder, point to New, and select Key.

  4. Enter DebugGui.

  5. Right-click the default value and select Modify.

  6. Enter 1 in Value data and select OK.

  7. Restart Alteryx Designer.

  8. In the Designer main menu, select Debug and select Show CEF Developer Tools.

The Alteryx CEF DevTools window automatically opens when you select a tool or window that uses the Chromium Embedded Framework.

Adding this registry key allows for remote debugging on port 9222, allowing CEF to be debugged from any CEF or Chrome browser window. To access the CEF remotely, go to the localhost URL oriented to the debugging port number: http://localhost:9222

When port 9222 is enabled, the temp AlteryxEngine file DevToolsActivePort is created. This file is used by Chrome and CEF to track the number of instances of Dev tools in use.

In this section: