public class DDDriverCommands
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
APPMAPCHAINING_KEYWORD
"AppMapChaining"
|
static java.lang.String |
APPMAPRESOLVE_KEYWORD
"AppMapResolve"
|
static java.lang.String |
ASSIGNCLIPBOARDVARIABLE_KEYWORD
"AssignClipboardVariable"
|
static java.lang.String |
CALLREMOTE_KEYWORD
"CallRemote"
|
static java.lang.String |
CAPTUREMOUSEPOSITIONONSCREEN_KEYWORD
"CaptureMousePositionOnScreen"
|
static java.lang.String |
CLEARALLVARIABLES_KEYWORD
"ClearAllVariables"
|
static java.lang.String |
CLEARAPPMAPCACHE_KEYWORD
"ClearAppMapCache"
|
static java.lang.String |
CLEARARRAYVARIABLES_KEYWORD
"ClearArrayVariables"
|
static java.lang.String |
CLEARCLIPBOARD_KEYWORD
"ClearClipboard"
|
static java.lang.String |
CLOSEAPPLICATION_KEYWORD
"CloseApplication"
|
static java.lang.String |
CLOSEAPPLICATIONMAP_KEYWORD
"CloseApplicationMap"
|
static java.lang.String |
COPYVARIABLEVALUEEX_KEYWORD
"CopyVariableValueEx"
|
static java.lang.String |
DELAY_KEYWORD
"Delay"
|
static java.lang.String |
DISABLEDOMAIN_KEYWORD
"DisableDomain"
|
static java.lang.String |
ENABLEDOMAIN_KEYWORD
"EnableDomain"
|
static java.lang.String |
EXPRESSIONS_KEYWORD
"Expressions"
|
static java.lang.String |
GET_SECS_BEFORE_MOUSE_DOWN_KEYWORD
"GetSecsBeforeMouseDown"
|
static java.lang.String |
GET_SECS_BEFORE_MOUSE_UP_KEYWORD
"GetSecsBeforeMouseUp"
|
static java.lang.String |
GETAPPMAPVALUE_KEYWORD
"GetAppMapValue"
|
static java.lang.String |
GETCOMPSCREENRESOLUTION_KEYWORD
"GetCompScreenResolution"
|
static java.lang.String |
GETDELTADATE_KEYWORD
"GetDeltaDate"
|
static java.lang.String |
GETMILLISBETWEENRECORDS_KEYWORD
"GetMillisBetweenRecords"
|
static java.lang.String |
GETREGISTRYKEYVALUE_KEYWORD
"GetRegistryKeyValue"
|
static java.lang.String |
GETSECSAFTERWINDOWACTIVE_KEYWORD
"GetSecsAfterWindowActive"
|
static java.lang.String |
GETSECSDELAYRETRYCOMPONENT_KEYWORD
"GetSecsDelayRetryComponent"
|
static java.lang.String |
GETSECSSEEKCOMPONENT_KEYWORD
"GetSecsSeekComponent"
|
static java.lang.String |
GETSYSTEMDATE_KEYWORD
"GetSystemDate"
|
static java.lang.String |
GETSYSTEMDATETIME_KEYWORD
"GetSystemDateTime"
|
static java.lang.String |
GETSYSTEMTIME_KEYWORD
"GetSystemTime"
|
static java.lang.String |
GETURL_KEYWORD
"GetURL"
|
static java.lang.String |
GETVERSION_KEYWORD
"GetVersion"
|
static java.lang.String |
HIDESOFTKEYBOARD_KEYWORD
"HideSoftKeyboard"
|
static java.lang.String |
HIGHLIGHT_KEYWORD
"HighLight"
|
static java.lang.String |
LAUNCHAPPLICATION_KEYWORD
"LaunchApplication"
|
static java.lang.String |
NOTIFYANDWAIT_KEYWORD
"NotifyAndWait"
|
static java.lang.String |
PAUSE_KEYWORD
"Pause"
|
static java.lang.String |
SAVECLIPBOARDTOFILE_KEYWORD
"SaveClipboardToFile"
|
static java.lang.String |
SAVEURLTOFILE_KEYWORD
"SaveURLToFile"
|
static java.lang.String |
SCROLLWHEEL_KEYWORD
"ScrollWheel"
|
static java.lang.String |
SENDEMAIL_KEYWORD
"SendEmail"
|
static java.lang.String |
SET_SECS_BEFORE_MOUSE_DOWN_KEYWORD
"SetSecsBeforeMouseDown"
|
static java.lang.String |
SET_SECS_BEFORE_MOUSE_UP_KEYWORD
"SetSecsBeforeMouseUp"
|
static java.lang.String |
SETAPPLICATIONMAP_KEYWORD
"SetApplicationMap"
|
static java.lang.String |
SETBENCHDIRECTORY_KEYWORD
"SetBenchDirectory"
|
static java.lang.String |
SETCLIPBOARD_KEYWORD
"SetClipboard"
|
static java.lang.String |
SETCONTEXT_KEYWORD
"SetContext"
|
static java.lang.String |
SETDIFDIRECTORY_KEYWORD
"SetDifDirectory"
|
static java.lang.String |
SETFOCUS_KEYWORD
"SetFocus"
|
static java.lang.String |
SETIMAGEDEBUG_KEYWORD
"SetImageDebug"
|
static java.lang.String |
SETIMAGEFUZZYMATCHING_KEYWORD
"SetImageFuzzyMatching"
|
static java.lang.String |
SETMILLISBETWEENRECORDS_KEYWORD
"SetMillisBetweenRecords"
|
static java.lang.String |
SETMULTIPLETHREADSEARCH_KEYWORD
"SetMultipleThreadSearch"
|
static java.lang.String |
SETPROJECTDIRECTORY_KEYWORD
"SetProjectDirectory"
|
static java.lang.String |
SETROOTVERIFYDIRECTORY_KEYWORD
"SetRootVerifyDirectory"
|
static java.lang.String |
SETSECSAFTERWINDOWACTIVE_KEYWORD
"SetSecsAfterWindowActive"
|
static java.lang.String |
SETSECSDELAYRETRYCOMPONENT_KEYWORD
"SetSecsDelayRetryComponent"
|
static java.lang.String |
SETSECSSEEKCOMPONENT_KEYWORD
"SetSecsSeekComponent"
|
static java.lang.String |
SETTESTDIRECTORY_KEYWORD
"SetTestDirectory"
|
static java.lang.String |
SETVARIABLEVALUEEX_KEYWORD
"SetVariableValueEx"
|
static java.lang.String |
SETVARIABLEVALUES_KEYWORD
"SetVariableValues"
|
static java.lang.String |
SHOWSOFTKEYBOARD_KEYWORD
"ShowSoftKeyboard"
|
static java.lang.String |
STARTWEBBROWSER_KEYWORD
"StartWebBrowser"
|
static java.lang.String |
STOPWEBBROWSER_KEYWORD
"StopWebBrowser"
|
static java.lang.String |
SWITCHWINDOW_KEYWORD
"SwitchWindow"
|
static java.lang.String |
TAKESCREENSHOT_KEYWORD
"TakeScreenShot"
|
static java.lang.String |
USEABBOTFUNCTIONS_KEYWORD
"UseAbbotFunctions"
|
static java.lang.String |
USEDRIODFUNCTIONS_KEYWORD
"UseDroidFunctions"
|
static java.lang.String |
USEIOSFUNCTIONS_KEYWORD
"UseIOSFunctions"
|
static java.lang.String |
USEQTPFUNCTIONS_KEYWORD
"UseQTPFunctions"
|
static java.lang.String |
USEROBOTJFUNCTIONS_KEYWORD
"UseRobotJFunctions"
|
static java.lang.String |
USESAFSFUNCTIONS_KEYWORD
"UseSAFSFunctions"
|
static java.lang.String |
USESELENIUMFUNCTIONS_KEYWORD
"UseSeleniumFunctions"
|
static java.lang.String |
USETESTCOMPLETEFUNCTIONS_KEYWORD
"UseTestCompleteFunctions"
|
static java.lang.String |
USEWEBBROWSER_KEYWORD
"UseWebBrowser"
|
static java.lang.String |
VERIFYCLIPBOARDTOFILE_KEYWORD
"VerifyClipboardToFile"
|
static java.lang.String |
VERIFYURLCONTENT_KEYWORD
"VerifyURLContent"
|
static java.lang.String |
VERIFYURLTOFILE_KEYWORD
"VerifyURLToFile"
|
static java.lang.String |
VERSION_KEYWORD
"Version"
|
static java.lang.String |
WAITFORGUI_KEYWORD
"WaitForGUI"
|
static java.lang.String |
WAITFORGUIGONE_KEYWORD
"WaitForGUIGone"
|
static java.lang.String |
WAITFORPROPERTYVALUE_KEYWORD
"WaitForPropertyValue"
|
static java.lang.String |
WAITFORPROPERTYVALUEGONE_KEYWORD
"WaitForPropertyValueGone"
|
static java.lang.String |
WAITFORREGISTRYKEYEXISTS_KEYWORD
"WaitForRegistryKeyExists"
|
static java.lang.String |
WAITFORREGISTRYKEYVALUE_KEYWORD
"WaitForRegistryKeyValue"
|
static java.lang.String |
WAITFORWEBPAGE_KEYWORD
"WaitForWebPage"
|
| Modifier and Type | Method and Description |
|---|---|
static DriverCommand |
appMapChaining(java.lang.String mode)
Enable and Disable support for App Map chaining.
|
static DriverCommand |
appMapResolve(java.lang.String mode)
Enable and Disable support for embedded DDVariables in App Map strings.
|
static DriverCommand |
assignClipboardVariable(java.lang.String varName)
Copy the clipboard contents to a DDVariable.
|
static DriverCommand |
callRemote(java.lang.String[] parameters)
Execute a command on an external system / application.
|
static DriverCommand |
callRemote(java.lang.String protocol,
java.lang.String systemName,
java.lang.String serviceName,
java.lang.String command,
java.lang.String varName,
java.lang.String parameters)
Execute a command on an external system / application.
|
static DriverCommand |
captureMousePositionOnScreen(java.lang.String[] parameters)
Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
|
static DriverCommand |
captureMousePositionOnScreen(java.lang.String x_VariableName,
java.lang.String y_VariableName)
Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
|
static DriverCommand |
clearAllVariables()
Clear storage of all DDVariables.
|
static DriverCommand |
clearAppMapCache()
Clear the internal application map cache.
|
static DriverCommand |
clearArrayVariables(java.lang.String arrayName)
Clear storage of all SAFS variables containing a specific prefix.
|
static DriverCommand |
clearClipboard()
Clear the contents of the Window's clipboard.
|
static DriverCommand |
closeApplication(java.lang.String applicationID)
Close a named application process launched with LaunchApplication.
|
static DriverCommand |
closeApplicationMap(java.lang.String applicationMap)
By map ID, Close a opened Application Map in map chain.
|
static DriverCommand |
copyVariableValueEx(java.lang.String[] parameters)
Copy the value of a (dynamic) DDVariable to another.
|
static DriverCommand |
copyVariableValueEx(java.lang.String sourceVariable,
java.lang.String destinationVariable)
Copy the value of a (dynamic) DDVariable to another.
|
static DriverCommand |
delay(java.lang.String timeout)
Delay for a specified number of milliseconds.
|
static DriverCommand |
disableDomain(java.lang.String domain)
Disable a particular test domain for testing.
|
static DriverCommand |
enableDomain(java.lang.String domain)
Enable a particular test domain for testing.
|
static DriverCommand |
expressions(java.lang.String mode)
Enable and Disable enhanced expressions.
|
static DriverCommand |
getAppMapValue(java.lang.String[] parameters)
Assign a DDVariable a value from an App Map.
|
static DriverCommand |
getAppMapValue(java.lang.String appMapID,
java.lang.String section,
java.lang.String item,
java.lang.String varName)
Assign a DDVariable a value from an App Map.
|
static DriverCommand |
getCompScreenResolution(java.lang.String[] parameters)
Gets the current computer screen resolution and returns x and y values.
|
static DriverCommand |
getCompScreenResolution(java.lang.String xWidthVariable,
java.lang.String yHeightVariable)
Gets the current computer screen resolution and returns x and y values.
|
static DriverCommand |
getDeltaDate(java.lang.String[] parameters)
Calculates the delta date positive or negative delta days from the supplied date
Calculates the delta date positive or negative delta days from the supplied date.
|
static DriverCommand |
getDeltaDate(java.lang.String sourceDateString,
java.lang.String deltaDays,
java.lang.String resultString)
Calculates the delta date positive or negative delta days from the supplied date
Calculates the delta date positive or negative delta days from the supplied date.
|
static DDDriverCommands |
getInstance()
public Singleton to access class static methods via instance
|
static DriverCommand |
getMillisBetweenRecords(java.lang.String variableName)
Get the pause between two records, and assigns the value to a DDVariable.
|
static DriverCommand |
getRegistryKeyValue(java.lang.String[] parameters)
Assign the value of the specified Registry Key to a variable.
|
static DriverCommand |
getRegistryKeyValue(java.lang.String key,
java.lang.String keyValue,
java.lang.String varName)
Assign the value of the specified Registry Key to a variable.
|
static DriverCommand |
getSecsAfterWindowActive(java.lang.String variableName)
Get the delay after window is activated, and assigns the value to a DDVariable.
|
static DriverCommand |
getSecsBeforeMouseDown(java.lang.String variableName)
Get the delay before mouse down, and assigns the value to a DDVariable.
|
static DriverCommand |
getSecsBeforeMouseUp(java.lang.String variableName)
Get the delay before mouse up, and assigns the value to a DDVariable.
|
static DriverCommand |
getSecsDelayRetryComponent(java.lang.String variableName)
Get the delay of re-finding object, and assigns the value to a DDVariable.
|
static DriverCommand |
getSecsSeekComponent(java.lang.String variableName)
Get the timeout of finding object, and assigns the value to a DDVariable.
|
static DriverCommand |
getSystemDate(java.lang.String variableName)
Assigns the string value of the system date to a DDVariable.
|
static DriverCommand |
getSystemDateTime(java.lang.String[] parameters)
Assigns the string value of the system datetime to a DDVariable.
|
static DriverCommand |
getSystemDateTime(java.lang.String variableName,
java.lang.String getMilitaryTime)
Assigns the string value of the system datetime to a DDVariable.
|
static DriverCommand |
getSystemTime(java.lang.String[] parameters)
Assigns the string value of the current system time to a DDVariable.
|
static DriverCommand |
getSystemTime(java.lang.String variableName,
java.lang.String getMilitaryTime)
Assigns the string value of the current system time to a DDVariable.
|
static DriverCommand |
getURL(java.lang.String[] parameters)
Send an HTTP GET request, and get the response.
|
static DriverCommand |
getURL(java.lang.String uRL,
java.lang.String variable,
java.lang.String timeout,
java.lang.String headerName,
java.lang.String headerValue)
Send an HTTP GET request, and get the response.
|
static DriverCommand |
getVersion(java.lang.String variable)
Get the engine VERSION
Used to specify the VERSION of the engine.
|
static DriverCommand |
hideSoftKeyboard()
Hide the soft keyboard.
|
static DriverCommand |
highLight(java.lang.String mode)
Turn on or off the component highlight functionality.
|
static DriverCommand |
launchApplication(java.lang.String[] parameters)
Identify and Launch a specified application
For IOS: This command is used to Launch the IOS Instruments testing tool.
|
static DriverCommand |
launchApplication(java.lang.String applicationID,
java.lang.String executablePath,
java.lang.String workDir,
java.lang.String cMDLineParam,
java.lang.String appMap)
Identify and Launch a specified application
For IOS: This command is used to Launch the IOS Instruments testing tool.
|
static DriverCommand |
notifyAndWait(java.lang.String[] parameters)
Display a user-defined message dialog and wait until dismissed.
|
static DriverCommand |
notifyAndWait(java.lang.String message,
java.lang.String title)
Display a user-defined message dialog and wait until dismissed.
|
static DriverCommand |
pause(java.lang.String timeout)
Pause for a specified number of seconds.
|
static DriverCommand |
saveClipboardToFile(java.lang.String[] parameters)
Save the clipboard contents to a text file.
|
static DriverCommand |
saveClipboardToFile(java.lang.String file,
java.lang.String encoding)
Save the clipboard contents to a text file.
|
static DriverCommand |
saveURLToFile(java.lang.String[] parameters)
Send an HTTP GET request, and save the response into a file.
|
static DriverCommand |
saveURLToFile(java.lang.String uRL,
java.lang.String file,
java.lang.String timeout,
java.lang.String headerName,
java.lang.String headerValue)
Send an HTTP GET request, and save the response into a file.
|
static DriverCommand |
scrollWheel(java.lang.String numClicks)
Move mouse wheel forward (up) or backward (down).
|
static DriverCommand |
sendEmail(java.lang.String[] parameters)
Send email notification with attachments.Send email notification with attachments.
|
static DriverCommand |
sendEmail(java.lang.String from,
java.lang.String to,
java.lang.String subject,
java.lang.String message,
java.lang.String attachment)
Send email notification with attachments.Send email notification with attachments.
|
static DriverCommand |
setApplicationMap(java.lang.String applicationMap)
Provide the Application Map for the DDE to use
Provide the Application Map for the DDE to use.
|
static DriverCommand |
setBenchDirectory(java.lang.String path)
Set/Change the directory in which the framework will find
benchmark files by default.
|
static DriverCommand |
setClipboard(java.lang.String str)
Set the clipboard contents to a string.
|
static DriverCommand |
setContext(java.lang.String[] parameters)
Set a Window or Window Component as the current Robot context.
|
static DriverCommand |
setContext(java.lang.String windowID,
java.lang.String componentID)
Set a Window or Window Component as the current Robot context.
|
static DriverCommand |
setDifDirectory(java.lang.String path)
Set/Change the directory in which the framework will locate
file compare differences.
|
static DriverCommand |
setFocus(java.lang.String[] parameters)
Give a Window or Window Component input focus.
|
static DriverCommand |
setFocus(java.lang.String windowID,
java.lang.String componentID)
Give a Window or Window Component input focus.
|
static DriverCommand |
setImageDebug(java.lang.String mode)
Enable/Disable verbose debug log output and high-res failure snapshots.
|
static DriverCommand |
setImageFuzzyMatching(java.lang.String mode)
Enable/Disable Image-Based Testing Fuzzy Matching.
|
static DriverCommand |
setMillisBetweenRecords(java.lang.String value)
Set the pause between two records.
|
static DriverCommand |
setMultipleThreadSearch(java.lang.String onOrOff)
Turn on or trun off the multi-thread-search way to search an image.
|
static DriverCommand |
setProjectDirectory(java.lang.String path)
Set/Change the framework project directory.
|
static DriverCommand |
setRootVerifyDirectory(java.lang.String path)
Set/Change the Bench, Test, and Dif directories
to be subdirectories off of the provided path.
|
static DriverCommand |
setSecsAfterWindowActive(java.lang.String value)
Set the delay after window is activated.
|
static DriverCommand |
setSecsBeforeMouseDown(java.lang.String value)
Set the delay before mouse down.
|
static DriverCommand |
setSecsBeforeMouseUp(java.lang.String value)
Set the delay before mouse up.
|
static DriverCommand |
setSecsDelayRetryComponent(java.lang.String value)
Set the delay of re-finding object.
|
static DriverCommand |
setSecsSeekComponent(java.lang.String variableName)
Set the timeout of finding object.
|
static DriverCommand |
setTestDirectory(java.lang.String path)
Set/Change the directory in which the framework will find
test files (captured "actuals") by default.
|
static DriverCommand |
setVariableValueEx(java.lang.String[] parameters)
Set the value of a DDVariable
The name field can contain literal string, DDVariable, or
any expression that evaluates to a valid variable name.
|
static DriverCommand |
setVariableValueEx(java.lang.String variableName,
java.lang.String variableValue)
Set the value of a DDVariable
The name field can contain literal string, DDVariable, or
any expression that evaluates to a valid variable name.
|
static DriverCommand |
setVariableValues(java.lang.String variableName)
Preset the value of one or more DDVariables
Preset the value of one or more DDVariables.
|
static DriverCommand |
showSoftKeyboard()
Show the soft keyboard.
|
static DriverCommand |
startWebBrowser(java.lang.String[] parameters)
Launch a new web browser and optionally load a document into it.
|
static DriverCommand |
startWebBrowser(java.lang.String uRL,
java.lang.String windowTag,
java.lang.String browserName,
java.lang.String timeout,
java.lang.String isRemoteBrowser,
java.lang.String extraParamKey,
java.lang.String extraParamValue)
Launch a new web browser and optionally load a document into it.
|
static DriverCommand |
stopWebBrowser(java.lang.String browserID)
Stop an opened web browser indicated by ID.
|
static DriverCommand |
switchWindow(java.lang.String[] parameters)
Switch between multiple windows according to its title.
|
static DriverCommand |
switchWindow(java.lang.String title,
java.lang.String browserID,
java.lang.String expectedMatchIndex,
java.lang.String partialMatch,
java.lang.String ignoreCase)
Switch between multiple windows according to its title.
|
static DriverCommand |
takeScreenShot(java.lang.String[] parameters)
Take screenshot and save it to a file on test machine.
|
static DriverCommand |
takeScreenShot(java.lang.String fileName,
java.lang.String rotatable,
java.lang.String subArea)
Take screenshot and save it to a file on test machine.
|
static DriverCommand |
useAbbotFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" ABBOT Functions over
any other engine functions.
|
static DriverCommand |
useDroidFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" Droid Functions over
the current engine functions (like Robot Classic).
|
static DriverCommand |
useIOSFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" IOS Functions over
any other engine functions.
|
static DriverCommand |
useQTPFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" QTP Functions over
any other engine functions.
|
static DriverCommand |
useRobotJFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" RobotJ Hook Component Functions over
Robot Classic Component Functions.
|
static DriverCommand |
useSAFSFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" SAFS (SDC) Functions over
the current engine functions (like Robot Classic).
|
static DriverCommand |
useSeleniumFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" Selenium Functions over
the current engine functions (like Robot Classic).
|
static DriverCommand |
useTestCompleteFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" TestComplete (TCAFS) Functions over
any other engine functions.
|
static DriverCommand |
useWebBrowser(java.lang.String browserID)
Switch to use an opened web browser indicated by ID.
|
static DriverCommand |
verifyClipboardToFile(java.lang.String[] parameters)
Verify the current contents of the Windows clipboard with a benchmark file.
|
static DriverCommand |
verifyClipboardToFile(java.lang.String benchmarkFile,
java.lang.String encoding)
Verify the current contents of the Windows clipboard with a benchmark file.
|
static DriverCommand |
verifyURLContent(java.lang.String[] parameters)
Send an HTTP GET request, and verify the response with the content provided as parameter.
|
static DriverCommand |
verifyURLContent(java.lang.String uRL,
java.lang.String benchContent,
java.lang.String timeout,
java.lang.String headerName,
java.lang.String headerValue)
Send an HTTP GET request, and verify the response with the content provided as parameter.
|
static DriverCommand |
verifyURLToFile(java.lang.String[] parameters)
Send an HTTP GET request, and verify the response with the content of a file.
|
static DriverCommand |
verifyURLToFile(java.lang.String uRL,
java.lang.String benchFile,
java.lang.String timeout,
java.lang.String headerName,
java.lang.String headerValue)
Send an HTTP GET request, and verify the response with the content of a file.
|
static DriverCommand |
version(java.lang.String version)
Specify the table format VERSION
Used to specify the VERSION of the table format.
|
static DriverCommand |
waitForGUI(java.lang.String[] parameters)
Wait for a Window or Window Component to become valid.
|
static DriverCommand |
waitForGUI(java.lang.String windowID,
java.lang.String componentID,
java.lang.String timeout)
Wait for a Window or Window Component to become valid.
|
static DriverCommand |
waitForGUIGone(java.lang.String[] parameters)
Wait for a Window or Window Component to become invalid.
|
static DriverCommand |
waitForGUIGone(java.lang.String windowID,
java.lang.String componentID,
java.lang.String timeout)
Wait for a Window or Window Component to become invalid.
|
static DriverCommand |
waitForPropertyValue(java.lang.String[] parameters)
Wait for a specific Window or Component property value to match an expected value.
|
static DriverCommand |
waitForPropertyValue(java.lang.String windowID,
java.lang.String componentID,
java.lang.String propertyName,
java.lang.String expectedValue,
java.lang.String timeout,
java.lang.String caseInsensitive)
Wait for a specific Window or Component property value to match an expected value.
|
static DriverCommand |
waitForPropertyValueGone(java.lang.String[] parameters)
Wait for a specific Window or Component property value to change from a known value.
|
static DriverCommand |
waitForPropertyValueGone(java.lang.String windowID,
java.lang.String componentID,
java.lang.String propertyName,
java.lang.String expectedValue,
java.lang.String timeout,
java.lang.String caseInsensitive)
Wait for a specific Window or Component property value to change from a known value.
|
static DriverCommand |
waitForRegistryKeyExists(java.lang.String[] parameters)
Wait for a Registry Key to become valid.
|
static DriverCommand |
waitForRegistryKeyExists(java.lang.String key,
java.lang.String keyValue,
java.lang.String timeout)
Wait for a Registry Key to become valid.
|
static DriverCommand |
waitForRegistryKeyValue(java.lang.String[] parameters)
Wait for a specific Registry KeyValue to match an expected value.
|
static DriverCommand |
waitForRegistryKeyValue(java.lang.String key,
java.lang.String keyValue,
java.lang.String expectedValue,
java.lang.String timeout,
java.lang.String caseInsensitive)
Wait for a specific Registry KeyValue to match an expected value.
|
static DriverCommand |
waitForWebPage(java.lang.String[] parameters)
Wait for a web document to finish loading within a timeout period.
|
static DriverCommand |
waitForWebPage(java.lang.String windowID,
java.lang.String componentID,
java.lang.String timeout)
Wait for a web document to finish loading within a timeout period.
|
public static final java.lang.String APPMAPCHAINING_KEYWORD
public static final java.lang.String APPMAPRESOLVE_KEYWORD
public static final java.lang.String ASSIGNCLIPBOARDVARIABLE_KEYWORD
public static final java.lang.String CALLREMOTE_KEYWORD
public static final java.lang.String CAPTUREMOUSEPOSITIONONSCREEN_KEYWORD
public static final java.lang.String CLEARALLVARIABLES_KEYWORD
public static final java.lang.String CLEARAPPMAPCACHE_KEYWORD
public static final java.lang.String CLEARARRAYVARIABLES_KEYWORD
public static final java.lang.String CLEARCLIPBOARD_KEYWORD
public static final java.lang.String CLOSEAPPLICATION_KEYWORD
public static final java.lang.String CLOSEAPPLICATIONMAP_KEYWORD
public static final java.lang.String COPYVARIABLEVALUEEX_KEYWORD
public static final java.lang.String DELAY_KEYWORD
public static final java.lang.String DISABLEDOMAIN_KEYWORD
public static final java.lang.String ENABLEDOMAIN_KEYWORD
public static final java.lang.String EXPRESSIONS_KEYWORD
public static final java.lang.String GET_SECS_BEFORE_MOUSE_DOWN_KEYWORD
public static final java.lang.String GET_SECS_BEFORE_MOUSE_UP_KEYWORD
public static final java.lang.String GETAPPMAPVALUE_KEYWORD
public static final java.lang.String GETCOMPSCREENRESOLUTION_KEYWORD
public static final java.lang.String GETDELTADATE_KEYWORD
public static final java.lang.String GETMILLISBETWEENRECORDS_KEYWORD
public static final java.lang.String GETREGISTRYKEYVALUE_KEYWORD
public static final java.lang.String GETSECSAFTERWINDOWACTIVE_KEYWORD
public static final java.lang.String GETSECSDELAYRETRYCOMPONENT_KEYWORD
public static final java.lang.String GETSECSSEEKCOMPONENT_KEYWORD
public static final java.lang.String GETSYSTEMDATE_KEYWORD
public static final java.lang.String GETSYSTEMDATETIME_KEYWORD
public static final java.lang.String GETSYSTEMTIME_KEYWORD
public static final java.lang.String GETURL_KEYWORD
public static final java.lang.String GETVERSION_KEYWORD
public static final java.lang.String HIDESOFTKEYBOARD_KEYWORD
public static final java.lang.String HIGHLIGHT_KEYWORD
public static final java.lang.String LAUNCHAPPLICATION_KEYWORD
public static final java.lang.String NOTIFYANDWAIT_KEYWORD
public static final java.lang.String PAUSE_KEYWORD
public static final java.lang.String SAVECLIPBOARDTOFILE_KEYWORD
public static final java.lang.String SAVEURLTOFILE_KEYWORD
public static final java.lang.String SCROLLWHEEL_KEYWORD
public static final java.lang.String SENDEMAIL_KEYWORD
public static final java.lang.String SET_SECS_BEFORE_MOUSE_DOWN_KEYWORD
public static final java.lang.String SET_SECS_BEFORE_MOUSE_UP_KEYWORD
public static final java.lang.String SETAPPLICATIONMAP_KEYWORD
public static final java.lang.String SETBENCHDIRECTORY_KEYWORD
public static final java.lang.String SETCLIPBOARD_KEYWORD
public static final java.lang.String SETCONTEXT_KEYWORD
public static final java.lang.String SETDIFDIRECTORY_KEYWORD
public static final java.lang.String SETFOCUS_KEYWORD
public static final java.lang.String SETIMAGEDEBUG_KEYWORD
public static final java.lang.String SETIMAGEFUZZYMATCHING_KEYWORD
public static final java.lang.String SETMILLISBETWEENRECORDS_KEYWORD
public static final java.lang.String SETMULTIPLETHREADSEARCH_KEYWORD
public static final java.lang.String SETPROJECTDIRECTORY_KEYWORD
public static final java.lang.String SETROOTVERIFYDIRECTORY_KEYWORD
public static final java.lang.String SETSECSAFTERWINDOWACTIVE_KEYWORD
public static final java.lang.String SETSECSDELAYRETRYCOMPONENT_KEYWORD
public static final java.lang.String SETSECSSEEKCOMPONENT_KEYWORD
public static final java.lang.String SETTESTDIRECTORY_KEYWORD
public static final java.lang.String SETVARIABLEVALUEEX_KEYWORD
public static final java.lang.String SETVARIABLEVALUES_KEYWORD
public static final java.lang.String SHOWSOFTKEYBOARD_KEYWORD
public static final java.lang.String STARTWEBBROWSER_KEYWORD
public static final java.lang.String STOPWEBBROWSER_KEYWORD
public static final java.lang.String SWITCHWINDOW_KEYWORD
public static final java.lang.String TAKESCREENSHOT_KEYWORD
public static final java.lang.String USEABBOTFUNCTIONS_KEYWORD
public static final java.lang.String USEDRIODFUNCTIONS_KEYWORD
public static final java.lang.String USEIOSFUNCTIONS_KEYWORD
public static final java.lang.String USEQTPFUNCTIONS_KEYWORD
public static final java.lang.String USEROBOTJFUNCTIONS_KEYWORD
public static final java.lang.String USESAFSFUNCTIONS_KEYWORD
public static final java.lang.String USESELENIUMFUNCTIONS_KEYWORD
public static final java.lang.String USETESTCOMPLETEFUNCTIONS_KEYWORD
public static final java.lang.String USEWEBBROWSER_KEYWORD
public static final java.lang.String VERIFYCLIPBOARDTOFILE_KEYWORD
public static final java.lang.String VERIFYURLCONTENT_KEYWORD
public static final java.lang.String VERIFYURLTOFILE_KEYWORD
public static final java.lang.String VERSION_KEYWORD
public static final java.lang.String WAITFORGUI_KEYWORD
public static final java.lang.String WAITFORGUIGONE_KEYWORD
public static final java.lang.String WAITFORPROPERTYVALUE_KEYWORD
public static final java.lang.String WAITFORPROPERTYVALUEGONE_KEYWORD
public static final java.lang.String WAITFORREGISTRYKEYEXISTS_KEYWORD
public static final java.lang.String WAITFORREGISTRYKEYVALUE_KEYWORD
public static final java.lang.String WAITFORWEBPAGE_KEYWORD
public static DDDriverCommands getInstance()
public static DriverCommand appMapChaining(java.lang.String mode)
Enable and Disable support for App Map chaining.
The SAFSMAPS service historically looked for values in the 'default' AppMap.
This is typically the last AppMap that was OPENed. This service will now lookup
values in what is called the AppMap 'chain'. This chain is simply a
Last-In-First-Out (LIFO) buffer of open AppMaps. As an AppMap is OPENed it is
placed at the top of the search chain. AppMaps already in the chain are moved
down the chain and searched in a LIFO order. This allows a primary AppMap to
be OPENed that might contain many default and shared values while subsequently
opened AppMaps might have overriding entries, entries that build upon the
defaults, or contain locale-specific entries for things like NLS testing.
Support is currently provided via the SAFSMAPS service.
Supporting Engines:
mode - Optional:NO DefaultVal:ON
Enable("ON") or Disable("OFF") this feature.public static DriverCommand appMapResolve(java.lang.String mode)
Enable and Disable support for embedded DDVariables in App Map strings.
When enabled (ON), the App Map processor will resolve DDVariable references when
they are wrapped in curly braces {^varName} anywhere in the value portion of an
AppMap entry. There should be no spaces anywhere between the curly braces or the
variable will be considered literal text and will not be resolved.
;these two items have no section identifier
;they are part of an initial, unnamed section
AnItem = A normal static value
NewItem = Another static value
[ASection]
AnItem = A normal static value
Item2 = Type=Component;Text={^text}
Item3 = Type=Window;Caption={^caption};\;Type=CheckBox;Text={^text}
The syntax for Item2 specifies that the value of the DDVariable ^text should be
retrieved and embedded in the value provided for Item2.
The syntax for Item3 specifies that the value of the DDVariables ^caption and
^text should be retrieved and embedded in the value provided for Item3.
Support is currently provided via the SAFSMAPS service.
Supporting Engines:
mode - Optional:NO DefaultVal:ON
Enable("ON") or Disable("OFF") this feature.public static DriverCommand assignClipboardVariable(java.lang.String varName)
Copy the clipboard contents to a DDVariable.
Copy the clipboard contents to a DDVariable.
This command can only copy text contents of the clipboard.
Supporting Engines:
varName - Optional:NO
The variable to copy the clipboard text into.public static DriverCommand callRemote(java.lang.String protocol, java.lang.String systemName, java.lang.String serviceName, java.lang.String command, java.lang.String varName, java.lang.String parameters)
Execute a command on an external system / application.
Execute a command on an external system / application. This command presently supports only the STAF protocol.
Command syntax, parameters, and values will be dependent upon the protocol specified and
the command issued to the remote (or even local) system.
Supporting Engines:
protocol - Optional:No
The name of the protocol to use. Presently only 'STAF' is supported.systemName - Optional:No
The name of the system to send the command to.serviceName - Optional:No
The service name to be called on the external system / application.command - Optional:No
The service command to be issued to the external system / application.varName - Optional:Yes DefaultVal:result
The DDVariable root name to receive the results.parameters - Optional:Yes
Additional parameters to be passed to the service command.public static DriverCommand callRemote(java.lang.String[] parameters)
Execute a command on an external system / application.
Execute a command on an external system / application. This command presently supports only the STAF protocol.
Command syntax, parameters, and values will be dependent upon the protocol specified and
the command issued to the remote (or even local) system.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand captureMousePositionOnScreen(java.lang.String x_VariableName, java.lang.String y_VariableName)
Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
Supporting Engines:
x_VariableName - Optional:NO
The name of the DDVariable to store the X component of the mouse position.y_VariableName - Optional:NO
The name of the DDVariable to store the Y component of the mouse position.public static DriverCommand captureMousePositionOnScreen(java.lang.String[] parameters)
Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand clearAllVariables()
Clear storage of all DDVariables.
Supporting Engines:
public static DriverCommand clearAppMapCache()
Clear the internal application map cache.
Engines often maintain an internal cache for AppMap data.
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 new
instance. 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:
public static DriverCommand clearArrayVariables(java.lang.String arrayName)
Clear storage of all SAFS variables containing a specific prefix.
Users can use SAFSVARS to store pseudo-arrays simply by adding a numeric suffix to any vaiable name prefix.
For example:
TCAFS.UID.1
TCAFS.UID.2
TCAFS.UID.3
This command allows you to clear/delete all such SAFSVARS array variables with a specific prefix.
Supporting Engines:
arrayName - Optional:NO
The variable name prefix to use for the delete.public static DriverCommand clearClipboard()
Clear the contents of the Window's clipboard.
Supporting Engines:
public static DriverCommand closeApplication(java.lang.String applicationID)
Close a named application process launched with LaunchApplication.
Currently we can only TERMINATE processes successfully
providing a TASKID during LaunchApplication. If we were
unable to get a TASKID, then we will not be able to
terminate the task with this command.
For IOS: This simply tries to close any and all instances of the
running XCode Instruments application that is driving the IOS tests.
For Android testing: The AUT information is configured via the test INI file and
the installed APKs. There are no parameters to provide to the CloseApplication call when
closing the application under test.
Supporting Engines:
applicationID - Optional:NO
The Application ID or reference provided to LaunchApplicationpublic static DriverCommand closeApplicationMap(java.lang.String applicationMap)
By map ID, Close a opened Application Map in map chain.
By map ID, Close a opened Application Map in map chain. Closing an App Map releases all resources
used by the map and removes it from any active App Map chaining. If the closed App Map
was the "default" map then the next App Map in the chain becomes the "default" App Map.
Supporting Engines:
applicationMap - Optional:NO
The path and/or filename (ID) of the Application Map to close.public static DriverCommand copyVariableValueEx(java.lang.String sourceVariable, java.lang.String destinationVariable)
Copy the value of a (dynamic) DDVariable to another.
Both fields can contain literal strings, DDVariables, or
any expression that evaluates to a valid variable name. The primary
purpose of this is to allow for dynamic variable creation via expressions.
That is something that "SetVariableValues" cannot do.
Supporting Engines:
sourceVariable - Optional:NO
The name of the variable to copy.destinationVariable - Optional:NO
The name of the variable to receive the copypublic static DriverCommand copyVariableValueEx(java.lang.String[] parameters)
Copy the value of a (dynamic) DDVariable to another.
Both fields can contain literal strings, DDVariables, or
any expression that evaluates to a valid variable name. The primary
purpose of this is to allow for dynamic variable creation via expressions.
That is something that "SetVariableValues" cannot do.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand delay(java.lang.String timeout)
Delay for a specified number of milliseconds.
Supporting Engines:
timeout - Optional:NO
The number of milliseconds to delay.public static DriverCommand disableDomain(java.lang.String domain)
Disable a particular test domain for testing.
Some tools support multiple test domains like Java, Html, Net, and Win domains.
This command instructs the engine to dynamically disable a particular test domain.
This is the opposite of, and often used in conjunction with the command 'EnableDomain'.
Disabling unnecessary domains may drastically improve test performance.
Supporting Engines:
domain - Optional:NO
The generic name of the domain to disable.public static DriverCommand enableDomain(java.lang.String domain)
Enable a particular test domain for testing.
Some tools support multiple test domains like Java, Html, Net, and Win domains.
This command instructs the engine to dynamically enable a particular test domain.
This is the opposite of, and often used in conjunction with the command 'DisableDomain'.
Disabling unnecessary domains may drastically improve test performance.
Supporting Engines:
domain - Optional:NO
The generic name of the domain to enable.public static DriverCommand expressions(java.lang.String mode)
Enable and Disable enhanced expressions.
Enable and Disable enhanced expressions.
When enabled, records are pre-processed for advanced
expressions (math and string) conversions with DDVariables.
When disabled, records are pre-processed with
standard DDVariable conversions for backwards compatibility.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The status for enhanced expression handling.public static DriverCommand getAppMapValue(java.lang.String appMapID, java.lang.String section, java.lang.String item, java.lang.String varName)
Assign a DDVariable a value from an App Map.
Allows the extraction of an App Map item value into a DDVariable. The user can optionally
provide the App Map ID and Section from which the entry is sought. The default is to
retrieve the value from the default section in the default App Map.
Supporting Engines:
appMapID - Optional:YES DefaultVal:
The ID provided for the AppMap when OPENed.section - Optional:YES DefaultVal:
The Section within the App Map to locate the entry.item - Optional:NO DefaultVal:
The Item within the App Map to retrieve.varName - Optional:NO DefaultVal:
The name of the variable to receive the value.public static DriverCommand getAppMapValue(java.lang.String[] parameters)
Assign a DDVariable a value from an App Map.
Allows the extraction of an App Map item value into a DDVariable. The user can optionally
provide the App Map ID and Section from which the entry is sought. The default is to
retrieve the value from the default section in the default App Map.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand getCompScreenResolution(java.lang.String xWidthVariable, java.lang.String yHeightVariable)
Gets the current computer screen resolution and returns x and y values.
Gets the current computer screen resolution and returns x and y values.
Supporting Engines:
xWidthVariable - Optional:NO
SAFSVARS name to be used to store x screen resolutionyHeightVariable - Optional:NO
SAFSVARS name to be used to store y screen resolutionpublic static DriverCommand getCompScreenResolution(java.lang.String[] parameters)
Gets the current computer screen resolution and returns x and y values.
Gets the current computer screen resolution and returns x and y values.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand getDeltaDate(java.lang.String sourceDateString, java.lang.String deltaDays, java.lang.String resultString)
Calculates the delta date positive or negative delta days from the supplied date
Calculates the delta date positive or negative delta days from the supplied date.
The resulting date is in the "Short Date" format.
Supporting Engines:
sourceDateString - Optional:NO
String containing the date from which to calculate the delta datedeltaDays - Optional:NO
Positive or Negative number of days to calculate date from source dateresultString - Optional:NO
Variable name to receive the newly formatted date.public static DriverCommand getDeltaDate(java.lang.String[] parameters)
Calculates the delta date positive or negative delta days from the supplied date
Calculates the delta date positive or negative delta days from the supplied date.
The resulting date is in the "Short Date" format.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand getMillisBetweenRecords(java.lang.String variableName)
Get the pause between two records, and assigns the value to a DDVariable.
Get the pause between two records, and assigns the value to a DDVariable.
This time is milli-seconds.
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the pause between two records.public static DriverCommand getRegistryKeyValue(java.lang.String key, java.lang.String keyValue, java.lang.String varName)
Assign the value of the specified Registry Key to a variable.
On Windows XP (and higher?) this is accomplished via
the REG.EXE provided by the operating system. If this program is NOT available
then the Registry commands will not work until another means is implemented--possibly
Windows Scripting Host scripts, etc..
If the registry key does not exist then a failure will be recorded and no value--an
empty string--will be assigned to the variable.
Supporting Engines:
key - Optional:NO
The Registry Key name to seek.keyValue - Optional:NO
The value name under the parent key to seek.varName - Optional:NO
The name of the variable to receive the value of the registry key.public static DriverCommand getRegistryKeyValue(java.lang.String[] parameters)
Assign the value of the specified Registry Key to a variable.
On Windows XP (and higher?) this is accomplished via
the REG.EXE provided by the operating system. If this program is NOT available
then the Registry commands will not work until another means is implemented--possibly
Windows Scripting Host scripts, etc..
If the registry key does not exist then a failure will be recorded and no value--an
empty string--will be assigned to the variable.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand getSecsAfterWindowActive(java.lang.String variableName)
Get the delay after window is activated, and assigns the value to a DDVariable.
Get the delay after window is activated, and assigns the value to a DDVariable.
This time is seconds.
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the delay after window is activated.public static DriverCommand getSecsBeforeMouseDown(java.lang.String variableName)
Get the delay before mouse down, and assigns the value to a DDVariable.
Get the delay before mouse down, and assigns the value to a DDVariable.
This time is seconds.
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the delay before mouse down.public static DriverCommand getSecsBeforeMouseUp(java.lang.String variableName)
Get the delay before mouse up, and assigns the value to a DDVariable.
Get the delay before mouse up, and assigns the value to a DDVariable.
This time is seconds.
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the delay before mouse up.public static DriverCommand getSecsDelayRetryComponent(java.lang.String variableName)
Get the delay of re-finding object, and assigns the value to a DDVariable.
Get the delay of re-finding object, and assigns the value to a DDVariable.
This time is seconds.
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the delay of re-finding object.public static DriverCommand getSecsSeekComponent(java.lang.String variableName)
Get the timeout of finding object, and assigns the value to a DDVariable.
Get the timeout of finding object, and assigns the value to a DDVariable.
This time is seconds.
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the timeout of finding object.public static DriverCommand getSystemDate(java.lang.String variableName)
Assigns the string value of the system date to a DDVariable.
Assigns the string value of the system date to a DDVariable.
This date is in the format MM-DD-YYYY.
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the System Date.public static DriverCommand getSystemDateTime(java.lang.String variableName, java.lang.String getMilitaryTime)
Assigns the string value of the system datetime to a DDVariable.
Assigns the string value of the system datetime to a DDVariable.
This date is in the format MM-DD-YYYY HH:MM:SS, it is in AM-PM 12-hours
format (1-12) be default; If you set the second parameter 'GetMilitaryTime'
to True, the time will be 24-hours military format (0-23). Use military time
is recommanded, as am-pm time has confusion without AM or PM
(example: 18:00 and 06:00 will be both 06:00)
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the System DateTime.getMilitaryTime - Optional:YES
If true, the converted time is in 24-hours military time formatpublic static DriverCommand getSystemDateTime(java.lang.String[] parameters)
Assigns the string value of the system datetime to a DDVariable.
Assigns the string value of the system datetime to a DDVariable.
This date is in the format MM-DD-YYYY HH:MM:SS, it is in AM-PM 12-hours
format (1-12) be default; If you set the second parameter 'GetMilitaryTime'
to True, the time will be 24-hours military format (0-23). Use military time
is recommanded, as am-pm time has confusion without AM or PM
(example: 18:00 and 06:00 will be both 06:00)
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand getSystemTime(java.lang.String variableName, java.lang.String getMilitaryTime)
Assigns the string value of the current system time to a DDVariable.
Assigns the string value of the current system time to a DDVariable.
This date is in the format HH:MM:SS, it is in AM-PM 12-hours
format (1-12) be default; If you set the second parameter 'GetMilitaryTime'
to True, the time will be 24-hours military format (0-23). Use military time
is recommanded, as am-pm time has confusion without AM or PM
(example: 18:00 and 06:00 will be both 06:00)
Supporting Engines:
variableName - Optional:NO
The name of the variable to receive the System Time.getMilitaryTime - Optional:YES
If true, the converted time is in 24-hours military time formatpublic static DriverCommand getSystemTime(java.lang.String[] parameters)
Assigns the string value of the current system time to a DDVariable.
Assigns the string value of the current system time to a DDVariable.
This date is in the format HH:MM:SS, it is in AM-PM 12-hours
format (1-12) be default; If you set the second parameter 'GetMilitaryTime'
to True, the time will be 24-hours military format (0-23). Use military time
is recommanded, as am-pm time has confusion without AM or PM
(example: 18:00 and 06:00 will be both 06:00)
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand getURL(java.lang.String uRL, java.lang.String variable, java.lang.String timeout, java.lang.String headerName, java.lang.String headerValue)
Send an HTTP GET request, and get the response.Supporting Engines:
uRL - Optional:NoThe URL to request.variable - Optional:NoThe name of the variable holding the response sent back from the server.timeout - Optional:YesThe timeout (in seconds) waiting for the response from HTTP server. The default value is 120 seconds.headerName - Optional:YesThe HTTP request header name.headerValue - Optional:YesThe value to set for the HTTP request header.public static DriverCommand getURL(java.lang.String[] parameters)
Send an HTTP GET request, and get the response.Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand getVersion(java.lang.String variable)
Get the engine VERSION
Used to specify the VERSION of the engine.
Supporting Engines:
variable - Optional:NO DefaultVal:1.0
A variable to accept the VERSIONpublic static DriverCommand hideSoftKeyboard()
Hide the soft keyboard.
Hide the soft keyboard. The soft keyboard will be shown if user click on an edit box,
but the soft keyboard will show over the other components. User can use this keyword
to make this soft keyboard disappear.
Supporting Engines:
public static DriverCommand highLight(java.lang.String mode)
Turn on or off the component highlight functionality.
When enabled (ON) each call to a component function will temporarily highlight
the targeted component. The intent is to provide a design-time verification that the tool
is finding the desired target component. It is not recommended this command be used during
production runtime testing as there can be significant performance impact with some tools.
Supporting Engines:
mode - Optional:Yes
The status for highlight functionality. It can be On or Off. The Default is OFF.public static DriverCommand launchApplication(java.lang.String applicationID, java.lang.String executablePath, java.lang.String workDir, java.lang.String cMDLineParam, java.lang.String appMap)
Identify and Launch a specified application
For IOS: This command is used to Launch the IOS Instruments testing tool.
The user-defined Instrument's tracetemplate is used to launch the required application.
The tester must run the Driver Command UseIOSFunctions set to "ON" before
LaunchApplication or the IOS implementation of the command will not be invoked.
For IOS Simulator testing: The Trace Template must be configured to hold all required
information such as:
the application to be tested
the IOS SDK Version to use/simulate
the location for Instruments output logging
For IOS Device testing: The Trace Template should be configured to hold the same
information. However, at runtime the user still has to (re)specify the device name and
application to run in the LaunchApplication CMDLineParams (see below). In addition,
the devicename and/or appname CANNOT contain certain special characters like an apostrophe or
single-quote (') since this will prevent AppleScript from making their proper selection.
For Android testing: The AUT information is configured via the test INI file and
the installed APKs. There are no parameters to provide to the LaunchApplication call when
launching the application to be tested.
Supporting Engines:
applicationID - Optional:NO
A text ID or name to reference the applicationexecutablePath - Optional:NO
The path, filename, and parameters for the executable OR an ApplicationConstant.workDir - Optional:YES DefaultVal:
A Working Directory for the application (if required)cMDLineParam - Optional:YES DefaultVal:
Separate command line parameters for the application (if required).appMap - Optional:YES
Filename to the Application Map for the application.public static DriverCommand launchApplication(java.lang.String[] parameters)
Identify and Launch a specified application
For IOS: This command is used to Launch the IOS Instruments testing tool.
The user-defined Instrument's tracetemplate is used to launch the required application.
The tester must run the Driver Command UseIOSFunctions set to "ON" before
LaunchApplication or the IOS implementation of the command will not be invoked.
For IOS Simulator testing: The Trace Template must be configured to hold all required
information such as:
the application to be tested
the IOS SDK Version to use/simulate
the location for Instruments output logging
For IOS Device testing: The Trace Template should be configured to hold the same
information. However, at runtime the user still has to (re)specify the device name and
application to run in the LaunchApplication CMDLineParams (see below). In addition,
the devicename and/or appname CANNOT contain certain special characters like an apostrophe or
single-quote (') since this will prevent AppleScript from making their proper selection.
For Android testing: The AUT information is configured via the test INI file and
the installed APKs. There are no parameters to provide to the LaunchApplication call when
launching the application to be tested.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand notifyAndWait(java.lang.String message, java.lang.String title)
Display a user-defined message dialog and wait until dismissed.
Display a user-defined message dialog and wait until dismissed.
If prompting the user to perform some action the message should indicate the action
should be completed BEFORE the dialog is dismissed. Once the dialog is dismissed
automated test execution proceeds immediately.
Supporting Engines:
message - Optional:NO
The text message to be displayed in the dialog.title - Optional:YES
A short user-defined title for the dialog.public static DriverCommand notifyAndWait(java.lang.String[] parameters)
Display a user-defined message dialog and wait until dismissed.
Display a user-defined message dialog and wait until dismissed.
If prompting the user to perform some action the message should indicate the action
should be completed BEFORE the dialog is dismissed. Once the dialog is dismissed
automated test execution proceeds immediately.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand pause(java.lang.String timeout)
Pause for a specified number of seconds.
Supporting Engines:
timeout - Optional:NO
The number of seconds to Pause.public static DriverCommand saveClipboardToFile(java.lang.String file, java.lang.String encoding)
Save the clipboard contents to a text file.
Save the clipboard contents to a text file.
This command can only save text contents of the clipboard. The
length of the clipboard text should not exceed 32,767 characters
due to the inherent size limit of SQABasic's String data type.
Supporting Engines:
file - Optional:NO
The file to save the clipboard contents to.encoding - Optional:Yes
The encoding used to write a file.public static DriverCommand saveClipboardToFile(java.lang.String[] parameters)
Save the clipboard contents to a text file.
Save the clipboard contents to a text file.
This command can only save text contents of the clipboard. The
length of the clipboard text should not exceed 32,767 characters
due to the inherent size limit of SQABasic's String data type.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand saveURLToFile(java.lang.String uRL, java.lang.String file, java.lang.String timeout, java.lang.String headerName, java.lang.String headerValue)
Send an HTTP GET request, and save the response into a file.Supporting Engines:
uRL - Optional:NoThe URL to request.file - Optional:NoThe name of the file holding the response sent back from the server.timeout - Optional:YesThe timeout (in seconds) waiting for the response from HTTP server. The default value is 120 seconds.headerName - Optional:YesThe HTTP request header name.headerValue - Optional:YesThe value to set for the HTTP request header.public static DriverCommand saveURLToFile(java.lang.String[] parameters)
Send an HTTP GET request, and save the response into a file.Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand scrollWheel(java.lang.String numClicks)
Move mouse wheel forward (up) or backward (down).
Move mouse wheel forward (up) or backward (down).
A positive value indicates the wheel was moved forward (up) and a negative value indicates the wheel was moved backward (down).
Supporting Engines:
numClicks - Optional:NO
The number of mouse wheel clicks to move.
.public static DriverCommand sendEmail(java.lang.String from, java.lang.String to, java.lang.String subject, java.lang.String message, java.lang.String attachment)
Send email notification with attachments.Send email notification with attachments.
Mutiple TOs, custom subject line, custom message and attachment are allowed.
HTML tag pass into message to display message into HTML format.
Supporting Engines:
from - Optional:NOEmail address sending the Email.to - Optional:NOEmail addresses to receive the email.subject - Optional:NOThe Subject of the email.message - Optional:YESText or HTML message.attachment - Optional:YESEmail attachment file pathpublic static DriverCommand sendEmail(java.lang.String[] parameters)
Send email notification with attachments.Send email notification with attachments.
Mutiple TOs, custom subject line, custom message and attachment are allowed.
HTML tag pass into message to display message into HTML format.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand setApplicationMap(java.lang.String applicationMap)
Provide the Application Map for the DDE to use
Provide the Application Map for the DDE to use. This command must be used
prior to ANY other command or script referencing the AppMap can be used. The
AppMap can also be set by the DDE initialization script or another script with
the function AUSetCurrentAppMap.
In addition to loading the Application Map, WRAFS will also load the GUI Map file
in Winrunner. For this reason, the Application map and GUI Map File must have
the same name.
Supporting Engines:
applicationMap - Optional:NO
The path and/or filename of the Application Map to usepublic static DriverCommand setBenchDirectory(java.lang.String path)
Set/Change the directory in which the framework will find
benchmark files by default.
The path must already exist. If the path is invalid
the previous setting will be retained (and logged).
Any incomplete path will be assumed to be relative
to the current project directory.
Supporting Engines:
path - Optional:NO
The full or project relative path to the new directory.public static DriverCommand setClipboard(java.lang.String str)
Set the clipboard contents to a string.
Set the clipboard contents to a string.
Supporting Engines:
str - Optional:NO
The string to set the clipboard contents to.public static DriverCommand setContext(java.lang.String windowID, java.lang.String componentID)
Set a Window or Window Component as the current Robot context.
Set a Window or Window Component as the current Robot context.
Note, this does not SetFocus on the object. This
sets an object of reference for future Robot commands. This may
generate an ignored Script Command Failure if the object is not
valid or visible.
This command is not necessary for the normal operation of the DDE
and the processing of Test records. The DDE will automatically
generate numerous SetContext commands during the normal processing
of Test records. This command is for other extraordinary cases not
covered by normal Test record processing.
Supporting Engines:
windowID - Optional:NO
A Window reference from the AppMapcomponentID - Optional:NO
A reference from the AppMap for the Component within the Window.public static DriverCommand setContext(java.lang.String[] parameters)
Set a Window or Window Component as the current Robot context.
Set a Window or Window Component as the current Robot context.
Note, this does not SetFocus on the object. This
sets an object of reference for future Robot commands. This may
generate an ignored Script Command Failure if the object is not
valid or visible.
This command is not necessary for the normal operation of the DDE
and the processing of Test records. The DDE will automatically
generate numerous SetContext commands during the normal processing
of Test records. This command is for other extraordinary cases not
covered by normal Test record processing.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand setDifDirectory(java.lang.String path)
Set/Change the directory in which the framework will locate
file compare differences.
The path must already exist. If the path is invalid
the previous setting will be retained (and logged).
Any incomplete path will be assumed to be relative
to the current project directory.
Supporting Engines:
path - Optional:NO
The full or project relative path to the new directory.public static DriverCommand setFocus(java.lang.String windowID, java.lang.String componentID)
Give a Window or Window Component input focus.
Supporting Engines:
windowID - Optional:NO
A Window reference from the AppMapcomponentID - Optional:NO
A reference from the AppMap for the Component within the Window to get input focus.public static DriverCommand setFocus(java.lang.String[] parameters)
Give a Window or Window Component input focus.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand setImageDebug(java.lang.String mode)
Enable/Disable verbose debug log output and high-res failure snapshots.
By default the image-based testing algorithm writes JPG screenshots to the Datapool\Test
directory when an image search fails to locate the desired image onscreen. These images
can help the user know the state of the system at the time of a specific test failure.
However, these images are not suitable for more advanced debugging purposes such as finding
out 'why' a target image was not found in the screenshot when it appears it should have been
found.
Enabling image debugging allows the system to output full-resolution BMP images into the
Datapool\Test directory instead of JPG images. It also writes more verbose debug information
into the SAFS Debug Log if the user has the Debug Log running during the test.
See: Debug Log Doc
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The boolean status for enabling extended image debugging.public static DriverCommand setImageFuzzyMatching(java.lang.String mode)
Enable/Disable Image-Based Testing Fuzzy Matching.
Allows more robust fuzzy matching on image comparisons during Image-Based Testing.
Image-Based Testing recognition strings must have a BitTolerance (BT) of less than
100% specified for an image that is intended to be found with the fuzzy matching algorithm.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The boolean status for enabling extended image-based fuzzy matching.public static DriverCommand setMillisBetweenRecords(java.lang.String value)
Set the pause between two records.
Set the pause between two records.
This time is milli-seconds.
Supporting Engines:
value - Optional:NO
The value of the pause between two records.public static DriverCommand setMultipleThreadSearch(java.lang.String onOrOff)
Turn on or trun off the multi-thread-search way to search an image.
Turn on or trun off the multi-thread-search way to search an image.
If set true, program will search an image by multi-thread; If false, program
will use single-thread to search.
Supporting Engines:
onOrOff - Optional:NO
Turn on or turn off multi-thread-search. This parameter should be given as "On" or "Off".public static DriverCommand setProjectDirectory(java.lang.String path)
Set/Change the framework project directory.
The path must already exist. If the path is invalid
the previous setting will be retained (and logged).
Supporting Engines:
path - Optional:NO
The full path to the new directory.public static DriverCommand setRootVerifyDirectory(java.lang.String path)
Set/Change the Bench, Test, and Dif directories
to be subdirectories off of the provided path.
The path must already exist. If the path is invalid
the previous settings for Bench, Test, and Dif will
be retained and a FAILURE will be reported. The Bench,
Test, and Dif subdirectories must also exist.
Any incomplete path will be assumed to be relative
to the current project directory. It is important
to note that the provided path can be valid, yet
the expected "Bench", "Test", and "Dif" subdirectories
may not be valid. In that scenario, no failure
will be reported, and the previous settings for
Bench, Test, and Dif will be retained (and logged).
Supporting Engines:
path - Optional:NO
The full or project relative path to the root directory for
Bench, Test, and Dif.public static DriverCommand setSecsAfterWindowActive(java.lang.String value)
Set the delay after window is activated.
Set the delay after window is activated.
This time is seconds.
Supporting Engines:
value - Optional:NO
The value of the delay after window is activated.public static DriverCommand setSecsBeforeMouseDown(java.lang.String value)
Set the delay before mouse down.
Set the delay before mouse down.
This time is seconds.
Supporting Engines:
value - Optional:NO
The value of the delay before mouse down.public static DriverCommand setSecsBeforeMouseUp(java.lang.String value)
Set the delay before mouse up.
Set the delay before mouse up.
This time is seconds.
Supporting Engines:
value - Optional:NO
The value of the delay before mouse up.public static DriverCommand setSecsDelayRetryComponent(java.lang.String value)
Set the delay of re-finding object.
Set the delay of re-finding object.
This time is seconds.
Supporting Engines:
value - Optional:NO
The value of the delay of re-finding object.public static DriverCommand setSecsSeekComponent(java.lang.String variableName)
Set the timeout of finding object.
Set the timeout of finding object.
This time is seconds.
Supporting Engines:
variableName - Optional:NO
The value of the timeout of finding object.public static DriverCommand setTestDirectory(java.lang.String path)
Set/Change the directory in which the framework will find
test files (captured "actuals") by default.
The path must already exist. If the path is invalid
the previous setting will be retained (and logged).
Any incomplete path will be assumed to be relative
to the current project directory.
Supporting Engines:
path - Optional:NO
The full or project relative path to the new directory.public static DriverCommand setVariableValueEx(java.lang.String variableName, java.lang.String variableValue)
Set the value of a DDVariable
The name field can contain literal string, DDVariable, or
any expression that evaluates to a valid variable name. Supporting Engines:
variableName - Optional:NO
The name of the variablevariableValue - Optional:NO
The value to assign to the variablepublic static DriverCommand setVariableValueEx(java.lang.String[] parameters)
Set the value of a DDVariable
The name field can contain literal string, DDVariable, or
any expression that evaluates to a valid variable name.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand setVariableValues(java.lang.String variableName)
Preset the value of one or more DDVariables
Preset the value of one or more DDVariables.
Each subsequent field can contain one variable expression.
Note: SAFS/DriverCommands and RobotJ actually implement an incompatible
version of this command. However, that version is normally never called by
standard SAFS Drivers.
The variable handling is actually already done before Driver Commands can
be called, and true Drivers or Processors do nothing but log success and return "NoScriptFailure".
The command remains for RobotJ and SAFS/DriverCommands for those people using
not standard Drivers that do not process expressions before this call. These are a rare breed, indeed!
Supporting Engines:
variableName - Optional:NO
The name of the variable along with its value assignmentpublic static DriverCommand showSoftKeyboard()
Show the soft keyboard.
Show the soft keyboard.
Supporting Engines:
public static DriverCommand startWebBrowser(java.lang.String uRL, java.lang.String windowTag, java.lang.String browserName, java.lang.String timeout, java.lang.String isRemoteBrowser, java.lang.String extraParamKey, java.lang.String extraParamValue)
Launch a new web browser and optionally load a document into it.
Windows TID, SDC, and RFT Support:
This command in the above engines now supports using the System default browser.
By default, the System default browser will be used to launch the URL. (Previous
versions of this command were unfortunately hardcoded to use Internet Explorer only.)
In addition, the tester can set a SAFS variable directly or through ApplicationConstants
to provide the full path to an alternate browser executable. By setting and clearing
this variable the tester can switch between using the System default browser and an
alternate browser dynamically during runtime.
Variable Name: SAFSWebBrowserPath
Sample SAFS variable usage:
;Set an alternate browser to use:
C, SetVariableValues, ^SAFSWebBrowserPath="C:\Program Files\Mozilla Firefox\firefox.exe"
;Clear to return to System default browser:
C, SetVariableValues, ^SAFSWebBrowserPath=""
Sample ApplicationConstants usage:
;provide a value used for all browser launches
[ApplicationConstants]
...
SAFSWebBrowserPath="C:\Program Files\Mozilla Firefox\firefox.exe"
(Note: if the tester ever "sets" or clears the SAFS variable then
any ApplicationConstants setting is no longer used.)
Selenium Note:The parameters from 4 are specially for Selenium 2.0 (WebDriver) for now.
The parameters from 8 are extra parameter settings for Selenium 2.0 (WebDriver), they appear as pair(key, value),
for example #8 is the key, #9 is the value; #10 is the key, #11 is the value; and so on.
you can specify extra parameters as many as wanted if they are supported.
Supporting Engines:
uRL - Optional:YES DefaultVal:
URL of a web resource to load in the new browser instance.windowTag - Optional:YES DefaultVal:
A WindowTag or Browser ID to call the new browser instance.browserName - Optional:YES DefaultVal:firefox
SE2The browser to open. It can be "explorer", "chrome" or "firefox". "firefox" is default.timeout - Optional:YES DefaultVal:15
SE2Specifies the amount of time the selenium web driver should wait
when searching for an element if it is not immediately present.isRemoteBrowser - Optional:YES DefaultVal:true
SE2True = use Selenium RemoteDriver.extraParamKey - Optional:YES
SE2The extra parameter key. You can use one of
Extra parameter keys.extraParamValue - Optional:YES
SE2The value of the extra parameter indicated by ExtraParamKey above.public static DriverCommand startWebBrowser(java.lang.String[] parameters)
Launch a new web browser and optionally load a document into it.
Windows TID, SDC, and RFT Support:
This command in the above engines now supports using the System default browser.
By default, the System default browser will be used to launch the URL. (Previous
versions of this command were unfortunately hardcoded to use Internet Explorer only.)
In addition, the tester can set a SAFS variable directly or through ApplicationConstants
to provide the full path to an alternate browser executable. By setting and clearing
this variable the tester can switch between using the System default browser and an
alternate browser dynamically during runtime.
Variable Name: SAFSWebBrowserPath
Sample SAFS variable usage:
;Set an alternate browser to use:
C, SetVariableValues, ^SAFSWebBrowserPath="C:\Program Files\Mozilla Firefox\firefox.exe"
;Clear to return to System default browser:
C, SetVariableValues, ^SAFSWebBrowserPath=""
Sample ApplicationConstants usage:
;provide a value used for all browser launches
[ApplicationConstants]
...
SAFSWebBrowserPath="C:\Program Files\Mozilla Firefox\firefox.exe"
(Note: if the tester ever "sets" or clears the SAFS variable then
any ApplicationConstants setting is no longer used.)
Selenium Note:The parameters from 4 are specially for Selenium 2.0 (WebDriver) for now.
The parameters from 8 are extra parameter settings for Selenium 2.0 (WebDriver), they appear as pair(key, value),
for example #8 is the key, #9 is the value; #10 is the key, #11 is the value; and so on.
you can specify extra parameters as many as wanted if they are supported.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand stopWebBrowser(java.lang.String browserID)
Stop an opened web browser indicated by ID.
Stop an opened web browser indicated by ID. This ID is assigned by user
during calling keyword StartWebBrowser.
Supporting Engines:
browserID - Optional:YES DefaultVal:MainApp
The identifier used to get the webdriver for the opened browser. This ID is assigned by user
during calling keyword StartWebBrowser.public static DriverCommand switchWindow(java.lang.String title, java.lang.String browserID, java.lang.String expectedMatchIndex, java.lang.String partialMatch, java.lang.String ignoreCase)
Switch between multiple windows according to its title.Supporting Engines:
title - Optional:NoThe Title of the window to switch to.browserID - Optional:YesThe ID representing the opened browser from where to search the window.expectedMatchIndex - Optional:YesIf more than one windows can be found according to the title, then this parameter
will decide which one to return, the index is 1 based.partialMatch - Optional:YesIf the parameter 'title' will match partially (be sub-string) with
the title of the existing windows.ignoreCase - Optional:YesIf the parameter 'title' will match case-insentitively with
the title of the existing windows.public static DriverCommand switchWindow(java.lang.String[] parameters)
Switch between multiple windows according to its title.Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand takeScreenShot(java.lang.String fileName, java.lang.String rotatable, java.lang.String subArea)
Take screenshot and save it to a file on test machine.
Take screenshot and save it to a file on test machine.
Supporting Engines:
fileName - Optional:NO
The file to store the screeshot. (For Android Engine, the screenshot is device/emulator's)rotatable - Optional:YES
For other Engine, this parameter will be ignored.
For Android Engine, if the android application is rotatable, you set this parameter to True. The default is True.subArea - Optional:YES
Optional sbuarea indicating partial image of the screen to capture.public static DriverCommand takeScreenShot(java.lang.String[] parameters)
Take screenshot and save it to a file on test machine.
Take screenshot and save it to a file on test machine.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand useAbbotFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" ABBOT Functions over
any other engine functions.
If enabled, and the ABBOT engine is up and running, the Driver
will always attempt to execute test records through Abbot first before
any other.
If the ABBOT engine is not fully available, this command will generate and
log a WARNING. If the record type contains the "W" (Warning allowed)
modifier then we will issue an appropriate log message, but no WARNING
will be counted.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The switch status for enabling the preference of the engine.
Valid values are "ON" and "OFF".public static DriverCommand useDroidFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" Droid Functions over
the current engine functions (like Robot Classic).
If enabled and the Droid hooking mechanism is up and running the Driver
will always attempt to execute test records through Droid first before
defaulting to the current engine (like Robot Classic).
If the Droid hook is not fully available, this command will generate and
log a WARNING.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The switch status for enabling the use of the Droid hook.
Valid values are "ON" and "OFF".public static DriverCommand useIOSFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" IOS Functions over
any other engine functions.
If enabled, and the IOS engine is up and running, the Driver
will always attempt to execute test records through IOS first before
any other.
If the IOS engine is not fully available, this command will generate and
log a WARNING. If the record type contains the "W" (Warning allowed)
modifier then we will issue an appropriate log message, but no WARNING
will be counted.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The switch status for enabling the preference of the engine.
Valid values are "ON" and "OFF".public static DriverCommand useQTPFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" QTP Functions over
any other engine functions.
If enabled, and the QTP engine is up and running, the Driver
will always attempt to execute test records through QTP first before
any other.
If the QTP engine is not fully available, this command will generate and
log a WARNING. If the record type contains the "W" (Warning allowed)
modifier then we will issue an appropriate log message, but no WARNING
will be counted.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The switch status for enabling the preference of the engine.
Valid values are "ON" and "OFF".public static DriverCommand useRobotJFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" RobotJ Hook Component Functions over
Robot Classic Component Functions.
If enabled and the RobotJ hooking mechanism is up and running then StepDriver
will always attempt to execute test records (T) through RobotJ first before
defaulting to Robot Classic.
If the RobotJ hook is not fully available, this command will generate and
log a WARNING. If the record type is "CW" (Warning allowed), then we
will issue an appropriate log message, but no WARNING will be counted.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The switch status for enabling the use of the RobotJ hook.
Valid values are "ON" and "OFF".public static DriverCommand useSAFSFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" SAFS (SDC) Functions over
the current engine functions (like Robot Classic).
If enabled and the SAFS hooking mechanism is up and running the Driver
will always attempt to execute test records through SAFS first before
defaulting to the current engine (like Robot Classic).
If the SAFS hook is not fully available, this command will generate and
log a WARNING. If the record type contains the "W" (Warning allowed)
modifier then we will issue an appropriate log message, but no WARNING
will be counted.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The switch status for enabling the use of the SAFS hook.
Valid values are "ON" and "OFF".public static DriverCommand useSeleniumFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" Selenium Functions over
the current engine functions (like Robot Classic).
If enabled and the Selenium hooking mechanism is up and running the Driver
will always attempt to execute test records through Selenium first before
defaulting to the current engine (like Robot Classic).
If the Selenium hook is not fully available, this command will generate and
log a WARNING.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The switch status for enabling the use of the Selenium hook.
Valid values are "ON" and "OFF".public static DriverCommand useTestCompleteFunctions(java.lang.String mode)
Enable/Disable the switch to "prefer" TestComplete (TCAFS) Functions over
any other engine functions.
If enabled, and the TCAFS engine is up and running, the Driver
will always attempt to execute test records through TCAFS first before
any other.
If the TCAFS engine is not fully available, this command will generate and
log a WARNING. If the record type contains the "W" (Warning allowed)
modifier then we will issue an appropriate log message, but no WARNING
will be counted.
Supporting Engines:
mode - Optional:NO DefaultVal:OFF
The switch status for enabling the preference of the engine.
Valid values are "ON" and "OFF".public static DriverCommand useWebBrowser(java.lang.String browserID)
Switch to use an opened web browser indicated by ID.
Switch to use an opened web browser indicated by ID. This ID is assigned by user
during calling keyword StartWebBrowser.
Supporting Engines:
browserID - Optional:YES DefaultVal:MainApp
The identifier used to get the webdriver for the opened browser. This ID is assigned by user
during calling keyword StartWebBrowser.public static DriverCommand verifyClipboardToFile(java.lang.String benchmarkFile, java.lang.String encoding)
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:
benchmarkFile - Optional:NO
The name of the file used as the comparison benchmark.encoding - Optional:Yes
The encoding used to read a file.public static DriverCommand verifyClipboardToFile(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:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand verifyURLContent(java.lang.String uRL, java.lang.String benchContent, java.lang.String timeout, java.lang.String headerName, java.lang.String headerValue)
Send an HTTP GET request, and verify the response with the content provided as parameter.Supporting Engines:
uRL - Optional:NoThe URL to request.benchContent - Optional:NoThe bench content to be compared with the response sent back from the server.timeout - Optional:YesThe timeout (in seconds) waiting for the response from HTTP server. The default value is 120 seconds.headerName - Optional:YesThe HTTP request header name.headerValue - Optional:YesThe value to set for the HTTP request header.public static DriverCommand verifyURLContent(java.lang.String[] parameters)
Send an HTTP GET request, and verify the response with the content provided as parameter.Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand verifyURLToFile(java.lang.String uRL, java.lang.String benchFile, java.lang.String timeout, java.lang.String headerName, java.lang.String headerValue)
Send an HTTP GET request, and verify the response with the content of a file.Supporting Engines:
uRL - Optional:NoThe URL to request.benchFile - Optional:NoThe name of the bench file holding the content to be compared with the response sent back from the server.timeout - Optional:YesThe timeout (in seconds) waiting for the response from HTTP server. The default value is 120 seconds.headerName - Optional:YesThe HTTP request header name.headerValue - Optional:YesThe value to set for the HTTP request header.public static DriverCommand verifyURLToFile(java.lang.String[] parameters)
Send an HTTP GET request, and verify the response with the content of a file.Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand version(java.lang.String version)
Specify the table format VERSION
Used to specify the VERSION of the table format.
This is currently not required since there is only one
current version of the table format--1.0.
Supporting Engines:
version - Optional:NO DefaultVal:1.0
The VERSION of the table format. Initially "1.0"public static DriverCommand waitForGUI(java.lang.String windowID, java.lang.String componentID, java.lang.String timeout)
Wait for a Window or Window Component to become valid.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries.
Supporting Engines:
windowID - Optional:NO
A Window reference from the AppMapcomponentID - Optional:NO
A reference from the AppMap for the Component within the Window to wait for.timeout - Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically.public static DriverCommand waitForGUI(java.lang.String[] parameters)
Wait for a Window or Window Component to become valid.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand waitForGUIGone(java.lang.String windowID, java.lang.String componentID, java.lang.String timeout)
Wait for a Window or Window Component to become invalid.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries.
Supporting Engines:
windowID - Optional:NO
A Window reference from the AppMapcomponentID - Optional:NO
A reference from the AppMap for the Component within the Window to watch.timeout - Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically.public static DriverCommand waitForGUIGone(java.lang.String[] parameters)
Wait for a Window or Window Component to become invalid.
Note: the TID supports this command using
Image-Based Testing
techniques and App Map entries.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand waitForPropertyValue(java.lang.String windowID, java.lang.String componentID, java.lang.String propertyName, java.lang.String expectedValue, java.lang.String timeout, java.lang.String caseInsensitive)
Wait for a specific Window or Component property value to match an expected value.
Supporting Engines:
windowID - Optional:NO
A Window reference from the AppMapcomponentID - Optional:NO
A reference from the AppMap for the Component within the Window.propertyName - Optional:NO
Case-sensitive name of the object property to watch.expectedValue - Optional:NO
Case-sensitive value of the object property to match.timeout - Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically.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 DriverCommand waitForPropertyValue(java.lang.String[] parameters)
Wait for a specific Window or Component property value to match an expected value.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand waitForPropertyValueGone(java.lang.String windowID, java.lang.String componentID, java.lang.String propertyName, java.lang.String expectedValue, java.lang.String timeout, java.lang.String caseInsensitive)
Wait for a specific Window or Component property value to change from a known value.
Supporting Engines:
windowID - Optional:NO
A Window reference from the AppMapcomponentID - Optional:NO
A reference from the AppMap for the Component within the Window.propertyName - Optional:NO
Case-sensitive name of the object property to watch.expectedValue - Optional:NO
Case-sensitive known value of the property to change to something else.timeout - Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically.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 DriverCommand waitForPropertyValueGone(java.lang.String[] parameters)
Wait for a specific Window or Component property value to change from a known value.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand waitForRegistryKeyExists(java.lang.String key, java.lang.String keyValue, java.lang.String timeout)
Wait for a Registry Key to become valid.
On Windows XP (and higher?) this is accomplished via
the REG.EXE provided by the operating system. If this program is NOT available
then the Registry commands will not work until another means is implemented--possibly
Windows Scripting Host scripts, etc..
Supporting Engines:
key - Optional:NO
The Registry Key name to seek.keyValue - Optional:YES
The value name under the parent key to seek.timeout - Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically.public static DriverCommand waitForRegistryKeyExists(java.lang.String[] parameters)
Wait for a Registry Key to become valid.
On Windows XP (and higher?) this is accomplished via
the REG.EXE provided by the operating system. If this program is NOT available
then the Registry commands will not work until another means is implemented--possibly
Windows Scripting Host scripts, etc..
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand waitForRegistryKeyValue(java.lang.String key, java.lang.String keyValue, java.lang.String expectedValue, java.lang.String timeout, java.lang.String caseInsensitive)
Wait for a specific Registry KeyValue to match an expected value.
On Windows XP (and higher?) this is accomplished via
the REG.EXE provided by the operating system. If this program is NOT available
then the Registry commands will not work until another means is implemented--possibly
Windows Scripting Host scripts, etc..
Supporting Engines:
key - Optional:NO
The Registry Key name to seekkeyValue - Optional:NO
The value name under the parent key to seek.expectedValue - Optional:NO
Case-sensitive value to match with the key value.timeout - Optional:YES DefaultVal:15
Timeout value in seconds before exiting automatically.caseInsensitive - Optional:YES
Values of "CASE-INSENSITIVE", "CASEINSENSITIVE", and "FALSE" will cause the
comparison of the key value and the expected value to ignore case.public static DriverCommand waitForRegistryKeyValue(java.lang.String[] parameters)
Wait for a specific Registry KeyValue to match an expected value.
On Windows XP (and higher?) this is accomplished via
the REG.EXE provided by the operating system. If this program is NOT available
then the Registry commands will not work until another means is implemented--possibly
Windows Scripting Host scripts, etc..
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
public static DriverCommand waitForWebPage(java.lang.String windowID, java.lang.String componentID, java.lang.String timeout)
Wait for a web document to finish loading within a timeout period.
Supporting Engines:
windowID - Optional:YES DefaultVal:
A Window reference from the AppMapcomponentID - Optional:YES DefaultVal:
A reference from the AppMap for the Frame/HTMLDocument within WindowID to wait for.timeout - Optional:YES DefaultVal:30
Timeout value in seconds before exiting automatically.public static DriverCommand waitForWebPage(java.lang.String[] parameters)
Wait for a web document to finish loading within a timeout period.
Supporting Engines:
parameters - Optional:NO
An array containing the following parameters:
Copyright © SAS Institute. All Rights Reserved.