SiebScreenViews Object

Description

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

Note: You can also view a list and descriptions of the SiebScreenViews 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 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 GetUINameReturns the UIName (display name in the user interface) of the object.
Method GotoNavigates to a screen view.
Method IsExistsIndicates whether the specified object exists.
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 ActiveViewThe RepositoryName of the active View, as represented by the active Aggregate Category link.
Property ClassNameThe class of the object.
Common Property ExistChecks whether the object currently exists in the open application.
Property L2CountThe number of second-level screen views on the current screen.
Property L3CountThe number of third-level screen views on the current screen.
Property L4CountThe number of fourth-level screen views on the current screen.
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

 

GetRepositoryName Method

Description

Returns the RepositoryName of the object.

Syntax

object.GetRepositoryName (ViewUIName, Level)

Arguments

ParameterDescription
ViewUIName Required. A String value.
The UIName of the View object.
Level Required. A String value.
The level (L2, L3, or L4) of the View object.

Return Type

A String value.

The repository name of the specified View object.

Example

                    'The following example uses the GetRepositoryName method to select a
'predefined view at specific level, if the view was not already active.

var_MoreInfoViewRN = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").GetRepositoryName("More Info", "L3")
var_curActiveViewRN = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").ActiveView
If var_curActiveViewRN <> var_MoreInfoViewRN Then
    SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").Goto (var_MoreInfoViewRN), "L3"
    Else
    Reporter.ReportEvent 0, "", "SiebView MoreInfo already active"
End If

Back to top

 

GetRepositoryNameByIndex Method

Description

Returns the RepositoryName of the item with the specified index.

Syntax

object.GetRepositoryNameByIndex (Index, Level)

Arguments

ParameterDescription
Index Required. A long integer value.
The index of the object in the appropriate Count property (L2Count, L3Count, or L4Count).
Level Required. A String value.
The level (L2, L3, or L4) of the object.

Return Type

A String value.

Example

                    'The following example uses the GetRepositoryNameByIndex method to
'enumerate through all views at level 3 and place their UINames in
'the Data Pane.

'create sheet and column for UINames
var_ParamName = DataTable.AddSheet("MySheet").AddParameter("Views_UIName", "").Name
var_L3Count = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").l3count
For i = 0 To var_L3Count - 1
    var_L3ViewRN = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").GetRepositoryNameByIndex(i, "L3")
    ' to call object properties we need to open the view
    SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").Goto (var_L3ViewRN), "L3"
    'programmatically create the SiebView object to call its UIName property
    Set MyDescription = Description.Create()
    MyDescription("ClassName").Value = "SiebView"
    MyDescription("RepositoryName").Value = var_L3ViewRN
    ' Set RegularExpression flag to FALSE, because we want the repository name "as is" and often it contains different characters, which may be interpreted as RegExp symbols
   MyDescription("RepositoryName").RegularExpression = False
   DataTable.GetSheet("MySheet").SetCurrentRow (i + 1)
   DataTable.Value("Views_UIName", "MySheet") = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebView(MyDescription).UIName()
Next

Back to top

 

GetUIName Method

Description

Returns the UIName (display name in the user interface) of the object.

Syntax

object.GetUIName (ViewRepositoryName, Level)

Arguments

ParameterDescription
ViewRepositoryName Required. A String value.
The RepositoryName of the object.
Level Required. A String value.
The level (L2, L3, or L4) of the object.

Return Type

A String value.

Example

 
' The following example retrieves the repository name of the specified view, navigates to it, and shows the Level 4 View.
    
Dim reposName
reposName = SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetRepositoryName("Body", "L3")
If SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").IsExists(reposName, "L3") Then
        MsgBox "Navigating to view    " + SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetUIName(reposName, "L3")
        SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").Goto reposName, "L3"
End If
    'Show the Level 4 screen view
    MsgBox SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").L4Count

Back to top

 

Goto Method

Description

Navigates to a screen view.

Syntax

object.Goto (View, Level)

Arguments

ParameterDescription
View Required. A String value.
The name of the screen view.
Level Required. A String value.
The level (L2, L3, or L4) of the screen view.

Return Type

None.

Example

                    'The following example uses the Goto method to select a predefined view at
'specific level, if the view was not already active.

var_MoreInfoViewRN = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").GetRepositoryName("More Info", "L3")
var_curActiveViewRN = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").ActiveView
If var_curActiveViewRN <> var_MoreInfoViewRN Then
    SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").Goto (var_MoreInfoViewRN), "L3"
    Else
    Reporter.ReportEvent 0, "", "SiebView MoreInfo already active"
End If
 
' The following example retrieves the repository name of the specified view, navigates to it, and shows the Level 4 View.
    
Dim reposName
reposName = SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetRepositoryName("Body", "L3")
If SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").IsExists(reposName, "L3") Then
        MsgBox "Navigating to view    " + SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetUIName(reposName, "L3")
        SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").Goto reposName, "L3"
End If
    'Show the Level 4 screen view
    MsgBox SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").L4Count

Back to top

 

IsExists Method

Description

Indicates whether the specified object exists.

Syntax

object.IsExists (ViewRepositoryName, Level)

Arguments

ParameterDescription
ViewRepositoryName Required. A String value.
The RepositoryName of the screen view.
Level Required. A String value.
The level (L2, L3, or L4) of the screen view.

Return Type

A long integer value.

Example

 
' The following example retrieves the repository name of the specified view, navigates to it, and shows the Level 4 View.
    
Dim reposName
reposName = SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetRepositoryName("Body", "L3")
If SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").IsExists(reposName, "L3") Then
        MsgBox "Navigating to view    " + SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetUIName(reposName, "L3")
        SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").Goto reposName, "L3"
End If
    'Show the Level 4 screen view
    MsgBox SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").L4Count

Back to top

 

ActiveView Property

Description

The RepositoryName of the active View, as represented by the active Aggregate Category link.

Syntax

object.ActiveView

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the ActiveView property to check whether a
'specific view is active, and if not, select it.

var_MoreInfoViewRN = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").GetRepositoryName("More Info", "L3")
var_curActiveViewRN = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").ActiveView
If var_curActiveViewRN <> var_MoreInfoViewRN Then
    SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").Goto (var_MoreInfoViewRN), "L3"
    Else
    Reporter.ReportEvent 0, "", "SiebView MoreInfo already active"
End If

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

 

L2Count Property

Description

The number of second-level screen views on the current screen.

Syntax

object.L2Count

Value Type

A long integer value.

Property type

Read-only property

Example

                    ''The following example uses the L2Count property to enumerate through all
'views at level 2 and place their UINames in the Data pane.

' this examples enumerates all views of third level and puts their UINames to DataTable.
'create sheet and column for UINames
var_ParamName = DataTable.AddSheet("MySheet").AddParameter("Views_UIName", "").Name
var_L2Count = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").L2Count
For i = 0 To var_L2Count - 1
    var_L2ViewRN = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").GetRepositoryNameByIndex(i, "L2")
    ' to call object properties we need to open the view
    SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebScreenViews("ScreenViews").Goto (var_L2ViewRN), "L2"
    ' create programmatically the SiebView object to call its UIName property
    Set MyDescription = Description.Create()
    MyDescription("ClassName").Value = "SiebView"
    MyDescription("RepositoryName").Value = var_L2ViewRN
    ' Set RegularExpression flag to FALSE, because we want the repository name "as is" and often it contains different characters, which may be interpreted as RegExp symbols
   MyDescription("RepositoryName").RegularExpression = False
   DataTable.GetSheet("MySheet").SetCurrentRow (i + 1)
   DataTable.Value("Views_UIName", "MySheet") = SiebApplication("Siebel Call Center").SiebScreen("Orders").SiebView(MyDescription).UIName()
Next

Back to top

 

L3Count Property

Description

The number of third-level screen views on the current screen.

Syntax

object.L3Count

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example shows all repository names of the L3 level screen views.

Dim L3_count, reposName
L3_count = SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").l3count
For i = 0 To L3_count - 1
    reposName = SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetRepositoryNameByIndex(i, "L3")
    MsgBox reposName
Next

Back to top

 

L4Count Property

Description

The number of fourth-level screen views on the current screen.

Syntax

object.L4Count

Value Type

A long integer value.

Property type

Read-only property

Example

 
' The following example retrieves the repository name of the specified view, navigates to it, and shows the Level 4 View.
    
Dim reposName
reposName = SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetRepositoryName("Body", "L3")
If SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").IsExists(reposName, "L3") Then
        MsgBox "Navigating to view    " + SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").GetUIName(reposName, "L3")
        SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").Goto reposName, "L3"
End If
    'Show the Level 4 screen view
    MsgBox SiebApplication("Siebel Call Center").SiebScreen("Communications").SiebScreenViews("ScreenViews").L4Count

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: