Share this page
SAPiView Object
Description
An SAP Enterprise Portal application iView frame.
Operations
The sections below list the built-in methods and properties that you can use as operations for the SAPiView object.
Note: You can also view a list and descriptions of the SAPiView 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. |
| 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. |
 Maximize | Maximizes the iView frame. |
| Minimize | Minimizes the iView frame. |
| 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. |
| RunScript | Runs the specified JavaScript. |
| RunScriptFromFile | Runs the JavaScript stored in the specified file. |
| SelectMenuItem | Selects an item from the iView menu. |
| SetTOProperty | Sets the value of the specified description property in the test object description. |
| Sync | Synchronizes the iView frame. |
| 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. |
Maximize Method
Description
Maximizes the iView frame.
Syntax
object.Maximize
Return Type
None.
Example
Maximize the iView Frame (VBScript)
'The following example uses the Maximize method to maximize the "Attendance Overview" iView frame.
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Navigate "My Staff"
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").SAPiView("Attendance Overview").Maximize
Minimize Method
Description
Minimizes the iView frame.
Syntax
object.Minimize
Return Type
None.
Example
Minimize the iView Frame (VBScript)
'The following example uses the Minimize method to minimize the "Attendance Overview" iView frame.
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Navigate "My Staff"
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").SAPiView("Attendance Overview").Minimize
RunScript Method
Description
Runs the specified JavaScript.
Syntax
object.RunScript (Script)
Arguments
| Parameter | Description |
|---|---|
| Script |
Required. A String value. |
Return Type
A Variant.
IMPORTANT
- To run this method, the security settings in your Web browser must be set to allow active scripting. Otherwise, steps using this method will fail.
- When using Internet Explorer in protected mode, using this method to run the Alert, Prompt, and Confirm JavaScript methods is not supported.
- When running this method, you should use an eval() function or anonymous function to run the script entered for this method.
For example, you can use functions like these:
"eval(var remove = document.getElementsByTagName('a')[0]; var per = remove.parentNode; per.removeChild(remove););"
OR
"(function(){var remove = document.getElementsByTagName('a')[0]; var per = remove.parentNode; per.removeChild(remove);})();"
Example
Run a Script on a SAP Frame (VBScript)
'This example uses the RunScript method to remove a DOM element from an SAP frame.
'Then it verifies that the frame still behaves correctly when the DOM element is removed.
Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").RunScript "var remove = document.getElementById('menuslOKCodeField'); remove.parentNode.removeChild(remove)"
'Check that the frame behaves correctly
If Browser("SAP R/3 System").Page("SAP R/3 System_2").SAPFrame("SAP R/3 System").SAPOKCode("Transaction").Exist Then
Reporter.ReportEvent micFail, "Failed to remove SAPOKCode"
End IfClone a Returned JavaScript Array (VBScript)
'This example provides a JavaScript function that uses a Push operation to clone
'the array that is returned by the RunScript method. The cloneArray function is then saved as a .js file in the file system.
'The example then uses the EmbedScriptFromFile method to embed the function in the specified SAP frame,
'and the RunScript method to run the embedded cloneArray() function on the script that returned the array.
'Adapt the following function and save it as CloneArray.js on your C: drive:
' function cloneArray(arr) {
' var ret = [];
' for (var i = 0; i < arr.length; ++i)
' ret.push(arr[i]);
' return ret;
' }
'In UFT One, embed the function in the frame
Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").EmbedScriptFromFile "C:\CloneArray.js"
'Call the function and run the script that returns the array
Set cloned = Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").RunScript("cloneArray( /* JavaScript code that returns an array */ )")
RunScriptFromFile Method
Description
Runs the JavaScript stored in the specified file.
Syntax
object.RunScriptFromFile (FileName)
Arguments
| Parameter | Description |
|---|---|
| FileName |
Required. A String value. |
Return Type
A Variant.
IMPORTANT
- To run this method, the security settings in your Web browser must be set to allow active scripting. Otherwise, steps using this method will fail.
- When using Internet Explorer in protected mode, using this method to run the Alert, Prompt, and Confirm JavaScript methods is not supported.
- When running this method, you should use an eval() function or anonymous function to run the script entered for this method.
For example, you can use functions like these:
"eval(var remove = document.getElementsByTagName('a')[0]; var per = remove.parentNode; per.removeChild(remove););"
OR
"(function(){var remove = document.getElementsByTagName('a')[0]; var per = remove.parentNode; per.removeChild(remove);})();"
Example
Run a Script from a Specified File on a SAP Frame (VBScript)
'This example uses the RunScriptFromFile method to remove a DOM element from an SAP frame.
'Then it verifies that the frame still behaves correctly when the DOM element is removed.
Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").RunScriptFromFile "C:\script.js"
'Check that the frame behaves correctly
If Browser("SAP R/3 System").Page("SAP R/3 System_2").SAPFrame("SAP R/3 System").SAPOKCode("Transaction").Exist Then
Reporter.ReportEvent micFail, "Failed to remove SAPOKCode"
End IfClone a Returned JavaScript Array (VBScript)
'This example provides a JavaScript function that uses a push operation to clone
'the array that is returned by the RunScriptFromFile method. The cloneArray function is then saved as a .js file in the file system.
'The example then uses the EmbedScriptFromFile method to embed the function in the specified SAP frame,
'and the RunScriptFromFile method to run the embedded cloneArray() function on the script that returned the array.
'Adapt the following function and save it as CloneArray.js on your C: drive:
' function cloneArray(arr) {
' var ret = [];
' for (var i = 0; i < arr.length; ++i)
' ret.push(arr[i]);
' return ret;
' }
'In UFT One, embed the function in the frame
Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").EmbedScriptFromFile "C:\CloneArray.js"
'Call the function and run the script that returns the array
Set cloned = Browser("SAP R/3 System").Page("SAP R/3 System").SAPFrame("SAP R/3 System").RunScriptFromFile("cloneArray( /* JavaScript file path that returns an array */ )")
SelectMenuItem Method
Description
Selects an item from the iView menu.
Syntax
object.SelectMenuItem (Item)
Arguments
| Parameter | Description |
|---|---|
| Item |
Required. A String value. Item to select. The item can either be one of the items in the iView menu or its index. To specify the index of the item to select, use the format: #index.
Index values begin with 0.
|
Return Type
None.
Example
Select a Menu Item from an iView Frame Context Menu (VBScript)
'The following example uses the SelectMenuItem method to select the "Personalize" item from
'the "SAP Business Packages" iView frame's context menu.
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").SAPiView("SAP Business Packages").SelectMenuItem "Personalize"
Sync Method
Description
Synchronizes the iView frame.
Syntax
object.Sync
Return Type
None.
Example
Synchronize the iView Frame (VBScript)
'The following example uses the Sync method to synchronize the "Attendance Overview" iView frame.
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").Navigate "My Staff"
Browser("SAP Enterprise Portal").SAPPortal("SAP Enterprise Portal").SAPiView("Attendance Overview").Sync
See also:
