org.safs.model.components

Class HTMLDocument

java.lang.Object

org.safs.model.Component

org.safs.model.components.UIComponent

org.safs.model.components.GenericMaster

org.safs.model.components.GenericObject

org.safs.model.components.HTML

org.safs.model.components.HTMLDocument

public class HTMLDocument
extends HTML

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HTMLDocument(java.lang.String compname)
	HTMLDocument(java.lang.String winname, java.lang.String compname) Constructor Create an instance of pseudo-component representing a specific component in a specific window.
	HTMLDocument(Window window, java.lang.String compname) Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Method Summary

Modifier and Type	Method and Description
void	captureBodySourceToFile(StepTestTable table, java.lang.String[] parameters) Captures the HTML source of the BODY tag into a file.
void	captureBodySourceToFile(StepTestTable table, java.lang.String filename, java.lang.String fileEncoding) Captures the HTML source of the BODY tag into a file.
ComponentFunction	captureBodySourceToFile(java.lang.String[] parameters) Captures the HTML source of the BODY tag into a file.
ComponentFunction	captureBodySourceToFile(java.lang.String filename, java.lang.String fileEncoding) Captures the HTML source of the BODY tag into a file.
void	captureBodyTextToFile(StepTestTable table, java.lang.String[] parameters) Captures the visible document text into a file.
void	captureBodyTextToFile(StepTestTable table, java.lang.String filename, java.lang.String fileEncoding) Captures the visible document text into a file.
ComponentFunction	captureBodyTextToFile(java.lang.String[] parameters) Captures the visible document text into a file.
ComponentFunction	captureBodyTextToFile(java.lang.String filename, java.lang.String fileEncoding) Captures the visible document text into a file.
void	clickLink(StepTestTable table, java.lang.String[] parameters) Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object.
void	clickLink(StepTestTable table, java.lang.String compareTextValue, java.lang.String matchIndex, java.lang.String caseSensitive) Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object.
ComponentFunction	clickLink(java.lang.String[] parameters) Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object.
ComponentFunction	clickLink(java.lang.String compareTextValue, java.lang.String matchIndex, java.lang.String caseSensitive) Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object.
void	clickLinkBeginning(StepTestTable table, java.lang.String[] parameters) Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
void	clickLinkBeginning(StepTestTable table, java.lang.String beginningTextValue, java.lang.String matchIndex, java.lang.String caseSensitive) Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
ComponentFunction	clickLinkBeginning(java.lang.String[] parameters) Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
ComponentFunction	clickLinkBeginning(java.lang.String beginningTextValue, java.lang.String matchIndex, java.lang.String caseSensitive) Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
void	clickLinkContaining(StepTestTable table, java.lang.String[] parameters) Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
void	clickLinkContaining(StepTestTable table, java.lang.String compareTextValue, java.lang.String matchIndex, java.lang.String caseSensitive) Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
ComponentFunction	clickLinkContaining(java.lang.String[] parameters) Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
ComponentFunction	clickLinkContaining(java.lang.String compareTextValue, java.lang.String matchIndex, java.lang.String caseSensitive) Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
void	clickLinkMatching(StepTestTable table, java.lang.String[] parameters) DEPARECATED.
void	clickLinkMatching(StepTestTable table, java.lang.String compareTextValue, java.lang.String matchIndex, java.lang.String caseSensitive) DEPARECATED.
ComponentFunction	clickLinkMatching(java.lang.String[] parameters) DEPARECATED.
ComponentFunction	clickLinkMatching(java.lang.String compareTextValue, java.lang.String matchIndex, java.lang.String caseSensitive) DEPARECATED.
void	verifyBodySource(StepTestTable table, java.lang.String[] parameters) Compares the HTML source of the BODY tag with that of a benchmark file.
void	verifyBodySource(StepTestTable table, java.lang.String benchmark, java.lang.String fileEncoding) Compares the HTML source of the BODY tag with that of a benchmark file.
ComponentFunction	verifyBodySource(java.lang.String[] parameters) Compares the HTML source of the BODY tag with that of a benchmark file.
ComponentFunction	verifyBodySource(java.lang.String benchmark, java.lang.String fileEncoding) Compares the HTML source of the BODY tag with that of a benchmark file.
void	verifyBodyText(StepTestTable table, java.lang.String[] parameters) Compares the visible doc text with that of a benchmark file.
void	verifyBodyText(StepTestTable table, java.lang.String benchmark, java.lang.String fileEncoding) Compares the visible doc text with that of a benchmark file.
ComponentFunction	verifyBodyText(java.lang.String[] parameters) Compares the visible doc text with that of a benchmark file.
ComponentFunction	verifyBodyText(java.lang.String benchmark, java.lang.String fileEncoding) Compares the visible doc text with that of a benchmark file.

Methods inherited from class org.safs.model.components.GenericObject

altLeftDrag, altLeftDrag, click, click, click, click, clickScreenImage, clickScreenImage, clickScreenLocation, clickScreenLocation, clickScreenPoint, clickScreenPoint, compareStoredData, compareStoredData, compareStoredData, compareStoredData, compareStoredProperties, compareStoredProperties, compareStoredProperties, compareStoredProperties, ctrlAltLeftDrag, ctrlAltLeftDrag, ctrlClick, ctrlClick, ctrlClick, ctrlClick, ctrlClickScreenImage, ctrlClickScreenImage, ctrlLeftDrag, ctrlLeftDrag, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClick, ctrlRightClickScreenImage, ctrlRightClickScreenImage, ctrlShiftLeftDrag, ctrlShiftLeftDrag, doubleClick, doubleClick, doubleClick, doubleClick, doubleClickScreenImage, doubleClickScreenImage, doubleClickScreenLocation, doubleClickScreenLocation, doubleClickScreenPoint, doubleClickScreenPoint, doubleTap, doubleTap, dragTo, dragTo, dragTo, dragTo, flick, flick, flick, flick, flickDown, flickDown, flickLeft, flickLeft, flickRight, flickRight, flickUp, flickUp, hScrollTo, hScrollTo, javaMenuSelect, javaMenuSelect, leftDrag, leftDrag, mouseClick, mouseClick, multiClick, multiClick, multiClick, multiClick, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, multiClickScreenImage, press, press, rightClick, rightClick, rightClick, rightClick, rightClickScreenImage, rightClickScreenImage, rightClickScreenLocation, rightClickScreenLocation, rightClickScreenPoint, rightClickScreenPoint, rightDrag, rightDrag, shiftClick, shiftClick, shiftClick, shiftClick, shiftClickScreenImage, shiftClickScreenImage, shiftLeftDrag, shiftLeftDrag, tap, tap, twoFingerTap, twoFingerTap, verifyImage, verifyImage, vScrollTo, vScrollTo

Methods inherited from class org.safs.model.components.GenericMaster

assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, assignPropertyVariable, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, captureObjectDataToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertiesToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, capturePropertyToFile, clearAppMapCache, clearAppMapCache, clearCache, clearCache, executeScript, executeScript, executeScript, executeScript, getComputedStyle, getComputedStyle, getGUIImage, getGUIImage, getGUIImage, getGUIImage, getTextFromGUI, getTextFromGUI, getTextFromGUI, getTextFromGUI, gUIDoesExist, gUIDoesExist, gUIDoesNotExist, gUIDoesNotExist, hoverMouse, hoverMouse, hoverMouse, hoverMouse, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, hoverScreenLocation, inputCharacters, inputCharacters, inputKeys, inputKeys, isPropertyExist, isPropertyExist, isPropertyExist, isPropertyExist, locateScreenImage, locateScreenImage, locateScreenImage, locateScreenImage, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, saveTextFromGUI, sendEvent, sendEvent, sendEvent, sendEvent, setPropertyValue, setPropertyValue, setPropertyValue, setPropertyValue, showOnPage, showOnPage, typeChars, typeChars, typeEncryption, typeEncryption, typeEncryption, typeEncryption, typeKeys, typeKeys, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyArrayPropertyToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyBinaryFileToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardToFile, verifyClipboardVP, verifyClipboardVP, verifyComputedStyle, verifyComputedStyle, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyFileToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyGUIImageToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyObjectDataToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesSubsetToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyPropertiesToFile, verifyProperty, verifyProperty, verifyProperty, verifyProperty, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyContains, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyPropertyToFile, verifyTabOrder, verifyTabOrder, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyTextFileToFile, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContains, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueContainsIgnoreCase, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValueDoesNotContain, verifyValues, verifyValues, verifyValues, verifyValues, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesIgnoreCase, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual, verifyValuesNotEqual

Methods inherited from class org.safs.model.components.UIComponent

getWindow, setWindow

Methods inherited from class org.safs.model.Component

getName, getParent, getParentName, quote

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HTMLDocument

public HTMLDocument(Window window,
                    java.lang.String compname)

Constructor Create an instance of pseudo-component representing a specific component in a specific window.

Parameters:

window - Optional:NO Specifies which Window this component is 'in'.

compname - Optional:NO Specifies the AppMap name of the component in the Window.

HTMLDocument

public HTMLDocument(java.lang.String winname,
                    java.lang.String compname)

Constructor Create an instance of pseudo-component representing a specific component in a specific window. This convenience routine will create the requisite Window component.

Parameters:

winname - Optional:NO Specifies the AppMap name of the window.

compname - Optional:NO Specifies the AppMap name of the component in the Window.

HTMLDocument

protected HTMLDocument(java.lang.String compname)

Method Detail

captureBodySourceToFile

public ComponentFunction captureBodySourceToFile(java.lang.String filename,
                                                 java.lang.String fileEncoding)

 
                 Captures the HTML source of the BODY tag into a file.
               
                Captures the HTML source of the BODY tag into a file.
                This includes the BODY tag itself, everything inside it, and the closing 
                /Body tag as well.
                RobotJ (RJ) Specific Notes:
                        1) If your HTML document or browser does not support the 'outerHTML' property 
                        then you may have to resort to providing internet connection info in the properties 
                        file mentioned in #2.
                        
                        2) If you use proxy to connect to internet, proxy.server and proxy.server.port
                        in the file org.safs.rational.proxyParameter.properties must be set to ensure
                        the execution of this command.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

filename - Optional:NO Name of the output file to create in the active "Test" directory.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

captureBodySourceToFile

public void captureBodySourceToFile(StepTestTable table,
                                    java.lang.String filename,
                                    java.lang.String fileEncoding)

 
                 Captures the HTML source of the BODY tag into a file.
               
                Captures the HTML source of the BODY tag into a file.
                This includes the BODY tag itself, everything inside it, and the closing 
                /Body tag as well.
                RobotJ (RJ) Specific Notes:
                        1) If your HTML document or browser does not support the 'outerHTML' property 
                        then you may have to resort to providing internet connection info in the properties 
                        file mentioned in #2.
                        
                        2) If you use proxy to connect to internet, proxy.server and proxy.server.port
                        in the file org.safs.rational.proxyParameter.properties must be set to ensure
                        the execution of this command.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

filename - Optional:NO Name of the output file to create in the active "Test" directory.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

captureBodySourceToFile

public ComponentFunction captureBodySourceToFile(java.lang.String[] parameters)

 
                 Captures the HTML source of the BODY tag into a file.
               
                Captures the HTML source of the BODY tag into a file.
                This includes the BODY tag itself, everything inside it, and the closing 
                /Body tag as well.
                RobotJ (RJ) Specific Notes:
                        1) If your HTML document or browser does not support the 'outerHTML' property 
                        then you may have to resort to providing internet connection info in the properties 
                        file mentioned in #2.
                        
                        2) If you use proxy to connect to internet, proxy.server and proxy.server.port
                        in the file org.safs.rational.proxyParameter.properties must be set to ensure
                        the execution of this command.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

filename -- Optional:NO Name of the output file to create in the active "Test" directory.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

captureBodySourceToFile

public void captureBodySourceToFile(StepTestTable table,
                                    java.lang.String[] parameters)

 
                 Captures the HTML source of the BODY tag into a file.
               
                Captures the HTML source of the BODY tag into a file.
                This includes the BODY tag itself, everything inside it, and the closing 
                /Body tag as well.
                RobotJ (RJ) Specific Notes:
                        1) If your HTML document or browser does not support the 'outerHTML' property 
                        then you may have to resort to providing internet connection info in the properties 
                        file mentioned in #2.
                        
                        2) If you use proxy to connect to internet, proxy.server and proxy.server.port
                        in the file org.safs.rational.proxyParameter.properties must be set to ensure
                        the execution of this command.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

filename -- Optional:NO Name of the output file to create in the active "Test" directory.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

captureBodyTextToFile

public ComponentFunction captureBodyTextToFile(java.lang.String filename,
                                               java.lang.String fileEncoding)

 
                 Captures the visible document text into a file.
               
                Captures the visible document text into a file.
                That is, generally, the text you see with no HTML tags.
                /Body tag as well.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

filename - Optional:NO Name of the output file to create in the active "Test" directory.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

captureBodyTextToFile

public void captureBodyTextToFile(StepTestTable table,
                                  java.lang.String filename,
                                  java.lang.String fileEncoding)

 
                 Captures the visible document text into a file.
               
                Captures the visible document text into a file.
                That is, generally, the text you see with no HTML tags.
                /Body tag as well.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

filename - Optional:NO Name of the output file to create in the active "Test" directory.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

captureBodyTextToFile

public ComponentFunction captureBodyTextToFile(java.lang.String[] parameters)

 
                 Captures the visible document text into a file.
               
                Captures the visible document text into a file.
                That is, generally, the text you see with no HTML tags.
                /Body tag as well.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

filename -- Optional:NO Name of the output file to create in the active "Test" directory.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

captureBodyTextToFile

public void captureBodyTextToFile(StepTestTable table,
                                  java.lang.String[] parameters)

 
                 Captures the visible document text into a file.
               
                Captures the visible document text into a file.
                That is, generally, the text you see with no HTML tags.
                /Body tag as well.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

filename -- Optional:NO Name of the output file to create in the active "Test" directory.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

clickLink

public ComponentFunction clickLink(java.lang.String compareTextValue,
                                   java.lang.String matchIndex,
                                   java.lang.String caseSensitive)

 
                 Performs an HTMLLink Click based on a complete match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a complete match of text found on 
                Links within this HTMLDOCUMENT object.
                
                Optionally, the user can also specify a match index to indicate that 
                the desired Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

compareTextValue - Optional:NO The text to compare with each Link.

matchIndex - Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.

caseSensitive - Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLink

public void clickLink(StepTestTable table,
                      java.lang.String compareTextValue,
                      java.lang.String matchIndex,
                      java.lang.String caseSensitive)

 
                 Performs an HTMLLink Click based on a complete match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a complete match of text found on 
                Links within this HTMLDOCUMENT object.
                
                Optionally, the user can also specify a match index to indicate that 
                the desired Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

compareTextValue - Optional:NO The text to compare with each Link.

matchIndex - Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.

caseSensitive - Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLink

public ComponentFunction clickLink(java.lang.String[] parameters)

 
                 Performs an HTMLLink Click based on a complete match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a complete match of text found on 
                Links within this HTMLDOCUMENT object.
                
                Optionally, the user can also specify a match index to indicate that 
                the desired Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

compareTextValue -- Optional:NO The text to compare with each Link.
matchIndex -- Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
caseSensitive -- Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLink

public void clickLink(StepTestTable table,
                      java.lang.String[] parameters)

 
                 Performs an HTMLLink Click based on a complete match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a complete match of text found on 
                Links within this HTMLDOCUMENT object.
                
                Optionally, the user can also specify a match index to indicate that 
                the desired Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

compareTextValue -- Optional:NO The text to compare with each Link.
matchIndex -- Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
caseSensitive -- Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkBeginning

public ComponentFunction clickLinkBeginning(java.lang.String beginningTextValue,
                                            java.lang.String matchIndex,
                                            java.lang.String caseSensitive)

 
                 Performs an HTMLLink Click based on a partial match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a partial match of text found on 
                Links within this HTMLDOCUMENT object.  The text of the Link is 
                expected to BEGIN with the text provided by the user.  Optionally, 
                the user can also specify a match index to indicate that the desired 
                Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.  The 
                user can specify a case-senstive comparison via CaseSensitive Field #7. 
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

beginningTextValue - Optional:NO The text (NOT case-sensitive) to compare with the beginning of each Link.

matchIndex - Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.

caseSensitive - Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkBeginning

public void clickLinkBeginning(StepTestTable table,
                               java.lang.String beginningTextValue,
                               java.lang.String matchIndex,
                               java.lang.String caseSensitive)

 
                 Performs an HTMLLink Click based on a partial match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a partial match of text found on 
                Links within this HTMLDOCUMENT object.  The text of the Link is 
                expected to BEGIN with the text provided by the user.  Optionally, 
                the user can also specify a match index to indicate that the desired 
                Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.  The 
                user can specify a case-senstive comparison via CaseSensitive Field #7. 
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

beginningTextValue - Optional:NO The text (NOT case-sensitive) to compare with the beginning of each Link.

matchIndex - Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.

caseSensitive - Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkBeginning

public ComponentFunction clickLinkBeginning(java.lang.String[] parameters)

 
                 Performs an HTMLLink Click based on a partial match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a partial match of text found on 
                Links within this HTMLDOCUMENT object.  The text of the Link is 
                expected to BEGIN with the text provided by the user.  Optionally, 
                the user can also specify a match index to indicate that the desired 
                Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.  The 
                user can specify a case-senstive comparison via CaseSensitive Field #7. 
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

beginningTextValue -- Optional:NO The text (NOT case-sensitive) to compare with the beginning of each Link.
matchIndex -- Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
caseSensitive -- Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkBeginning

public void clickLinkBeginning(StepTestTable table,
                               java.lang.String[] parameters)

 
                 Performs an HTMLLink Click based on a partial match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a partial match of text found on 
                Links within this HTMLDOCUMENT object.  The text of the Link is 
                expected to BEGIN with the text provided by the user.  Optionally, 
                the user can also specify a match index to indicate that the desired 
                Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.  The 
                user can specify a case-senstive comparison via CaseSensitive Field #7. 
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

beginningTextValue -- Optional:NO The text (NOT case-sensitive) to compare with the beginning of each Link.
matchIndex -- Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
caseSensitive -- Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkContaining

public ComponentFunction clickLinkContaining(java.lang.String compareTextValue,
                                             java.lang.String matchIndex,
                                             java.lang.String caseSensitive)

 
                 Performs an HTMLLink Click based on a partial match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a partial match of text found on 
                Links within this HTMLDOCUMENT object.  The text of the Link is 
                expected to CONTAIN the text provided by the user at any position in 
                the Link text--not strictly the beginning as in ClickLinkBeginning.
                
                Optionally, the user can also specify a match index to indicate that 
                the desired Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

compareTextValue - Optional:NO The text to compare with each Link.

matchIndex - Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.

caseSensitive - Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkContaining

public void clickLinkContaining(StepTestTable table,
                                java.lang.String compareTextValue,
                                java.lang.String matchIndex,
                                java.lang.String caseSensitive)

 
                 Performs an HTMLLink Click based on a partial match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a partial match of text found on 
                Links within this HTMLDOCUMENT object.  The text of the Link is 
                expected to CONTAIN the text provided by the user at any position in 
                the Link text--not strictly the beginning as in ClickLinkBeginning.
                
                Optionally, the user can also specify a match index to indicate that 
                the desired Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

compareTextValue - Optional:NO The text to compare with each Link.

matchIndex - Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.

caseSensitive - Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkContaining

public ComponentFunction clickLinkContaining(java.lang.String[] parameters)

 
                 Performs an HTMLLink Click based on a partial match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a partial match of text found on 
                Links within this HTMLDOCUMENT object.  The text of the Link is 
                expected to CONTAIN the text provided by the user at any position in 
                the Link text--not strictly the beginning as in ClickLinkBeginning.
                
                Optionally, the user can also specify a match index to indicate that 
                the desired Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

compareTextValue -- Optional:NO The text to compare with each Link.
matchIndex -- Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
caseSensitive -- Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkContaining

public void clickLinkContaining(StepTestTable table,
                                java.lang.String[] parameters)

 
                 Performs an HTMLLink Click based on a partial match of text found on 
                 Links within this HTMLDOCUMENT object.
               
                Performs an HTMLLink Click based on a partial match of text found on 
                Links within this HTMLDOCUMENT object.  The text of the Link is 
                expected to CONTAIN the text provided by the user at any position in 
                the Link text--not strictly the beginning as in ClickLinkBeginning.
                
                Optionally, the user can also specify a match index to indicate that 
                the desired Link is the "nth" Link that matches the text criteria.
                
                The text comparison for the Link is NOT case-sensitive by default.
                
                Leading and trailing whitespace will be removed from the links as they 
                are compared unless the link in the HTML itself is quoted.
                In addition, any Line Feeds and Carriage Returns will be removed.
                For the link, we use the outerText property to locate the text.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

compareTextValue -- Optional:NO The text to compare with each Link.
matchIndex -- Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
caseSensitive -- Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkMatching

public ComponentFunction clickLinkMatching(java.lang.String compareTextValue,
                                           java.lang.String matchIndex,
                                           java.lang.String caseSensitive)

 
                 DEPARECATED.  This command is identical to ClickLink.
               
                 DEPARECATED.  This command is identical to ClickLink.
                  

Supporting Engines:

• Rational Robot
• OpenQA Selenium

Parameters:

compareTextValue - Optional:NO The text to compare with each Link.

matchIndex - Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.

caseSensitive - Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkMatching

public void clickLinkMatching(StepTestTable table,
                              java.lang.String compareTextValue,
                              java.lang.String matchIndex,
                              java.lang.String caseSensitive)

 
                 DEPARECATED.  This command is identical to ClickLink.
               
                 DEPARECATED.  This command is identical to ClickLink.
                  

Supporting Engines:

• Rational Robot
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

compareTextValue - Optional:NO The text to compare with each Link.

matchIndex - Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.

caseSensitive - Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkMatching

public ComponentFunction clickLinkMatching(java.lang.String[] parameters)

 
                 DEPARECATED.  This command is identical to ClickLink.
               
                 DEPARECATED.  This command is identical to ClickLink.
                  

Supporting Engines:

• Rational Robot
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

compareTextValue -- Optional:NO The text to compare with each Link.
matchIndex -- Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
caseSensitive -- Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

clickLinkMatching

public void clickLinkMatching(StepTestTable table,
                              java.lang.String[] parameters)

 
                 DEPARECATED.  This command is identical to ClickLink.
               
                 DEPARECATED.  This command is identical to ClickLink.
                  

Supporting Engines:

• Rational Robot
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

compareTextValue -- Optional:NO The text to compare with each Link.
matchIndex -- Optional:YES Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
caseSensitive -- Optional:YES "Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

verifyBodySource

public ComponentFunction verifyBodySource(java.lang.String benchmark,
                                          java.lang.String fileEncoding)

 
                 Compares the HTML source of the BODY tag with that of a benchmark file.
               
                This includes the BODY tag itself, everything inside it, and the closing 
                /Body tag as well.
                
                RRAFS:
                The routine will automatically create a temporary ObjectData VP with a 
                dummy baseline, capture the actual file, transfer it to active "Test" 
                directory, and compare it with the benchmark.  The routine will then 
                delete all significant remnants of the temporary ObjectData VP.
                 
                RRAFS:
                This routine requires that the following two files exist in the 
                DDE_RUNTIME directory:
                 
                HTMLDocumentHTML.grd
                HTMLDocumentHTML.vpm
                
             The command may produce a WARNING if a diff tool for which we 
             have no means to verify the results is configured for use.  
             Consequently, if these warnings are expected, the user can use the 
             "TW" test record type to avoid issuing these warnings.
                           RobotJ (RJ) Specific Notes:
                        1) If you use proxy to connect to internet, proxy.server and proxy.server.port
                        in the file org.safs.rational.proxyParameter.properties must be set to ensure
                        the execution of this command.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

benchmark - Optional:NO Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

verifyBodySource

public void verifyBodySource(StepTestTable table,
                             java.lang.String benchmark,
                             java.lang.String fileEncoding)

 
                 Compares the HTML source of the BODY tag with that of a benchmark file.
               
                This includes the BODY tag itself, everything inside it, and the closing 
                /Body tag as well.
                
                RRAFS:
                The routine will automatically create a temporary ObjectData VP with a 
                dummy baseline, capture the actual file, transfer it to active "Test" 
                directory, and compare it with the benchmark.  The routine will then 
                delete all significant remnants of the temporary ObjectData VP.
                 
                RRAFS:
                This routine requires that the following two files exist in the 
                DDE_RUNTIME directory:
                 
                HTMLDocumentHTML.grd
                HTMLDocumentHTML.vpm
                
             The command may produce a WARNING if a diff tool for which we 
             have no means to verify the results is configured for use.  
             Consequently, if these warnings are expected, the user can use the 
             "TW" test record type to avoid issuing these warnings.
                           RobotJ (RJ) Specific Notes:
                        1) If you use proxy to connect to internet, proxy.server and proxy.server.port
                        in the file org.safs.rational.proxyParameter.properties must be set to ensure
                        the execution of this command.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

benchmark - Optional:NO Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

verifyBodySource

public ComponentFunction verifyBodySource(java.lang.String[] parameters)

 
                 Compares the HTML source of the BODY tag with that of a benchmark file.
               
                This includes the BODY tag itself, everything inside it, and the closing 
                /Body tag as well.
                
                RRAFS:
                The routine will automatically create a temporary ObjectData VP with a 
                dummy baseline, capture the actual file, transfer it to active "Test" 
                directory, and compare it with the benchmark.  The routine will then 
                delete all significant remnants of the temporary ObjectData VP.
                 
                RRAFS:
                This routine requires that the following two files exist in the 
                DDE_RUNTIME directory:
                 
                HTMLDocumentHTML.grd
                HTMLDocumentHTML.vpm
                
             The command may produce a WARNING if a diff tool for which we 
             have no means to verify the results is configured for use.  
             Consequently, if these warnings are expected, the user can use the 
             "TW" test record type to avoid issuing these warnings.
                           RobotJ (RJ) Specific Notes:
                        1) If you use proxy to connect to internet, proxy.server and proxy.server.port
                        in the file org.safs.rational.proxyParameter.properties must be set to ensure
                        the execution of this command.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

benchmark -- Optional:NO Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

verifyBodySource

public void verifyBodySource(StepTestTable table,
                             java.lang.String[] parameters)

 
                 Compares the HTML source of the BODY tag with that of a benchmark file.
               
                This includes the BODY tag itself, everything inside it, and the closing 
                /Body tag as well.
                
                RRAFS:
                The routine will automatically create a temporary ObjectData VP with a 
                dummy baseline, capture the actual file, transfer it to active "Test" 
                directory, and compare it with the benchmark.  The routine will then 
                delete all significant remnants of the temporary ObjectData VP.
                 
                RRAFS:
                This routine requires that the following two files exist in the 
                DDE_RUNTIME directory:
                 
                HTMLDocumentHTML.grd
                HTMLDocumentHTML.vpm
                
             The command may produce a WARNING if a diff tool for which we 
             have no means to verify the results is configured for use.  
             Consequently, if these warnings are expected, the user can use the 
             "TW" test record type to avoid issuing these warnings.
                           RobotJ (RJ) Specific Notes:
                        1) If you use proxy to connect to internet, proxy.server and proxy.server.port
                        in the file org.safs.rational.proxyParameter.properties must be set to ensure
                        the execution of this command.
                
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

benchmark -- Optional:NO Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

verifyBodyText

public ComponentFunction verifyBodyText(java.lang.String benchmark,
                                        java.lang.String fileEncoding)

 
                 Compares the visible doc text with that of a benchmark file.
               
                The routine will automatically create a temporary ObjectData VP with a 
                dummy baseline, capture the actual file, transfer it to active "Test" 
                directory, and compare it with the benchmark.  The routine will then 
                delete all significant remnants of the temporary ObjectData VP.
                 
                This routine requires that the following two files exist in the 
                DDE_RUNTIME directory:
                 
                HTMLDocumentText.grd
                HTMLDocumentText.vpm
                
             The command may produce a WARNING if a diff tool for which we 
             have no means to verify the results is configured for use.  
             Consequently, if these warnings are expected, the user can use the 
             "TW" test record type to avoid issuing these warnings.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

benchmark - Optional:NO Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

verifyBodyText

public void verifyBodyText(StepTestTable table,
                           java.lang.String benchmark,
                           java.lang.String fileEncoding)

 
                 Compares the visible doc text with that of a benchmark file.
               
                The routine will automatically create a temporary ObjectData VP with a 
                dummy baseline, capture the actual file, transfer it to active "Test" 
                directory, and compare it with the benchmark.  The routine will then 
                delete all significant remnants of the temporary ObjectData VP.
                 
                This routine requires that the following two files exist in the 
                DDE_RUNTIME directory:
                 
                HTMLDocumentText.grd
                HTMLDocumentText.vpm
                
             The command may produce a WARNING if a diff tool for which we 
             have no means to verify the results is configured for use.  
             Consequently, if these warnings are expected, the user can use the 
             "TW" test record type to avoid issuing these warnings.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

benchmark - Optional:NO Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.

fileEncoding - Optional:YES DefaultVal: Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

verifyBodyText

public ComponentFunction verifyBodyText(java.lang.String[] parameters)

 
                 Compares the visible doc text with that of a benchmark file.
               
                The routine will automatically create a temporary ObjectData VP with a 
                dummy baseline, capture the actual file, transfer it to active "Test" 
                directory, and compare it with the benchmark.  The routine will then 
                delete all significant remnants of the temporary ObjectData VP.
                 
                This routine requires that the following two files exist in the 
                DDE_RUNTIME directory:
                 
                HTMLDocumentText.grd
                HTMLDocumentText.vpm
                
             The command may produce a WARNING if a diff tool for which we 
             have no means to verify the results is configured for use.  
             Consequently, if these warnings are expected, the user can use the 
             "TW" test record type to avoid issuing these warnings.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

parameters - Optional:NO An array containing the following parameters:

benchmark -- Optional:NO Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

verifyBodyText

public void verifyBodyText(StepTestTable table,
                           java.lang.String[] parameters)

 
                 Compares the visible doc text with that of a benchmark file.
               
                The routine will automatically create a temporary ObjectData VP with a 
                dummy baseline, capture the actual file, transfer it to active "Test" 
                directory, and compare it with the benchmark.  The routine will then 
                delete all significant remnants of the temporary ObjectData VP.
                 
                This routine requires that the following two files exist in the 
                DDE_RUNTIME directory:
                 
                HTMLDocumentText.grd
                HTMLDocumentText.vpm
                
             The command may produce a WARNING if a diff tool for which we 
             have no means to verify the results is configured for use.  
             Consequently, if these warnings are expected, the user can use the 
             "TW" test record type to avoid issuing these warnings.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• OpenQA Selenium

Parameters:

table - Optional:NO The table to add the record to.

parameters - Optional:NO An array containing the following parameters:

benchmark -- Optional:NO Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.
fileEncoding -- Optional:YES DefaultVal: Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.