SAFS TIDComponent 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	Copy the clipboard contents to a DDVariable.
CallRemote	TID SDC	Execute a command on an external system / application.
CaptureMousePositionOnScreen	SDC TID	Capture the location of the mouse pointer relative to the screen and save the x and y components into variables.
ClearAllVariables	SDC	Clear storage of all DDVariables.
ClearArrayVariables	SDC	Clear storage of all SAFS variables containing a specific prefix.
ClearClipboard	TID SDC	Clear the contents of the Window's clipboard.
CloseApplication	TID SDC	Close a named application process launched with LaunchApplication.
CloseApplicationMap	TID	By map ID, Close a opened Application Map in map chain.
CopyVariableValueEx	TID SDC	Copy the value of a (dynamic) DDVariable to another.
Delay	TID SDC	Delay for a specified number of milliseconds.
Expressions	TID	Enable and Disable enhanced expressions.
GetAppMapValue	SDC	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	Assign the value of the specified Registry Key to a variable.
GetSystemDate	TID SDC	Assigns the string value of the system date to a DDVariable.
GetSystemDateTime	TID SDC	Assigns the string value of the system datetime to a DDVariable.
GetSystemTime	TID SDC	Assigns the string value of the current system time to a DDVariable.
GetVersion	TID SDC	Get the engine VERSION
LaunchApplication	TID SDC	Identify and Launch a specified application
NotifyAndWait	TID SDC	Display a user-defined message dialog and wait until dismissed.
Pause	TID SDC	Pause for a specified number of seconds.
SaveClipboardToFile	TID SDC	Save the clipboard contents to a text file.
SendEmail	TID	Send email notification with attachments.
SetApplicationMap	TID	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	Set the clipboard contents to a string.
SetDifDirectory	TID SDC	Set/Change the directory in which the framework will locate file compare differences.
SetImageDebug	TID	Enable/Disable verbose debug log output and high-res failure snapshots.
SetImageFuzzyMatching	TID	Enable/Disable Image-Based Testing Fuzzy Matching.
SetMillisBetweenRecords	TID	Set the pause between two records.
SetMultipleThreadSearch	TID	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	Set the value of a DDVariable
SetVariableValues	TID SDC	Preset the value of one or more DDVariables
StartWebBrowser	TID SDC	Launch a new web browser and optionally load a document into it.
TakeScreenShot	TID	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.
VerifyClipboardToFile	TID SDC	Verify the current contents of the Windows clipboard with a benchmark file.
Version	TID	Specify the table format VERSION
WaitForGUI	TID	Wait for a Window or Window Component to become valid.
WaitForGUIGone	TID	Wait for a Window or Window Component to become invalid.
WaitForRegistryKeyExists	SDC TID	Wait for a Registry Key to become valid.
WaitForRegistryKeyValue	SDC TID	Wait for a specific Registry KeyValue to match an expected value.

DDDriverCounterCommands [How To Read This Reference]

DeleteCounter	TID	Delete any existing private counter with the provided counterID.
LogCounterInfo	TID	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	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	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	Begin tracking status on a user-defined item.
StartTestcase	TID	Begin tracking status on a user-defined TestCase.
StopCounter	TID	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	Stop tracking status on a user-defined TestCase.
StoreCounterInfo	TID	Store the current values of the named counter into unique DDVariables.
SuspendStatusCounts	TID	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	Close the open file with the file number provided
CopyFile	TID SDC	Copy the specified filename to the target filename.
CopyMatchingFiles	TID SDC	Copy multiple files/sub-directories, based on matching the provided pattern, from one directory to another.
CreateDirectory	TID SDC	Create the directory for the provided directory pathname
CreateFile	TID SDC	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	Delete the directory for the provided directory pathname
DeleteDirectoryContents	TID SDC	Delete the contents (files and sub-directories) of a provided directory and optionally, the directory itself.
DeleteFile	TID SDC	Delete the file for the file name provided
FilterImage	TID SDC	Filter out specific parts of an image.
FilterTextFile	TID SDC	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	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	Save the file attributes for the file name to the variable provided.
GetFiles	TID SDC	Search the directory provided for files according to possible attribute and write the list of filenames found into the output file.
GetFileSize	TID SDC	Determine the file size for file name provided and assign it to a DDV variable.
GetINIFileValue	TID SDC	Get value from INI file.
GetStringCountInFile	TID SDC	Count the number of occurrences of a target string in a File.
GetSubstringsInFile	TID SDC	Extract dynamic substrings from a file using regular expressions.
GetTextFromImage	SDC TID	Incorporate OCR technology to detect the text in an image file and save the text to a variable.
IfExistDir	TID SDC	If the specified directory exists, then execute the following driver command.
IfExistFile	TID SDC	If the specified file exists, then execute the following driver command.
IsEndOfFile	TID SDC	If the specified file is at the end of file, a 'variable' gets true assigned, otherwise it gets false
OpenFile	TID SDC	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	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	Write output to a sequential file already opened for writing.
ReadFileChars	TID SDC	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	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	Rename the file from the old file name to the new filename
SaveTextFromImage	SDC TID	Incorporate OCR technology to detect the text in an image file and save the text to a text file.
SetFileProtections	TID SDC	Change the file attribute for the file name provided to the value of the new file protection provided.
WriteFileChars	TID SDC	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).
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	Goto the named block in the current table if a GUI component exists.
OnGUINotExistGotoBlockID	TID	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	Log a generic message
LogTestFailure	TID	Log a FAILURE message. Also increments appropriate counters.
LogTestSuccess	TID	Log a SUCCESS/OK message. Also increments appropriate counters.
LogTestWarning	TID	Log a WARNING message. Also increments appropriate counters.
LogWarningOK	TID	Log an EXPECTED WARNING message.
ResumeLogging	TID	Resume suspended logging.
SuspendLogging	TID	Suspend all logging.

DDDriverStringCommands [How To Read This Reference]

CleanString	TID SDC	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	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	Concatenate String1 with String2 and returns concatenated string.
GetField	TID SDC	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	GetFieldCount, Finds the count of all fields within the inputRecord found from startindex to the end of the inputRecord.
GetFixedWidthField	TID SDC	GetFixedWidthField, Given an Input of fixed-width fields, return the nth(FieldID) Field in the record.
GetMultiDelimitedField	TID SDC	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	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	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	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	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	Extract dynamic substring from a string using regular expressions.
GetSystemEnviron	TID SDC	GetSystemEnviron, get a system environment variable value
GetSystemUser	TID SDC	Get the USERID of the currently logged on user as stored in System Environment variables.
GetTrimmedField	TID SDC	GetTrimmedField, get a trimmed field out of a string using specified delimiter(s).
Index	TID SDC	Returns the position of the first occurrence of one string within another string. -1 if not found at all
Left	TID SDC	Returns a string of a specified number of characters copied from the beginning of another string.
LeftTrim	TID SDC	A new string trimmed of leading tabs and spaces.
Length	TID SDC	Returns the length of a string or variable.
Replace	TID SDC	Replace 'find' substring with 'replace' substring
Right	TID SDC	Returns a string of a specified number of characters copied from the end of another string.
RightTrim	TID SDC	A new string trimmed of trailing tabs and spaces.
SubString	TID SDC	Returns a portion of a string based on character index.
ToLowerCase	TID SDC	Returns a copy of a string, with all letters converted to lowercase.
ToUpperCase	TID SDC	Returns a copy of a string after converting all letters to uppercase.
Trim	TID SDC	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)

GenericMasterFunctions [How To Read This Reference]

GetGUIImage	TID	Capture the screen shot of a GUI component and save it to a file
GetTextFromGUI	TID	Incorporate OCR technology to detect the text on a GUI component and save the text to a variable.
GUIDoesExist	TID	Routine to verify the visual existence of a particular window and/or component.
GUIDoesNotExist	TID	Routine to verify the visual non-existence of a particular window and/or component.
HoverMouse	TID	Hover the mouse over an object.
HoverScreenLocation	TID	Hover the mouse over a specified screen location.
InputCharacters	TID	Sends literal text to the specified component.
InputKeys	TID	Sends keystrokes to the specified component.
LocateScreenImage	TID	Store the location and dimensions of a component.
SaveTextFromGUI	TID	Incorporate OCR technology to detect the text on a GUI component and save the text to a text file.
TypeChars	TID	Sends literal text keystrokes to whatever has keyboard focus.
TypeEncryption	TID	Sends secret-text (such as password) to whatever has keyboard focus.
TypeKeys	TID	Sends keystrokes to whatever has keyboard focus.
VerifyBinaryFileToFile	TID	Verify the current contents of a binary file with a benchmark file.
VerifyFileToFile	TID	Verify the current contents of a text file with a benchmark file (same as VerifyTextFileToFile).
VerifyGUIImageToFile	TID	Verify the screen shot of a GUI component with a benchmark image 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]

Click	TID	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.
CtrlClick	TID	A CTRL-click on an object.
CtrlClickScreenImage	TID	Same as CtrlClick.
CtrlRightClick	TID	A CTRL-Right click on an object.
CtrlRightClickScreenImage	TID	Same as CtrlRightClick.
DoubleClick	TID	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.
LeftDrag	TID	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	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	A right mouse drag is performed on the object based on the stored coordinates.
ShiftClick	TID	A SHIFT click on an object.
ShiftClickScreenImage	TID	Same as ShiftClick.

---

ENGINE COMMANDS