To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

GuiSessionTO

SAPGUI. GuiSessionTO

GuiSessionTO

Constructor

new GuiSessionTO()

Members

displayName

Returns the object display name defined in the Application Model.

Methods

$(description) → {*}

Creates a child test object of this test object. This operation does not cause LeanFT to search for the object in the AUT. LeanFT interacts with the application only when a step runs that performs an operation on the AUT object.
Parameters:
Name Type Description
description The description of the test object. Can be a full test object description or a string. If a string is provided, it is interpreted as a CSS selector with a default test object type of WebElement.
Returns:
the new child test object with the provided description.
Type
*

$$(description, dontFilterByTypeopt) → {Promise.<Array.<TestObject>>}

Returns all child objects of this object that match the supplied test object description.
Parameters:
Name Type Attributes Default Description
description A description object that defines the test object type and the set of properties and values that should be common to all objects that are returned.
dontFilterByType bool <optional>
false Set this parameter to true to avoid limiting the returned objects to a specific test object type.
Returns:
an array of test objects that match the supplied description.
Type
Promise.<Array.<TestObject>>

activeWindow() → {Promise.<string>}

The name of the window that has focus.
Returns:
a promise that is fulfilled with the name of the window that has focus.
Type
Promise.<string>

applicationServer() → {Promise.<string>}

The name of the application server. Applies only when the connection specifies an application server and is not using load balancing.
Returns:
a promise that is fulfilled with the name of the application server.
Type
Promise.<string>

client() → {Promise.<string>}

The client selected on the login screen.
Returns:
a promise that is fulfilled with the client selected on the login screen.
Type
Promise.<string>

close() → {Promise.<void>}

Closes the SAP GUI for Windows session without displaying a warning message.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

codePage() → {Promise.<Number>}

The code page for this session.
Returns:
a promise that is fulfilled with the code page for this session.
Type
Promise.<Number>

description() → {*}

Returns the description for this test object.
Returns:
the description for this test object.
Type
*

exists(timeoutopt) → {Promise.<bool>}

Checks whether this object exists in the AUT.
Parameters:
Name Type Attributes Description
timeout Number <optional>
The time (in seconds) to wait for this object before returning a result of true or false.
By default, uses the object synchronization timeout defined in the runtime engine settings.
Returns:
an indication of whether the object exists.
Type
Promise.<bool>

flushes() → {Promise.<Number>}

The number of flushes or passes of data during server communication to the client.
Returns:
a promise that is fulfilled with the number of flushes or passes of data during server communication to the client.
Type
Promise.<Number>

getTextLocations(text, rectangleopt) → {Promise.<object>}

Returns all rectangular areas containing the specified text within this object.
Parameters:
Name Type Attributes Description
text String The text to search for in the test object.
rectangle Object <optional>
The rectangular area in the test object to search for the text.
Returns:
a promise that is fulfilled with an array of rectangles containing all rectangular areas containing the specified text within this object.
Type
Promise.<object>

getVisibleText(rectangleopt) → {Promise.<string>}

Returns all visible text from this object.
Parameters:
Name Type Attributes Description
rectangle Object <optional>
The rectangular area in the test object to return the text from.
Returns:
a promise that is fulfilled with all the visible text from this object.
Type
Promise.<string>

group() → {Promise.<string>}

Login group information. Applies only when connection is using load balancing.
Returns:
a promise that is fulfilled with the login group information.
Type
Promise.<string>

highlight()

Does not support
Overrides:

highlightMatches(description, dontFilterByTypeopt) → {Promise.<Number>}

Highlights all children that match the supplied test object description.
Parameters:
Name Type Attributes Default Description
description A description object that defines the test object type and the set of properties and values that should be common to all objects that are highlighted.
dontFilterByType bool <optional>
false Set this parameter to true to avoid limiting the highlighted objects to a specific test object type.
Returns:
the number of matches that are found and highlighted.
Type
Promise.<Number>

id() → {Promise.<string>}

The session's unique identifier in text format.
Returns:
a promise that is fulfilled with the session's unique identifier in text format.
Type
Promise.<string>

interpretationTime() → {Promise.<Number>}

The time, in milliseconds, it takes for the client to interpret the information received from the server.
Returns:
a promise that is fulfilled with the interpretation time.
Type
Promise.<Number>

language() → {Promise.<string>}

The language the user is working in.
Returns:
a promise that is fulfilled with the language the user is working in.
Type
Promise.<string>

messageServer() → {Promise.<string>}

The name of the message server. Applies only when connection is using load balancing.
Returns:
a promise that is fulfilled with the name of the message server.
Type
Promise.<string>

name() → {Promise.<string>}

The name of the session.
Returns:
a promise that is fulfilled with the name of the session.
Type
Promise.<string>

nativeObject() → {Promise.<Object>}

Returns the native application object that is represented by this test object instance, enabling you to access the native properties and methods provided by that object.
Returns:
a promise that is fulfilled with the native application object that is represented by this test object instance.
Type
Promise.<Object>

parent() → {*}

Returns the parent test object of this test object.
Returns:
the parent test object of this test object.
Type
*

program() → {Promise.<string>}

The name of the SAP source program that is executing.
Returns:
a promise that is fulfilled with the name of the SAP source program that is executing.
Type
Promise.<string>

reset(transactionCodeopt) → {Promise.<void>}

Navigates to the session initial screen.
Parameters:
Name Type Attributes Description
transactionCode string <optional>
The transaction to navigate to.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

responseTime() → {Promise.<Number>}

The server response time in milliseconds.
Returns:
a promise that is fulfilled with the server response time in milliseconds.
Type
Promise.<Number>

roundTrips() → {Promise.<Number>}

The number of communications between client and server while the client is locked and waiting for data from the server.
Returns:
a promise that is fulfilled with the number of communications between client and server while the client is locked. and waiting for data from the server.
Type
Promise.<Number>

screenNumber() → {Promise.<Number>}

The number of the displayed screen.
Returns:
a promise that is fulfilled with the number of the displayed screen from the server.
Type
Promise.<Number>

snapshot()

Does not support
Overrides:

sync(timeOutopt) → {Promise.<void>}

Suspends execution until the SAP GUI for Windows session is available. After time-out, the test run continues regardless of the session status. You can use this method when invoking a new session from an existing session or when moving from a session that is open on one server to a new session on a different server.
Parameters:
Name Type Attributes Description
timeOut Number <optional>
Milliseconds.
Returns:
a promise that is fulfilled when the operation ends.
Type
Promise.<void>

systemName() → {Promise.<string>}

The name of the SAP system.
Returns:
a promise that is fulfilled with the name of the SAP system.
Type
Promise.<string>

systemNumber() → {Promise.<Number>}

The system number. Applies only when connection specifies an application server and is not using load balancing.
Returns:
a promise that is fulfilled with the system number.
Type
Promise.<Number>

transaction() → {Promise.<string>}

The transaction the user is executing.
Returns:
a promise that is fulfilled with the transaction the user is executing.
Type
Promise.<string>

type() → {Promise.<SAPGUI.ComponentType>}

The SAPGUI component type.
Returns:
a promise that is fulfilled with the SAPGUI component type.
Type
Promise.<SAPGUI.ComponentType>

user() → {Promise.<string>}

The user name.
Returns:
a promise that is fulfilled with the user name.
Type
Promise.<string>

verifyImageExists(imageToFind, similarityopt) → {Promise.<object>}

Checks whether a snapshot of this object contains the supplied image.
Parameters:
Name Type Attributes Description
imageToFind String A Base64 string representation of the image to look for within the test object's snapshot.
similarity Number <optional>
The minimum similarity between the two images (as a percentage), above which the find is considered a match. Default = 100.
Returns:
a promise that is fulfilled with an object representing the point where the image was located, or null if it was not found.
Type
Promise.<object>

verifyImageMatch(expectedImage, maskAreaImage, pixelToleranceopt, rgbToleranceopt) → {Promise.<Boolean>}

Checks whether a snapshot of this object and the supplied image are a match.
Parameters:
Name Type Attributes Description
expectedImage String A Base64 string representation of the image to compare to the test object snapshot.
maskAreaImage String A Base64 string representation of the image mask area to use in the image comparison.
pixelTolerance Number <optional>
The percentage of pixels that can differ between the two images, and still be considered a match. Default = 0.
rgbTolerance Number <optional>
The percentage by which the RGB values of the pixels in the two images can differ, and still be considered a match. Default = 0.
Returns:
a Boolean representing the comparison result.
Type
Promise.<Boolean>