You are here:

Quick Reference: Global Properties

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

On this page:

Eggplant Functional Global Properties
Run-Option Global Properties
Assert Command Global Properties
Deprecated Global Properties

Eggplant Functional Global Properties

Key	Description
The CaptureScreenImageFormat	Modifies the image file format used by the CaptureScreen command when capturing screenshots during a test run.
The CaptureScreenJPGCompressionQuality	Adjusts the compression quality of JPG formatted screenshots captured by the CaptureScreen command.
The CaptureScreenScaleFactor	Scales images captured by the CaptureScreen command proportionally.
The CollectionFilter	Limits image searches based on a specified string.
The CommandLineOutput	Determines whether log files are output when you run scripts from the command line.
The CurrentCharacterCollection	Sets a default character collection for image searches that use the character property.
The DefaultCaptureScreenSize	Sets the default screen size of the SUT at time of image capture for any images captured prior to Eggplant Functional 12.20.
The DefaultScale	Sets the scale at which Eggplant Functional searches for an image, relative to its original capture size.
The DefaultUseMarkup	Determines whether supported text markups are used to format text images.
The FinalSuites	Sets the suite or suites that are searched for image or script resources after the script's own suite is searched.
The ForceScreenRefresh	Determines whether Eggplant Functional refreshes the Viewer window after each command.
The HotSpotScaling	Specifies the behavior of the hot spot when image scaling is used.
The ImageUpdate	Determines the behavior of the Image Update panel during script execution.
The InitialSuites	Sets the first suite or suites that are searched for image or script resources during script execution.
The MultipleFoundAction	Overrides image update settings at runtime.
The OpenTestCases	Accesses information gathered up to that point by all open test cases.
The ReadTextSettings	Provides default settings used by the ReadText and ReadTable functions.
The RemoteClipboard	Holds the contents of the SUT clipboard.
The RepositionPoint	Sets the location where the mouse cursor is moved during searches.
The SaveRunLogOutput	Determines whether the run log output from the execution is saved.
The ScriptAnimation	Turns script animation on or off.
The ScriptLogging	Determines how much is written in the log file.
The ScriptTracing	Turns script tracing on or off.
The SearchRectangle	Sets the area of the System Under Test (SUT) that is searched.
The SuiteVariables	Sets suite-wide variables in Eggplant Functional that can be used in many contexts.
The TextStyle	Controls the default option settings for text searches.
The ValidateImageFound	Determines the behavior of Image Update panel when ImageFound returns false.

Run-Option Global Properties

Key	Description
The ForceScreenRefresh	Whether there is a screen refresh after every line
The ImageSearchCount	Number of times Eggplant Functional searches for an image in the Viewer window
The ImageSearchDelay	Time between image searches
The ImageSearchTime	Time spent searching for an image
The KeyDownDelay	Time between key press and release
The MouseClickDelay	Time between mouse-button press and release
The MouseDoubleClickDelay	Time between clicks of a double-click
The MouseDragSpeed	Determines how fast the SUT's mouse is moved during a drag command.
The MouseMoveDelay	Time between increments of mouse movement
The MouseMoveMode	Mouse path to the next given location
The MouseMoveSpeed	Space the mouse moves in each increment between locations
The NextKeyDelay	Time between keystrokes
The PreciseImageTolerance	Maximum color difference allowed by precise image searches
The RemoteWorkInterval	Minimum time between executed commands in the SUT
The SendShiftForCaps	Whether or not Shift is held down for capital letters on the SUT
The ShouldRepositionMouse	Whether the mouse is repositioned during searches
The StandardImageTolerance	Maximum color difference allowed by tolerant image searches
The SwipeSpeed	The speed at which swipe events occur, expressed in number of pixels Eggplant Functional drags the SUT’s mouse in each step
The WebElementDisplay	Whether WebElement objects display in long or short format

Assert Command Global Properties

Key	Description
The AssertionBehavior	The default behavior for assert commands. Options are Exception, Error, Warning, or Pause. Defaults to Exception.
The AssertionsEnabled	Specifies if Eggplant Functional runs assert commands. Defaults to True. If set to False, Eggplant Functional ignores assert commands.
The AssertionPassCount and related counters	Global counters that increment each time an assert command runs. The counters are assertionFailCount, assertionErrorCount, assertionWarningCount, and assertionExceptionCount. Each failure increments both the assertionFailCount and also one of the assertionErrorCount, assertionWarningCount, or assertionExceptionCount counters.

For information about using the Assert command, see Assert Command.

Deprecated Global Properties

Key	Description
The CurrentTextPlatform	Sets the current text platform.
The DefaultTextStyle	Sets the default text style of the current text platform.
The ImageDoctor	Determines how the Image Doctor works during script execution. Instead, use the ImageUpdate Global Property.
The TextPlatforms	Contains properties for all text platforms.

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