SiebScreen Object

Description

A screen object 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 SiebScreen object.

Note: You can also view a list and descriptions of the SiebScreen 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 GetClassCountReturns the number of objects of the specified type.
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.
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 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.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application the next time a step refers to this object.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
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 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

 

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 retrieve the
'number of views in the current screen, and then check whether the expected
'repository name matches the repository name of the active view.

SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
var_count = SiebApplication("Siebel Call Center").CurrentSiebScreen.GetClassCount("SiebView")
For i = 0 To var_count - 1
var_ViewRN = SiebApplication("Siebel Call Center").CurrentSiebScreen.GetRepositoryNameByIndex("SiebView", i)
   SiebApplication("Siebel Call Center").CurrentSiebScreen.GotoView var_ViewRN
    var_curViewRN = SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.RepositoryName
   If var_curAppletRN = var_AppletRN Then
    Reporter.ReportEvent 0, "Success ", "The application is opened on View " & SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.UIName & "  with active applet " & (i + 1) & " from " & var_count & " applets on the screen"
    Else
    Reporter.ReportEvent 1, "Fail ", "The application is not opened on View " & SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.UIName & "  with active applet " & (i + 1) & " from " & var_count & " applets on the screen"
   End If
Next

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 SiebScreen object.

Example

'The following example finds the repository name of one view,
'navigates to the home view, and then navigates back to the original view
'based on the previously saved repository name

Dim reposName
reposName = SiebApplication("Siebel Call Center").SiebScreen("Accounts").GetRepositoryName("SiebView", "My Accounts")
SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoView "Account Screen Homepage View"
SiebApplication("Siebel Call Center").SiebScreen("Accounts").GotoView (reposName)

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
'enumerate through the views in the current screen and check whether
'the expected repository name matches the expected name of the active view.

SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
var_count = SiebApplication("Siebel Call Center").CurrentSiebScreen.GetClassCount("SiebView")
For i = 0 To var_count - 1
var_ViewRN = SiebApplication("Siebel Call Center").CurrentSiebScreen.GetRepositoryNameByIndex("SiebView", i)
   SiebApplication("Siebel Call Center").CurrentSiebScreen.GotoView var_ViewRN
    var_curViewRN = SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.RepositoryName
   If var_curAppletRN = var_AppletRN Then
    Reporter.ReportEvent 0, "Success ", "The application is opened on View " & SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.UIName & "  with active applet " & (i + 1) & " from " & var_count & " applets on the screen"
    Else
    Reporter.ReportEvent 1, "Fail ", "The application is not opened on View " & SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.UIName & "  with active applet " & (i + 1) & " from " & var_count & " applets on the screen"
   End If
Next

Back to top

 

GotoView Method

Description

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

Syntax

object.GotoView (View)

Arguments

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

Return Type

None.

Example

                    'The following example uses the GotoView method to enumerate through the
'views in the current screen and select a specific view according to its
'repository name.

SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
var_count = SiebApplication("Siebel Call Center").CurrentSiebScreen.GetClassCount("SiebView")
For i = 0 To var_count - 1
var_ViewRN = SiebApplication("Siebel Call Center").CurrentSiebScreen.GetRepositoryNameByIndex("SiebView", i)
   SiebApplication("Siebel Call Center").CurrentSiebScreen.GotoView var_ViewRN
    var_curViewRN = SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.RepositoryName
   If var_curAppletRN = var_AppletRN Then
    Reporter.ReportEvent 0, "Success ", "The application is opened on View " & SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.UIName & "  with active applet " & (i + 1) & " from " & var_count & " applets on the screen"
    Else
    Reporter.ReportEvent 1, "Fail ", "The application is not opened on View " & SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.UIName & "  with active applet " & (i + 1) & " from " & var_count & " applets on the screen"
   End If
Next
'The following example finds the repository name of one view,
'navigates to the home view, and then navigates back to the original view
'based on the previously saved repository name

Dim reposName
reposName = SiebApplication("Siebel Call Center").SiebScreen("Accounts").GetRepositoryName("SiebView", "My Accounts")
SiebApplication("Siebel Call Center").SiebPageTabs("PageTabs").GotoView "Account Screen Homepage View"
SiebApplication("Siebel Call Center").SiebScreen("Accounts").GotoView (reposName)

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

 

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

Example

                    'The following example uses the CurrentSiebView property to retrieve the
'repository name of the current view and compare it with the expected
'name.

SiebApplication("Siebel Call Center").GotoScreen "Accounts Screen"
var_count = SiebApplication("Siebel Call Center").CurrentSiebScreen.GetClassCount("SiebView")
For i = 0 To var_count - 1
var_ViewRN = SiebApplication("Siebel Call Center").CurrentSiebScreen.GetRepositoryNameByIndex("SiebView", i)
   SiebApplication("Siebel Call Center").CurrentSiebScreen.GotoView var_ViewRN
    var_curViewRN = SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.RepositoryName
   If var_curAppletRN = var_AppletRN Then
    Reporter.ReportEvent 0, "Success ", "The application is opened on View " & SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.UIName & "  with active applet " & (i + 1) & " from " & var_count & " applets on the screen"
    Else
    Reporter.ReportEvent 1, "Fail ", "The application is not opened on View " & SiebApplication("Siebel Call Center").CurrentSiebScreen.CurrentSiebView.UIName & "  with active applet " & (i + 1) & " from " & var_count & " applets on the screen"
   End If
Next

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

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: