Start

START executes the associated application and creates the mainWindow variable. The START command will auto-detect the application's title, class, and process name. All parameters are optional.

Syntax

START(string mainWindowTitle = null, string mainWindowClass = null, string processName = null, int timeout = 180, bool continueOnError = false);

Code Example

START(mainWindowTitle:"Untitled - Notepad", mainWindowClass:"Win32 Window:Notepad", processName:"notepad", timeout:10);

Stop

The STOP command terminates the associated application. The timeout parameter specifies the maximum amount of seconds an application can take to gracefully stop. After the timeout is reached, the application is closed forcefully.

Syntax

STOP(int timeout = 5);

Code Example

STOP(timeout:5);

StartTimer

The StartTimer function allows you to create a custom timer to measure the time one or more actions take within a script. The timers are reported back to the Login Enterprise server as measurements and can be used to trigger a notification if the measurement is over the configured threshold. Measurements are displayed in the Login Enterprise dashboard and charts. StartTimer must be stopped with either CancelTimer or StopTimer.

Syntax

StartTimer(string name);

Note: Timer name must only contain alphanumeric characters and underscore

Code Example

StartTimer(name:"Create_New_File");
StopTimer(name:"Create_New_File");

StopTimer

StopTimer is used to stop a timer that's started by StartTimer. The StopTimer name should be the same as the StartTimer.

Syntax

StopTimer(string name);

Note: Timer name must only contain alphanumeric characters and underscore

Code Example

StartTimer(name:"Save_File_To_Network");
StopTimer(name:"Save_File_To_Network");

CancelTimer

The CancelTimer command is used to cancel a timer. The CancelTimer name should be the same as the StartTimer.

Syntax

CancelTimer(string name);

Note: Timer name must only contain alphanumeric characters and underscore

Code Example

StartTimer(name:"Create_New_File");
CancelTimer(name:"Create_New_File");

SetTimer

Create your own custom timers with the SetTimer function. In many cases you could call an external value of a system resource like CPU % utilization and have it be visible in the Login Enterprise reporting.

SetTimer does not require a start and stop function as it collects an integer at the time it is executed.

Syntax

SetTimer("name", value);

Note: Timer name must only contain alphanumeric characters and underscore

Code Example

int myCounter = {some code that gets a Windows performance counter in milliseconds};
SetTimer(“MyTimer”,myCounter);

Wait

The Wait function will wait for an X amount of time in seconds before continuing with the script.

Syntax

Wait(double seconds);

Code Example

Wait(seconds:10, showOnScreen:true, onScreenText:"Waiting 10 seconds");

Log

The log function will log to console if you are using the scriptrunner. When using it as part of the Login Enterprise appliance, it logs to %temp%\LoginPI\Logs.

Syntax

Log(string message);
Log(object component);

Code Example

Log(message:"Log Message");

//

Log(component:MainWindow.GetTitle());

Abort

Abort is used to gracefully exit the script and throw an error message. The error will be shown as an 'Application failure' on the Login Enterprise dashboard, under events.

Syntax

ABORT(string error);

Code Example

ABORT(error:"An error occurred");

ShellExecute

Run a script or application in the Windows Shell

Syntax

ShellExecute(string commandLine, string workingFolder = "", bool waitForProcessEnd = true, int timeout = 180, bool forceKillOnExit = true);

Code Example

ShellExecute("mspaint", waitForProcessEnd: false, timeout: 15, forceKillOnExit: false);

Create Event

The CreateEvent function will generate a custom event on the Enterprise appliance which is shown in the results page of a Continuous, Load, and Application test.

Syntax

CreateEvent(title:"", description:"");

Code Example

CreateEvent(title:"Windows Update Available", description:"Update is available on hostname x");

Get Environment 

GetEnvironmentVariable is used as the name suggest to retrieve an environment variable. The GetEnvironmentVariable can be stored in a variable to use multiple times in your script. Note that if a continueOnError is not set and if you do not have permissions to retrieve the variable, the script will stop.

Syntax

GetEnvironmentVariable(variableName:"", continueOnError:false);

Code Example

var TempEnv = GetEnvironmentVariable("temp", continueOnError:true);

Log ($"The environment path = {TempEnv}");

Type ($"{TempEnv}");

Take Screenshot

The take screenshot command is used to create custom screenshots that are sent to the Login Enterprise appliance. This functionality can be used to verify visual output of an application. This will also work for your Application Testing. 

NOTE: The title can not handle spaces, these need to be underscores.

Syntax

TakeScreenshot(name:"", description:"");

Code Example

 TakeScreenshot(name:"Notepad",description: "Check if notepad has loaded the correct file");

FindWindow

FindWindow can be used to detect new windows or windows that have already been opened. Each window has a set of information: class, title, and process name. The ApplicationXRay tool can be used to detect the title, class, and process name of a window or control.

Syntax

FindWindow(string title = null, string className = null, string processName = null, int timeout = 30, bool continueOnError = false);

Code Example

var openDialogue = FindWindow(title:"Open", processName:"notepad", timeout:10);

Control Actions

When the engine finds the window or object, it can perform multiple actions on the window/object. Using the above example, the following window control actions are available:

FindControl

Each window has a set of controls (buttons, input fields, text fields, etc...). Using FindControl allows you to find and subsequently interact with these controls.

Syntax

FindControl(string className = null, string title = null, int timeout = 5, bool searchRecursively = true, bool continueOnError = false);

Code Example

MainWindow.FindControl(className : "Button:Button", title : "&Open").Click();

FindControlWithXPath

Each window has a set of controls (buttons, input fields, text fields, etc...). Using FindControlWithXPath allows you to find and subsequently interact with these controls.

Syntax

FindControlWithXPath(string xPath, int timeout = 5, bool continueOnError = false);

Code Example

MainWindow.FindControlWithXPath(xPath : "Button:Button").Click();

DumpHierarchy

Every window has a control tree with all classes and names. For troubleshooting purposes, we have a DumpHierarchy method. DumpHierarchy dumps the control tree to a text file.

Syntax

DumpHierarchy(string filePath, bool refreshBeforeDump = false);

Code Example

var Open = FindWindow(title:"Open");
Open.DumpHierarchy(filePath:"C:\\dump.txt");

Type

The Type command is used to type text or press keys.

Syntax

Type(string text, int cpm = 300, hideInLogging:true)

Variable options: 

• ApplicationPassword - using this variable you can enter an encrypted password for a specific application. More info found in the Login Enterprise - Application Password Encryption article. 
• ApplicationUser - using this variable you can enter an encrypted user for a specific application. More info found in the Login Enterprise application Password Encryption article.

Code Example

// use type to type text
Type("Insert Text Here");

// use type to press the enter key
Type("{ENTER}");

// use type to press the enter key twice
Type("{ENTER}".Repeat(2));

// use type to press ctrl + O
Type("{CTRL+O}");

// use type to enter a path. backslash is an escape character.
Type("C:\\Folder\\Folder1\\something.txt");

// use @ sign to type path
Type(@"C:\Folder\Folder1\something.txt");

// type quotes
// use backslash to escape quote e.g. \"
Type("\"test\""); // this will type "test"

// type quotes
// use @ in front of string and use double quotes
Type(@"""test"""); // this will type "test"

// typing to a window variable will keep the focus on that window
MainWindow.Type("Insert text here");

KeyDown(KeyCode.SHIFT); // Holds the SHIFT key
Type("insert non-capital text here"); // This text will be typed in uppercase
KeyUp(KeyCode.SHIFT); // Releases the SHIFT key
Type("insert non-capital text here"); // This text will be typed in lowercase

Click

The Click command is used to mouse click on an X Y coordinate.

Syntax

Click(double x, double y, bool continueOnError = false);

Code Example

Click(x:10, y:10);

RightClick

The RightClick command is used right click on an X Y coordinate.

Syntax

RightClick(double x, double y, bool continueOnError = false);

Code Example

RightClick(x:10, y:10);

DoubleClick

The DoubleClick command is used double click on an X Y coordinate.

Syntax

DoubleClick(double x, double y, bool continueOnError = false);

Code Example

DoubleClick(x:10, y:10);

MouseMove

The MouseMove command is used to move the mouse/cursor to a set of X Y coordinate.

Syntax

MouseMove(double x, double y, bool continueOnError = false);

Code Example

MouseMove(x:10, y:10);

MouseMoveBy

The MouseMoveBy command is used to move the mouse/cursor by a set of pixels relative to the current position.

Syntax

MouseMoveBy(double dx, double dy, bool continueOnError = false);

Code Example

MouseMoveBy(dx:10, dy:10);

MouseDown

The MouseDown command presses the left mouse button without letting go

Code Example

MouseDown();

MouseUp

The MouseUp command lets go of the left mouse button

Code Example

MouseUp();

KeyDown

The KeyDown command holds down a key

Code Example

KeyDown(KeyCode.SHIFT);
KeyUp(KeyCode.SHIFT);

KeyUp

The KeyUp command lets go of a key

Code Example

KeyDown(KeyCode.CTRL);
KeyUp(KeyCode.CTRL);

KeyCodes

Available KeyCodes

/// Control-break processing
CANCEL = 0x03,
BREAK = CANCEL,

/// BACKSPACE key
BACK = 0x08,
BACKSPACE = BACK,

/// TAB key
TAB = 0x09,

/// CLEAR key
CLEAR = 0x0C,

/// ENTER key
RETURN = 0x0D,
ENTER = RETURN,

/// SHIFT key
SHIFT = 0x10,

/// CTRL key
CONTROL = 0x11,
CTRL = CONTROL,

/// ALT key
ALT = 0x12,

/// PAUSE key
PAUSE = 0x13,

/// CAPS LOCK key
CAPITAL = 0x14,
CAPSLOCK = CAPITAL,

/// ESC key
ESCAPE = 0x1B,
ESC = ESCAPE,

/// SPACEBAR
SPACE = 0x20,

/// PAGE UP key
PRIOR = 0x21,
PAGEUP = PRIOR,

/// PAGE DOWN key
NEXT = 0x22,
PAGEDOWN = NEXT,

/// END key
END = 0x23,

/// HOME key
HOME = 0x24,

/// LEFT ARROW key
LEFT = 0x25,

/// UP ARROW key
UP = 0x26,

/// RIGHT ARROW key
RIGHT = 0x27,

/// DOWN ARROW key
DOWN = 0x28,

/// PRINT SCREEN key
SNAPSHOT = 0x2C,
PRINTSCREEN = SNAPSHOT,

/// INS key
INSERT = 0x2D,
INS = INSERT,

/// DEL key
DELETE = 0x2E,
DEL = DELETE,

/// 0 key
KEY_0 = 0x30,

/// 1 key
KEY_1 = 0x31,

/// 2 key
KEY_2 = 0x32,

/// 3 key
KEY_3 = 0x33,

/// 4 key
KEY_4 = 0x34,

/// 5 key
KEY_5 = 0x35,

/// 6 key
KEY_6 = 0x36,

/// 7 key
KEY_7 = 0x37,

/// 8 key
KEY_8 = 0x38,

/// 9 key
KEY_9 = 0x39,

/// A key
KEY_A = 0x41,

/// B key
KEY_B = 0x42,

/// C key
KEY_C = 0x43,

/// D key
KEY_D = 0x44,

/// E key
KEY_E = 0x45,

/// F key
KEY_F = 0x46,

/// G key
KEY_G = 0x47,

/// H key
KEY_H = 0x48,

/// I key
KEY_I = 0x49,

/// J key
KEY_J = 0x4A,

/// K key
KEY_K = 0x4B,

/// L key
KEY_L = 0x4C,

/// M key
KEY_M = 0x4D,

/// N key
KEY_N = 0x4E,

/// O key
KEY_O = 0x4F,

/// P key
KEY_P = 0x50,

/// Q key
KEY_Q = 0x51,

/// R key
KEY_R = 0x52,

/// S key
KEY_S = 0x53,

/// T key
KEY_T = 0x54,

/// U key
KEY_U = 0x55,

/// V key
KEY_V = 0x56,

/// W key
KEY_W = 0x57,

/// X key
KEY_X = 0x58,

/// Y key
KEY_Y = 0x59,

/// Z key
KEY_Z = 0x5A,

/// Left Windows key (Microsoft Natural keyboard)
LWIN = 0x5B,

/// Right Windows key (Natural keyboard)
RWIN = 0x5C,

/// Applications key (Natural keyboard)
APPS = 0x5D,
MENU = APPS,

/// Numeric keypad 0 key
NUMPAD0 = 0x60,

/// Numeric keypad 1 key
NUMPAD1 = 0x61,

/// Numeric keypad 2 key
NUMPAD2 = 0x62,

/// Numeric keypad 3 key
NUMPAD3 = 0x63,

/// Numeric keypad 4 key
NUMPAD4 = 0x64,

/// Numeric keypad 5 key
NUMPAD5 = 0x65,

/// Numeric keypad 6 key
NUMPAD6 = 0x66,

/// Numeric keypad 7 key
NUMPAD7 = 0x67,

/// Numeric keypad 8 key
NUMPAD8 = 0x68,

/// Numeric keypad 9 key
NUMPAD9 = 0x69,

/// Multiply key
MULTIPLY = 0x6A,
NUMPAD_MULTIPLY = MULTIPLY,

/// Add key
ADD = 0x6B,
PLUS = ADD,
NUMPAD_ADD = ADD,

/// Subtract key
SUBTRACT = 0x6D,
MINUS = SUBTRACT,
NUMPAD_SUBTRACT = SUBTRACT,

/// Decimal key
DECIMAL = 0x6E,
NUMPAD_DECIMAL = DECIMAL,

/// Divide key
DIVIDE = 0x6F,
NUMPAD_DIVIDE = DIVIDE,

/// F1 key
F1 = 0x70,

/// F2 key
F2 = 0x71,

/// F3 key
F3 = 0x72,

/// F4 key
F4 = 0x73,

/// F5 key
F5 = 0x74,

/// F6 key
F6 = 0x75,

/// F7 key
F7 = 0x76,

/// F8 key
F8 = 0x77,

/// F9 key
F9 = 0x78,

/// F10 key
F10 = 0x79,

/// F11 key
F11 = 0x7A,

/// F12 key
F12 = 0x7B,

/// NUM LOCK key
NUMLOCK = 0x90,

/// SCROLL LOCK key
SCROLL = 0x91,
SCROLL_LOCK = SCROLL,

/// Left SHIFT key
LSHIFT = 0xA0,

/// Right SHIFT key
RSHIFT = 0xA1,

/// Left CONTROL key
LCONTROL = 0xA2,
LCTRL = LCONTROL,

/// Right CONTROL key
RCONTROL = 0xA3,
RCTRL = RCONTROL,

/// Left MENU key
LMENU = 0xA4,
LALT = LMENU,

/// Right MENU key
RMENU = 0xA5,
RALT = RMENU,

/// Windows 2000/XP: Volume Mute key
VOLUME_MUTE = 0xAD,

/// Windows 2000/XP: Volume Down key
VOLUME_DOWN = 0xAE,

/// Windows 2000/XP: Volume Up key
VOLUME_UP = 0xAF,

Get Text

The GetText command (added in 4.3.x) will retrieve the text from an object, this can be a text field or button. This is best used to write to a variable and then use further in the script.

Syntax

MainWindow.FindWindow("","").GetText();

Code Example

var value = MainWindow.FindWindow("","").GetText();

CopyFile

The CopyFile command will copy a file from source to destination, overwriting the destination path.

Syntax

CopyFile(string sourcepath, string destinationPath, bool continueOnError, bool overwrite);

Code Example

CopyFile(sourcePath:"C:\\somefile.txt",destinationPath:"D:\\somefile.txt",continueOnError:false,overwrite:true)

CopyFile - download existing example files

With update 4.1 it's now possible to download known files from the appliance. This is part of the existing CopyFile command. These files can be found on the appliance under "/loginVSI/content/scriptcontent/" when using WINSCP to connect to the appliance.

Syntax

CopyFile(KnownFiles.FileType, string destinationPath, bool continueOnError, bool overwrite);

Code Example

CopyFile(KnownFiles.PdfFile, "C:\\Temp\\loginvsi.pdf",continueOnError:false,overwrite:true);

CopyFolder

The CopyFolder command will copy a folder from source to destination, overwriting the destination path.

Syntax

CopyFolder(string sourcepath, string destinationPath);

Code Example

CopyFolder(@"c:\testfolder", @"c:\temp\testfolder");
CopyFolder(string sourcepath, string destinationPath);

FileExists

Check if a file exists, can be used as a verification to check if the file was successfully copied

Syntax

FileExists(string path);

Code Example

FileExists("C:\\Temp\\loginvsi.pdf");

RemoveFile

The RemoveFile command will remove/delete the specified file. 

Syntax

RemoveFile(string path);

Code Example

# literal string path
RemoveFile(path: "c:\\testfolder\\some file.txt");

# verbatim string path
RemoveFile(@"c:\testfolder\some file.txt");

RemoveFolder

The RemoveFolder command will remove/delete the specified folder.

Syntax

RemoveFolder(string path);

Code Example

# literal string path
RemoveFolder(path: "c:\\temp\\testfolder");

# verbatim string path
RemoveFolder(@"c:\temp\testfolder");

DirectoryExists

The DirectoryExists function checks if a specified folder exists. Can be used after you created a folder or if you wish to verify if the folder exists before executing an action

Syntax

DirectoryExists(string path);

Code Example

DirectoryExists("C:\\Temp");

UnzipFile(string SourcePath, destinationFolder, continueOnError, overWrite);

UnzipFile(sourcePath:"C:\\Temp\\loginvsi.zip", destinationFolder:"C:\\temp\\loginvsiwebsite",continueOnError:false,overWrite:false); 

The RegImport command will import a registry file to the system registry.

Syntax

RegImport(string registryFile);

Code Example

# literal string path
RegImport(registryFile: "C:\\temp\\regfile.reg");

# verbatim string path
RegImport(@"C:\temp\regfile.reg");

StartBrowser

The StartBrowser command allows you to start a browser within an application script. Right now we only support Chrome80 and Edge42/44.

Syntax

StartBrowser(usInPrivateBrowsing, expectedURL, timeout, continueOnError);

Code Example

StartBrowser(useInPrivateBrowsing:false,expectedUrl:"https://www.loginvsi.com",timeout:30,continueOnError:true);

StopBrowser();

Syntax

Navigate(string url, string timerName);

Navigate(url: "https://loginvsi.com", timerName: "Website_LoginVSI");

FindWebComponentBySelector

The findWebComponentBySelector finds a web element based on the given CSS selector. You can attach existing control actions, to find them click here. You can also move your mouse to the component or ssearch your component by text.

Note: Make the search field as small as possible to eliminate long searches.

Syntax

FindWebComponentBySelector(string selector, int timeout, bool continueOnError);

Code Example

FindWebComponentBySelector(selector:"",timeout:30,continueOnError:false);

// It's also possible to type to the web element via
FindWebComponentBySelector(selector:"",timeout:30,continueOnError:false).Type("Example text");

// You can also send a Click to the found web element
FindWebComponentBySelector(selector:"",timeout:30,continueOnError:false).Click();

Sometimes the CSS selector appears multiple times within the webpage, this makes it hard to find the one you are looking for. To list the selectors you can use this command. The result can be used by findWebComponentBySelector. 

You can also move your mouse to the component. To find out more click here.

Syntax

FindAllWebComponentsBySelector(string selector, int timeout);

Code Example

FindAllWebComponentsBySelector(selector:"", timeout:30);

FindWindows

Find all windows by title, class, and process. If you specify multiple parameters, only the windows matching all criteria will be returned. The parameters do accept wildcards (*). This method will return whenever at minimum one window is found. If no window was found within the given timeout, it will return an empty array.

This method will return all windows that match the given criteria. This solves the issue where we cannot find a window if there are multiple matches for a set of criteria.

Syntax

FindWindows(title:"", classname:"", processname:"", timeout = 30);

Code Example

FindWindows(title:"*Untitled*", timeout: 5);

NativeWindowHandle

Returns the unique identifier of the window as it is known to the Windows OS. This solves the issue where we cannot uniquely identify any given window.

Syntax

IntPtr NativeWindowHandle;

Code Example

FindWindows(title:"*Untitled*", timeout: 5).NativeWindowHandle;

FromNativeWindowHandle

Constructs a scripting window object from a native window handle. This allows us to work with a window that was found by its handle using native technologies like win32 calls.

Syntax

IWindow FromNativeWindowHandle(IntPtr handle);

Code Example

FromNativeWindowHandle(Process.GetProcessbyName("explorer"));

SwitchTopMostWindow

Allows a window to stay on top rather than behind a newly opened window. It provides a better defense against popups overlapping your active window while running a workload.

Syntax

IWindow FromNativeWindowHandle(IntPtr handle);

Code Example

FindWindows(title: "*Untitled*", timeout:5).SwitchTopMostWindow(true);

NativeAutomationElement

This provides access to the underlying automation (UIAutomation) library the Login Enterprise Engine uses. It allows us to use low-level automation actions like manipulating checkboxes directly or setting the value of a text edit control in a more resilient way if typing doesn't work properly.

Syntax

IUIAutomationElement NativeAutomationElement;

Code Example

MainWindow.FindControl(classname:"*Document*").NativeAutomationElement;