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 CaptureBitmapSaves a screen capture of the object as a .png or .bmp image, depending on the specified file extension.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the specified object property achieves the specified value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Method GetBusyTimeReturns the time (in milliseconds) it took Siebel Application Client to become idle when the Siebel Application UI changed from standard- to high-interactivity.
Method GetClassCountReturns the number of objects of the specified type.
Method GetLastErrorCodeReturns the last error code issued.
Method GetLastErrorMessageReturns the last error message issued.
Method GetLastOpIdReturns the Id of the previous operation.
Method GetLastOpTimeReturns the time (in milliseconds) it took to execute the previous operation.
Method GetRepositoryNameReturns the RepositoryName of the object.
Method GetRepositoryNameByIndexReturns the RepositoryName of the item with the specified index.
Common Method GetROPropertyReturns the current value of the specified description property from the object in the application.
Method GetSessionIdReturns the Id of current session.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method GotoScreenNavigates to the specified screen corresponding to the specified screen repository name.
Method GotoViewNavigates to the top-level view corresponding to the specified view repository name.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Method ProcessKeyboardAcceleratorExecutes keyboard accelerators.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Method SetTimeOutSets 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 SetTOPropertySets the value of the specified description property in the test object description.
Method SyncSynchronizes the automation framework with the Siebel application.
Common Method ToStringReturns a string that represents the current test object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Property ClassNameThe class of the object.
Property CurrentSiebScreenReturns the test object corresponding to the screen that is currently active.
Property CurrentSiebViewReturns the test object corresponding to the view that is currently active.
Common Property ExistChecks whether the object currently exists in the open application.
Property RepositoryNameThe name of the object as it is stored in the repository.
Property UINameThe 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

                    'navigate to the Accounts screen
SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
'navigate to the Accounts list view inside Accounts screen
SiebApplication("Siebel Call Center").GotoView "Account List View"
' show the application busy time and the last error that occurred
MsgBox "The application busy time is  " + CStr(SiebApplication("Siebel Call Center").GetBusyTime)
MsgBox "The last error code is " + CStr(SiebApplication("Siebel Call Center").GetLastErrorCode) + " and the error message is " + SiebApplication("Siebel Call Center").GetLastErrorMessage

Back to top

 

GetClassCount Method

Description

Returns the number of objects of the specified type.

Syntax

object.GetClassCount (ClassName)

Arguments

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

Return Type

A long integer value.

Example

                    'The following example uses the GetClassCount method to return the number
'of PageTab objects in the "Siebel Universal Agent" application, and
'then writes this information to the run results.

var_GetClassCount = SiebApplication("Siebel Universal Agent").GetClassCount("SiebPageTabs")
Reporter.ReportEvent 2, "Method  GetClassCount", "  returns  " & var_GetClassCount

Back to top

 

GetLastErrorCode Method

Description

Returns the last error code issued.

Syntax

object.GetLastErrorCode

Return Type

A long integer value.

Example

                    'navigate to the Accounts screen
SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
'navigate to the Accounts list view inside Accounts screen
SiebApplication("Siebel Call Center").GotoView "Account List View"
' show the application busy time and the last error that occurred
MsgBox "The application busy time is  " + CStr(SiebApplication("Siebel Call Center").GetBusyTime)
MsgBox "The last error code is " + CStr(SiebApplication("Siebel Call Center").GetLastErrorCode) + " and the error message is " + SiebApplication("Siebel Call Center").GetLastErrorMessage

Back to top

 

GetLastErrorMessage Method

Description

Returns the last error message issued.

Syntax

object.GetLastErrorMessage

Return Type

A String value.

Example

                    'navigate to the Accounts screen
SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
'navigate to the Accounts list view inside Accounts screen
SiebApplication("Siebel Call Center").GotoView "Account List View"
' show the application busy time and the last error that occurred
MsgBox "The application busy time is  " + CStr(SiebApplication("Siebel Call Center").GetBusyTime)
MsgBox "The last error code is " + CStr(SiebApplication("Siebel Call Center").GetLastErrorCode) + " and the error message is " + SiebApplication("Siebel Call Center").GetLastErrorMessage

Back to top

 

GetLastOpId Method

Description

Returns the Id of the previous operation.

Syntax

object.GetLastOpId

Return Type

A String value.

Example

                    'The following example uses the GetLastOpId method to return the operation
'ID of the operation previously performed in the "Siebel Universal Agent"
'application, and then writes this information to the run results.

var_GetLastOpId = SiebApplication("Siebel Universal Agent").GetLastOpId
Reporter.ReportEvent 2, "Method  GetLastOpId", "  returns  " & var_GetLastOpId

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

                    'The following example uses the GetLastOpTime method to return the time
'(in milliseconds) it took to execute the previous operation performed
'in the "Siebel Universal Agent" application, and then writes this
'information to the run results.

var_GetLastOpTime = SiebApplication("Siebel Universal Agent").GetLastOpTime
Reporter.ReportEvent 2, "Method GetLastOpTime", "  returns  " & var_GetLastOpTime

Back to top

 

GetRepositoryName Method

Description

Returns the RepositoryName of the object.

Syntax

object.GetRepositoryName (ClassName, UIName)

Arguments

ParameterDescription
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

ParameterDescription
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

                    'The following example uses the GetRepositoryNameByIndex method to return
'the repository name of the SiebScreen object with the index "0" in the
'"Siebel Universal Agent" application, and then writes this information to
'the run results.

var_GetRepositoryNameByIndex = SiebApplication("Siebel Universal Agent").GetRepositoryNameByIndex("SiebScreen", 0)
Reporter.ReportEvent 2, "Method GetRepositoryNameByIndex  ", "  returns for SiebScreen  " & var_GetRepositoryNameByIndex

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

                    'The following example uses the GetSessionId method to return the session
'ID of the current session in the "Siebel Universal Agent" application,
'and then writes this information to the run results.

var_GetSessionId = SiebApplication("Siebel Universal Agent").GetSessionId
'SiebApplication("Siebel Universal Agent").
Reporter.ReportEvent 2, "Method GetSessionId", "  returns  " & var_GetSessionId

Back to top

 

GotoScreen Method

Description

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

Syntax

object.GotoScreen (Screen)

Arguments

ParameterDescription
Screen Required. A String value.
The RepositoryName of the screen.

Return Type

None.

Example

                    'navigate to the Accounts screen
SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
'navigate to the Accounts list view inside Accounts screen
SiebApplication("Siebel Call Center").GotoView "Account List View"
' show the application busy time and the last error that occurred
MsgBox "The application busy time is  " + CStr(SiebApplication("Siebel Call Center").GetBusyTime)
MsgBox "The last error code is " + CStr(SiebApplication("Siebel Call Center").GetLastErrorCode) + " and the error message is " + SiebApplication("Siebel Call Center").GetLastErrorMessage

Back to top

 

GotoView Method

Description

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

Syntax

object.GotoView (ViewName)

Arguments

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

Return Type

None.

Example

                    'navigate to the Accounts screen
SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
'navigate to the Accounts list view inside Accounts screen
SiebApplication("Siebel Call Center").GotoView "Account List View"
' show the application busy time and the last error that occurred
MsgBox "The application busy time is  " + CStr(SiebApplication("Siebel Call Center").GetBusyTime)
MsgBox "The last error code is " + CStr(SiebApplication("Siebel Call Center").GetLastErrorCode) + " and the error message is " + SiebApplication("Siebel Call Center").GetLastErrorMessage

Back to top

 

ProcessKeyboardAccelerator Method

Description

Executes keyboard accelerators.

Syntax

object.ProcessKeyboardAccelerator (Keys)

Arguments

ParameterDescription
Keys Required. A String value.
The accelerator keys to execute.

Return Type

None.

Example

                    'The following example uses the ProcessKeyboardAccelerator method to press
'the CTRL+B accelerator keys in the "Siebel Universal Agent" application.

SiebApplication("Siebel Universal Agent").ProcessKeyboardAccelerator "Ctrl+B"

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

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

Return Type

A long integer value.

Example

                    'The following example uses the SetTimeOut method to instruct Siebel
'to wait 10 seconds before returning an error from an operation.

var_SetTimeOut = SiebApplication("Siebel Universal Agent").SetTimeOut(10)

Back to top

 

Sync Method

Description

Synchronizes the automation framework with the Siebel application.

Syntax

object.Sync

Return Type

None.

Example

                    'The following example uses the Sync method to synchronize the automation
'framework with the "Siebel Universal Agent" application after the previous
'operation.

var_GetTOProperty = SiebApplication("Siebel Universal Agent").GetTOProperty("classname")
Reporter.ReportEvent 2, "Method  GetTOProperty", "  returns  new value  " & var_GetTOProperty
SiebApplication("Siebel Universal Agent").Sync

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

                    'The following example uses the UIName and ClassName properties to display this
'information for all child objects of the Siebel Call Center application.

'Retrieve all the children of the siebel application object
Set MyDescription = Description.Create()
Set MyChildren = SiebApplication("Siebel Call Center").ChildObjects(MyDescription)
childCount = MyChildren.Count
'Display the UI names and classes for each object.
For i = 0 To childCount - 1
    MsgBox MyChildren(i).UIName + "  object of class   " + MyChildren(i).ClassName
Next

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

                    'The following example finds all the objects in the Daily Calendar with the same
'classname as a specified SiebPickList object and then displays the Repository
'name of each of these objects.

Set MyDescription = Description.Create()
MyDescription("classname").Value = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").SiebPicklist("SiebPicklist").ClassName
Set MyChildren = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").ChildObjects(MyDescription)
childCount = MyChildren.Count
' now we show test object names
For i = 0 To childCount - 1
        MsgBox MyChildren(i).RepositoryName
Next

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

                    'The following example finds all the objects in the Daily Calendar with the same
'classname as a specified SiebPickList object and then displays the Repository
'name of each of these objects.

Set MyDescription = Description.Create()
MyDescription("classname").Value = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").SiebPicklist("SiebPicklist").ClassName
Set MyChildren = SiebApplication("Siebel Call Center").SiebScreen("Home").SiebView("Siebel Web Call Center").SiebApplet("Daily Calendar").ChildObjects(MyDescription)
childCount = MyChildren.Count
' now we show test object names
For i = 0 To childCount - 1
        MsgBox MyChildren(i).RepositoryName
Next

Back to top

See also: