Skip to main content

Quick Reference: Property Lists

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

CaptureScreen Properties

ImageInfoAn image property list
IncrementWhether to append an automatically incremented number to the image; true or false
NameAn 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

The properties in a connection property list vary depending on the type of connection.

The properties for a VNC or RDP connection may include:

BlendScaledScreenWhether or not VNC server blends pixel colors when scaleRemoteScreen is Yes
BonjourWhether or not the SUT was found via Bonjour or zeroconf
ColorDepthThe color depth of the SUT in the Viewer window: 8, 16, 32
ConnectedWhether or not Eggplant Functional is currently connected to the SUT
HeightFor RDP connections only, the height of the Viewer window in pixels
MonitorCountThe number of monitors for an RDP connection
NameThe display name of the SUT
PasswordPassword for the VNC server for a VNC connection, or the Windows user password for an RDP connection
PortNumPort number used by the SUT VNC server
ReverseWhether or not the connection is a reverse connection (i.e., initiated by the SUT)
ScaleRemoteScreenWhether or not VNC server dimensions are scaled by 50 percent
ScreenSizeThe width and height of the SUT screen
ServerID (required)SUT host name, IP address, or display name
sshHostHost name or IP address of an SSH host
sshPasswordPassword of the user account on the SSH host computer
sshUserUser account on the SSH host computer
TypeThe method to use to connect to the SUT. Possible values are RDP, VNC, or screenshot
UsernameThe Windows username when connecting via RDP
VisibleWhether or not the Viewer window opens upon connection
WidthFor RDP connections only, the width of the Viewer window in pixels

The properties for a Sauce Labs connection may include:

APIKeyThe Sauce Labs API key for the account
AppThe URL of the app to execute on the device
BrowserNameThe name of the browser, such as "Chrome", "Firefox", etc.
BrowserVersionSpecific browser version
ColorDepthThe color depth of the SUT in the Viewer window: 8, 16, 32
ConnectedWhether or not Eggplant Functional is currently connected to the SUT
DataCenterThe Sauce Labs data center to connect to
DeviceNameThe device identifier, such as "Iphone 12", etc
NameThe display name of the SUT
PlatformNameThe name of the operating system platform, such as "Windows 10" or "Android"
ScreenResolutionThe browser screen size in the form width X height, such as "1400x1050"
ScreenSizeThe width and height of the SUT screen, as a list
TypeFor a Sauce Labs connection this will be "SauceLabs"
URLThe URL of the site to connect to in the browser
UserThe user name for the Sauce Labs account being used
VisibleWhether or not the Viewer window opens upon connection

For information about using connection property lists see the Connect Command and the ConnectionInfo Function. For general information about connections, see Creating Connections to SUTs.

Image Properties

CaptureDateThe date of image capture, including the time
CaptureHostThe SUT from which the image was captured
CaptureLocationScreen coordinates of the image when it was captured. (This value cannot be changed.)
CaptureScreenSizeScreen size of the SUT in pixels at time of image capture, given as (width,height)
CharactersRefers to image names from a character collection. See Image Searches Using a Character Collection for more information.
CliprectangleCoordinates that define a rectangle within the image; any pixels outside the cliprectangle are disregarded for image matching
DiscrepancyThe 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.
HotSpotCoordinates of the hot spot within the image, relative to the top-left corner of the image
ImageDescriptionThe images description in the Suite Editor Images pane. (This value cannot be changed.)
ImageNameName of the image file. (File extension is not used.)
ImagePathFile path of the image file. (This value cannot be changed.)
ImageSizeWidth and height in pixels. (This value cannot be changed.)
ImageToleranceThe acceptable difference between color values in an image and a match in the Viewer window
PulsingWhether the search type allows for pulsing; true or false
RotateA 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
ScaleThe 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.
SearchrectangleCoordinates that define a rectangle in the Viewer window. Eggplant Functional only looks for this image within the defined rectangle
SearchTypeThe 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.
WaitForThe maximum time Eggplant Functional waits for the given image to appear on the SUT

For information about using image properties, see:

ReadCharacters Function Properties

asListWhen asList is on (asList:Yes), the ReadCharacters function returns a list of strings, one for each group of recognized characters.
characterPriorityThis 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.
minimumVerticalOverlapThis 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.
maximumHorizontalOverlapThis 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.
maximumAdjacentGapThis 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.
maximumSpaceGapThis 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.
spaceWidthThis 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

DurationThe length of time the script ran (or has been running) given in seconds
ErrorsA count of errors logged for that run
ExceptionsA count of the Eggplant Functional caught and uncaught exceptions raised
LogFileThe name and absolute path of the Log file
ReturnValueThe returned value of any return statements
RunDateThe date and time the run was started
StatusThe status of the run: Success, Failure, or Running
WarningsA count of the warnings logged for that run

For information about script results, see the ScriptResults Function.

SendMail Properties

AttachmentA filename or list of filenames to attach to the email
Body (or Message)The text of the message
CCOne or more addresses to which a copy of the message is sent, separated by commas
"Content-Type"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
ReplyToThe default address to which a reply is sent
smtp_host (required)The hostname or IP Address of the mail server
smtp_passwordThe password for log in to the mail server; used if an smtp_type is specified
smtp_portThe port used to connect to the mail server. Port 25, the default mail port, is used if nothing is specified.
smtp_transportThe encryption method used for mail transport, either Unencrypted, SSL, or TLS
smtp_typeThe authentication scheme used by the mail server.
On Mac: None, Plain, Login, or CRAM-MD5

On Linux and Windows: None or Plain.
smtp_userThe user account on the mail server; used if an smtp_type is specified
SubjectThe 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)

TextThe text string that you want to find on the SUT. (Required.)
TextStyleEither the name of a text style, or a list of text properties defined in a script

Generic OCR Text Properties


A boolean value is like a toggle switch with two possible values; Yes/No values are accepted as well as On/Off.

ContrastColorYesYesA color (see Color Values in SenseTalk)
ContrastToleranceYesYes0-100 / Default 45
ExtraWordsYesYesA string or list of words
LanguageYesYesA language name as specified in OCR Language Support (case sensitive).
PreferredPatternYesYesRegular expression string (see Using Patterns in SenseTalk)
PreferredWordsYesYesA string or list of words
ProhibitedWordsYesYesA string or list of words
SearchRectangleYesNo*A pair of coordinates or captured images defining a rectangle
TextRotationYesYesOne of four predefined values
TrimColorNoYesA color (see Color Values in SenseTalk)
ValidPatternYesYesRegular expression string (see Using Patterns in SenseTalk)
ValidWordsYesYesA 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.