User Guide
Version v3.5.0

Editor: Interface Overview

Alyvix Editor lets you visually create, edit and run complex scripts allowing Alyvix to interact with your applications just like a human user would. Each script consists of multiple test case objects, organized as sequential, conditional and loop commands, along with Sections and Maps.

The Editor interface includes the Alyvix Selector and Designer modules as collapsible panels, which lets you easily inspect and choose test case objects to include when building your scripts.

To run Alyvix Editor from the command prompt, use the following command:

C:\Alyvix\testcases> alyvix_editor -f <alyvix-file-name>

This loads the Editor interface, whose layout has the following elements:

Alyvix Editor with Designer and Selector.
  1. The Editor panel, consisting of the Script Management panel (left) and the Scripting panel (right)

  2. The Selector pane, containing test case objects that can be added to the Scripting panel

  3. The Designer pane, which shows the details of the currently selected test case object

Editor-Specific Features

The principle interface elements specific to Alyvix Editor are:

The Alyvix Editor interface.
  1. The test case menu (described below), containing actions for Alyvix Editor and the current test case

  2. The main Script Management panel, used to select the principal scripts to be edited

  3. The Sections list, containing user-defined scripts (sections ) that can be used as subroutines within any of the principal scripts

  4. The Maps list, containing user-defined maps (consisting of keys and one or more values for each key) that can be used either by a script via looping, or to insert values in a String field.

  5. The scripting mode selector, containing the Script tab to display the currently selected script or map, the Monitor tab to show the screen capture of Selector’s current test case object, and the Console tab to show the output along with any potential failure causes after running the test case script from within Alyvix Editor

  6. The scripting panel, containing individual scripting nodes and the logic connecting them

  7. The script properties and actions that work both for single nodes and subsets of nodes, where you can enable, disable, run, or remove the scripted elements that have been placed in the scripting panel

  8. Panel resizing controls, allowing you to resize, minimize, or restore the three peripheral panels

The Test Case Menu

The following actions are available from Editor’s menu:

  • runblue — Run the current script displayed in the scripting panel (see below)

  • New — Throw away the current test case, replacing it with an empty one

  • Open — Replace the current test case with a new one chosen from the file dialog

  • Save — Save the current test case with its existing filename, overwriting the previous version

  • Save As — Create a copy of the current test case under a new file name

  • Exit — Close Alyvix Editor

The Monitor Tab

When you just need to quickly look at the positions of components in a test case object without making any changes, the fastest way isn’t to return to editing the test case object in Designer. Instead you can use the monitor tab to see the screen capture for the currently selected test case object.

An example Monitor tab screenshot

The monitor tab displays a read-only, full-size, instantly available copy of the screen grab for the test case object currently opened in the Designer panel.

Launching Alyvix Robot from Alyvix Editor

The script of the currently loaded test case can be run directly in Editor by pressing the runblue button at the top left. The default starting point is the MAIN script in the script management panel (you can use the debugging methods available in Alyvix Editor to change this starting point).

When run, Editor will be minimized until the scripted interaction has completed, after which the Editor window will return, and the output will appear in the Console tab at the top of the scripting panel:

The results of running the script in Alyvix Editor

The structure of the output is the same regardless of whether the test case is started in Editor or run in the command prompt. The effect of the Break and Measure flags are described in detail in the Test Execution section.

In addition, if a failure was caused by a simple sequential scripting node, then the annotated screenshot describing the failure will be displayed below the output in the Console tab:

A matching error displayed in the console tab

The annotation indicates the position, size and group of the first component that could not be matched during execution. In the PowerPoint example shown above, the Paste icon was marked as a subselection in the first group without an enlarged region of interest, so reducing the window horizontally means the Paste icon no longer fell within that region. The exclamation mark inside the red square representing the color of the first group indicates where Alyvix expected to find the Paste icon.


Note that currently arguments such as a private key and the verbosity level for Alyvix Robot cannot be set within Editor.