Quick Reference: Eggplant Functional Commands
Command |
Behavior |
Takes a snapshot of the Viewer window |
|
Clicks the SUT mouse in a coordinate location, or in the first image parameter found |
|
CompareScreen | Checks for changes to a screen or portion of a screen. |
Opens a VNC or RDP connection with a SUT; makes it the active connection |
|
DeleteVaultValue | Deletes a string from a secure location |
Closes a connection with a SUT |
|
Double-clicks the SUT mouse in a coordinate location, or in the first image parameter found |
|
Clicks and holds the SUT mouse in the Hot Spot of the first location found |
|
Clicks and holds the SUT mouse in the first location, moves to subsequent locations, releasing the mouse button on the last location |
|
Moves the mouse to the given location and releases the mouse button |
|
GetVaultValue | Returns a string from a secure location |
Hides the Viewer window |
|
Draws a border around the given rectangle in the Viewer window |
|
Presses and holds keys on the SUT keyboard |
|
Releases keys that are held down on the SUT keyboard |
|
Launches a signed app (or Springboard) on an iOS device that you are connected to through the iOS Gateway |
|
Inserts a comment into a script’s Log file |
|
Inserts a comment into a script’s Log file in red text |
|
Inserts a comment into a script's log file and adds one to the success count for the script |
|
Inserts a comment into a script’s Log file in orange text |
|
Presses the SUT mouse button |
|
Releases the SUT mouse button |
|
Moves the SUT mouse to a coordinate location, or to the first image parameter found |
|
Moves the SUT mouse to each of the given coordinate locations and image parameters |
|
Pauses script execution; enters debug mode |
|
Redraws the image of the SUT in the Viewer window |
|
Right-clicks the SUT mouse in a coordinate location, or in the first image parameter found |
|
Runs a given script |
|
Runs a given script, generating a separate Log file for it |
|
Scrolls the SUT mouse wheel down a given number of increments |
|
Scrolls the SUT mouse wheel up a given number of increments |
|
Sends an e-mail from within a script |
|
Modifies a global property value |
|
Modifies multiple global property values |
|
Places text in the SUT clipboard |
|
SetVaultValue | Stores a specified string in a secure location |
Shows the Viewer window |
|
Starts recording a movie in the Viewer window |
|
Ends a movie that is recorded from within a script |
|
Turns screen captures before every command on and off |
|
Sends keystrokes to the SUT keyboard |
|
Unzip File | Uncompresses and extracts the contents of a .zip archive file |
Delays the next line of execution for the given length of time |
|
Delays execution of the next line until any one of the given images is found |
|
Delays execution of the next line until all given images are found |
|
Zip File, Zip Folder | Makes a compressed archive (a .zip file) of an existing file or folder |
Deprecated Commands
Commands in the following table are deprecated and no longer supported; if an updated command or method is available, it is noted in the description.
Command |
Behavior |
Ends the temporary suite availability of OpenSuite |
|
Makes a suite available to the running script; use The InitialSuites global property instead |
|
Defines the search area based on two pairs of screen coordinates that it takes as parameters. Instead, use the SearchRectangle Eggplant Functional Global Property. |