Port IMAGE - DEFAULT¶

Default port for the interaction with an AUT

Stimulation¶

This port has no stimulus capabilities.

Specifics¶

The supported touch inputs Tap, Hold and Multi-Tap are executed as mouse actions. Tap corresponds to a left click, Hold to a long left click and Multi-Tap to a repeated left click with the specified waiting time in between. This can be used to create a double click, for example.

Properties 🛈¶

Name	Available if	Default value	Valid values	Type	Description
Name of the AUT				string	Name of the application under test, that will be started
Screenshot mode		Desktop	[Desktop, Object]	string	Specifies the area from which a screenshot is taken during the image read test step.
Object for media access	Screenshot mode: ‘Object’			string	Name of the object which shall be used for media access. The Read-Image test step will take a screenshot of the object configured here. This must be the name of a member of the object map (names.py).
Delay for object screenshots ❲ms❳		1000		int	Delay for Read-Image test steps in Screenshot Mode “Object” and for job “Screenshot”. By default, this is 1000 ms to allow the AUT to process previous inputs and reach a stable state.
Toolkit wrapper of the AUT		Windows	[Qt, Windows, Web (Chromium-based Application)]	string	Name of the toolkit wrapper, that shall be used for this AUT. If it’s unknown, the value can be taken from the Test Suite settings.
Remote debugging port	Toolkit wrapper of the AUT: ‘Web (Chromium-based Application)’			int	Port number of the AUT’s remote debugging port for establishing a connection from Squish to the AUT’s Chromium web content.
Start and stop AUT		☑		bool	If active, the Application Under Test will be started automatically when starting the configuration and stopped when stopping the configuration.

Jobs 🛈¶

CheckIfObjectExists¶

Checks if object exists.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ItemName				string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
ObjectName			[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).

Return value

Name	Available if	Default value	Valid values	Type	Description
return			[False, True]	bool	True if the object exists, False otherwise.

GetObjectProperty¶

Queries the value of a property from the object with the given name.

Parameter

Name	Valid values	Type	Description
ItemName		string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
ObjectName	[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).
PropertyName		string	Name of the property to query.

Return value

Name	Available if	Default value	Valid values	Type	Description
return				string	Text representation of the value of the property.

GetTableCell¶

Reads the data of a table cell. Allows using a QT Role such as Qt.DisplayRole or Qt.UserRole. This job can only be executed with the “Qt” toolkit. For other toolkits an error is thrown.

Parameter

Name	Default value	Valid values	Type	Description
ObjectName		[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).
Position	(0, 0)		object	Coordinate of the requested cell.
RoleContext	‘Qt.DisplayRole’	[‘Qt.DisplayRole’, ‘Qt.UserRole’]	string	Kind of requested information. For a Qt role the content is returned in the respective representation. For example “Qt.DisplayRole” returns the main contents of the cell in textual representation.

Return value

Name	Available if	Default value	Valid values	Type	Description
return				object	Representation of the cell’s value.

GetTableSize¶

Returns the size of the table. This job can only be used for toolkit “Qt” and throws an error otherwise.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ObjectName			[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).

Return value

Name	Available if	Default value	Valid values	Type	Description
return				object	The size of the table as (row count, column count).

MouseClickObject¶

Triggers a mouse click on the element which is identified by its object name.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ItemName				string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
ObjectName			[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).

MouseClickPosition¶

Triggers a mouse click at a specified position.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Position		(0, 0)		object	Position at which should be clicked. Must be a tuple of the form (x, y).

MouseDragObject¶

Presses the left mouse button on an element and moves it.

This tool job can only be executed in combination with the “Qt” toolkit. With other toolkits an error occurs.

Parameter

Name	Default value	Valid values	Type	Description
Delta	(0, 0)		object	Delta by which the mouse button should move the object. Must be a tuple of the form (x, y).
ItemName			string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
Modifier1		[ONLINE]	string	Key to be pressed during the operation.
Modifier2		[ONLINE]	string	Key to be pressed during the operation.
MouseButton		[ONLINE]	string	Mouse button to be pressed.
ObjectName		[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).
Position	(0, 0)		object	Position at which the mouse button should be pressed within the object. Must be a tuple of the form (x, y).

MousePressAndHoldObject¶

Presses the left mouse button on an element and keeps it pressed for a certain time. The target is identified by a name from the object map (names.py).

Parameter

Name	Default value	Valid values	Type	Description
Duration	1.0		float	How long the mouse button should be held down on the target (in seconds).
ItemName			string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
ObjectName		[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).

MousePressAndHoldPosition¶

Presses the left mouse button at a certain position and keeps it pressed for a certain time.

Parameter

Name	Available if	Default value	Valid values	Type	Description
Duration		1.0		float	How long the mouse button should be held down (in seconds).
Position		(0, 0)		object	Position at which the mouse button should be pressed. Must be a tuple of the form (x, y).

ReattachAut¶

This job connects to the specified AUT. If the AUT is already connected, the current connection is terminated and a new connection is established. Establishing a first-time connection is possible as well.

If the AUT cannot be connected, its name is returned.

This job cannot be used if the port is set to start and stop the AUT automatically.

Return value

Name	Available if	Default value	Valid values	Type	Description
errorAut				string	Name of AUT if it was not attached successfully.

Screenshot¶

Takes a screenshot of an element which is identified by the object name. The object does not need to be visible.

Parameter

Name	Available if	Default value	Valid values	Type	Description
ItemName				string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
ObjectName			[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).

SendEvent¶

Sends an event to the given object.

Parameter

Name	Default value	Valid values	Type	Description
EventArgs	()		object	Arguments of the event as a tuple.
EventName			string	Name of the event.
ItemName			string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
ObjectName		[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).

SetObjectProperty¶

Sets the value of an object property with the given name.

Parameter

Name	Default value	Valid values	Type	Description
ItemName			string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
ObjectName		[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).
PropertyName			string	Name of the property to be set.
Value	()		object	Value of the property to be set. The data type for input as well as the write permission depend on the object and the toolkit.

TypeText¶

Enters text as if typing on a keyboard. Entries with <> are interpreted as key input, for example <Ctrl+c>.

Parameter

Name	Valid values	Type	Description
ItemName		string	If Object is a container, e.g. a list, table or tree, a sub element can be entered optionally. For tables it can be entered as “Line/Column” (e.g. “5/3”), for trees as path with “.” as separator. For toolkits Windows, Java and Qt this sub element is evaluated, otherwise the main object.
ObjectName	[ONLINE]	string	Name of the referenced object. This must be the name of a member of the object map (names.py).
Value		string	Text to be entered. Permitted key combinations, such as “<Ctrl+Return>”, as well as writing permissions depend on object and toolkit.