Quick Reference: Property Lists

The following tables list SenseTalk properties that you can use with common Eggplant Functional commands.

CaptureScreen Properties




An image property list


Whether to append an automatically incremented number to the image; true or false


An image file name and optional path information, in quotation marks

Rectangle (or Rect)

A coordinate pair indicating the top left and bottom right corners of a rectangle to capture.

For information about using CaptureScreen, see CaptureScreen Command.

Connection Properties




Whether or not the SUT was found via Bonjour or zerconf


The color depth of the SUT in the Viewer window: 8, 16, 32


Whether or not Eggplant Functional is currently connected to the SUT


The display name of the SUT


Password of the SUT's VNC server


Port number used by the SUT VNC server


Whether or not the connection is a reverse connection (i.e., initiated by the SUT)


The width and height of the SUT screen

ServerID (required)

SUT host name, IP address, or display name


Host name or IP address of an SSH host


Password of the user account on the SSH host computer


User account on the SSH host computer

Type The method to use to connect to the SUT. Possible values are RDP, VNC, or screenshot


Whether or not the Viewer window opens upon connection

For information about using the Connect command, see Connect Command. For general information about connections, see Creating Connections to SUTs.

Image Properties




The date of image capture, including the time


The SUT from which the image was captured


Screen coordinates of the image when it was captured. (This value cannot be changed.)


Screen size of the SUT in pixels at time of image capture, given as (width,height)

Characters Refers to image names from a character collection. See Image Searches Using a Character Collection for more information.


Coordinates that define a rectangle within the image; any pixels outside the cliprectangle are disregarded for image matching


The percentage or absolute number of pixels that may differ between an image and a match in the Viewer window. The percentage of pixels (with a percent sign) or number of pixels (with no percent sign) by which the image and a match in the Viewer window can differ.

Note: Discrepancy can be slow to use and can result in false positive matches. Preferable approaches include setting the Search Type to Smoothed for Text in the Image Update panel, cropping the image using the Image Editor, or creating an Image Collection that includes several acceptable versions of a basic image. You can also capture a new image if the current image can only be found using a discrepancy search.


Coordinates of the hot spot within the image, relative to the top-left corner of the image


The images description in the Suite Editor Images pane. (This value cannot be changed.)


Name of the image file. (File extension is not used.)


File path of the image file. (This value cannot be changed.)


Width and height in pixels. (This value cannot be changed.)


The acceptable difference between color values in an image and a match in the Viewer window


Whether the search type allows for pulsing; true or false


A degree of rotation (or list or range of degrees) that the image should be found at, if you expect an image to appear at a different angle than was originally captured. Rotation is clockwise


The scale factor at which the image is to be found (or was found, as in the case of foundimageinfo()). For more information, see Scaling Images.


Coordinates that define a rectangle in the Viewer window. Eggplant Functional only looks for this image within the defined rectangle


The search type to be used; Tolerant of Background (Tolerant), Smoothed for Text (Smoothed), Adaptive to Image (Adaptive), Precise to Pixel (Precise), Pulsing to Element (Pulsing), or Smooth and Pulsing.


The maximum time Eggplant Functional waits for the given image to appear on the SUT

For information about using image properties, see:

ReadCharacters Function Properties

Key Description
asList When asList is on (asList:Yes), the ReadCharacters function returns a list of strings, one for each group of recognized characters.
characterPriority This string contains priority characters, in high-to-low order. The default setting is ";:.". This setting controls which character is recognized if two character images are found in the same location. For example, using characterPriority:"OC" gives the "O" character image a higher priority than the "C"character image. The result is that the ReadCharacters function uses the letter "O" rather than the letter "C" if both the O and C images are found at the same location on the screen.
minimumVerticalOverlap This value sets the minimum overlap, in pixels, allowed for two characters to be considered to be on the same line. If the two characters overlap more than the minimumVerticalOverlap value, the ReadCharacters function considers these characters to reside on the same line.
maximumHorizontalOverlap This value sets the maximum overlap, in pixels, allowed for adjacent characters to be considered as occupying the same space. If two adjacent characters overlap more than this setting, the ReadCharacters function considers these characters to be occupying the same space.
maximumAdjacentGap This value sets the maximum gap, in pixels, allowed between two adjacent characters. This setting assumes no space between characters. If two adjacent characters reside further apart than this setting, the ReadCharacters function considers these characters to be non-adjacent characters.
maximumSpaceGap This value sets the maximum gap, in pixels, for an implied space to exist between two characters. If two characters reside closer together than this setting, the ReadCharacters function does not consider these characters to be separated by a space.
spaceWidth This value sets the nominal width, in pixels, of a space character. The ReadCharacters function uses this setting to determine the number of spaces returned for wide space gaps.

For information about using the ReadCharacters function properties, see the ReadCharacters Function. The ReadCharacters function is an image search function, so it also supports the properties shown in Image Properties.

ScriptResults Properties




The length of time the script ran (or has been running) given in seconds


A count of errors logged for that run


A count of the Eggplant Functional caught and uncaught exceptions raised


The name and absolute path of the Log file


The returned value of any return statements


The date and time the run was started


The status of the run: Success, Failure, or Running


A count of the warnings logged for that run

For information about script results, see the ScriptResults Function.

SendMail Properties




A filename or list of filenames to attach to the email

Body (or Message)

The text of the message


One or more addresses to which a copy of the message is sent, separated by commas


A mime type. For HTML email, use the value text/html. (The default is text/plain.)

From (required by some mail servers)

The user account sending the message


The default address to which a reply is sent

smtp_host (required)

The hostname or IP Address of the mail server


The password for log in to the mail server; used if an smtp_type is specified


The port used to connect to the mail server. Port 25, the default mail port, is used if nothing is specified.


The encryption method used for mail transport, either Unencrypted, SSL, or TLS


The authentication scheme used by the mail server.
On Mac: None, Plain, Login, or CRAM-MD5

On Linux and Windows: None or Plain.


The user account on the mail server; used if an smtp_type is specified


The subject line for the message

To (required)

One or more addresses, separated by commas

For information about using SendMail, see the SendMail Command. For a complete explanation of how to set up SendMail, see Sending Test Results via Email.

Text Properties

Common Text Properties (Used for OCR Searches)




The text string that you want to find on the SUT. (Required.)


Either the name of a text style, or a list of text properties defined in a script

Generic OCR Text Properties

Note: A boolean value is like a toggle switch with two possible values; Yes/No values are accepted as well as On/Off.
Property Searching Reading Value
AggressiveTextExtraction Yes Yes Boolean
CaseSensitive Yes No Boolean
Contrast Yes Yes Boolean
ContrastColor Yes Yes A color (see Color Values in SenseTalk)
ContrastTolerance Yes Yes 0-100 / Default 45
DPI Yes Yes Integer
EnhanceLocalContrast Yes Yes Boolean
ExtraWords Yes Yes A string or list of words
IgnoreNewLines Yes No Boolean
IgnoreSpaces Yes No Boolean
IgnoreUnderscores Yes No Boolean
InvertImage Yes Yes Boolean
Language Yes Yes A language name as specified in OCR Language Support (case sensitive).
LowResolutionMode Yes Yes Boolean
Multiline No Yes Boolean
PreferDictionaryWords Yes Yes Boolean
PreferredPattern Yes Yes Regular expression string (see Using Patterns in SenseTalk)
PreferredWords Yes Yes A string or list of words
ProhibitedWords Yes Yes A string or list of words
SearchRectangle Yes No* A pair of coordinates or captured images defining a rectangle
TextDifference Yes No Integer
TextRotation Yes Yes One of four predefined values
Trim No Yes Boolean
TrimBorder No Yes Integer
TrimColor No Yes A color (see Color Values in SenseTalk)
TrimTolerance No Yes Integer
TrimWhitespace No Yes Boolean
ValidCharacters No Yes Boolean
ValidPattern Yes Yes Regular expression string (see Using Patterns in SenseTalk)
ValidWords Yes Yes A string or list of words

* You do not need to set a SearchRectangle property with the ReadText Command because ReadText already takes a rectangle by default. This property can also be set with standard image searches; for more on this see Image References.


This topic was last updated on August 19, 2021, at 03:30:51 PM.

Eggplant icon Eggplantsoftware.com | Documentation Home | User Forums | Support | Copyright © 2022 Eggplant