public class GenericMasterFunctions
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
ASSIGNPROPERTYVARIABLE_KEYWORD
"AssignPropertyVariable"
|
static java.lang.String |
CAPTUREOBJECTDATATOFILE_KEYWORD
"CaptureObjectDataToFile"
|
static java.lang.String |
CAPTUREPROPERTIESTOFILE_KEYWORD
"CapturePropertiesToFile"
|
static java.lang.String |
CAPTUREPROPERTYTOFILE_KEYWORD
"CapturePropertyToFile"
|
static java.lang.String |
CLEARAPPMAPCACHE_KEYWORD
"ClearAppMapCache"
|
static java.lang.String |
CLEARCACHE_KEYWORD
"ClearCache"
|
static java.lang.String |
EXECUTESCRIPT_KEYWORD
"ExecuteScript"
|
static java.lang.String |
GETCOMPUTEDSTYLE_KEYWORD
"GetComputedStyle"
|
static java.lang.String |
GETGUIIMAGE_KEYWORD
"GetGUIImage"
|
static java.lang.String |
GETTEXTFROMGUI_KEYWORD
"GetTextFromGUI"
|
static java.lang.String |
GUIDOESEXIST_KEYWORD
"GUIDoesExist"
|
static java.lang.String |
GUIDOESNOTEXIST_KEYWORD
"GUIDoesNotExist"
|
static java.lang.String |
HOVERMOUSE_KEYWORD
"HoverMouse"
|
static java.lang.String |
HOVERSCREENLOCATION_KEYWORD
"HoverScreenLocation"
|
static java.lang.String |
INPUTCHARACTERS_KEYWORD
"InputCharacters"
|
static java.lang.String |
INPUTKEYS_KEYWORD
"InputKeys"
|
static java.lang.String |
ISPROPERTYEXIST_KEYWORD
"IsPropertyExist"
|
static java.lang.String |
LOCATESCREENIMAGE_KEYWORD
"LocateScreenImage"
|
static java.lang.String |
SAVETEXTFROMGUI_KEYWORD
"SaveTextFromGUI"
|
static java.lang.String |
SENDEVENT_KEYWORD
"SendEvent"
|
static java.lang.String |
SETPROPERTYVALUE_KEYWORD
"SetPropertyValue"
|
static java.lang.String |
SHOWONPAGE_KEYWORD
"ShowOnPage"
|
static java.lang.String |
TYPECHARS_KEYWORD
"TypeChars"
|
static java.lang.String |
TYPEENCRYPTION_KEYWORD
"TypeEncryption"
|
static java.lang.String |
TYPEKEYS_KEYWORD
"TypeKeys"
|
static java.lang.String |
VERIFYARRAYPROPERTYTOFILE_KEYWORD
"VerifyArrayPropertyToFile"
|
static java.lang.String |
VERIFYBINARYFILETOFILE_KEYWORD
"VerifyBinaryFileToFile"
|
static java.lang.String |
VERIFYCLIPBOARDTOFILE_KEYWORD
"VerifyClipboardToFile"
|
static java.lang.String |
VERIFYCLIPBOARDVP_KEYWORD
"VerifyClipboardVP"
|
static java.lang.String |
VERIFYCOMPUTEDSTYLE_KEYWORD
"VerifyComputedStyle"
|
static java.lang.String |
VERIFYFILETOFILE_KEYWORD
"VerifyFileToFile"
|
static java.lang.String |
VERIFYGUIIMAGETOFILE_KEYWORD
"VerifyGUIImageToFile"
|
static java.lang.String |
VERIFYOBJECTDATATOFILE_KEYWORD
"VerifyObjectDataToFile"
|
static java.lang.String |
VERIFYPROPERTIESSUBSETTOFILE_KEYWORD
"VerifyPropertiesSubsetToFile"
|
static java.lang.String |
VERIFYPROPERTIESTOFILE_KEYWORD
"VerifyPropertiesToFile"
|
static java.lang.String |
VERIFYPROPERTY_KEYWORD
"VerifyProperty"
|
static java.lang.String |
VERIFYPROPERTYCONTAINS_KEYWORD
"VerifyPropertyContains"
|
static java.lang.String |
VERIFYPROPERTYTOFILE_KEYWORD
"VerifyPropertyToFile"
|
static java.lang.String |
VERIFYTABORDER_KEYWORD
"VerifyTabOrder"
|
static java.lang.String |
VERIFYTEXTFILETOFILE_KEYWORD
"VerifyTextFileToFile"
|
static java.lang.String |
VERIFYVALUECONTAINS_KEYWORD
"VerifyValueContains"
|
static java.lang.String |
VERIFYVALUECONTAINSIGNORECASE_KEYWORD
"VerifyValueContainsIgnoreCase"
|
static java.lang.String |
VERIFYVALUEDOESNOTCONTAIN_KEYWORD
"VerifyValueDoesNotContain"
|
static java.lang.String |
VERIFYVALUES_KEYWORD
"VerifyValues"
|
static java.lang.String |
VERIFYVALUESIGNORECASE_KEYWORD
"VerifyValuesIgnoreCase"
|
static java.lang.String |
VERIFYVALUESNOTEQUAL_KEYWORD
"VerifyValuesNotEqual"
|
| Modifier and Type | Method and Description |
|---|---|
static ComponentFunction |
assignPropertyVariable(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Assign the string value of an object property to a specific DDVariable
Assign the string value of an object property to a specific DDVariable.
|
static ComponentFunction |
assignPropertyVariable(java.lang.String winname,
java.lang.String compname,
java.lang.String propertyName,
java.lang.String variableName,
java.lang.String suppressValue)
Assign the string value of an object property to a specific DDVariable
Assign the string value of an object property to a specific DDVariable.
|
static ComponentFunction |
captureObjectDataToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Copy the current contents of an object's data to a file.
|
static ComponentFunction |
captureObjectDataToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String file,
java.lang.String fileEncoding,
java.lang.String filterMode,
java.lang.String filterOptions)
Copy the current contents of an object's data to a file.
|
static ComponentFunction |
capturePropertiesToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Copy all of the value properties a test object to a file.
|
static ComponentFunction |
capturePropertiesToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String file,
java.lang.String fileEncoding)
Copy all of the value properties a test object to a file.
|
static ComponentFunction |
capturePropertyToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Copy a propertie's value of a test object to to a file.
|
static ComponentFunction |
capturePropertyToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String propertyName,
java.lang.String file,
java.lang.String fileEncoding)
Copy a propertie's value of a test object to to a file.
|
static ComponentFunction |
clearAppMapCache(java.lang.String winname,
java.lang.String compname)
Clear the internal application map cache.
|
static ComponentFunction |
clearCache(java.lang.String winname,
java.lang.String compname)
Clear the cache of a component.
|
static ComponentFunction |
executeScript(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Execute a piece of script on the specified component synchronously.
|
static ComponentFunction |
executeScript(java.lang.String winname,
java.lang.String compname,
java.lang.String script,
java.lang.String paramN)
Execute a piece of script on the specified component synchronously.
|
static ComponentFunction |
getComputedStyle(java.lang.String winname,
java.lang.String compname,
java.lang.String testFile)
Get a component's 'computed style', and save them to a file.
|
static ComponentFunction |
getGUIImage(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Capture the screen shot of a GUI component and save it to a file
Capture the screen shot of a GUI component and save it to a file.
|
static ComponentFunction |
getGUIImage(java.lang.String winname,
java.lang.String compname,
java.lang.String outputFile,
java.lang.String subArea,
java.lang.String filteredAreas)
Capture the screen shot of a GUI component and save it to a file
Capture the screen shot of a GUI component and save it to a file.
|
static GenericMasterFunctions |
getInstance()
public Singleton to access class static methods via instance
|
static ComponentFunction |
getTextFromGUI(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
|
static ComponentFunction |
getTextFromGUI(java.lang.String winname,
java.lang.String compname,
java.lang.String variableName,
java.lang.String subArea,
java.lang.String oCRId,
java.lang.String langId,
java.lang.String scaleRatio)
Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
|
static ComponentFunction |
gUIDoesExist(java.lang.String winname,
java.lang.String compname)
Routine to verify the visual existence of a particular window and/or component.
|
static ComponentFunction |
gUIDoesNotExist(java.lang.String winname,
java.lang.String compname)
Routine to verify the visual non-existence of a particular window and/or component.
|
static ComponentFunction |
hoverMouse(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Hover the mouse over an object.
|
static ComponentFunction |
hoverMouse(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String hoverTime)
Hover the mouse over an object.
|
static ComponentFunction |
hoverScreenLocation(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Hover the mouse over a specified screen location.
|
static ComponentFunction |
hoverScreenLocation(java.lang.String winname,
java.lang.String compname,
java.lang.String appMapSubkey,
java.lang.String hoverTime)
Hover the mouse over a specified screen location.
|
static ComponentFunction |
inputCharacters(java.lang.String winname,
java.lang.String compname,
java.lang.String textValue)
Sends literal text to the specified component.
|
static ComponentFunction |
inputKeys(java.lang.String winname,
java.lang.String compname,
java.lang.String textValue)
Sends keystrokes to the specified component.
|
static ComponentFunction |
isPropertyExist(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify if object's property exists or not.
|
static ComponentFunction |
isPropertyExist(java.lang.String winname,
java.lang.String compname,
java.lang.String propertyName,
java.lang.String propertyExistVariable)
Verify if object's property exists or not.
|
static ComponentFunction |
locateScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Store the location and dimensions of a component.
|
static ComponentFunction |
locateScreenImage(java.lang.String winname,
java.lang.String compname,
java.lang.String variableName,
java.lang.String whomRelativeTo)
Store the location and dimensions of a component.
|
static ComponentFunction |
saveTextFromGUI(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Incorporate OCR technology to detect the text on a GUI component and save the text to a text file.
|
static ComponentFunction |
saveTextFromGUI(java.lang.String winname,
java.lang.String compname,
java.lang.String outputFile,
java.lang.String subArea,
java.lang.String oCRId,
java.lang.String langId,
java.lang.String scaleRatio)
Incorporate OCR technology to detect the text on a GUI component and save the text to a text file.
|
static ComponentFunction |
sendEvent(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Send or trigger an "event" with 0 or more arguments.
|
static ComponentFunction |
sendEvent(java.lang.String winname,
java.lang.String compname,
java.lang.String event,
java.lang.String pARAM_N)
Send or trigger an "event" with 0 or more arguments.
|
static ComponentFunction |
setPropertyValue(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Sets a value to the property of an object.
|
static ComponentFunction |
setPropertyValue(java.lang.String winname,
java.lang.String compname,
java.lang.String objectPropertyName,
java.lang.String propertyValue)
Sets a value to the property of an object.
|
static ComponentFunction |
showOnPage(java.lang.String winname,
java.lang.String compname,
java.lang.String verify)
Make the component visible on the page.
|
static ComponentFunction |
typeChars(java.lang.String winname,
java.lang.String compname,
java.lang.String textValue)
Sends literal text keystrokes to whatever has keyboard focus.
|
static ComponentFunction |
typeEncryption(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Sends secret-text (such as password) to whatever has keyboard focus.
|
static ComponentFunction |
typeEncryption(java.lang.String winname,
java.lang.String compname,
java.lang.String encryptedDataFile,
java.lang.String privateKeyFile)
Sends secret-text (such as password) to whatever has keyboard focus.
|
static ComponentFunction |
typeKeys(java.lang.String winname,
java.lang.String compname,
java.lang.String textValue)
Sends keystrokes to whatever has keyboard focus.
|
static ComponentFunction |
verifyArrayPropertyToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the value of an array property with a benchmark file
Typically, benchmarks are stored in the Datapool\Bench directory.
|
static ComponentFunction |
verifyArrayPropertyToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String propertyName,
java.lang.String benchmarkFile,
java.lang.String filterMode,
java.lang.String filterOptions)
Verify the value of an array property with a benchmark file
Typically, benchmarks are stored in the Datapool\Bench directory.
|
static ComponentFunction |
verifyBinaryFileToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the current contents of a binary (image, PDF etc.) file with a benchmark file.
|
static ComponentFunction |
verifyBinaryFileToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String benchmarkFile,
java.lang.String actualFile,
java.lang.String filterMode,
java.lang.String filterOptions,
java.lang.String alterImageStyle,
java.lang.String alterImageFactor,
java.lang.String pdfResolution)
Verify the current contents of a binary (image, PDF etc.) file with a benchmark file.
|
static ComponentFunction |
verifyClipboardToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the current contents of the Windows clipboard with a benchmark file.
|
static ComponentFunction |
verifyClipboardToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String benchmarkFile,
java.lang.String filterMode,
java.lang.String filterOptions)
Verify the current contents of the Windows clipboard with a benchmark file.
|
static ComponentFunction |
verifyClipboardVP(java.lang.String winname,
java.lang.String compname,
java.lang.String vPName)
Verify the current contents of the Windows clipboard using a Robot ClipboardVP.
|
static ComponentFunction |
verifyComputedStyle(java.lang.String winname,
java.lang.String compname,
java.lang.String benchFile)
Verify a component's 'computed style' against a benchmark file.
|
static ComponentFunction |
verifyFileToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
|
static ComponentFunction |
verifyFileToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String benchmarkFile,
java.lang.String actualFile,
java.lang.String filterMode,
java.lang.String filterOptions)
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
|
static ComponentFunction |
verifyGUIImageToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the screen shot of a GUI component with a benchmark image file
Verify the screen shot of a GUI component with a benchmark image file.
|
static ComponentFunction |
verifyGUIImageToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String benchmarkFile,
java.lang.String subArea,
java.lang.String percentageTolerance,
java.lang.String uUIDFlag,
java.lang.String filteredAreas)
Verify the screen shot of a GUI component with a benchmark image file
Verify the screen shot of a GUI component with a benchmark image file.
|
static ComponentFunction |
verifyObjectDataToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the current contents of an object's data with a benchmark file.
|
static ComponentFunction |
verifyObjectDataToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String benchmarkFile,
java.lang.String fileEncoding,
java.lang.String filterMode,
java.lang.String filterOptions)
Verify the current contents of an object's data with a benchmark file.
|
static ComponentFunction |
verifyPropertiesSubsetToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Compare/Verify the subset of properties of a test object with the values stored in a benchmark file.
|
static ComponentFunction |
verifyPropertiesSubsetToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String benchFile,
java.lang.String fileEncoding)
Compare/Verify the subset of properties of a test object with the values stored in a benchmark file.
|
static ComponentFunction |
verifyPropertiesToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Compare/Verify ALL of the value properties of a test object with a benchmark file.
|
static ComponentFunction |
verifyPropertiesToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String benchFile,
java.lang.String fileEncoding)
Compare/Verify ALL of the value properties of a test object with a benchmark file.
|
static ComponentFunction |
verifyProperty(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the value of a single object property
|
static ComponentFunction |
verifyProperty(java.lang.String winname,
java.lang.String compname,
java.lang.String propertyName,
java.lang.String expectedValue,
java.lang.String caseInsensitive)
Verify the value of a single object property
|
static ComponentFunction |
verifyPropertyContains(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify that the value of an object property contains a string
|
static ComponentFunction |
verifyPropertyContains(java.lang.String winname,
java.lang.String compname,
java.lang.String propertyName,
java.lang.String searchString,
java.lang.String caseInsensitive)
Verify that the value of an object property contains a string
|
static ComponentFunction |
verifyPropertyToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the value of a single object property with a benchmark file
Verify the value of a single object property with a benchmark file.
|
static ComponentFunction |
verifyPropertyToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String propertyName,
java.lang.String benchmarkFile,
java.lang.String fileEncoding,
java.lang.String filterMode,
java.lang.String filterOptions)
Verify the value of a single object property with a benchmark file
Verify the value of a single object property with a benchmark file.
|
static ComponentFunction |
verifyTabOrder(java.lang.String winname,
java.lang.String compname,
java.lang.String fileName)
Attempts to verify the tab order of the specified object--usually a Window.
|
static ComponentFunction |
verifyTextFileToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
|
static ComponentFunction |
verifyTextFileToFile(java.lang.String winname,
java.lang.String compname,
java.lang.String benchmarkFile,
java.lang.String actualFile,
java.lang.String filterMode,
java.lang.String filterOptions)
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
|
static ComponentFunction |
verifyValueContains(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify that a string value contains a substring
|
static ComponentFunction |
verifyValueContains(java.lang.String winname,
java.lang.String compname,
java.lang.String value,
java.lang.String searchString,
java.lang.String suppressValue)
Verify that a string value contains a substring
|
static ComponentFunction |
verifyValueContainsIgnoreCase(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify that a string value contains a substring, ignoring case.
|
static ComponentFunction |
verifyValueContainsIgnoreCase(java.lang.String winname,
java.lang.String compname,
java.lang.String value,
java.lang.String searchString,
java.lang.String suppressValue)
Verify that a string value contains a substring, ignoring case.
|
static ComponentFunction |
verifyValueDoesNotContain(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify that a string value does NOT contain a substring
|
static ComponentFunction |
verifyValueDoesNotContain(java.lang.String winname,
java.lang.String compname,
java.lang.String value,
java.lang.String searchString,
java.lang.String suppressValue)
Verify that a string value does NOT contain a substring
|
static ComponentFunction |
verifyValues(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify that two string values are identical.
|
static ComponentFunction |
verifyValues(java.lang.String winname,
java.lang.String compname,
java.lang.String value1,
java.lang.String value2,
java.lang.String suppressValue)
Verify that two string values are identical.
|
static ComponentFunction |
verifyValuesIgnoreCase(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify that two string values are identical, ignoring case.
|
static ComponentFunction |
verifyValuesIgnoreCase(java.lang.String winname,
java.lang.String compname,
java.lang.String value1,
java.lang.String value2,
java.lang.String suppressValue)
Verify that two string values are identical, ignoring case.
|
static ComponentFunction |
verifyValuesNotEqual(java.lang.String winname,
java.lang.String compname,
java.lang.String[] parameters)
Verify that two string values are NOT identical.
|
static ComponentFunction |
verifyValuesNotEqual(java.lang.String winname,
java.lang.String compname,
java.lang.String value1,
java.lang.String value2,
java.lang.String suppressValue)
Verify that two string values are NOT identical.
|
public static final java.lang.String ASSIGNPROPERTYVARIABLE_KEYWORD
public static final java.lang.String CAPTUREOBJECTDATATOFILE_KEYWORD
public static final java.lang.String CAPTUREPROPERTIESTOFILE_KEYWORD
public static final java.lang.String CAPTUREPROPERTYTOFILE_KEYWORD
public static final java.lang.String CLEARAPPMAPCACHE_KEYWORD
public static final java.lang.String CLEARCACHE_KEYWORD
public static final java.lang.String EXECUTESCRIPT_KEYWORD
public static final java.lang.String GETCOMPUTEDSTYLE_KEYWORD
public static final java.lang.String GETGUIIMAGE_KEYWORD
public static final java.lang.String GETTEXTFROMGUI_KEYWORD
public static final java.lang.String GUIDOESEXIST_KEYWORD
public static final java.lang.String GUIDOESNOTEXIST_KEYWORD
public static final java.lang.String HOVERMOUSE_KEYWORD
public static final java.lang.String HOVERSCREENLOCATION_KEYWORD
public static final java.lang.String INPUTCHARACTERS_KEYWORD
public static final java.lang.String INPUTKEYS_KEYWORD
public static final java.lang.String ISPROPERTYEXIST_KEYWORD
public static final java.lang.String LOCATESCREENIMAGE_KEYWORD
public static final java.lang.String SAVETEXTFROMGUI_KEYWORD
public static final java.lang.String SENDEVENT_KEYWORD
public static final java.lang.String SETPROPERTYVALUE_KEYWORD
public static final java.lang.String SHOWONPAGE_KEYWORD
public static final java.lang.String TYPECHARS_KEYWORD
public static final java.lang.String TYPEENCRYPTION_KEYWORD
public static final java.lang.String TYPEKEYS_KEYWORD
public static final java.lang.String VERIFYARRAYPROPERTYTOFILE_KEYWORD
public static final java.lang.String VERIFYBINARYFILETOFILE_KEYWORD
public static final java.lang.String VERIFYCLIPBOARDTOFILE_KEYWORD
public static final java.lang.String VERIFYCLIPBOARDVP_KEYWORD
public static final java.lang.String VERIFYCOMPUTEDSTYLE_KEYWORD
public static final java.lang.String VERIFYFILETOFILE_KEYWORD
public static final java.lang.String VERIFYGUIIMAGETOFILE_KEYWORD
public static final java.lang.String VERIFYOBJECTDATATOFILE_KEYWORD
public static final java.lang.String VERIFYPROPERTIESSUBSETTOFILE_KEYWORD
public static final java.lang.String VERIFYPROPERTIESTOFILE_KEYWORD
public static final java.lang.String VERIFYPROPERTY_KEYWORD
public static final java.lang.String VERIFYPROPERTYCONTAINS_KEYWORD
public static final java.lang.String VERIFYPROPERTYTOFILE_KEYWORD
public static final java.lang.String VERIFYTABORDER_KEYWORD
public static final java.lang.String VERIFYTEXTFILETOFILE_KEYWORD
public static final java.lang.String VERIFYVALUECONTAINS_KEYWORD
public static final java.lang.String VERIFYVALUECONTAINSIGNORECASE_KEYWORD
public static final java.lang.String VERIFYVALUEDOESNOTCONTAIN_KEYWORD
public static final java.lang.String VERIFYVALUES_KEYWORD
public static final java.lang.String VERIFYVALUESIGNORECASE_KEYWORD
public static final java.lang.String VERIFYVALUESNOTEQUAL_KEYWORD
public static GenericMasterFunctions getInstance()
public static ComponentFunction assignPropertyVariable(java.lang.String winname, java.lang.String compname, java.lang.String propertyName, java.lang.String variableName, java.lang.String suppressValue)
Assign the string value of an object property to a specific DDVariable
Assign the string value of an object property to a specific DDVariable.
Note, if you supply the name of the variable and include the leading
caret (^) symbol then the variable must be enclosed in quotes.
Otherwise, that variable will be used like any other variable and the
substituted value of that variable will be interpretted as the name
of the variable you wish to use.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.propertyName - Optional:NO
The case-sensitive name of the object property.variableName - Optional:NO
The name of the variable to receive the property value.suppressValue - Optional:YES
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line property values.public static ComponentFunction assignPropertyVariable(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Assign the string value of an object property to a specific DDVariable
Assign the string value of an object property to a specific DDVariable.
Note, if you supply the name of the variable and include the leading
caret (^) symbol then the variable must be enclosed in quotes.
Otherwise, that variable will be used like any other variable and the
substituted value of that variable will be interpretted as the name
of the variable you wish to use.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction captureObjectDataToFile(java.lang.String winname, java.lang.String compname, java.lang.String file, java.lang.String fileEncoding, java.lang.String filterMode, java.lang.String filterOptions)
Copy the current contents of an object's data to a file.
Only an object that Robot can perform an ObjectData VP
on can use this command. By default, the files will be
stored in the active "Test" directory. If you specify a
relative path, the path will be relative to the project
directory. The directory for a full or relative path
must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.file - Optional:NO
The name of the file used to store the object data.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.filterMode - Optional:YES DefaultVal:
(Future) Specify a file filter to use to process the text before comparison.filterOptions - Optional:YES DefaultVal:
(Future) Specify filter options to use with the file filter.public static ComponentFunction captureObjectDataToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Copy the current contents of an object's data to a file.
Only an object that Robot can perform an ObjectData VP
on can use this command. By default, the files will be
stored in the active "Test" directory. If you specify a
relative path, the path will be relative to the project
directory. The directory for a full or relative path
must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction capturePropertiesToFile(java.lang.String winname, java.lang.String compname, java.lang.String file, java.lang.String fileEncoding)
Copy all of the value properties a test object to a file.
Copy all of the value properties a test object to a file.
By default, the files will be
stored in the active "Test" directory. If you specify a
relative path, the path will be relative to the project
directory. The directory for a full or relative path must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.file - Optional:NO
The name of the file used to store the property list data.fileEncoding - Optional:YES DefaultVal:
Specify a character encoding to be used when saving data to a file.public static ComponentFunction capturePropertiesToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Copy all of the value properties a test object to a file.
Copy all of the value properties a test object to a file.
By default, the files will be
stored in the active "Test" directory. If you specify a
relative path, the path will be relative to the project
directory. The directory for a full or relative path must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction capturePropertyToFile(java.lang.String winname, java.lang.String compname, java.lang.String propertyName, java.lang.String file, java.lang.String fileEncoding)
Copy a propertie's value of a test object to to a file.
Copy a propertie's value of a test object to to a file.
The file will be stored in the active "Test" directory.
If you specify a relative path, the path will be relative
to the project directory. The directory for a full or
relative path must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.propertyName - Optional:NO
The case-sensitive name of the object array property to verify.file - Optional:NO
The name of the file used to store the property list data.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.public static ComponentFunction capturePropertyToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Copy a propertie's value of a test object to to a file.
Copy a propertie's value of a test object to to a file.
The file will be stored in the active "Test" directory.
If you specify a relative path, the path will be relative
to the project directory. The directory for a full or
relative path must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction clearAppMapCache(java.lang.String winname, java.lang.String compname)
Clear the internal application map cache.
Some Engines maintain an internal cache of previously sought
application objects. In RobotJ, there exists a cache of
TestObject objects, that cache is cleared by this command
so that the recognition string algorithm has to be re-run
the next time a window or component is to be recognized.
This is useful for cases when a dialog pops up, goes
away, then pops up again. The cached version of the
dialog or it's components may not correspond to the actual
version. This command lets a tester clear the cache when
this kind of condition may arrise.
(Future: instruct the safsmaps service
to reload it's application map data)
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.public static ComponentFunction clearCache(java.lang.String winname, java.lang.String compname)
Clear the cache of a component.
Clear the cache of a component. To save time, component may contain a cache to store its content
or some time-consuming resource. But sometime, the cache's content may not be fresh, which will
affect the test, at this situation, user may call this keyword to clear the cache and SAFS will
use the latest content.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.public static ComponentFunction executeScript(java.lang.String winname, java.lang.String compname, java.lang.String script, java.lang.String paramN)
Execute a piece of script on the specified component synchronously.
Execute a piece of script on the specified component synchronously.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.script - Optional:NO
The script to execute.paramN - Optional:YES
The paramters passed to script.public static ComponentFunction executeScript(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Execute a piece of script on the specified component synchronously.
Execute a piece of script on the specified component synchronously.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction getComputedStyle(java.lang.String winname, java.lang.String compname, java.lang.String testFile)
Get a component's 'computed style', and save them to a file.
Get a component's 'computed style', and save them to a file.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.testFile - Optional:NO
The test file to save 'computed style'.public static ComponentFunction getGUIImage(java.lang.String winname, java.lang.String compname, java.lang.String outputFile, java.lang.String subArea, java.lang.String filteredAreas)
Capture the screen shot of a GUI component and save it to a file
Capture the screen shot of a GUI component and save it to a file.
The available formats for the output file are BITMAP (*.bmp) and JPEG
(*.jpg).
For RJ and IBT engine, other formats like TIFF (*.tif), GIF (*.gif),
PNG (*.png) and PNM (*.pnm) are also supported.
Optionally the user can specify part of the component to capture.
The specified GUI component/part must be in the viewing range of its
containing window. If portion of the component is displayed in the
window, only that portion will be captured; if the component falls
completely out of the viewing range of the window, the command will
fail. The command makes no attempt to bring the component into view.
Robot Classic (RC) Specific Notes:
1) This command may fail to execute if the user has turned off logging
to TestManager via the Robot tools setting. You may have to enable
TestManager logging for the command to successfully execute.
2) This command requires that the TestManager Image Comparator tool is
installed on the test machine. Machines having only the Robot Test Agent
installed will not be able to use this command.
3) Due to a bug in Robot Classic, images captured using the Robot Classic
engine may differ in image size and/or file size from those captured using
other supported engines. Depending on the comparator used, rebenching
your images may be necessary when migrating to another engine.
RobotJ (RJ) and IBT Specific Notes:
1)It requires that Java Advanced Imaging (JAI) be installed
on the test machine
2)It supports to save image in format TIFF (*.tif), GIF (*.gif), PNG (*.png)
and PNM (*.pnm)
Apple IOS specific Notes:
UIAutomation captures all screenshots as PNG images, but SAFS copies and stores them
into the image format desired (JPG, BMP, etc.). However, the rootname of the desired
output image name must be unique to avoid UIAutomation generating indexed image names
we will not be looking for.
For example, specifying MyImage.JPG and later MyImage.BMP will cause UIAutomation to capture
MyImage.PNG and MyImage1.PNG. When attempting to find MyImage.PNG captured for MyImage.BMP
we will retrieve MyImage.PNG which is NOT the correct image capture for MyImage.BMP.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.outputFile - Optional:NO
Path (with filename) to the output image file.subArea - Optional:YES
Optional app map subkey indicating partial image of the component to capture.filteredAreas - Optional:YES
"Filter=one or multiple areas" to filter the GUI image (or sub image of GUI if the parameter "SubArea" is present)public static ComponentFunction getGUIImage(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Capture the screen shot of a GUI component and save it to a file
Capture the screen shot of a GUI component and save it to a file.
The available formats for the output file are BITMAP (*.bmp) and JPEG
(*.jpg).
For RJ and IBT engine, other formats like TIFF (*.tif), GIF (*.gif),
PNG (*.png) and PNM (*.pnm) are also supported.
Optionally the user can specify part of the component to capture.
The specified GUI component/part must be in the viewing range of its
containing window. If portion of the component is displayed in the
window, only that portion will be captured; if the component falls
completely out of the viewing range of the window, the command will
fail. The command makes no attempt to bring the component into view.
Robot Classic (RC) Specific Notes:
1) This command may fail to execute if the user has turned off logging
to TestManager via the Robot tools setting. You may have to enable
TestManager logging for the command to successfully execute.
2) This command requires that the TestManager Image Comparator tool is
installed on the test machine. Machines having only the Robot Test Agent
installed will not be able to use this command.
3) Due to a bug in Robot Classic, images captured using the Robot Classic
engine may differ in image size and/or file size from those captured using
other supported engines. Depending on the comparator used, rebenching
your images may be necessary when migrating to another engine.
RobotJ (RJ) and IBT Specific Notes:
1)It requires that Java Advanced Imaging (JAI) be installed
on the test machine
2)It supports to save image in format TIFF (*.tif), GIF (*.gif), PNG (*.png)
and PNM (*.pnm)
Apple IOS specific Notes:
UIAutomation captures all screenshots as PNG images, but SAFS copies and stores them
into the image format desired (JPG, BMP, etc.). However, the rootname of the desired
output image name must be unique to avoid UIAutomation generating indexed image names
we will not be looking for.
For example, specifying MyImage.JPG and later MyImage.BMP will cause UIAutomation to capture
MyImage.PNG and MyImage1.PNG. When attempting to find MyImage.PNG captured for MyImage.BMP
we will retrieve MyImage.PNG which is NOT the correct image capture for MyImage.BMP.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction getTextFromGUI(java.lang.String winname, java.lang.String compname, java.lang.String variableName, java.lang.String subArea, java.lang.String oCRId, java.lang.String langId, java.lang.String scaleRatio)
Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
Two open-source OCRs are integrated into SAFS. One is TesseractOCR (TOCR) at
http://code.google.com/p/tesseract-ocr; the other GOCR at http://jocr.sourceforge.net.
TOCR 2.0.4 and GOCR 0.48 are the latest release. They are available in SAFS and only
support English. Both two OCR owners claim to support more languages in next release. Chinese,
Japanese, and Korean are going to be supported in TOCR's next release 3.00.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.variableName - Optional:NO
The name of the variable to receive detected text.subArea - Optional:YES
Optional app map subkey indicating partial image of the component to capture.oCRId - Optional:YES
OCRId indicating the OCR used to recognize text.langId - Optional:YES
Optional LangId representing the language in use for selected OCR to recognize text.scaleRatio - Optional:YES
Optional ScaleRatio indicating the scale ratio for resizing the original image.public static ComponentFunction getTextFromGUI(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
Two open-source OCRs are integrated into SAFS. One is TesseractOCR (TOCR) at
http://code.google.com/p/tesseract-ocr; the other GOCR at http://jocr.sourceforge.net.
TOCR 2.0.4 and GOCR 0.48 are the latest release. They are available in SAFS and only
support English. Both two OCR owners claim to support more languages in next release. Chinese,
Japanese, and Korean are going to be supported in TOCR's next release 3.00.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction gUIDoesExist(java.lang.String winname, java.lang.String compname)
Routine to verify the visual existence of a particular window and/or component.
Routine to verify the visual existence of a particular window and/or component.
If the window(Field 2) and component(Field 3) are the same then we only
check for the existence of the window. However, if the component is
actually a child of the window then we first check for the window and
then check for the component.
If a Window or Component is HIDDEN, it will be treated as if it Does NOT Exist.
The item must be VISIBLE to pass.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.public static ComponentFunction gUIDoesNotExist(java.lang.String winname, java.lang.String compname)
Routine to verify the visual non-existence of a particular window and/or component.
Routine to verify the visual non-existence of a particular window and/or component.
If the window(Field 2) and component(Field 3) are the same then we only
check for the visual non-existence of the window. However, if the component is
actually a child of the window then we first check for the visual existence of the
window and then check for the visual non-existence of the component.
If a Window or Component is HIDDEN, it will be treated as if it Does NOT Exist.
The item must not exist or be HIDDEN to pass.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.public static ComponentFunction hoverMouse(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String hoverTime)
Hover the mouse over an object.
By default, hover on the center of the component for 2000 milliseconds.
We can also hover on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then the hover command is generated at the coordinate.
Thus, an item or object can be referenced by name even though it is only
recognized via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow Component HoverMouse 1000
(2) t MainWindow MainWindow HoverMouse AnObject 2000
(3) t MainWindow FolderTree HoverMouse Node1 3000
#1 above will contain a blank as it's 5th field and 1000 as 6th field,
and it will hover at the center of the Component for 1000 milliseconds.
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to hover at x=3, y=10 in the MainWindow.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it. FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell Robot to locate the FolderTree Generic
object and hover at the coordinates specified by the reference.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Optional)Name of the AppMap subkey to lookup and use for the hover.hoverTime - Optional:YES DefaultVal:2000
(Optional)Number of milliseconds to hover.public static ComponentFunction hoverMouse(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Hover the mouse over an object.
By default, hover on the center of the component for 2000 milliseconds.
We can also hover on any part of an object based on a stored x,y
coordinate. The object containing the coordinate is first given
context and then the hover command is generated at the coordinate.
Thus, an item or object can be referenced by name even though it is only
recognized via coordinates.
The coordinate lookup is done with the component name of the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow Component HoverMouse 1000
(2) t MainWindow MainWindow HoverMouse AnObject 2000
(3) t MainWindow FolderTree HoverMouse Node1 3000
#1 above will contain a blank as it's 5th field and 1000 as 6th field,
and it will hover at the center of the Component for 1000 milliseconds.
#2 above will contain an AnObject="3,10" entry in the MainWindow section
of the Application Map to hover at x=3, y=10 in the MainWindow.
#3 above will contain a FolderTree entry in the MainWindow section with
normal recognition information for it. FolderTree will also have it's
own section in the Application Map in which there will be an entry like
Node1="15,30". This will tell Robot to locate the FolderTree Generic
object and hover at the coordinates specified by the reference.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction hoverScreenLocation(java.lang.String winname, java.lang.String compname, java.lang.String appMapSubkey, java.lang.String hoverTime)
Hover the mouse over a specified screen location.
Hover the mouse over a specified screen location.
We can hover on any screen location based on stored x,y
coordinates or hardcoded literal values. The Window:Component fields
can be anything at all and will be ignored if they do not exist in the app map,
or if the retrieved app map data does not contain coordinate data.
Thus, an item or object can be referenced by name even though it is only
known via coordinates.
If the Window:Component AppMap lookup does NOT contain coordinate data and is ignored, then
the AppMapSubKey field is REQUIRED and is expected to contain a reference or literal
text containing absolute screen coordinates.
If the Window:Component AppMap lookup DOES contain coordinate data, this data is treated as
the absolute screen coordinates to be used. The AppMapSubKey field becomes OPTIONAL and
coordinate data in the field is treated as a relative offset added to the absolute values
found for the Window:Component.
Any AppMapSubKey lookup is done with the Component name in the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow Component HoverScreenLocation 1000
(2) t MainWindow MainWindow HoverScreenLocation AnObject 2000
(3) t MainWindow MainWindow HoverScreenLocation 50,80 3000
(4) t AnyWin AnyComp HoverScreenLocation Node1 3000
#1 above will contain a blank as it's 5th field and 1000 as 6th field. Because the AppMapSubKey
field is blank, the [MainWindow] section of the AppMap MUST have a Component item with valid
absolute screen coordinate data. The mouse cursor will hover at the specified Component location
for 1000 milliseconds.
#2 above will contain an AnObject="Coords=50,80" entry in the [MainWindow] section
of the AppMap. If there is a MainWindow component in the AppMap with valid screen coordinates
then the mouse cursor will hover with a relative offset of 50,80 from those absolute screen
coordinates. Otherwise, the mouse will hover at absolute screen coordinates 50,80.
#3 If there is a MainWindow component in the [MainWindow] section of the AppMap with valid screen
coordinates then the mouse cursor will hover with a relative offset of 50,80 from those absolute
screen coordinates. Otherwise, the mouse will hover at absolute screen coordinates 50,80.
#4 above will contain no valid AnyWin:AnyComp coordinate data and
those fields will be ignored. However, Node1 MUST exist in the
Application Map [AnyComp] section to provide absolute screen coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.appMapSubkey - Optional:YES
(Sometimes Optional)Name of the AppMap subkey to lookup and use for the hover.hoverTime - Optional:YES DefaultVal:2000
(Optional)Number of milliseconds to hover.public static ComponentFunction hoverScreenLocation(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Hover the mouse over a specified screen location.
Hover the mouse over a specified screen location.
We can hover on any screen location based on stored x,y
coordinates or hardcoded literal values. The Window:Component fields
can be anything at all and will be ignored if they do not exist in the app map,
or if the retrieved app map data does not contain coordinate data.
Thus, an item or object can be referenced by name even though it is only
known via coordinates.
If the Window:Component AppMap lookup does NOT contain coordinate data and is ignored, then
the AppMapSubKey field is REQUIRED and is expected to contain a reference or literal
text containing absolute screen coordinates.
If the Window:Component AppMap lookup DOES contain coordinate data, this data is treated as
the absolute screen coordinates to be used. The AppMapSubKey field becomes OPTIONAL and
coordinate data in the field is treated as a relative offset added to the absolute values
found for the Window:Component.
Any AppMapSubKey lookup is done with the Component name in the record AND
Field #5.
Typical Data Table records:
(1) t MainWindow Component HoverScreenLocation 1000
(2) t MainWindow MainWindow HoverScreenLocation AnObject 2000
(3) t MainWindow MainWindow HoverScreenLocation 50,80 3000
(4) t AnyWin AnyComp HoverScreenLocation Node1 3000
#1 above will contain a blank as it's 5th field and 1000 as 6th field. Because the AppMapSubKey
field is blank, the [MainWindow] section of the AppMap MUST have a Component item with valid
absolute screen coordinate data. The mouse cursor will hover at the specified Component location
for 1000 milliseconds.
#2 above will contain an AnObject="Coords=50,80" entry in the [MainWindow] section
of the AppMap. If there is a MainWindow component in the AppMap with valid screen coordinates
then the mouse cursor will hover with a relative offset of 50,80 from those absolute screen
coordinates. Otherwise, the mouse will hover at absolute screen coordinates 50,80.
#3 If there is a MainWindow component in the [MainWindow] section of the AppMap with valid screen
coordinates then the mouse cursor will hover with a relative offset of 50,80 from those absolute
screen coordinates. Otherwise, the mouse will hover at absolute screen coordinates 50,80.
#4 above will contain no valid AnyWin:AnyComp coordinate data and
those fields will be ignored. However, Node1 MUST exist in the
Application Map [AnyComp] section to provide absolute screen coordinates.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction inputCharacters(java.lang.String winname, java.lang.String compname, java.lang.String textValue)
Sends literal text to the specified component.
Sends literal text to the specified component.
The InputChars command does not convert or interpret any special
characters like InputKeys (InputKeystrokes) does.
Some engines cannot set keyboard focus to the component.
These engines will require the component already have keyboard focus before
calling this command.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.textValue - Optional:NO
String of keystrokes to send.public static ComponentFunction inputKeys(java.lang.String winname, java.lang.String compname, java.lang.String textValue)
Sends keystrokes to the specified component.
Sends keystrokes to the specified component.
Some engines cannot set keyboard focus to the component.
These engines will require the component already have keyboard focus before
calling this command.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.textValue - Optional:NO
String of keystrokes to send.public static ComponentFunction isPropertyExist(java.lang.String winname, java.lang.String compname, java.lang.String propertyName, java.lang.String propertyExistVariable)
Verify if object's property exists or not.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.propertyName - Optional:NO
The case-sensitive name of the object property to verify.propertyExistVariable - Optional:NO
The variable to store 'true' or 'false' to indicate if the property exist or not.public static ComponentFunction isPropertyExist(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify if object's property exists or not.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction locateScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String variableName, java.lang.String whomRelativeTo)
Store the location and dimensions of a component.
Store the location and dimensions of a component.
The component can be SAFS IBT, RJ, Selenium object.
The information is stored in a collection of variables using the variable root name provided.
The following variables are set by this command:
rootname=x y w h [space delimited values]
rootname.x=x
rootname.y=y
rootname.w=w
rootname.h=h
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.variableName - Optional:NO
The root name of the collection of variables to receive the location and dimensions.whomRelativeTo - Optional:YES DefaultVal:screen
This parameter decides the coordinates stored in VariableName is relative to the screen or the parent window.
'screen' means they are relative to the screen; 'parent' means they are relative to the parent window.
The parameter is curently available in RJ only.public static ComponentFunction locateScreenImage(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Store the location and dimensions of a component.
Store the location and dimensions of a component.
The component can be SAFS IBT, RJ, Selenium object.
The information is stored in a collection of variables using the variable root name provided.
The following variables are set by this command:
rootname=x y w h [space delimited values]
rootname.x=x
rootname.y=y
rootname.w=w
rootname.h=h
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction saveTextFromGUI(java.lang.String winname, java.lang.String compname, java.lang.String outputFile, java.lang.String subArea, java.lang.String oCRId, java.lang.String langId, java.lang.String scaleRatio)
Incorporate OCR technology to detect the text on a GUI component and save the text to a text file.
Two open-source OCRs are integrated into SAFS. One is TesseractOCR (TOCR) at
http://code.google.com/p/tesseract-ocr; the other GOCR at http://jocr.sourceforge.net.
TOCR 2.0.4 and GOCR 0.48 are the latest release. They are available in SAFS and only
support English. Both two OCR owners claim to support more languages in next release. Chinese,
Japanese, and Korean are going to be supported in TOCR's next release 3.00.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.outputFile - Optional:NO
The name of the text file used to store detected text.subArea - Optional:YES
Optional app map subkey indicating partial image of the component to capture.oCRId - Optional:YES
OCRId indicating the OCR used to recognize text.langId - Optional:YES
Optional LangId representing the language in use for selected OCR to recognize text.scaleRatio - Optional:YES
Optional ScaleRatio indicating the scale ratio for resizing the original image.public static ComponentFunction saveTextFromGUI(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Incorporate OCR technology to detect the text on a GUI component and save the text to a text file.
Two open-source OCRs are integrated into SAFS. One is TesseractOCR (TOCR) at
http://code.google.com/p/tesseract-ocr; the other GOCR at http://jocr.sourceforge.net.
TOCR 2.0.4 and GOCR 0.48 are the latest release. They are available in SAFS and only
support English. Both two OCR owners claim to support more languages in next release. Chinese,
Japanese, and Korean are going to be supported in TOCR's next release 3.00.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction sendEvent(java.lang.String winname, java.lang.String compname, java.lang.String event, java.lang.String pARAM_N)
Send or trigger an "event" with 0 or more arguments.
For objects or technologies that can be effectively event-driven, rather than GUI-driven.
The first implementation is in IBM Rational Functional Tester for Flex testing. Many Flex objects
respond to events, in addition to traditional GUI interaction. Some Flex objects ONLY respond to
events. This is especially true of many custom Flex delegates.
The tester must know the events and arguments available for their particular object and technology.
The generic nature for this command cannot generally know if a particular event or set of
arguments is valid or not. Thus, the implementation may not be able issue failures resulting from
invalid events, arguments, or other issues not generating recognizable failure conditions.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.event - Optional:NO
The potentially case-sensitive name of the event to send or trigger.pARAM_N - Optional:YES
The first of 0 or more parameters needed for the event.public static ComponentFunction sendEvent(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Send or trigger an "event" with 0 or more arguments.
For objects or technologies that can be effectively event-driven, rather than GUI-driven.
The first implementation is in IBM Rational Functional Tester for Flex testing. Many Flex objects
respond to events, in addition to traditional GUI interaction. Some Flex objects ONLY respond to
events. This is especially true of many custom Flex delegates.
The tester must know the events and arguments available for their particular object and technology.
The generic nature for this command cannot generally know if a particular event or set of
arguments is valid or not. Thus, the implementation may not be able issue failures resulting from
invalid events, arguments, or other issues not generating recognizable failure conditions.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction setPropertyValue(java.lang.String winname, java.lang.String compname, java.lang.String objectPropertyName, java.lang.String propertyValue)
Sets a value to the property of an object.
Routine to set a value to the property of an object..
The routine expects that the given object already has Context or Focus.
It also expects that Global StepDriverTestInfo contains all the information
it needs to perform its function.
The routine will set the StepDriverTestInfo.statuscode and log any pass/fail info
using the StepDriverTestInfo.fac LogFacility.
RJ implementation directly modifies the object in the software under test;therefore, it should be done with extreme care.
Avoid using setPropertyValue whenever possible because it allows you to modify the software under test in ways that a typical user cannot.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.objectPropertyName - Optional:NO
The name of the property of the object.propertyValue - Optional:NO
The value to set the property to.public static ComponentFunction setPropertyValue(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Sets a value to the property of an object.
Routine to set a value to the property of an object..
The routine expects that the given object already has Context or Focus.
It also expects that Global StepDriverTestInfo contains all the information
it needs to perform its function.
The routine will set the StepDriverTestInfo.statuscode and log any pass/fail info
using the StepDriverTestInfo.fac LogFacility.
RJ implementation directly modifies the object in the software under test;therefore, it should be done with extreme care.
Avoid using setPropertyValue whenever possible because it allows you to modify the software under test in ways that a typical user cannot.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction showOnPage(java.lang.String winname, java.lang.String compname, java.lang.String verify)
Make the component visible on the page.
Make the component visible on the page.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.verify - Optional:YES DefaultVal:False"True" to verify that the component is shown on page.public static ComponentFunction typeChars(java.lang.String winname, java.lang.String compname, java.lang.String textValue)
Sends literal text keystrokes to whatever has keyboard focus.
Sends literal text keystrokes to whatever has keyboard focus.
The TypeChars command does not convert or interpret any special
characters like InputKeys or TypeKeys do.
No attempt is made to locate any specific window or component.
Keystrokes are simply sent to the system.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.textValue - Optional:NO
String of keystrokes to send.public static ComponentFunction typeEncryption(java.lang.String winname, java.lang.String compname, java.lang.String encryptedDataFile, java.lang.String privateKeyFile)
Sends secret-text (such as password) to whatever has keyboard focus.
User needs to provide the path to the "encrypted text" and the path
to the "private key".
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.encryptedDataFile - Optional:NO
The full path of the file where the "encrypted data" is stored.privateKeyFile - Optional:NO
The full path of the file where the "private key" is stored.public static ComponentFunction typeEncryption(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Sends secret-text (such as password) to whatever has keyboard focus.
User needs to provide the path to the "encrypted text" and the path
to the "private key".
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction typeKeys(java.lang.String winname, java.lang.String compname, java.lang.String textValue)
Sends keystrokes to whatever has keyboard focus.
Sends keystrokes to whatever has keyboard focus.
No attempt is made to locate any specific window or component.
Keystrokes are simply sent to the system.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.textValue - Optional:NO
String of keystrokes to send.public static ComponentFunction verifyArrayPropertyToFile(java.lang.String winname, java.lang.String compname, java.lang.String propertyName, java.lang.String benchmarkFile, java.lang.String filterMode, java.lang.String filterOptions)
Verify the value of an array property with a benchmark file
Typically, benchmarks are stored in the Datapool\Bench directory.
In that event, only the filename.ext is needed. There is currently
a limit of 32K allowed for this type of comparison.
The command will produce a TEST WARNING if the user has configured an
alternate DIFF tool for which we have no means to compare the diff results.
If this WARNING is expected, the user should use the "TW" test record type.
Note: for RobotJ,Suggest to use RFT Inspector to confirm which property should be used. There are two examples:
For Java swing List and ComboBox items can be fetchedusing the '.itemText' property (Note the dot)
For Html List (type is html.select) items can be fetchedusing the '.text' property (Note the dot)
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.propertyName - Optional:NO
The case-sensitive name of the object array property to verify.benchmarkFile - Optional:NO
The name of the file used as the comparison benchmark.filterMode - Optional:YES DefaultVal:
(Future) Specify a file filter to use to process the text before comparison.filterOptions - Optional:YES DefaultVal:
(Future) Specify filter options to use with the file filter.public static ComponentFunction verifyArrayPropertyToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the value of an array property with a benchmark file
Typically, benchmarks are stored in the Datapool\Bench directory.
In that event, only the filename.ext is needed. There is currently
a limit of 32K allowed for this type of comparison.
The command will produce a TEST WARNING if the user has configured an
alternate DIFF tool for which we have no means to compare the diff results.
If this WARNING is expected, the user should use the "TW" test record type.
Note: for RobotJ,Suggest to use RFT Inspector to confirm which property should be used. There are two examples:
For Java swing List and ComboBox items can be fetchedusing the '.itemText' property (Note the dot)
For Html List (type is html.select) items can be fetchedusing the '.text' property (Note the dot)
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyBinaryFileToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchmarkFile, java.lang.String actualFile, java.lang.String filterMode, java.lang.String filterOptions, java.lang.String alterImageStyle, java.lang.String alterImageFactor, java.lang.String pdfResolution)
Verify the current contents of a binary (image, PDF etc.) file with a benchmark file.
Verify the current contents of a binary (image, PDF etc.) file with a benchmark file.
Typically, benchmarks are stored in the Datapool\Bench directory.
Typically, files to test are stored in the Datapool\Test directory.
In that event, the filename.ext is needed for both files.
The Window and Component objects are not validated and have no role.
The Window and Component strings can be any text, but they cannot be blank.
If the files are image, a diff image will be created if there are considered different.
If the files are PDF, they will be converted to image files and then compared as image file. Each PDF page
will be converted to an image, so comparison of 2 PDF files might be comparison of 2 set of image files.
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:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchmarkFile - Optional:NO
File used as the comparison benchmark.actualFile - Optional:NO
File used as the comparison file under test.filterMode - Optional:YES DefaultVal:
Specify a filter to use to process the file content before comparison.filterOptions - Optional:YES DefaultVal:
Specify filter options to use with the filter.alterImageStyle - Optional:YES DefaultVal:
It is used to alter the diff image when 2 image/PDF doesn't match.alterImageFactor - Optional:YES DefaultVal:
How much lighter or darker to alter the original pixel (with no difference), it is a double number between 0 and 1.pdfResolution - Optional:YES DefaultVal:
The resolution (DPI) used to convert PDF to image.public static ComponentFunction verifyBinaryFileToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the current contents of a binary (image, PDF etc.) file with a benchmark file.
Verify the current contents of a binary (image, PDF etc.) file with a benchmark file.
Typically, benchmarks are stored in the Datapool\Bench directory.
Typically, files to test are stored in the Datapool\Test directory.
In that event, the filename.ext is needed for both files.
The Window and Component objects are not validated and have no role.
The Window and Component strings can be any text, but they cannot be blank.
If the files are image, a diff image will be created if there are considered different.
If the files are PDF, they will be converted to image files and then compared as image file. Each PDF page
will be converted to an image, so comparison of 2 PDF files might be comparison of 2 set of image files.
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:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyClipboardToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchmarkFile, java.lang.String filterMode, java.lang.String filterOptions)
Verify the current contents of the Windows clipboard with a benchmark file.
Verify the current contents of the Windows clipboard with a benchmark file.
Typically, benchmarks are stored in the Datapool\Bench directory.
In that event, only the filename.ext is needed. There is currently
a limit of 32K allowed for this type of comparison.
The Window and Component objects are not validated and have no role.
The Window and Component strings can be any text, but they cannot be blank.
The command will produce a TEST WARNING if the user has configured an
alternate DIFF tool for which we have no means to compare the diff results.
If this WARNING is expected, the user should use the "TW" test record type.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchmarkFile - Optional:NO
The name of the file used as the comparison benchmark.filterMode - Optional:YES DefaultVal:
(Future) Specify a file filter to use to process the text before comparison.filterOptions - Optional:YES DefaultVal:
(Future) Specify filter options to use with the file filter.public static ComponentFunction verifyClipboardToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the current contents of the Windows clipboard with a benchmark file.
Verify the current contents of the Windows clipboard with a benchmark file.
Typically, benchmarks are stored in the Datapool\Bench directory.
In that event, only the filename.ext is needed. There is currently
a limit of 32K allowed for this type of comparison.
The Window and Component objects are not validated and have no role.
The Window and Component strings can be any text, but they cannot be blank.
The command will produce a TEST WARNING if the user has configured an
alternate DIFF tool for which we have no means to compare the diff results.
If this WARNING is expected, the user should use the "TW" test record type.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyClipboardVP(java.lang.String winname, java.lang.String compname, java.lang.String vPName)
Verify the current contents of the Windows clipboard using a Robot ClipboardVP.
Verify the current contents of the Windows clipboard using a Robot ClipboardVP.
The benchmark VP must already exist as an asset of the currently running script.
If the provided VP is NOT a reference in the AppMap then a standard VP compare
will occur with the typical VP parameter value like "VP=StoredVP".
However, if you wish to modify the ClipboardVP parameter values, such as
specifying that the expected result = FAIL, then you must make an entry
in the AppMap under the Component name to provide these modified parameters.
The Window and Component objects are not validated and normally have no role.
The Window and Component strings can normally be any text, but they cannot be blank.
However, the Component must be a valid section in the AppMap if we wish to store
modified VP parameter settings.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.vPName - Optional:NO
The name of the ClipboardVP from the currently running script.public static ComponentFunction verifyComputedStyle(java.lang.String winname, java.lang.String compname, java.lang.String benchFile)
Verify a component's 'computed style' against a benchmark file.
Verify a component's 'computed style' against a benchmark file.
If the comparison fails, a copy of the captured 'computed style' should be stored in
the project's Test directory. This file, once verified, should be suitable to become a
new benchmark, if needed.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchFile - Optional:NO
The benchmake file to compare against.public static ComponentFunction verifyFileToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchmarkFile, java.lang.String actualFile, java.lang.String filterMode, java.lang.String filterOptions)
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
Typically, benchmarks are stored in the Datapool\Bench directory.
Typically, files to test are stored in the Datapool\Test directory.
In that event, the filename.ext is needed for both files.
The Window and Component objects are not validated and have no role.
The Window and Component strings can be any text, but they cannot be blank.
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:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchmarkFile - Optional:NO
File used as the comparison benchmark.actualFile - Optional:NO
File used as the comparison file under test.filterMode - Optional:YES DefaultVal:
(Future) Specify a file filter to use to process the text before comparison.filterOptions - Optional:YES DefaultVal:
(Future) Specify filter options to use with the file filter.public static ComponentFunction verifyFileToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
Typically, benchmarks are stored in the Datapool\Bench directory.
Typically, files to test are stored in the Datapool\Test directory.
In that event, the filename.ext is needed for both files.
The Window and Component objects are not validated and have no role.
The Window and Component strings can be any text, but they cannot be blank.
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:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyGUIImageToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchmarkFile, java.lang.String subArea, java.lang.String percentageTolerance, java.lang.String uUIDFlag, java.lang.String filteredAreas)
Verify the screen shot of a GUI component with a benchmark image file
Verify the screen shot of a GUI component with a benchmark image file.
The benchmark file must reside in the \Datapool\Bench folder.
Only BMP and JPG files can be used as the benchmark. If the extension
of the bench file is not BMP or JPG, it is considered a BMP file.
For RJ and IBT engine, other formats like TIFF (*.tif), GIF (*.gif),
PNG (*.png) and PNM (*.pnm) are also supported.
Optionally the user can specify part of the component to verify.
The specified GUI component/part must be in the viewing range of its
containing window. If portion of the component is displayed in the
window, only that portion will be captured; if the component falls
completely out of the viewing range of the window, the command will
fail. The command makes no attemp to bring the component into view.
NOTE: the command may fail to execute if the user has turned off logging
to TestManager via the Robot tools setting. You may have to enable TestManager
logging for the command to successfully execute.
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.
This command requires that TestManager Image Comparator tool is
installed on the machine. Machines having only the Robot Test Agent
installed will not be able to usee this command.
RobotJ (RJ) and IBT Specific Notes:
1)It requires that Java Advanced Imaging (JAI) be installed
on the test machine
2)It supports to save image in format TIFF (*.tif), GIF (*.gif), PNG (*.png)
and PNM (*.pnm)
Apple IOS specific Notes:
UIAutomation captures all screenshots as PNG images, but SAFS copies and stores them
into the image format desired (JPG, BMP, etc.). However, the rootname of the desired
output image name must be unique to avoid UIAutomation generating indexed image names
we will not be looking for.
For example, specifying MyImage.JPG and later MyImage.BMP will cause UIAutomation to capture
MyImage.PNG and MyImage1.PNG. When attempting to find MyImage.PNG captured for MyImage.BMP
we will retrieve MyImage.PNG which is NOT the correct image capture for MyImage.BMP.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchmarkFile - Optional:NO
Name of the benchmark image file.subArea - Optional:YES
Optional app map subkey indicating partial image of the component to verify.percentageTolerance - Optional:YES
The percentage of bits need to be matched.uUIDFlag - Optional:YES
"UUID=False" to make Test/Actuals Filenames the same as the Benchmark.filteredAreas - Optional:YES
"Filter=one or multiple areas" to filter the GUI image (or sub image of GUI if the parameter "SubArea" is present)
and it will also be used to filter the bench image before comparing. If there are some differences, the diff image
will be made between these 2 filtered images (not the acutal and bench image).public static ComponentFunction verifyGUIImageToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the screen shot of a GUI component with a benchmark image file
Verify the screen shot of a GUI component with a benchmark image file.
The benchmark file must reside in the \Datapool\Bench folder.
Only BMP and JPG files can be used as the benchmark. If the extension
of the bench file is not BMP or JPG, it is considered a BMP file.
For RJ and IBT engine, other formats like TIFF (*.tif), GIF (*.gif),
PNG (*.png) and PNM (*.pnm) are also supported.
Optionally the user can specify part of the component to verify.
The specified GUI component/part must be in the viewing range of its
containing window. If portion of the component is displayed in the
window, only that portion will be captured; if the component falls
completely out of the viewing range of the window, the command will
fail. The command makes no attemp to bring the component into view.
NOTE: the command may fail to execute if the user has turned off logging
to TestManager via the Robot tools setting. You may have to enable TestManager
logging for the command to successfully execute.
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.
This command requires that TestManager Image Comparator tool is
installed on the machine. Machines having only the Robot Test Agent
installed will not be able to usee this command.
RobotJ (RJ) and IBT Specific Notes:
1)It requires that Java Advanced Imaging (JAI) be installed
on the test machine
2)It supports to save image in format TIFF (*.tif), GIF (*.gif), PNG (*.png)
and PNM (*.pnm)
Apple IOS specific Notes:
UIAutomation captures all screenshots as PNG images, but SAFS copies and stores them
into the image format desired (JPG, BMP, etc.). However, the rootname of the desired
output image name must be unique to avoid UIAutomation generating indexed image names
we will not be looking for.
For example, specifying MyImage.JPG and later MyImage.BMP will cause UIAutomation to capture
MyImage.PNG and MyImage1.PNG. When attempting to find MyImage.PNG captured for MyImage.BMP
we will retrieve MyImage.PNG which is NOT the correct image capture for MyImage.BMP.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyObjectDataToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchmarkFile, java.lang.String fileEncoding, java.lang.String filterMode, java.lang.String filterOptions)
Verify the current contents of an object's data with a benchmark file.
Typically, benchmarks are stored in the Datapool\Bench directory.
In that event, only the filename.ext is needed. Only an object that
Robot can perform an ObjectData VP on can use this command.
The command will produce a TEST WARNING if the user has configured an
alternate DIFF tool for which we have no means to compare the diff results.
If this WARNING is expected, the user should use the "TW" test record type.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchmarkFile - Optional:NO
The name of the file used as the comparison benchmark.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.filterMode - Optional:YES DefaultVal:
(Future) Specify a file filter to use to process the text before comparison.filterOptions - Optional:YES DefaultVal:
(Future) Specify filter options to use with the file filter.public static ComponentFunction verifyObjectDataToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the current contents of an object's data with a benchmark file.
Typically, benchmarks are stored in the Datapool\Bench directory.
In that event, only the filename.ext is needed. Only an object that
Robot can perform an ObjectData VP on can use this command.
The command will produce a TEST WARNING if the user has configured an
alternate DIFF tool for which we have no means to compare the diff results.
If this WARNING is expected, the user should use the "TW" test record type.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyPropertiesSubsetToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchFile, java.lang.String fileEncoding)
Compare/Verify the subset of properties of a test object with the values stored in a benchmark file.
Compare/Verify the subset of properties of a test object with the values stored in a benchmark file.
Only the properties stored in the benchmark are compared against the properties of the test object.
The benchmark file is expected to be stored in the active "Bench" directory.
If you specify a relative path, the path will be relative to the project
directory. The directory for a full or relative path must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchFile - Optional:NO
The name of the file used to store the benchmark property data.fileEncoding - Optional:YES DefaultVal:
Specify a character encoding to be used when loading data from the file.public static ComponentFunction verifyPropertiesSubsetToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Compare/Verify the subset of properties of a test object with the values stored in a benchmark file.
Compare/Verify the subset of properties of a test object with the values stored in a benchmark file.
Only the properties stored in the benchmark are compared against the properties of the test object.
The benchmark file is expected to be stored in the active "Bench" directory.
If you specify a relative path, the path will be relative to the project
directory. The directory for a full or relative path must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyPropertiesToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchFile, java.lang.String fileEncoding)
Compare/Verify ALL of the value properties of a test object with a benchmark file.
Compare/Verify all of the value properties of a test object with a benchmark file.
The benchmark file is expected to be stored in the active "Bench" directory.
If you specify a relative path, the path will be relative to the project
directory. The directory for a full or relative path must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchFile - Optional:NO
The name of the file used to store the benchmark property data.fileEncoding - Optional:YES DefaultVal:
Specify a character encoding to be used when loading data from the file.public static ComponentFunction verifyPropertiesToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Compare/Verify ALL of the value properties of a test object with a benchmark file.
Compare/Verify all of the value properties of a test object with a benchmark file.
The benchmark file is expected to be stored in the active "Bench" directory.
If you specify a relative path, the path will be relative to the project
directory. The directory for a full or relative path must already exist.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyProperty(java.lang.String winname, java.lang.String compname, java.lang.String propertyName, java.lang.String expectedValue, java.lang.String caseInsensitive)
Verify the value of a single object property
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.propertyName - Optional:NO
The case-sensitive name of the object property to verify.expectedValue - Optional:NO
The case-sensitive value we expect to get from the object property.caseInsensitive - Optional:YES
Values of "CASE-INSENSITIVE", "CASEINSENSITIVE", and "FALSE" will cause the
comparison of the property value and the expected value to ignore case.public static ComponentFunction verifyProperty(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the value of a single object property
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyPropertyContains(java.lang.String winname, java.lang.String compname, java.lang.String propertyName, java.lang.String searchString, java.lang.String caseInsensitive)
Verify that the value of an object property contains a string
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.propertyName - Optional:NO
The case-sensitive name of the object property to verify.searchString - Optional:NO
The case-sensitive value we expect the object property to contain.caseInsensitive - Optional:YES
Values of "CASE-INSENSITIVE", "CASEINSENSITIVE", and "FALSE" will cause the
comparison of the property value and the expected value to ignore case.public static ComponentFunction verifyPropertyContains(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify that the value of an object property contains a string
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyPropertyToFile(java.lang.String winname, java.lang.String compname, java.lang.String propertyName, java.lang.String benchmarkFile, java.lang.String fileEncoding, java.lang.String filterMode, java.lang.String filterOptions)
Verify the value of a single object property with a benchmark file
Verify the value of a single object property with a benchmark file.
Typically, benchmarks are stored in the Datapool\Bench directory.
In that event, only the filename.ext is needed. There is currently
a limit of 32K allowed for this type of comparison.
The command will produce a TEST WARNING if the user has configured an
alternate DIFF tool for which we have no means to compare the diff results.
If this WARNING is expected, the user should use the "TW" test record type.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.propertyName - Optional:NO
The case-sensitive name of the object property to verify.benchmarkFile - Optional:NO
The name of the file used as the comparison benchmark.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.filterMode - Optional:YES DefaultVal:
(Future) Specify a file filter to use to process the text before comparison.filterOptions - Optional:YES DefaultVal:
(Future) Specify filter options to use with the file filter.public static ComponentFunction verifyPropertyToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the value of a single object property with a benchmark file
Verify the value of a single object property with a benchmark file.
Typically, benchmarks are stored in the Datapool\Bench directory.
In that event, only the filename.ext is needed. There is currently
a limit of 32K allowed for this type of comparison.
The command will produce a TEST WARNING if the user has configured an
alternate DIFF tool for which we have no means to compare the diff results.
If this WARNING is expected, the user should use the "TW" test record type.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyTabOrder(java.lang.String winname, java.lang.String compname, java.lang.String fileName)
Attempts to verify the tab order of the specified object--usually a Window.
Attempts to verify the tab order of the current object--usually a Window.
A file is used to store the correct tab order of the interface.
The file is simply a list of component names in the order we expect to find
them as we tab through the interface. Each line in the file will contain a
single component name. That can be either the real valid Name given to the
component by development, or the name for the component from the AppMap. The
AppMap name is highly recommended to reduce maintenance of the tab order file.
Blank lines or commented lines are ignored. Comment lines begin with
apostrophe(') or semi-colon(;) characters.
Example file:
;Tab Order Benchmark File
;For ClassicC Login Window
(blank)
UserIDComboBox
PasswordEditBox
RememberCheckBox
(blank)
OKButton
CancelButton
This file would normally be placed in the Datapool\Bench directory.
The function will verify that the object order in the interface is the same
object order that is in the file. This is done by checking the FOCUS
Property of the current object and using the TAB key for navigation.
Thus, navigation by the TAB key must be supported by the application.
The routine will only check the tab order for the number of items found
in the tab order benchmark file. Thus, the user can perform partial tests
on different portions of the interface at different times. Just make sure
that the item that currently has the focus is the first item in the tab order
benchmark file when invoking this command.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.fileName - Optional:NO
Filename of TabOrder benchmark file.public static ComponentFunction verifyTextFileToFile(java.lang.String winname, java.lang.String compname, java.lang.String benchmarkFile, java.lang.String actualFile, java.lang.String filterMode, java.lang.String filterOptions)
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
Typically, benchmarks are stored in the Datapool\Bench directory.
Typically, files to test are stored in the Datapool\Test directory.
In that event, the filename.ext is needed for both files.
The Window and Component objects are not validated and have no role.
The Window and Component strings can be any text, but they cannot be blank.
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:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.benchmarkFile - Optional:NO
File used as the comparison benchmark.actualFile - Optional:NO
File used as the comparison file under test.filterMode - Optional:YES DefaultVal:
(Future) Specify a file filter to use to process the text before comparison.filterOptions - Optional:YES DefaultVal:
(Future) Specify filter options to use with the file filter.public static ComponentFunction verifyTextFileToFile(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
Typically, benchmarks are stored in the Datapool\Bench directory.
Typically, files to test are stored in the Datapool\Test directory.
In that event, the filename.ext is needed for both files.
The Window and Component objects are not validated and have no role.
The Window and Component strings can be any text, but they cannot be blank.
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:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyValueContains(java.lang.String winname, java.lang.String compname, java.lang.String value, java.lang.String searchString, java.lang.String suppressValue)
Verify that a string value contains a substring
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.value - Optional:NO
The case-sensitive string value to verify.searchString - Optional:NO
The case-sensitive value we expect the preceeding string to contain.suppressValue - Optional:YES
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.public static ComponentFunction verifyValueContains(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify that a string value contains a substring
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyValueContainsIgnoreCase(java.lang.String winname, java.lang.String compname, java.lang.String value, java.lang.String searchString, java.lang.String suppressValue)
Verify that a string value contains a substring, ignoring case.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.value - Optional:NO
The case-insensitive string value to verify.searchString - Optional:NO
The case-insensitive value we expect the preceeding string to contain.suppressValue - Optional:YES
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.public static ComponentFunction verifyValueContainsIgnoreCase(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify that a string value contains a substring, ignoring case.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyValueDoesNotContain(java.lang.String winname, java.lang.String compname, java.lang.String value, java.lang.String searchString, java.lang.String suppressValue)
Verify that a string value does NOT contain a substring
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.value - Optional:NO
The case-sensitive string value to verify.searchString - Optional:NO
The case-sensitive value we do NOT want to find in the provided Value.suppressValue - Optional:YES
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.public static ComponentFunction verifyValueDoesNotContain(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify that a string value does NOT contain a substring
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyValues(java.lang.String winname, java.lang.String compname, java.lang.String value1, java.lang.String value2, java.lang.String suppressValue)
Verify that two string values are identical. Note: RobotJ
also uses identical keyword 'VerifyValueEquals'
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.value1 - Optional:NO
A case-sensitive string value to compare.value2 - Optional:NO
A case-sensitive value to compare.suppressValue - Optional:YES
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.public static ComponentFunction verifyValues(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify that two string values are identical. Note: RobotJ
also uses identical keyword 'VerifyValueEquals'
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyValuesIgnoreCase(java.lang.String winname, java.lang.String compname, java.lang.String value1, java.lang.String value2, java.lang.String suppressValue)
Verify that two string values are identical, ignoring case.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.value1 - Optional:NO
A case-insensitive string value to compare.value2 - Optional:NO
A case-insensitive value to compare.suppressValue - Optional:YES
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.public static ComponentFunction verifyValuesIgnoreCase(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify that two string values are identical, ignoring case.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
public static ComponentFunction verifyValuesNotEqual(java.lang.String winname, java.lang.String compname, java.lang.String value1, java.lang.String value2, java.lang.String suppressValue)
Verify that two string values are NOT identical.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.value1 - Optional:NO
A case-sensitive string value to compare.value2 - Optional:NO
A case-sensitive value to compare.suppressValue - Optional:YES
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.public static ComponentFunction verifyValuesNotEqual(java.lang.String winname, java.lang.String compname, java.lang.String[] parameters)
Verify that two string values are NOT identical.
Supporting Engines:
winname - Optional:NO
The name of the window to act upon.compname - Optional:NO
The name of the component to act upon.parameters - Optional:NO
An array containing the following parameters:
Copyright © SAS Institute. All Rights Reserved.