Interface IGuiSession
A SAP GUI for Windows session.
Inherited Members
Namespace: HP.LFT.SDK.SAP.GUI
Assembly: HP.LFT.SDK.dll
Syntax
public interface IGuiSession : ITestObject, ITestObjectDescriber, ISupportsNativeObjectProperties
ActiveWindow
The name of the window that has focus.
Declaration
string ActiveWindow { get; }Property Value
| Type | Description |
|---|---|
| string |
ApplicationServer
The name of the application server. Applies only when the connection specifies an application server and is not using load balancing.
Declaration
string ApplicationServer { get; }Property Value
| Type | Description |
|---|---|
| string |
Client
The client selected on the login screen.
Declaration
string Client { get; }Property Value
| Type | Description |
|---|---|
| string |
CodePage
The code page for this session.
Declaration
long CodePage { get; }Property Value
| Type | Description |
|---|---|
| long |
Flushes
The number of flushes or passes of data during server communication to the client.
Declaration
long Flushes { get; }Property Value
| Type | Description |
|---|---|
| long |
Group
Login group information. Applies only when connection is using load balancing.
Declaration
string Group { get; }Property Value
| Type | Description |
|---|---|
| string |
Id
The session's unique identifier in text format.
Declaration
string Id { get; }Property Value
| Type | Description |
|---|---|
| string |
InterpretationTime
The time, in milliseconds, it takes for the client to interpret the information received from the server.
Declaration
long InterpretationTime { get; }Property Value
| Type | Description |
|---|---|
| long |
Language
The language the user is working in.
Declaration
string Language { get; }Property Value
| Type | Description |
|---|---|
| string |
MessageServer
The name of the message server. Applies only when connection is using load balancing.
Declaration
string MessageServer { get; }Property Value
| Type | Description |
|---|---|
| string |
Name
The name of the session.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| string |
Program
The name of the SAP source program that is executing.
Declaration
string Program { get; }Property Value
| Type | Description |
|---|---|
| string |
ResponseTime
The server response time in milliseconds.
Declaration
long ResponseTime { get; }Property Value
| Type | Description |
|---|---|
| long |
RoundTrips
The number of communications between client and server while the client is locked and waiting for data from the server.
Declaration
long RoundTrips { get; }Property Value
| Type | Description |
|---|---|
| long |
ScreenNumber
The number of the displayed screen.
Declaration
long ScreenNumber { get; }Property Value
| Type | Description |
|---|---|
| long |
SystemName
The name of the SAP system.
Declaration
string SystemName { get; }Property Value
| Type | Description |
|---|---|
| string |
SystemNumber
The system number. Applies only when connection specifies an application server and is not using load balancing.
Declaration
long SystemNumber { get; }Property Value
| Type | Description |
|---|---|
| long |
Transaction
The transaction the user is executing.
Declaration
string Transaction { get; }Property Value
| Type | Description |
|---|---|
| string |
Type
The GUI component type.
Declaration
ComponentType Type { get; }Property Value
| Type | Description |
|---|---|
| ComponentType |
User
The user name.
Declaration
string User { get; }Property Value
| Type | Description |
|---|---|
| string |
Methods
Close()
Closes the SAP GUI for Windows session without displaying a warning message.
Declaration
void Close()Remarks
You can invoke this method at the end of an action or test iteration to close sessions that were opened during the test run. This ensures that each iteration begins with the same number of open SAP Gui for Windows sessions.
Reset()
Navigates to the session initial screen.
Declaration
void Reset()Remarks
We recommend using this method to ensure that tests are rerun from the initial screen of the session.
Reset(string)
Navigates to the specified transaction.
Declaration
void Reset(string transactionCode)Parameters
| Type | Name | Description |
|---|---|---|
| string | transactionCode | the transaction to navigate to. |
Sync()
Suspends execution until the SAP GUI for Windows session is available.
Declaration
void Sync()Sync(long)
Suspends execution until the SAP GUI for Windows session is available or until timed out.
Declaration
void Sync(long timeOut)Parameters
| Type | Name | Description |
|---|---|---|
| long | timeOut | milliseconds. |
Remarks
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.