SiebTaskUIPane Object

Description

The task UI pane 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 SiebTaskUIPane object.

Note: You can also view a list and descriptions of the SiebTaskUIPane 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 CloseCloses the task list
Method GetClassCountReturns the number of objects of the specified class type.
Method GetRepositoryNameByIndexReturns the RepositoryName of the specified object.
Common Method GetROPropertyReturns the current value of the specified description property from the object in the application.
Method GetStepByIndexReturns the visible text of the specified step.
Method GetTaskByIndexReturns the visible text of the specified task.
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 GotoInboxClicks the Go to Inbox link.
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.
Method StartClicks the link of the specified task to start that task.
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 ActiveTaskThe name of the current task.
Property ClassNameThe class of the object.
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 StepCountThe number of steps in the current task.
Property TaskCountThe number of tasks in the current list.
Property UINameThe name of the object as it is appears in the user interface.

Back to top

 

Close Method

Description

Closes the task list

Syntax

object.Close

Return Type

None.

Example

                    'The following example iterates through all the tasks available for the current
'view and displays the name of each one in a message box.

Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").taskCount
If (MyTaskCount > 0) Then
        For i = 1 To MyTaskCount
            MsgBox SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").GetTaskByIndex(i)
        Next
End If
' When finished, close the task list
SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").GotoInbox
SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").Close

Back to top

 

GetClassCount Method

Description

Returns the number of objects of the specified class 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.

Back to top

 

GetRepositoryNameByIndex Method

Description

Returns the RepositoryName of the specified object.

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.

Back to top

 

GetStepByIndex Method

Description

Returns the visible text of the specified step.

Syntax

object.GetStepByIndex (Index)

Arguments

ParameterDescription
Index Required. A long integer value.
The index of the task.

Return Type

A String value.

Back to top

 

GetTaskByIndex Method

Description

Returns the visible text of the specified task.

Syntax

object.GetTaskByIndex (Index)

Arguments

ParameterDescription
Index Required. A long integer value.
The index of the task.

Return Type

A String value.

Example

                    'The following example iterates through all the tasks available for the current
'view and displays the name of each one in a message box.

Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").taskCount
If (MyTaskCount > 0) Then
        For i = 1 To MyTaskCount
            MsgBox SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").GetTaskByIndex(i)
        Next
End If
' When finished, close the task list
SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").GotoInbox
SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").Close

Back to top

 

GotoInbox Method

Description

Clicks the Go to Inbox link.

Syntax

object.GotoInbox

Return Type

None.

Example

                    'The following example iterates through all the tasks available for the current
'view and displays the name of each one in a message box.

Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").taskCount
If (MyTaskCount > 0) Then
        For i = 1 To MyTaskCount
            MsgBox SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").GetTaskByIndex(i)
        Next
End If
' When finished, close the task list
SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").GotoInbox
SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").Close

Back to top

 

Start Method

Description

Clicks the link of the specified task to start that task.

Syntax

object.Start (TaskName, TaskGroup)

Arguments

ParameterDescription
TaskName Required. A String value.
The RepositoryName of the task.
TaskGroup Required. A String value.
The group to which the task belongs.

Return Type

None.

Back to top

 

ActiveTask Property

Description

The name of the current task.

Syntax

object.ActiveTask

Value Type

A String value.

Property type

Read-only property

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

 

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

 

StepCount Property

Description

The number of steps in the current task.

Syntax

object.StepCount

Value Type

A long integer value.

Property type

Read-only property

Back to top

 

TaskCount Property

Description

The number of tasks in the current list.

Syntax

object.TaskCount

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example iterates through all the tasks available for the current
'view and displays the name of each one in a message box.

Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").taskCount
If (MyTaskCount > 0) Then
        For i = 1 To MyTaskCount
            MsgBox SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").GetTaskByIndex(i)
        Next
End If
' When finished, close the task list
SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").GotoInbox
SiebApplication("Siebel Call Center").SiebTaskUIPane("TaskUIPane").Close

Back to top

 

UIName Property

Description

The name of the object as it is 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: