Share this page
SAPPortal Object
Description
An SAP Enterprise Portal desktop.
IMPORTANT
This object represents the top navigation bar and the detailed navigation bar in an SAP Portal desktop.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPPortal object.
Note: You can also view a list and descriptions of the SAPPortal 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
 CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image using the specified file name. |
| Check | Checks whether the actual value of an item matches the expected value. |
| CheckProperty | Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout. |
| ChildObjects | Returns the collection of child objects contained within the object. |
| GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
 DetailedNavigation | Navigates the Detailed Navigation iView in the navigation panel. |
| GetROProperty | Returns the current value of the description property from the object in the application. |
| GetTOProperties | Returns the collection of properties and values used to identify the object. |
| GetTOProperty | Returns the value of the specified description property from the test object description. |
| Highlight | Highlights the object in the application. |
| Navigate | Navigates the tabs in the top-level navigation bar. |
| Output | Retrieves the current value of an item and stores it in a specified location. |
| RefreshObject | Instructs UFT One to re-identify the object in the application the next time a step refers to this object. |
| Search | Searches the SAP Enterprise Portal desktop. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| Sync | Waits for the browser to complete the current navigation. |
| ToString | Returns a string that represents the test object. |
| WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
 Exist | Checks whether the object currently exists in the open application. |
| Object | Accesses the native methods and properties of the object. |
DetailedNavigation Method
Description
Navigates the Detailed Navigation iView in the navigation panel.
Syntax
object.DetailedNavigation (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the tab item, separated by semicolons (;). You can use either the tab name, or its index. For example, TabName;SubTabName or #1;#2.
Index values begin with 1.
|
Return Type
None.
Example
Navigate Using the Detailed Navigation Bar (VBScript)
'The following example uses the DetailedNavigation method to navigate to the "Stock Overview" iView
'using the Detailed Navigation bar.
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Navigate "Inventory Controlling"
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").DetailedNavigation "Stock Overview"
Navigate Method
Description
Navigates the tabs in the top-level navigation bar.
Syntax
object.Navigate (Path)
Arguments
| Parameter | Description |
|---|---|
| Path |
Required. A String value.
The path of the node, separated by semicolons (;). You can use either the node name, or its index. For example, NodeName;SubNodeName or #1;#2.
Index values begin with 1.
|
Return Type
None.
IMPORTANT
If the tabs are not in view, they are brought into view.
Example
Navigate Using the Top Level Navigation Bar (VBScript)
'The following example uses the Navigate method to navigate to the "Inventory Controlling" iView
'using the top-level navigation bar.
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Navigate "Inventory Controlling"
Search Method
Description
Searches the SAP Enterprise Portal desktop.
Syntax
object.Search (Query)
Arguments
| Parameter | Description |
|---|---|
| Query |
Required. A String value. The query to submit in the Portal search field. |
Return Type
None.
Example
Search for Specified Text in the SAP Enterprise Portl (VBScript)
'The following example uses the Search method to search for "Meaning of Life" in the SAP Enterprise Portal.
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Navigate "Inventory Controlling"
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").DetailedNavigation "Stock Overview"
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Search "meaning of life"
Browser("SAP Enterprise Portal_2").Page("SAP Enterprise Portal").Sync
Browser("SAP Enterprise Portal_2").Page("SAP Enterprise Portal").WebElement("No results have been found").Check CheckPoint("No results have been found")
Sync Method
Description
Waits for the browser to complete the current navigation.
Syntax
object.Sync
Return Type
None
Example
Synchronize the SAP Enterprise Portal Desktop (VBScript)
'The following example uses the Sync method to synchronize the SAP Enterprise Portal Desktop
'after performing a search and before displaying the search results.
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Search "meaning of life"
Browser("SAP Enterprise Portal_2").Page("SAP Enterprise Portal").Sync
Browser("SAP Enterprise Portal_2").Page("SAP Enterprise Portal").WebElement("No results have been found").Check CheckPoint("No results have been found")
See also:
