SiebTaskAssistant Object

Description

The Task Assistant 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 SiebTaskAssistant object.

Note: You can also view a list and descriptions of the SiebTaskAssistant 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 DoneClicks the Return To link.
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 NextClicks the See additional steps 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 a task.
Method StepClicks the specified step.
Method StepViewClicks the View link for the specified step.
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 ActiveStepNumCloses the task list.
Property ActiveTaskThe name of the current task.
Property ActiveTaskIdThe Id 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 visible steps.
Property TaskCountThe number of tasks in the current list.
Property UINameThe name of the object as it 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 reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
End If

Back to top

 

Done Method

Description

Clicks the Return To link.

Syntax

object.Done

Return Type

None.

Example

                    'The following example reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
End If

Back to top

 

Next Method

Description

Clicks the See additional steps link.

Syntax

object.Next

Return Type

None.

Example

                    'The following example uses the Step method to select step 2 in the task assistant,
'and then uses the Next method to select the next step in the task assistant.
SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step "2"
SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Next

Back to top

 

Start Method

Description

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

Syntax

object.Start (TaskIndex)

Arguments

ParameterDescription
TaskIndex Required. A String value.
The Id of the task to start.

Return Type

None.

Example

                    'The following example reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
End If

Back to top

 

Step Method

Description

Clicks the specified step.

Syntax

object.Step (StepNum)

Arguments

ParameterDescription
StepNum Required. A String value.
The number of the step.

Return Type

None.

Example

                    'The following example reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
End If

Back to top

 

StepView Method

Description

Clicks the View link for the specified step.

Syntax

object.StepView (StepNum)

Arguments

ParameterDescription
StepNum Required. A String value.
The number of the step.

Return Type

None.

Example

                    'The following example reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
End If

Back to top

 

ActiveStepNum Property

Description

Closes the task list.

Syntax

object.ActiveStepNum

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
End If

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

Example

                    'The following example reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
End If

Back to top

 

ActiveTaskId Property

Description

The Id of the current task.

Syntax

object.ActiveTaskId

Value Type

A String value.

Property type

Read-only property

Example

                    'The following example reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
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

 

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 visible steps.

Syntax

object.StepCount

Value Type

A long integer value.

Property type

Read-only property

Example

                    'The following example reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
End If

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 reviews all of the steps of a task in the Siebel Call Center application.

' retrieve the total number of tasks available for the user
Dim MyTaskCount
MyTaskCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").taskCount
If MyTaskCount > 0 Then
        'start task number 1 from the TaskAssistant list
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Start ("1")
        'display information about the task in message boxes.
        MsgBox "Started task called  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTask
        MsgBox "The active task id  running now is -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveTaskId
        'go over each of the steps of the specified task and review them one at a time.
        Dim MyStepCount
        MyStepCount = SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").stepCount
        If (MyStepCount > 0) Then
                For i = 1 To MyStepCount
                   'select the specified step from steps list
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Step (CStr(i))
                    ' click the "View" link of the specified step
                    SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").StepView (CStr(i))
                    MsgBox "Finished performing step number  -  " + SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").ActiveStepNum
                Next
        End If
        ' When finished, click the return link to return to the list of all available tasks
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Done
        ' Close the task assistant list.
        SiebApplication("Siebel Call Center").SiebTaskAssistant("TaskAssistant").Close
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

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: