SiebCommunicationsToolbar Object

Description

The communications toolbar 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 SiebCommunicationsToolbar object.

Note: You can also view a list and descriptions of the SiebCommunicationsToolbar 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 ClickClicks the specified button.
Method GetButtonStateReturns a String that The state of the specified button (for example, Blinking).
Method GetButtonTooltipReturns a String that The tooltip for the specified button.
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.
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.
Method SelectWorkItemSelects the specified work item.
Method SetTextEnters text in the textbox.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Method ShowButtonTooltipDisplays the tooltip for the specified button.
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 CurrentWorkItemThe currently selected work item.
Common Property ExistChecks whether the object currently exists in the open application.
Property IsEnabledIndicates whether the object is enabled.
Property IsVisibleIndicates whether the object is visible.
Property MediaTypeThe type of media.
Property MessageThe communication channel information displayed next to the Siebel menu that indicates where the message comes from (for example, Call Display).
Property RepositoryNameThe name of the object as it is stored in the repository.
Property TextThe text value of the object.
Property UINameThe name of the object as it appears in the user interface.
Property WorkItemDurationThe duration of the currently selected work item.

Back to top

 

Click Method

Description

Clicks the specified button.

Syntax

object.Click (ButtonName)

Arguments

ParameterDescription
ButtonName Required. A String value.
The RepositoryName of the button.

Return Type

None.

Example

                    'The following example checks whether a toolbar button is enabled and visible before clicking it.

                    Dim toolbarName, buttonState, buttonTooltip
 If (SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsEnabled And SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsVisible) Then
        ' get toolbar repository name
        toolbarName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").CurrentWorkItem
        duration = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").WorkItemDuration
        buttonState = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonState(toobarName)
        buttonTooltip = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonTooltip(toolbarName)
        MsgBox "The state of the button " + buttonTooltip + " is " + buttonState
        ' If the toolbar has the desired state, click the toolbar button.
        SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").Click (toobarName)
 End If

Back to top

 

GetButtonState Method

Description

Returns a String that The state of the specified button (for example, Blinking).

Syntax

object.GetButtonState (ButtonName)

Arguments

ParameterDescription
ButtonName Required. A String value.
The RepositoryName of the button.

Return Type

A String value.

The state of the specified button (for example, Blinking).

Example

                    'The following example checks whether a toolbar button is enabled and visible before clicking it.

                    Dim toolbarName, buttonState, buttonTooltip
 If (SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsEnabled And SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsVisible) Then
        ' get toolbar repository name
        toolbarName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").CurrentWorkItem
        duration = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").WorkItemDuration
        buttonState = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonState(toobarName)
        buttonTooltip = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonTooltip(toolbarName)
        MsgBox "The state of the button " + buttonTooltip + " is " + buttonState
        ' If the toolbar has the desired state, click the toolbar button.
        SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").Click (toobarName)
 End If

Back to top

 

GetButtonTooltip Method

Description

Returns a String that The tooltip for the specified button.

Syntax

object.GetButtonTooltip (ButtonName)

Arguments

ParameterDescription
ButtonName Required. A String value.
The RepositoryName of the button.

Return Type

A String value.

The tooltip for the specified button.

Example

                    'The following example checks whether a toolbar button is enabled and visible before clicking it.

                    Dim toolbarName, buttonState, buttonTooltip
 If (SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsEnabled And SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsVisible) Then
        ' get toolbar repository name
        toolbarName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").CurrentWorkItem
        duration = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").WorkItemDuration
        buttonState = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonState(toobarName)
        buttonTooltip = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonTooltip(toolbarName)
        MsgBox "The state of the button " + buttonTooltip + " is " + buttonState
        ' If the toolbar has the desired state, click the toolbar button.
        SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").Click (toobarName)
 End If

Back to top

 

SelectWorkItem Method

Description

Selects the specified work item.

Syntax

object.SelectWorkItem (Item)

Arguments

ParameterDescription
Item Required. A long integer value.
The WorkItem to select.

Return Type

None.

Example

                    'The following example uses the SelectWorkItem method to select the CommunicationsToolbar object as the currently selected work item,
'and then it uses the SetText method to enter text into the its textbox.
    
    SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").SelectWorkItem "CommuniationsToolbar"
    SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").SetText "Communications"

Back to top

 

SetText Method

Description

Enters text in the textbox.

Syntax

object.SetText (Text)

Arguments

ParameterDescription
Text Required. A String value.
The text to enter.

Return Type

None.

Example

                    'The following example uses the SelectWorkItem method to select the CommunicationsToolbar object as the currently selected work item,
'and then it uses the SetText method to enter text into the its textbox.
    
    SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").SelectWorkItem "CommuniationsToolbar"
    SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").SetText "Communications"

Back to top

 

ShowButtonTooltip Method

Description

Displays the tooltip for the specified button.

Syntax

object.ShowButtonTooltip (ButtonName)

Arguments

ParameterDescription
ButtonName Required. A String value.
The RepositoryName of the button.

Return Type

None.

IMPORTANT

This event is significant because the CommunicationsToolbar tooltip is dynamic, causing a roundtrip to the server.

Example

                    'The following example uses the CurrentWorkItem property to retrieve the currently selected work item,
'and then it uses the ShowButtonTooltip to displays the work item's tooltip.
    itemName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").CurrentWorkItem
    SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").ShowButtonTooltip (itemName)

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

 

CurrentWorkItem Property

Description

The currently selected work item.

Syntax

object.CurrentWorkItem

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the CurrentWorkItem property to retrieve the name of the currently selected work item,
'and then it uses the WorkItemDuration property to retrieve the duration of that work item.

    itemName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").CurrentWorkItem
    duration = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").WorkItemDuration
    MsgBox "The duration of the item named " + itemName + " is " + duration

Back to top

 

IsEnabled Property

Description

Indicates whether the object is enabled.

Syntax

object.IsEnabled

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example checks whether a toolbar button is enabled and visible before clicking it.

                    Dim toolbarName, buttonState, buttonTooltip
 If (SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsEnabled And SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsVisible) Then
        ' get toolbar repository name
        toolbarName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").CurrentWorkItem
        duration = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").WorkItemDuration
        buttonState = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonState(toobarName)
        buttonTooltip = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonTooltip(toolbarName)
        MsgBox "The state of the button " + buttonTooltip + " is " + buttonState
        ' If the toolbar has the desired state, click the toolbar button.
        SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").Click (toobarName)
 End If

Back to top

 

IsVisible Property

Description

Indicates whether the object is visible.

Syntax

object.IsVisible

Value Type

A long integer value.

Property type

Read-only property

IMPORTANT

You cannot checkpoint this property because the control is not rendered by the browser when it is not visible. However, you can manually write script code to check the property.

Example

                    'The following example checks whether a toolbar button is enabled and visible before clicking it.

                    Dim toolbarName, buttonState, buttonTooltip
 If (SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsEnabled And SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsVisible) Then
        ' get toolbar repository name
        toolbarName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").CurrentWorkItem
        duration = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").WorkItemDuration
        buttonState = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonState(toobarName)
        buttonTooltip = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonTooltip(toolbarName)
        MsgBox "The state of the button " + buttonTooltip + " is " + buttonState
        ' If the toolbar has the desired state, click the toolbar button.
        SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").Click (toobarName)
 End If

Back to top

 

MediaType Property

Description

The type of media.

Syntax

object.MediaType

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the Message property to retrieve the communication channel,
'and then it uses the MediaType property to retrieve the media type of that channel.

    channelInfo = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").Message
    MediaType = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").MediaType
    MsgBox "The message of a media type " + MediaType + " comes from communication channel " + channelInfo

Back to top

 

Message Property

Description

The communication channel information displayed next to the Siebel menu that indicates where the message comes from (for example, Call Display).

Syntax

object.Message

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the Message property to retrieve the communication channel,
'and then it uses the MediaType property to retrieve the media type of that channel.

    channelInfo = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").Message
    MediaType = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").MediaType
    MsgBox "The message of a media type " + MediaType + " comes from communication channel " + channelInfo

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

 

Text Property

Description

The text value of the object.

Syntax

object.Text

Value Type

A String value.

The RepositoryName of the toolbar.

Property type

Read-only property

Example

                    'The following example checks whether a toolbar button is enabled and visible before clicking it.

                    Dim toolbarName, buttonState, buttonTooltip
 If (SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsEnabled And SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").IsVisible) Then
        ' get toolbar repository name
        toolbarName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").CurrentWorkItem
        duration = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").WorkItemDuration
        buttonState = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonState(toobarName)
        buttonTooltip = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").GetButtonTooltip(toolbarName)
        MsgBox "The state of the button " + buttonTooltip + " is " + buttonState
        ' If the toolbar has the desired state, click the toolbar button.
        SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommunicationsToolbar").Click (toobarName)
 End If

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

Back to top

 

WorkItemDuration Property

Description

The duration of the currently selected work item.

Syntax

object.WorkItemDuration

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example uses the CurrentWorkItem property to retrieve the name of the currently selected work item,
'and then it uses the WorkItemDuration property to retrieve the duration of that work item.

    itemName = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").CurrentWorkItem
    duration = SiebApplication("Siebel Call Center").SiebCommunicationsToolbar("CommuniationsToolbar").WorkItemDuration
    MsgBox "The duration of the item named " + itemName + " is " + duration

Back to top

See also: