org.safs.model.commands

Class DriverCommands

java.lang.Object

org.safs.model.commands.DriverCommands

public class DriverCommands
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static DDDriverCommands	_DDDriverCommands static reference to DDDriverCommands.class Miscellaneous Driver Commands.
static DDDriverCounterCommands	_DDDriverCounterCommands static reference to DDDriverCounterCommands.class Driver Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver.
static DDDriverDatabaseCommands	_DDDriverDatabaseCommands static reference to DDDriverDatabaseCommands.class Driver Database Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Database Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver.
static DDDriverDebugCommands	_DDDriverDebugCommands static reference to DDDriverDebugCommands.class Debug Driver Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver.
static DDDriverDeprecatedCommands	_DDDriverDeprecatedCommands static reference to DDDriverDeprecatedCommands.class Deprecated Driver Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver.
static DDDriverFileCommands	_DDDriverFileCommands static reference to DDDriverFileCommands.class Driver Commands for File Manipulations It is important to note that file command usage cannot readily be mixed and matched across different SAFS engines.
static DDDriverFlowCommands	_DDDriverFlowCommands static reference to DDDriverFlowCommands.class Driver Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver.
static DDDriverLogCommands	_DDDriverLogCommands static reference to DDDriverLogCommands.class Driver Commands for Logging This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver.
static DDDriverRestCommands	_DDDriverRestCommands static reference to DDDriverRestCommands.class REST Driver Commands for handling Response like store, delete etc.
static DDDriverStringCommands	_DDDriverStringCommands static reference to DDDriverStringCommands.class Driver Commands for String Manipulations Driver Command record format: Field #1 The "C" = DRIVER COMMAND record type specifier.
static DDDriverTimerCommands	_DDDriverTimerCommands static reference to DDDriverTimerCommands.class Driver Commands for Timer functions Driver Command record format: Field #1 The "C" = DRIVER COMMAND record type specifier.
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	BREAKPOINTS_KEYWORD "Breakpoints"
static java.lang.String	CALLCYCLE_KEYWORD "CallCycle"
static java.lang.String	CALLJUNIT_KEYWORD "CallJUnit"
static java.lang.String	CALLREMOTE_KEYWORD "CallRemote"
static java.lang.String	CALLSCRIPT_KEYWORD "CallScript"
static java.lang.String	CALLSTEP_KEYWORD "CallStep"
static java.lang.String	CALLSUITE_KEYWORD "CallSuite"
static java.lang.String	CAPTUREMOUSEPOSITIONONSCREEN_KEYWORD "CaptureMousePositionOnScreen"
static java.lang.String	CLEANSTRING_KEYWORD "CleanString"
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	CLOSEFILE_KEYWORD "CloseFile"
static java.lang.String	COMMANDDEBUG_KEYWORD "CommandDebug"
static java.lang.String	COMPARE_KEYWORD "Compare"
static java.lang.String	CONCATENATE_KEYWORD "Concatenate"
static java.lang.String	COPYDBTABLECOLUMNTOFILE_KEYWORD "CopyDBTableColumnToFile"
static java.lang.String	COPYDBTABLETOFILE_KEYWORD "CopyDBTableToFile"
static java.lang.String	COPYFILE_KEYWORD "CopyFile"
static java.lang.String	COPYMATCHINGFILES_KEYWORD "CopyMatchingFiles"
static java.lang.String	COPYVARIABLEVALUEEX_KEYWORD "CopyVariableValueEx"
static java.lang.String	CREATEDIRECTORY_KEYWORD "CreateDirectory"
static java.lang.String	CREATEFILE_KEYWORD "CreateFile"
static java.lang.String	DELAY_KEYWORD "Delay"
static java.lang.String	DELETECOUNTER_KEYWORD "DeleteCounter"
static java.lang.String	DELETEDBTABLERECORDS_KEYWORD "DeleteDBTableRecords"
static java.lang.String	DELETEDIRECTORY_KEYWORD "DeleteDirectory"
static java.lang.String	DELETEDIRECTORYCONTENTS_KEYWORD "DeleteDirectoryContents"
static java.lang.String	DELETEFILE_KEYWORD "DeleteFile"
static java.lang.String	DISABLEDOMAIN_KEYWORD "DisableDomain"
static java.lang.String	ENABLEDOMAIN_KEYWORD "EnableDomain"
static java.lang.String	ENDREQUIREMENT_KEYWORD "EndRequirement"
static java.lang.String	ENDTESTCASE_KEYWORD "EndTestcase"
static java.lang.String	EXECSQLQUERY_KEYWORD "ExecSQLQuery"
static java.lang.String	EXITCYCLE_KEYWORD "ExitCycle"
static java.lang.String	EXITSUITE_KEYWORD "ExitSuite"
static java.lang.String	EXITTABLE_KEYWORD "ExitTable"
static java.lang.String	EXPRESSIONS_KEYWORD "Expressions"
static java.lang.String	FILTERIMAGE_KEYWORD "FilterImage"
static java.lang.String	FILTERTEXTFILE_KEYWORD "FilterTextFile"
static java.lang.String	FINDSQAFILE_KEYWORD "FindSqaFile"
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	GETDBTABLECOLUMNCOUNT_KEYWORD "GetDBTableColumnCount"
static java.lang.String	GETDBTABLEROWCOUNT_KEYWORD "GetDBTableRowCount"
static java.lang.String	GETDBVALUE_KEYWORD "GetDBValue"
static java.lang.String	GETDELTADATE_KEYWORD "GetDeltaDate"
static java.lang.String	GETFIELD_KEYWORD "GetField"
static java.lang.String	GETFIELDCOUNT_KEYWORD "GetFieldCount"
static java.lang.String	GETFILEDATETIME_KEYWORD "GetFileDateTime"
static java.lang.String	GETFILEPROTECTIONS_KEYWORD "GetFileProtections"
static java.lang.String	GETFILES_KEYWORD "GetFiles"
static java.lang.String	GETFILESIZE_KEYWORD "GetFileSize"
static java.lang.String	GETFIXEDWIDTHFIELD_KEYWORD "GetFixedWidthField"
static java.lang.String	GETINIFILEVALUE_KEYWORD "GetINIFileValue"
static java.lang.String	GETMILLISBETWEENRECORDS_KEYWORD "GetMillisBetweenRecords"
static java.lang.String	GETMULTIDELIMITEDFIELD_KEYWORD "GetMultiDelimitedField"
static java.lang.String	GETMULTIDELIMITEDFIELDCOUNT_KEYWORD "GetMultiDelimitedFieldCount"
static java.lang.String	GETNEXTDELIMITERINDEX_KEYWORD "GetNextDelimiterIndex"
static java.lang.String	GETREDELIMITEDFIELD_KEYWORD "GetREDelimitedField"
static java.lang.String	GETREDELIMITEDFIELDCOUNT_KEYWORD "GetREDelimitedFieldCount"
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	GETSTRINGCOUNTINFILE_KEYWORD "GetStringCountInFile"
static java.lang.String	GETSUBSTRINGINSTRING_KEYWORD "GetSubstringsInString"
static java.lang.String	GETSUBSTRINGSINFILE_KEYWORD "GetSubstringsInFile"
static java.lang.String	GETSYSTEMDATE_KEYWORD "GetSystemDate"
static java.lang.String	GETSYSTEMDATETIME_KEYWORD "GetSystemDateTime"
static java.lang.String	GETSYSTEMENVIRON_KEYWORD "GetSystemEnviron"
static java.lang.String	GETSYSTEMTIME_KEYWORD "GetSystemTime"
static java.lang.String	GETSYSTEMUSER_KEYWORD "GetSystemUser"
static java.lang.String	GETTEXTFROMIMAGE_KEYWORD "GetTextFromImage"
static java.lang.String	GETTRIMMEDFIELD_KEYWORD "GetTrimmedField"
static java.lang.String	GETURL_KEYWORD "GetURL"
static java.lang.String	GETVARIABLEVALUEEX_KEYWORD "GetVariableValueEx"
static java.lang.String	GETVERSION_KEYWORD "GetVersion"
static java.lang.String	GOTOBLOCKID_KEYWORD "GotoBlockID"
static java.lang.String	HIDESOFTKEYBOARD_KEYWORD "HideSoftKeyboard"
static java.lang.String	HIGHLIGHT_KEYWORD "HighLight"
static java.lang.String	IFEXISTDIR_KEYWORD "IfExistDir"
static java.lang.String	IFEXISTFILE_KEYWORD "IfExistFile"
static java.lang.String	INDEX_KEYWORD "Index"
static java.lang.String	ISENDOFFILE_KEYWORD "IsEndOfFile"
static java.lang.String	LAUNCHAPPLICATION_KEYWORD "LaunchApplication"
static java.lang.String	LEFT_KEYWORD "Left"
static java.lang.String	LEFTTRIM_KEYWORD "LeftTrim"
static java.lang.String	LENGTH_KEYWORD "Length"
static java.lang.String	LOGCOUNTERINFO_KEYWORD "LogCounterInfo"
static java.lang.String	LOGFAILUREOK_KEYWORD "LogFailureOK"
static java.lang.String	LOGMESSAGE_KEYWORD "LogMessage"
static java.lang.String	LOGTESTFAILURE_KEYWORD "LogTestFailure"
static java.lang.String	LOGTESTSUCCESS_KEYWORD "LogTestSuccess"
static java.lang.String	LOGTESTWARNING_KEYWORD "LogTestWarning"
static java.lang.String	LOGWARNINGOK_KEYWORD "LogWarningOK"
static java.lang.String	NOTIFYANDWAIT_KEYWORD "NotifyAndWait"
static java.lang.String	ONCONTAINSGOTOBLOCKID_KEYWORD "OnContainsGotoBlockID"
static java.lang.String	OnDirectoryExistGotoBlockID_KEYWORD "OnDirectoryExistGotoBlockID"
static java.lang.String	ONDIRECTORYNOTEXISTGOTOBLOCKID_KEYWORD "OnDirectoryNotExistGotoBlockID"
static java.lang.String	ONEQUALGOTOBLOCKID_KEYWORD "OnEqualGotoBlockID"
static java.lang.String	ONFILEEOFGOTOBLOCKID_KEYWORD "OnFileEOFGotoBlockID"
static java.lang.String	ONFILEEXISTGOTOBLOCKID_KEYWORD "OnFileExistGotoBlockID"
static java.lang.String	ONFILENOTEXISTGOTOBLOCKID_KEYWORD "OnFileNotExistGotoBlockID"
static java.lang.String	ONGREATERTHANGOTOBLOCKID_KEYWORD "OnGreaterThanGotoBlockID"
static java.lang.String	ONGUIEXISTSGOTOBLOCKID_KEYWORD "OnGUIExistsGotoBlockID"
static java.lang.String	ONGUINOTEXISTGOTOBLOCKID_KEYWORD "OnGUINotExistGotoBlockID"
static java.lang.String	ONINRANGEGOTOBLOCKID_KEYWORD "OnInRangeGotoBlockID"
static java.lang.String	ONLESSTHANGOTOBLOCKID_KEYWORD "OnLessThanGotoBlockID"
static java.lang.String	ONMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD "OnMenuItemContainsStateGotoBlockID"
static java.lang.String	ONNOTCONTAINSGOTOBLOCKID_KEYWORD "OnNotContainsGotoBlockID"
static java.lang.String	ONNOTEQUALGOTOBLOCKID_KEYWORD "OnNotEqualGotoBlockID"
static java.lang.String	ONNOTGREATERTHANGOTOBLOCKID_KEYWORD "OnNotGreaterThanGotoBlockID"
static java.lang.String	ONNOTINRANGEGOTOBLOCKID_KEYWORD "OnNotInRangeGotoBlockID"
static java.lang.String	ONNOTLESSTHANGOTOBLOCKID_KEYWORD "OnNotLessThanGotoBlockID"
static java.lang.String	ONPARTIALMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD "OnPartialMenuItemContainsStateGotoBlockID"
static java.lang.String	ONREGISTRYKEYEXISTGOTOBLOCKID_KEYWORD "OnRegistryKeyExistGotoBlockID"
static java.lang.String	ONREGISTRYKEYNOTEXISTGOTOBLOCKID_KEYWORD "OnRegistryKeyNotExistGotoBlockID"
static java.lang.String	OPENFILE_KEYWORD "OpenFile"
static java.lang.String	OPENUTF8FILE_KEYWORD "OpenUTF8File"
static java.lang.String	PAUSE_KEYWORD "Pause"
static java.lang.String	PRINTTOFILE_KEYWORD "PrintToFile"
static java.lang.String	READFILECHARS_KEYWORD "ReadFileChars"
static java.lang.String	READFILELINE_KEYWORD "ReadFileLine"
static java.lang.String	READFILESTRING_KEYWORD "ReadFileString"
static java.lang.String	RECORDSDEBUG_KEYWORD "RecordsDebug"
static java.lang.String	RENAMEFILE_KEYWORD "RenameFile"
static java.lang.String	REPLACE_KEYWORD "Replace"
static java.lang.String	RESETCOUNTER_KEYWORD "ResetCounter"
static java.lang.String	RESETTIMER_KEYWORD "ResetTimer"
static java.lang.String	RESTCLEANRESPONSEMAP_KEYWORD "RestCleanResponseMap"
static java.lang.String	RESTDELETERESPONSE_KEYWORD "RestDeleteResponse"
static java.lang.String	RESTDELETERESPONSESTORE_KEYWORD "RestDeleteResponseStore"
static java.lang.String	RESTHEADERSLOAD_KEYWORD "RestHeadersLoad"
static java.lang.String	RESTSTORERESPONSE_KEYWORD "RestStoreResponse"
static java.lang.String	RESTVERIFYRESPONSE_KEYWORD "RestVerifyResponse"
static java.lang.String	RESTVERIFYRESPONSECONTAINS_KEYWORD "RestVerifyResponseContains"
static java.lang.String	RESUMELOGGING_KEYWORD "ResumeLogging"
static java.lang.String	RESUMESTATUSCOUNTS_KEYWORD "ResumeStatusCounts"
static java.lang.String	RIGHT_KEYWORD "Right"
static java.lang.String	RIGHTTRIM_KEYWORD "RightTrim"
static java.lang.String	SAVECLIPBOARDTOFILE_KEYWORD "SaveClipboardToFile"
static java.lang.String	SAVETEXTFROMIMAGE_KEYWORD "SaveTextFromImage"
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	SETCOUNTERMODE_KEYWORD "SetCounterMode"
static java.lang.String	SETDIFDIRECTORY_KEYWORD "SetDifDirectory"
static java.lang.String	SETEXITTABLEBLOCK_KEYWORD "SetExitTableBlock"
static java.lang.String	SETFILEPROTECTIONS_KEYWORD "SetFileProtections"
static java.lang.String	SETFOCUS_KEYWORD "SetFocus"
static java.lang.String	SETGENERALSCRIPTFAILUREBLOCK_KEYWORD "SetGeneralScriptFailureBlock"
static java.lang.String	SETIMAGEDEBUG_KEYWORD "SetImageDebug"
static java.lang.String	SETIMAGEFUZZYMATCHING_KEYWORD "SetImageFuzzyMatching"
static java.lang.String	SETINVALIDFILEIOBLOCK_KEYWORD "SetInvalidFileIOBlock"
static java.lang.String	SETJDBCDRIVER_KEYWORD "SetJdbcDriver"
static java.lang.String	SETMILLISBETWEENRECORDS_KEYWORD "SetMillisBetweenRecords"
static java.lang.String	SETMULTIPLETHREADSEARCH_KEYWORD "SetMultipleThreadSearch"
static java.lang.String	SETNOSCRIPTFAILUREBLOCK_KEYWORD "SetNoScriptFailureBlock"
static java.lang.String	SETPROJECTDIRECTORY_KEYWORD "SetProjectDirectory"
static java.lang.String	SETREQUIREMENT_KEYWORD "SetRequirement"
static java.lang.String	SETROOTVERIFYDIRECTORY_KEYWORD "SetRootVerifyDirectory"
static java.lang.String	SETSCRIPTNOTEXECUTEDBLOCK_KEYWORD "SetScriptNotExecutedBlock"
static java.lang.String	SETSCRIPTWARNINGBLOCK_KEYWORD "SetScriptWarningBlock"
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	SETTESTCASE_KEYWORD "SetTestcase"
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	STARTCOUNTER_KEYWORD "StartCounter"
static java.lang.String	STARTCYCLE_KEYWORD "StartCycle"
static java.lang.String	STARTPROCEDURE_KEYWORD "StartProcedure"
static java.lang.String	STARTREQUIREMENT_KEYWORD "StartRequirement"
static java.lang.String	STARTSUITE_KEYWORD "StartSuite"
static java.lang.String	STARTTESTCASE_KEYWORD "StartTestcase"
static java.lang.String	StartTimer_KEYWORD "StartTimer"
static java.lang.String	STARTWEBBROWSER_KEYWORD "StartWebBrowser"
static java.lang.String	STOPCOUNTER_KEYWORD "StopCounter"
static java.lang.String	STOPCYCLE_KEYWORD "StopCycle"
static java.lang.String	STOPPROCEDURE_KEYWORD "StopProcedure"
static java.lang.String	STOPREQUIREMENT_KEYWORD "StopRequirement"
static java.lang.String	STOPSUITE_KEYWORD "StopSuite"
static java.lang.String	STOPTESTCASE_KEYWORD "StopTestcase"
static java.lang.String	StopTimer_KEYWORD "StopTimer"
static java.lang.String	STOPWEBBROWSER_KEYWORD "StopWebBrowser"
static java.lang.String	STORECOUNTERINFO_KEYWORD "StoreCounterInfo"
static java.lang.String	StoreTimerInfo_KEYWORD "StoreTimerInfo"
static java.lang.String	StoreTimerInfoFile_KEYWORD "StoreTimerInfoFile"
static java.lang.String	SUBSTRING_KEYWORD "SubString"
static java.lang.String	SUSPENDLOGGING_KEYWORD "SuspendLogging"
static java.lang.String	SUSPENDSTATUSCOUNTS_KEYWORD "SuspendStatusCounts"
static java.lang.String	SWITCHWINDOW_KEYWORD "SwitchWindow"
static java.lang.String	TAKESCREENSHOT_KEYWORD "TakeScreenShot"
static java.lang.String	TESTDEBUG_KEYWORD "TestDebug"
static java.lang.String	TOLOWERCASE_KEYWORD "ToLowerCase"
static java.lang.String	TOUPPERCASE_KEYWORD "ToUpperCase"
static java.lang.String	TRIM_KEYWORD "Trim"
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	USELOCALFLOWCONTROL_KEYWORD "UseLocalFlowControl"
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	VERIFYDATABASENULLVALUE_KEYWORD "VerifyDatabaseNullValue"
static java.lang.String	VERIFYDATABASEVALUE_KEYWORD "VerifyDatabaseValue"
static java.lang.String	VERIFYDBNULLVALUE_KEYWORD "VerifyDBNullValue"
static java.lang.String	VERIFYDBVALUE_KEYWORD "VerifyDBValue"
static java.lang.String	VerifyElapsedTimeInRange_KEYWORD "VerifyElapsedTimeInRange"
static java.lang.String	VerifyElapsedTimeIsLess_KEYWORD "VerifyElapsedTimeIsLess"
static java.lang.String	VerifyElapsedTimeIsMore_KEYWORD "VerifyElapsedTimeIsMore"
static java.lang.String	VerifyTimer_KEYWORD "VerifyTimer"
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"
static java.lang.String	WRITEFILECHARS_KEYWORD "WriteFileChars"

Method Summary

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	breakpoints(java.lang.String mode) Enable and Disable Breakpoint Debugging.
static DriverCommand	callCycle(java.lang.String[] parameters) Invoke a Cycle table (from StepDriver or SuiteDriver) Since the Cycle is executed as a driver command and NOT as a test record, the call to the Cycle itself is not counted as a test pass or a test fail.
static DriverCommand	callCycle(java.lang.String cycleName, java.lang.String cycleSeparator, java.lang.String parameterName) Invoke a Cycle table (from StepDriver or SuiteDriver) Since the Cycle is executed as a driver command and NOT as a test record, the call to the Cycle itself is not counted as a test pass or a test fail.
static DriverCommand	callJUnit(java.lang.String className) Invoke one or more JUnit tests using the provided Class name(s).
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	callScript(java.lang.String[] parameters) Invoke a custom script with passed parameters/variables, if desired.
static DriverCommand	callScript(java.lang.String scriptName, java.lang.String parameterName) Invoke a custom script with passed parameters/variables, if desired.
static DriverCommand	callStep(java.lang.String[] parameters) Invoke a Step table from within another Step table (from StepDriver).
static DriverCommand	callStep(java.lang.String stepName, java.lang.String stepSeparator, java.lang.String parameterName) Invoke a Step table from within another Step table (from StepDriver).
static DriverCommand	callSuite(java.lang.String[] parameters) Invoke a Suite table (from StepDriver or SuiteDriver) You cannot use CallSuite in a CycleDriver test table.
static DriverCommand	callSuite(java.lang.String suiteName, java.lang.String suiteSeparator, java.lang.String parameterName) Invoke a Suite table (from StepDriver or SuiteDriver) You cannot use CallSuite in a CycleDriver test table.
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	cleanString(java.lang.String[] parameters) CleanString, for each char in string: if ((char .gt.
static DriverCommand	cleanString(java.lang.String sourceString, java.lang.String resultVar) CleanString, for each char in string: if ((char .gt.
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	closeFile(java.lang.String fileNumber) Close the open file with the file number provided
static DriverCommand	commandDebug(java.lang.String mode) Enable and Disable (C)Command Debugging.
static DriverCommand	compare(java.lang.String[] parameters) Compares two strings and returns an integer specifying the result of the comparison.
static DriverCommand	compare(java.lang.String sourceString, java.lang.String dstString, java.lang.String resultVar, java.lang.String regexMatch) Compares two strings and returns an integer specifying the result of the comparison.
static DriverCommand	concatenate(java.lang.String[] parameters) Concatenate String1 with String2 and returns concatenated string.
static DriverCommand	concatenate(java.lang.String string1, java.lang.String string2, java.lang.String resultVar) Concatenate String1 with String2 and returns concatenated string.
static DriverCommand	copyDBTableColumnToFile(java.lang.String[] parameters) This routine will copy the contents of one or more DBTable column(s) to a file.
static DriverCommand	copyDBTableColumnToFile(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String fileOut, java.lang.String sQLQuery, java.lang.String directoryOut, java.lang.String sQLStatus, java.lang.String delimiter, java.lang.String userID, java.lang.String password) This routine will copy the contents of one or more DBTable column(s) to a file.
static DriverCommand	copyDBTableToFile(java.lang.String[] parameters) This routine will copy the contents of a DBTable to a file.
static DriverCommand	copyDBTableToFile(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String fileOut, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String rowCount, java.lang.String sQLQuery, java.lang.String delimiter, java.lang.String directoryOut, java.lang.String sQLStatus, java.lang.String userID, java.lang.String password) This routine will copy the contents of a DBTable to a file.
static DriverCommand	copyFile(java.lang.String[] parameters) Copy the specified filename to the target filename.
static DriverCommand	copyFile(java.lang.String fromFileName, java.lang.String toFileName) Copy the specified filename to the target filename.
static DriverCommand	copyMatchingFiles(java.lang.String[] parameters) Copy multiple files/sub-directories, based on matching the provided pattern, from one directory to another.
static DriverCommand	copyMatchingFiles(java.lang.String fromDirectoryName, java.lang.String toDirectoryName, java.lang.String pattern, java.lang.String filterMode) Copy multiple files/sub-directories, based on matching the provided pattern, from one directory to another.
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	createDirectory(java.lang.String directoryName) Create the directory for the provided directory pathname
static DriverCommand	createFile(java.lang.String[] parameters) Open a new file with the filename, mode and access provided.
static DriverCommand	createFile(java.lang.String fileName, java.lang.String mode, java.lang.String access, java.lang.String fileNumberVariable, java.lang.String fileNumber) Open a new file with the filename, mode and access provided.
static DriverCommand	delay(java.lang.String timeout) Delay for a specified number of milliseconds.
static DriverCommand	deleteCounter(java.lang.String[] parameters) Delete any existing private counter with the provided counterID.
static DriverCommand	deleteCounter(java.lang.String counterID, java.lang.String description) Delete any existing private counter with the provided counterID.
static DriverCommand	deleteDBTableRecords(java.lang.String[] parameters) Deletes records in a database table Deletes records in a database table.
static DriverCommand	deleteDBTableRecords(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String sQLStatus) Deletes records in a database table Deletes records in a database table.
static DriverCommand	deleteDirectory(java.lang.String directoryName) Delete the directory for the provided directory pathname
static DriverCommand	deleteDirectoryContents(java.lang.String[] parameters) Delete the contents (files and sub-directories) of a provided directory and optionally, the directory itself.
static DriverCommand	deleteDirectoryContents(java.lang.String directoryName, java.lang.String deleteDir) Delete the contents (files and sub-directories) of a provided directory and optionally, the directory itself.
static DriverCommand	deleteFile(java.lang.String[] parameters) Delete the file for the file name provided
static DriverCommand	deleteFile(java.lang.String fileName, java.lang.String noVerify) Delete the file for the file name provided
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	endRequirement(java.lang.String requirementID) DEPRECATED.
static DriverCommand	endTestcase(java.lang.String testCaseID) DEPRECATED.
static DriverCommand	execSQLQuery(java.lang.String[] parameters) Executes the query provided in a queryStr on the database table.
static DriverCommand	execSQLQuery(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password) Executes the query provided in a queryStr on the database table.
static DriverCommand	exitCycle() Exit the currently running Step, Suite, and/or Cycle table.
static DriverCommand	exitSuite() Exit the currently running Step and/or Suite table.
static DriverCommand	exitTable() Exit the currently running Step, Suite, or Cycle table.
static DriverCommand	expressions(java.lang.String mode) Enable and Disable enhanced expressions.
static DriverCommand	filterImage(java.lang.String[] parameters) Filter out specific parts of an image.
static DriverCommand	filterImage(java.lang.String inputFilename, java.lang.String outputFilename, java.lang.String filterMode, java.lang.String coords) Filter out specific parts of an image.
static DriverCommand	filterTextFile(java.lang.String[] parameters) Filter a text file based on the given parameters.
static DriverCommand	filterTextFile(java.lang.String file, java.lang.String filterMode, java.lang.String filterOptions, java.lang.String encoding) Filter a text file based on the given parameters.
static DriverCommand	findSqaFile(java.lang.String[] parameters) Find the file for the SQA relative path and file name provided.
static DriverCommand	findSqaFile(java.lang.String fileName, java.lang.String filePathVariable) Find the file for the SQA relative path and file name provided.
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	getDBTableColumnCount(java.lang.String[] parameters) Executes the query in a specified database table and returns the total column count.
static DriverCommand	getDBTableColumnCount(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String columnCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password) Executes the query in a specified database table and returns the total column count.
static DriverCommand	getDBTableRowCount(java.lang.String[] parameters) Executes the query in a database table.
static DriverCommand	getDBTableRowCount(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String dBTableName, java.lang.String rowCount, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password) Executes the query in a database table.
static DriverCommand	getDBValue(java.lang.String[] parameters) Executes the query and returns the case-sensitive value as result of the execution.
static DriverCommand	getDBValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBSourceName, java.lang.String queryStr, java.lang.String queryResult, java.lang.String sQLStatusCode, java.lang.String userID, java.lang.String password) Executes the query and returns the case-sensitive value as result of the execution.
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 DriverCommand	getField(java.lang.String[] parameters) GetField, get a field out of a string using specified delimiter(s).
static DriverCommand	getField(java.lang.String inputString, java.lang.String index, java.lang.String delimiter, java.lang.String resultVar) GetField, get a field out of a string using specified delimiter(s).
static DriverCommand	getFieldCount(java.lang.String[] parameters) GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
static DriverCommand	getFieldCount(java.lang.String string1, java.lang.String startindex, java.lang.String delimiters, java.lang.String resultVar) GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
static DriverCommand	getFileDateTime(java.lang.String[] parameters) Determine the date and time the file created/last changed/last accessed for file name provided and assign it to a DDV variable.
static DriverCommand	getFileDateTime(java.lang.String fileName, java.lang.String fileDateVariable, java.lang.String getMilitaryTime, java.lang.String dateTimeType) Determine the date and time the file created/last changed/last accessed for file name provided and assign it to a DDV variable.
static DriverCommand	getFileProtections(java.lang.String[] parameters) Save the file attributes for the file name to the variable provided.
static DriverCommand	getFileProtections(java.lang.String fileName, java.lang.String varName) Save the file attributes for the file name to the variable provided.
static DriverCommand	getFiles(java.lang.String[] parameters) Search the directory provided for files according to possible attribute and write the list of filenames found into the output file.
static DriverCommand	getFiles(java.lang.String directory, java.lang.String fileName, java.lang.String fileAttributes) Search the directory provided for files according to possible attribute and write the list of filenames found into the output file.
static DriverCommand	getFileSize(java.lang.String[] parameters) Determine the file size for file name provided and assign it to a DDV variable.
static DriverCommand	getFileSize(java.lang.String fileName, java.lang.String fileSizeVariable) Determine the file size for file name provided and assign it to a DDV variable.
static DriverCommand	getFixedWidthField(java.lang.String[] parameters) GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record.
static DriverCommand	getFixedWidthField(java.lang.String sourceString, java.lang.String fieldID, java.lang.String fixedwidth, java.lang.String resultVar) GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record.
static DriverCommand	getINIFileValue(java.lang.String[] parameters) Get value from INI file.
static DriverCommand	getINIFileValue(java.lang.String fileName, java.lang.String section, java.lang.String item, java.lang.String variable) Get value from INI file.
static DriverCommand	getMillisBetweenRecords(java.lang.String variableName) Get the pause between two records, and assigns the value to a DDVariable.
static DriverCommand	getMultiDelimitedField(java.lang.String[] parameters) Given a sourceString of delimited fields, return the nth(FieldID) Field in the record from startIndex.
static DriverCommand	getMultiDelimitedField(java.lang.String sourceString, java.lang.String fieldID, java.lang.String startIndex, java.lang.String delimiters, java.lang.String resultVar) Given a sourceString of delimited fields, return the nth(FieldID) Field in the record from startIndex.
static DriverCommand	getMultiDelimitedFieldCount(java.lang.String[] parameters) Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
static DriverCommand	getMultiDelimitedFieldCount(java.lang.String string1, java.lang.String startIndex, java.lang.String delimiters, java.lang.String resultVar) Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
static DriverCommand	getNextDelimiterIndex(java.lang.String[] parameters) GetNextDelimiterIndex, Finds the index of the first character matching one of the provided delimiter characters.
static DriverCommand	getNextDelimiterIndex(java.lang.String string1, java.lang.String startindex, java.lang.String delimiters, java.lang.String resultVar) GetNextDelimiterIndex, Finds the index of the first character matching one of the provided delimiter characters.
static DriverCommand	getREDelimitedField(java.lang.String[] parameters) GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
static DriverCommand	getREDelimitedField(java.lang.String inputString, java.lang.String index, java.lang.String regExp, java.lang.String resultVar) GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
static DriverCommand	getREDelimitedFieldCount(java.lang.String[] parameters) GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
static DriverCommand	getREDelimitedFieldCount(java.lang.String inputString, java.lang.String index, java.lang.String regExp, java.lang.String resultVar) GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
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	getStringCountInFile(java.lang.String[] parameters) Count the number of occurrences of a target string in a File.
static DriverCommand	getStringCountInFile(java.lang.String file, java.lang.String string, java.lang.String varName, java.lang.String caseSensitive, java.lang.String encoding) Count the number of occurrences of a target string in a File.
static DriverCommand	getSubstringsInFile(java.lang.String[] parameters) Extract dynamic substrings from a file using regular expressions.
static DriverCommand	getSubstringsInFile(java.lang.String file, java.lang.String regexstart, java.lang.String regexstop, java.lang.String rootname) Extract dynamic substrings from a file using regular expressions.
static DriverCommand	getSubstringsInString(java.lang.String[] parameters) Extract dynamic substring from a string using regular expressions.
static DriverCommand	getSubstringsInString(java.lang.String string, java.lang.String regexStart, java.lang.String regexStop, java.lang.String varName) Extract dynamic substring from a string using regular expressions.
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	getSystemEnviron(java.lang.String[] parameters) GetSystemEnviron, get a system environment variable value
static DriverCommand	getSystemEnviron(java.lang.String string1, java.lang.String resultVar) GetSystemEnviron, get a system environment variable value
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	getSystemUser(java.lang.String resultVar) Get the USERID of the currently logged on user as stored in System Environment variables.
static DriverCommand	getTextFromImage(java.lang.String[] parameters) Incorporate OCR technology to detect the text in an image file and save the text to a variable.
static DriverCommand	getTextFromImage(java.lang.String imageFile, java.lang.String variableName, java.lang.String oCRId, java.lang.String langId, java.lang.String scaleRatio) Incorporate OCR technology to detect the text in an image file and save the text to a variable.
static DriverCommand	getTrimmedField(java.lang.String[] parameters) GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
static DriverCommand	getTrimmedField(java.lang.String string1, java.lang.String index, java.lang.String delimiter, java.lang.String resultVar) GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
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	getVariableValueEx(java.lang.String[] parameters) Replaced by CopyVariableValueEx
static DriverCommand	getVariableValueEx(java.lang.String sourceVariable, java.lang.String destinationVariable) Replaced by CopyVariableValueEx
static DriverCommand	getVersion(java.lang.String variable) Get the engine VERSION Used to specify the VERSION of the engine.
static DriverCommand	gotoBlockID(java.lang.String blockID) Goto a named block in the current table.
static DriverCommand	hideSoftKeyboard() Hide the soft keyboard.
static DriverCommand	highLight(java.lang.String mode) Turn on or off the component highlight functionality.
static DriverCommand	ifExistDir(java.lang.String[] parameters) If the specified directory exists, then execute the following driver command.
static DriverCommand	ifExistDir(java.lang.String directoryName, java.lang.String thenDriverCommand) If the specified directory exists, then execute the following driver command.
static DriverCommand	ifExistFile(java.lang.String[] parameters) If the specified file exists, then execute the following driver command.
static DriverCommand	ifExistFile(java.lang.String fileName, java.lang.String thenDriverCommand) If the specified file exists, then execute the following driver command.
static DriverCommand	index(java.lang.String[] parameters) Returns the position of the first occurrence of one string within another string.
static DriverCommand	index(java.lang.String start, java.lang.String sourceString, java.lang.String findString, java.lang.String resultVar) Returns the position of the first occurrence of one string within another string.
static DriverCommand	isEndOfFile(java.lang.String[] parameters) If the specified file is at the end of file, a 'variable' gets true assigned, otherwise it gets false
static DriverCommand	isEndOfFile(java.lang.String fileNumber, java.lang.String variable) If the specified file is at the end of file, a 'variable' gets true assigned, otherwise it gets false
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	left(java.lang.String[] parameters) Returns a string of a specified number of characters copied from the beginning of another string.
static DriverCommand	left(java.lang.String sourceString, java.lang.String length, java.lang.String resultVar) Returns a string of a specified number of characters copied from the beginning of another string.
static DriverCommand	leftTrim(java.lang.String[] parameters) A new string trimmed of leading tabs and spaces.
static DriverCommand	leftTrim(java.lang.String sourceString, java.lang.String resultVar) A new string trimmed of leading tabs and spaces.
static DriverCommand	length(java.lang.String[] parameters) Returns the length of a string or variable.
static DriverCommand	length(java.lang.String sourceString, java.lang.String resultVar) Returns the length of a string or variable.
static DriverCommand	logCounterInfo(java.lang.String[] parameters) Log the specified counter's info in the active log(s) of the current Log Facility.
static DriverCommand	logCounterInfo(java.lang.String counterID, java.lang.String logName) Log the specified counter's info in the active log(s) of the current Log Facility.
static DriverCommand	logFailureOK(java.lang.String[] parameters) Log an EXPECTED failure message.
static DriverCommand	logFailureOK(java.lang.String message, java.lang.String details) Log an EXPECTED failure message.
static DriverCommand	logMessage(java.lang.String[] parameters) Log a generic message Log a generic message.
static DriverCommand	logMessage(java.lang.String message, java.lang.String details) Log a generic message Log a generic message.
static DriverCommand	logTestFailure(java.lang.String[] parameters) Log a FAILURE message.
static DriverCommand	logTestFailure(java.lang.String message, java.lang.String details) Log a FAILURE message.
static DriverCommand	logTestSuccess(java.lang.String[] parameters) Log a SUCCESS/OK message.
static DriverCommand	logTestSuccess(java.lang.String message, java.lang.String details) Log a SUCCESS/OK message.
static DriverCommand	logTestWarning(java.lang.String[] parameters) Log a WARNING message.
static DriverCommand	logTestWarning(java.lang.String message, java.lang.String details) Log a WARNING message.
static DriverCommand	logWarningOK(java.lang.String[] parameters) Log an EXPECTED WARNING message.
static DriverCommand	logWarningOK(java.lang.String message, java.lang.String details) Log an EXPECTED WARNING message.
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	onContainsGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if value2 is contained within value1.
static DriverCommand	onContainsGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive) Goto the named block in the current table if value2 is contained within value1.
static DriverCommand	onDirectoryExistGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if the directory exists.
static DriverCommand	onDirectoryExistGotoBlockID(java.lang.String blockID, java.lang.String directoryName) Goto the named block in the current table if the directory exists.
static DriverCommand	onDirectoryNotExistGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if the Directory does not exist.
static DriverCommand	onDirectoryNotExistGotoBlockID(java.lang.String blockID, java.lang.String directoryName) Goto the named block in the current table if the Directory does not exist.
static DriverCommand	onEqualGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if two values are equal.
static DriverCommand	onEqualGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive) Goto the named block in the current table if two values are equal.
static DriverCommand	onFileEOFGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if the file is at EOF.
static DriverCommand	onFileEOFGotoBlockID(java.lang.String blockID, java.lang.String fileNumber) Goto the named block in the current table if the file is at EOF.
static DriverCommand	onFileExistGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if the file exists.
static DriverCommand	onFileExistGotoBlockID(java.lang.String blockID, java.lang.String fileName) Goto the named block in the current table if the file exists.
static DriverCommand	onFileNotExistGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if the file does not exist.
static DriverCommand	onFileNotExistGotoBlockID(java.lang.String blockID, java.lang.String fileName) Goto the named block in the current table if the file does not exist.
static DriverCommand	onGreaterThanGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if value1 is greater than value2.
static DriverCommand	onGreaterThanGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive) Goto the named block in the current table if value1 is greater than value2.
static DriverCommand	onGUIExistsGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if a GUI component exists.
static DriverCommand	onGUIExistsGotoBlockID(java.lang.String blockID, java.lang.String windowID, java.lang.String componentID, java.lang.String timeOut) Goto the named block in the current table if a GUI component exists.
static DriverCommand	onGUINotExistGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if a GUI component does not exist.
static DriverCommand	onGUINotExistGotoBlockID(java.lang.String blockID, java.lang.String windowID, java.lang.String componentID, java.lang.String timeOut) Goto the named block in the current table if a GUI component does not exist.
static DriverCommand	onInRangeGotoBlockID(java.lang.String[] parameters) Goto named block if value1 is between value2 and value3.
static DriverCommand	onInRangeGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String value3, java.lang.String caseSensitive) Goto named block if value1 is between value2 and value3.
static DriverCommand	onLessThanGotoBlockID(java.lang.String[] parameters) Goto the named block if value1 is less than value2.
static DriverCommand	onLessThanGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive) Goto the named block if value1 is less than value2.
static DriverCommand	onMenuItemContainsStateGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if state is part of the state information of the menuitem.
static DriverCommand	onMenuItemContainsStateGotoBlockID(java.lang.String blockID, java.lang.String windowName, java.lang.String componentName, java.lang.String menuItem, java.lang.String state) Goto the named block in the current table if state is part of the state information of the menuitem.
static DriverCommand	onNotContainsGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if value2 is NOT a substring of value1.
static DriverCommand	onNotContainsGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive) Goto the named block in the current table if value2 is NOT a substring of value1.
static DriverCommand	onNotEqualGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if two values are not equal.
static DriverCommand	onNotEqualGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive) Goto the named block in the current table if two values are not equal.
static DriverCommand	onNotGreaterThanGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if value1 is NOT greater than value2.
static DriverCommand	onNotGreaterThanGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive) Goto the named block in the current table if value1 is NOT greater than value2.
static DriverCommand	onNotInRangeGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if value1 is not between value2 and value3.
static DriverCommand	onNotInRangeGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String value3, java.lang.String caseSensitive) Goto the named block in the current table if value1 is not between value2 and value3.
static DriverCommand	onNotLessThanGotoBlockID(java.lang.String[] parameters) Goto the named block if value1 is NOT less than value2.
static DriverCommand	onNotLessThanGotoBlockID(java.lang.String blockID, java.lang.String value1, java.lang.String value2, java.lang.String caseSensitive) Goto the named block if value1 is NOT less than value2.
static DriverCommand	onPartialMenuItemContainsStateGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if state is part of the state information of the menuitem.
static DriverCommand	onPartialMenuItemContainsStateGotoBlockID(java.lang.String blockID, java.lang.String windowName, java.lang.String componentName, java.lang.String menuItem, java.lang.String state) Goto the named block in the current table if state is part of the state information of the menuitem.
static DriverCommand	onRegistryKeyExistGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if the Registry Key exists.
static DriverCommand	onRegistryKeyExistGotoBlockID(java.lang.String blockID, java.lang.String key, java.lang.String keyValue, java.lang.String timeOut) Goto the named block in the current table if the Registry Key exists.
static DriverCommand	onRegistryKeyNotExistGotoBlockID(java.lang.String[] parameters) Goto the named block in the current table if the Registry Key does not exist.
static DriverCommand	onRegistryKeyNotExistGotoBlockID(java.lang.String blockID, java.lang.String key, java.lang.String keyValue, java.lang.String timeOut) Goto the named block in the current table if the Registry Key does not exist.
static DriverCommand	openFile(java.lang.String[] parameters) Open an existing file with the filename, mode and access provided.
static DriverCommand	openFile(java.lang.String fileName, java.lang.String mode, java.lang.String access, java.lang.String fileNumberVariable, java.lang.String fileNumber) Open an existing file with the filename, mode and access provided.
static DriverCommand	openUTF8File(java.lang.String[] parameters) Open an existing UTF-8 file with the filename, mode and access provided.
static DriverCommand	openUTF8File(java.lang.String fileName, java.lang.String mode, java.lang.String access, java.lang.String fileNumberVariable, java.lang.String fileNumber) Open an existing UTF-8 file with the filename, mode and access provided.
static DriverCommand	pause(java.lang.String timeout) Pause for a specified number of seconds.
static DriverCommand	printToFile(java.lang.String[] parameters) Write output to a sequential file already opened for writing.
static DriverCommand	printToFile(java.lang.String fileNumber, java.lang.String expressionListVariable, java.lang.String printOutputPlacement) Write output to a sequential file already opened for writing.
static DriverCommand	readFileChars(java.lang.String[] parameters) Read the number of characters from the file defined by file number and assign a string containing the characters read to a DDV variable.
static DriverCommand	readFileChars(java.lang.String fileNumber, java.lang.String numberOfChar, java.lang.String variableName) Read the number of characters from the file defined by file number and assign a string containing the characters read to a DDV variable.
static DriverCommand	readFileLine(java.lang.String[] parameters) Read a line from the file defined by file number and assign a string containing the line read to a DDV variable.
static DriverCommand	readFileLine(java.lang.String fileNumber, java.lang.String variableName) Read a line from the file defined by file number and assign a string containing the line read to a DDV variable.
static DriverCommand	readFileString(java.lang.String[] parameters) Read a comma-separated value from a file and store it in a DDVariable.
static DriverCommand	readFileString(java.lang.String fileNumber, java.lang.String variableName) Read a comma-separated value from a file and store it in a DDVariable.
static DriverCommand	recordsDebug(java.lang.String mode) Enable and Disable debugging of ALL record types.
static DriverCommand	renameFile(java.lang.String[] parameters) Rename the file from the old file name to the new filename
static DriverCommand	renameFile(java.lang.String oldFileName, java.lang.String newFileName, java.lang.String noVerify) Rename the file from the old file name to the new filename
static DriverCommand	replace(java.lang.String[] parameters) Replace 'find' substring with 'replace' substring
static DriverCommand	replace(java.lang.String sourceString, java.lang.String findString, java.lang.String replaceString, java.lang.String resultVar) Replace 'find' substring with 'replace' substring
static DriverCommand	resetCounter(java.lang.String[] parameters) Create a new private counter or reset counts in an existing private counter.
static DriverCommand	resetCounter(java.lang.String counterID, java.lang.String description) Create a new private counter or reset counts in an existing private counter.
static DriverCommand	resetTimer(java.lang.String timerName) Reset a "stopped" timer for reuse.
static DriverCommand	restCleanResponseMap(java.lang.String responseID) Delete REST response (and request if it is stored) from the internal Map.
static DriverCommand	restDeleteResponse(java.lang.String responseID) Delete a REST response (and request if stored) from the persistent storages.
static DriverCommand	restDeleteResponseStore() Delete ALL REST responses (and requests if stored) from the persistent storages.
static DriverCommand	restHeadersLoad(java.lang.String[] parameters) Load headers from a file.
static DriverCommand	restHeadersLoad(java.lang.String headersFile, java.lang.String method, java.lang.String type) Load headers from a file.
static DriverCommand	restStoreResponse(java.lang.String[] parameters) Save a REST response into a persistent storage.
static DriverCommand	restStoreResponse(java.lang.String responseID, java.lang.String variablePrefix, java.lang.String storeRequest, java.lang.String persistenceType, java.lang.String fileType) Save a REST response into a persistent storage.
static DriverCommand	restVerifyResponse(java.lang.String[] parameters) Verify a REST response is what is expected.
static DriverCommand	restVerifyResponse(java.lang.String responseID, java.lang.String benchFile, java.lang.String fileType, java.lang.String result, java.lang.String verifyRequest, java.lang.String valueContains, java.lang.String valueCaseSensitive) Verify a REST response is what is expected.
static DriverCommand	restVerifyResponseContains(java.lang.String[] parameters) Verify a REST response contains what is expected.
static DriverCommand	restVerifyResponseContains(java.lang.String responseID, java.lang.String benchFile, java.lang.String fileType, java.lang.String result, java.lang.String verifyRequest, java.lang.String valueContains, java.lang.String valueCaseSensitive) Verify a REST response contains what is expected.
static DriverCommand	resumeLogging(java.lang.String logName) Resume suspended logging.
static DriverCommand	resumeStatusCounts(java.lang.String[] parameters) Resume counting on ALL status counters--both public/global and private.
static DriverCommand	resumeStatusCounts(java.lang.String description, java.lang.String logName) Resume counting on ALL status counters--both public/global and private.
static DriverCommand	right(java.lang.String[] parameters) Returns a string of a specified number of characters copied from the end of another string.
static DriverCommand	right(java.lang.String sourceString, java.lang.String length, java.lang.String resultVar) Returns a string of a specified number of characters copied from the end of another string.
static DriverCommand	rightTrim(java.lang.String[] parameters) A new string trimmed of trailing tabs and spaces.
static DriverCommand	rightTrim(java.lang.String sourceString, java.lang.String resultVar) A new string trimmed of trailing tabs and spaces.
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	saveTextFromImage(java.lang.String[] parameters) Incorporate OCR technology to detect the text in an image file and save the text to a text file.
static DriverCommand	saveTextFromImage(java.lang.String imageFile, java.lang.String outputFile, java.lang.String oCRId, java.lang.String langId, java.lang.String scaleRatio) Incorporate OCR technology to detect the text in an image file and save the text 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	setCounterMode(java.lang.String[] parameters) Create a new private counter or modify the mode of an existing private counter.
static DriverCommand	setCounterMode(java.lang.String counterID, java.lang.String mode) Create a new private counter or modify the mode of an existing private counter.
static DriverCommand	setDifDirectory(java.lang.String path) Set/Change the directory in which the framework will locate file compare differences.
static DriverCommand	setExitTableBlock(java.lang.String blockID) Set or clear the name of a block to execute when the ExitTable command is encountered.
static DriverCommand	setFileProtections(java.lang.String[] parameters) Change the file attribute for the file name provided to the value of the new file protection provided.
static DriverCommand	setFileProtections(java.lang.String fileName, java.lang.String fileProtection) Change the file attribute for the file name provided to the value of the new file protection provided.
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	setGeneralScriptFailureBlock(java.lang.String blockID) Set or clear the name of a block to execute when GeneralScriptFailure occurs.
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	setInvalidFileIOBlock(java.lang.String blockID) Set or clear the name of a block to execute when InvalidFileIO occurs.
static DriverCommand	setJdbcDriver(java.lang.String driverClassName) set Jdbc Driver sets a JDBC driver, can be called more than once with multiple drivers.
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	setNoScriptFailureBlock(java.lang.String blockID) Set or clear the name of a block to execute when NoScriptFailure occurs.
static DriverCommand	setProjectDirectory(java.lang.String path) Set/Change the framework project directory.
static DriverCommand	setRequirement(java.lang.String[] parameters) DEPRECATED.
static DriverCommand	setRequirement(java.lang.String requirementID, java.lang.String description) DEPRECATED.
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	setScriptNotExecutedBlock(java.lang.String blockID) Set or clear the name of a block to execute when ScriptNotExecuted occurs.
static DriverCommand	setScriptWarningBlock(java.lang.String blockID) Set or clear the name of a block to execute when ScriptWarning occurs.
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	setTestcase(java.lang.String[] parameters) DEPRECATED.
static DriverCommand	setTestcase(java.lang.String testCaseID, java.lang.String description) DEPRECATED.
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	startCounter(java.lang.String[] parameters) Create a new private counter or start an existing stopped private counter.
static DriverCommand	startCounter(java.lang.String counterID, java.lang.String description) Create a new private counter or start an existing stopped private counter.
static DriverCommand	startCycle(java.lang.String[] parameters) Begin tracking status on a user-defined item.
static DriverCommand	startCycle(java.lang.String cycleID, java.lang.String description) Begin tracking status on a user-defined item.
static DriverCommand	startProcedure(java.lang.String[] parameters) Begin tracking status on a user-defined item.
static DriverCommand	startProcedure(java.lang.String procedureID, java.lang.String description) Begin tracking status on a user-defined item.
static DriverCommand	startRequirement(java.lang.String[] parameters) Begin tracking status on a user-defined item.
static DriverCommand	startRequirement(java.lang.String requirementID, java.lang.String description) Begin tracking status on a user-defined item.
static DriverCommand	startSuite(java.lang.String[] parameters) Begin tracking status on a user-defined item.
static DriverCommand	startSuite(java.lang.String suiteID, java.lang.String description) Begin tracking status on a user-defined item.
static DriverCommand	startTestcase(java.lang.String[] parameters) Begin tracking status on a user-defined TestCase.
static DriverCommand	startTestcase(java.lang.String testCaseID, java.lang.String description) Begin tracking status on a user-defined TestCase.
static DriverCommand	startTimer(java.lang.String[] parameters) Will start a unique timer.
static DriverCommand	startTimer(java.lang.String timerName, java.lang.String verifyValue) Will start a unique timer.
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	stopCounter(java.lang.String[] parameters) Create a new private counter or suspend counts in an existing private counter.
static DriverCommand	stopCounter(java.lang.String counterID, java.lang.String description) Create a new private counter or suspend counts in an existing private counter.
static DriverCommand	stopCycle(java.lang.String[] parameters) Stop tracking status on a user-defined item.
static DriverCommand	stopCycle(java.lang.String cycleID, java.lang.String description) Stop tracking status on a user-defined item.
static DriverCommand	stopProcedure(java.lang.String[] parameters) Stop tracking status on a user-defined item.
static DriverCommand	stopProcedure(java.lang.String procedureID, java.lang.String description) Stop tracking status on a user-defined item.
static DriverCommand	stopRequirement(java.lang.String[] parameters) Stop tracking status on a user-defined item.
static DriverCommand	stopRequirement(java.lang.String requirementID, java.lang.String description) Stop tracking status on a user-defined item.
static DriverCommand	stopSuite(java.lang.String[] parameters) Stop tracking status on a user-defined item.
static DriverCommand	stopSuite(java.lang.String suiteID, java.lang.String description) Stop tracking status on a user-defined item.
static DriverCommand	stopTestcase(java.lang.String[] parameters) Stop tracking status on a user-defined TestCase.
static DriverCommand	stopTestcase(java.lang.String testCaseID, java.lang.String description) Stop tracking status on a user-defined TestCase.
static DriverCommand	stopTimer(java.lang.String timerName) Will end a unique timer and perform a verify test if a value was supplied at start time.
static DriverCommand	stopWebBrowser(java.lang.String browserID) Stop an opened web browser indicated by ID.
static DriverCommand	storeCounterInfo(java.lang.String[] parameters) Store the current values of the named counter into unique DDVariables.
static DriverCommand	storeCounterInfo(java.lang.String counterID, java.lang.String varPrefix) Store the current values of the named counter into unique DDVariables.
static DriverCommand	storeTimerInfo(java.lang.String[] parameters) Well store the timer information in the given variable.
static DriverCommand	storeTimerInfo(java.lang.String timerName, java.lang.String variable) Well store the timer information in the given variable.
static DriverCommand	storeTimerInfoFile(java.lang.String[] parameters) Well store the timer information in the given file, in csv format.
static DriverCommand	storeTimerInfoFile(java.lang.String timerName, java.lang.String fileLoc) Well store the timer information in the given file, in csv format.
static DriverCommand	subString(java.lang.String[] parameters) Returns a portion of a string based on character index.
static DriverCommand	subString(java.lang.String sourceString, java.lang.String start, java.lang.String length, java.lang.String resultVar) Returns a portion of a string based on character index.
static DriverCommand	suspendLogging(java.lang.String logName) Suspend all logging.
static DriverCommand	suspendStatusCounts(java.lang.String[] parameters) Suspend counting on ALL status counters--both public/global and private.
static DriverCommand	suspendStatusCounts(java.lang.String description, java.lang.String logName) Suspend counting on ALL status counters--both public/global and private.
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	testDebug(java.lang.String mode) Enable and Disable (T)Test Record Debugging.
static DriverCommand	toLowerCase(java.lang.String[] parameters) Returns a copy of a string, with all letters converted to lowercase.
static DriverCommand	toLowerCase(java.lang.String sourceString, java.lang.String resultVar) Returns a copy of a string, with all letters converted to lowercase.
static DriverCommand	toUpperCase(java.lang.String[] parameters) Returns a copy of a string after converting all letters to uppercase.
static DriverCommand	toUpperCase(java.lang.String sourceString, java.lang.String resultVar) Returns a copy of a string after converting all letters to uppercase.
static DriverCommand	trim(java.lang.String[] parameters) A new string trimmed of leading and trailing tabs and spaces.
static DriverCommand	trim(java.lang.String sourceString, java.lang.String resultVar) A new string trimmed of leading and trailing tabs and spaces.
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	useLocalFlowControl(java.lang.String state) When TRUE then flow control block IDs have current table scope only.
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	verifyDatabaseNullValue(java.lang.String[] parameters) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
static DriverCommand	verifyDatabaseNullValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String sQLStatus) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
static DriverCommand	verifyDatabaseValue(java.lang.String[] parameters) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
static DriverCommand	verifyDatabaseValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String expectedValue, java.lang.String sQLStatus) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
static DriverCommand	verifyDBNullValue(java.lang.String[] parameters) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
static DriverCommand	verifyDBNullValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String sQLStatus) Verifies the value of a field in a database table is NULL Verifies the value of a field in a database table is NULL.
static DriverCommand	verifyDBValue(java.lang.String[] parameters) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
static DriverCommand	verifyDBValue(java.lang.String aDBAlias, java.lang.String aTableAlias, java.lang.String dBFieldName, java.lang.String dBTableName, java.lang.String dBQueryCond, java.lang.String dBSourceName, java.lang.String userID, java.lang.String password, java.lang.String expectedValue, java.lang.String sQLStatus) Verifies the case-sensitive value of a field in a database table Verifies the case-sensitive value of a field in a database table.
static DriverCommand	verifyElapsedTimeInRange(java.lang.String[] parameters) Well verify that a timer was in the range of the given values.
static DriverCommand	verifyElapsedTimeInRange(java.lang.String timerName, java.lang.String verifyValue1, java.lang.String verifyValue2) Well verify that a timer was in the range of the given values.
static DriverCommand	verifyElapsedTimeIsLess(java.lang.String[] parameters) Well verify that a timer was less then the given value.
static DriverCommand	verifyElapsedTimeIsLess(java.lang.String timerName, java.lang.String verifyValue) Well verify that a timer was less then the given value.
static DriverCommand	verifyElapsedTimeIsMore(java.lang.String[] parameters) Well verify that a timer was greater then the given value.
static DriverCommand	verifyElapsedTimeIsMore(java.lang.String timerName, java.lang.String verifyValue) Well verify that a timer was greater then the given value.
static DriverCommand	verifyTimer(java.lang.String[] parameters) Well verify that a timer was less then the given value.
static DriverCommand	verifyTimer(java.lang.String timerName, java.lang.String verifyValue) Well verify that a timer was less then the given value.
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.
static DriverCommand	writeFileChars(java.lang.String[] parameters) Write the specified number of characters to a file already opened for writing.
static DriverCommand	writeFileChars(java.lang.String fileNumber, java.lang.String numberOfChars, java.lang.String expressionList) Write the specified number of characters to a file already opened for writing.

Methods inherited from class java.lang.Object

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

Field Detail

APPMAPCHAINING_KEYWORD

public static final java.lang.String APPMAPCHAINING_KEYWORD

"AppMapChaining"

See Also:

Constant Field Values

APPMAPRESOLVE_KEYWORD

public static final java.lang.String APPMAPRESOLVE_KEYWORD

"AppMapResolve"

See Also:

Constant Field Values

ASSIGNCLIPBOARDVARIABLE_KEYWORD

public static final java.lang.String ASSIGNCLIPBOARDVARIABLE_KEYWORD

"AssignClipboardVariable"

See Also:

Constant Field Values

CALLREMOTE_KEYWORD

public static final java.lang.String CALLREMOTE_KEYWORD

"CallRemote"

See Also:

Constant Field Values

CAPTUREMOUSEPOSITIONONSCREEN_KEYWORD

public static final java.lang.String CAPTUREMOUSEPOSITIONONSCREEN_KEYWORD

"CaptureMousePositionOnScreen"

See Also:

Constant Field Values

CLEARALLVARIABLES_KEYWORD

public static final java.lang.String CLEARALLVARIABLES_KEYWORD

"ClearAllVariables"

See Also:

Constant Field Values

CLEARAPPMAPCACHE_KEYWORD

public static final java.lang.String CLEARAPPMAPCACHE_KEYWORD

"ClearAppMapCache"

See Also:

Constant Field Values

CLEARARRAYVARIABLES_KEYWORD

public static final java.lang.String CLEARARRAYVARIABLES_KEYWORD

"ClearArrayVariables"

See Also:

Constant Field Values

CLEARCLIPBOARD_KEYWORD

public static final java.lang.String CLEARCLIPBOARD_KEYWORD

"ClearClipboard"

See Also:

Constant Field Values

CLOSEAPPLICATION_KEYWORD

public static final java.lang.String CLOSEAPPLICATION_KEYWORD

"CloseApplication"

See Also:

Constant Field Values

CLOSEAPPLICATIONMAP_KEYWORD

public static final java.lang.String CLOSEAPPLICATIONMAP_KEYWORD

"CloseApplicationMap"

See Also:

Constant Field Values

COPYVARIABLEVALUEEX_KEYWORD

public static final java.lang.String COPYVARIABLEVALUEEX_KEYWORD

"CopyVariableValueEx"

See Also:

Constant Field Values

DELAY_KEYWORD

public static final java.lang.String DELAY_KEYWORD

"Delay"

See Also:

Constant Field Values

DISABLEDOMAIN_KEYWORD

public static final java.lang.String DISABLEDOMAIN_KEYWORD

"DisableDomain"

See Also:

Constant Field Values

ENABLEDOMAIN_KEYWORD

public static final java.lang.String ENABLEDOMAIN_KEYWORD

"EnableDomain"

See Also:

Constant Field Values

EXPRESSIONS_KEYWORD

public static final java.lang.String EXPRESSIONS_KEYWORD

"Expressions"

See Also:

Constant Field Values

GET_SECS_BEFORE_MOUSE_DOWN_KEYWORD

public static final java.lang.String GET_SECS_BEFORE_MOUSE_DOWN_KEYWORD

"GetSecsBeforeMouseDown"

See Also:

Constant Field Values

GET_SECS_BEFORE_MOUSE_UP_KEYWORD

public static final java.lang.String GET_SECS_BEFORE_MOUSE_UP_KEYWORD

"GetSecsBeforeMouseUp"

See Also:

Constant Field Values

GETAPPMAPVALUE_KEYWORD

public static final java.lang.String GETAPPMAPVALUE_KEYWORD

"GetAppMapValue"

See Also:

Constant Field Values

GETCOMPSCREENRESOLUTION_KEYWORD

public static final java.lang.String GETCOMPSCREENRESOLUTION_KEYWORD

"GetCompScreenResolution"

See Also:

Constant Field Values

GETDELTADATE_KEYWORD

public static final java.lang.String GETDELTADATE_KEYWORD

"GetDeltaDate"

See Also:

Constant Field Values

GETMILLISBETWEENRECORDS_KEYWORD

public static final java.lang.String GETMILLISBETWEENRECORDS_KEYWORD

"GetMillisBetweenRecords"

See Also:

Constant Field Values

GETREGISTRYKEYVALUE_KEYWORD

public static final java.lang.String GETREGISTRYKEYVALUE_KEYWORD

"GetRegistryKeyValue"

See Also:

Constant Field Values

GETSECSAFTERWINDOWACTIVE_KEYWORD

public static final java.lang.String GETSECSAFTERWINDOWACTIVE_KEYWORD

"GetSecsAfterWindowActive"

See Also:

Constant Field Values

GETSECSDELAYRETRYCOMPONENT_KEYWORD

public static final java.lang.String GETSECSDELAYRETRYCOMPONENT_KEYWORD

"GetSecsDelayRetryComponent"

See Also:

Constant Field Values

GETSECSSEEKCOMPONENT_KEYWORD

public static final java.lang.String GETSECSSEEKCOMPONENT_KEYWORD

"GetSecsSeekComponent"

See Also:

Constant Field Values

GETSYSTEMDATE_KEYWORD

public static final java.lang.String GETSYSTEMDATE_KEYWORD

"GetSystemDate"

See Also:

Constant Field Values

GETSYSTEMDATETIME_KEYWORD

public static final java.lang.String GETSYSTEMDATETIME_KEYWORD

"GetSystemDateTime"

See Also:

Constant Field Values

GETSYSTEMTIME_KEYWORD

public static final java.lang.String GETSYSTEMTIME_KEYWORD

"GetSystemTime"

See Also:

Constant Field Values

GETURL_KEYWORD

public static final java.lang.String GETURL_KEYWORD

"GetURL"

See Also:

Constant Field Values

GETVERSION_KEYWORD

public static final java.lang.String GETVERSION_KEYWORD

"GetVersion"

See Also:

Constant Field Values

HIDESOFTKEYBOARD_KEYWORD

public static final java.lang.String HIDESOFTKEYBOARD_KEYWORD

"HideSoftKeyboard"

See Also:

Constant Field Values

HIGHLIGHT_KEYWORD

public static final java.lang.String HIGHLIGHT_KEYWORD

"HighLight"

See Also:

Constant Field Values

LAUNCHAPPLICATION_KEYWORD

public static final java.lang.String LAUNCHAPPLICATION_KEYWORD

"LaunchApplication"

See Also:

Constant Field Values

NOTIFYANDWAIT_KEYWORD

public static final java.lang.String NOTIFYANDWAIT_KEYWORD

"NotifyAndWait"

See Also:

Constant Field Values

PAUSE_KEYWORD

public static final java.lang.String PAUSE_KEYWORD

"Pause"

See Also:

Constant Field Values

SAVECLIPBOARDTOFILE_KEYWORD

public static final java.lang.String SAVECLIPBOARDTOFILE_KEYWORD

"SaveClipboardToFile"

See Also:

Constant Field Values

SAVEURLTOFILE_KEYWORD

public static final java.lang.String SAVEURLTOFILE_KEYWORD

"SaveURLToFile"

See Also:

Constant Field Values

SCROLLWHEEL_KEYWORD

public static final java.lang.String SCROLLWHEEL_KEYWORD

"ScrollWheel"

See Also:

Constant Field Values

SENDEMAIL_KEYWORD

public static final java.lang.String SENDEMAIL_KEYWORD

"SendEmail"

See Also:

Constant Field Values

SET_SECS_BEFORE_MOUSE_DOWN_KEYWORD

public static final java.lang.String SET_SECS_BEFORE_MOUSE_DOWN_KEYWORD

"SetSecsBeforeMouseDown"

See Also:

Constant Field Values

SET_SECS_BEFORE_MOUSE_UP_KEYWORD

public static final java.lang.String SET_SECS_BEFORE_MOUSE_UP_KEYWORD

"SetSecsBeforeMouseUp"

See Also:

Constant Field Values

SETAPPLICATIONMAP_KEYWORD

public static final java.lang.String SETAPPLICATIONMAP_KEYWORD

"SetApplicationMap"

See Also:

Constant Field Values

SETBENCHDIRECTORY_KEYWORD

public static final java.lang.String SETBENCHDIRECTORY_KEYWORD

"SetBenchDirectory"

See Also:

Constant Field Values

SETCLIPBOARD_KEYWORD

public static final java.lang.String SETCLIPBOARD_KEYWORD

"SetClipboard"

See Also:

Constant Field Values

SETCONTEXT_KEYWORD

public static final java.lang.String SETCONTEXT_KEYWORD

"SetContext"

See Also:

Constant Field Values

SETDIFDIRECTORY_KEYWORD

public static final java.lang.String SETDIFDIRECTORY_KEYWORD

"SetDifDirectory"

See Also:

Constant Field Values

SETFOCUS_KEYWORD

public static final java.lang.String SETFOCUS_KEYWORD

"SetFocus"

See Also:

Constant Field Values

SETIMAGEDEBUG_KEYWORD

public static final java.lang.String SETIMAGEDEBUG_KEYWORD

"SetImageDebug"

See Also:

Constant Field Values

SETIMAGEFUZZYMATCHING_KEYWORD

public static final java.lang.String SETIMAGEFUZZYMATCHING_KEYWORD

"SetImageFuzzyMatching"

See Also:

Constant Field Values

SETMILLISBETWEENRECORDS_KEYWORD

public static final java.lang.String SETMILLISBETWEENRECORDS_KEYWORD

"SetMillisBetweenRecords"

See Also:

Constant Field Values

SETMULTIPLETHREADSEARCH_KEYWORD

public static final java.lang.String SETMULTIPLETHREADSEARCH_KEYWORD

"SetMultipleThreadSearch"

See Also:

Constant Field Values

SETPROJECTDIRECTORY_KEYWORD

public static final java.lang.String SETPROJECTDIRECTORY_KEYWORD

"SetProjectDirectory"

See Also:

Constant Field Values

SETROOTVERIFYDIRECTORY_KEYWORD

public static final java.lang.String SETROOTVERIFYDIRECTORY_KEYWORD

"SetRootVerifyDirectory"

See Also:

Constant Field Values

SETSECSAFTERWINDOWACTIVE_KEYWORD

public static final java.lang.String SETSECSAFTERWINDOWACTIVE_KEYWORD

"SetSecsAfterWindowActive"

See Also:

Constant Field Values

SETSECSDELAYRETRYCOMPONENT_KEYWORD

public static final java.lang.String SETSECSDELAYRETRYCOMPONENT_KEYWORD

"SetSecsDelayRetryComponent"

See Also:

Constant Field Values

SETSECSSEEKCOMPONENT_KEYWORD

public static final java.lang.String SETSECSSEEKCOMPONENT_KEYWORD

"SetSecsSeekComponent"

See Also:

Constant Field Values

SETTESTDIRECTORY_KEYWORD

public static final java.lang.String SETTESTDIRECTORY_KEYWORD

"SetTestDirectory"

See Also:

Constant Field Values

SETVARIABLEVALUEEX_KEYWORD

public static final java.lang.String SETVARIABLEVALUEEX_KEYWORD

"SetVariableValueEx"

See Also:

Constant Field Values

SETVARIABLEVALUES_KEYWORD

public static final java.lang.String SETVARIABLEVALUES_KEYWORD

"SetVariableValues"

See Also:

Constant Field Values

SHOWSOFTKEYBOARD_KEYWORD

public static final java.lang.String SHOWSOFTKEYBOARD_KEYWORD

"ShowSoftKeyboard"

See Also:

Constant Field Values

STARTWEBBROWSER_KEYWORD

public static final java.lang.String STARTWEBBROWSER_KEYWORD

"StartWebBrowser"

See Also:

Constant Field Values

STOPWEBBROWSER_KEYWORD

public static final java.lang.String STOPWEBBROWSER_KEYWORD

"StopWebBrowser"

See Also:

Constant Field Values

SWITCHWINDOW_KEYWORD

public static final java.lang.String SWITCHWINDOW_KEYWORD

"SwitchWindow"

See Also:

Constant Field Values

TAKESCREENSHOT_KEYWORD

public static final java.lang.String TAKESCREENSHOT_KEYWORD

"TakeScreenShot"

See Also:

Constant Field Values

USEABBOTFUNCTIONS_KEYWORD

public static final java.lang.String USEABBOTFUNCTIONS_KEYWORD

"UseAbbotFunctions"

See Also:

Constant Field Values

USEDRIODFUNCTIONS_KEYWORD

public static final java.lang.String USEDRIODFUNCTIONS_KEYWORD

"UseDroidFunctions"

See Also:

Constant Field Values

USEIOSFUNCTIONS_KEYWORD

public static final java.lang.String USEIOSFUNCTIONS_KEYWORD

"UseIOSFunctions"

See Also:

Constant Field Values

USEQTPFUNCTIONS_KEYWORD

public static final java.lang.String USEQTPFUNCTIONS_KEYWORD

"UseQTPFunctions"

See Also:

Constant Field Values

USEROBOTJFUNCTIONS_KEYWORD

public static final java.lang.String USEROBOTJFUNCTIONS_KEYWORD

"UseRobotJFunctions"

See Also:

Constant Field Values

USESAFSFUNCTIONS_KEYWORD

public static final java.lang.String USESAFSFUNCTIONS_KEYWORD

"UseSAFSFunctions"

See Also:

Constant Field Values

USESELENIUMFUNCTIONS_KEYWORD

public static final java.lang.String USESELENIUMFUNCTIONS_KEYWORD

"UseSeleniumFunctions"

See Also:

Constant Field Values

USETESTCOMPLETEFUNCTIONS_KEYWORD

public static final java.lang.String USETESTCOMPLETEFUNCTIONS_KEYWORD

"UseTestCompleteFunctions"

See Also:

Constant Field Values

USEWEBBROWSER_KEYWORD

public static final java.lang.String USEWEBBROWSER_KEYWORD

"UseWebBrowser"

See Also:

Constant Field Values

VERIFYCLIPBOARDTOFILE_KEYWORD

public static final java.lang.String VERIFYCLIPBOARDTOFILE_KEYWORD

"VerifyClipboardToFile"

See Also:

Constant Field Values

VERIFYURLCONTENT_KEYWORD

public static final java.lang.String VERIFYURLCONTENT_KEYWORD

"VerifyURLContent"

See Also:

Constant Field Values

VERIFYURLTOFILE_KEYWORD

public static final java.lang.String VERIFYURLTOFILE_KEYWORD

"VerifyURLToFile"

See Also:

Constant Field Values

VERSION_KEYWORD

public static final java.lang.String VERSION_KEYWORD

"Version"

See Also:

Constant Field Values

WAITFORGUI_KEYWORD

public static final java.lang.String WAITFORGUI_KEYWORD

"WaitForGUI"

See Also:

Constant Field Values

WAITFORGUIGONE_KEYWORD

public static final java.lang.String WAITFORGUIGONE_KEYWORD

"WaitForGUIGone"

See Also:

Constant Field Values

WAITFORPROPERTYVALUE_KEYWORD

public static final java.lang.String WAITFORPROPERTYVALUE_KEYWORD

"WaitForPropertyValue"

See Also:

Constant Field Values

WAITFORPROPERTYVALUEGONE_KEYWORD

public static final java.lang.String WAITFORPROPERTYVALUEGONE_KEYWORD

"WaitForPropertyValueGone"

See Also:

Constant Field Values

WAITFORREGISTRYKEYEXISTS_KEYWORD

public static final java.lang.String WAITFORREGISTRYKEYEXISTS_KEYWORD

"WaitForRegistryKeyExists"

See Also:

Constant Field Values

WAITFORREGISTRYKEYVALUE_KEYWORD

public static final java.lang.String WAITFORREGISTRYKEYVALUE_KEYWORD

"WaitForRegistryKeyValue"

See Also:

Constant Field Values

WAITFORWEBPAGE_KEYWORD

public static final java.lang.String WAITFORWEBPAGE_KEYWORD

"WaitForWebPage"

See Also:

Constant Field Values

DELETECOUNTER_KEYWORD

public static final java.lang.String DELETECOUNTER_KEYWORD

"DeleteCounter"

See Also:

Constant Field Values

LOGCOUNTERINFO_KEYWORD

public static final java.lang.String LOGCOUNTERINFO_KEYWORD

"LogCounterInfo"

See Also:

Constant Field Values

RESETCOUNTER_KEYWORD

public static final java.lang.String RESETCOUNTER_KEYWORD

"ResetCounter"

See Also:

Constant Field Values

RESUMESTATUSCOUNTS_KEYWORD

public static final java.lang.String RESUMESTATUSCOUNTS_KEYWORD

"ResumeStatusCounts"

See Also:

Constant Field Values

SETCOUNTERMODE_KEYWORD

public static final java.lang.String SETCOUNTERMODE_KEYWORD

"SetCounterMode"

See Also:

Constant Field Values

STARTCOUNTER_KEYWORD

public static final java.lang.String STARTCOUNTER_KEYWORD

"StartCounter"

See Also:

Constant Field Values

STARTCYCLE_KEYWORD

public static final java.lang.String STARTCYCLE_KEYWORD

"StartCycle"

See Also:

Constant Field Values

STARTPROCEDURE_KEYWORD

public static final java.lang.String STARTPROCEDURE_KEYWORD

"StartProcedure"

See Also:

Constant Field Values

STARTREQUIREMENT_KEYWORD

public static final java.lang.String STARTREQUIREMENT_KEYWORD

"StartRequirement"

See Also:

Constant Field Values

STARTSUITE_KEYWORD

public static final java.lang.String STARTSUITE_KEYWORD

"StartSuite"

See Also:

Constant Field Values

STARTTESTCASE_KEYWORD

public static final java.lang.String STARTTESTCASE_KEYWORD

"StartTestcase"

See Also:

Constant Field Values

STOPCOUNTER_KEYWORD

public static final java.lang.String STOPCOUNTER_KEYWORD

"StopCounter"

See Also:

Constant Field Values

STOPCYCLE_KEYWORD

public static final java.lang.String STOPCYCLE_KEYWORD

"StopCycle"

See Also:

Constant Field Values

STOPPROCEDURE_KEYWORD

public static final java.lang.String STOPPROCEDURE_KEYWORD

"StopProcedure"

See Also:

Constant Field Values

STOPREQUIREMENT_KEYWORD

public static final java.lang.String STOPREQUIREMENT_KEYWORD

"StopRequirement"

See Also:

Constant Field Values

STOPSUITE_KEYWORD

public static final java.lang.String STOPSUITE_KEYWORD

"StopSuite"

See Also:

Constant Field Values

STOPTESTCASE_KEYWORD

public static final java.lang.String STOPTESTCASE_KEYWORD

"StopTestcase"

See Also:

Constant Field Values

STORECOUNTERINFO_KEYWORD

public static final java.lang.String STORECOUNTERINFO_KEYWORD

"StoreCounterInfo"

See Also:

Constant Field Values

SUSPENDSTATUSCOUNTS_KEYWORD

public static final java.lang.String SUSPENDSTATUSCOUNTS_KEYWORD

"SuspendStatusCounts"

See Also:

Constant Field Values

COPYDBTABLECOLUMNTOFILE_KEYWORD

public static final java.lang.String COPYDBTABLECOLUMNTOFILE_KEYWORD

"CopyDBTableColumnToFile"

See Also:

Constant Field Values

COPYDBTABLETOFILE_KEYWORD

public static final java.lang.String COPYDBTABLETOFILE_KEYWORD

"CopyDBTableToFile"

See Also:

Constant Field Values

DELETEDBTABLERECORDS_KEYWORD

public static final java.lang.String DELETEDBTABLERECORDS_KEYWORD

"DeleteDBTableRecords"

See Also:

Constant Field Values

EXECSQLQUERY_KEYWORD

public static final java.lang.String EXECSQLQUERY_KEYWORD

"ExecSQLQuery"

See Also:

Constant Field Values

GETDBTABLECOLUMNCOUNT_KEYWORD

public static final java.lang.String GETDBTABLECOLUMNCOUNT_KEYWORD

"GetDBTableColumnCount"

See Also:

Constant Field Values

GETDBTABLEROWCOUNT_KEYWORD

public static final java.lang.String GETDBTABLEROWCOUNT_KEYWORD

"GetDBTableRowCount"

See Also:

Constant Field Values

GETDBVALUE_KEYWORD

public static final java.lang.String GETDBVALUE_KEYWORD

"GetDBValue"

See Also:

Constant Field Values

SETJDBCDRIVER_KEYWORD

public static final java.lang.String SETJDBCDRIVER_KEYWORD

"SetJdbcDriver"

See Also:

Constant Field Values

VERIFYDATABASENULLVALUE_KEYWORD

public static final java.lang.String VERIFYDATABASENULLVALUE_KEYWORD

"VerifyDatabaseNullValue"

See Also:

Constant Field Values

VERIFYDATABASEVALUE_KEYWORD

public static final java.lang.String VERIFYDATABASEVALUE_KEYWORD

"VerifyDatabaseValue"

See Also:

Constant Field Values

VERIFYDBNULLVALUE_KEYWORD

public static final java.lang.String VERIFYDBNULLVALUE_KEYWORD

"VerifyDBNullValue"

See Also:

Constant Field Values

VERIFYDBVALUE_KEYWORD

public static final java.lang.String VERIFYDBVALUE_KEYWORD

"VerifyDBValue"

See Also:

Constant Field Values

BREAKPOINTS_KEYWORD

public static final java.lang.String BREAKPOINTS_KEYWORD

"Breakpoints"

See Also:

Constant Field Values

COMMANDDEBUG_KEYWORD

public static final java.lang.String COMMANDDEBUG_KEYWORD

"CommandDebug"

See Also:

Constant Field Values

RECORDSDEBUG_KEYWORD

public static final java.lang.String RECORDSDEBUG_KEYWORD

"RecordsDebug"

See Also:

Constant Field Values

TESTDEBUG_KEYWORD

public static final java.lang.String TESTDEBUG_KEYWORD

"TestDebug"

See Also:

Constant Field Values

CLOSEFILE_KEYWORD

public static final java.lang.String CLOSEFILE_KEYWORD

"CloseFile"

See Also:

Constant Field Values

COPYFILE_KEYWORD

public static final java.lang.String COPYFILE_KEYWORD

"CopyFile"

See Also:

Constant Field Values

COPYMATCHINGFILES_KEYWORD

public static final java.lang.String COPYMATCHINGFILES_KEYWORD

"CopyMatchingFiles"

See Also:

Constant Field Values

CREATEDIRECTORY_KEYWORD

public static final java.lang.String CREATEDIRECTORY_KEYWORD

"CreateDirectory"

See Also:

Constant Field Values

CREATEFILE_KEYWORD

public static final java.lang.String CREATEFILE_KEYWORD

"CreateFile"

See Also:

Constant Field Values

DELETEDIRECTORY_KEYWORD

public static final java.lang.String DELETEDIRECTORY_KEYWORD

"DeleteDirectory"

See Also:

Constant Field Values

DELETEDIRECTORYCONTENTS_KEYWORD

public static final java.lang.String DELETEDIRECTORYCONTENTS_KEYWORD

"DeleteDirectoryContents"

See Also:

Constant Field Values

DELETEFILE_KEYWORD

public static final java.lang.String DELETEFILE_KEYWORD

"DeleteFile"

See Also:

Constant Field Values

FILTERIMAGE_KEYWORD

public static final java.lang.String FILTERIMAGE_KEYWORD

"FilterImage"

See Also:

Constant Field Values

FILTERTEXTFILE_KEYWORD

public static final java.lang.String FILTERTEXTFILE_KEYWORD

"FilterTextFile"

See Also:

Constant Field Values

FINDSQAFILE_KEYWORD

public static final java.lang.String FINDSQAFILE_KEYWORD

"FindSqaFile"

See Also:

Constant Field Values

GETFILEDATETIME_KEYWORD

public static final java.lang.String GETFILEDATETIME_KEYWORD

"GetFileDateTime"

See Also:

Constant Field Values

GETFILEPROTECTIONS_KEYWORD

public static final java.lang.String GETFILEPROTECTIONS_KEYWORD

"GetFileProtections"

See Also:

Constant Field Values

GETFILES_KEYWORD

public static final java.lang.String GETFILES_KEYWORD

"GetFiles"

See Also:

Constant Field Values

GETFILESIZE_KEYWORD

public static final java.lang.String GETFILESIZE_KEYWORD

"GetFileSize"

See Also:

Constant Field Values

GETINIFILEVALUE_KEYWORD

public static final java.lang.String GETINIFILEVALUE_KEYWORD

"GetINIFileValue"

See Also:

Constant Field Values

GETSTRINGCOUNTINFILE_KEYWORD

public static final java.lang.String GETSTRINGCOUNTINFILE_KEYWORD

"GetStringCountInFile"

See Also:

Constant Field Values

GETSUBSTRINGSINFILE_KEYWORD

public static final java.lang.String GETSUBSTRINGSINFILE_KEYWORD

"GetSubstringsInFile"

See Also:

Constant Field Values

GETTEXTFROMIMAGE_KEYWORD

public static final java.lang.String GETTEXTFROMIMAGE_KEYWORD

"GetTextFromImage"

See Also:

Constant Field Values

IFEXISTDIR_KEYWORD

public static final java.lang.String IFEXISTDIR_KEYWORD

"IfExistDir"

See Also:

Constant Field Values

IFEXISTFILE_KEYWORD

public static final java.lang.String IFEXISTFILE_KEYWORD

"IfExistFile"

See Also:

Constant Field Values

ISENDOFFILE_KEYWORD

public static final java.lang.String ISENDOFFILE_KEYWORD

"IsEndOfFile"

See Also:

Constant Field Values

OPENFILE_KEYWORD

public static final java.lang.String OPENFILE_KEYWORD

"OpenFile"

See Also:

Constant Field Values

OPENUTF8FILE_KEYWORD

public static final java.lang.String OPENUTF8FILE_KEYWORD

"OpenUTF8File"

See Also:

Constant Field Values

PRINTTOFILE_KEYWORD

public static final java.lang.String PRINTTOFILE_KEYWORD

"PrintToFile"

See Also:

Constant Field Values

READFILECHARS_KEYWORD

public static final java.lang.String READFILECHARS_KEYWORD

"ReadFileChars"

See Also:

Constant Field Values

READFILELINE_KEYWORD

public static final java.lang.String READFILELINE_KEYWORD

"ReadFileLine"

See Also:

Constant Field Values

READFILESTRING_KEYWORD

public static final java.lang.String READFILESTRING_KEYWORD

"ReadFileString"

See Also:

Constant Field Values

RENAMEFILE_KEYWORD

public static final java.lang.String RENAMEFILE_KEYWORD

"RenameFile"

See Also:

Constant Field Values

SAVETEXTFROMIMAGE_KEYWORD

public static final java.lang.String SAVETEXTFROMIMAGE_KEYWORD

"SaveTextFromImage"

See Also:

Constant Field Values

SETFILEPROTECTIONS_KEYWORD

public static final java.lang.String SETFILEPROTECTIONS_KEYWORD

"SetFileProtections"

See Also:

Constant Field Values

WRITEFILECHARS_KEYWORD

public static final java.lang.String WRITEFILECHARS_KEYWORD

"WriteFileChars"

See Also:

Constant Field Values

CALLCYCLE_KEYWORD

public static final java.lang.String CALLCYCLE_KEYWORD

"CallCycle"

See Also:

Constant Field Values

CALLJUNIT_KEYWORD

public static final java.lang.String CALLJUNIT_KEYWORD

"CallJUnit"

See Also:

Constant Field Values

CALLSCRIPT_KEYWORD

public static final java.lang.String CALLSCRIPT_KEYWORD

"CallScript"

See Also:

Constant Field Values

CALLSTEP_KEYWORD

public static final java.lang.String CALLSTEP_KEYWORD

"CallStep"

See Also:

Constant Field Values

CALLSUITE_KEYWORD

public static final java.lang.String CALLSUITE_KEYWORD

"CallSuite"

See Also:

Constant Field Values

EXITCYCLE_KEYWORD

public static final java.lang.String EXITCYCLE_KEYWORD

"ExitCycle"

See Also:

Constant Field Values

EXITSUITE_KEYWORD

public static final java.lang.String EXITSUITE_KEYWORD

"ExitSuite"

See Also:

Constant Field Values

EXITTABLE_KEYWORD

public static final java.lang.String EXITTABLE_KEYWORD

"ExitTable"

See Also:

Constant Field Values

GOTOBLOCKID_KEYWORD

public static final java.lang.String GOTOBLOCKID_KEYWORD

"GotoBlockID"

See Also:

Constant Field Values

ONCONTAINSGOTOBLOCKID_KEYWORD

public static final java.lang.String ONCONTAINSGOTOBLOCKID_KEYWORD

"OnContainsGotoBlockID"

See Also:

Constant Field Values

OnDirectoryExistGotoBlockID_KEYWORD

public static final java.lang.String OnDirectoryExistGotoBlockID_KEYWORD

"OnDirectoryExistGotoBlockID"

See Also:

Constant Field Values

ONDIRECTORYNOTEXISTGOTOBLOCKID_KEYWORD

public static final java.lang.String ONDIRECTORYNOTEXISTGOTOBLOCKID_KEYWORD

"OnDirectoryNotExistGotoBlockID"

See Also:

Constant Field Values

ONEQUALGOTOBLOCKID_KEYWORD

public static final java.lang.String ONEQUALGOTOBLOCKID_KEYWORD

"OnEqualGotoBlockID"

See Also:

Constant Field Values

ONFILEEOFGOTOBLOCKID_KEYWORD

public static final java.lang.String ONFILEEOFGOTOBLOCKID_KEYWORD

"OnFileEOFGotoBlockID"

See Also:

Constant Field Values

ONFILEEXISTGOTOBLOCKID_KEYWORD

public static final java.lang.String ONFILEEXISTGOTOBLOCKID_KEYWORD

"OnFileExistGotoBlockID"

See Also:

Constant Field Values

ONFILENOTEXISTGOTOBLOCKID_KEYWORD

public static final java.lang.String ONFILENOTEXISTGOTOBLOCKID_KEYWORD

"OnFileNotExistGotoBlockID"

See Also:

Constant Field Values

ONGREATERTHANGOTOBLOCKID_KEYWORD

public static final java.lang.String ONGREATERTHANGOTOBLOCKID_KEYWORD

"OnGreaterThanGotoBlockID"

See Also:

Constant Field Values

ONGUIEXISTSGOTOBLOCKID_KEYWORD

public static final java.lang.String ONGUIEXISTSGOTOBLOCKID_KEYWORD

"OnGUIExistsGotoBlockID"

See Also:

Constant Field Values

ONGUINOTEXISTGOTOBLOCKID_KEYWORD

public static final java.lang.String ONGUINOTEXISTGOTOBLOCKID_KEYWORD

"OnGUINotExistGotoBlockID"

See Also:

Constant Field Values

ONINRANGEGOTOBLOCKID_KEYWORD

public static final java.lang.String ONINRANGEGOTOBLOCKID_KEYWORD

"OnInRangeGotoBlockID"

See Also:

Constant Field Values

ONLESSTHANGOTOBLOCKID_KEYWORD

public static final java.lang.String ONLESSTHANGOTOBLOCKID_KEYWORD

"OnLessThanGotoBlockID"

See Also:

Constant Field Values

ONMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD

public static final java.lang.String ONMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD

"OnMenuItemContainsStateGotoBlockID"

See Also:

Constant Field Values

ONNOTCONTAINSGOTOBLOCKID_KEYWORD

public static final java.lang.String ONNOTCONTAINSGOTOBLOCKID_KEYWORD

"OnNotContainsGotoBlockID"

See Also:

Constant Field Values

ONNOTEQUALGOTOBLOCKID_KEYWORD

public static final java.lang.String ONNOTEQUALGOTOBLOCKID_KEYWORD

"OnNotEqualGotoBlockID"

See Also:

Constant Field Values

ONNOTGREATERTHANGOTOBLOCKID_KEYWORD

public static final java.lang.String ONNOTGREATERTHANGOTOBLOCKID_KEYWORD

"OnNotGreaterThanGotoBlockID"

See Also:

Constant Field Values

ONNOTINRANGEGOTOBLOCKID_KEYWORD

public static final java.lang.String ONNOTINRANGEGOTOBLOCKID_KEYWORD

"OnNotInRangeGotoBlockID"

See Also:

Constant Field Values

ONNOTLESSTHANGOTOBLOCKID_KEYWORD

public static final java.lang.String ONNOTLESSTHANGOTOBLOCKID_KEYWORD

"OnNotLessThanGotoBlockID"

See Also:

Constant Field Values

ONPARTIALMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD

public static final java.lang.String ONPARTIALMENUITEMCONTAINSSTATEGOTOBLOCKID_KEYWORD

"OnPartialMenuItemContainsStateGotoBlockID"

See Also:

Constant Field Values

ONREGISTRYKEYEXISTGOTOBLOCKID_KEYWORD

public static final java.lang.String ONREGISTRYKEYEXISTGOTOBLOCKID_KEYWORD

"OnRegistryKeyExistGotoBlockID"

See Also:

Constant Field Values

ONREGISTRYKEYNOTEXISTGOTOBLOCKID_KEYWORD

public static final java.lang.String ONREGISTRYKEYNOTEXISTGOTOBLOCKID_KEYWORD

"OnRegistryKeyNotExistGotoBlockID"

See Also:

Constant Field Values

SETEXITTABLEBLOCK_KEYWORD

public static final java.lang.String SETEXITTABLEBLOCK_KEYWORD

"SetExitTableBlock"

See Also:

Constant Field Values

SETGENERALSCRIPTFAILUREBLOCK_KEYWORD

public static final java.lang.String SETGENERALSCRIPTFAILUREBLOCK_KEYWORD

"SetGeneralScriptFailureBlock"

See Also:

Constant Field Values

SETINVALIDFILEIOBLOCK_KEYWORD

public static final java.lang.String SETINVALIDFILEIOBLOCK_KEYWORD

"SetInvalidFileIOBlock"

See Also:

Constant Field Values

SETNOSCRIPTFAILUREBLOCK_KEYWORD

public static final java.lang.String SETNOSCRIPTFAILUREBLOCK_KEYWORD

"SetNoScriptFailureBlock"

See Also:

Constant Field Values

SETSCRIPTNOTEXECUTEDBLOCK_KEYWORD

public static final java.lang.String SETSCRIPTNOTEXECUTEDBLOCK_KEYWORD

"SetScriptNotExecutedBlock"

See Also:

Constant Field Values

SETSCRIPTWARNINGBLOCK_KEYWORD

public static final java.lang.String SETSCRIPTWARNINGBLOCK_KEYWORD

"SetScriptWarningBlock"

See Also:

Constant Field Values

USELOCALFLOWCONTROL_KEYWORD

public static final java.lang.String USELOCALFLOWCONTROL_KEYWORD

"UseLocalFlowControl"

See Also:

Constant Field Values

LOGFAILUREOK_KEYWORD

public static final java.lang.String LOGFAILUREOK_KEYWORD

"LogFailureOK"

See Also:

Constant Field Values

LOGMESSAGE_KEYWORD

public static final java.lang.String LOGMESSAGE_KEYWORD

"LogMessage"

See Also:

Constant Field Values

LOGTESTFAILURE_KEYWORD

public static final java.lang.String LOGTESTFAILURE_KEYWORD

"LogTestFailure"

See Also:

Constant Field Values

LOGTESTSUCCESS_KEYWORD

public static final java.lang.String LOGTESTSUCCESS_KEYWORD

"LogTestSuccess"

See Also:

Constant Field Values

LOGTESTWARNING_KEYWORD

public static final java.lang.String LOGTESTWARNING_KEYWORD

"LogTestWarning"

See Also:

Constant Field Values

LOGWARNINGOK_KEYWORD

public static final java.lang.String LOGWARNINGOK_KEYWORD

"LogWarningOK"

See Also:

Constant Field Values

RESUMELOGGING_KEYWORD

public static final java.lang.String RESUMELOGGING_KEYWORD

"ResumeLogging"

See Also:

Constant Field Values

SUSPENDLOGGING_KEYWORD

public static final java.lang.String SUSPENDLOGGING_KEYWORD

"SuspendLogging"

See Also:

Constant Field Values

RESTCLEANRESPONSEMAP_KEYWORD

public static final java.lang.String RESTCLEANRESPONSEMAP_KEYWORD

"RestCleanResponseMap"

See Also:

Constant Field Values

RESTDELETERESPONSE_KEYWORD

public static final java.lang.String RESTDELETERESPONSE_KEYWORD

"RestDeleteResponse"

See Also:

Constant Field Values

RESTDELETERESPONSESTORE_KEYWORD

public static final java.lang.String RESTDELETERESPONSESTORE_KEYWORD

"RestDeleteResponseStore"

See Also:

Constant Field Values

RESTHEADERSLOAD_KEYWORD

public static final java.lang.String RESTHEADERSLOAD_KEYWORD

"RestHeadersLoad"

See Also:

Constant Field Values

RESTSTORERESPONSE_KEYWORD

public static final java.lang.String RESTSTORERESPONSE_KEYWORD

"RestStoreResponse"

See Also:

Constant Field Values

RESTVERIFYRESPONSE_KEYWORD

public static final java.lang.String RESTVERIFYRESPONSE_KEYWORD

"RestVerifyResponse"

See Also:

Constant Field Values

RESTVERIFYRESPONSECONTAINS_KEYWORD

public static final java.lang.String RESTVERIFYRESPONSECONTAINS_KEYWORD

"RestVerifyResponseContains"

See Also:

Constant Field Values

CLEANSTRING_KEYWORD

public static final java.lang.String CLEANSTRING_KEYWORD

"CleanString"

See Also:

Constant Field Values

COMPARE_KEYWORD

public static final java.lang.String COMPARE_KEYWORD

"Compare"

See Also:

Constant Field Values

CONCATENATE_KEYWORD

public static final java.lang.String CONCATENATE_KEYWORD

"Concatenate"

See Also:

Constant Field Values

GETFIELD_KEYWORD

public static final java.lang.String GETFIELD_KEYWORD

"GetField"

See Also:

Constant Field Values

GETFIELDCOUNT_KEYWORD

public static final java.lang.String GETFIELDCOUNT_KEYWORD

"GetFieldCount"

See Also:

Constant Field Values

GETFIXEDWIDTHFIELD_KEYWORD

public static final java.lang.String GETFIXEDWIDTHFIELD_KEYWORD

"GetFixedWidthField"

See Also:

Constant Field Values

GETMULTIDELIMITEDFIELD_KEYWORD

public static final java.lang.String GETMULTIDELIMITEDFIELD_KEYWORD

"GetMultiDelimitedField"

See Also:

Constant Field Values

GETMULTIDELIMITEDFIELDCOUNT_KEYWORD

public static final java.lang.String GETMULTIDELIMITEDFIELDCOUNT_KEYWORD

"GetMultiDelimitedFieldCount"

See Also:

Constant Field Values

GETNEXTDELIMITERINDEX_KEYWORD

public static final java.lang.String GETNEXTDELIMITERINDEX_KEYWORD

"GetNextDelimiterIndex"

See Also:

Constant Field Values

GETREDELIMITEDFIELD_KEYWORD

public static final java.lang.String GETREDELIMITEDFIELD_KEYWORD

"GetREDelimitedField"

See Also:

Constant Field Values

GETREDELIMITEDFIELDCOUNT_KEYWORD

public static final java.lang.String GETREDELIMITEDFIELDCOUNT_KEYWORD

"GetREDelimitedFieldCount"

See Also:

Constant Field Values

GETSUBSTRINGINSTRING_KEYWORD

public static final java.lang.String GETSUBSTRINGINSTRING_KEYWORD

"GetSubstringsInString"

See Also:

Constant Field Values

GETSYSTEMENVIRON_KEYWORD

public static final java.lang.String GETSYSTEMENVIRON_KEYWORD

"GetSystemEnviron"

See Also:

Constant Field Values

GETSYSTEMUSER_KEYWORD

public static final java.lang.String GETSYSTEMUSER_KEYWORD

"GetSystemUser"

See Also:

Constant Field Values

GETTRIMMEDFIELD_KEYWORD

public static final java.lang.String GETTRIMMEDFIELD_KEYWORD

"GetTrimmedField"

See Also:

Constant Field Values

INDEX_KEYWORD

public static final java.lang.String INDEX_KEYWORD

"Index"

See Also:

Constant Field Values

LEFT_KEYWORD

public static final java.lang.String LEFT_KEYWORD

"Left"

See Also:

Constant Field Values

LEFTTRIM_KEYWORD

public static final java.lang.String LEFTTRIM_KEYWORD

"LeftTrim"

See Also:

Constant Field Values

LENGTH_KEYWORD

public static final java.lang.String LENGTH_KEYWORD

"Length"

See Also:

Constant Field Values

REPLACE_KEYWORD

public static final java.lang.String REPLACE_KEYWORD

"Replace"

See Also:

Constant Field Values

RIGHT_KEYWORD

public static final java.lang.String RIGHT_KEYWORD

"Right"

See Also:

Constant Field Values

RIGHTTRIM_KEYWORD

public static final java.lang.String RIGHTTRIM_KEYWORD

"RightTrim"

See Also:

Constant Field Values

SUBSTRING_KEYWORD

public static final java.lang.String SUBSTRING_KEYWORD

"SubString"

See Also:

Constant Field Values

TOLOWERCASE_KEYWORD

public static final java.lang.String TOLOWERCASE_KEYWORD

"ToLowerCase"

See Also:

Constant Field Values

TOUPPERCASE_KEYWORD

public static final java.lang.String TOUPPERCASE_KEYWORD

"ToUpperCase"

See Also:

Constant Field Values

TRIM_KEYWORD

public static final java.lang.String TRIM_KEYWORD

"Trim"

See Also:

Constant Field Values

RESETTIMER_KEYWORD

public static final java.lang.String RESETTIMER_KEYWORD

"ResetTimer"

See Also:

Constant Field Values

StartTimer_KEYWORD

public static final java.lang.String StartTimer_KEYWORD

"StartTimer"

See Also:

Constant Field Values

StopTimer_KEYWORD

public static final java.lang.String StopTimer_KEYWORD

"StopTimer"

See Also:

Constant Field Values

StoreTimerInfo_KEYWORD

public static final java.lang.String StoreTimerInfo_KEYWORD

"StoreTimerInfo"

See Also:

Constant Field Values

StoreTimerInfoFile_KEYWORD

public static final java.lang.String StoreTimerInfoFile_KEYWORD

"StoreTimerInfoFile"

See Also:

Constant Field Values

VerifyElapsedTimeInRange_KEYWORD

public static final java.lang.String VerifyElapsedTimeInRange_KEYWORD

"VerifyElapsedTimeInRange"

See Also:

Constant Field Values

VerifyElapsedTimeIsLess_KEYWORD

public static final java.lang.String VerifyElapsedTimeIsLess_KEYWORD

"VerifyElapsedTimeIsLess"

See Also:

Constant Field Values

VerifyElapsedTimeIsMore_KEYWORD

public static final java.lang.String VerifyElapsedTimeIsMore_KEYWORD

"VerifyElapsedTimeIsMore"

See Also:

Constant Field Values

VerifyTimer_KEYWORD

public static final java.lang.String VerifyTimer_KEYWORD

"VerifyTimer"

See Also:

Constant Field Values

ENDREQUIREMENT_KEYWORD

public static final java.lang.String ENDREQUIREMENT_KEYWORD

"EndRequirement"

See Also:

Constant Field Values

ENDTESTCASE_KEYWORD

public static final java.lang.String ENDTESTCASE_KEYWORD

"EndTestcase"

See Also:

Constant Field Values

GETVARIABLEVALUEEX_KEYWORD

public static final java.lang.String GETVARIABLEVALUEEX_KEYWORD

"GetVariableValueEx"

See Also:

Constant Field Values

SETREQUIREMENT_KEYWORD

public static final java.lang.String SETREQUIREMENT_KEYWORD

"SetRequirement"

See Also:

Constant Field Values

SETTESTCASE_KEYWORD

public static final java.lang.String SETTESTCASE_KEYWORD

"SetTestcase"

See Also:

Constant Field Values

_DDDriverCommands

public static DDDriverCommands _DDDriverCommands

static reference to DDDriverCommands.class Miscellaneous Driver Commands. This keyword library provides Driver Commands that can be used in any keyword driven test table regardless of the test tables level--Cycle, Suite, or Step. Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: C , SetApplicationMap , "AppMap.map" Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter. Example: C, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map" The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped). Note that the full availability of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework.

_DDDriverCounterCommands

public static DDDriverCounterCommands _DDDriverCounterCommands

static reference to DDDriverCounterCommands.class Driver Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: c , SetApplicationMap , "AppMap.map" Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter. Example: c, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map" The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped). Note that the full availablility of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework. DDDriverCommands Miscellaneous and often used Commands. DDDriverLogCommands Commands focused on logging test execution. DDDriverFlowCommands Commands focused on Error Recovery and Flow Control. DDDriverCounterCommands Commands focused on status tracking. DDDriverDeprecatedCommands Commands that are still provided for backward compatibility, but are no longer supported. DDDriverDebugCommands Commands focused on debugging test execution.

_DDDriverDatabaseCommands

public static DDDriverDatabaseCommands _DDDriverDatabaseCommands

static reference to DDDriverDatabaseCommands.class Driver Database Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Database Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: Most all commands here require a data source name, Since this driver uses jdbc, then a format like "jdbc:odbc:drivername" is usually supplied for that parameter. Another examples could be: jdbc:oracle:thin:@machine:1111:DBNAME If the jdbc:odbc: is omitted, then the 'drivername' is assumed to be Sun's jdbc-odbc bridge (sun.jdbc.odbc.JdbcOdbcDriver) and that string (jdbc:odbc:) is automatically prepended. Notice that for all of the commands here which accept the ADBAlias and ATableAlias parameters, that they are not used. They are only there because there for compatibility with the Component Function versions of these commands (CFDatabase). In order to specify the driver, a 'setJdbcDriver' command can be used once at the beginning Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Examples: C, setJdbcDriver, "sun.jdbc.odbc.JdbcOdbcDriver" C, setJdbcDriver, "oracle.jdbc.driver.OracleDriver" Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional and can be skipped. Optional parameters can only be skipped if all subsequent optional paramaters are also skipped. Example: c, deleteDBTableRecords, ADBAlias, ATableAlias, DBTableName, DBQueryCond, DBSourceName The above example skips the UserId, Password, and SQLStatus (they are not even included) DDDriverCommands

_DDDriverDebugCommands

public static DDDriverDebugCommands _DDDriverDebugCommands

static reference to DDDriverDebugCommands.class Debug Driver Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: c , SetApplicationMap , "AppMap.map" Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter. Example: c, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map" The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped). Note that the full availablility of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework. DDDriverCommands Miscellaneous and often used Commands. DDDriverLogCommands Commands focused on logging test execution. DDDriverFlowCommands Commands focused on Error Recovery and Flow Control. DDDriverCounterCommands Commands focused on status tracking. DDDriverDeprecatedCommands Commands that are still provided for backward compatibility, but are no longer supported. DDDriverDebugCommands Commands focused on debugging test execution.

_DDDriverFileCommands

public static DDDriverFileCommands _DDDriverFileCommands

static reference to DDDriverFileCommands.class Driver Commands for File Manipulations It is important to note that file command usage cannot readily be mixed and matched across different SAFS engines. For example, Files opened by Robot(RC) are only known to RC. So attempting to use SDC or RJ commands on files opened by RC are not likely to work in this scenario. This will be fixed in future releases.

_DDDriverFlowCommands

public static DDDriverFlowCommands _DDDriverFlowCommands

static reference to DDDriverFlowCommands.class Driver Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: c , SetApplicationMap , "AppMap.map" Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter. Example: c, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map" The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped). Note that the full availablility of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework. DDDriverCommands Miscellaneous and often used Commands. DDDriverLogCommands Commands focused on logging test execution. DDDriverFlowCommands Commands focused on Error Recovery and Flow Control. DDDriverCounterCommands Commands focused on status tracking. DDDriverDeprecatedCommands Commands that are still provided for backward compatibility, but are no longer supported. DDDriverDebugCommands Commands focused on debugging test execution.

_DDDriverLogCommands

public static DDDriverLogCommands _DDDriverLogCommands

static reference to DDDriverLogCommands.class Driver Commands for Logging This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: c , SetApplicationMap , "AppMap.map" Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter. Example: c, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map" The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped). Note that the full availablility of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework. DDDriverCommands Miscellaneous and often used Commands. DDDriverLogCommands Commands focused on logging test execution. DDDriverFlowCommands Commands focused on Error Recovery and Flow Control. DDDriverCounterCommands Commands focused on status tracking. DDDriverDeprecatedCommands Commands that are still provided for backward compatibility, but are no longer supported. DDDriverDebugCommands Commands focused on debugging test execution.

_DDDriverRestCommands

public static DDDriverRestCommands _DDDriverRestCommands

static reference to DDDriverRestCommands.class REST Driver Commands for handling Response like store, delete etc. This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: C, RestStoreResponse, responseId, varnamePrefix Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter. Example: C, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map" The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped).

_DDDriverStringCommands

public static DDDriverStringCommands _DDDriverStringCommands

static reference to DDDriverStringCommands.class Driver Commands for String Manipulations Driver Command record format: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: c , SetApplicationMap , "AppMap.map"

_DDDriverTimerCommands

public static DDDriverTimerCommands _DDDriverTimerCommands

static reference to DDDriverTimerCommands.class Driver Commands for Timer functions Driver Command record format: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: c , SetApplicationMap , "AppMap.map"

_DDDriverDeprecatedCommands

public static DDDriverDeprecatedCommands _DDDriverDeprecatedCommands

static reference to DDDriverDeprecatedCommands.class Deprecated Driver Commands for the Cycle, Suite, and Step drivers This keyword library provides Driver Commands that can be used by all three DDE Drivers--CycleDriver, SuiteDriver, and StepDriver. That means they can be used in any keyword driven test tables regardless of the test tables level--Cycle, Suite, or Step. Each different driver command has different parameters as described in its documentation. For reference, the first fields of ALL Driver Command test records are defined below: Field #1 The "C" = DRIVER COMMAND record type specifier. Field #2 The Driver Command keyword. Example: c , SetApplicationMap , "AppMap.map" Driver Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter. Example: c, LaunchApplication, NOTEPAD, NOTEPAD.EXE, , , "AppMap.map" The above example shows two optional fields after NOTEPAD.EXE which are given no value(skipped). Note that the full availablility of all Driver Commands is now spread across several files. Together, all of these files provide all the Driver Commands available to the core framework. DDDriverCommands Miscellaneous and often used Commands. DDDriverLogCommands Commands focused on logging test execution. DDDriverFlowCommands Commands focused on Error Recovery and Flow Control. DDDriverCounterCommands Commands focused on status tracking. DDDriverDeprecatedCommands Commands that are still provided for backward compatibility, but are no longer supported. DDDriverDebugCommands Commands focused on debugging test execution.

Method Detail

appMapChaining

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:

• SAFS SDCommands
• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:ON Enable("ON") or Disable("OFF") this feature.

appMapResolve

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:

• SAFS SDCommands
• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:ON Enable("ON") or Disable("OFF") this feature.

assignClipboardVariable

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:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium
• Google Android

Parameters:

varName - Optional:NO The variable to copy the clipboard text into.

callRemote

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:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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.

callRemote

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:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

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.

captureMousePositionOnScreen

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:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• AutomatedQA TestComplete
• OpenQA Selenium

Parameters:

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.

captureMousePositionOnScreen

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:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• AutomatedQA TestComplete
• OpenQA Selenium

Parameters:

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

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.

clearAllVariables

public static DriverCommand clearAllVariables()

 
                 Clear storage of all DDVariables.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS SDCommands
• OpenQA Selenium

clearAppMapCache

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:

• Rational RobotJ
• OpenQA Selenium
• OpenQA Selenium
• AutomatedQA TestComplete
• Google Android

clearArrayVariables

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:

• SAFS SDCommands
• OpenQA Selenium

Parameters:

arrayName - Optional:NO The variable name prefix to use for the delete.

clearClipboard

public static DriverCommand clearClipboard()

 
                 Clear the contents of the Window's clipboard.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium
• Mercury Interactive WinRunner
• Google Android

closeApplication

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:

• Google Android
• Rational Robot
• Rational RobotJ
• Apple IOS
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium
• Mercury Interactive WinRunner

Parameters:

applicationID - Optional:NO The Application ID or reference provided to LaunchApplication

closeApplicationMap

public 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:

• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

applicationMap - Optional:NO The path and/or filename (ID) of the Application Map to close.

copyVariableValueEx

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

sourceVariable - Optional:NO The name of the variable to copy.

destinationVariable - Optional:NO The name of the variable to receive the copy

copyVariableValueEx

public 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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

sourceVariable -- Optional:NO The name of the variable to copy.
destinationVariable -- Optional:NO The name of the variable to receive the copy

delay

public static DriverCommand delay(java.lang.String timeout)

 
                 Delay for a specified number of milliseconds.
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

timeout - Optional:NO The number of milliseconds to delay.

disableDomain

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:

• Rational RobotJ

Parameters:

domain - Optional:NO The generic name of the domain to disable.

enableDomain

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:

• Rational RobotJ

Parameters:

domain - Optional:NO The generic name of the domain to enable.

expressions

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:

• Rational Robot
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

mode - Optional:NO DefaultVal:OFF The status for enhanced expression handling.

getAppMapValue

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:

• SAFS SDCommands
• OpenQA Selenium

Parameters:

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.

getAppMapValue

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:

• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

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.

getCompScreenResolution

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:

• Rational Robot
• Rational RobotJ
• AutomatedQA TestComplete

Parameters:

xWidthVariable - Optional:NO SAFSVARS name to be used to store x screen resolution

yHeightVariable - Optional:NO SAFSVARS name to be used to store y screen resolution

getCompScreenResolution

public 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:

• Rational Robot
• Rational RobotJ
• AutomatedQA TestComplete

Parameters:

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

xWidthVariable -- Optional:NO SAFSVARS name to be used to store x screen resolution
yHeightVariable -- Optional:NO SAFSVARS name to be used to store y screen resolution

getDeltaDate

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:

• Rational Robot
• AutomatedQA TestComplete

Parameters:

sourceDateString - Optional:NO String containing the date from which to calculate the delta date

deltaDays - Optional:NO Positive or Negative number of days to calculate date from source date

resultString - Optional:NO Variable name to receive the newly formatted date.

getDeltaDate

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:

• Rational Robot
• AutomatedQA TestComplete

Parameters:

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

sourceDateString -- Optional:NO String containing the date from which to calculate the delta date
deltaDays -- Optional:NO Positive or Negative number of days to calculate date from source date
resultString -- Optional:NO Variable name to receive the newly formatted date.

getMillisBetweenRecords

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:

• SAFS TIDDriverCommands

Parameters:

variableName - Optional:NO The name of the variable to receive the pause between two records.

getRegistryKeyValue

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:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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.

getRegistryKeyValue

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:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

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.

getSecsAfterWindowActive

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:

• Rational RobotJ

Parameters:

variableName - Optional:NO The name of the variable to receive the delay after window is activated.

getSecsBeforeMouseDown

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:

• Rational RobotJ

Parameters:

variableName - Optional:NO The name of the variable to receive the delay before mouse down.

getSecsBeforeMouseUp

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:

• Rational RobotJ

Parameters:

variableName - Optional:NO The name of the variable to receive the delay before mouse up.

getSecsDelayRetryComponent

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:

• Rational RobotJ

Parameters:

variableName - Optional:NO The name of the variable to receive the delay of re-finding object.

getSecsSeekComponent

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:

• Rational RobotJ

Parameters:

variableName - Optional:NO The name of the variable to receive the timeout of finding object.

getSystemDate

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

variableName - Optional:NO The name of the variable to receive the System Date.

getSystemDateTime

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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 format

getSystemDateTime

public 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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

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 format

getSystemTime

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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 format

getSystemTime

public 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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

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 format

getURL

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:

• OpenQA Selenium

Parameters:

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.

getURL

public static DriverCommand getURL(java.lang.String[] parameters)

Send an HTTP GET request, and get the response.    

Supporting Engines:

• OpenQA Selenium

Parameters:

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

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.

getVersion

public static DriverCommand getVersion(java.lang.String variable)

Get the engine VERSION
        Used to specify the VERSION of the engine.
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

variable - Optional:NO DefaultVal:1.0 A variable to accept the VERSION

hideSoftKeyboard

public 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:

• Google Android

highLight

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:

• AutomatedQA TestComplete
• OpenQA Selenium

Parameters:

mode - Optional:Yes The status for highlight functionality. It can be On or Off. The Default is OFF.

launchApplication

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:

• Google Android
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Apple IOS
• SAFS SDCommands
• OpenQA Selenium
• Mercury Interactive WinRunner

Parameters:

applicationID - Optional:NO A text ID or name to reference the application

executablePath - 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.

launchApplication

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:

• Google Android
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Apple IOS
• SAFS SDCommands
• OpenQA Selenium
• Mercury Interactive WinRunner

Parameters:

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

applicationID -- Optional:NO A text ID or name to reference the application
executablePath -- 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.

notifyAndWait

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:

• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

message - Optional:NO The text message to be displayed in the dialog.

title - Optional:YES A short user-defined title for the dialog.

notifyAndWait

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:

• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

message -- Optional:NO The text message to be displayed in the dialog.
title -- Optional:YES A short user-defined title for the dialog.

pause

public static DriverCommand pause(java.lang.String timeout)

 
                 Pause for a specified number of seconds.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

timeout - Optional:NO The number of seconds to Pause.

saveClipboardToFile

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Google Android
• OpenQA Selenium

Parameters:

file - Optional:NO The file to save the clipboard contents to.

encoding - Optional:Yes The encoding used to write a file.

saveClipboardToFile

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Google Android
• OpenQA Selenium

Parameters:

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

file -- Optional:NO The file to save the clipboard contents to.
encoding -- Optional:Yes The encoding used to write a file.

saveURLToFile

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:

• OpenQA Selenium

Parameters:

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.

saveURLToFile

public static DriverCommand saveURLToFile(java.lang.String[] parameters)

Send an HTTP GET request, and save the response into a file.    

Supporting Engines:

• OpenQA Selenium

Parameters:

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

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.

scrollWheel

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:

• Rational RobotJ
• AutomatedQA TestComplete
• OpenQA Selenium

Parameters:

numClicks - Optional:NO The number of mouse wheel clicks to move. .

sendEmail

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:

• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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 path

sendEmail

public 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:

• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

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 path

setApplicationMap

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:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

applicationMap - Optional:NO The path and/or filename of the Application Map to use

setBenchDirectory

public 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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

path - Optional:NO The full or project relative path to the new directory.

setClipboard

public static DriverCommand setClipboard(java.lang.String str)

 
                 Set the clipboard contents to a string.
              
                 Set the clipboard contents to a string.
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Google Android
• OpenQA Selenium

Parameters:

str - Optional:NO The string to set the clipboard contents to.

setContext

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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium
• AutomatedQA TestComplete

Parameters:

windowID - Optional:NO A Window reference from the AppMap

componentID - Optional:NO A reference from the AppMap for the Component within the Window.

setContext

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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium
• AutomatedQA TestComplete

Parameters:

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

windowID -- Optional:NO A Window reference from the AppMap
componentID -- Optional:NO A reference from the AppMap for the Component within the Window.

setDifDirectory

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

path - Optional:NO The full or project relative path to the new directory.

setFocus

public static DriverCommand setFocus(java.lang.String windowID,
                                     java.lang.String componentID)

 
                 Give a Window or Window Component input focus.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium
• AutomatedQA TestComplete
• AUTOIT Team Autoit

Parameters:

windowID - Optional:NO A Window reference from the AppMap

componentID - Optional:NO A reference from the AppMap for the Component within the Window to get input focus.

setFocus

public static DriverCommand setFocus(java.lang.String[] parameters)

 
                 Give a Window or Window Component input focus.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium
• AutomatedQA TestComplete
• AUTOIT Team Autoit

Parameters:

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

windowID -- Optional:NO A Window reference from the AppMap
componentID -- Optional:NO A reference from the AppMap for the Component within the Window to get input focus.

setImageDebug

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:

• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

mode - Optional:NO DefaultVal:OFF The boolean status for enabling extended image debugging.

setImageFuzzyMatching

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:

• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

mode - Optional:NO DefaultVal:OFF The boolean status for enabling extended image-based fuzzy matching.

setMillisBetweenRecords

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:

• SAFS TIDDriverCommands

Parameters:

value - Optional:NO The value of the pause between two records.

setMultipleThreadSearch

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:

• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

onOrOff - Optional:NO Turn on or turn off multi-thread-search. This parameter should be given as "On" or "Off".

setProjectDirectory

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:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

path - Optional:NO The full path to the new directory.

setRootVerifyDirectory

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

path - Optional:NO The full or project relative path to the root directory for Bench, Test, and Dif.

setSecsAfterWindowActive

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:

• Rational RobotJ

Parameters:

value - Optional:NO The value of the delay after window is activated.

setSecsBeforeMouseDown

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:

• Rational RobotJ

Parameters:

value - Optional:NO The value of the delay before mouse down.

setSecsBeforeMouseUp

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:

• Rational RobotJ

Parameters:

value - Optional:NO The value of the delay before mouse up.

setSecsDelayRetryComponent

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:

• Rational RobotJ

Parameters:

value - Optional:NO The value of the delay of re-finding object.

setSecsSeekComponent

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:

• Rational RobotJ

Parameters:

variableName - Optional:NO The value of the timeout of finding object.

setTestDirectory

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

path - Optional:NO The full or project relative path to the new directory.

setVariableValueEx

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

variableName - Optional:NO The name of the variable

variableValue - Optional:NO The value to assign to the variable

setVariableValueEx

public 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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

variableName -- Optional:NO The name of the variable
variableValue -- Optional:NO The value to assign to the variable

setVariableValues

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

variableName - Optional:NO The name of the variable along with its value assignment

showSoftKeyboard

public static DriverCommand showSoftKeyboard()

 
                 Show the soft keyboard.
              
                 Show the soft keyboard.
                  

Supporting Engines:

• Google Android

startWebBrowser

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium
• OpenQA Selenium

Parameters:

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.

startWebBrowser

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:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner
• OpenQA Selenium
• OpenQA Selenium

Parameters:

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

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.

stopWebBrowser

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:

• OpenQA Selenium

Parameters:

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.

switchWindow

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:

• OpenQA Selenium

Parameters:

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.

switchWindow

public static DriverCommand switchWindow(java.lang.String[] parameters)

Switch between multiple windows according to its title.    

Supporting Engines:

• OpenQA Selenium

Parameters:

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

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.

takeScreenShot

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:

• Google Android
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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.

takeScreenShot

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:

• Google Android
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

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.

useAbbotFunctions

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:

• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:OFF The switch status for enabling the preference of the engine. Valid values are "ON" and "OFF".

useDroidFunctions

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:

• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:OFF The switch status for enabling the use of the Droid hook. Valid values are "ON" and "OFF".

useIOSFunctions

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:

• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:OFF The switch status for enabling the preference of the engine. Valid values are "ON" and "OFF".

useQTPFunctions

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:

• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:OFF The switch status for enabling the preference of the engine. Valid values are "ON" and "OFF".

useRobotJFunctions

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:

• Rational Robot
• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:OFF The switch status for enabling the use of the RobotJ hook. Valid values are "ON" and "OFF".

useSAFSFunctions

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:

• Rational Robot
• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:OFF The switch status for enabling the use of the SAFS hook. Valid values are "ON" and "OFF".

useSeleniumFunctions

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:

• Rational Robot
• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:OFF The switch status for enabling the use of the Selenium hook. Valid values are "ON" and "OFF".

useTestCompleteFunctions

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:

• SAFS TIDDriverCommands

Parameters:

mode - Optional:NO DefaultVal:OFF The switch status for enabling the preference of the engine. Valid values are "ON" and "OFF".

useWebBrowser

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:

• OpenQA Selenium

Parameters:

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.

verifyClipboardToFile

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:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Google Android
• OpenQA Selenium

Parameters:

benchmarkFile - Optional:NO The name of the file used as the comparison benchmark.

encoding - Optional:Yes The encoding used to read a file.

verifyClipboardToFile

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:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Google Android
• OpenQA Selenium

Parameters:

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

benchmarkFile -- Optional:NO The name of the file used as the comparison benchmark.
encoding -- Optional:Yes The encoding used to read a file.

verifyURLContent

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:

• OpenQA Selenium

Parameters:

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.

verifyURLContent

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:

• OpenQA Selenium

Parameters:

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

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.

verifyURLToFile

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:

• OpenQA Selenium

Parameters:

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.

verifyURLToFile

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:

• OpenQA Selenium

Parameters:

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

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.

version

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:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

version - Optional:NO DefaultVal:1.0 The VERSION of the table format. Initially "1.0"

waitForGUI

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:

• Google Android
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium
• OpenQA Selenium
• AutomatedQA TestComplete
• AUTOIT Team Autoit

Parameters:

windowID - Optional:NO A Window reference from the AppMap

componentID - 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.

waitForGUI

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:

• Google Android
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium
• OpenQA Selenium
• AutomatedQA TestComplete
• AUTOIT Team Autoit

Parameters:

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

windowID -- Optional:NO A Window reference from the AppMap
componentID -- 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.

waitForGUIGone

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:

• Google Android
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• AutomatedQA TestComplete
• OpenQA Selenium
• AUTOIT Team Autoit

Parameters:

windowID - Optional:NO A Window reference from the AppMap

componentID - 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.

waitForGUIGone

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:

• Google Android
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• AutomatedQA TestComplete
• OpenQA Selenium
• AUTOIT Team Autoit

Parameters:

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

windowID -- Optional:NO A Window reference from the AppMap
componentID -- 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.

waitForPropertyValue

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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• AutomatedQA TestComplete

Parameters:

windowID - Optional:NO A Window reference from the AppMap

componentID - 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.

waitForPropertyValue

public static DriverCommand waitForPropertyValue(java.lang.String[] parameters)

 
                 Wait for a specific Window or Component property value to match an expected value.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• AutomatedQA TestComplete

Parameters:

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

windowID -- Optional:NO A Window reference from the AppMap
componentID -- 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.

waitForPropertyValueGone

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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• AutomatedQA TestComplete

Parameters:

windowID - Optional:NO A Window reference from the AppMap

componentID - 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.

waitForPropertyValueGone

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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• AutomatedQA TestComplete

Parameters:

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

windowID -- Optional:NO A Window reference from the AppMap
componentID -- 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.

waitForRegistryKeyExists

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:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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.

waitForRegistryKeyExists

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:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

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.

waitForRegistryKeyValue

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:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

key - Optional:NO The Registry Key name to seek

keyValue - 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.

waitForRegistryKeyValue

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:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

key -- Optional:NO The Registry Key name to seek
keyValue -- 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.

waitForWebPage

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:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

windowID - Optional:YES DefaultVal: A Window reference from the AppMap

componentID - 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.

waitForWebPage

public static DriverCommand waitForWebPage(java.lang.String[] parameters)

 
                 Wait for a web document to finish loading within a timeout period.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

windowID -- Optional:YES DefaultVal: A Window reference from the AppMap
componentID -- 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.

deleteCounter

public static DriverCommand deleteCounter(java.lang.String counterID,
                                          java.lang.String description)

 
                 Delete any existing private counter with the provided counterID.
              
                 If counterID identifies an existing counter, then delete it.
                 See ApplicationUtilities for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.

description - Optional:YES Any additional information for deleting this counter.

deleteCounter

public static DriverCommand deleteCounter(java.lang.String[] parameters)

 
                 Delete any existing private counter with the provided counterID.
              
                 If counterID identifies an existing counter, then delete it.
                 See ApplicationUtilities for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

counterID -- Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.
description -- Optional:YES Any additional information for deleting this counter.

logCounterInfo

public static DriverCommand logCounterInfo(java.lang.String counterID,
                                           java.lang.String logName)

 
                 Log the specified counter's info in the active log(s) of the current Log Facility.
              
                 Extracts a snapshot of the specified private counter and outputs a 
                 small, embedded Status Report in the active logs of the current Log Facility.
                 The Status Report will be identified by the name of the private counter.
                 (Future) We will allow you to optionally specify a different Log Facility by name.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.

logName - Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

logCounterInfo

public static DriverCommand logCounterInfo(java.lang.String[] parameters)

 
                 Log the specified counter's info in the active log(s) of the current Log Facility.
              
                 Extracts a snapshot of the specified private counter and outputs a 
                 small, embedded Status Report in the active logs of the current Log Facility.
                 The Status Report will be identified by the name of the private counter.
                 (Future) We will allow you to optionally specify a different Log Facility by name.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

counterID -- Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.
logName -- Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

resetCounter

public static DriverCommand resetCounter(java.lang.String counterID,
                                         java.lang.String description)

 
                 Create a new private counter or reset counts in an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels.
                 If counterID identifies an existing counter, then this routine 
                 will reset all its counts to zero(0).
                 See ApplicationUtilities for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.

description - Optional:YES Any additional information for resetting this counter.

resetCounter

public static DriverCommand resetCounter(java.lang.String[] parameters)

 
                 Create a new private counter or reset counts in an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels.
                 If counterID identifies an existing counter, then this routine 
                 will reset all its counts to zero(0).
                 See ApplicationUtilities for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

counterID -- Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.
description -- Optional:YES Any additional information for resetting this counter.

resumeStatusCounts

public static DriverCommand resumeStatusCounts(java.lang.String description,
                                               java.lang.String logName)

 
                 Resume counting on ALL status counters--both public/global and private.
              
                 Resume all status counting that is triggered via ApplicationUtilities.
                 Only counters that are enabled--not independently "stopped"--will resume
                 counting.  Stopped counters are still stopped.
                 See ApplicationUtilities for more information on counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

description - Optional:YES Any additional information for resuming status counts.

logName - Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

resumeStatusCounts

public static DriverCommand resumeStatusCounts(java.lang.String[] parameters)

 
                 Resume counting on ALL status counters--both public/global and private.
              
                 Resume all status counting that is triggered via ApplicationUtilities.
                 Only counters that are enabled--not independently "stopped"--will resume
                 counting.  Stopped counters are still stopped.
                 See ApplicationUtilities for more information on counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

description -- Optional:YES Any additional information for resuming status counts.
logName -- Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

setCounterMode

public static DriverCommand setCounterMode(java.lang.String counterID,
                                           java.lang.String mode)

 
                 Create a new private counter or modify the mode of an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID and counting mode.
                 If counterID identifies an existing counter, then this routine 
                 will modify the counting mode of the existing counter.
                 See AUSetStatusCounterMode for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.

mode - Optional:NO DefaultVal:AllStatusInfo The counting mode to use for the specified counter.

setCounterMode

public static DriverCommand setCounterMode(java.lang.String[] parameters)

 
                 Create a new private counter or modify the mode of an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID and counting mode.
                 If counterID identifies an existing counter, then this routine 
                 will modify the counting mode of the existing counter.
                 See AUSetStatusCounterMode for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

counterID -- Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.
mode -- Optional:NO DefaultVal:AllStatusInfo The counting mode to use for the specified counter.

startCounter

public static DriverCommand startCounter(java.lang.String counterID,
                                         java.lang.String description)

 
                 Create a new private counter or start an existing stopped private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels.
                 If counterID identifies an existing counter, then this routine 
                 will enable the counter to resume counting--assuming it was stopped.
                 See ApplicationUtilities for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.

description - Optional:YES Any additional information such as the purpose of the counter.

startCounter

public static DriverCommand startCounter(java.lang.String[] parameters)

 
                 Create a new private counter or start an existing stopped private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels.
                 If counterID identifies an existing counter, then this routine 
                 will enable the counter to resume counting--assuming it was stopped.
                 See ApplicationUtilities for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

counterID -- Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.
description -- Optional:YES Any additional information such as the purpose of the counter.

startCycle

public static DriverCommand startCycle(java.lang.String cycleID,
                                       java.lang.String description)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

cycleID - Optional:NO The user-defined ID of the item.

description - Optional:YES A description of the item.

startCycle

public static DriverCommand startCycle(java.lang.String[] parameters)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

cycleID -- Optional:NO The user-defined ID of the item.
description -- Optional:YES A description of the item.

startProcedure

public static DriverCommand startProcedure(java.lang.String procedureID,
                                           java.lang.String description)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

procedureID - Optional:NO The user-defined ID of the item.

description - Optional:YES A description of the item.

startProcedure

public static DriverCommand startProcedure(java.lang.String[] parameters)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

procedureID -- Optional:NO The user-defined ID of the item.
description -- Optional:YES A description of the item.

startRequirement

public static DriverCommand startRequirement(java.lang.String requirementID,
                                             java.lang.String description)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

requirementID - Optional:NO The user-defined ID of the item.

description - Optional:YES A description of the item.

startRequirement

public static DriverCommand startRequirement(java.lang.String[] parameters)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

requirementID -- Optional:NO The user-defined ID of the item.
description -- Optional:YES A description of the item.

startSuite

public static DriverCommand startSuite(java.lang.String suiteID,
                                       java.lang.String description)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

suiteID - Optional:NO The user-defined ID of the item.

description - Optional:YES A description of the item.

startSuite

public static DriverCommand startSuite(java.lang.String[] parameters)

          Begin tracking status on a user-defined item.
          Log/process the beginning of testing associated with this user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

suiteID -- Optional:NO The user-defined ID of the item.
description -- Optional:YES A description of the item.

startTestcase

public static DriverCommand startTestcase(java.lang.String testCaseID,
                                          java.lang.String description)

          Begin tracking status on a user-defined TestCase.
          Log/process the beginning of testing associated with a user-defined Testcase.
          A private counter 
          will keep track of status for the testcase.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

testCaseID - Optional:NO The user-defined ID of the Testcase.

description - Optional:YES A description of the Testcase

startTestcase

public static DriverCommand startTestcase(java.lang.String[] parameters)

          Begin tracking status on a user-defined TestCase.
          Log/process the beginning of testing associated with a user-defined Testcase.
          A private counter 
          will keep track of status for the testcase.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

testCaseID -- Optional:NO The user-defined ID of the Testcase.
description -- Optional:YES A description of the Testcase

stopCounter

public static DriverCommand stopCounter(java.lang.String counterID,
                                        java.lang.String description)

 
                 Create a new private counter or suspend counts in an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels but will be suspended 
                 from actually counting.
                 If counterID identifies an existing counter, then this routine 
                 will suspend counting within this counter.
                 See ApplicationUtilities for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.

description - Optional:YES Any additional information for stopping this counter.

stopCounter

public static DriverCommand stopCounter(java.lang.String[] parameters)

 
                 Create a new private counter or suspend counts in an existing private counter.
              
                 If counterID is not already an active private counter, then 
                 this routine will create a new private counter with the provided 
                 counterID as its name.  The counter will be enabled for counting 
                 of all status information at all test levels but will be suspended 
                 from actually counting.
                 If counterID identifies an existing counter, then this routine 
                 will suspend counting within this counter.
                 See ApplicationUtilities for more information on private counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

counterID -- Optional:NO DefaultVal:Counter1 The unique name used to identify this private counter.
description -- Optional:YES Any additional information for stopping this counter.

stopCycle

public static DriverCommand stopCycle(java.lang.String cycleID,
                                      java.lang.String description)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

cycleID - Optional:NO The user-defined ID of the item.

description - Optional:YES A description of the item.

stopCycle

public static DriverCommand stopCycle(java.lang.String[] parameters)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

cycleID -- Optional:NO The user-defined ID of the item.
description -- Optional:YES A description of the item.

stopProcedure

public static DriverCommand stopProcedure(java.lang.String procedureID,
                                          java.lang.String description)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

procedureID - Optional:NO The user-defined ID of the item.

description - Optional:YES A description of the item.

stopProcedure

public static DriverCommand stopProcedure(java.lang.String[] parameters)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

procedureID -- Optional:NO The user-defined ID of the item.
description -- Optional:YES A description of the item.

stopRequirement

public static DriverCommand stopRequirement(java.lang.String requirementID,
                                            java.lang.String description)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

requirementID - Optional:NO The user-defined ID of the item.

description - Optional:YES A description of the item.

stopRequirement

public static DriverCommand stopRequirement(java.lang.String[] parameters)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

requirementID -- Optional:NO The user-defined ID of the item.
description -- Optional:YES A description of the item.

stopSuite

public static DriverCommand stopSuite(java.lang.String suiteID,
                                      java.lang.String description)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

suiteID - Optional:NO The user-defined ID of the item.

description - Optional:YES A description of the item.

stopSuite

public static DriverCommand stopSuite(java.lang.String[] parameters)

          Stop tracking status on a user-defined item.
          Log/process the end of testing associated with a user-defined item.
          A private counter 
          will keep track of status for the item.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

suiteID -- Optional:NO The user-defined ID of the item.
description -- Optional:YES A description of the item.

stopTestcase

public static DriverCommand stopTestcase(java.lang.String testCaseID,
                                         java.lang.String description)

          Stop tracking status on a user-defined TestCase.
          Log/process the end of testing associated with a user-defined Testcase.
          A private counter 
          will keep track of status for the testcase.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

testCaseID - Optional:NO The user-defined ID of the Testcase.

description - Optional:YES A description of the Testcase

stopTestcase

public static DriverCommand stopTestcase(java.lang.String[] parameters)

          Stop tracking status on a user-defined TestCase.
          Log/process the end of testing associated with a user-defined Testcase.
          A private counter 
          will keep track of status for the testcase.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

testCaseID -- Optional:NO The user-defined ID of the Testcase.
description -- Optional:YES A description of the Testcase

storeCounterInfo

public static DriverCommand storeCounterInfo(java.lang.String counterID,
                                             java.lang.String varPrefix)

 
                 Store the current values of the named counter into unique DDVariables.
              
                 This enables the framework, scripts, and other applications to retrieve 
                 the values of these counters at runtime.
                 Consult ApplicationUtilities 
                 and Using DDVariables 
                 for more information on referencing these DDVariables in your tests.
                 You must adhere to DDVariable naming conventions when providing this 
                 DDVariable basename.  Note that no spaces are allowed in DDVariable names.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

counterID - Optional:NO DefaultVal:Counter1 The unique name used to identify the private counter.

varPrefix - Optional:NO DefaultVal:Counter1 The unique DDVariable prefix to use for storing counter values.

storeCounterInfo

public static DriverCommand storeCounterInfo(java.lang.String[] parameters)

 
                 Store the current values of the named counter into unique DDVariables.
              
                 This enables the framework, scripts, and other applications to retrieve 
                 the values of these counters at runtime.
                 Consult ApplicationUtilities 
                 and Using DDVariables 
                 for more information on referencing these DDVariables in your tests.
                 You must adhere to DDVariable naming conventions when providing this 
                 DDVariable basename.  Note that no spaces are allowed in DDVariable names.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

counterID -- Optional:NO DefaultVal:Counter1 The unique name used to identify the private counter.
varPrefix -- Optional:NO DefaultVal:Counter1 The unique DDVariable prefix to use for storing counter values.

suspendStatusCounts

public static DriverCommand suspendStatusCounts(java.lang.String description,
                                                java.lang.String logName)

 
                 Suspend counting on ALL status counters--both public/global and private.
              
                 Suspends all status counting that is triggered via ApplicationUtilities.
                 See ApplicationUtilities for more information on counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

description - Optional:YES Any additional information for suspending status counts.

logName - Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

suspendStatusCounts

public static DriverCommand suspendStatusCounts(java.lang.String[] parameters)

 
                 Suspend counting on ALL status counters--both public/global and private.
              
                 Suspends all status counting that is triggered via ApplicationUtilities.
                 See ApplicationUtilities for more information on counters.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium

Parameters:

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

description -- Optional:YES Any additional information for suspending status counts.
logName -- Optional:YES DefaultVal:MainLog (Future) The name of a Log Facility other than the "current" one.

copyDBTableColumnToFile

public static DriverCommand copyDBTableColumnToFile(java.lang.String aDBAlias,
                                                    java.lang.String aTableAlias,
                                                    java.lang.String dBSourceName,
                                                    java.lang.String fileOut,
                                                    java.lang.String sQLQuery,
                                                    java.lang.String directoryOut,
                                                    java.lang.String sQLStatus,
                                                    java.lang.String delimiter,
                                                    java.lang.String userID,
                                                    java.lang.String password)

 
              This routine will copy the contents of one or more DBTable column(s) to a file.
              
                 This routine will export the contents of one or more DBTable column(s) to
                 a delimeted file. If columnDelimiter is omitted, a horizontal tab is used
                 to delimit fields.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

fileOut - Optional:NO Name of the output file.

sQLQuery - Optional:NO The file will contain the results of the executed Query. The query is NOT validated by this function.

directoryOut - Optional:YES OPTIONAL parameter. If not specified the file will be stored in the default test directory

sQLStatus - Optional:YES A variable which holds the current SQL run status.

delimiter - Optional:YES Optional Delimiter to be used between columns written to file.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

copyDBTableColumnToFile

public static DriverCommand copyDBTableColumnToFile(java.lang.String[] parameters)

 
              This routine will copy the contents of one or more DBTable column(s) to a file.
              
                 This routine will export the contents of one or more DBTable column(s) to
                 a delimeted file. If columnDelimiter is omitted, a horizontal tab is used
                 to delimit fields.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
fileOut -- Optional:NO Name of the output file.
sQLQuery -- Optional:NO The file will contain the results of the executed Query. The query is NOT validated by this function.
directoryOut -- Optional:YES OPTIONAL parameter. If not specified the file will be stored in the default test directory
sQLStatus -- Optional:YES A variable which holds the current SQL run status.
delimiter -- Optional:YES Optional Delimiter to be used between columns written to file.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

copyDBTableToFile

public static DriverCommand copyDBTableToFile(java.lang.String aDBAlias,
                                              java.lang.String aTableAlias,
                                              java.lang.String dBSourceName,
                                              java.lang.String fileOut,
                                              java.lang.String dBTableName,
                                              java.lang.String columnCount,
                                              java.lang.String rowCount,
                                              java.lang.String sQLQuery,
                                              java.lang.String delimiter,
                                              java.lang.String directoryOut,
                                              java.lang.String sQLStatus,
                                              java.lang.String userID,
                                              java.lang.String password)

 
              This routine will copy the contents of a DBTable  to a file.
              
                 This routine will export the contents of a DBTable  to a delimeted file.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

fileOut - Optional:NO Name of the output file.

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

columnCount - Optional:YES If specified the output file will contain only the number of columns specified.

rowCount - Optional:YES If specified the output file will contain only the number of rows specified.

sQLQuery - Optional:YES OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function. If this is provided, the the DBTableName must be ""

delimiter - Optional:YES OPTIONAL parameter. If not specified the default ',' seperator will be used.

directoryOut - Optional:YES OPTIONAL parameter. If not specified the file will be stored in the default test directory

sQLStatus - Optional:YES A variable which holds the current SQL run status.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

copyDBTableToFile

public static DriverCommand copyDBTableToFile(java.lang.String[] parameters)

 
              This routine will copy the contents of a DBTable  to a file.
              
                 This routine will export the contents of a DBTable  to a delimeted file.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
fileOut -- Optional:NO Name of the output file.
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
columnCount -- Optional:YES If specified the output file will contain only the number of columns specified.
rowCount -- Optional:YES If specified the output file will contain only the number of rows specified.
sQLQuery -- Optional:YES OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function. If this is provided, the the DBTableName must be ""
delimiter -- Optional:YES OPTIONAL parameter. If not specified the default ',' seperator will be used.
directoryOut -- Optional:YES OPTIONAL parameter. If not specified the file will be stored in the default test directory
sQLStatus -- Optional:YES A variable which holds the current SQL run status.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

deleteDBTableRecords

public static DriverCommand deleteDBTableRecords(java.lang.String aDBAlias,
                                                 java.lang.String aTableAlias,
                                                 java.lang.String dBTableName,
                                                 java.lang.String dBQueryCond,
                                                 java.lang.String dBSourceName,
                                                 java.lang.String userID,
                                                 java.lang.String password,
                                                 java.lang.String sQLStatus)

 
                 Deletes records in a database table
              
                 Deletes records in a database table.
                 
                 A table name is required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

deleteDBTableRecords

public static DriverCommand deleteDBTableRecords(java.lang.String[] parameters)

 
                 Deletes records in a database table
              
                 Deletes records in a database table.
                 
                 A table name is required. You also have to specify data source name,
                 and optionally user id and password (this is because some drivers
                 don't need a user/password).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

execSQLQuery

public static DriverCommand execSQLQuery(java.lang.String aDBAlias,
                                         java.lang.String aTableAlias,
                                         java.lang.String dBSourceName,
                                         java.lang.String queryStr,
                                         java.lang.String sQLStatusCode,
                                         java.lang.String userID,
                                         java.lang.String password)

 
                 Executes the query provided in a queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 Use this command with caution.  It doesn't return any value back other than the
                 SQL Status code.  So, remember not to use 'SELECT' command inside the queryStr.
                 It should rather be used to do an 'UPDATE', 'INSERT' or 'DELETE'.
                  
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

queryStr - Optional:NO Actual query stored in a queryStr.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

execSQLQuery

public static DriverCommand execSQLQuery(java.lang.String[] parameters)

 
                 Executes the query provided in a queryStr on the database table.
              
                 Executes the query in a database table.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                 Use this command with caution.  It doesn't return any value back other than the
                 SQL Status code.  So, remember not to use 'SELECT' command inside the queryStr.
                 It should rather be used to do an 'UPDATE', 'INSERT' or 'DELETE'.
                  
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
queryStr -- Optional:NO Actual query stored in a queryStr.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

getDBTableColumnCount

public static DriverCommand getDBTableColumnCount(java.lang.String aDBAlias,
                                                  java.lang.String aTableAlias,
                                                  java.lang.String dBSourceName,
                                                  java.lang.String dBTableName,
                                                  java.lang.String columnCount,
                                                  java.lang.String sQLStatusCode,
                                                  java.lang.String userID,
                                                  java.lang.String password)

 
                 Executes the query in a specified database table and returns the total column count.
              
                 Executes the query in a specified database table and returns the total column count.
                 
                 A data source name  and Table name are required. You also have to specify a 
                 variable to get the result of the SQL and status code.  And optionally user id 
                 and password (this is because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

columnCount - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

getDBTableColumnCount

public static DriverCommand getDBTableColumnCount(java.lang.String[] parameters)

 
                 Executes the query in a specified database table and returns the total column count.
              
                 Executes the query in a specified database table and returns the total column count.
                 
                 A data source name  and Table name are required. You also have to specify a 
                 variable to get the result of the SQL and status code.  And optionally user id 
                 and password (this is because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
columnCount -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

getDBTableRowCount

public static DriverCommand getDBTableRowCount(java.lang.String aDBAlias,
                                               java.lang.String aTableAlias,
                                               java.lang.String dBSourceName,
                                               java.lang.String dBTableName,
                                               java.lang.String rowCount,
                                               java.lang.String sQLStatusCode,
                                               java.lang.String userID,
                                               java.lang.String password)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

rowCount - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

getDBTableRowCount

public static DriverCommand getDBTableRowCount(java.lang.String[] parameters)

 
                 Executes the query in a database table.
              
                 Executes the query in a database table.
                 
                 A data source name  and Query String is required. You also have to specify
                 a variable to get the status code.  And optionally user id and password (this is
                 because some drivers don't need a user/password).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
rowCount -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

getDBValue

public static DriverCommand getDBValue(java.lang.String aDBAlias,
                                       java.lang.String aTableAlias,
                                       java.lang.String dBSourceName,
                                       java.lang.String queryStr,
                                       java.lang.String queryResult,
                                       java.lang.String sQLStatusCode,
                                       java.lang.String userID,
                                       java.lang.String password)

 
                 Executes the query and returns the case-sensitive value as result of the execution.
              
                 Executes the query specified in the queryStr and returns the case-sensitive value
                 as result of the execution.
                 
                 To return the value, it executes a SQL query sentence using a data source to 
                 connect to the data base (using a 'SELECT').
                 
                 A queryStr and the two return variables to store the query result and SQL Status code
                 are required.  You also have to specify data source name and optionally user id and
                 password (this is because some drivers don't need a user/password).
                 
                 If the query returns more than one record, the returned value is the corresponding to the
                 first one, unless the field name be something like COUNT(*) or SUM(InvoiceTot).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

queryStr - Optional:NO Actual query stored in a queryStr.

queryResult - Optional:NO SQL result get stored in this return variable.

sQLStatusCode - Optional:NO SQL status code as a result of executing the query.

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

getDBValue

public static DriverCommand getDBValue(java.lang.String[] parameters)

 
                 Executes the query and returns the case-sensitive value as result of the execution.
              
                 Executes the query specified in the queryStr and returns the case-sensitive value
                 as result of the execution.
                 
                 To return the value, it executes a SQL query sentence using a data source to 
                 connect to the data base (using a 'SELECT').
                 
                 A queryStr and the two return variables to store the query result and SQL Status code
                 are required.  You also have to specify data source name and optionally user id and
                 password (this is because some drivers don't need a user/password).
                 
                 If the query returns more than one record, the returned value is the corresponding to the
                 first one, unless the field name be something like COUNT(*) or SUM(InvoiceTot).
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
queryStr -- Optional:NO Actual query stored in a queryStr.
queryResult -- Optional:NO SQL result get stored in this return variable.
sQLStatusCode -- Optional:NO SQL status code as a result of executing the query.
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).

setJdbcDriver

public static DriverCommand setJdbcDriver(java.lang.String driverClassName)

 
                 set Jdbc Driver
              
                 sets a JDBC driver, can be called more than once with
                 multiple drivers.
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

driverClassName - Optional:NO Name of the driver class

verifyDatabaseNullValue

public static DriverCommand verifyDatabaseNullValue(java.lang.String aDBAlias,
                                                    java.lang.String aTableAlias,
                                                    java.lang.String dBFieldName,
                                                    java.lang.String dBTableName,
                                                    java.lang.String dBQueryCond,
                                                    java.lang.String dBSourceName,
                                                    java.lang.String userID,
                                                    java.lang.String password,
                                                    java.lang.String sQLStatus)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 user id and password (the user id and password can be "" meaning not required).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDatabaseNullValue

public static DriverCommand verifyDatabaseNullValue(java.lang.String[] parameters)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 user id and password (the user id and password can be "" meaning not required).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDatabaseValue

public static DriverCommand verifyDatabaseValue(java.lang.String aDBAlias,
                                                java.lang.String aTableAlias,
                                                java.lang.String dBFieldName,
                                                java.lang.String dBTableName,
                                                java.lang.String dBQueryCond,
                                                java.lang.String dBSourceName,
                                                java.lang.String userID,
                                                java.lang.String password,
                                                java.lang.String expectedValue,
                                                java.lang.String sQLStatus)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using a
                 data source to connect to the data base (using a 'SELECT'). 
                 
                 A table and field name are required. You also have to specify data source name,
                 user id, password, and the expected value.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:NO UserID for accessing the Datasource (if required, if not then "" must be supplied).

password - Optional:NO Password for accessing the Datasource (if required, if not then "" must be supplied).

expectedValue - Optional:NO Benchmark value to compare against retrieved DBFieldName value

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDatabaseValue

public static DriverCommand verifyDatabaseValue(java.lang.String[] parameters)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using a
                 data source to connect to the data base (using a 'SELECT'). 
                 
                 A table and field name are required. You also have to specify data source name,
                 user id, password, and the expected value.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:NO UserID for accessing the Datasource (if required, if not then "" must be supplied).
password -- Optional:NO Password for accessing the Datasource (if required, if not then "" must be supplied).
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDBNullValue

public static DriverCommand verifyDBNullValue(java.lang.String aDBAlias,
                                              java.lang.String aTableAlias,
                                              java.lang.String dBFieldName,
                                              java.lang.String dBTableName,
                                              java.lang.String dBQueryCond,
                                              java.lang.String dBSourceName,
                                              java.lang.String userID,
                                              java.lang.String password,
                                              java.lang.String sQLStatus)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 user id and password (the user id and password can be "" meaning not required).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:YES UserID for accessing the Datasource (if required).

password - Optional:YES Password for accessing the Datasource (if required).

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDBNullValue

public static DriverCommand verifyDBNullValue(java.lang.String[] parameters)

 
                 Verifies the value of a field in a database table is NULL
              
                 Verifies the value of a field in a database table is NULL.
                 
                 Sometimes you have to check if a field's value is NULL. This
                 NULL value is different from any other (even zero for numerics
                 and null string for characters), so if you try to check it
                 using VerifyDBValue() function, if will fail.
                 
                 A table and field name are required. You also have to specify data source name,
                 user id and password (the user id and password can be "" meaning not required).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:YES UserID for accessing the Datasource (if required).
password -- Optional:YES Password for accessing the Datasource (if required).
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDBValue

public static DriverCommand verifyDBValue(java.lang.String aDBAlias,
                                          java.lang.String aTableAlias,
                                          java.lang.String dBFieldName,
                                          java.lang.String dBTableName,
                                          java.lang.String dBQueryCond,
                                          java.lang.String dBSourceName,
                                          java.lang.String userID,
                                          java.lang.String password,
                                          java.lang.String expectedValue,
                                          java.lang.String sQLStatus)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using a
                 data source to connect to the data base (using a 'SELECT').
                 
                 A table and field name are required. You also have to specify data source name,
                 user id, password, and the expected value.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

aDBAlias - Optional:NO not used

aTableAlias - Optional:NO not used

dBFieldName - Optional:NO Name of the FIELD within DBTableName used in the verification

dBTableName - Optional:NO Name of the TABLE to access within the DBSourceName

dBQueryCond - Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver

dBSourceName - Optional:NO Name of the Datasource containing the DBTable

userID - Optional:NO UserID for accessing the Datasource (if required, if not then "" must be supplied).

password - Optional:NO Password for accessing the Datasource (if required, if not then "" must be supplied).

expectedValue - Optional:NO Benchmark value to compare against retrieved DBFieldName value

sQLStatus - Optional:YES SQL status code as a result of executing the query gets stored in this variable

verifyDBValue

public static DriverCommand verifyDBValue(java.lang.String[] parameters)

 
                 Verifies the case-sensitive value of a field in a database table
              
                 Verifies the case-sensitive value of a field in a database table.
                 
                 To return the value, it executes a SQL query sentence using a
                 data source to connect to the data base (using a 'SELECT').
                 
                 A table and field name are required. You also have to specify data source name,
                 user id, password, and the expected value.
                 
                 If the query returns more than one record, the returned value
                 is the corresponding to the first one, unless the field name
                 be something like COUNT(*) or SUM(InvoiceTot).
                 
                 A query condition can be included. It can be any 
                 valid expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
                 you are using. For example: "CliBal > 100000 and CliCat = 'C'". 
                 Including "where" in the expression itself is optional.  It will 
                 be prefixed to the expression if it is not provided.
                 
                  

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

aDBAlias -- Optional:NO not used
aTableAlias -- Optional:NO not used
dBFieldName -- Optional:NO Name of the FIELD within DBTableName used in the verification
dBTableName -- Optional:NO Name of the TABLE to access within the DBSourceName
dBQueryCond -- Optional:NO Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
dBSourceName -- Optional:NO Name of the Datasource containing the DBTable
userID -- Optional:NO UserID for accessing the Datasource (if required, if not then "" must be supplied).
password -- Optional:NO Password for accessing the Datasource (if required, if not then "" must be supplied).
expectedValue -- Optional:NO Benchmark value to compare against retrieved DBFieldName value
sQLStatus -- Optional:YES SQL status code as a result of executing the query gets stored in this variable

breakpoints

public static DriverCommand breakpoints(java.lang.String mode)

 
                 Enable and Disable Breakpoint Debugging.
              
                 Enable and Disable Breakpoint Debugging.  This means that 
                 debugging will stop at each record following a 
                 (BP) Breakpoint record.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner

Parameters:

mode - Optional:NO DefaultVal:OFF The status for this debug mode.

commandDebug

public static DriverCommand commandDebug(java.lang.String mode)

 
                 Enable and Disable (C)Command Debugging.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner

Parameters:

mode - Optional:NO DefaultVal:OFF The status for this debug mode.

recordsDebug

public static DriverCommand recordsDebug(java.lang.String mode)

 
                 Enable and Disable debugging of ALL record types.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner

Parameters:

mode - Optional:NO DefaultVal:OFF The status for this debug mode.

testDebug

public static DriverCommand testDebug(java.lang.String mode)

 
                 Enable and Disable (T)Test Record Debugging.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Mercury Interactive WinRunner

Parameters:

mode - Optional:NO DefaultVal:OFF The status for this debug mode.

closeFile

public static DriverCommand closeFile(java.lang.String fileNumber)

          Close the open file with the file number provided
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileNumber - Optional:NO The file number for the file to be closed.

copyFile

public static DriverCommand copyFile(java.lang.String fromFileName,
                                     java.lang.String toFileName)

          Copy the specified filename to the target filename.          
        
           For the Java-based engines--RJ, TID, and SDC:
           
           If the filenames provided are not full absolute paths then we will attempt to deduce a full Project-relative or Datapool\Test-relative path from the relative path provided. If the relative path already contains path separators (ex: "\subpath\filename.ext") then we attempt to deduce a fullpath relative to the SAFS Project.  If no path separators exist (ex: "filename.txt") then we attempt to deduce a fullpath relative to the project's Datapool\Test directory.  We do not actually attempt to see if the directories or files exists before executing the command.
           
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fromFileName - Optional:NO The file path and file name for the file to be copied.

toFileName - Optional:NO The file path and file name to copy the file to.

copyFile

public static DriverCommand copyFile(java.lang.String[] parameters)

          Copy the specified filename to the target filename.          
        
           For the Java-based engines--RJ, TID, and SDC:
           
           If the filenames provided are not full absolute paths then we will attempt to deduce a full Project-relative or Datapool\Test-relative path from the relative path provided. If the relative path already contains path separators (ex: "\subpath\filename.ext") then we attempt to deduce a fullpath relative to the SAFS Project.  If no path separators exist (ex: "filename.txt") then we attempt to deduce a fullpath relative to the project's Datapool\Test directory.  We do not actually attempt to see if the directories or files exists before executing the command.
           
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fromFileName -- Optional:NO The file path and file name for the file to be copied.
toFileName -- Optional:NO The file path and file name to copy the file to.

copyMatchingFiles

public static DriverCommand copyMatchingFiles(java.lang.String fromDirectoryName,
                                              java.lang.String toDirectoryName,
                                              java.lang.String pattern,
                                              java.lang.String filterMode)

                        Copy multiple files/sub-directories, based on matching the provided pattern, from one directory to another.
                
                        Note: This is a very powerful DriverCommand, please use with caution!
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fromDirectoryName - Optional:NO The directory name where the files are located.

toDirectoryName - Optional:NO The directory name where the files are copied.

pattern - Optional:NO The pattern used to distinguish the files/sub-directories to be copied.

filterMode - Optional:YES The filter mode used for matching the files/sub-directories to be copied. Default is WILDCARD.

copyMatchingFiles

public static DriverCommand copyMatchingFiles(java.lang.String[] parameters)

                        Copy multiple files/sub-directories, based on matching the provided pattern, from one directory to another.
                
                        Note: This is a very powerful DriverCommand, please use with caution!
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fromDirectoryName -- Optional:NO The directory name where the files are located.
toDirectoryName -- Optional:NO The directory name where the files are copied.
pattern -- Optional:NO The pattern used to distinguish the files/sub-directories to be copied.
filterMode -- Optional:YES The filter mode used for matching the files/sub-directories to be copied. Default is WILDCARD.

createDirectory

public static DriverCommand createDirectory(java.lang.String directoryName)

          Create the directory for the provided directory pathname
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

directoryName - Optional:NO The full directory path name for the directory to be created.

createFile

public static DriverCommand createFile(java.lang.String fileName,
                                       java.lang.String mode,
                                       java.lang.String access,
                                       java.lang.String fileNumberVariable,
                                       java.lang.String fileNumber)

          Open a new file with the filename, mode and access provided.
          TID Note: Three ways to create a file:
                        
                                Mode=Input, Access=Read
                                Mode=Output, Access=Write
                                Mode=Append, Access=Write
                                
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The full path file name of the file to be opened.

mode - Optional:NO Mode to be used to create and open the file, Input, Output or Append. Random and Binary not supported

access - Optional:NO Access to be used to create and open the file. Read, Write or Read Write.

fileNumberVariable - Optional:NO DDE Variable name of the variable to store the file number.

fileNumber - Optional:Yes Optional File number to be used to open the file Otherwise next available file number is used

createFile

public static DriverCommand createFile(java.lang.String[] parameters)

          Open a new file with the filename, mode and access provided.
          TID Note: Three ways to create a file:
                        
                                Mode=Input, Access=Read
                                Mode=Output, Access=Write
                                Mode=Append, Access=Write
                                
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The full path file name of the file to be opened.
mode -- Optional:NO Mode to be used to create and open the file, Input, Output or Append. Random and Binary not supported
access -- Optional:NO Access to be used to create and open the file. Read, Write or Read Write.
fileNumberVariable -- Optional:NO DDE Variable name of the variable to store the file number.
fileNumber -- Optional:Yes Optional File number to be used to open the file Otherwise next available file number is used

deleteDirectory

public static DriverCommand deleteDirectory(java.lang.String directoryName)

          Delete the directory for the provided directory pathname
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

directoryName - Optional:NO The full directory path name for the directory to be deleted.

deleteDirectoryContents

public static DriverCommand deleteDirectoryContents(java.lang.String directoryName,
                                                    java.lang.String deleteDir)

                        Delete the contents (files and sub-directories) of a provided directory and optionally, 
                        the directory itself.
                
                        Note: This is a very powerful DriverCommand, please use with caution!
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

directoryName - Optional:NO The directory name in which the contents will be deleted.

deleteDir - Optional:YES Indicate whether you want to also delete the directory with true or false. Default is false.

deleteDirectoryContents

public static DriverCommand deleteDirectoryContents(java.lang.String[] parameters)

                        Delete the contents (files and sub-directories) of a provided directory and optionally, 
                        the directory itself.
                
                        Note: This is a very powerful DriverCommand, please use with caution!
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

directoryName -- Optional:NO The directory name in which the contents will be deleted.
deleteDir -- Optional:YES Indicate whether you want to also delete the directory with true or false. Default is false.

deleteFile

public static DriverCommand deleteFile(java.lang.String fileName,
                                       java.lang.String noVerify)

          Delete the file for the file name provided
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The file name for the file to be deleted. Normally, the full file path is specified. If a relative path is specified, it is relative to the project directory.

noVerify - Optional:Yes String Equal to "NOVERIFY" if file is not verified prior to deleting.

deleteFile

public static DriverCommand deleteFile(java.lang.String[] parameters)

          Delete the file for the file name provided
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The file name for the file to be deleted. Normally, the full file path is specified. If a relative path is specified, it is relative to the project directory.
noVerify -- Optional:Yes String Equal to "NOVERIFY" if file is not verified prior to deleting.

filterImage

public static DriverCommand filterImage(java.lang.String inputFilename,
                                        java.lang.String outputFilename,
                                        java.lang.String filterMode,
                                        java.lang.String coords)

                Filter out specific parts of an image.
            
                Filter out specific parts of an image and save to a new or existing image file.
                The filtered portions of the image are blacked out so as to remove dynamic visible
                content from the image.
                The available formats for the input and output files are BITMAP (*.bmp) and JPEG
                (*.jpg).
                
                Specific Notes:
                        This command requires that Java Advanced Imaging (JAI) be installed
                        on the test machine.
                
                

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

inputFilename - Optional:NO The input image file (FULL PATH)

outputFilename - Optional:NO The output image file after filtering (FULL PATH)

filterMode - Optional:NO Mode by which the image is filtered

coords - Optional:NO Required parameter for the COORD FilterMode that defines the rectangle(s) of the input image that are to be filtered out.

filterImage

public static DriverCommand filterImage(java.lang.String[] parameters)

                Filter out specific parts of an image.
            
                Filter out specific parts of an image and save to a new or existing image file.
                The filtered portions of the image are blacked out so as to remove dynamic visible
                content from the image.
                The available formats for the input and output files are BITMAP (*.bmp) and JPEG
                (*.jpg).
                
                Specific Notes:
                        This command requires that Java Advanced Imaging (JAI) be installed
                        on the test machine.
                
                

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

inputFilename -- Optional:NO The input image file (FULL PATH)
outputFilename -- Optional:NO The output image file after filtering (FULL PATH)
filterMode -- Optional:NO Mode by which the image is filtered
coords -- Optional:NO Required parameter for the COORD FilterMode that defines the rectangle(s) of the input image that are to be filtered out.

filterTextFile

public static DriverCommand filterTextFile(java.lang.String file,
                                           java.lang.String filterMode,
                                           java.lang.String filterOptions,
                                           java.lang.String encoding)

 
                 Filter a text file based on the given parameters.
              
                 Filter a text file based on the given parameters.
                 
                 This command can be used to process a text file based on the
                 provided parameters, such as replacing text in a file that
                 matches a specific pattern. This command is experimental.
                 command name/parameters are subject to change without notice.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

file - Optional:NO The file to be filtered.

filterMode - Optional:NO The filter mode.

filterOptions - Optional:YES Additional filter options.

encoding - Optional:YES The encoding to use to read and write file.

filterTextFile

public static DriverCommand filterTextFile(java.lang.String[] parameters)

 
                 Filter a text file based on the given parameters.
              
                 Filter a text file based on the given parameters.
                 
                 This command can be used to process a text file based on the
                 provided parameters, such as replacing text in a file that
                 matches a specific pattern. This command is experimental.
                 command name/parameters are subject to change without notice.
                  

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

file -- Optional:NO The file to be filtered.
filterMode -- Optional:NO The filter mode.
filterOptions -- Optional:YES Additional filter options.
encoding -- Optional:YES The encoding to use to read and write file.

findSqaFile

public static DriverCommand findSqaFile(java.lang.String fileName,
                                        java.lang.String filePathVariable)

          Find the file for the SQA relative path and file name provided.  If a                 full file path is provided the file will be located using the full                 file path and name.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

fileName - Optional:NO The file path and file name of the file to be found.

filePathVariable - Optional:NO Name of the DDV variable to be used to store the full file path of the found file. If file not found blank string is assigned to variable

findSqaFile

public static DriverCommand findSqaFile(java.lang.String[] parameters)

          Find the file for the SQA relative path and file name provided.  If a                 full file path is provided the file will be located using the full                 file path and name.
            

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

fileName -- Optional:NO The file path and file name of the file to be found.
filePathVariable -- Optional:NO Name of the DDV variable to be used to store the full file path of the found file. If file not found blank string is assigned to variable

getFileDateTime

public static DriverCommand getFileDateTime(java.lang.String fileName,
                                            java.lang.String fileDateVariable,
                                            java.lang.String getMilitaryTime,
                                            java.lang.String dateTimeType)

          Determine the date and time the file created/last changed/last accessed for file name provided and assign it to a DDV variable.
        
                Determine the date and time the file created/last changed/last accessed 
                for file name provided and assign it to a DDV variable.
                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 third 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)
                You can get different date and time by providing a different value to the fourth
                optional parameter DateTimeType.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The file path and file name of the file to get the file date and time.

fileDateVariable - Optional:NO Name of the DDV variable to be used to store the file date and time

getMilitaryTime - Optional:YES If true, the converted time is in 24-hours military time format

dateTimeType - Optional:YES You can get different date and time by providing a different value.

getFileDateTime

public static DriverCommand getFileDateTime(java.lang.String[] parameters)

          Determine the date and time the file created/last changed/last accessed for file name provided and assign it to a DDV variable.
        
                Determine the date and time the file created/last changed/last accessed 
                for file name provided and assign it to a DDV variable.
                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 third 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)
                You can get different date and time by providing a different value to the fourth
                optional parameter DateTimeType.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The file path and file name of the file to get the file date and time.
fileDateVariable -- Optional:NO Name of the DDV variable to be used to store the file date and time
getMilitaryTime -- Optional:YES If true, the converted time is in 24-hours military time format
dateTimeType -- Optional:YES You can get different date and time by providing a different value.

getFileProtections

public static DriverCommand getFileProtections(java.lang.String fileName,
                                               java.lang.String varName)

          Save the file attributes for the file name to the variable provided.
        
          Save the file attributes for the file name to the variable provided. 
          The variable will be an integer containing the attributes for the file, it may be any combination of them.
          Here is a description of attributes:
          0  - Normal file
          1  - Read Only file
          2  - Hidden file
          4  - System file (Windows OS Only)
          16 - Directory
          32 - Archive file (Windows OS: attrib with 'A'; Other OS: file suffix is .jar, .tar, .rar, .gz etc.)
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The file path and file name of the file to get the file attribute.

varName - Optional:NO variable name to place the attributes in

getFileProtections

public static DriverCommand getFileProtections(java.lang.String[] parameters)

          Save the file attributes for the file name to the variable provided.
        
          Save the file attributes for the file name to the variable provided. 
          The variable will be an integer containing the attributes for the file, it may be any combination of them.
          Here is a description of attributes:
          0  - Normal file
          1  - Read Only file
          2  - Hidden file
          4  - System file (Windows OS Only)
          16 - Directory
          32 - Archive file (Windows OS: attrib with 'A'; Other OS: file suffix is .jar, .tar, .rar, .gz etc.)
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The file path and file name of the file to get the file attribute.
varName -- Optional:NO variable name to place the attributes in

getFiles

public static DriverCommand getFiles(java.lang.String directory,
                                     java.lang.String fileName,
                                     java.lang.String fileAttributes)

          Search the directory provided for files according to possible attribute and write the list of filenames found into the output file.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

directory - Optional:NO The full name of the directory to be searched for files.

fileName - Optional:NO Full file path and name of the file to store list of files found in the directory

fileAttributes - Optional:YES Optional File Attributes parameter specifying file attributes to select with Dir directory search command. Default if unspecified is normal files. It may be any combination of them.

getFiles

public static DriverCommand getFiles(java.lang.String[] parameters)

          Search the directory provided for files according to possible attribute and write the list of filenames found into the output file.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

directory -- Optional:NO The full name of the directory to be searched for files.
fileName -- Optional:NO Full file path and name of the file to store list of files found in the directory
fileAttributes -- Optional:YES Optional File Attributes parameter specifying file attributes to select with Dir directory search command. Default if unspecified is normal files. It may be any combination of them.

getFileSize

public static DriverCommand getFileSize(java.lang.String fileName,
                                        java.lang.String fileSizeVariable)

          Determine the file size for file name provided and assign it to a DDV variable.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The file path and file name of the file to get file size.

fileSizeVariable - Optional:NO Name of the DDV variable to be used to store the file size of the file.

getFileSize

public static DriverCommand getFileSize(java.lang.String[] parameters)

          Determine the file size for file name provided and assign it to a DDV variable.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The file path and file name of the file to get file size.
fileSizeVariable -- Optional:NO Name of the DDV variable to be used to store the file size of the file.

getINIFileValue

public static DriverCommand getINIFileValue(java.lang.String fileName,
                                            java.lang.String section,
                                            java.lang.String item,
                                            java.lang.String variable)

          Get value from INI file.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The name of the file.

section - Optional:NO The Section of the file to look in.

item - Optional:NO The item to look for.

variable - Optional:NO Name of the DDV variable to be used to store the file date and time

getINIFileValue

public static DriverCommand getINIFileValue(java.lang.String[] parameters)

          Get value from INI file.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The name of the file.
section -- Optional:NO The Section of the file to look in.
item -- Optional:NO The item to look for.
variable -- Optional:NO Name of the DDV variable to be used to store the file date and time

getStringCountInFile

public static DriverCommand getStringCountInFile(java.lang.String file,
                                                 java.lang.String string,
                                                 java.lang.String varName,
                                                 java.lang.String caseSensitive,
                                                 java.lang.String encoding)

 
                  Count the number of occurrences of a target string in a File.
                
                  This command opens and reads a file line by line, then sets a specified DDVariable to the number of times the target string is found in the file. 
                  String comparisons are case-sensitive by default. The file is assumed to be in the system default encoding unless specified otherwise.
                   

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

file - Optional:NO The File to be searched.

string - Optional:NO The string to match and count in the file.

varName - Optional:YES DefaultVal:GetStringCountInFile The name of the variable to receive the count.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive.

encoding - Optional:YES Charset encoding string like "UTF-8", etc...

getStringCountInFile

public static DriverCommand getStringCountInFile(java.lang.String[] parameters)

 
                  Count the number of occurrences of a target string in a File.
                
                  This command opens and reads a file line by line, then sets a specified DDVariable to the number of times the target string is found in the file. 
                  String comparisons are case-sensitive by default. The file is assumed to be in the system default encoding unless specified otherwise.
                   

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

file -- Optional:NO The File to be searched.
string -- Optional:NO The string to match and count in the file.
varName -- Optional:YES DefaultVal:GetStringCountInFile The name of the variable to receive the count.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive.
encoding -- Optional:YES Charset encoding string like "UTF-8", etc...

getSubstringsInFile

public static DriverCommand getSubstringsInFile(java.lang.String file,
                                                java.lang.String regexstart,
                                                java.lang.String regexstop,
                                                java.lang.String rootname)

 
                  Extract dynamic substrings from a file using regular expressions.
                
                  
                  This command opens the file, reads it line by line, and sets DDVariables (based on rootname) for each occurrence of string identified by the substring formed between regexstart and regexstop (1 match per line, currently).  regexstart and regexstop must both be valid, non-empty strings or no matching substrings will be found.
                  
                  Fully qualified filename is opened and read line by line.  
                  Each line is parsed, searching for a match to the substring formed between regexstart and regexstop.
                  
                  When a match is found, the string between regexstart and regexstop is saved in a newly created DDVariable based on rootname and the number of occurrences.  There will be one DDVariable for each match found and a unique "Count" variable specifying how many matches were found.
                  
                  The rootname is used as a base to build the DDVariable names which contain the located substring(s) and Count.  For example, if rootname is "Chart" and two substring matches are found, then 2 DDVariables are created to store those substrings and another is created to store the count of matches: 
                  
                  
                     DDVariable Chart1 contains the first substring, and
                     DDVariable Chart2 contains the second substring. 
                     DDVariable ChartCount contains the number of matches found. 
                  
                   

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

file - Optional:NO Fully-qualified filename

regexstart - Optional:NO The starting regular expression. Should not be empty.

regexstop - Optional:NO The stopping regular expression. Should not be empty.

rootname - Optional:NO The root name of the returned variable(s).

getSubstringsInFile

public static DriverCommand getSubstringsInFile(java.lang.String[] parameters)

 
                  Extract dynamic substrings from a file using regular expressions.
                
                  
                  This command opens the file, reads it line by line, and sets DDVariables (based on rootname) for each occurrence of string identified by the substring formed between regexstart and regexstop (1 match per line, currently).  regexstart and regexstop must both be valid, non-empty strings or no matching substrings will be found.
                  
                  Fully qualified filename is opened and read line by line.  
                  Each line is parsed, searching for a match to the substring formed between regexstart and regexstop.
                  
                  When a match is found, the string between regexstart and regexstop is saved in a newly created DDVariable based on rootname and the number of occurrences.  There will be one DDVariable for each match found and a unique "Count" variable specifying how many matches were found.
                  
                  The rootname is used as a base to build the DDVariable names which contain the located substring(s) and Count.  For example, if rootname is "Chart" and two substring matches are found, then 2 DDVariables are created to store those substrings and another is created to store the count of matches: 
                  
                  
                     DDVariable Chart1 contains the first substring, and
                     DDVariable Chart2 contains the second substring. 
                     DDVariable ChartCount contains the number of matches found. 
                  
                   

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

file -- Optional:NO Fully-qualified filename
regexstart -- Optional:NO The starting regular expression. Should not be empty.
regexstop -- Optional:NO The stopping regular expression. Should not be empty.
rootname -- Optional:NO The root name of the returned variable(s).

getTextFromImage

public static DriverCommand getTextFromImage(java.lang.String imageFile,
                                             java.lang.String variableName,
                                             java.lang.String oCRId,
                                             java.lang.String langId,
                                             java.lang.String scaleRatio)

             Incorporate OCR technology to detect the text in an image file and save the text to a variable.
          
             Two open-source OCRs are integrated into SAFS. One is TesseractOCR (TOCR) at 
             http://code.google.com/p/tesseract-ocr; the other GOCR at http://jocr.sourceforge.net. 
             
             TOCR 2.0.4 and GOCR 0.48 are the latest release. They are available in SAFS and only 
             support English. Both two OCR owners claim to support more languages in next release. Chinese, 
             Japanese, and Korean are going to be supported in TOCR's next release 3.00.
                        
              

Supporting Engines:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

imageFile - Optional:NO The name of the image file used to detect text in it.

variableName - Optional:NO The name of the variable to receive detected text.

oCRId - Optional:YES OCRId indicating the OCR used to recognize text.

langId - Optional:YES Optional LangId representing the language in use for selected OCR to recognize text.

scaleRatio - Optional:YES Optional ScaleRatio indicating the scale ratio for resizing the original image.

getTextFromImage

public static DriverCommand getTextFromImage(java.lang.String[] parameters)

             Incorporate OCR technology to detect the text in an image file and save the text to a variable.
          
             Two open-source OCRs are integrated into SAFS. One is TesseractOCR (TOCR) at 
             http://code.google.com/p/tesseract-ocr; the other GOCR at http://jocr.sourceforge.net. 
             
             TOCR 2.0.4 and GOCR 0.48 are the latest release. They are available in SAFS and only 
             support English. Both two OCR owners claim to support more languages in next release. Chinese, 
             Japanese, and Korean are going to be supported in TOCR's next release 3.00.
                        
              

Supporting Engines:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

imageFile -- Optional:NO The name of the image file used to detect text in it.
variableName -- Optional:NO The name of the variable to receive detected text.
oCRId -- Optional:YES OCRId indicating the OCR used to recognize text.
langId -- Optional:YES Optional LangId representing the language in use for selected OCR to recognize text.
scaleRatio -- Optional:YES Optional ScaleRatio indicating the scale ratio for resizing the original image.

ifExistDir

public static DriverCommand ifExistDir(java.lang.String directoryName,
                                       java.lang.String thenDriverCommand)

          If the specified directory exists, then execute the following driver command.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

directoryName - Optional:NO The full path name of directory to test for

thenDriverCommand - Optional:NO Actually, the rest of the parameters include this, which is the driver command to execute if the directory exists, followed by the remaining driver parameters for that command

ifExistDir

public static DriverCommand ifExistDir(java.lang.String[] parameters)

          If the specified directory exists, then execute the following driver command.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

directoryName -- Optional:NO The full path name of directory to test for
thenDriverCommand -- Optional:NO Actually, the rest of the parameters include this, which is the driver command to execute if the directory exists, followed by the remaining driver parameters for that command

ifExistFile

public static DriverCommand ifExistFile(java.lang.String fileName,
                                        java.lang.String thenDriverCommand)

          If the specified file exists, then execute the following driver command.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The full path name of file to test for

thenDriverCommand - Optional:NO Actually, the rest of the parameters include this, which is the driver command to execute if the file exists, followed by the remaining driver parameters for that command

ifExistFile

public static DriverCommand ifExistFile(java.lang.String[] parameters)

          If the specified file exists, then execute the following driver command.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The full path name of file to test for
thenDriverCommand -- Optional:NO Actually, the rest of the parameters include this, which is the driver command to execute if the file exists, followed by the remaining driver parameters for that command

isEndOfFile

public static DriverCommand isEndOfFile(java.lang.String fileNumber,
                                        java.lang.String variable)

           If the specified file is at the end of file, a 'variable' gets true assigned, otherwise it gets false
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileNumber - Optional:NO The file number for the file to be closed.

variable - Optional:NO Variable to assign true or false

isEndOfFile

public static DriverCommand isEndOfFile(java.lang.String[] parameters)

           If the specified file is at the end of file, a 'variable' gets true assigned, otherwise it gets false
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileNumber -- Optional:NO The file number for the file to be closed.
variable -- Optional:NO Variable to assign true or false

openFile

public static DriverCommand openFile(java.lang.String fileName,
                                     java.lang.String mode,
                                     java.lang.String access,
                                     java.lang.String fileNumberVariable,
                                     java.lang.String fileNumber)

          Open an existing file with the filename, mode and access provided.
                  TID Note: Multiple ways to open a file:
                        
                                Mode=Input, Access=Read
                                Mode=Output, Access=Write
                                Mode=Append, Access=Write
                                Mode=AppendRaw, Access=Write
                                
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The full path file name of the file to be opened.

mode - Optional:NOMode to be used to open the file, Input, Output, Append, and AppendRaw.

access - Optional:NO Access to be used to open the file. Read, Write or Read Write.

fileNumberVariable - Optional:NO DDE Variable name of the variable to store the file number.

fileNumber - Optional:Yes Optional File number to be used to open the file Otherwise next available file number is used

openFile

public static DriverCommand openFile(java.lang.String[] parameters)

          Open an existing file with the filename, mode and access provided.
                  TID Note: Multiple ways to open a file:
                        
                                Mode=Input, Access=Read
                                Mode=Output, Access=Write
                                Mode=Append, Access=Write
                                Mode=AppendRaw, Access=Write
                                
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The full path file name of the file to be opened.
mode -- Optional:NOMode to be used to open the file, Input, Output, Append, and AppendRaw.
access -- Optional:NO Access to be used to open the file. Read, Write or Read Write.
fileNumberVariable -- Optional:NO DDE Variable name of the variable to store the file number.
fileNumber -- Optional:Yes Optional File number to be used to open the file Otherwise next available file number is used

openUTF8File

public static DriverCommand openUTF8File(java.lang.String fileName,
                                         java.lang.String mode,
                                         java.lang.String access,
                                         java.lang.String fileNumberVariable,
                                         java.lang.String fileNumber)

          Open an existing UTF-8 file with the filename, mode and access provided.
              TID Note: Multiple ways to open a file:
                        
                                Mode=Input, Access=Read
                                Mode=Output, Access=Write
                                Mode=Append, Access=Write
                                Mode=AppendRaw, Access=Write
                        
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The full path file name of the UTF-8 file to be opened.

mode - Optional:NOMode to be used to open the file, Input, Output, Append, and AppendRaw.

access - Optional:NO Access to be used to open the UTF-8 file. Read, Write or Read Write.

fileNumberVariable - Optional:NO DDE Variable name of the variable to store the file number.

fileNumber - Optional:Yes Optional File number to be used to open the UTF-8 file, otherwise, next available file number is used.

openUTF8File

public static DriverCommand openUTF8File(java.lang.String[] parameters)

          Open an existing UTF-8 file with the filename, mode and access provided.
              TID Note: Multiple ways to open a file:
                        
                                Mode=Input, Access=Read
                                Mode=Output, Access=Write
                                Mode=Append, Access=Write
                                Mode=AppendRaw, Access=Write
                        
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The full path file name of the UTF-8 file to be opened.
mode -- Optional:NOMode to be used to open the file, Input, Output, Append, and AppendRaw.
access -- Optional:NO Access to be used to open the UTF-8 file. Read, Write or Read Write.
fileNumberVariable -- Optional:NO DDE Variable name of the variable to store the file number.
fileNumber -- Optional:Yes Optional File number to be used to open the UTF-8 file, otherwise, next available file number is used.

printToFile

public static DriverCommand printToFile(java.lang.String fileNumber,
                                        java.lang.String expressionListVariable,
                                        java.lang.String printOutputPlacement)

          Write output to a sequential file already opened for writing.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileNumber - Optional:NO The file number of the file to be written to.

expressionListVariable - Optional:NO DDV variable name of the variable that contains the "Expression List"; NOTE: for RobotJ it is the Expression List, if it begins with ^ then it is treated as a variable.

printOutputPlacement - Optional:YES Print Output Placement Parameter determines where the next output to the same file should begin ; will place the output immediately following this print output , will start output at the next print zone on the same line Absence of this parameter (Default) will place the next output at the beginning of a new line following a carriage return line feed.

printToFile

public static DriverCommand printToFile(java.lang.String[] parameters)

          Write output to a sequential file already opened for writing.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileNumber -- Optional:NO The file number of the file to be written to.
expressionListVariable -- Optional:NO DDV variable name of the variable that contains the "Expression List"; NOTE: for RobotJ it is the Expression List, if it begins with ^ then it is treated as a variable.
printOutputPlacement -- Optional:YES Print Output Placement Parameter determines where the next output to the same file should begin ; will place the output immediately following this print output , will start output at the next print zone on the same line Absence of this parameter (Default) will place the next output at the beginning of a new line following a carriage return line feed.

readFileChars

public static DriverCommand readFileChars(java.lang.String fileNumber,
                                          java.lang.String numberOfChar,
                                          java.lang.String variableName)

          Read the number of characters from the file defined by file number 
          and assign a string containing the characters read to a DDV variable.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileNumber - Optional:NO The file number of the file to be read from.

numberOfChar - Optional:NO Number of characters to be read from the file If the number is -1, then the whole content will be read .

variableName - Optional:NO Name of the DDV variable in which to store the characters read from the file

readFileChars

public static DriverCommand readFileChars(java.lang.String[] parameters)

          Read the number of characters from the file defined by file number 
          and assign a string containing the characters read to a DDV variable.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileNumber -- Optional:NO The file number of the file to be read from.
numberOfChar -- Optional:NO Number of characters to be read from the file If the number is -1, then the whole content will be read .
variableName -- Optional:NO Name of the DDV variable in which to store the characters read from the file

readFileLine

public static DriverCommand readFileLine(java.lang.String fileNumber,
                                         java.lang.String variableName)

          Read a line from the file defined by file number                 and assign a string containing the line read to a DDV variable.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileNumber - Optional:NO The file number of the file to be read from.

variableName - Optional:NO Name of the DDV variable in which to store the line read from the file

readFileLine

public static DriverCommand readFileLine(java.lang.String[] parameters)

          Read a line from the file defined by file number                 and assign a string containing the line read to a DDV variable.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileNumber -- Optional:NO The file number of the file to be read from.
variableName -- Optional:NO Name of the DDV variable in which to store the line read from the file

readFileString

public static DriverCommand readFileString(java.lang.String fileNumber,
                                           java.lang.String variableName)

          Read a comma-separated value from a file and store it in a DDVariable.
        
          This command provides old Basic 'Input' style handling of file data.  It expects that 
          the file contains comma-separated values and only a single value is read from the 
          specified file for each call.
            

Supporting Engines:

• Rational Robot

Parameters:

fileNumber - Optional:NO The file number of the file to be read from.

variableName - Optional:NO Name of the DDVariable in which to store the value read from the file.

readFileString

public static DriverCommand readFileString(java.lang.String[] parameters)

          Read a comma-separated value from a file and store it in a DDVariable.
        
          This command provides old Basic 'Input' style handling of file data.  It expects that 
          the file contains comma-separated values and only a single value is read from the 
          specified file for each call.
            

Supporting Engines:

• Rational Robot

Parameters:

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

fileNumber -- Optional:NO The file number of the file to be read from.
variableName -- Optional:NO Name of the DDVariable in which to store the value read from the file.

renameFile

public static DriverCommand renameFile(java.lang.String oldFileName,
                                       java.lang.String newFileName,
                                       java.lang.String noVerify)

          Rename the file from the old file name to the new filename
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

oldFileName - Optional:NO The file path and file name of the file to be renamed.

newFileName - Optional:NO The new file path and file name of the file.

noVerify - Optional:Yes String Equal to "NOVERIFY" if file is not verified prior to renaming.

renameFile

public static DriverCommand renameFile(java.lang.String[] parameters)

          Rename the file from the old file name to the new filename
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

oldFileName -- Optional:NO The file path and file name of the file to be renamed.
newFileName -- Optional:NO The new file path and file name of the file.
noVerify -- Optional:Yes String Equal to "NOVERIFY" if file is not verified prior to renaming.

saveTextFromImage

public static DriverCommand saveTextFromImage(java.lang.String imageFile,
                                              java.lang.String outputFile,
                                              java.lang.String oCRId,
                                              java.lang.String langId,
                                              java.lang.String scaleRatio)

             Incorporate OCR technology to detect the text in an image file and save the text to a text file.
             
             Two open-source OCRs are integrated into SAFS. One is TesseractOCR (TOCR) at 
             http://code.google.com/p/tesseract-ocr; the other GOCR at http://jocr.sourceforge.net. 
             
             TOCR 2.0.4 and GOCR 0.48 are the latest release. They are available in SAFS and only 
             support English. Both two OCR owners claim to support more languages in next release. Chinese, 
             Japanese, and Korean are going to be supported in TOCR's next release 3.00.
                        
                 

Supporting Engines:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

imageFile - Optional:NO The name of the image file used to detect text in it.

outputFile - Optional:NO The name of the text file used to store detected text.

oCRId - Optional:YES OCRId indicating the OCR used to recognize text.

langId - Optional:YES Optional LangId representing the language in use for selected OCR to recognize text.

scaleRatio - Optional:YES Optional ScaleRatio indicating the scale ratio for resizing the original image.

saveTextFromImage

public static DriverCommand saveTextFromImage(java.lang.String[] parameters)

             Incorporate OCR technology to detect the text in an image file and save the text to a text file.
             
             Two open-source OCRs are integrated into SAFS. One is TesseractOCR (TOCR) at 
             http://code.google.com/p/tesseract-ocr; the other GOCR at http://jocr.sourceforge.net. 
             
             TOCR 2.0.4 and GOCR 0.48 are the latest release. They are available in SAFS and only 
             support English. Both two OCR owners claim to support more languages in next release. Chinese, 
             Japanese, and Korean are going to be supported in TOCR's next release 3.00.
                        
                 

Supporting Engines:

• Rational RobotJ
• SAFS SDCommands
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

imageFile -- Optional:NO The name of the image file used to detect text in it.
outputFile -- Optional:NO The name of the text file used to store detected text.
oCRId -- Optional:YES OCRId indicating the OCR used to recognize text.
langId -- Optional:YES Optional LangId representing the language in use for selected OCR to recognize text.
scaleRatio -- Optional:YES Optional ScaleRatio indicating the scale ratio for resizing the original image.

setFileProtections

public static DriverCommand setFileProtections(java.lang.String fileName,
                                               java.lang.String fileProtection)

          Change the file attribute for the file name provided to the value of the new file protection provided.
        
          Change the file attribute for the file name provided to the value of the new file protection provided. An integer containing the new attributes for the file. Here is a description of attributes that can be modified: 
          0 Normal file (Windows PC Only)
          1 Read-only file
          2 Hidden file (Windows PC Only)
          4 System file (Windows PC Only)
          32 Archive - file has changed since last backup (Windows PC Only)
          Note: Java-based support like RJ, TID, SDC currently only support setting one 
          file protection at a time--0, 1, 2, 3, 32. They do not yet support Integer values OR'd 
          together to combine settings in a single call.
          Note: On platforms other than windows we currently only support setting the READ-ONLY 
          attribute.
          
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileName - Optional:NO The file path and file name of the file change the file attribute.

fileProtection - Optional:NO New value of the attribute of the file to be changed

setFileProtections

public static DriverCommand setFileProtections(java.lang.String[] parameters)

          Change the file attribute for the file name provided to the value of the new file protection provided.
        
          Change the file attribute for the file name provided to the value of the new file protection provided. An integer containing the new attributes for the file. Here is a description of attributes that can be modified: 
          0 Normal file (Windows PC Only)
          1 Read-only file
          2 Hidden file (Windows PC Only)
          4 System file (Windows PC Only)
          32 Archive - file has changed since last backup (Windows PC Only)
          Note: Java-based support like RJ, TID, SDC currently only support setting one 
          file protection at a time--0, 1, 2, 3, 32. They do not yet support Integer values OR'd 
          together to combine settings in a single call.
          Note: On platforms other than windows we currently only support setting the READ-ONLY 
          attribute.
          
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileName -- Optional:NO The file path and file name of the file change the file attribute.
fileProtection -- Optional:NO New value of the attribute of the file to be changed

writeFileChars

public static DriverCommand writeFileChars(java.lang.String fileNumber,
                                           java.lang.String numberOfChars,
                                           java.lang.String expressionList)

          Write the specified number of characters to a file already opened for writing.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

fileNumber - Optional:NO The file number/identifier of the file to be written to.

numberOfChars - Optional:NO The number of characters to write to the file; however, if this parameter is equal to 'all' then all of the characters from the expression list are written.

expressionList - Optional:NO Expression List, if it begins with ^ then it is treated as a variable.

writeFileChars

public static DriverCommand writeFileChars(java.lang.String[] parameters)

          Write the specified number of characters to a file already opened for writing.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

fileNumber -- Optional:NO The file number/identifier of the file to be written to.
numberOfChars -- Optional:NO The number of characters to write to the file; however, if this parameter is equal to 'all' then all of the characters from the expression list are written.
expressionList -- Optional:NO Expression List, if it begins with ^ then it is treated as a variable.

callCycle

public static DriverCommand callCycle(java.lang.String cycleName,
                                      java.lang.String cycleSeparator,
                                      java.lang.String parameterName)

 
                 Invoke a Cycle table (from StepDriver or SuiteDriver)
               
                 Since the Cycle is executed as a driver command 
                 and NOT as a test record, the call to the 
                 Cycle itself is not counted as a test pass or a test fail.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

cycleName - Optional:NO The name of the Cycle table to execute.

cycleSeparator - Optional:YES DefaultVal: The field separator used by the table--if required.

parameterName - Optional:YES DefaultVal:AValue One or more parameter values to send to the Cycle--each in their own field.

callCycle

public static DriverCommand callCycle(java.lang.String[] parameters)

 
                 Invoke a Cycle table (from StepDriver or SuiteDriver)
               
                 Since the Cycle is executed as a driver command 
                 and NOT as a test record, the call to the 
                 Cycle itself is not counted as a test pass or a test fail.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

cycleName -- Optional:NO The name of the Cycle table to execute.
cycleSeparator -- Optional:YES DefaultVal: The field separator used by the table--if required.
parameterName -- Optional:YES DefaultVal:AValue One or more parameter values to send to the Cycle--each in their own field.

callJUnit

public static DriverCommand callJUnit(java.lang.String className)

 
                 Invoke one or more JUnit tests using the provided Class name(s).
               
                 Because JUnit is a testing framework; test_record, test_passes, and test_failure counts within the status counters 
                 will be updated when possible.
                 
                 If properly configured with SAFS RuntimeDataAwareness (dependency injection of SAFS Driver instances) the JUnit 
                 test has full access to all SAFS services including SAFS App Map data and SAFS Variable storage.
                 
                 JUnit tests can be intermixed with other SAFS tests.
                  

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

className - Optional:NO The name of one or more Classes to execute.

callScript

public static DriverCommand callScript(java.lang.String scriptName,
                                       java.lang.String parameterName)

 
                 Invoke a custom script with passed parameters/variables, if desired.
               
                 Since the script is executed as a Driver Command and NOT a test; 
                 test_record, test_passes, and test_failures information within the status counters 
                 are not updated.
                 For Rational Robot, if the called script wishes to record 
                 tests attempted, pass, and failure counts then it must 
                 do so itself by updating the ScriptStatusInfo fields 
                 accordingly.
                 The name of the script must not include the file extension.
                 Any number of parameters can be passed to the script.
                 These parameters are passed as DDVariables and\or SAFSVARS variables.
                 The variables and their values are available to the script and all of SAFS.
                 These parameters are usually specific to each called script.  The script can also 
                 set variable values for use by SAFS test tables.
                 With Robot, the script can get/set variable values from the DDVariableStore.
                 With Rational Functional Tester, the custom script should follow this Script Javadoc.
                 For Apple IOS, consult the SAFS IOS Developer's Guide.
                 
                  

Supporting Engines:

• OpenQA Selenium
• Rational Robot
• Apple IOS
• Rational RobotJ
• Mercury Interactive WinRunner

Parameters:

scriptName - Optional:NO The name of the Script to execute.

parameterName - Optional:YES DefaultVal:AValue One or more parameter values to send to the script--each in their own field.

callScript

public static DriverCommand callScript(java.lang.String[] parameters)

 
                 Invoke a custom script with passed parameters/variables, if desired.
               
                 Since the script is executed as a Driver Command and NOT a test; 
                 test_record, test_passes, and test_failures information within the status counters 
                 are not updated.
                 For Rational Robot, if the called script wishes to record 
                 tests attempted, pass, and failure counts then it must 
                 do so itself by updating the ScriptStatusInfo fields 
                 accordingly.
                 The name of the script must not include the file extension.
                 Any number of parameters can be passed to the script.
                 These parameters are passed as DDVariables and\or SAFSVARS variables.
                 The variables and their values are available to the script and all of SAFS.
                 These parameters are usually specific to each called script.  The script can also 
                 set variable values for use by SAFS test tables.
                 With Robot, the script can get/set variable values from the DDVariableStore.
                 With Rational Functional Tester, the custom script should follow this Script Javadoc.
                 For Apple IOS, consult the SAFS IOS Developer's Guide.
                 
                  

Supporting Engines:

• OpenQA Selenium
• Rational Robot
• Apple IOS
• Rational RobotJ
• Mercury Interactive WinRunner

Parameters:

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

scriptName -- Optional:NO The name of the Script to execute.
parameterName -- Optional:YES DefaultVal:AValue One or more parameter values to send to the script--each in their own field.

callStep

public static DriverCommand callStep(java.lang.String stepName,
                                     java.lang.String stepSeparator,
                                     java.lang.String parameterName)

 
                 Invoke a Step table from within another Step table (from StepDriver).
               
                 The command is only used at the Step level.  You do not use this 
                 command within Suites or Cycles.
                 Since the Step table is executed as a driver command by StepDriver 
                 and NOT as a CycleDriver or SuiteDriver test record, the call to the 
                 Step table itself is not counted as a test pass or a test fail.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

stepName - Optional:NO The name of the StepTable to execute.

stepSeparator - Optional:YES DefaultVal: The field separator used by the Step table--if required.

parameterName - Optional:YES DefaultVal:AValue One or more parameter values to send to the table--each in their own field.

callStep

public static DriverCommand callStep(java.lang.String[] parameters)

 
                 Invoke a Step table from within another Step table (from StepDriver).
               
                 The command is only used at the Step level.  You do not use this 
                 command within Suites or Cycles.
                 Since the Step table is executed as a driver command by StepDriver 
                 and NOT as a CycleDriver or SuiteDriver test record, the call to the 
                 Step table itself is not counted as a test pass or a test fail.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

stepName -- Optional:NO The name of the StepTable to execute.
stepSeparator -- Optional:YES DefaultVal: The field separator used by the Step table--if required.
parameterName -- Optional:YES DefaultVal:AValue One or more parameter values to send to the table--each in their own field.

callSuite

public static DriverCommand callSuite(java.lang.String suiteName,
                                      java.lang.String suiteSeparator,
                                      java.lang.String parameterName)

 
                 Invoke a Suite table (from StepDriver or SuiteDriver)
               
                 You cannot use CallSuite in a CycleDriver test table.
                 Since the Suite is executed as a driver command by SuiteDriver or 
                 StepDriver and NOT as a CycleDriver test record, the call to the 
                 Suite itself is not counted as a test pass or a test fail.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

suiteName - Optional:NO The name of the Suite to execute.

suiteSeparator - Optional:YES DefaultVal: The field separator used by the Suite--if required.

parameterName - Optional:YES DefaultVal:AValue One or more parameter values to send to the suite--each in their own field.

callSuite

public static DriverCommand callSuite(java.lang.String[] parameters)

 
                 Invoke a Suite table (from StepDriver or SuiteDriver)
               
                 You cannot use CallSuite in a CycleDriver test table.
                 Since the Suite is executed as a driver command by SuiteDriver or 
                 StepDriver and NOT as a CycleDriver test record, the call to the 
                 Suite itself is not counted as a test pass or a test fail.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

suiteName -- Optional:NO The name of the Suite to execute.
suiteSeparator -- Optional:YES DefaultVal: The field separator used by the Suite--if required.
parameterName -- Optional:YES DefaultVal:AValue One or more parameter values to send to the suite--each in their own field.

exitCycle

public static DriverCommand exitCycle()

 
                 Exit the currently running Step, Suite, and/or Cycle table.
               
                 Exit the currently running Step, Suite, and/or Cycle table.
                 Generally called from Step or Suite Driver to exit or abort the entire 
                 Cycle test currently running.
                 
                 The Step or Suite table containing the command is exited.  If an ExitTable 
                 processing block has been set by SetExitTableBlock then that block 
                 will be executed.  Otherwise, the table will immediately exit.  
                 
                 Any Suite and/or Cycle table that invoked the table will also be exited.  
                 If an ExitTable processing block has been set by SetExitTableBlock for the table 
                 then that block will be executed.  Otherwise, the table will immediately exit.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

exitSuite

public static DriverCommand exitSuite()

 
                 Exit the currently running Step and/or Suite table.
               
                 Exit the currently running Step and/or Suite table.
                 Generally only called from Step Driver to exit the current Step 
                 table AND the Suite that invoked it.  The command should have no 
                 effect inside a Cycle table.
                 
                 The Step or Suite table containing the command is exited.  If an ExitTable 
                 processing block has been set by SetExitTableBlock then that block 
                 will be executed.  Otherwise, the table will immediately exit.  
                 
                 If the table containing the command was a Step table, then the Suite that 
                 called the Step table will also be exited.  If an ExitTable 
                 processing block has been set by SetExitTableBlock for the Suite,
                 then that block will be executed.  Otherwise, the Suite will immediately exit.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

exitTable

public static DriverCommand exitTable()

 
                 Exit the currently running Step, Suite, or Cycle table.
               
                 Exit the currently running Step, Suite, or Cycle table.
                 The table containing the command is exited.  No other table 
                 is automatically exited because of this command.  If an ExitTable 
                 processing block has been set by SetExitTableBlock then that block 
                 will be executed.  Otherwise, the table will immediately exit.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

gotoBlockID

public static DriverCommand gotoBlockID(java.lang.String blockID)

 
                 Goto a named block in the current table.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:NO The name of the block to Goto.

onContainsGotoBlockID

public static DriverCommand onContainsGotoBlockID(java.lang.String blockID,
                                                  java.lang.String value1,
                                                  java.lang.String value2,
                                                  java.lang.String caseSensitive)

 
                 Goto the named block in the current table if value2 is contained within value1.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The value to be searched for the Value2 substring

value2 - Optional:NO A string to search Value1 for an occurance of

caseSensitive - Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onContainsGotoBlockID

public static DriverCommand onContainsGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if value2 is contained within value1.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The value to be searched for the Value2 substring
value2 -- Optional:NO A string to search Value1 for an occurance of
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onDirectoryExistGotoBlockID

public static DriverCommand onDirectoryExistGotoBlockID(java.lang.String blockID,
                                                        java.lang.String directoryName)

 
                 Goto the named block in the current table if the directory exists.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

blockID - Optional:NO The name of the block to Goto.

directoryName - Optional:NO The directory name of the directory relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).

onDirectoryExistGotoBlockID

public static DriverCommand onDirectoryExistGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if the directory exists.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
directoryName -- Optional:NO The directory name of the directory relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).

onDirectoryNotExistGotoBlockID

public static DriverCommand onDirectoryNotExistGotoBlockID(java.lang.String blockID,
                                                           java.lang.String directoryName)

 
                 Goto the named block in the current table if the Directory does not exist.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

blockID - Optional:NO The name of the block to Goto.

directoryName - Optional:NO The directory name relatvie to Datapool/Text of the directory to be verified for non existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).

onDirectoryNotExistGotoBlockID

public static DriverCommand onDirectoryNotExistGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if the Directory does not exist.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
directoryName -- Optional:NO The directory name relatvie to Datapool/Text of the directory to be verified for non existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).

onEqualGotoBlockID

public static DriverCommand onEqualGotoBlockID(java.lang.String blockID,
                                               java.lang.String value1,
                                               java.lang.String value2,
                                               java.lang.String caseSensitive)

 
                 Goto the named block in the current table if two values are equal.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The first value for the comparison.

value2 - Optional:NO The second value for the comparison.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onEqualGotoBlockID

public static DriverCommand onEqualGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if two values are equal.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The first value for the comparison.
value2 -- Optional:NO The second value for the comparison.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onFileEOFGotoBlockID

public static DriverCommand onFileEOFGotoBlockID(java.lang.String blockID,
                                                 java.lang.String fileNumber)

          Goto the named block in the current table if the file is at EOF.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

blockID - Optional:NO The name of the block to Goto.

fileNumber - Optional:NO The file number of the file to be verified for EOF.

onFileEOFGotoBlockID

public static DriverCommand onFileEOFGotoBlockID(java.lang.String[] parameters)

          Goto the named block in the current table if the file is at EOF.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
fileNumber -- Optional:NO The file number of the file to be verified for EOF.

onFileExistGotoBlockID

public static DriverCommand onFileExistGotoBlockID(java.lang.String blockID,
                                                   java.lang.String fileName)

 
                 Goto the named block in the current table if the file exists.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

blockID - Optional:NO The name of the block to Goto.

fileName - Optional:NO The file name of the file relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).

onFileExistGotoBlockID

public static DriverCommand onFileExistGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if the file exists.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
fileName -- Optional:NO The file name of the file relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).

onFileNotExistGotoBlockID

public static DriverCommand onFileNotExistGotoBlockID(java.lang.String blockID,
                                                      java.lang.String fileName)

 
                 Goto the named block in the current table if the file does not exist.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

blockID - Optional:NO The name of the block to Goto.

fileName - Optional:NO The file name of the file relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).

onFileNotExistGotoBlockID

public static DriverCommand onFileNotExistGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if the file does not exist.
                  

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
fileName -- Optional:NO The file name of the file relative to Datapool/Test to be verified for existance. Case sensitivity is handled by the underlying operating system (i.e. a case sensitive platform makes this keyword case sensitive).

onGreaterThanGotoBlockID

public static DriverCommand onGreaterThanGotoBlockID(java.lang.String blockID,
                                                     java.lang.String value1,
                                                     java.lang.String value2,
                                                     java.lang.String caseSensitive)

 
                 Goto the named block in the current table if value1 is greater than value2.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The value to be compared.

value2 - Optional:NO The value to be compared against.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onGreaterThanGotoBlockID

public static DriverCommand onGreaterThanGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if value1 is greater than value2.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The value to be compared.
value2 -- Optional:NO The value to be compared against.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onGUIExistsGotoBlockID

public static DriverCommand onGUIExistsGotoBlockID(java.lang.String blockID,
                                                   java.lang.String windowID,
                                                   java.lang.String componentID,
                                                   java.lang.String timeOut)

                 Goto the named block in the current table if a GUI component exists.
                  

Supporting Engines:

• Google Android
• Apple IOS
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium
• OpenQA Selenium
• Automated QA TestComplete

Parameters:

blockID - Optional:NO The name of the block to Goto.

windowID - Optional:NO A Window reference from the app map.

componentID - Optional:NO A reference from the app map for the Component within the Window.

timeOut - Optional:YES DefaultVal:15 Timeout value in seconds before exiting automatically (no branch).

onGUIExistsGotoBlockID

public static DriverCommand onGUIExistsGotoBlockID(java.lang.String[] parameters)

                 Goto the named block in the current table if a GUI component exists.
                  

Supporting Engines:

• Google Android
• Apple IOS
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium
• OpenQA Selenium
• Automated QA TestComplete

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
windowID -- Optional:NO A Window reference from the app map.
componentID -- Optional:NO A reference from the app map for the Component within the Window.
timeOut -- Optional:YES DefaultVal:15 Timeout value in seconds before exiting automatically (no branch).

onGUINotExistGotoBlockID

public static DriverCommand onGUINotExistGotoBlockID(java.lang.String blockID,
                                                     java.lang.String windowID,
                                                     java.lang.String componentID,
                                                     java.lang.String timeOut)

                 Goto the named block in the current table if a GUI component does not exist.
                  

Supporting Engines:

• Google Android
• Apple IOS
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium
• OpenQA Selenium
• Automated QA TestComplete

Parameters:

blockID - Optional:NO The name of the block to Goto.

windowID - Optional:NO A Window reference from the app map.

componentID - Optional:NO A reference from the app map for the Component within the Window.

timeOut - Optional:YES DefaultVal:15 Timeout value in seconds before exiting automatically (no branch).

onGUINotExistGotoBlockID

public static DriverCommand onGUINotExistGotoBlockID(java.lang.String[] parameters)

                 Goto the named block in the current table if a GUI component does not exist.
                  

Supporting Engines:

• Google Android
• Apple IOS
• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner
• OpenQA Selenium
• OpenQA Selenium
• Automated QA TestComplete

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
windowID -- Optional:NO A Window reference from the app map.
componentID -- Optional:NO A reference from the app map for the Component within the Window.
timeOut -- Optional:YES DefaultVal:15 Timeout value in seconds before exiting automatically (no branch).

onInRangeGotoBlockID

public static DriverCommand onInRangeGotoBlockID(java.lang.String blockID,
                                                 java.lang.String value1,
                                                 java.lang.String value2,
                                                 java.lang.String value3,
                                                 java.lang.String caseSensitive)

                 Goto named block if value1 is between value2 and value3.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The value to be compared.

value2 - Optional:NO The low end of range to be compared against.

value3 - Optional:NO The high end of range to be compared against.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onInRangeGotoBlockID

public static DriverCommand onInRangeGotoBlockID(java.lang.String[] parameters)

                 Goto named block if value1 is between value2 and value3.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The value to be compared.
value2 -- Optional:NO The low end of range to be compared against.
value3 -- Optional:NO The high end of range to be compared against.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onLessThanGotoBlockID

public static DriverCommand onLessThanGotoBlockID(java.lang.String blockID,
                                                  java.lang.String value1,
                                                  java.lang.String value2,
                                                  java.lang.String caseSensitive)

 
                 Goto the named block if value1 is less than value2.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The value to be compared.

value2 - Optional:NO The value to be compared against.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onLessThanGotoBlockID

public static DriverCommand onLessThanGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block if value1 is less than value2.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The value to be compared.
value2 -- Optional:NO The value to be compared against.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onMenuItemContainsStateGotoBlockID

public static DriverCommand onMenuItemContainsStateGotoBlockID(java.lang.String blockID,
                                                               java.lang.String windowName,
                                                               java.lang.String componentName,
                                                               java.lang.String menuItem,
                                                               java.lang.String state)

 
                   Goto the named block in the current table if state is part of the state information of the menuitem.
                    

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

blockID - Optional:NO The name of the block to transfer control to if state is part of the state information of the menuitem.

windowName - Optional:NO The window name.

componentName - Optional:NO The component name.

menuItem - Optional:NO Menu->MenuItem hierarchy string to identify which menu item to test. This menu hierarchy is case-sensitive. to test. This menu hierarchy is case-sensitive.

state - Optional:NO Expected status string (or part thereof) to verify. Ex: "Enabled Checked" OR "Disabled Grayed" etc. Each item separated by a space will be evaluated separately so the order of the status items does not matter. These status items are case-sensitive.

onMenuItemContainsStateGotoBlockID

public static DriverCommand onMenuItemContainsStateGotoBlockID(java.lang.String[] parameters)

 
                   Goto the named block in the current table if state is part of the state information of the menuitem.
                    

Supporting Engines:

• Rational Robot
• Rational RobotJ

Parameters:

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

blockID -- Optional:NO The name of the block to transfer control to if state is part of the state information of the menuitem.
windowName -- Optional:NO The window name.
componentName -- Optional:NO The component name.
menuItem -- Optional:NO Menu->MenuItem hierarchy string to identify which menu item to test. This menu hierarchy is case-sensitive. to test. This menu hierarchy is case-sensitive.
state -- Optional:NO Expected status string (or part thereof) to verify. Ex: "Enabled Checked" OR "Disabled Grayed" etc. Each item separated by a space will be evaluated separately so the order of the status items does not matter. These status items are case-sensitive.

onNotContainsGotoBlockID

public static DriverCommand onNotContainsGotoBlockID(java.lang.String blockID,
                                                     java.lang.String value1,
                                                     java.lang.String value2,
                                                     java.lang.String caseSensitive)

 
                 Goto the named block in the current table if value2 is NOT a substring of value1.
                  

Supporting Engines:

• SAFS TIDDriverCommands
• Rational Robot

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The value to be searched for the Value2 substring

value2 - Optional:NO The substring to seek in VALUE1

caseSensitive - Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onNotContainsGotoBlockID

public static DriverCommand onNotContainsGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if value2 is NOT a substring of value1.
                  

Supporting Engines:

• SAFS TIDDriverCommands
• Rational Robot

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The value to be searched for the Value2 substring
value2 -- Optional:NO The substring to seek in VALUE1
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onNotEqualGotoBlockID

public static DriverCommand onNotEqualGotoBlockID(java.lang.String blockID,
                                                  java.lang.String value1,
                                                  java.lang.String value2,
                                                  java.lang.String caseSensitive)

 
                 Goto the named block in the current table if two values are not equal.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The first value for the comparison.

value2 - Optional:NO The second value for the comparison.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onNotEqualGotoBlockID

public static DriverCommand onNotEqualGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if two values are not equal.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The first value for the comparison.
value2 -- Optional:NO The second value for the comparison.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onNotGreaterThanGotoBlockID

public static DriverCommand onNotGreaterThanGotoBlockID(java.lang.String blockID,
                                                        java.lang.String value1,
                                                        java.lang.String value2,
                                                        java.lang.String caseSensitive)

 
                 Goto the named block in the current table if value1 is NOT greater than value2.
                  

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The value expected to be NOT greater than VALUE2.

value2 - Optional:NO The value expected to be equal or greater than VALUE1.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onNotGreaterThanGotoBlockID

public static DriverCommand onNotGreaterThanGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block in the current table if value1 is NOT greater than value2.
                  

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The value expected to be NOT greater than VALUE2.
value2 -- Optional:NO The value expected to be equal or greater than VALUE1.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

onNotInRangeGotoBlockID

public static DriverCommand onNotInRangeGotoBlockID(java.lang.String blockID,
                                                    java.lang.String value1,
                                                    java.lang.String value2,
                                                    java.lang.String value3,
                                                    java.lang.String caseSensitive)

                 Goto the named block in the current table if value1 is not between value2 and value3.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The value to be compared.

value2 - Optional:NO The low end of range to be compared against.

value3 - Optional:NO The high end of range to be compared against.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onNotInRangeGotoBlockID

public static DriverCommand onNotInRangeGotoBlockID(java.lang.String[] parameters)

                 Goto the named block in the current table if value1 is not between value2 and value3.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The value to be compared.
value2 -- Optional:NO The low end of range to be compared against.
value3 -- Optional:NO The high end of range to be compared against.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onNotLessThanGotoBlockID

public static DriverCommand onNotLessThanGotoBlockID(java.lang.String blockID,
                                                     java.lang.String value1,
                                                     java.lang.String value2,
                                                     java.lang.String caseSensitive)

 
                 Goto the named block if value1 is NOT less than value2.
                  

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

blockID - Optional:NO The name of the block to Goto.

value1 - Optional:NO The value that should be NOT less than VALUE2.

value2 - Optional:NO The value that should be equal or less than VALUE1.

caseSensitive - Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onNotLessThanGotoBlockID

public static DriverCommand onNotLessThanGotoBlockID(java.lang.String[] parameters)

 
                 Goto the named block if value1 is NOT less than value2.
                  

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
value1 -- Optional:NO The value that should be NOT less than VALUE2.
value2 -- Optional:NO The value that should be equal or less than VALUE1.
caseSensitive -- Optional:YES Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

onPartialMenuItemContainsStateGotoBlockID

public static DriverCommand onPartialMenuItemContainsStateGotoBlockID(java.lang.String blockID,
                                                                      java.lang.String windowName,
                                                                      java.lang.String componentName,
                                                                      java.lang.String menuItem,
                                                                      java.lang.String state)

 
                   Goto the named block in the current table if state is part of the state information of the menuitem.
                   This command allows for a partial match of the menu item.
                    

Supporting Engines:

• Rational Robot

Parameters:

blockID - Optional:NO The name of the block to transfer control to if state is part of the state information of the menuitem.

windowName - Optional:NO The window name.

componentName - Optional:NO The component name.

menuItem - Optional:NO Menu->MenuItem hierarchy string to identify which menu item to test. This menu hierarchy is case-sensitive. to test. This menu hierarchy is case-sensitive.

state - Optional:NO Expected status string (or part thereof) to verify. Ex: "Enabled Checked" OR "Disabled Grayed" etc. Each item separated by a space will be evaluated separately so the order of the status items does not matter. These status items are case-sensitive.

onPartialMenuItemContainsStateGotoBlockID

public static DriverCommand onPartialMenuItemContainsStateGotoBlockID(java.lang.String[] parameters)

 
                   Goto the named block in the current table if state is part of the state information of the menuitem.
                   This command allows for a partial match of the menu item.
                    

Supporting Engines:

• Rational Robot

Parameters:

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

blockID -- Optional:NO The name of the block to transfer control to if state is part of the state information of the menuitem.
windowName -- Optional:NO The window name.
componentName -- Optional:NO The component name.
menuItem -- Optional:NO Menu->MenuItem hierarchy string to identify which menu item to test. This menu hierarchy is case-sensitive. to test. This menu hierarchy is case-sensitive.
state -- Optional:NO Expected status string (or part thereof) to verify. Ex: "Enabled Checked" OR "Disabled Grayed" etc. Each item separated by a space will be evaluated separately so the order of the status items does not matter. These status items are case-sensitive.

onRegistryKeyExistGotoBlockID

public static DriverCommand onRegistryKeyExistGotoBlockID(java.lang.String blockID,
                                                          java.lang.String key,
                                                          java.lang.String keyValue,
                                                          java.lang.String timeOut)

                 Goto the named block in the current table if the Registry Key exists.
              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:

• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

blockID - Optional:NO The name of the block to Goto.

key - Optional:NO The Registry Key to seek.

keyValue - Optional:YES The optional Registry subkey value to seek.

timeOut - Optional:YES DefaultVal:15 Timeout value in seconds before exiting automatically (no branch).

onRegistryKeyExistGotoBlockID

public static DriverCommand onRegistryKeyExistGotoBlockID(java.lang.String[] parameters)

                 Goto the named block in the current table if the Registry Key exists.
              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:

• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
key -- Optional:NO The Registry Key to seek.
keyValue -- Optional:YES The optional Registry subkey value to seek.
timeOut -- Optional:YES DefaultVal:15 Timeout value in seconds before exiting automatically (no branch).

onRegistryKeyNotExistGotoBlockID

public static DriverCommand onRegistryKeyNotExistGotoBlockID(java.lang.String blockID,
                                                             java.lang.String key,
                                                             java.lang.String keyValue,
                                                             java.lang.String timeOut)

                 Goto the named block in the current table if the Registry Key does not exist.
              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:

• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

blockID - Optional:NO The name of the block to Goto.

key - Optional:NO The Registry Key to seek.

keyValue - Optional:YES The optional Registry subkey value to seek.

timeOut - Optional:YES DefaultVal:15 Timeout value in seconds before exiting automatically (no branch).

onRegistryKeyNotExistGotoBlockID

public static DriverCommand onRegistryKeyNotExistGotoBlockID(java.lang.String[] parameters)

                 Goto the named block in the current table if the Registry Key does not exist.
              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:

• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

blockID -- Optional:NO The name of the block to Goto.
key -- Optional:NO The Registry Key to seek.
keyValue -- Optional:YES The optional Registry subkey value to seek.
timeOut -- Optional:YES DefaultVal:15 Timeout value in seconds before exiting automatically (no branch).

setExitTableBlock

public static DriverCommand setExitTableBlock(java.lang.String blockID)

 
                 Set or clear the name of a block to execute when the ExitTable command is encountered.
               
                 Set or clear the name of a block to execute when the ExitTable command is encountered.
                 You can reset this to nothing by leaving the BlockID parameter blank 
                 or providing an empty BlockID.  This reset should be done as part of the ExitTable 
                 processing.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:YES DefaultVal: The name of the block to Goto when ExitTable is encountered.

setGeneralScriptFailureBlock

public static DriverCommand setGeneralScriptFailureBlock(java.lang.String blockID)

 
                 Set or clear the name of a block to execute when GeneralScriptFailure occurs.
               
                 Set or clear the name of a block to execute when GeneralScriptFailure occurs.
                 Status is evaluated after the completion of every record in a table. 
                 
                 You can reset this to nothing by leaving the BlockID parameter blank 
                 or providing an empty BlockID.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:YES DefaultVal: The name of the block to Goto on status GeneralScriptFailure.

setInvalidFileIOBlock

public static DriverCommand setInvalidFileIOBlock(java.lang.String blockID)

 
                 Set or clear the name of a block to execute when InvalidFileIO occurs.
               
                 Set or clear the name of a block to execute when InvalidFileIO occurs.
                 Status is evaluated after the completion of every record in a table. 
                 
                 You can reset this to nothing by leaving the BlockID parameter blank 
                 or providing an empty BlockID.
                 
                 Note, an InvalidFileIO generated from the test table itself will not 
                 be processed by this block.  In general, that would not be possible 
                 because the FileIO error likely means the table cannot be processed.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:YES DefaultVal: The name of the block to Goto on status InvalidFileIO.

setNoScriptFailureBlock

public static DriverCommand setNoScriptFailureBlock(java.lang.String blockID)

 
                 Set or clear the name of a block to execute when NoScriptFailure occurs.
               
                 Set or clear the name of a block to execute when NoScriptFailure occurs.
                 Status is evaluated after the completion of every record in a table. 
                 So event the simple logging of message can return NoScriptFailure.
                 
                 This block setting is automatically cleared when a jump is executed as 
                 a result of this condition.  This command is generally used immediately 
                 before the record you expect to pass or fail.  You can reset this to 
                 nothing by leaving the BlockID parameter blank or providing an empty
                 BlockID.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:YES DefaultVal: The name of the block to Goto on status NoScriptFailure.

setScriptNotExecutedBlock

public static DriverCommand setScriptNotExecutedBlock(java.lang.String blockID)

 
                 Set or clear the name of a block to execute when ScriptNotExecuted occurs.
               
                 Set or clear the name of a block to execute when ScriptNotExecuted occurs.
                 Status is evaluated after the completion of every record in a table.  In general, 
                 ScriptNotExecuted only occurs when the drivers are not able to be invoked or 
                 StepDriver cannot properly locate GUI items or the functions to process them.
                 
                 You can reset this to nothing by leaving the BlockID parameter blank 
                 or providing an empty BlockID.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:YES DefaultVal: The name of the block to Goto on status ScriptNotExecuted.

setScriptWarningBlock

public static DriverCommand setScriptWarningBlock(java.lang.String blockID)

 
                 Set or clear the name of a block to execute when ScriptWarning occurs.
               
                 Set or clear the name of a block to execute when ScriptWarning occurs.
                 Status is evaluated after the completion of every record in a table. 
                 
                 You can reset this to nothing by leaving the BlockID parameter blank 
                 or providing an empty BlockID.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• Mercury Interactive WinRunner

Parameters:

blockID - Optional:YES DefaultVal: The name of the block to Goto on status ScriptWarning.

useLocalFlowControl

public static DriverCommand useLocalFlowControl(java.lang.String state)

 
                 When TRUE then flow control block IDs have current table scope only.
               
                 By default, flow control block IDs provided with the SetXXXBlock commands 
                 have test level scope.  That is, a block ID set stays in effect for all test 
                 tables at that test level until the block ID is changed or cleared.
                 
                 By setting UseLocalFlowControl=TRUE then any flow control block ID set 
                 has only local scope.  It is only valid for the currently executing table.
                 
                 Note, if no parameter is provided the parameter will default to TRUE.
                 
                  

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

state - Optional:YES DefaultVal:TRUE The TRUE or FALSE value to use.

logFailureOK

public static DriverCommand logFailureOK(java.lang.String message,
                                         java.lang.String details)

        Log an EXPECTED failure message.
          Log that a failure was expected and, as such, is OK.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

message - Optional:NO The message to log.

details - Optional:YES Additional detail to add to the message.

logFailureOK

public static DriverCommand logFailureOK(java.lang.String[] parameters)

        Log an EXPECTED failure message.
          Log that a failure was expected and, as such, is OK.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

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

message -- Optional:NO The message to log.
details -- Optional:YES Additional detail to add to the message.

logMessage

public static DriverCommand logMessage(java.lang.String message,
                                       java.lang.String details)

        Log a generic message
          Log a generic message.  You can optionally add an additional 
          details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

message - Optional:NO The message to log.

details - Optional:YES Additional detail to add to the message.

logMessage

public static DriverCommand logMessage(java.lang.String[] parameters)

        Log a generic message
          Log a generic message.  You can optionally add an additional 
          details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

message -- Optional:NO The message to log.
details -- Optional:YES Additional detail to add to the message.

logTestFailure

public static DriverCommand logTestFailure(java.lang.String message,
                                           java.lang.String details)

        Log a FAILURE message. Also increments appropriate counters.
          Log a FAILURE message.  Also increments appropriate counters.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

message - Optional:NO The message to log.

details - Optional:YES Additional detail to add to the message.

logTestFailure

public static DriverCommand logTestFailure(java.lang.String[] parameters)

        Log a FAILURE message. Also increments appropriate counters.
          Log a FAILURE message.  Also increments appropriate counters.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

message -- Optional:NO The message to log.
details -- Optional:YES Additional detail to add to the message.

logTestSuccess

public static DriverCommand logTestSuccess(java.lang.String message,
                                           java.lang.String details)

        Log a SUCCESS/OK message. Also increments appropriate counters.
          Log a SUCCESS/OK message.  Also increments appropriate counters.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

message - Optional:NO The message to log.

details - Optional:YES Additional detail to add to the message.

logTestSuccess

public static DriverCommand logTestSuccess(java.lang.String[] parameters)

        Log a SUCCESS/OK message. Also increments appropriate counters.
          Log a SUCCESS/OK message.  Also increments appropriate counters.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

message -- Optional:NO The message to log.
details -- Optional:YES Additional detail to add to the message.

logTestWarning

public static DriverCommand logTestWarning(java.lang.String message,
                                           java.lang.String details)

        Log a WARNING message. Also increments appropriate counters.
          Log a WARNING message.  Also increments appropriate counters.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

message - Optional:NO The message to log.

details - Optional:YES Additional detail to add to the message.

logTestWarning

public static DriverCommand logTestWarning(java.lang.String[] parameters)

        Log a WARNING message. Also increments appropriate counters.
          Log a WARNING message.  Also increments appropriate counters.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

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

message -- Optional:NO The message to log.
details -- Optional:YES Additional detail to add to the message.

logWarningOK

public static DriverCommand logWarningOK(java.lang.String message,
                                         java.lang.String details)

        Log an EXPECTED WARNING message.
          Log that a WARNING was expected and, as such, is OK.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

message - Optional:NO The message to log.

details - Optional:YES Additional detail to add to the message.

logWarningOK

public static DriverCommand logWarningOK(java.lang.String[] parameters)

        Log an EXPECTED WARNING message.
          Log that a WARNING was expected and, as such, is OK.
          You can optionally add an additional details description that follows the message.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner
• SAFS TIDDriverCommands

Parameters:

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

message -- Optional:NO The message to log.
details -- Optional:YES Additional detail to add to the message.

resumeLogging

public static DriverCommand resumeLogging(java.lang.String logName)

 
                 Resume suspended logging.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

logName - Optional:YES DefaultVal: The name of a Log Facility, other than the "current" one, to resume.

suspendLogging

public static DriverCommand suspendLogging(java.lang.String logName)

 
                 Suspend all logging.
                  

Supporting Engines:

• Rational Robot
• SAFS TIDDriverCommands
• OpenQA Selenium

Parameters:

logName - Optional:YES DefaultVal: The name of a Log Facility if other than the "current" one.

restCleanResponseMap

public static DriverCommand restCleanResponseMap(java.lang.String responseID)

                    Delete REST response (and request if it is stored) from the internal Map.
                
                    Delete a REST response (and request if it is stored) from the internal Map.
                    The REST response/request is stored internally in a Map of pair (responsID, Response).
                    
                        BE CAREFUL WHNE CALLING THIS KEYWORD! It will clean Response from internal Map, and
                        can cause other keyword failing to work.
                    
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

responseID - Optional:YES The ID used to delete Response Object from internal Map.

restDeleteResponse

public static DriverCommand restDeleteResponse(java.lang.String responseID)

                                        Delete a REST response (and request if stored) from the persistent storages.
                                
                                        Delete a REST response (and request if stored) from the persistent storages.
                                        The REST response/request is supposed to be in the persistent storages.
                                        The response/request can be in more than one type of persistence storage, and
                                        it can be a series of variables, a file or something else, please refer to 
                                        explanation of parameters of keyword RestStoreResponse.
                                        For example, if the Response/Request is stored be in a XML file, a JSON file 
                                        and "a series of variables" at the same time, then this keyword will delete 
                                        all of them (XML file, JSON file and variables).
                                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

responseID - Optional:NO The ID of the Response/Request (stored in persistence storages) to be deleted.

restDeleteResponseStore

public static DriverCommand restDeleteResponseStore()

                    Delete ALL REST responses (and requests if stored) from the persistent storages.
                
                    Delete ALL REST responses (and requests if stored) from the persistent storages. 
                    The REST response/request is supposed to be in the persistent storages.
                    The response/request can be in more than one type of persistence storage, and
                    it can be a series of variables, a file or something else, please refer to 
                    explanation of parameters of keyword RestStoreResponse.
                    For example, if there are 2 Responses/Requests have been persisted, 
                    one is stored be in a XML file, a JSON file and "a series of variables" at the same time,
                    the other is stored in JSON file and "a series of variables", then this keyword will delete 
                    all of them (XML file, JSON file and variables of the first Response/Request, 
                    JSON file and "a series of variables" of the second Response/Request).
                    

Supporting Engines:

• SAFS TIDDriverCommands

restHeadersLoad

public static DriverCommand restHeadersLoad(java.lang.String headersFile,
                                            java.lang.String method,
                                            java.lang.String type)

                    Load headers from a file.
                
                    This might be called before invoking a REST action, like RESTGetXML etc.
                    And the loaded headers will be used when executing that REST action 
                    if no headers are provided as parameter of that REST action.
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

headersFile - Optional:NO The path to file holding headers information.

method - Optional:YES The method is used to load the "headers" from a file. If this parameter is not provided, then "headers" of all methods will be loaded.

type - Optional:YES The type is used to load the "headers" from a file. If this parameter is not provided, then "headers" of all types will be loaded.

restHeadersLoad

public static DriverCommand restHeadersLoad(java.lang.String[] parameters)

                    Load headers from a file.
                
                    This might be called before invoking a REST action, like RESTGetXML etc.
                    And the loaded headers will be used when executing that REST action 
                    if no headers are provided as parameter of that REST action.
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

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

headersFile -- Optional:NO The path to file holding headers information.
method -- Optional:YES The method is used to load the "headers" from a file. If this parameter is not provided, then "headers" of all methods will be loaded.
type -- Optional:YES The type is used to load the "headers" from a file. If this parameter is not provided, then "headers" of all types will be loaded.

restStoreResponse

public static DriverCommand restStoreResponse(java.lang.String responseID,
                                              java.lang.String variablePrefix,
                                              java.lang.String storeRequest,
                                              java.lang.String persistenceType,
                                              java.lang.String fileType)

Save a REST response into a persistent storage.
                    Retrieve a REST response according to the responseID, and store the response into
                    a persistent storage. The persistent storage can be a series of variables, a file 
                    or something else, please refer to explanation of parameters.
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

responseID - Optional:NO The ID used to retrieve Response Object from internal Map.

variablePrefix - Optional:NO The prefix of the variables to store the information of a REST response/request if parameter persistenceType is VARIABLE. Or the file name holding the information of a REST response/request if parameter persistenceType is FILE.

storeRequest - Optional:YES DefaultVal:FalseStore the originating Request information if this parameter is true. The default value is false.

persistenceType - Optional:YES DefaultVal:VARIABLEThe type of the persistence storage to save the Response/Request information.

fileType - Optional:YES DefaultVal:JSONThe Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"

restStoreResponse

public static DriverCommand restStoreResponse(java.lang.String[] parameters)

Save a REST response into a persistent storage.
                    Retrieve a REST response according to the responseID, and store the response into
                    a persistent storage. The persistent storage can be a series of variables, a file 
                    or something else, please refer to explanation of parameters.
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

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

responseID -- Optional:NO The ID used to retrieve Response Object from internal Map.
variablePrefix -- Optional:NO The prefix of the variables to store the information of a REST response/request if parameter persistenceType is VARIABLE. Or the file name holding the information of a REST response/request if parameter persistenceType is FILE.
storeRequest -- Optional:YES DefaultVal:FalseStore the originating Request information if this parameter is true. The default value is false.
persistenceType -- Optional:YES DefaultVal:VARIABLEThe type of the persistence storage to save the Response/Request information.
fileType -- Optional:YES DefaultVal:JSONThe Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"

restVerifyResponse

public static DriverCommand restVerifyResponse(java.lang.String responseID,
                                               java.lang.String benchFile,
                                               java.lang.String fileType,
                                               java.lang.String result,
                                               java.lang.String verifyRequest,
                                               java.lang.String valueContains,
                                               java.lang.String valueCaseSensitive)

Verify a REST response is what is expected.
                    Retrieve a REST response according to the responseID, and compare the response with
                    the content stored in a bench file.
                    The comparison should be defined by parameter verifyRequest, valueContains and valueCaseSensitive.
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

responseID - Optional:NO The ID used to retrieve Response Object from internal Map.

benchFile - Optional:NO The bench file for verifying a REST response.

fileType - Optional:YES DefaultVal:JSONThe Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"

result - Optional:YES DefaultVal:.verification.result The variable holding the verification result.

verifyRequest - Optional:YES DefaultVal:FALSE If it is true, then verify also the Request; otherwise only the Response will be verified. The default value is 'false', which means only the Response will be verified.

valueContains - Optional:YES DefaultVal:FALSE If true, then verify that Response/Request field's value contains that in benchFile; Otherwise, then verify that Response/Request field's value matches wholly with that in benchFile; The default value is false;

valueCaseSensitive - Optional:YES DefaultVal:TRUE If true, then verify that Response/Request field's value matches case sensitively with that in benchFile; Otherwise, then verify that Response/Request field's value matches case insensitively with that in benchFile; The default value is true;

restVerifyResponse

public static DriverCommand restVerifyResponse(java.lang.String[] parameters)

Verify a REST response is what is expected.
                    Retrieve a REST response according to the responseID, and compare the response with
                    the content stored in a bench file.
                    The comparison should be defined by parameter verifyRequest, valueContains and valueCaseSensitive.
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

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

responseID -- Optional:NO The ID used to retrieve Response Object from internal Map.
benchFile -- Optional:NO The bench file for verifying a REST response.
fileType -- Optional:YES DefaultVal:JSONThe Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"
result -- Optional:YES DefaultVal:.verification.result The variable holding the verification result.
verifyRequest -- Optional:YES DefaultVal:FALSE If it is true, then verify also the Request; otherwise only the Response will be verified. The default value is 'false', which means only the Response will be verified.
valueContains -- Optional:YES DefaultVal:FALSE If true, then verify that Response/Request field's value contains that in benchFile; Otherwise, then verify that Response/Request field's value matches wholly with that in benchFile; The default value is false;
valueCaseSensitive -- Optional:YES DefaultVal:TRUE If true, then verify that Response/Request field's value matches case sensitively with that in benchFile; Otherwise, then verify that Response/Request field's value matches case insensitively with that in benchFile; The default value is true;

restVerifyResponseContains

public static DriverCommand restVerifyResponseContains(java.lang.String responseID,
                                                       java.lang.String benchFile,
                                                       java.lang.String fileType,
                                                       java.lang.String result,
                                                       java.lang.String verifyRequest,
                                                       java.lang.String valueContains,
                                                       java.lang.String valueCaseSensitive)

Verify a REST response contains what is expected.
                    Retrieve a REST response according to the responseID, and verify that the response contains
                    the content stored in a bench file.
                    The Contains in keyword RestVerifyResponseContains means the Response/Request contains the fields
                    defined in the bench file, that is to say not all fields of Response/Request should be matched
                    For the field's value, it should be defined by parameter valueContains and valueCaseSensitive.
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

responseID - Optional:NO The ID used to retrieve Response Object from internal Map.

benchFile - Optional:NO The bench file for verifying a REST response.

fileType - Optional:YES DefaultVal:JSONThe Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"

result - Optional:YES DefaultVal:.verification.result The variable holding the verification result.

verifyRequest - Optional:YES DefaultVal:FALSE If it is true, then verify also the Request; otherwise only the Response will be verified. The default value is 'false', which means only the Response will be verified.

valueContains - Optional:YES DefaultVal:FALSE If true, then verify that Response/Request field's value contains that in benchFile; Otherwise, then verify that Response/Request field's value matches wholly with that in benchFile; The default value is false;

valueCaseSensitive - Optional:YES DefaultVal:TRUE If true, then verify that Response/Request field's value matches case sensitively with that in benchFile; Otherwise, then verify that Response/Request field's value matches case insensitively with that in benchFile; The default value is true;

restVerifyResponseContains

public static DriverCommand restVerifyResponseContains(java.lang.String[] parameters)

Verify a REST response contains what is expected.
                    Retrieve a REST response according to the responseID, and verify that the response contains
                    the content stored in a bench file.
                    The Contains in keyword RestVerifyResponseContains means the Response/Request contains the fields
                    defined in the bench file, that is to say not all fields of Response/Request should be matched
                    For the field's value, it should be defined by parameter valueContains and valueCaseSensitive.
                    

Supporting Engines:

• SAFS TIDDriverCommands

Parameters:

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

responseID -- Optional:NO The ID used to retrieve Response Object from internal Map.
benchFile -- Optional:NO The bench file for verifying a REST response.
fileType -- Optional:YES DefaultVal:JSONThe Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"
result -- Optional:YES DefaultVal:.verification.result The variable holding the verification result.
verifyRequest -- Optional:YES DefaultVal:FALSE If it is true, then verify also the Request; otherwise only the Response will be verified. The default value is 'false', which means only the Response will be verified.
valueContains -- Optional:YES DefaultVal:FALSE If true, then verify that Response/Request field's value contains that in benchFile; Otherwise, then verify that Response/Request field's value matches wholly with that in benchFile; The default value is false;
valueCaseSensitive -- Optional:YES DefaultVal:TRUE If true, then verify that Response/Request field's value matches case sensitively with that in benchFile; Otherwise, then verify that Response/Request field's value matches case insensitively with that in benchFile; The default value is true;

cleanString

public static DriverCommand cleanString(java.lang.String sourceString,
                                        java.lang.String resultVar)

          CleanString, for each char in string: if ((char .gt. 31) and (char .lt. 127)) keep it,
          otherwise turn it into a space
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

cleanString

public static DriverCommand cleanString(java.lang.String[] parameters)

          CleanString, for each char in string: if ((char .gt. 31) and (char .lt. 127)) keep it,
          otherwise turn it into a space
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

compare

public static DriverCommand compare(java.lang.String sourceString,
                                    java.lang.String dstString,
                                    java.lang.String resultVar,
                                    java.lang.String regexMatch)

          Compares two strings and returns an integer specifying the
          result of the comparison.
          The java version returns 'true' or 'false' as the result.
        
          For java version, if the parameter 'regexMatch' is true, then
          the parameter 'dstString' is considered as regular expression.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

sourceString - Optional:NO The source string (could come from a ^variable) to compare.

dstString - Optional:NO The destination string (could come from a ^variable) to compare.

resultVar - Optional:NO the resultVar to place the result of the operation into

regexMatch - Optional:YES DefaultVal:false Indicates if the comparison is in regex way.

compare

public static DriverCommand compare(java.lang.String[] parameters)

          Compares two strings and returns an integer specifying the
          result of the comparison.
          The java version returns 'true' or 'false' as the result.
        
          For java version, if the parameter 'regexMatch' is true, then
          the parameter 'dstString' is considered as regular expression.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO The source string (could come from a ^variable) to compare.
dstString -- Optional:NO The destination string (could come from a ^variable) to compare.
resultVar -- Optional:NO the resultVar to place the result of the operation into
regexMatch -- Optional:YES DefaultVal:false Indicates if the comparison is in regex way.

concatenate

public static DriverCommand concatenate(java.lang.String string1,
                                        java.lang.String string2,
                                        java.lang.String resultVar)

          Concatenate String1 with String2 and returns concatenated string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO string1 (could come from a ^variable)

string2 - Optional:NO string2 (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

concatenate

public static DriverCommand concatenate(java.lang.String[] parameters)

          Concatenate String1 with String2 and returns concatenated string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

string1 -- Optional:NO string1 (could come from a ^variable)
string2 -- Optional:NO string2 (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

getField

public static DriverCommand getField(java.lang.String inputString,
                                     java.lang.String index,
                                     java.lang.String delimiter,
                                     java.lang.String resultVar)

          GetField, get a field out of a string using specified delimiter(s). Note that any leading or trailing whitespaces are still present.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

inputString - Optional:NO The input string which contains the field to be returned

index - Optional:NO 0-based index of which field to return

delimiter - Optional:NO delimiter(s) - one or more single characters used as delimiters

resultVar - Optional:NO the variable name to store the returned field in

getField

public static DriverCommand getField(java.lang.String[] parameters)

          GetField, get a field out of a string using specified delimiter(s). Note that any leading or trailing whitespaces are still present.
            

Supporting Engines:

• Rational Robot
• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

inputString -- Optional:NO The input string which contains the field to be returned
index -- Optional:NO 0-based index of which field to return
delimiter -- Optional:NO delimiter(s) - one or more single characters used as delimiters
resultVar -- Optional:NO the variable name to store the returned field in

getFieldCount

public static DriverCommand getFieldCount(java.lang.String string1,
                                          java.lang.String startindex,
                                          java.lang.String delimiters,
                                          java.lang.String resultVar)

          GetFieldCount, Finds the count of all fields within the
          inputRecord found from startindex to the end of the inputRecord.  
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO String1 to parse and count fields

startindex - Optional:NO 0-based startindex for parsing the string.

delimiters - Optional:NO delimiters -- each character is treated as a separate delimiter.

resultVar - Optional:NO the resultVar to place the result of the operation into

getFieldCount

public static DriverCommand getFieldCount(java.lang.String[] parameters)

          GetFieldCount, Finds the count of all fields within the
          inputRecord found from startindex to the end of the inputRecord.  
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

string1 -- Optional:NO String1 to parse and count fields
startindex -- Optional:NO 0-based startindex for parsing the string.
delimiters -- Optional:NO delimiters -- each character is treated as a separate delimiter.
resultVar -- Optional:NO the resultVar to place the result of the operation into

getFixedWidthField

public static DriverCommand getFixedWidthField(java.lang.String sourceString,
                                               java.lang.String fieldID,
                                               java.lang.String fixedwidth,
                                               java.lang.String resultVar)

          GetFixedWidthField, Given an Input of fixed-width
          fields, return the nth(FieldID) Field  in the record.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

fieldID - Optional:NO 0-based field to retrieve. from 0.

fixedwidth - Optional:NO the fixedwidth alotted for each field in the record

resultVar - Optional:NO the resultVar to place the result of the operation into

getFixedWidthField

public static DriverCommand getFixedWidthField(java.lang.String[] parameters)

          GetFixedWidthField, Given an Input of fixed-width
          fields, return the nth(FieldID) Field  in the record.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
fieldID -- Optional:NO 0-based field to retrieve. from 0.
fixedwidth -- Optional:NO the fixedwidth alotted for each field in the record
resultVar -- Optional:NO the resultVar to place the result of the operation into

getMultiDelimitedField

public static DriverCommand getMultiDelimitedField(java.lang.String sourceString,
                                                   java.lang.String fieldID,
                                                   java.lang.String startIndex,
                                                   java.lang.String delimiters,
                                                   java.lang.String resultVar)

Given a sourceString of delimited fields, return the nth(FieldID) Field
      in the record from startIndex.  The startIndex and fieldID are 1 based. 
        Returns a specific field from the source string found from
        startindex to the end of the sourceString.  The field and index are 1-based.
   
      The delimiter string can contain multiple characters and this string is treated
      as a single delimiter.

      For example, if delimiter = "->" then the fields of the sourceString 
      are expected to be delimited by the full delimiter string as in:

      "field1->field2->field3"
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO Source string in which to search for first delimited character

fieldID - Optional:NO The one based index of the field to find and return.

startIndex - Optional:NO Integer (1-based) start position for search in sourceString

delimiters - Optional:NO String list of delimiters to find

resultVar - Optional:NO Name of DDVariable that will receive the result.

getMultiDelimitedField

public static DriverCommand getMultiDelimitedField(java.lang.String[] parameters)

Given a sourceString of delimited fields, return the nth(FieldID) Field
      in the record from startIndex.  The startIndex and fieldID are 1 based. 
        Returns a specific field from the source string found from
        startindex to the end of the sourceString.  The field and index are 1-based.
   
      The delimiter string can contain multiple characters and this string is treated
      as a single delimiter.

      For example, if delimiter = "->" then the fields of the sourceString 
      are expected to be delimited by the full delimiter string as in:

      "field1->field2->field3"
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO Source string in which to search for first delimited character
fieldID -- Optional:NO The one based index of the field to find and return.
startIndex -- Optional:NO Integer (1-based) start position for search in sourceString
delimiters -- Optional:NO String list of delimiters to find
resultVar -- Optional:NO Name of DDVariable that will receive the result.

getMultiDelimitedFieldCount

public static DriverCommand getMultiDelimitedFieldCount(java.lang.String string1,
                                                        java.lang.String startIndex,
                                                        java.lang.String delimiters,
                                                        java.lang.String resultVar)

Finds the count of all fields within the inputRecord found from
        startindex to the end of the inputRecord.  The field and index are 1-based.
        Finds the count of all fields within the inputRecord found from
        startindex to the end of the inputRecord.  The field and index are 1-based.
        Blank fields count The next field starts at the next
        character index even if that char is also a delimiter.
        If the last character in the inputRecord is a delimiter, then the
        field it terminates is the last field in the inputRecord.

      Field #1 index is always the same as startindex--even if the character at 
      the startindex position is a delimiter.

      The delimiter string can contain multiple characters and this string is treated
      as a single delimiter.

      For example, if delimiter = "->" then the fields of the inputRecord 
      are expected to be delimited by the full delimiter string as in:

      "field1->field2->field3"
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO Source String in which to search for first delimited character

startIndex - Optional:NO Integer (1-based) start position for search in inputRecord

delimiters - Optional:NO String list of delimiters to find

resultVar - Optional:NO Name of DDVariable to receive the result

getMultiDelimitedFieldCount

public static DriverCommand getMultiDelimitedFieldCount(java.lang.String[] parameters)

Finds the count of all fields within the inputRecord found from
        startindex to the end of the inputRecord.  The field and index are 1-based.
        Finds the count of all fields within the inputRecord found from
        startindex to the end of the inputRecord.  The field and index are 1-based.
        Blank fields count The next field starts at the next
        character index even if that char is also a delimiter.
        If the last character in the inputRecord is a delimiter, then the
        field it terminates is the last field in the inputRecord.

      Field #1 index is always the same as startindex--even if the character at 
      the startindex position is a delimiter.

      The delimiter string can contain multiple characters and this string is treated
      as a single delimiter.

      For example, if delimiter = "->" then the fields of the inputRecord 
      are expected to be delimited by the full delimiter string as in:

      "field1->field2->field3"
           

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

string1 -- Optional:NO Source String in which to search for first delimited character
startIndex -- Optional:NO Integer (1-based) start position for search in inputRecord
delimiters -- Optional:NO String list of delimiters to find
resultVar -- Optional:NO Name of DDVariable to receive the result

getNextDelimiterIndex

public static DriverCommand getNextDelimiterIndex(java.lang.String string1,
                                                  java.lang.String startindex,
                                                  java.lang.String delimiters,
                                                  java.lang.String resultVar)

          GetNextDelimiterIndex, Finds the index of the first
          character matching one of the provided delimiter characters.
          The search begins at startindex within the inputRecord. 
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO String1 to parse for field delimiters

startindex - Optional:NO 0-based startindex to begin parsing the string.

delimiters - Optional:NO delimiters -- each character is treated as a separate delimiter.

resultVar - Optional:NO the resultVar to place the result of the operation into

getNextDelimiterIndex

public static DriverCommand getNextDelimiterIndex(java.lang.String[] parameters)

          GetNextDelimiterIndex, Finds the index of the first
          character matching one of the provided delimiter characters.
          The search begins at startindex within the inputRecord. 
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

string1 -- Optional:NO String1 to parse for field delimiters
startindex -- Optional:NO 0-based startindex to begin parsing the string.
delimiters -- Optional:NO delimiters -- each character is treated as a separate delimiter.
resultVar -- Optional:NO the resultVar to place the result of the operation into

getREDelimitedField

public static DriverCommand getREDelimitedField(java.lang.String inputString,
                                                java.lang.String index,
                                                java.lang.String regExp,
                                                java.lang.String resultVar)

          GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

inputString - Optional:NO The input string to analyze.

index - Optional:NO 1-based index of the field to return from the input string.

regExp - Optional:NO RegExp - This string contains a regular expression used as the delimiter(s). These should conform to the regular expressions defined in "java.util.regex.Pattern" documentation.

resultVar - Optional:NO resultVar contains the requested field from the input string.

getREDelimitedField

public static DriverCommand getREDelimitedField(java.lang.String[] parameters)

          GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

inputString -- Optional:NO The input string to analyze.
index -- Optional:NO 1-based index of the field to return from the input string.
regExp -- Optional:NO RegExp - This string contains a regular expression used as the delimiter(s). These should conform to the regular expressions defined in "java.util.regex.Pattern" documentation.
resultVar -- Optional:NO resultVar contains the requested field from the input string.

getREDelimitedFieldCount

public static DriverCommand getREDelimitedFieldCount(java.lang.String inputString,
                                                     java.lang.String index,
                                                     java.lang.String regExp,
                                                     java.lang.String resultVar)

          GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

inputString - Optional:NO The input string to analyze.

index - Optional:NO 0-based index of where to start the analysis from. The index should be less than or equal to the length of the input string.

regExp - Optional:NO RegExp - This string contains a regular expression used as the delimiter(s). These should conform to the regular expressions defined in "java.util.regex.Pattern" documentation.

resultVar - Optional:NO resultVar contains the number of fields in the input string.

getREDelimitedFieldCount

public static DriverCommand getREDelimitedFieldCount(java.lang.String[] parameters)

          GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

inputString -- Optional:NO The input string to analyze.
index -- Optional:NO 0-based index of where to start the analysis from. The index should be less than or equal to the length of the input string.
regExp -- Optional:NO RegExp - This string contains a regular expression used as the delimiter(s). These should conform to the regular expressions defined in "java.util.regex.Pattern" documentation.
resultVar -- Optional:NO resultVar contains the number of fields in the input string.

getSubstringsInString

public static DriverCommand getSubstringsInString(java.lang.String string,
                                                  java.lang.String regexStart,
                                                  java.lang.String regexStop,
                                                  java.lang.String varName)

 
                  Extract dynamic substring from a string using regular expressions.
                
                  
                  This command sets a DDVariable for each substring formed between regexstart and regexstop (1 match per string, currently).  Both regexstart and regexstop must be valid, non-empty strings or no matching substring will be found.
                  
                  The string is parsed, searching the substring between regexstart and regexstop matches.
                  
                  When a match is found, the string between regexstart and regexstop is saved in a newly created DDVariable with the name given in varname.
                  
                   

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

string - Optional:NO String to search for substring.

regexStart - Optional:NO The starting regular expression. Should not be empty.

regexStop - Optional:NO The stopping regular expression. Should not be empty.

varName - Optional:NO The name of the variable to contain the substring.

getSubstringsInString

public static DriverCommand getSubstringsInString(java.lang.String[] parameters)

 
                  Extract dynamic substring from a string using regular expressions.
                
                  
                  This command sets a DDVariable for each substring formed between regexstart and regexstop (1 match per string, currently).  Both regexstart and regexstop must be valid, non-empty strings or no matching substring will be found.
                  
                  The string is parsed, searching the substring between regexstart and regexstop matches.
                  
                  When a match is found, the string between regexstart and regexstop is saved in a newly created DDVariable with the name given in varname.
                  
                   

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

string -- Optional:NO String to search for substring.
regexStart -- Optional:NO The starting regular expression. Should not be empty.
regexStop -- Optional:NO The stopping regular expression. Should not be empty.
varName -- Optional:NO The name of the variable to contain the substring.

getSystemEnviron

public static DriverCommand getSystemEnviron(java.lang.String string1,
                                             java.lang.String resultVar)

          GetSystemEnviron, get a system environment variable value
            

Supporting Engines:

• Rational RobotJ
• Rational Robot
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

string1 - Optional:NO String1

resultVar - Optional:NO the resultVar to place the result of the operation into

getSystemEnviron

public static DriverCommand getSystemEnviron(java.lang.String[] parameters)

          GetSystemEnviron, get a system environment variable value
            

Supporting Engines:

• Rational RobotJ
• Rational Robot
• SAFS TIDDriverCommands
• SAFS SDCommands
• OpenQA Selenium

Parameters:

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

string1 -- Optional:NO String1
resultVar -- Optional:NO the resultVar to place the result of the operation into

getSystemUser

public static DriverCommand getSystemUser(java.lang.String resultVar)

          Get the USERID of the currently logged on user as stored in System Environment variables.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

resultVar - Optional:NO the resultVar to place the USERID into

getTrimmedField

public static DriverCommand getTrimmedField(java.lang.String string1,
                                            java.lang.String index,
                                            java.lang.String delimiter,
                                            java.lang.String resultVar)

          GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

string1 - Optional:NO string1

index - Optional:NO 0-based index of which field to grab

delimiter - Optional:NO delimiter

resultVar - Optional:NO the resultVar to place the result of the operation into

getTrimmedField

public static DriverCommand getTrimmedField(java.lang.String[] parameters)

          GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

string1 -- Optional:NO string1
index -- Optional:NO 0-based index of which field to grab
delimiter -- Optional:NO delimiter
resultVar -- Optional:NO the resultVar to place the result of the operation into

index

public static DriverCommand index(java.lang.String start,
                                  java.lang.String sourceString,
                                  java.lang.String findString,
                                  java.lang.String resultVar)

          Returns the position of the first occurrence of one string
          within another string. -1 if not found at all
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

start - Optional:NO 0-based starting offset of the sourceString to search

sourceString - Optional:NO sourceString (could come from a ^variable)

findString - Optional:NO findString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

index

public static DriverCommand index(java.lang.String[] parameters)

          Returns the position of the first occurrence of one string
          within another string. -1 if not found at all
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

start -- Optional:NO 0-based starting offset of the sourceString to search
sourceString -- Optional:NO sourceString (could come from a ^variable)
findString -- Optional:NO findString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

left

public static DriverCommand left(java.lang.String sourceString,
                                 java.lang.String length,
                                 java.lang.String resultVar)

          Returns a string of a specified number of characters copied from the beginning of another string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

length - Optional:NO number of chars to copy

resultVar - Optional:NO the resultVar to place the result of the operation into

left

public static DriverCommand left(java.lang.String[] parameters)

          Returns a string of a specified number of characters copied from the beginning of another string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
length -- Optional:NO number of chars to copy
resultVar -- Optional:NO the resultVar to place the result of the operation into

leftTrim

public static DriverCommand leftTrim(java.lang.String sourceString,
                                     java.lang.String resultVar)

          A new string trimmed of leading tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

leftTrim

public static DriverCommand leftTrim(java.lang.String[] parameters)

          A new string trimmed of leading tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

length

public static DriverCommand length(java.lang.String sourceString,
                                   java.lang.String resultVar)

          Returns the length of a string or variable.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the length operation into

length

public static DriverCommand length(java.lang.String[] parameters)

          Returns the length of a string or variable.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the length operation into

replace

public static DriverCommand replace(java.lang.String sourceString,
                                    java.lang.String findString,
                                    java.lang.String replaceString,
                                    java.lang.String resultVar)

          Replace 'find' substring with 'replace' substring
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

findString - Optional:NO findString (could come from a ^variable)

replaceString - Optional:NO replaceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

replace

public static DriverCommand replace(java.lang.String[] parameters)

          Replace 'find' substring with 'replace' substring
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
findString -- Optional:NO findString (could come from a ^variable)
replaceString -- Optional:NO replaceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

right

public static DriverCommand right(java.lang.String sourceString,
                                  java.lang.String length,
                                  java.lang.String resultVar)

          Returns a string of a specified number of characters copied from the end of another string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

length - Optional:NO length

resultVar - Optional:NO the resultVar to place the result of the operation into

right

public static DriverCommand right(java.lang.String[] parameters)

          Returns a string of a specified number of characters copied from the end of another string.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
length -- Optional:NO length
resultVar -- Optional:NO the resultVar to place the result of the operation into

rightTrim

public static DriverCommand rightTrim(java.lang.String sourceString,
                                      java.lang.String resultVar)

          A new string trimmed of trailing tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

rightTrim

public static DriverCommand rightTrim(java.lang.String[] parameters)

          A new string trimmed of trailing tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

subString

public static DriverCommand subString(java.lang.String sourceString,
                                      java.lang.String start,
                                      java.lang.String length,
                                      java.lang.String resultVar)

          Returns a portion of a string based on character index.
        
          The substring  to retrieve starts at the specified start
          character index and ends after the specified number of characters have been copied.  If the number of characters to copy is not provided, then we will return all characters after the start index.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

start - Optional:NO starting 0-based offset character position

length - Optional:YES number of chars to copy. If not provided or less than 1 then all characters after the start index will be retrieved.

resultVar - Optional:NO the resultVar to place the result of the operation into

subString

public static DriverCommand subString(java.lang.String[] parameters)

          Returns a portion of a string based on character index.
        
          The substring  to retrieve starts at the specified start
          character index and ends after the specified number of characters have been copied.  If the number of characters to copy is not provided, then we will return all characters after the start index.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
start -- Optional:NO starting 0-based offset character position
length -- Optional:YES number of chars to copy. If not provided or less than 1 then all characters after the start index will be retrieved.
resultVar -- Optional:NO the resultVar to place the result of the operation into

toLowerCase

public static DriverCommand toLowerCase(java.lang.String sourceString,
                                        java.lang.String resultVar)

          Returns a copy of a string, with all letters converted to lowercase.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

toLowerCase

public static DriverCommand toLowerCase(java.lang.String[] parameters)

          Returns a copy of a string, with all letters converted to lowercase.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

toUpperCase

public static DriverCommand toUpperCase(java.lang.String sourceString,
                                        java.lang.String resultVar)

          Returns a copy of a string after converting all letters to uppercase.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

toUpperCase

public static DriverCommand toUpperCase(java.lang.String[] parameters)

          Returns a copy of a string after converting all letters to uppercase.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

trim

public static DriverCommand trim(java.lang.String sourceString,
                                 java.lang.String resultVar)

          A new string trimmed of leading and trailing tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

sourceString - Optional:NO sourceString (could come from a ^variable)

resultVar - Optional:NO the resultVar to place the result of the operation into

trim

public static DriverCommand trim(java.lang.String[] parameters)

          A new string trimmed of leading and trailing tabs and spaces.
            

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands
• Rational Robot
• OpenQA Selenium

Parameters:

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

sourceString -- Optional:NO sourceString (could come from a ^variable)
resultVar -- Optional:NO the resultVar to place the result of the operation into

resetTimer

public static DriverCommand resetTimer(java.lang.String timerName)

                Reset a "stopped" timer for reuse.
                
                Returns internal status values to a reset state. This allows the timer to be used again with 
                a new start time when StartTimer is called with the same name as this timer. It should be 
                considered an error to attempt to reset a timer that is active (not stopped).
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

startTimer

public static DriverCommand startTimer(java.lang.String timerName,
                                       java.lang.String verifyValue)

                Will start a unique timer.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue - Optional:YES verifyValue will be used to verify the timer was less then then given value. If the parameter isn't given then no check will occur.

startTimer

public static DriverCommand startTimer(java.lang.String[] parameters)

                Will start a unique timer.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

timerName -- Optional:NO timerName (should be unique)
verifyValue -- Optional:YES verifyValue will be used to verify the timer was less then then given value. If the parameter isn't given then no check will occur.

stopTimer

public static DriverCommand stopTimer(java.lang.String timerName)

                Will end a unique timer and perform a verify test if a value was supplied at start time.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

storeTimerInfo

public static DriverCommand storeTimerInfo(java.lang.String timerName,
                                           java.lang.String variable)

                Well store the timer information in the given variable.
                Information stored:
                
                  
                    .elapsed - Amount of seconds that has passed.
                  
                  
                    .startTime - Time that the timer was started.
                  
                  
                    .endTime - Time that the timer was stopped.
                  
                  
                    .failures - Number of failures that happened on the timer (based on verify commands).
                  
                
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

variable - Optional:No variable to store time information in.

storeTimerInfo

public static DriverCommand storeTimerInfo(java.lang.String[] parameters)

                Well store the timer information in the given variable.
                Information stored:
                
                  
                    .elapsed - Amount of seconds that has passed.
                  
                  
                    .startTime - Time that the timer was started.
                  
                  
                    .endTime - Time that the timer was stopped.
                  
                  
                    .failures - Number of failures that happened on the timer (based on verify commands).
                  
                
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

timerName -- Optional:NO timerName (should be unique)
variable -- Optional:No variable to store time information in.

storeTimerInfoFile

public static DriverCommand storeTimerInfoFile(java.lang.String timerName,
                                               java.lang.String fileLoc)

                Well store the timer information in the given file, in csv format. Will use absolute path if given otherwise uses SAFS Project Directory.
                Information Stored:Name,Start,Stop,Duration,Timeout,Pass?
                
                  
                    Name - Name of timer
                  
                  
                    Start - Time of start
                  
                  
                    Stop - Time of stop
                  
                  
                    Duration - total elapsed time.
                  
                  
                    Timeout - 
                  
                  
                    Pass? - if the timer passed any verfiy commands.
                  
                
                Variable TimerStorageVariables can list additional variables to be stored in the file (comma delimited).
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

fileLoc - Optional:No fileLoc is the location of the file to write (including filename). If an absolute path is given then it is used other wise the default path is SAFS Project Directory. If the file exists it is just appended to.

storeTimerInfoFile

public static DriverCommand storeTimerInfoFile(java.lang.String[] parameters)

                Well store the timer information in the given file, in csv format. Will use absolute path if given otherwise uses SAFS Project Directory.
                Information Stored:Name,Start,Stop,Duration,Timeout,Pass?
                
                  
                    Name - Name of timer
                  
                  
                    Start - Time of start
                  
                  
                    Stop - Time of stop
                  
                  
                    Duration - total elapsed time.
                  
                  
                    Timeout - 
                  
                  
                    Pass? - if the timer passed any verfiy commands.
                  
                
                Variable TimerStorageVariables can list additional variables to be stored in the file (comma delimited).
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

timerName -- Optional:NO timerName (should be unique)
fileLoc -- Optional:No fileLoc is the location of the file to write (including filename). If an absolute path is given then it is used other wise the default path is SAFS Project Directory. If the file exists it is just appended to.

verifyElapsedTimeInRange

public static DriverCommand verifyElapsedTimeInRange(java.lang.String timerName,
                                                     java.lang.String verifyValue1,
                                                     java.lang.String verifyValue2)

                Well verify that a timer was in the range of the given values.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue1 - Optional:No verifyValue1 will be used as the lower bounds of the check.

verifyValue2 - Optional:No verifyValue2 will be used as the higher bounds of the check.

verifyElapsedTimeInRange

public static DriverCommand verifyElapsedTimeInRange(java.lang.String[] parameters)

                Well verify that a timer was in the range of the given values.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

timerName -- Optional:NO timerName (should be unique)
verifyValue1 -- Optional:No verifyValue1 will be used as the lower bounds of the check.
verifyValue2 -- Optional:No verifyValue2 will be used as the higher bounds of the check.

verifyElapsedTimeIsLess

public static DriverCommand verifyElapsedTimeIsLess(java.lang.String timerName,
                                                    java.lang.String verifyValue)

                Well verify that a timer was less then the given value.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue - Optional:No verifyValue will be used to as the check value.

verifyElapsedTimeIsLess

public static DriverCommand verifyElapsedTimeIsLess(java.lang.String[] parameters)

                Well verify that a timer was less then the given value.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

timerName -- Optional:NO timerName (should be unique)
verifyValue -- Optional:No verifyValue will be used to as the check value.

verifyElapsedTimeIsMore

public static DriverCommand verifyElapsedTimeIsMore(java.lang.String timerName,
                                                    java.lang.String verifyValue)

                Well verify that a timer was greater then the given value.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue - Optional:No verifyValue will be used to as the check value.

verifyElapsedTimeIsMore

public static DriverCommand verifyElapsedTimeIsMore(java.lang.String[] parameters)

                Well verify that a timer was greater then the given value.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

timerName -- Optional:NO timerName (should be unique)
verifyValue -- Optional:No verifyValue will be used to as the check value.

verifyTimer

public static DriverCommand verifyTimer(java.lang.String timerName,
                                        java.lang.String verifyValue)

                Well verify that a timer was less then the given value.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

timerName - Optional:NO timerName (should be unique)

verifyValue - Optional:YES verifyValue will be used to as the check value. If nothing is given then the value given during StartTimer will be use, if nothing was given then the value -1 is used.

verifyTimer

public static DriverCommand verifyTimer(java.lang.String[] parameters)

                Well verify that a timer was less then the given value.
                    

Supporting Engines:

• Rational RobotJ
• SAFS TIDDriverCommands
• SAFS SDCommands

Parameters:

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

timerName -- Optional:NO timerName (should be unique)
verifyValue -- Optional:YES verifyValue will be used to as the check value. If nothing is given then the value given during StartTimer will be use, if nothing was given then the value -1 is used.

endRequirement

public static DriverCommand endRequirement(java.lang.String requirementID)

        DEPRECATED. Use StopRequirement instead.
          Log/process the end of testing associated with a user-defined Requirement.
          Currently no processing is done with this.  Only a log entry occurs.
          Use StopRequirement which now implements the original intent of this command.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner

Parameters:

requirementID - Optional:YES The user-defined ID of the Requirement

endTestcase

public static DriverCommand endTestcase(java.lang.String testCaseID)

        DEPRECATED. Use StopTestCase instead.
          Log/process the end of testing associated with a user-defined Testcase.
          Currently no processing is done with this.  Only a log entry occurs.
          Use StopTestCase which now implements the original intent of this command.
          
          In addition to the above, WRAFS will close the node created by the SETTESTCASE
          command in the log file.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner

Parameters:

testCaseID - Optional:YES The user-defined ID of the Testcase.

getVariableValueEx

public static DriverCommand getVariableValueEx(java.lang.String sourceVariable,
                                               java.lang.String destinationVariable)

 
                 Replaced by CopyVariableValueEx    

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner

Parameters:

sourceVariable - Optional:NO The name of the variable to retrieve the value of

destinationVariable - Optional:NO The name of the variable to hold the retrieved value

getVariableValueEx

public static DriverCommand getVariableValueEx(java.lang.String[] parameters)

 
                 Replaced by CopyVariableValueEx    

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner

Parameters:

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

sourceVariable -- Optional:NO The name of the variable to retrieve the value of
destinationVariable -- Optional:NO The name of the variable to hold the retrieved value

setRequirement

public static DriverCommand setRequirement(java.lang.String requirementID,
                                           java.lang.String description)

        DEPRECATED. Use StartRequirement instead.
          Log/process the beginning of testing associated with a user-defined Requirement.
          Currently no processing is done with this.  Only a log entry occurs.
          Use StartRequirement which now implements the original intent of this command.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner

Parameters:

requirementID - Optional:NO The user-defined ID of the Requirement

description - Optional:YES A description of the Requirement

setRequirement

public static DriverCommand setRequirement(java.lang.String[] parameters)

        DEPRECATED. Use StartRequirement instead.
          Log/process the beginning of testing associated with a user-defined Requirement.
          Currently no processing is done with this.  Only a log entry occurs.
          Use StartRequirement which now implements the original intent of this command.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner

Parameters:

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

requirementID -- Optional:NO The user-defined ID of the Requirement
description -- Optional:YES A description of the Requirement

setTestcase

public static DriverCommand setTestcase(java.lang.String testCaseID,
                                        java.lang.String description)

        DEPRECATED. Use StartTestCase instead.
          Log/process the beginning of testing associated with a user-defined Testcase.
          Currently no processing is done with this.  Only a log entry occurs.
          Use StartTestCase which now implements the original intent of this command.
          
          In addition to the above functionality, WRAFS will create a new node in the 
          log used by Winrunner. Care should be taken to only use one SETTESTCASE at a time,
          nesting these will have unpredictable results.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner

Parameters:

testCaseID - Optional:NO The user-defined ID of the Testcase.

description - Optional:YES A description of the Testcase

setTestcase

public static DriverCommand setTestcase(java.lang.String[] parameters)

        DEPRECATED. Use StartTestCase instead.
          Log/process the beginning of testing associated with a user-defined Testcase.
          Currently no processing is done with this.  Only a log entry occurs.
          Use StartTestCase which now implements the original intent of this command.
          
          In addition to the above functionality, WRAFS will create a new node in the 
          log used by Winrunner. Care should be taken to only use one SETTESTCASE at a time,
          nesting these will have unpredictable results.
            

Supporting Engines:

• Rational Robot
• Mercury Interactive WinRunner

Parameters:

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

testCaseID -- Optional:NO The user-defined ID of the Testcase.
description -- Optional:YES A description of the Testcase