isabella232 / ui-automation-samples

Alteryx GUI Automation Tools

A set of Alteryx Designer tools written using the Python SDK for the purpose of GUI (Graphical User Interface) automation. The tools provide a no-code solution to writing GUI Automated tests when used in conjunction with Alteryx Designer.

Note: These tools are not actively supported by Alteryx.

Requirements

Aleryx Designer 2018.2+

Setup

• Alteryx Designer must be installed. Versions 2018.1 and greater are recommended.
• Double-click a .yxi file in the YXI_Installers directory to install a tool. Alteryx Designer should handle the install.

Documentation

General

• Variable-value data stream paradigm
• Common Tool Options

Tool-Specific

        Note: Tool documentation can also be accessed via Alteryx by clicking the tool's help icon

• GUIClick
• GUIGetInfo
• GUIKeyboard
• GUIScreenshot
• GUIStartExe

Simple Example

In the Examples folder, there is an Alteryx workflow that uses a number of these tools to automate MS Notepad

Code

To access the source code for a tool, you can either: 1. Install the tools and open them at the location in which they were installed (usually C:\ProgramData or C:\Users\yourUsername\AppData\Roaming\Alteryx\Tools), or 2. Rename the .yxi file of the tool in question, replacing .yxi with .zip, and extract the zip file.

Option #1 is recommended as it will allow you to see changes you make to the tools in Alteryx immediately.