Object Model Reference for GUI Testing > Siebel > GetBusyTime Method

SiebApplication Object

Description

An application in a Siebel test automation environment.

Operations

The sections below list the built-in methods and properties that you can use as operations for the SiebApplication object.

Note: You can also view a list and descriptions of the SiebApplication description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

Methods

Common Method CaptureBitmap Saves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method Check Checks whether the actual value of an item matches the expected value.
Common Method CheckProperty Checks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjects Returns the collection of child objects contained within the object.
Method GetBusyTime Returns the time (in milliseconds) it took Siebel Application Client to become idle when the Siebel Application UI changed from standard- to high-interactivity.
Method GetClassCount Returns the number of objects of the specified type.
Method GetLastErrorCode Returns the last error code issued.
Method GetLastErrorMessage Returns the last error message issued.
Method GetLastOpId Returns the Id of the previous operation.
Method GetLastOpTime Returns the time (in milliseconds) it took to execute the previous operation.
Method GetRepositoryName Returns the RepositoryName of the object.
Method GetRepositoryNameByIndex Returns the RepositoryName of the item with the specified index.
Common Method GetROProperty Returns the current value of the specified description properties from the object in the application.
Method GetSessionId Returns the Id of current session.
Common Method GetTOProperties Returns the collection of properties and values used to identify the object.
Common Method GetTOProperty Returns the value of the specified description properties from the test object description.
Method GotoScreen Navigates to the specified screen corresponding to the specified screen repository name.
Method GotoView Navigates to the top-level view corresponding to the specified view repository name.
Common Method Output Retrieves the current value of an item and stores it in a specified location.
Method ProcessKeyboardAccelerator Executes keyboard accelerators.
Common Method RefreshObject Instructs UFT to re-identify the object in the application the next time a step refers to this object.
Method SetTimeOut Sets the maximum length of time (in seconds) that the test tool waits for the application to return from an operation before executing the next line of script. When timeout is exceeded, the test tool halts the script and displays an error.
Common Method SetTOProperty Sets the value of the specified description properties in the test object description.
Method Sync Synchronizes the automation framework with the Siebel application.
Common Method ToString Returns a string that represents the current test object.
Common Method WaitProperty Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property ClassName The class of the object.
Property CurrentSiebScreen Returns the test object corresponding to the screen that is currently active.
Property CurrentSiebView Returns the test object corresponding to the view that is currently active.
Common Property Exist Checks whether the object currently exists in the open application.
Property RepositoryName The name of the object as it is stored in the repository.
Property UIName The name of the object as it appears in the user interface.

 

Back to top

GetBusyTime Method

Description

Returns the time (in milliseconds) it took Siebel Application Client to become idle when the Siebel Application UI changed from standard- to high-interactivity.

Syntax

object.GetBusyTime

Return Type

A long integer value.

IMPORTANT

The GetBusyTime method is executed asynchronously. That is, it is executed immediately after the previous statement, without waiting for the previous statement to complete. Therefore, an accurate response time is not returned by the GetBusyTime method until the previous operation and the GetBusyTime method have completed execution. For more information, see GetLastOpTime.

The GetBusyTime method is useful for measuring operations performed against standard-interactivity components within high-interactivity applications.

Example


 

Back to top

GetClassCount Method

Description

Returns the number of objects of the specified type.

Syntax

object.GetClassCount (ClassName)

Arguments

Parameter Description
ClassName Required. A String value.
The type of object to be counted.

Return Type

A long integer value.

Example


 

Back to top

GetLastErrorCode Method

Description

Returns the last error code issued.

Syntax

object.GetLastErrorCode

Return Type

A long integer value.

Example


 

Back to top

GetLastErrorMessage Method

Description

Returns the last error message issued.

Syntax

object.GetLastErrorMessage

Return Type

A String value.

Example


 

Back to top

GetLastOpId Method

Description

Returns the Id of the previous operation.

Syntax

object.GetLastOpId

Return Type

A String value.

Example


 

Back to top

GetLastOpTime Method

Description

Returns the time (in milliseconds) it took to execute the previous operation.

Syntax

object.GetLastOpTime

Return Type

A long integer value.

IMPORTANT

The GetLastOpTime method is executed synchronously. That is, it is executed after the previous statement has completed execution. For more information, see GetBusyTime method.

The GetLastOpTime method is useful for measuring operations such as navigating to a screen, raising a popup applet, and selecting a menu item.

Example


 

Back to top

GetRepositoryName Method

Description

Returns the RepositoryName of the object.

Syntax

object.GetRepositoryName (ClassName, UIName)

Arguments

Parameter Description
ClassName Required. A String value.
The ClassName of the child object.
UIName Required. A String value.
The UIName of the child object.

Return Type

A String value.

The repository name of the specified child object.

IMPORTANT

The specified object must be a direct child object of the SiebApplication object.


 

Back to top

GetRepositoryNameByIndex Method

Description

Returns the RepositoryName of the item with the specified index.

Syntax

object.GetRepositoryNameByIndex (ClassName, Index)

Arguments

Parameter Description
ClassName Required. A String value.
The ClassName of the object.
Index Required. A long integer value.
The index of the object in the value returned by the GetClassCount method.

Return Type

A String value.

Example


 

Back to top

GetSessionId Method

Description

Returns the Id of current session.

Syntax

object.GetSessionId

Return Type

A String value.

IMPORTANT

The returned string can be used to correlate the server-side Siebel ARM (Siebel Application Response Measurement) log files with the client operation Id. The Siebel ARM feature captures timing data useful for monitoring the performance of the Siebel application.

Example


 

Back to top

GotoScreen Method

Description

Navigates to the specified screen corresponding to the specified screen repository name.

Syntax

object.GotoScreen (Screen)

Arguments

Parameter Description
Screen Required. A String value.
The RepositoryName of the screen.

Return Type

None.

Example


 

Back to top

GotoView Method

Description

Navigates to the top-level view corresponding to the specified view repository name.

Syntax

object.GotoView (ViewName)

Arguments

Parameter Description
ViewName Required. A String value.
The RepositoryName of the View object.

Return Type

None.

Example


 

Back to top

ProcessKeyboardAccelerator Method

Description

Executes keyboard accelerators.

Syntax

object.ProcessKeyboardAccelerator (Keys)

Arguments

Parameter Description
Keys Required. A String value.
The accelerator keys to execute.

Return Type

None.

Example


 

Back to top

SetTimeOut Method

Description

Sets the maximum length of time (in seconds) that the test tool waits for the application to return from an operation before executing the next line of script. When timeout is exceeded, the test tool halts the script and displays an error.

Syntax

object.SetTimeOut (NewTimeOutInSecs)

Arguments

Parameter Description
NewTimeOutInSecs Required. A long integer value.
The number of seconds to wait before timing out.

Return Type

A long integer value.

Example


 

Back to top

Sync Method

Description

Synchronizes the automation framework with the Siebel application.

Syntax

object.Sync

Return Type

None.

Example


 

Back to top

ClassName Property

Description

The class of the object.

Syntax

object.ClassName

Value Type

A String value.

Property type

Read-only property

Example


 

Back to top

CurrentSiebScreen Property

Description

Returns the test object corresponding to the screen that is currently active.

Syntax

object.CurrentSiebScreen

Value Type

An Object.

Property type

Read-only property


 

Back to top

CurrentSiebView Property

Description

Returns the test object corresponding to the view that is currently active.

Syntax

object.CurrentSiebView

Value Type

An Object.

Property type

Read-only property


 

Back to top

RepositoryName Property

Description

The name of the object as it is stored in the repository.

Syntax

object.RepositoryName

Value Type

A String value.

Property type

Read-only property

Example


 

Back to top

UIName Property

Description

The name of the object as it appears in the user interface.

Syntax

object.UIName

Value Type

A String value.

Property type

Read-only property

Example


Back to top

See also: