Port IMAGE - DEFAULT¶

Standard port for browser interaction

Stimulation¶

This port has no stimulus capabilities.

Properties 🛈¶

Name	Available if	Default value	Valid values	Type	Description
Browser		‘Firefox’	[‘Firefox’, ‘Chrome’, ‘Edge’]	string	Browser selection. Browser path and web driver path must match the selection.
Browser path		‘<auto>’		string	Absolute installation path to the browser or “<auto>” to use default path.
Browser profile path				string	Optional: Absolute path to the used browser profile
Browser extensions				string	Optional: Comma-separated paths to browser extensions. Paths can be absolute or relative to the tool host base path.
Browser width		800		int	Width of the browser window in pixels.
Browser height		600		int	Height of the browser window in pixels.
WebDriver path		‘<auto>’		string	Installation path to the web driver. Path can be absolute or relative to the tool host base path. The option “<auto>” will try to find and download the driver automatically via Selenium’s web driver manager (internet access is needed).
Implicit timeout		10		float	Timeout in seconds, which applies to all steps unless specified otherwise in the step.
Headless mode		☐		bool	Starts the browser in headless mode (without visible window).
Additional arguments				string	Additional command line arguments that are passed to the configured web driver at startup, e.g. “–proxy-server=http://proxy.local:8338”. See the Selenium web driver documentation for possible arguments.
Live preview		☐		bool	Streams a live preview on the configured network port. The live stream is available under the toolhost’s IP address and the configured port, e.g. for a local tool connection: http://127.0.0.1:<port>
Open preview window	Live preview	☑		bool	Opens a preview window upon StartBrowser job execution. This window displays the current output of the image source as a livestream and will remain open until StopBrowser job execution.
Port	Live preview	‘<auto>’		string	The network port that will be used for live streaming. Every live stream needs an unique port if live streaming is enabled for multiple video sources. If the value is set to <auto> a free network port will be defined by the system.
Show text overlay in video recordings		☐		bool	Adds a text overlay with the format “timestamp package name” in the bottom left corner of video recordings.

Jobs 🛈¶

ClickElement¶

Clicks onto the requested element.

Parameter

Name	Default value	Valid values	Type	Description
searchMethod	‘id’	[‘id’, ‘xpath’, ‘link text’, ‘partial link text’, ‘name’, ‘tag name’, ‘class name’, ‘css selector’]	string	The method by which the element is identified.
searchValue			string	The value that identifies the element to click onto, according to the search method.
timeout	-1.0		float	Timeout to wait for the element; -1 for default value from test bench configuration.

ClickPosition¶

Clicks onto the requested position.

Parameter

Name	Available if	Default value	Valid values	Type	Description
positionX		0		int	The X location of the position.
positionY		0		int	The Y location of the position.

CloseWindow¶

Closes the specified window.

Parameter

Name	Available if	Default value	Valid values	Type	Description
windowHandle				string	The identifier for the window to be changed.

Return value

Name	Available if	Default value	Valid values	Type	Description
success			[False, True]	bool	Returns whether the closing of the window was successful.

DragAndDropByOffset¶

Performs a drag and drop on an element in the specified direction.

Parameter

Name	Default value	Valid values	Type	Description
offsetX	0		int	Number of pixels in horizontal direction.
offsetY	0		int	Number of pixels in vertical direction.
searchMethod	‘id’	[‘id’, ‘xpath’, ‘link text’, ‘partial link text’, ‘name’, ‘tag name’, ‘class name’, ‘css selector’]	string	The method by which the element is identified.
searchValue			string	The value that identifies the element to click onto, according to the search method.
timeout	-1.0		float	Timeout to wait for the element; -1 for default value from test bench configuration.

ElementScreenshot¶

Returns the image of the first found element.

Parameter

Name	Default value	Valid values	Type	Description
searchMethod	‘id’	[‘id’, ‘xpath’, ‘link text’, ‘partial link text’, ‘name’, ‘tag name’, ‘class name’, ‘css selector’]	string	The method by which the element is identified.
searchValue			string	The value that identifies the element to click onto, according to the search method.
timeout	-1.0		float	Timeout to wait for the element; -1 for default value from test bench configuration.

FindElements¶

Returns the IDs of the searched elements

Parameter

Name	Default value	Valid values	Type	Description
searchMethod	‘id’	[‘id’, ‘xpath’, ‘link text’, ‘partial link text’, ‘name’, ‘tag name’, ‘class name’, ‘css selector’]	string	The method by which the element is identified.
searchValue			string	The value that identifies the element to click onto, according to the search method.
timeout	-1.0		float	Timeout to wait for the element; -1 for default value from test bench configuration.

Return value

Name	Available if	Default value	Valid values	Type	Description
Response				object	List with IDs.

GetCurrentUrl¶

Returns the URL of the currently opened web page.

Return value

Name	Available if	Default value	Valid values	Type	Description
Response				string	Current URL.

GetElementProperty¶

Returns the desired property of the element.

Parameter

Name	Default value	Valid values	Type	Description
propertyName			string	The value of the property to be returned.
searchMethod	‘id’	[‘id’, ‘xpath’, ‘link text’, ‘partial link text’, ‘name’, ‘tag name’, ‘class name’, ‘css selector’]	string	The method by which the element is identified.
searchValue			string	The value that identifies the element to click onto, according to the search method.
timeout	-1.0		float	Timeout to wait for the element; -1 for default value from test bench configuration.

Return value

Name	Available if	Default value	Valid values	Type	Description
Response				string	Property value.

GetOpenWindows¶

Returns all open windows. Empty list if none are open.

Return value

Name	Available if	Default value	Valid values	Type	Description
windows				object	List of all open windows.

GetPageSource¶

Returns the HTML source of the web page.

Return value

Name	Available if	Default value	Valid values	Type	Description
html				string	HTML source code of the web page.

GetWebDriver¶

Returns the internal Selenium web driver which allows direct access to the Selenium API.

GoBack¶

Displays the previous page again.

MoveMouseOverElement¶

Moves the mouse to the first element found.

Parameter

Name	Default value	Valid values	Type	Description
searchMethod	‘id’	[‘id’, ‘xpath’, ‘link text’, ‘partial link text’, ‘name’, ‘tag name’, ‘class name’, ‘css selector’]	string	The method by which the element is identified.
searchValue			string	The value that identifies the element to click onto, according to the search method.
timeout	-1.0		float	Timeout to wait for the element; -1 for default value from test bench configuration.

OpenUrl¶

Opens the given web site (URL).

Parameter

Name	Default value	Valid values	Type	Description
url			string	The complete web address.
windowName			string	The name of the window in which the URL should be opened.
windowType	‘Current window’	[‘Current window’, ‘Selected window’, ‘New window’, ‘New tab’]	string	Type of window in which the URL should be opened.

Return value

Name	Available if	Default value	Valid values	Type	Description
windowHandle				string	The identifier of the window.

ScrollElement¶

Scrolls by the requested distance in the given element - up (or to the left) for a given negative distance, down (or to the right) otherwise.

Parameter

Name	Default value	Valid values	Type	Description
searchMethod	‘id’	[‘id’, ‘xpath’, ‘link text’, ‘partial link text’, ‘name’, ‘tag name’, ‘class name’, ‘css selector’]	string	The method by which the element is identified.
searchValue			string	The value that identifies the element to click onto, according to the search method.
xDistance	0		int	The number of pixels to scroll.
yDistance	0		int	The number of pixels to scroll.

ScrollPage¶

Scrolls the whole page by the requested distance - up (or to the left) for a given negative distance, down (or to the right) otherwise.

Parameter

Name	Available if	Default value	Valid values	Type	Description
xDistance		0		int	The number of pixels to scroll.
yDistance		0		int	The number of pixels to scroll.

ScrollToElement¶

Scrolls to the given element.

Parameter

Name	Available if	Default value	Valid values	Type	Description
searchMethod		‘id’	[‘id’, ‘xpath’, ‘link text’, ‘partial link text’, ‘name’, ‘tag name’, ‘class name’, ‘css selector’]	string	The method by which the element is identified.
searchValue				string	The value that identifies the element to click onto, according to the search method.

SendKey¶

Presses a special key.

Parameter

Name	Available if	Default value	Valid values	Type	Description
key		‘ADD’	[‘ADD’, ‘ALT’, ‘ARROW_DOWN’, ‘ARROW_LEFT’, ‘ARROW_RIGHT’, ‘ARROW_UP’, ‘BACKSPACE’, ‘BACK_SPACE’, ‘CANCEL’, ‘CLEAR’, ‘COMMAND’, ‘CONTROL’, ‘DECIMAL’, ‘DELETE’, ‘DIVIDE’, ‘DOWN’, ‘END’, ‘ENTER’, ‘EQUALS’, ‘ESCAPE’, ‘F1’, ‘F10’, ‘F11’, ‘F12’, ‘F2’, ‘F3’, ‘F4’, ‘F5’, ‘F6’, ‘F7’, ‘F8’, ‘F9’, ‘HELP’, ‘HOME’, ‘INSERT’, ‘LEFT’, ‘LEFT_ALT’, ‘LEFT_COMMAND’, ‘LEFT_CONTROL’, ‘LEFT_META’, ‘LEFT_OPTION’, ‘LEFT_SHIFT’, ‘META’, ‘MULTIPLY’, ‘NULL’, ‘NUMPAD0’, ‘NUMPAD1’, ‘NUMPAD2’, ‘NUMPAD3’, ‘NUMPAD4’, ‘NUMPAD5’, ‘NUMPAD6’, ‘NUMPAD7’, ‘NUMPAD8’, ‘NUMPAD9’, ‘PAGE_DOWN’, ‘PAGE_UP’, ‘PAUSE’, ‘RETURN’, ‘RIGHT’, ‘RIGHT_ALT’, ‘RIGHT_CONTROL’, ‘RIGHT_META’, ‘RIGHT_OPTION’, ‘RIGHT_SHIFT’, ‘SEMICOLON’, ‘SEPARATOR’, ‘SHIFT’, ‘SPACE’, ‘SUBTRACT’, ‘TAB’, ‘UP’, ‘ZENKAKU_HANKAKU’]	string	The key to be pressed.

SetWindowSize¶

Changes the size of the browser window.

Parameter

Name	Default value	Valid values	Type	Description
mode	‘From test bench configuration’	[‘From test bench configuration’, ‘Maximized’, ‘Minimized’, ‘User defined’]	string	Custom value, “maximized”, “minimized” or default value from test bench configuration
windowHeight	0		int	Window height in pixels for “User defined” mode.
windowWidth	0		int	Window width in pixels for “User defined” mode.

StartBrowser¶

Starts the browser instance.

StopBrowser¶

Stops the browser instance.

SwitchToDefaultContent¶

Moves focus back to the main content after an iframe has been selected.

SwitchToFrame¶

Moves focus to an iframe for locating elements therein.

Parameter

Name	Available if	Default value	Valid values	Type	Description
identifier				string	Index, name or ID of the iframe.

SwitchToWindow¶

Switches to the specified window.

Parameter

Name	Available if	Default value	Valid values	Type	Description
windowHandle				string	The identifier for the window to be changed.

Return value

Name	Available if	Default value	Valid values	Type	Description
success			[False, True]	bool	Returns whether the switch to the window was successful.

WebsiteScreenshot¶

Returns an image of the complete web page, including the invisible area.

WriteText¶

Types the given text at the current cursor position.

Parameter

Name	Available if	Default value	Valid values	Type	Description
pressEnter		☐		bool	If True, Enter is pressed after the input.
text				string	The text that has to be typed.