SAFS Selenium Quick Reference

Last Updated:

Goto: Driver Commands, Component Functions, Engine Commands, Detailed Reference Doc


DRIVER COMMANDS

DDDriverCommands [How To Read This Reference]
AppMapChaining
SDC TID
Enable and Disable support for App Map chaining.
AppMapResolve
SDC TID
Enable and Disable support for embedded DDVariables in App Map strings.
AssignClipboardVariable
TID SDC SE2
Copy the clipboard contents to a DDVariable.
CallRemote
TID SDC SE2
Execute a command on an external system / application.
CaptureMousePositionOnScreen
SDC TID SE2
Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
ClearAllVariables
SDC SE2
Clear storage of all DDVariables.
ClearAppMapCache
SE SE2
Clear the internal application map cache.
ClearArrayVariables
SDC SE2
Clear storage of all SAFS variables containing a specific prefix.
ClearClipboard
TID SDC SE2
Clear the contents of the Window's clipboard.
CloseApplication
TID SDC SE2
Close a named application process launched with LaunchApplication.
CloseApplicationMap
TID SE2
By map ID, Close a opened Application Map in map chain.
CopyVariableValueEx
TID SDC SE2
Copy the value of a (dynamic) DDVariable to another.
Delay
TID SDC SE2
Delay for a specified number of milliseconds.
Expressions
TID SE2
Enable and Disable enhanced expressions.
GetAppMapValue
SDC SE2
Assign a DDVariable a value from an App Map.
GetMillisBetweenRecords
TID
Get the pause between two records, and assigns the value to a DDVariable.
GetRegistryKeyValue
SDC TID SE2
Assign the value of the specified Registry Key to a variable.
GetSystemDate
TID SDC SE2
Assigns the string value of the system date to a DDVariable.
GetSystemDateTime
TID SDC SE2
Assigns the string value of the system datetime to a DDVariable.
GetSystemTime
TID SDC SE2
Assigns the string value of the current system time to a DDVariable.
GetURL
SE2
Send an HTTP GET request, and get the response.
GetVersion
TID SDC
Get the engine VERSION
HighLight
SE2
Turn on or off the component highlight functionality.
LaunchApplication
TID SDC SE2
Identify and Launch a specified application
NotifyAndWait
TID SDC
Display a user-defined message dialog and wait until dismissed.
Pause
TID SDC SE2
Pause for a specified number of seconds.
SaveClipboardToFile
TID SDC SE2
Save the clipboard contents to a text file.
SaveURLToFile
SE2
Send an HTTP GET request, and save the response into a file.
ScrollWheel
SE2
Move mouse wheel forward (up) or backward (down).
SendEmail
TID SE2
Send email notification with attachments.
SetApplicationMap
TID SE2
Provide the Application Map for the DDE to use
SetBenchDirectory
TID SDC
Set/Change the directory in which the framework will find benchmark files by default.
SetClipboard
TID SDC SE2
Set the clipboard contents to a string.
SetContext
SE
Set a Window or Window Component as the current Robot context.
SetDifDirectory
TID SDC
Set/Change the directory in which the framework will locate file compare differences.
SetFocus
SE
Give a Window or Window Component input focus.
SetImageDebug
TID SE2
Enable/Disable verbose debug log output and high-res failure snapshots.
SetImageFuzzyMatching
TID SE2
Enable/Disable Image-Based Testing Fuzzy Matching.
SetMillisBetweenRecords
TID
Set the pause between two records.
SetMultipleThreadSearch
TID SE2
Turn on or trun off the multi-thread-search way to search an image.
SetProjectDirectory
TID SDC
Set/Change the framework project directory.
SetRootVerifyDirectory
TID SDC
Set/Change the Bench, Test, and Dif directories to be subdirectories off of the provided path.
SetTestDirectory
TID SDC
Set/Change the directory in which the framework will find test files (captured "actuals") by default.
SetVariableValueEx
TID SDC SE2
Set the value of a DDVariable
SetVariableValues
TID SDC SE2
Preset the value of one or more DDVariables
StartWebBrowser
TID SDC SE SE2
Launch a new web browser and optionally load a document into it.
StopWebBrowser
SE2
Stop an opened web browser indicated by ID.
TakeScreenShot
TID SE2
Take screenshot and save it to a file on test machine.
UseAbbotFunctions
TID
Enable/Disable the switch to "prefer" ABBOT Functions over any other engine functions.
UseDroidFunctions
TID
Enable/Disable the switch to "prefer" Droid Functions over the current engine functions (like Robot Classic).
UseIOSFunctions
TID
Enable/Disable the switch to "prefer" IOS Functions over any other engine functions.
UseQTPFunctions
TID
Enable/Disable the switch to "prefer" QTP Functions over any other engine functions.
UseRobotJFunctions
TID
Enable/Disable the switch to "prefer" RobotJ Hook Component Functions over Robot Classic Component Functions.
UseSAFSFunctions
TID
Enable/Disable the switch to "prefer" SAFS (SDC) Functions over the current engine functions (like Robot Classic).
UseSeleniumFunctions
TID
Enable/Disable the switch to "prefer" Selenium Functions over the current engine functions (like Robot Classic).
UseTestCompleteFunctions
TID
Enable/Disable the switch to "prefer" TestComplete (TCAFS) Functions over any other engine functions.
UseWebBrowser
SE2
Switch to use an opened web browser indicated by ID.
VerifyClipboardToFile
TID SDC SE2
Verify the current contents of the Windows clipboard with a benchmark file.
VerifyURLContent
SE2
Send an HTTP GET request, and verify the response with the content provided as parameter.
VerifyURLToFile
SE2
Send an HTTP GET request, and verify the response with the content of a file.
Version
TID
Specify the table format VERSION
WaitForGUI
TID SE SE2
Wait for a Window or Window Component to become valid.
WaitForGUIGone
TID SE2
Wait for a Window or Window Component to become invalid.
WaitForRegistryKeyExists
SDC TID SE2
Wait for a Registry Key to become valid.
WaitForRegistryKeyValue
SDC TID SE2
Wait for a specific Registry KeyValue to match an expected value.
WaitForWebPage
SE
Wait for a web document to finish loading within a timeout period.

DDDriverCounterCommands [How To Read This Reference]
DeleteCounter
TID
Delete any existing private counter with the provided counterID.
LogCounterInfo
TID SE2
Log the specified counter's info in the active log(s) of the current Log Facility.
ResetCounter
TID
Create a new private counter or reset counts in an existing private counter.
ResumeStatusCounts
TID SE2
Resume counting on ALL status counters--both public/global and private.
SetCounterMode
TID
Create a new private counter or modify the mode of an existing private counter.
StartCounter
TID SE2
Create a new private counter or start an existing stopped private counter.
StartCycle
TID
Begin tracking status on a user-defined item.
StartProcedure
TID
Begin tracking status on a user-defined item.
StartRequirement
TID
Begin tracking status on a user-defined item.
StartSuite
TID SE2
Begin tracking status on a user-defined item.
StartTestcase
TID SE2
Begin tracking status on a user-defined TestCase.
StopCounter
TID SE2
Create a new private counter or suspend counts in an existing private counter.
StopCycle
TID
Stop tracking status on a user-defined item.
StopProcedure
TID
Stop tracking status on a user-defined item.
StopRequirement
TID
Stop tracking status on a user-defined item.
StopSuite
TID
Stop tracking status on a user-defined item.
StopTestcase
TID SE2
Stop tracking status on a user-defined TestCase.
StoreCounterInfo
TID SE2
Store the current values of the named counter into unique DDVariables.
SuspendStatusCounts
TID SE2
Suspend counting on ALL status counters--both public/global and private.

DDDriverDatabaseCommands [How To Read This Reference]
CopyDBTableColumnToFile
TID SDC
This routine will copy the contents of one or more DBTable column(s) to a file.
CopyDBTableToFile
TID SDC
This routine will copy the contents of a DBTable to a file.
DeleteDBTableRecords
TID SDC
Deletes records in a database table
ExecSQLQuery
TID SDC
Executes the query provided in a queryStr on the database table.
GetDBTableColumnCount
TID SDC
Executes the query in a specified database table and returns the total column count.
GetDBTableRowCount
TID SDC
Executes the query in a database table.
GetDBValue
TID SDC
Executes the query and returns the case-sensitive value as result of the execution.
SetJdbcDriver
TID SDC
set Jdbc Driver
VerifyDatabaseNullValue
TID SDC
Verifies the value of a field in a database table is NULL
VerifyDatabaseValue
TID SDC
Verifies the case-sensitive value of a field in a database table
VerifyDBNullValue
TID SDC
Verifies the value of a field in a database table is NULL
VerifyDBValue
TID SDC
Verifies the case-sensitive value of a field in a database table

DDDriverDebugCommands [How To Read This Reference]
Breakpoints
TID SDC
Enable and Disable Breakpoint Debugging.
CommandDebug
TID SDC
Enable and Disable (C)Command Debugging.
RecordsDebug
TID SDC
Enable and Disable debugging of ALL record types.
TestDebug
TID SDC
Enable and Disable (T)Test Record Debugging.

DDDriverFileCommands [How To Read This Reference]
CloseFile
TID SDC SE2
Close the open file with the file number provided
CopyFile
TID SDC SE2
Copy the specified filename to the target filename.
CopyMatchingFiles
TID SDC SE2
Copy multiple files/sub-directories, based on matching the provided pattern, from one directory to another.
CreateDirectory
TID SDC SE2
Create the directory for the provided directory pathname
CreateFile
TID SDC SE2
Open a new file with the filename, mode and access provided.TID Note: Three ways to create a file: Mode=Input, Access=ReadMode=Output, Access=WriteMode=Append, Access=Write
DeleteDirectory
TID SDC SE2
Delete the directory for the provided directory pathname
DeleteDirectoryContents
TID SDC SE2
Delete the contents (files and sub-directories) of a provided directory and optionally, the directory itself.
DeleteFile
TID SDC SE2
Delete the file for the file name provided
FilterImage
TID SDC SE2
Filter out specific parts of an image.
FilterTextFile
TID SDC SE2
Filter a text file based on the given parameters.
FindSqaFile
TID SDC
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.
GetFileDateTime
TID SDC SE2
Determine the date and time the file created/last changed/last accessed for file name provided and assign it to a DDV variable.
GetFileProtections
TID SDC SE2
Save the file attributes for the file name to the variable provided.
GetFiles
TID SDC SE2
Search the directory provided for files according to possible attribute and write the list of filenames found into the output file.
GetFileSize
TID SDC SE2
Determine the file size for file name provided and assign it to a DDV variable.
GetINIFileValue
TID SDC SE2
Get value from INI file.
GetStringCountInFile
TID SDC SE2
Count the number of occurrences of a target string in a File.
GetSubstringsInFile
TID SDC SE2
Extract dynamic substrings from a file using regular expressions.
GetTextFromImage
SDC TID SE2
Incorporate OCR technology to detect the text in an image file and save the text to a variable.
IfExistDir
TID SDC SE2
If the specified directory exists, then execute the following driver command.
IfExistFile
TID SDC SE2
If the specified file exists, then execute the following driver command.
IsEndOfFile
TID SDC SE2
If the specified file is at the end of file, a 'variable' gets true assigned, otherwise it gets false
OpenFile
TID SDC SE2
Open an existing file with the filename, mode and access provided.TID Note: Three ways to open a file: Mode=Input, Access=ReadMode=Output, Access=WriteMode=Append, Access=Write
OpenUTF8File
TID SDC SE2
Open an existing UTF-8 file with the filename, mode and access provided.TID Note: Three ways to open a file: Mode=Input, Access=ReadMode=Output, Access=WriteMode=Append, Access=Write
PrintToFile
TID SDC SE2
Write output to a sequential file already opened for writing.
ReadFileChars
TID SDC SE2
Read the number of characters from the file defined by file number and assign a string containing the characters read to a DDV variable.
ReadFileLine
TID SDC SE2
Read a line from the file defined by file number and assign a string containing the line read to a DDV variable.
RenameFile
TID SDC SE2
Rename the file from the old file name to the new filename
SaveTextFromImage
SDC TID SE2
Incorporate OCR technology to detect the text in an image file and save the text to a text file.
SetFileProtections
TID SDC SE2
Change the file attribute for the file name provided to the value of the new file protection provided.
WriteFileChars
TID SDC SE2
Write the specified number of characters to a file already opened for writing.

DDDriverFlowCommands [How To Read This Reference]
CallCycle
TID
Invoke a Cycle table (from StepDriver or SuiteDriver)
CallJUnit
Invoke one or more JUnit tests using the provided Class name(s).
CallScript
SE2
Invoke a custom script with passed parameters/variables, if desired.
CallStep
TID
Invoke a Step table from within another Step table (from StepDriver).
CallSuite
TID
Invoke a Suite table (from StepDriver or SuiteDriver)
ExitCycle
TID
Exit the currently running Step, Suite, and/or Cycle table.
ExitSuite
TID
Exit the currently running Step and/or Suite table.
ExitTable
TID
Exit the currently running Step, Suite, or Cycle table.
GotoBlockID
TID
Goto a named block in the current table.
OnContainsGotoBlockID
TID
Goto the named block in the current table if value2 is contained within value1.
OnDirectoryExistGotoBlockID
TID
Goto the named block in the current table if the directory exists.
OnDirectoryNotExistGotoBlockID
TID
Goto the named block in the current table if the Directory does not exist.
OnEqualGotoBlockID
TID
Goto the named block in the current table if two values are equal.
OnFileExistGotoBlockID
TID
Goto the named block in the current table if the file exists.
OnFileNotExistGotoBlockID
TID
Goto the named block in the current table if the file does not exist.
OnGreaterThanGotoBlockID
TID
Goto the named block in the current table if value1 is greater than value2.
OnGUIExistsGotoBlockID
TID SE SE2
Goto the named block in the current table if a GUI component exists.
OnGUINotExistGotoBlockID
TID SE SE2
Goto the named block in the current table if a GUI component does not exist.
OnInRangeGotoBlockID
TID
Goto named block if value1 is between value2 and value3.
OnLessThanGotoBlockID
TID
Goto the named block if value1 is less than value2.
OnNotContainsGotoBlockID
TID
Goto the named block in the current table if value2 is NOT a substring of value1.
OnNotEqualGotoBlockID
TID
Goto the named block in the current table if two values are not equal.
OnNotGreaterThanGotoBlockID
TID
Goto the named block in the current table if value1 is NOT greater than value2.
OnNotInRangeGotoBlockID
TID
Goto the named block in the current table if value1 is not between value2 and value3.
OnNotLessThanGotoBlockID
TID
Goto the named block if value1 is NOT less than value2.
OnRegistryKeyExistGotoBlockID
TID SDC
Goto the named block in the current table if the Registry Key exists.
OnRegistryKeyNotExistGotoBlockID
TID SDC
Goto the named block in the current table if the Registry Key does not exist.
SetExitTableBlock
TID
Set or clear the name of a block to execute when the ExitTable command is encountered.
SetGeneralScriptFailureBlock
TID
Set or clear the name of a block to execute when GeneralScriptFailure occurs.
SetInvalidFileIOBlock
TID
Set or clear the name of a block to execute when InvalidFileIO occurs.
SetNoScriptFailureBlock
TID
Set or clear the name of a block to execute when NoScriptFailure occurs.
SetScriptNotExecutedBlock
TID
Set or clear the name of a block to execute when ScriptNotExecuted occurs.
SetScriptWarningBlock
TID
Set or clear the name of a block to execute when ScriptWarning occurs.
UseLocalFlowControl
TID
When TRUE then flow control block IDs have current table scope only.

DDDriverLogCommands [How To Read This Reference]
LogFailureOK
TID
Log an EXPECTED failure message.
LogMessage
TID SE2
Log a generic message
LogTestFailure
TID SE2
Log a FAILURE message. Also increments appropriate counters.
LogTestSuccess
TID SE2
Log a SUCCESS/OK message. Also increments appropriate counters.
LogTestWarning
TID SE2
Log a WARNING message. Also increments appropriate counters.
LogWarningOK
TID
Log an EXPECTED WARNING message.
ResumeLogging
TID SE2
Resume suspended logging.
SuspendLogging
TID SE2
Suspend all logging.

DDDriverStringCommands [How To Read This Reference]
CleanString
TID SDC SE2
CleanString, for each char in string: if ((char .gt. 31) and (char .lt. 127)) keep it, otherwise turn it into a space
Compare
TID SDC SE2
Compares two strings and returns an integer specifying the result of the comparison. The java version uses String.equals() for comparison so the result will be either 'true' or 'false'
Concatenate
TID SDC SE2
Concatenate String1 with String2 and returns concatenated string.
GetField
TID SDC SE2
GetField, get a field out of a string using specified delimiter(s). Note that any leading or trailing whitespaces are still present.
GetFieldCount
TID SDC SE2
GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
GetFixedWidthField
TID SDC SE2
GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record.
GetMultiDelimitedField
TID SDC SE2
Given a sourceString of delimited fields, return the nth(FieldID) Field in the record from startIndex. The startIndex and fieldID are 1 based.
GetMultiDelimitedFieldCount
TID SDC SE2
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.
GetNextDelimiterIndex
TID SDC SE2
GetNextDelimiterIndex, Finds the index of the first character matching one of the provided delimiter characters. The search begins at startindex within the inputRecord.
GetREDelimitedField
TID SDC SE2
GetREDelimitedField, this command returns the requested field contained in the input string using the passed in regular expression as the delimiter(s).
GetREDelimitedFieldCount
TID SDC SE2
GetREDelimitedFieldCount, this command returns the number of fields contained in the input string using the passed in regular expression as the delimiter(s).
GetSubstringsInString
TID SDC SE2
Extract dynamic substring from a string using regular expressions.
GetSystemEnviron
TID SDC SE2
GetSystemEnviron, get a system environment variable value
GetSystemUser
TID SDC SE2
Get the USERID of the currently logged on user as stored in System Environment variables.
GetTrimmedField
TID SDC SE2
GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
Index
TID SDC SE2
Returns the position of the first occurrence of one string within another string. -1 if not found at all
Left
TID SDC SE2
Returns a string of a specified number of characters copied from the beginning of another string.
LeftTrim
TID SDC SE2
A new string trimmed of leading tabs and spaces.
Length
TID SDC SE2
Returns the length of a string or variable.
Replace
TID SDC SE2
Replace 'find' substring with 'replace' substring
Right
TID SDC SE2
Returns a string of a specified number of characters copied from the end of another string.
RightTrim
TID SDC SE2
A new string trimmed of trailing tabs and spaces.
SubString
TID SDC SE2
Returns a portion of a string based on character index.
ToLowerCase
TID SDC SE2
Returns a copy of a string, with all letters converted to lowercase.
ToUpperCase
TID SDC SE2
Returns a copy of a string after converting all letters to uppercase.
Trim
TID SDC SE2
A new string trimmed of leading and trailing tabs and spaces.

DDDriverTimerCommands [How To Read This Reference]
ResetTimer
TID SDC
Reset a "stopped" timer for reuse.
StartTimer
TID SDC
Will start a unique timer.
StopTimer
TID SDC
Will end a unique timer and perform a verify test if a value was supplied at start time.
StoreTimerInfo
TID SDC
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).
StoreTimerInfoFile
TID SDC
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).
VerifyElapsedTimeInRange
TID SDC
Well verify that a timer was in the range of the given values.
VerifyElapsedTimeIsLess
TID SDC
Well verify that a timer was less then the given value.
VerifyElapsedTimeIsMore
TID SDC
Well verify that a timer was greater then the given value.
VerifyTimer
TID SDC
Well verify that a timer was less then the given value.


COMPONENT FUNCTIONS
(back to top)

CheckBoxFunctions [How To Read This Reference]
Check
SE SE2
Tries to perform a Check on the Checkbox.
UnCheck
SE SE2
Tries to perform a UnCheck on the Checkbox.

ComboBoxFunctions [How To Read This Reference]
CaptureItemsToFile
SE2
Capture Items To a File specified (if not abs, then to test dir)
HideList
SE2
Hide the combo box list (equivalent to an ESC or two ESCs).
Select
SE SE2
Select an item by its text value from a combobox.
SelectIndex
SE SE2
Select an item by its index from a combobox.
SelectPartialMatch
SE SE2
Select an item via a partial text match in a combobox.
SelectUnverified
SE SE2
Select an item by its text value from a combobox without verifying the selection.
SelectUnverifiedPartialMatch
SE2
Select an item via a partial text match in a combobox without verification.
SetTextValue
SE2
Set the text of the combobox
ShowList
SE2
Show the combo box list (expose it).
VerifySelected
SE2
Verify Selected item is equal to specified parameter

EditBoxFunctions [How To Read This Reference]
SetTextCharacters
SE SE2
Set the text of the editbox
SetTextValue
SE SE2
Set the text of the editbox
SetUnverifiedTextCharacters
SE SE2
Set the text of the editbox
SetUnverifiedTextValue
SE SE2
Set the text of the editbox without verification

GenericMasterFunctions [How To Read This Reference]
AssignPropertyVariable
SE SE2
Assign the string value of an object property to a specific DDVariable
CaptureObjectDataToFile
SE SE2
Copy the current contents of an object's data to a file.
CapturePropertiesToFile
SE SE2
Copy all of the value properties a test object to a file.
CapturePropertyToFile
SE SE2
Copy a propertie's value of a test object to to a file.
ClearAppMapCache
SE2
Clear the internal application map cache.
ClearCache
SE2
Clear the cache of a component.
ExecuteScript
SE2
Execute a piece of script on the specified component synchronously.
GetComputedStyle
SE2
Get a component's 'computed style', and save them to a file.
GetGUIImage
TID SE SE2
Capture the screen shot of a GUI component and save it to a file
GetTextFromGUI
TID SE SE2
Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
GUIDoesExist
TID SE SE2
Routine to verify the visual existence of a particular window and/or component.
GUIDoesNotExist
TID SE SE2
Routine to verify the visual non-existence of a particular window and/or component.
HoverMouse
TID SE SE2
Hover the mouse over an object.
HoverScreenLocation
TID
Hover the mouse over a specified screen location.
InputCharacters
TID SE SE2
Sends literal text to the specified component.
InputKeys
TID SE SE2
Sends keystrokes to the specified component.
IsPropertyExist
SE SE2
Verify if object's property exists or not.
LocateScreenImage
TID SE SE2
Store the location and dimensions of a component.
SaveTextFromGUI
TID SE SE2
Incorporate OCR technology to detect the text on a GUI component and save the text to a text file.
ShowOnPage
SE2
Make the component visible on the page.
TypeChars
TID SE2
Sends literal text keystrokes to whatever has keyboard focus.
TypeEncryption
TID
Sends secret-text (such as password) to whatever has keyboard focus.
TypeKeys
TID SE2
Sends keystrokes to whatever has keyboard focus.
VerifyBinaryFileToFile
TID
Verify the current contents of a binary file with a benchmark file.
VerifyComputedStyle
SE2
Verify a component's 'computed style' against a benchmark file.
VerifyFileToFile
TID
Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
VerifyGUIImageToFile
TID SE SE2
Verify the screen shot of a GUI component with a benchmark image file
VerifyObjectDataToFile
SE SE2
Verify the current contents of an object's data with a benchmark file.
VerifyPropertiesSubsetToFile
SE SE2
Compare/Verify the subset of properties of a test object with the values stored in a benchmark file.
VerifyPropertiesToFile
SE SE2
Compare/Verify ALL of the value properties of a test object with a benchmark file.
VerifyProperty
SE SE2
Verify the value of a single object property
VerifyPropertyContains
SE SE2
Verify that the value of an object property contains a string
VerifyPropertyToFile
SE SE2
Verify the value of a single object property with a benchmark file
VerifyTextFileToFile
TID
Verify the current contents of a text file with a benchmark file (same as VerifyFileToFile).
VerifyValueContains
TID
Verify that a string value contains a substring
VerifyValueContainsIgnoreCase
TID
Verify that a string value contains a substring, ignoring case.
VerifyValueDoesNotContain
TID
Verify that a string value does NOT contain a substring
VerifyValues
TID
Verify that two string values are identical. Note: RobotJ also uses identical keyword 'VerifyValueEquals'
VerifyValuesIgnoreCase
TID
Verify that two string values are identical, ignoring case.
VerifyValuesNotEqual
TID
Verify that two string values are NOT identical.

GenericObjectFunctions [How To Read This Reference]
AltLeftDrag
SE2
An ALT left mouse drag is performed on the object based on the stored coordinates.
Click
TID SE SE2
A single click on an object.
ClickScreenImage
TID
Same as Click.
ClickScreenLocation
TID
Click a specified screen location.
ClickScreenPoint
TID
(Deprecated) Click a specified screen location.
CtrlAltLeftDrag
SE2
CTRL ALT left mouse drag is performed on the object based on the stored coordinates.
CtrlClick
TID SE SE2
A CTRL-click on an object.
CtrlClickScreenImage
TID
Same as CtrlClick.
CtrlLeftDrag
SE2
A CTRL left mouse drag is performed on the object based on the stored coordinates.
CtrlRightClick
TID SE SE2
A CTRL-Right click on an object.
CtrlRightClickScreenImage
TID
Same as CtrlRightClick.
CtrlShiftLeftDrag
SE2
A CTRL SHIFT left mouse drag is performed on the object based on the stored coordinates.
DoubleClick
TID SE SE2
A double click on an object.
DoubleClickScreenImage
TID
Same as DoubleClick.
DoubleClickScreenLocation
TID
DoubleClick a specified screen location.
DoubleClickScreenPoint
TID
(Deprecated) DoubleClick a specified screen location.
DragTo
SE2
A left mouse drag is performed from one object to another object based on the offsets values.
LeftDrag
TID SE2
A left mouse drag is performed on the object based on the stored coordinates.
MultiClick
TID
Multiple clicks on an object.
MultiClickScreenImage
TID
Same as MULTICLICK.
RightClick
TID SE SE2
A right click on an object.
RightClickScreenImage
TID
Same as RightClick.
RightClickScreenLocation
TID
RightClick a specified screen location.
RightClickScreenPoint
TID
(Deprecated) RightClick a specified screen location.
RightDrag
TID SE2
A right mouse drag is performed on the object based on the stored coordinates.
ShiftClick
TID SE SE2
A SHIFT click on an object.
ShiftClickScreenImage
TID
Same as ShiftClick.
ShiftLeftDrag
SE2
A SHIFT left mouse drag is performed on the object based on the stored coordinates.

HTMLDocumentFunctions [How To Read This Reference]
CaptureBodySourceToFile
SE
Captures the HTML source of the BODY tag into a file.
CaptureBodyTextToFile
SE
Captures the visible document text into a file.
ClickLink
SE
Performs an HTMLLink Click based on a complete match of text found on Links within this HTMLDOCUMENT object.
ClickLinkBeginning
SE
Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
ClickLinkContaining
SE
Performs an HTMLLink Click based on a partial match of text found on Links within this HTMLDOCUMENT object.
ClickLinkMatching
SE
DEPARECATED. This command is identical to ClickLink.
VerifyBodySource
SE
Compares the HTML source of the BODY tag with that of a benchmark file.
VerifyBodyText
SE
Compares the visible doc text with that of a benchmark file.

HTMLTableFunctions [How To Read This Reference]
ActivateCell
SE
Attempts to perform a double click on a Table cell.
AssignCellContainsTextRow
SE
Assigns a user-defined variable a row # based on partial matching cell values.
AssignCellTextRow
SE
Assigns a user-defined variable a row # based on matching cell values.
AssignVariableCellText
SE
Attempts to extract a particular cell value and assign it to the provided variable name.
CaptureFuzzyRangeToFile
SE
Saves a range of values to the specified file.
CaptureRangeToFile
SE
Saves a range of values to the specified file.
ClickCell
SE
Click on a cell specified by row and column.
DoubleClickCell
SE
Attempts to perform a double click on a cell in a Table.
RightClickCell
SE
Attempts to perform a right click on a cell in a Table.
SelectCell
SE
Same as ClickCell.
SelectCellContainsTextFind
SE
Attempts to select a particular cell by finding the row based on cell values.
SelectCellText
SE
Attempts to select a particular cell.
SelectCellTextFind
SE
Attempts to select a particular cell by finding the row based on cell values.
SelectFuzzyCellText
SE
Attempts to select a particular cell.
SelectFuzzyCellTextFind
SE
Attempts to select a particular cell by finding the row based on fuzzy cell values.
VerifyCellEditable
SE
Verifies whether the specified cell is editable.
VerifyCellText
SE
Attempts to verify a particular cell value.
VerifyCellTextContains
SE
Attempts to verify a particular cell value.
VerifyCellTextFind
SE
Attempts to verify a particular cell by finding the row based on cell values.
VerifyCellValue
SE
Verify the value of a specific Cell.
VerifyColumnLabel
SE
Attempts to verify a particular column's label when given a column number.
VerifyFuzzyCellText
SE
Attempts to verify a particular cell value.
VerifyFuzzyCellTextContains
SE
Attempts to verify a particular cell value.
VerifyFuzzyCellTextFind
SE
Attempts to verify a particular cell by finding the row based on fuzzy cell values.

JavaMenuFunctions [How To Read This Reference]
SelectMenuItem
SE2
Action to select a menuItem according to its text value.
SelectMenuItemContains
SE2
Action to select a menuItem according to a partial match of its text value.
SelectUnverifiedMenuItem
SE2
Action to select a menuItem according to its text value without verification of it's existance.
VerifyMenuItem
SE2
Attempts to verify the a particular menuitem exists in a menu.
VerifyMenuItemContains
SE2
Attempts to verify the existence of a menuitem found by partial text match.

ListBoxFunctions [How To Read This Reference]
ActivatePartialMatch
SE
Routine to DblClick and Verify an item according to a partial text match.
ActivateTextItem
SE
Routine to DblClick and Verify an item according to its text value.
ActivateUnverifiedPartialMatch
SE
DblClicks an item according to a partial text match.
ActivateUnverifiedTextItem
SE
Routine to DblClick an item according to its text value.
SelectAnotherTextItem
SE
Routine to Control+Click and Verify a selection according to its text value.
SelectAnotherUnverifiedTextItem
SE
Routine to Control+Click an item according to its text value. No post-select verification of the selection is performed.
SelectIndex
SE
Select an item based on it's index in the list, starting from 1
SelectPartialMatch
SE
Routine to Click and Verify an item according to a partial text match.
SelectTextItem
SE
Routine to Click and Verify a selection according to its text value.
SelectUnverifiedPartialMatch
SE
Routine to Click an item according to a partial text match.
SelectUnverifiedTextItem
SE
Routine to Click a selection according to its text value.
VerifyItemUnselected
SE
Verifies a particular case-sensitive text item is NOT selected.
VerifyListContains
SE
Verifies a particular list-item exists in the list (somewhere)
VerifyListContainsPartialMatch
SE
Verifies a particular list-item substring exists in the list (somewhere)
VerifyListDoesNotContain
SE
Verifies a particular list-item does NOT exists in the list (somewhere)
VerifyListDoesNotContainPartialMatch
SE
Verifies a particular list-item substring does NOT exists in the list (somewhere)
VerifySelectedItem
SE
Verifies a particular case-sensitive text item is selected
VerifySelectedPartialMatch
SE
Verifies a particular case-sensitive item is selected based on a substring match.

ListViewFunctions [How To Read This Reference]
ActivateIndex
SE2
Activate (double-click) an item based on it's index in the list
ActivateIndexItem
SE2
Routine to double click an item according to its index in the list.
ActivatePartialMatch
SE2
Routine to double click an item according to a partial text match.
ActivateTextItem
SE2
Routine to double click an item according to its text value.
ActivateTextItemCoords
SE2
Double click a text item at specific Coords.
ActivateUnverifiedTextItem
SE2
Routine to double click an unverifiable item according to its text value.
ActivateUnverifiedTextItemCoords
SE2
Double click an unverifiable text item at specific Coords.
CaptureItemsToFile
SE2
Capture Items To a File specified (if not abs, then to test dir)
ClickIndex
SE2
Same as (Alias for) ListView ActivateIndexItem
ClickIndexItem
SE2
Same as (Alias for) ListView ActivateIndexItem
ExtendSelectionToTextItem
SE2
Routine to Shift+Click and Verify a selection according to its text value.
RightClickTextItem
SE2
Routine to RightClick (single click) an item according to its text value.
RightClickTextItemCoords
SE2
Right click a text item at specific Coords.
SelectAnotherPartialMatch
SE2
Routine for multiple selection to Control+Click on an item according to a partial text match.
SelectAnotherTextItem
SE2
Routine for multiple selection to Control+Click on an item by its text value.
SelectIndex
SE2
Same as (Alias for) ListView SelectIndexItem
SelectIndexItem
SE2
Routine to single click an item according to its Index value.
SelectIndexItemCoords
SE2
Routine to single click an item by Index at specific coordinates.
SelectPartialMatch
SE2
Routine to select (single click) an item according to a partial text match.
SelectTextItem
SE2
Routine to select (single click) an item according to its text value.
SelectTextItemCoords
SE2
Single click a text item at specific Coords.
SelectUnverifiedTextItem
SE2
Routine to select (single click) an unverifiable item according to its text value.
SelectUnverifiedTextItemCoords
SE2
Single click an unverifiable text item at specific Coords.
SetListContains
SE2
Set a variable with the result of checking that a listview contains the provided item.
VerifyItemUnselected
SE2
Verifies a particular case-sensitive text item is NOT selected.
VerifyListContains
SE2
Verify that a list view contains the provided item.
VerifySelectedItem
SE2
Verifies a particular case-sensitive text item is selected

ScrollBarFunctions [How To Read This Reference]
OneDown
SE2
Attempts to perform a ScrollLineDown on a scrollbar.
OneLeft
SE2
Attempts to perform a ScrollLeft on a scrollbar.
OneRight
SE2
Attempts to perform a ScrollRight on a scrollbar.
OneUp
SE2
Attempts to perform a ScrollLineUp on a scrollbar.
PageDown
SE2
Attempts to perform a ScrollPageDown on a scrollbar.
PageLeft
SE2
Attempts to perform a ScrollPageLeft on a scrollbar.
PageRight
SE2
Attempts to perform a ScrollPageRight on a scrollbar.
PageUp
SE2
Attempts to perform a ScrollPageUp on a scrollbar.

TabControlFunctions [How To Read This Reference]
ClickTab
SE2
Attempts to perform a standard Click on a particular Tab on the TabControl
ClickTabContains
SE2
Attempts to perform a Click on a Tab according to a partial match of its text value.
MakeSelection
SE2
Attempts to perform a standard Click on a particular Tab on the TabControl
SelectTab
SE2
Attempts to perform a standard SelectTab on a particular Tab on the TabControl
SelectTabIndex
SE2
Attempts to select a particular Tab by Index.
UnverifiedClickTab
SE2
Attempts to perform an unverified Click on a particular Tab on the TabControl

TreeViewFunctions [How To Read This Reference]
CaptureTreeDataToFile
SE2
Copy the current contents of a tree[branch] to a file.
ClickPartial
SE2
Action to click a node according to a partial match of its text value.
ClickTextNode
SE2
Action to click a node according to its text value.
ClickUnverifiedTextNode
SE2
Action to (almost) blindly click a text node.
Collapse
SE2
Action to collapse a node according to its text value.
CollapsePartial
SE2
Action to collapse a node according to a partial match of its text value.
CollapseUnverifiedTextNode
SE2
Action to blindly collapse a node according to its text value.
CtrlClickUnverifiedTextNode
SE2
Action to blindly CTRL-click a node according to its text value. Currently, this component function is for JavaTrees only.
DoubleClickPartial
SE2
Action to double click a node according to a partial match of its text value.
DoubleClickTextNode
SE2
Action to double click a node according to its text value.
DoubleClickUnverifiedTextNode
SE2
Action to (almost) blindly activate (double-click) a text node.
Expand
SE2
Action to expand a node according to its text value.
ExpandPartial
SE2
Action to expand a node according to a partial match of text value.
ExpandUnverifiedTextNode
SE2
Action to blindly expand a node according to its text value.
RightClickPartial
SE2
Action to right click a node according to a partial match of its text value.
RightClickTextNode
SE2
Action to right click a node according to its text value.
RightClickUnverifiedTextNode
SE2
Action to (almost) blindly right-click a text node.
Select
SE2
Action to select a node according to its text value.
SelectPartial
SE2
Action to select a node according to a partial match of its text value.
SelectUnverifiedTextNode
SE2
Action to (almost) blindly click a text node.
SetTreeContainsNode
SE2
Sets a user-defined variable with the result of whether a tree contains the provided node.
SetTreeContainsPartialMatch
SE2
Sets a user-defined variable with the result of whether a tree contains the provided node according to a partial match of the node's text value.
ShiftClickUnverifiedTextNode
SE2
Action to blindly SHIFT-click a node according to its text value. Currently, this component function is for JavaTrees only.
VerifyNodeUnselected
SE2
Action to verify a particular text node is NOT selected.
VerifySelectedNode
SE2
Action to verify a particular text node is selected.
VerifyTreeContainsNode
SE2
Verify that a tree contains the provided node.
VerifyTreeContainsPartialMatch
SE2
Verify that a tree contains the provided node according to a partial match of the node's text value.

WindowFunctions [How To Read This Reference]
CloseWindow
SE SE2
Sends a Close command to the active window.
Maximize
SE SE2
Sends a WMaximize command to the active window.
Minimize
SE SE2
Sends a WMinimize command to the active window.
Restore
SE SE2
Sends a RestorePos command to the active window.
SetFocus
SE
Set focus on the window.
SetPosition
SE SE2
Sends a SetPosition command to the window to set the position, size, and status of the window.


ENGINE COMMANDS


Goto:
Driver Commands, Component Functions, Engine Commands, Detailed Reference Doc