SAFS Dynamic Engine Reference

(updated )

The following reference material is in a format similar to an outline. When you click on an item it will expand (or collapse) to show or hide the information available within that section. Here you will find links to sample files, available commands for the engine and GUI components, and the syntax for these commands. In general, an empty circle will signify the item does not expand (but it may contain a link to another document), while a solid disk or square indicates the item does expand (or collapse).

Background and Examples:
- Test Automation Frameworks Whitepaper for information on various forms of test automation and, specifically, the data-driven or keyword-driven form of SAFS test automation.
- Creating an Application Map for your application.
- Official SAFS Test Table Record Formats.
- Sample Application Map developed with a version of a ProcessContainer tool.
- Sample Test Table for StepDriver
- Sample Script to Launch StepDriver.
  (Normally we would also develop Cycle and Suite tables and invoke CycleDriver instead of the low level StepDriver. But here we are simply trying to illustrate the Application Map and its use. CycleDriver and SuiteDriver do not generally access the Application Map.)

DDE Setup, DDEngineReference, Using DDVariables, Error Recovery and Flow Control, Custom Extensions

Reference:

A few of notes on the general format of the reference below:
- When an item has multiple syntax examples, usually only the last one can be expanded to see the field explanations.
- Although some examples shown might be wrapped onto two or more lines here, the full syntax for these commands is expected to be all on one line in the actual data/step file.
- The syntax examples often show a comma (,) as a record field separator. Data/Step files can actually use almost any field separator desired. The separator will be specified to the drivers during the initialization of the DDE or when the test table is passed to the driver.
- When a command keyword accepts parameters, OPTIONAL fields are shown enclosed in brackets []. However, in general, OPTIONAL fields must be provided (or left blank\empty) if subsequent fields are provided.
- Field Types definitions:
  - TQ String: Trimmed Quoted String:
    - A field that will be trimmed of all leading and trailing whitespace.
      OPTIONALLY: Use double-quotes to retain leading and trailing whitespace.
      The quotes will be removed before use.
      99.999% of all fields are of this type.
  - QS String: Quoted String:
    - A field defined by a leading double-quote and a trailing double-quote irregardless of any separator currently in force. To include a double-quote within this string two double-quote characters must exist with no intervening characters and neither of these can be the outermost leading or trailing double-quote.
      The outermost quotes will not be returned as part of the string.
      Due to the nature of field parsing, this type of field generally must be the last useful field in the input record if the separator character exists anywhere within the field.
      The use of this field type is EXTREMELY rare!

CORE DRIVERS:

Common Record Types and DriverCommands for Cycles, Suites, and Steps

Skip RecordType (RecordType = "S")

S, "Skipping Security Test due to Defect #XYZ", T, RunSecurityTests, ...

Field 2 : TQ String. Skip this record (usually a test record) but log the fact and the comment of why the record is being skipped. This is better than simply commenting out a test record which might then be forgotten.
Normally, these two fields are added to the front of an existing record to temporarily skip the record. Later, these two fields are easily deleted leaving the original record intact and executable.

Block RecordType (RecordType = "B")

B, SomeBlockName

Field 2 : TQ String. Declares or defines a named reference point in this file. This is used for naming or referencing the start of a block or section in the file and is the target point for the Flow Control/Error Recovery Driver Commands.

BreakPoint RecordType (RecordType = "BP")

BP
Sets a breakpoint in the test table for when running the table in Debug Mode. Breakpoints can be set, but not ENABLED. To use breakpoints, the specific Driver or Engine must be running in its Debug Mode AND breakpoints must be turned "ON" with the BREAKPOINTS Driver Command.

Driver Commands (RecordType = "C", "CW", "CF" )
(C=Command; W=Warning Expected\Allowed; F=Failure Expected\Allowed)

DDDriverCommands

DDDriverCommands Documentation.

AppMapChaining
SDC TID
( )

C, AppMapChaining, OFF

Field 3 :Mode
Enable("ON") or Disable("OFF") this feature.

AppMapResolve
SDC TID
( )

C, AppMapResolve, OFF

Field 3 :Mode
Enable("ON") or Disable("OFF") this feature.

AssignClipboardVariable
RJ TID SDC SE2 DRD
( )

C, AssignClipboardVariable, "Clipboard"

C, AssignClipboardVariable, "^Clipboard"

Field 3 :VarName
The variable to copy the clipboard text into.
The routine will strip off any leading "^" if it is provided.

CallRemote
RJ TID SDC SE2
( )

C CallRemote STAF LOCAL PING PING

C CallRemote STAF ext-1 HANDLE QUERY myResult ALL

Field 3 :Protocol
The name of the protocol to use. Presently only 'STAF' is supported.

Field 4 :SystemName
The name of the system to send the command to.

Field 5 :ServiceName
The service name to be called on the external system / application.

Field 6 :Command
The service command to be issued to the external system / application.

Field [7]:VarName
The DDVariable root name to receive the results.
Variable root name defaults to 'result' if not provided.
The variables varName.RC and varName.RESULT are defined on completion of the command.

Field [8]:Parameters
Additional parameters to be passed to the service command.

CaptureMousePositionOnScreen
RJ SDC TID TC SE2
( , F )

C, CaptureMousePositionOnScreen, xVar, yVar

C, CaptureMousePositionOnScreen, ^xVar="x1", ^yVar="y1"

Field 3 :X_VariableName
The name of the DDVariable to store the X component of the mouse position.

Field 4 :Y_VariableName
The name of the DDVariable to store the Y component of the mouse position.
Capture the current position of the mouse on the screen. The X component of the returned coordinate is saved into the DDVariable given as the first parameter. The Y component of the returned coordinate is saved into the DDVariable given as the second parameter.

ClearAllVariables
RC RJ SDC SE2
( )

C, ClearAllVariables

ClearAppMapCache
RJ SE SE2 TC DRD
( )

C, ClearAppMapCache

ClearArrayVariables
SDC SE2
( )

C, ClearArrayVariables, "TCAFS.UID."

Field 3 :ArrayName
The variable name prefix to use for the delete.

ClearClipboard
RC RJ TID SDC SE2 WR DRD
( )

C, ClearClipboard

CloseApplication
DRD RC RJ IOS TID SDC SE2 WR
( W, F )

C, CloseApplication, NotePad

Field 3 :ApplicationID
The Application ID or reference provided to LaunchApplication
For IOS: The ApplicationID can be anything because it is ignored. The IOS engine simply shuts down all running IOS Instruments applications.

CloseApplicationMap
TID SE2
( )

C, CloseApplicationMap, NotePad.Map

C, CloseApplicationMap, "C:\SomeDir\NewApp.Map"

Field 3 :ApplicationMap
The path and/or filename (ID) of the Application Map to close.
The path and/or filename (ID) of the Application Map to close. This must be the same path or filename used when the App Map was opened. The short filename without the path can be used if the file can be found via internal search algorithms. Typically, the AppMap is located in the project's Datapool directory.

CopyVariableValueEx
RC RJ TID SDC SE2
( )

C, CopyVariableValueEx, srcvar, destvar

C, CopyVariableValueEx, ^srcvarname, ^destvarname

C, CopyVariableValueEx, ^basename & ^index, destvar

Field 3 :SourceVariable
The name of the variable to copy.

Field 4 :DestinationVariable
The name of the variable to receive the copy

Delay
RJ TID SDC SE2
( )

C, Delay, 300

Field 3 :Timeout
The number of milliseconds to delay.

DisableDomain
RJ
( )

C, DisableDomain, "Win"

Field 3 :Domain
The generic name of the domain to disable.
The name might be engine-specific, but the domain names should attempt to conform to:

Java

Html

Net

Win

Domain names should not be case-sensitive.

EnableDomain
RJ
( )

C, EnableDomain, "Java"

Field 3 :Domain
The generic name of the domain to enable.
The name might be engine-specific, but the domain names should attempt to conform to:

Java

Html

Net

Win

Domain names should not be case-sensitive.

Expressions
RC TID SE2
( )

C, Expressions, ON

Field 3 :Mode
The status for enhanced expression handling.

GetAppMapValue
SDC SE2
( )

C, GetAppMapValue, Classics.MAP, MainWindow, FileMenu, menuRec

C, GetAppMapValue, , , FileMenu, menuRec

Field [3]:AppMapID
The ID provided for the AppMap when OPENed.
If this parameter is left empty then the default or "current" App Map is used.

Field [4]:Section
The Section within the App Map to locate the entry.
If this parameter is left empty then the default App Map section is used.

Field 5 :Item
The Item within the App Map to retrieve.
This parameter cannot be left empty.

Field 6 :varName
The name of the variable to receive the value.
This parameter cannot be left empty.

GetCompScreenResolution
RC RJ TC
( )

C, GetCompScreenResolution, xres, yres

Field 3 :XWidthVariable
SAFSVARS name to be used to store x screen resolution

Field 4 :YHeightVariable
SAFSVARS name to be used to store y screen resolution

GetDeltaDate
RC TC
( )

C, GetDeltaDate, "25-Dec-2005", 1, "newdateresult"

C, GetDeltaDate, "25-Dec-2005", "-1", "newdateresult"

Field 3 :SourceDateString
String containing the date from which to calculate the delta date

Field 4 :DeltaDays
Positive or Negative number of days to calculate date from source date

Field 5 :ResultString

Variable name to receive the newly formatted date.

GetMillisBetweenRecords
TID
( )

C, GetMillisBetweenRecords, "millisBetweenRecords"

Field 3 :VariableName
The name of the variable to receive the pause between two records.
The name of the variable to receive the pause between two records.

GetRegistryKeyValue
RJ SDC TID SE2
( )

C, GetRegistryKeyValue, "HKLM\Software\Adobe\CommonFiles", "AdobeHome", "AdobeHomeVar"

Field 3 :Key
The Registry Key name to seek.

Field 4 :KeyValue
The value name under the parent key to seek.

Field 5 :VarName
The name of the variable to receive the value of the registry key.

GetSecsAfterWindowActive
RJ
( )

C, GetSecsAfterWindowActive, "secondsAfterWindowActive"

Field 3 :VariableName
The name of the variable to receive the delay after window is activated.
The name of the variable to receive the delay after window is activated.

GetSecsBeforeMouseDown
RJ
( )

C, GetSecsBeforeMouseDown, "secondsBeforeMouseDown"

Field 3 :VariableName
The name of the variable to receive the delay before mouse down.
The name of the variable to receive the delay before mouse down.

GetSecsBeforeMouseUp
RJ
( )

C, GetSecsBeforeMouseUp, "secondsBeforeMouseUp"

Field 3 :VariableName
The name of the variable to receive the delay before mouse up.
The name of the variable to receive the delay before mouse up.

GetSecsDelayRetryComponent
RJ
( )

C, GetSecsDelayRetryComponent, "secondsDelayRetryComponent"

Field 3 :VariableName
The name of the variable to receive the delay of re-finding object.
The name of the variable to receive the delay of re-finding object.

GetSecsSeekComponent
RJ
( )

C, GetSecsSeekComponent, "secondsSeekComponent"

Field 3 :VariableName
The name of the variable to receive the timeout of finding object.
The name of the variable to receive the timeout of finding object.

GetSystemDate
RC RJ TID SDC WR SE2
( )

C, GetSystemDate, SystemDate

C, GetSystemDate, "SystemDate"

C, GetSystemDate, "^SystemDate"

C, SetVariableValues, ^SystemDate="TodaysDate"
C, GetSystemDate, ^SystemDate

Field 3 :VariableName
The name of the variable to receive the System Date.
The name of the variable to receive the System Date. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

GetSystemDateTime
RC RJ TID SDC WR SE2
( )

C, GetSystemDateTime, SystemDate

C, GetSystemDateTime, "SystemDate"

C, GetSystemDateTime, "^SystemDate"

C, SetVariableValues, ^SystemDate="TodaysDate" C, GetSystemDateTime, ^SystemDate

C, GetSystemDateTime, SystemMilitaryDate, True

Field 3 :VariableName
The name of the variable to receive the System DateTime.
The name of the variable to receive the System DateTime. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Field [4]:GetMilitaryTime
If true, the converted time is in 24-hours military time format
If this is true, the converted time will be in 24-hours military time format (0-23). If this parameter is omitted, it is false be default, the converted time will be in AM-PM 12-hours format (1-12).

GetSystemTime
RC RJ TID SDC WR SE2
( )

C, GetSystemTime, SystemTime

C, GetSystemTime, "SystemTime"

C, GetSystemTime, "^SystemTime"

C, SetVariableValues, ^SystemTime="CurrentTime" C, GetSystemTime, ^SystemTime

C, GetSystemTime, SystemMilitaryTime, True

Field 3 :VariableName
The name of the variable to receive the System Time.
The name of the variable to receive the System Time. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Field [4]:GetMilitaryTime
If true, the converted time is in 24-hours military time format
If this is true, the converted time will be in 24-hours military time format (0-23). If this parameter is omitted, it is false be default, the converted time will be in AM-PM 12-hours format (1-12).

GetURL
SE2
( )

C, GetURL, "http://rest.api.url", "response", "60"

C, GetURL, "http://rest.api.url?var1=value&var2=value", "response"

C, GetURL, "http://rest.api.url", "response", "", "Accept", "text/*", "Accept-Charset", "UTF-8"

Field 3 :URL
The URL to request.

Field 4 :Variable
The name of the variable holding the response sent back from the server.
Some suffixes can be appended to the variable name to form new variable holding other values, suffixes list as below:

.readyState contains 'AJAX Ready State Code', such as "0", "1", "2", "3" and "4".

.headers contains the response headers

.status contains the HTTP status code, such as "200", "404" etc.

.statusText contains the HTTP status text, such as "OK", "Not Found" etc.

.xml contains the XML response if it exists.

Field [5]:Timeout
The timeout (in seconds) waiting for the response from HTTP server. The default value is 120 seconds.

Field [6]:HeaderName
The HTTP request header name.

Field [7]:HeaderValue
The value to set for the HTTP request header.

GetVersion
RJ TID SDC
( )

C Version var

Field 3 :Variable
A variable to accept the VERSION

HideSoftKeyboard
DRD
( )

C, HideSoftKeyboard

HighLight
TC SE2
( )

C, HighLight, ON

C, HighLight, OFF

Field [3]:Mode
The status for highlight functionality. It can be On or Off. The Default is OFF.

LaunchApplication
DRD RC RJ TID IOS SDC SE2 WR
( W, F )

C, LaunchApplication, NotePad, "notepad.exe c:\sample.txt"

C, LaunchApplication, NotePad, SampleFile

C, LaunchApplication, MainAUT, "c:\MyApp.EXE", , , MainAppMap.MAP

C, LaunchApplication, MainAUT, "c:\AppDir\MyApp.EXE", "c:\AppDir\", "-s -e -automation", MainAppMap.MAP

C, LaunchApplication, MyIOSApp, MyAppTemplate, TheWorkDir

C,LaunchApplication,MyIOSApp, "/Library/safs/samples/UICatalog/UICatalogInstruments.tracetemplate", "/Library/safs/samples/UICatalog/"

C, LaunchApplication, MyIOSApp, MyAppTemplate, TheWorkDir, "-d:iPad2 (v5.0) -app:UICatalog"

Field 3 :ApplicationID
A text ID or name to reference the application
A text ID or name to reference the application. Something to call it during possible future references in DDE tables or scripts. This is different than a window ID. It is what we want to call the App itself.

Field 4 :ExecutablePath
The path, filename, and parameters for the executable OR an ApplicationConstant.
The path and filename to the executable OR an ApplicationConstant.
This can and should include the full command line syntax with application specific command line parameters unless the application is unable to successfully handle this invocation.
This ExecutablePath parameter may instead contain a reference to an ApplicationConstant from the currently active Application Map. The value of the retrieved constant will be used as the ExecutablePath.

For IOS: This should resolve to the full path to the Instruments trace template that will be used to launch the application.

Field [5]:WorkDir
A Working Directory for the application (if required)
A Working Directory for the application (if required). Do not provide this if it is not required by the application. If you DO provide this then the DDE cannot automatically terminate the application if things go really bad.
For IOS: This should resolve to be the path to the directory that will contain the Instruments output log.

Field [6]:CMDLineParam
Separate command line parameters for the application (if required).
Command line parameters for the application (if required). Do not provide this if it is not required by the application.
For RRAFS: Try to include all command line parameters within the ExecutablePath
If you DO provide separate command line paratmeters then the RRAFS DDE cannot automatically terminate the application if things go really bad.
For IOS Device testing: the device and application must be specified exactly as they will appear in the Instruments "Choose Target" configuration menus. The parameters should be specified inline as:

-d [DeviceMenuItem] -app [AppNameMenuItem]

Example: "-d Carls iPad (v5.0) -app UICatalog"
For IOS Simulator testing: this parameter is not needed and should not contain any -d or -app options.
For compatibility with different inputrecord separators, the SAFS/IOS engine supports different delimiters to be used with -d and -app. Supported Delimiters are (:;, ).
Examples:

"-d:Carls iPad (v5.0) -app:UICatalog"

"-d;Carls iPad (v5.0) -app;UICatalog"

"-d,Carls iPad (v5.0) -app,UICatalog"

"-d Carls iPad (v5.0) -app UICatalog"

(Of course, you cannot use a comma delimiter here if the inputrecord itself is comma delimited.)

Field [7]:AppMap
Filename to the Application Map for the application.
Filename to the Application Map for the application. You can provide a short filename (no path) if the map file can be found by the FindSQAFile function. Typically, the AppMap is placed in the project's Datapool directory.

NotifyAndWait
TID SDC
( )

C, NotifyAndWait, "Fix the app state and then press OK."

C, NotifyAndWait, "Fix the app state and then press OK.", "Fix Application"

Field 3 :Message
The text message to be displayed in the dialog.
The text message to be displayed in the dialog. The message should not contain the inputrecord field separator character nor linefeeds or carriage returns.

Field [4]:Title
A short user-defined title for the dialog.
A short user-defined title for the dialog. The message should not contain the inputrecord field separator character nor linefeeds or carriage returns.

Pause
RC RJ TID SDC WR SE2
( )

C, Pause, 30

Field 3 :Timeout
The number of seconds to Pause.

SaveClipboardToFile
RC RJ TID SDC DRD SE2
( )

C, SaveClipboardToFile, C:\Temp\myclipboard.txt

C, SaveClipboardToFile, Datapool\myclipboard.txt

C, SaveClipboardToFile, myclipboard.txt

C, SaveClipboardToFile, C:\Temp\myclipboard.txt, "ANSI"

Field 3 :File
The file to save the clipboard contents to.
The file to save the clipboard contents to. This can be a full path, a relative path, or a file name. For relative path, it is appended to the project's path to build the full path of the file. For file name, the file is saved under the project's Datapool\Test directory. In any case the parent folder of the file must exist.

Field [4]:Encoding
The encoding used to write a file.
The encoding used to write a file. If user doesn't specify this parameter, the "UTF-8" encoding will be used.

SaveURLToFile
SE2
( )

C, SaveURLToFile, "http://rest.api.url", "reponse.txt", "60"

C, SaveURLToFile, "http://rest.api.url?var1=value&var2=value", "result\reponse.txt"

C, SaveURLToFile, "http://rest.api.url", "c:\test\result\reponse.txt", "", "Accept", "text/*", "Accept-Charset", "UTF-8"

Field 3 :URL
The URL to request.

Field 4 :File
The name of the file holding the response sent back from the server.
The file to save the response from the server. This can be a full path, a relative path, or a file name. For relative path, it is appended to the project's path to build the full path of the file. For file name, the file is saved under the project's test directory (it is Datapool\Test in SAFS or Acturals in SE+). In any case the parent folder of the file must exist.

Field [5]:Timeout
The timeout (in seconds) waiting for the response from HTTP server. The default value is 120 seconds.

Field [6]:HeaderName
The HTTP request header name.

Field [7]:HeaderValue
The value to set for the HTTP request header.

ScrollWheel
RJ TC SE2
( )

C, ScrollWheel, "10"

Field 3 :numClicks
The number of mouse wheel clicks to move. .
The number of mouse wheel clicks to move.A postive value indicates the wheel was moved forward (up) and a negative value indicates the wheel was moved backward (down).

SendEmail
TID SE2
( )

C, SendEmail, "TestSuite@company.com", "TestMonitor@company.com", "TestSuite Results Report" ,"PASSED"

C, SendEmail, "TestSuite@company.com", "TestMonitor@company.com;bob.cares@company.com", "TestSuite Screenshot" , "Screenshot Feature 2", "fullpath/To/Test/ScreenShotF2.jpg"

Field 3 :From
Email address sending the Email.
Email address of the user or system sending the email.

Field 4 :To
Email addresses to receive the email.
Email addresses to receive the email. Multiple addresses can be specified with semicolon or comma separators--whichever is NOT the field separator for the record.

Field 5 :Subject
The Subject of the email.

Field [6]:Message
Text or HTML message.
Text or HTML message can be specified. HTML message requires HTML tag to work properly. The message cannot contain the field separator for the record.

Field [7]:Attachment
Email attachment file path
Email attachment file path. Multiple filepaths (files) can be specified with semicolons or comma separators--whichever is NOT the field separator for the record.

SetApplicationMap
RC TID WR SE2
( )

C, SetApplicationMap, NotePad.Map

C, SetApplicationMap, "C:\SomeDir\NewApp.Map"

Field 3 :ApplicationMap
The path and/or filename of the Application Map to use
The path and/or filename of the Application Map to use. The short filename without the path can be used if the file can be found via FindSQAFile. Typically, the AppMap is located in the project's Datapool directory.

SetBenchDirectory
RC RJ TID SDC
( )

C, SetBenchDirectory, "C:\MyRepo\MyProject\AltPath\Bench"

C, SetBenchDirectory, "AltPath\Bench"

Field 3 :Path
The full or project relative path to the new directory.

SetClipboard
RJ TID SDC DRD SE2
( )

C, SetClipboard, "This should go into the clipboard"

Field 3 :Str
The string to set the clipboard contents to.
The string to set the clipboard contents to.

SetContext
RC RJ WR SE TC
( )

C, SetContext, AWindow, AWindow

C, SetContext, AWindow, AComponent

Field 3 :WindowID
A Window reference from the AppMap

Field 4 :ComponentID
A reference from the AppMap for the Component within the Window.
A reference from the AppMap for the Component within the Window. If the Window is the item of interest then both the WindowID and ComponentID will be the same.

SetDifDirectory
RC RJ TID SDC
( )

C, SetDifDirectory, "C:\MyRepo\MyProject\AltPath\Dif"

C, SetDifDirectory, "AltPath\Dif"

Field 3 :Path
The full or project relative path to the new directory.

SetFocus
RC RJ WR SE TC AUT
( W, F )

C, SetFocus, AWindow, AWindow

C, SetFocus, AWindow, AComponent

Field 3 :WindowID
A Window reference from the AppMap

Field 4 :ComponentID
A reference from the AppMap for the Component within the Window to get input focus.
A reference from the AppMap for the Component within the Window to get input focus. If the Window is the item of interest then both the WindowID and ComponentID will be the same.
This only works on Windows or Components that have a valid Windows HANDLE (HWND) and can legally receive the focus at the time of the call.

SetImageDebug
TID SE2
( )

C, SetImageDebug, ON

C, SetImageDebug, Nope

Field 3 :Mode
The boolean status for enabling extended image debugging.
Valid case-insensitive values to enable are "TRUE", "ON", "YES", "1", and "-1". All other values will disable this mode.

SetImageFuzzyMatching
TID SE2
( )

C, SetImageFuzzyMatching, ON

C, SetImageFuzzyMatching, OFF

Field 3 :Mode
The boolean status for enabling extended image-based fuzzy matching.
Valid case-insensitive values to enable are "TRUE", "ON", "YES", "1", and "-1". All other values will disable this mode.

SetMillisBetweenRecords
TID
( )

C, SetMillisBetweenRecords, 1000

Field 3 :Value
The value of the pause between two records.
The value of the pause between two records.

SetMultipleThreadSearch
TID SE2
( )

C, SetProjectDirectory, "On"

Field 3 :OnOrOff
Turn on or turn off multi-thread-search. This parameter should be given as "On" or "Off".

SetProjectDirectory
RJ TID SDC
( )

C, SetProjectDirectory, "C:\MyRepo\MyProject\AltPath"

Field 3 :Path
The full path to the new directory.

SetRootVerifyDirectory
RC RJ TID SDC
( )

C, SetRootVerifyDirectory, "C:\MyRepo\MyProject\AltPath"

C, SetRootDirectory, "AltPath"

Field 3 :Path
The full or project relative path to the root directory for Bench, Test, and Dif.

SetSecsAfterWindowActive
RJ
( )

C, SetSecsAfterWindowActive, 1

Field 3 :Value
The value of the delay after window is activated.
The value of the delay after window is activated.

SetSecsBeforeMouseDown
RJ
( )

C, SetSecsBeforeMouseDown, 0.1

Field 3 :Value
The value of the delay before mouse down.
The value of the delay before mouse down.

SetSecsBeforeMouseUp
RJ
( )

C, SetSecsBeforeMouseUp, 0.1

Field 3 :Value
The value of the delay before mouse up.
The value of the delay before mouse up.

SetSecsDelayRetryComponent
RJ
( )

C, SetSecsDelayRetryComponent, 1

Field 3 :Value
The value of the delay of re-finding object.
The value of the delay of re-finding object.

SetSecsSeekComponent
RJ
( )

C, SetSecsSeekComponent, 1

Field 3 :VariableName
The value of the timeout of finding object.
The value of the timeout of finding object.

SetTestDirectory
RC RJ TID SDC
( )

C, SetTestDirectory, "C:\MyRepo\MyProject\AltPath\Test"

C, SetTestDirectory, "AltPath\Test"

Field 3 :Path
The full or project relative path to the new directory.

SetVariableValueEx
RC RJ TID SDC SE2
( )

C, SetVariableValueEx, var, value

C, SetVariableValueEx, ^varname, value

C, SetVariableValueEx, ^basename & ^index, value

Field 3 :VariableName
The name of the variable

Field 4 :VariableValue
The value to assign to the variable

SetVariableValues
RC RJ TID SDC WR SE2
( )

C, SetVariableValues, ^var1=value

C, SetVariableValues, ^var1=value, ^var2=value2, ^var3=^var1

Field 3 :VariableName
The name of the variable along with its value assignment

ShowSoftKeyboard
DRD
( )

C, ShowSoftKeyboard

StartWebBrowser
RC RJ TID SDC WR SE SE2
( )

C, StartWebBrowser

C, StartWebBrowser, "", WebBrowser

C, StartWebBrowser, "http://aUrl.jsp", WebBrowser

C, StartWebBrowser, "http://aUrl.jsp"

C, StartWebBrowser, "http://aUrl.jsp", "", "FirstTestPage", "firefox", 20

C, StartWebBrowser, "http://aUrl.jsp", "", "FirstTestPage", "firefox", 20, "", "KEY_PROXY_SETTING", "proxy-server:80"

C, StartWebBrowser, "http://www.google.com", "", "GoogleMain", "firefox", 20, "", "FirefoxProfile", "myprofile"

C, StartWebBrowser, "http://www.google.com", "", "GoogleMain", "chrome", 20, "", "user-data-dir", "c:\chrome_custom_data"

C, StartWebBrowser, "http://www.google.com", "", "GoogleMain", "chrome", 20, "", "user-data-dir", "C:\Users\xxx\AppData\Local\Google\Chrome\User Data"

C, StartWebBrowser, "http://www.google.com", "", "GoogleMain", "chrome", 20, "", "user-data-dir", "C:\Users\xxx\AppData\Local\Google\Chrome\User Data", "profile-directory", "Profile 1"

C, StartWebBrowser, "http://www.google.com", "", "GoogleMain", "chrome", 20, "", "excludeSwitches", "disable-component-update; ignore-certificate-errors"

Field [3]:URL
URL of a web resource to load in the new browser instance.
This field can be empty which may produce different results in different browsers. When using the system default browser on Windows, this empty field will typically generate a blank web page, or an "about:blank" page.
Some browsers, like Internet Explorer, support other URLs like "about:home"-- which will launch the browser and display whatever the Home page is set to. However, not all browsers support this.
For consistency, it is usually necessary to include the full URL syntax--including the protocol portion of the URL (http://, https://, ftp://, etc..).

Field [4]:WindowTag
A WindowTag or Browser ID to call the new browser instance.
This Tag might be used by some test tools to track specific browser instances, but not all test tools are able to support this type of browser Tagging.
SE2The identifier used to store the webdriver for the opened browser. It can be used to switch between opened browsers or close one of them.

Field [5]:BrowserName
SE2The browser to open. It can be "explorer", "chrome" or "firefox". "firefox" is default.

Field [6]:timeout
SE2Specifies the amount of time the selenium web driver should wait when searching for an element if it is not immediately present.

Field [7]:IsRemoteBrowser
SE2True = use Selenium RemoteDriver.
True = use Selenium RemoteDriver. Otherwise, use the FirefoxDriver, ChromeDriver or InternetExplorerDriver.
This parameter is ignored now for SE2 as it always uses a RemoteDriver.

Field [8]:ExtraParamKey
SE2The extra parameter key. You can use one of Extra parameter keys.

Field [9]:ExtraParamValue
SE2The value of the extra parameter indicated by ExtraParamKey above.

StopWebBrowser
SE2
( )

C, StopWebBrowser

C, StopWebBrowser, "FirstTestPage"

Field [3]:BrowserID
The identifier used to get the webdriver for the opened browser. This ID is assigned by user during calling keyword StartWebBrowser.

SwitchWindow
SE2
( )

C, SwitchWindow, "Google"

C, SwitchWindow, "[G|g]oogle"

C, SwitchWindow, "Google", "TestGooglePage"

C, SwitchWindow, "Google", "TestGooglePage" ,2

C, SwitchWindow, "gle", "TestGooglePage", 2, true

C, SwitchWindow, "Goog", "TestGooglePage", 2, true, false

Field 3 :Title
The Title of the window to switch to.
The title can be a normal string; a wildcard string or a regular-expression string.

Field [4]:BrowserID
The ID representing the opened browser from where to search the window.
The browser ID is assigned by user when calling StartWebBrowser. This parameter is optional, if not provided then the last opened browser will be used.

Field [5]:ExpectedMatchIndex
If 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.
The default index is 1, which means the first matched window will be returned.

Field [6]:PartialMatch
If the parameter 'title' will match partially (be sub-string) with the title of the existing windows.
The default value is false; which means that the parameter 'title' should be fully matched.
This parameter will only be valid if the parameter 'title' is normal string.

Field [7]:IgnoreCase
If the parameter 'title' will match case-insentitively with the title of the existing windows.
The default value is true; which means that the parameter 'title' will be matched case insensitively.
This parameter will only be valid if the parameter 'title' is normal string.

TakeScreenShot
DRD TID SE2
( )

C, TakeScreenShot, "screenshot.png", Yes

C, TakeScreenShot, "d:\temp\image\screenshot.png", No

C, TakeScreenShot, "image\screenshot.png"

C, TakeScreenShot, "screenshotPart.png", , "0;0;50%;50%"

Field 3 :FileName
The file to store the screeshot. (For Android Engine, the screenshot is device/emulator's)
The file to store the screeshot. (For Android Engine, the screenshot is device/emulator's) It can be a full path name; If it is only a filename, the image will be stored to sub directory "test" of your project; If it is a filename including path-separator, it will be concatanated to the "datapool" of your project to create a fullpath file.

Field [4]:Rotatable
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.
For other Engine, this parameter will be ignored. For Android Engine, if the android application is rotatable, that is to say the application will adjust its direction and keep upstraight when you rotate your device. If the android application is rotatable and this parameter is set to False, the screenshot maybe upside down.

Field [5]:SubArea
Optional sbuarea indicating partial image of the screen to capture.
Optional sbuarea indicating partial image of the screen to capture. The value must be in the format of a top-left and bottom-right pair, and can be either absolute coordinates or percentages ("x1,y1,x2,y2" or "x1%,y1%,x2%,y2%"). Coordinates are relative to the screen, i.e. (0,0) and (0%,0%) are the minimum, and (SCREEN_WIDTH, SCREEN_HEIGHT) and (100%,100%) are the maximum. Values exceeding the minimun/ maximum are forced to the nearest limiting value. Absolute and percent values can be mixed, so "0,0,50%,50%" is valid. If this parameter is omitted, full image of the screen is captured (equivalent to "0,0,100%,100%").

UseAbbotFunctions
TID
( W )

C, UseAbbotFunctions, ON

Field 3 :Mode
The switch status for enabling the preference of the engine. Valid values are "ON" and "OFF".

UseDroidFunctions
TID
( W )

C, UseDroidFunctions, ON

Field 3 :Mode
The switch status for enabling the use of the Droid hook. Valid values are "ON" and "OFF".

UseIOSFunctions
TID
( W )

C, UseIOSFunctions, ON

Field 3 :Mode
The switch status for enabling the preference of the engine. Valid values are "ON" and "OFF".

UseQTPFunctions
TID
( W )

C, UseQTPFunctions, ON

Field 3 :Mode
The switch status for enabling the preference of the engine. Valid values are "ON" and "OFF".

UseRobotJFunctions
RC TID
( W )

C, UseRobotJFunctions, ON

Field 3 :Mode
The switch status for enabling the use of the RobotJ hook. Valid values are "ON" and "OFF".

UseSAFSFunctions
RC TID
( W )

C, UseSAFSFunctions, ON

Field 3 :Mode
The switch status for enabling the use of the SAFS hook. Valid values are "ON" and "OFF".

UseSeleniumFunctions
RC TID
( W )

C, UseSeleniumFunctions, ON

Field 3 :Mode
The switch status for enabling the use of the Selenium hook. Valid values are "ON" and "OFF".

UseTestCompleteFunctions
TID
( W )

C, UseTestCompleteFunctions, ON

Field 3 :Mode
The switch status for enabling the preference of the engine. Valid values are "ON" and "OFF".

UseWebBrowser
SE2
( )

C, UseWebBrowser

C, UseWebBrowser, "FirstTestPage"

Field [3]:BrowserID
The identifier used to get the webdriver for the opened browser. This ID is assigned by user during calling keyword StartWebBrowser.

VerifyClipboardToFile
RJ TID SDC DRD SE2
( )

C, VerifyClipboardToFile, myclipboard.txt

C, VerifyClipboardToFile, C:\Temp\myclipboard.txt

C, VerifyClipboardToFile, C:\Temp\myclipboard.txt, "Ansi"

Field 3 :BenchmarkFile
The name of the file used as the comparison benchmark.
The name of the file used as the comparison benchmark.
Typically, benchmarks are stored in the Datapool\Bench directory. In that event, only the filename.ext is needed.

Field [4]:Encoding
The encoding used to read a file.
The encoding used to read a file. If user doesn't specify this parameter, the "UTF-8" encoding will be used.

VerifyURLContent
SE2
( )

C, VerifyURLContent, "http://rest.api.url", "some expected response content", "60"

C, VerifyURLContent, "http://rest.api.url?var1=value&var2=value", "some expected response content"

C, VerifyURLContent, "http://rest.api.url", "some expected response content", "60", "Accept", "text/*", "Accept-Charset", "UTF-8"

Field 3 :URL
The URL to request.

Field 4 :BenchContent
The bench content to be compared with the response sent back from the server.

Field [5]:Timeout
The timeout (in seconds) waiting for the response from HTTP server. The default value is 120 seconds.

Field [6]:HeaderName
The HTTP request header name.

Field [7]:HeaderValue
The value to set for the HTTP request header.

VerifyURLToFile
SE2
( )

C, VerifyURLToFile, "http://rest.api.url", "reponse.txt"

C, VerifyURLToFile, "http://rest.api.url?var1=value&var2=value", "compare\reponse.txt"

C, VerifyURLToFile, "http://rest.api.url", "c:\test\compare\reponse.txt", "60", "Accept", "text/*", "Accept-Charset", "UTF-8"

Field 3 :URL
The URL to request.

Field 4 :BenchFile
The name of the bench file holding the content to be compared with the response sent back from the server.
The bench file can be a full path, a relative path, or a file name. For relative path, it is appended to the project's path to build the full path of the file. For file name, the file is supposed under the project's bench directory (it is Datapool\Bench in SAFS or Benchmarks in SE+). In any case the parent folder of the file must exist.

Field [5]:Timeout
The timeout (in seconds) waiting for the response from HTTP server. The default value is 120 seconds.

Field [6]:HeaderName
The HTTP request header name.

Field [7]:HeaderValue
The value to set for the HTTP request header.

Version
RC TID WR
( )

C Version 1.0

Field 3 :Version
The VERSION of the table format. Initially "1.0"

WaitForGUI
DRD RC RJ TID WR SE SE2 TC AUT
( W, F )

C, WaitForGUI, AWindow, AWindow

C, WaitForGUI, AWindow, AWindow, 10

C, WaitForGUI, AWindow, AComponent, 10

Field 3 :WindowID
A Window reference from the AppMap

Field 4 :ComponentID
A reference from the AppMap for the Component within the Window to wait for.
A reference from the AppMap for the Component within the Window to wait for. If the Window is the item of interest then both the WindowID and ComponentID will be the same.

Field [5]:Timeout
Timeout value in seconds before exiting automatically.

WaitForGUIGone
DRD RC RJ TID WR TC SE2 AUT
( W, F )

C, WaitForGUIGone, AWindow, AWindow

C, WaitForGUIGone, AWindow, AWindow, 10

C, WaitForGUIGone, AWindow, AComponent, 10

Field 3 :WindowID
A Window reference from the AppMap

Field 4 :ComponentID
A reference from the AppMap for the Component within the Window to watch.
A reference from the AppMap for the Component within the Window to watch. If the Window is the item of interest then both the WindowID and ComponentID will be the same.

Field [5]:Timeout
Timeout value in seconds before exiting automatically.

WaitForPropertyValue
RC RJ WR TC
( W, F )

C, WaitForPropertyValue, AWindow, AWindow, "Visible", "True"

C, WaitForPropertyValue, WebBrowser, BrowserDoc, "readyState", "Complete", 45

C, WaitForPropertyValue, AWindow, AWindow, visible, "True", 5, "CASEINSENSITIVE"

C, WaitForPropertyValue, AWindow, AWindow, visible, True, , "FALSE"

Field 3 :WindowID
A Window reference from the AppMap

Field 4 :ComponentID
A reference from the AppMap for the Component within the Window.
A reference from the AppMap for the Component within the Window. If the Window is the item of interest then both the WindowID and ComponentID will be the same.

Field 5 :PropertyName
Case-sensitive name of the object property to watch.

Field 6 :ExpectedValue
Case-sensitive value of the object property to match.

Field [7]:Timeout
Timeout value in seconds before exiting automatically.

Field [8]:CaseInsensitive
Values of "CASE-INSENSITIVE", "CASEINSENSITIVE", and "FALSE" will cause the comparison of the property value and the expected value to ignore case.
All engines may not support this parameter at this time.

WaitForPropertyValueGone
RC RJ WR TC
( W, F )

C, WaitForPropertyValueGone, AWindow, AWindow, "Visible", "False"

C, WaitForPropertyValueGone, WebBrowser, BrowserDoc, "readyState", "Loading", 45

C, WaitForPropertyValueGone, AWindow, AWindow, visible, "True", 5, "CASEINSENSITIVE"

C, WaitForPropertyValueGone, AWindow, AWindow, visible, True, , "FALSE"

Field 3 :WindowID
A Window reference from the AppMap

Field 4 :ComponentID
A reference from the AppMap for the Component within the Window.
A reference from the AppMap for the Component within the Window. If the Window is the item of interest then both the WindowID and ComponentID will be the same.

Field 5 :PropertyName
Case-sensitive name of the object property to watch.

Field 6 :ExpectedValue
Case-sensitive known value of the property to change to something else.

Field [7]:Timeout
Timeout value in seconds before exiting automatically.

Field [8]:CaseInsensitive
Values of "CASE-INSENSITIVE", "CASEINSENSITIVE", and "FALSE" will cause the comparison of the property value and the expected value to ignore case.
All engines may not support this parameter at this time.

WaitForRegistryKeyExists
RJ SDC TID SE2
( )

C, WaitForRegistryKeyExists, "HKLM\Software\Rational Software\Rational Test\8", "Install Directory", 5

C, WaitForRegistryKeyExists, "HKLM\Software\Rational Software\Rational Test\8", "", 0

C, WaitForRegistryKeyExists, "HKLM\Software\Rational Software\Rational Test\8"

Field 3 :Key
The Registry Key name to seek.

Field [4]:KeyValue
The value name under the parent key to seek.
The value name under the parent key. If not provided then we just check to see if the provided parent key exists.

Field [5]:Timeout
Timeout value in seconds before exiting automatically.

WaitForRegistryKeyValue
RJ SDC TID SE2
( )

C, WaitForRegistryKeyValue, "HKLM\Software\Adobe\CommonFiles", "UsageCount", "0x1"

C, WaitForRegistryKeyValue, "HKLM\Software\Adobe\CommonFiles", "UsageCount", "0x1", 45

C, WaitForRegistryKeyValue, "HKLM\Software\Adobe\CommonFiles", "UsageCount", "0X1", 5, CASEINSENSITIVE

C, WaitForRegistryKeyValue, "HKLM\Software\Adobe\CommonFiles", "UsageCount", "0X1", "", FALSE

Field 3 :Key
The Registry Key name to seek

Field 4 :KeyValue
The value name under the parent key to seek.
The value name under the parent key. If not provided then we just check to see if the provided parent key exists.

Field 5 :ExpectedValue
Case-sensitive value to match with the key value.

Field [6]:Timeout
Timeout value in seconds before exiting automatically.

Field [7]:CaseInsensitive
Values of "CASE-INSENSITIVE", "CASEINSENSITIVE", and "FALSE" will cause the comparison of the key value and the expected value to ignore case.
All engines may not support this parameter at this time.

WaitForWebPage
RC RJ WR SE
( W, F )

C, WaitForWebPage

C, WaitForWebPage, "", "", 60

C, WaitForWebPage, MainWebApp, TOCFrameDoc, 20

Field [3]:WindowID
A Window reference from the AppMap
If ComponentID is provided then providing WindowID is REQUIRED.

Field [4]:ComponentID
A reference from the AppMap for the Frame/HTMLDocument within WindowID to wait for.
If this parameter is provided then providing WindowID is REQUIRED.

Field [5]:Timeout
Timeout value in seconds before exiting automatically.

DDDriverCounterCommands

DDDriverCounterCommands Documentation.

DeleteCounter
RC TID WR
( )

C, DeleteCounter, "TestCase 124", "All done"

Field 3 :counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.

Field [4]:Description
Any additional information for deleting this counter.

LogCounterInfo
RC TID WR SE2
( )

C, LogCounterInfo, "TestCase 124"

Field 3 :counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.

Field [4]:logName
(Future) The name of a Log Facility other than the "current" one.
When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the Status Report.

ResetCounter
RC TID WR
( )

C, ResetCounter, "TestCase 124", "Zero all counts to retest"

Field 3 :counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.

Field [4]:Description
Any additional information for resetting this counter.

ResumeStatusCounts
RC TID WR SE2
( )

C, ResumeStatusCounts, "Done resetting the application"

Field [3]:Description
Any additional information for resuming status counts.

Field [4]:logName
(Future) The name of a Log Facility other than the "current" one.
When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the notice.

SetCounterMode
RC TID WR
( )

C, SetCounterMode, "TestCase 124", "StepTestsOnly"

C, SetCounterMode, "TestCase 124", "2"

Field 3 :counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.

Field 4 :mode
The counting mode to use for the specified counter.
Currently supported modes are:

"AllStatusInfo" or "1"

"StepTestsOnly" or "2"

Consult AUSetStatusCounterMode for more information on private counters.

StartCounter
RC TID WR SE2
( )

C, StartCounter, "TestCase 124", "Verify we can login."

Field 3 :counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.

Field [4]:Description
Any additional information such as the purpose of the counter.

StartCycle
RC TID WR
( )

C StartCycle Option1

C StartCycle Option1 "Integration Testing"

Field 3 :CycleID
The user-defined ID of the item.

Field [4]:Description
A description of the item.

StartProcedure
RC TID WR
( )

C StartProcedure Option1

C StartProcedure Option1 "Entering New Users"

Field 3 :ProcedureID
The user-defined ID of the item.

Field [4]:Description
A description of the item.

StartRequirement
RC TID WR
( )

C StartRequirement Option1

C StartRequirement Option1 "It Must Compile"

Field 3 :RequirementID
The user-defined ID of the item.

Field [4]:Description
A description of the item.

StartSuite
RC TID WR SE2
( )

C StartSuite Option1

C StartSuite Option1 "Data Testing"

Field 3 :SuiteID
The user-defined ID of the item.

Field [4]:Description
A description of the item.

StartTestcase
RC TID WR SE2
( )

C StartTestcase Option1

C StartTestcase Option1 "It Must Compile"

Field 3 :TestCaseID
The user-defined ID of the Testcase.

Field [4]:Description
A description of the Testcase

StopCounter
RC TID WR SE2
( )

C, StopCounter, "TestCase 124", "Done testing Login"

Field 3 :counterID
The unique name used to identify this private counter.
These unique names are case-insensitive.

Field [4]:Description
Any additional information for stopping this counter.

StopCycle
RC TID WR
( )

C StopCycle Option1

C StopCycle Option1 "Integration Testing"

Field 3 :CycleID
The user-defined ID of the item.

Field [4]:Description
A description of the item.

StopProcedure
RC TID WR
( )

C StopProcedure Option1

C StopProcedure Option1 "Entering New Users"

Field 3 :ProcedureID
The user-defined ID of the item.

Field [4]:Description
A description of the item.

StopRequirement
RC TID WR
( )

C StopRequirement Option1

C StopRequirement Option1 "It Must Compile"

Field 3 :RequirementID
The user-defined ID of the item.

Field [4]:Description
A description of the item.

StopSuite
RC TID WR
( )

C StopSuite Option1

C StopSuite Option1 "Data Tests"

Field 3 :SuiteID
The user-defined ID of the item.

Field [4]:Description
A description of the item.

StopTestcase
RC TID WR SE2
( )

C StopTestcase Option1

C StopTestcase Option1 "It Must Compile"

Field 3 :TestCaseID
The user-defined ID of the Testcase.

Field [4]:Description
A description of the Testcase

StoreCounterInfo
RC TID WR SE2
( )

C, StoreCounterInfo, ^counter="TestCase 124", ^varPrefix="TestCase124"

Field 3 :counterID
The unique name used to identify the private counter.
These unique names are case-insensitive.

Field 4 :varPrefix
The unique DDVariable prefix to use for storing counter values.
The DDVariable prefix will be used to create several DDVariables that will hold the counter information.
The variables stored:

VARPREFIX.successes

VARPREFIX.warnings

VARPREFIX.general_failures

VARPREFIX.test_passes

VARPREFIX.test_warnings

VARPREFIX.test_failures

VARPREFIX.test_records

VARPREFIX.total_records

VARPREFIX.IO_failures

VARPREFIX.skipped_records

VARPREFIX.filename

VARPREFIX.id

VARPREFIX.mode

VARPREFIX.suspended

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.

SuspendStatusCounts
RC TID WR SE2
( )

C, SuspendStatusCounts, "Resetting the application"

Field [3]:Description
Any additional information for suspending status counts.

Field [4]:logName
(Future) The name of a Log Facility other than the "current" one.
When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the notice.

DDDriverDatabaseCommands

DDDriverDatabaseCommands Documentation.

CopyDBTableColumnToFile
RJ TID SDC
( )

C, CopyDBTableColumnToFile, ADBAlias, ATableAlias, DataSourceName, OutputFileName, SQLQuery, OutputDirectory, sqlStatus, "|"

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :FileOut
Name of the output file.

Field 7 :SQLQuery
The file will contain the results of the executed Query. The query is NOT validated by this function.

Field [8]:DirectoryOut
OPTIONAL parameter. If not specified the file will be stored in the default test directory

Field [9]:SQLStatus
A variable which holds the current SQL run status.

Field [10]:Delimiter
Optional Delimiter to be used between columns written to file.

Field [11]:UserID
UserID for accessing the Datasource (if required).

Field [12]:Password
Password for accessing the Datasource (if required).

CopyDBTableToFile
RJ TID SDC
( )

C, CopyDBTableToFile, ADBAlias, ATableAlias, Data Source Name (dsn), OutputFileName, tableName, [ColumnCount],[rowCount], [SQLQuery], [Delimiter], [OutputDirectory], sqlStatus, "[UID]", "[PWD]"

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :FileOut
Name of the output file.

Field 7 :DBTableName
Name of the TABLE to access within the DBSourceName

Field [8]:ColumnCount
If specified the output file will contain only the number of columns specified.

OPTIONAL parameter. If specified the output file will contain only the number of columns specified. This number will become the first dimension of the retreival array. If NOT specified then no maximum.

Field [9]:RowCount
If specified the output file will contain only the number of rows specified.

OPTIONAL parameter. If specified the output file will contain only the number of columns specified. This number will become the first dimension of the retreival array. If NOT specified then no maximum.

Field [10]:SQLQuery
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 ""

Field [11]:delimiter
OPTIONAL parameter. If not specified the default ',' seperator will be used.

Field [12]:DirectoryOut
OPTIONAL parameter. If not specified the file will be stored in the default test directory

Field [13]:SQLStatus
A variable which holds the current SQL run status.

Field [14]:UserID
UserID for accessing the Datasource (if required).

Field [15]:Password
Password for accessing the Datasource (if required).

DeleteDBTableRecords
RJ TID SDC
( )

C, DeleteDBTableRecords, ADBAlias, ATableAlias, Clients, "CID = 25", ContactDatabase, "", "", sqlStatusVar

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 6 :DBQueryCond
Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
A query condition can be included, if not then "" is supplied. 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'".
"where" will be added to any expression if it is not provided.

Field 7 :DBSourceName
Name of the Datasource containing the DBTable

Field [8]:UserID
UserID for accessing the Datasource (if required).

Field [9]:Password
Password for accessing the Datasource (if required).

Field [10]:SQLStatus
SQL status code as a result of executing the query gets stored in this variable

ExecSQLQuery
RJ TID SDC
( )

C, ExecSQLQuery, ADBAlias, ATableAlias, empODBC, "UPDATE Employee Set City = 'Pittsburgh' Where EmpID = '0023' ", sqlStatus

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :queryStr
Actual query stored in a queryStr.

Field 7 :SQLStatusCode
SQL status code as a result of executing the query.

Field [8]:UserID
UserID for accessing the Datasource (if required).

Field [9]:Password
Password for accessing the Datasource (if required).

GetDBTableColumnCount
RJ TID SDC
( )

C, GetDBTableColumnCount, ADBAlias, ATableAlias, empODBC, Employee, columnCount, sqlStatus

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 7 :ColumnCount
SQL result get stored in this return variable.

Field 8 :SQLStatusCode
SQL status code as a result of executing the query.

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

GetDBTableRowCount
RJ TID SDC
( )

C, GetDBTableRowCount, ADBAlias, ATableAlias, empODBC, Employee, rowCount, sqlStatus

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 7 :RowCount
SQL result get stored in this return variable.

Field 8 :SQLStatusCode
SQL status code as a result of executing the query.

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

GetDBValue
RJ TID SDC
( )

C, GetDBValue, ADBAlias, ATableAlias, empODBC, "Select LastName From Employee Where EmpID = '0023'", queryResult, sqlStatus

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :queryStr
Actual query stored in a queryStr.

Field 7 :QueryResult
SQL result get stored in this return variable.

Field 8 :SQLStatusCode
SQL status code as a result of executing the query.

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

SetJdbcDriver
RJ TID SDC
( )

C, SetJdbcDriver, "oracle.jdbc.driver.OracleDriver"

Field 3 :DriverClassName
Name of the driver class

VerifyDatabaseNullValue
RJ TID SDC
( )

C, VerifyDatabaseNullValue, ADBAlias, ATableAlias, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", sqlStatusVariable

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBFieldName
Name of the FIELD within DBTableName used in the verification

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 7 :DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included, if not then "" must be supplied. 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'".
"where" will be added to any expression if it is not provided.

Field 8 :DBSourceName
Name of the Datasource containing the DBTable

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field [11]:SQLStatus
SQL status code as a result of executing the query gets stored in this variable

VerifyDatabaseValue
RJ TID SDC
( )

C, VerifyDBValue, ADBAlias, ATableAlias, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", "Smith", sqlStatusVariable

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBFieldName
Name of the FIELD within DBTableName used in the verification

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 7 :DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included, if not then "" must be supplied. 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'".
"where" will be added to any expression if it is not provided.

Field 8 :DBSourceName
Name of the Datasource containing the DBTable

Field 9 :UserID
UserID for accessing the Datasource (if required, if not then "" must be supplied).

Field 10 :Password
Password for accessing the Datasource (if required, if not then "" must be supplied).

Field 11 :ExpectedValue
Benchmark value to compare against retrieved DBFieldName value

Field [12]:SQLStatus
SQL status code as a result of executing the query gets stored in this variable

VerifyDBNullValue
RJ TID SDC
( )

C, VerifyDBNullValue, ADBAlias, ATableAlias, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", sqlStatusVariable

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBFieldName
Name of the FIELD within DBTableName used in the verification

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 7 :DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included, if not then "" must be supplied. 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'".
"where" will be added to any expression if it is not provided.

Field 8 :DBSourceName
Name of the Datasource containing the DBTable

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field [11]:SQLStatus
SQL status code as a result of executing the query gets stored in this variable

VerifyDBValue
RJ TID SDC
( )

C, VerifyDBValue, ADBAlias, ATableAlias, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", "Smith", sqlStatusVariable

Field 3 :ADBAlias
not used

Field 4 :ATableAlias
not used

Field 5 :DBFieldName
Name of the FIELD within DBTableName used in the verification

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 7 :DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included, if not then "" must be supplied. 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'".
"where" will be added to any expression if it is not provided.

Field 8 :DBSourceName
Name of the Datasource containing the DBTable

Field 9 :UserID
UserID for accessing the Datasource (if required, if not then "" must be supplied).

Field 10 :Password
Password for accessing the Datasource (if required, if not then "" must be supplied).

Field 11 :ExpectedValue
Benchmark value to compare against retrieved DBFieldName value

Field [12]:SQLStatus
SQL status code as a result of executing the query gets stored in this variable

DDDriverDebugCommands

DDDriverDebugCommands Documentation.

Breakpoints
RC RJ TID SDC WR
( )

C, Breakpoints, ON

Field 3 :Mode
The status for this debug mode.

CommandDebug
RC RJ TID SDC WR
( )

C, CommandDebug, ON

Field 3 :Mode
The status for this debug mode.

RecordsDebug
RC RJ TID SDC WR
( )

C, RecordsDebug, ON

Field 3 :Mode
The status for this debug mode.

TestDebug
RC RJ TID SDC WR
( )

C, TestDebug, ON

Field 3 :Mode
The status for this debug mode.

DDDriverFileCommands

DDDriverFileCommands Documentation.

CloseFile
RC RJ TID SDC SE2
( )

C, CloseFile, 8

C, CloseFile, ^file_number

Field 3 :FileNumber
The file number for the file to be closed.

CopyFile
RC RJ TID SDC SE2
( )

C, CopyFile, "C:/Test/Test1.txt" , "C:/Test/Test2.txt"

C, CopyFile, "C:/Test/Test1.txt" , "Test2.txt"

C, CopyFile, "Test1.txt" , "Test2.txt"

C, CopyFile, "Test1.txt" , "/w32/Results/Test1.txt"

Field 3 :FromFileName
The file path and file name for the file to be copied.

Field 4 :ToFileName
The file path and file name to copy the file to.

CopyMatchingFiles
RJ TID SDC SE2
( )

C, CopyMatchingFiles, "C:\Test", "C\Test2", "file?.*"

C, CopyMatchingFiles, "Datapool\Test\MyTestOutput", "C:\MyTestOutput", "file.*\.java", REGEXP

Field 3 :FromDirectoryName
The directory name where the files are located.
The directory name where the files are located. The directory can be a fully-qualified path or a path that is relative to the SAFS Automation Project Directory.

Field 4 :ToDirectoryName
The directory name where the files are copied.
The directory name where the files are copied. The directory can be a fully-qualified path or a path that is relative to the SAFS Automation Project Directory. This directory must already exist prior to execution.

Field 5 :Pattern
The pattern used to distinguish the files/sub-directories to be copied.

Field [6]:FilterMode
The filter mode used for matching the files/sub-directories to be copied. Default is WILDCARD.
Supported filter modes include:

FilterMode Comments

WILDCARD Default. Includes support for * and ? wildcard characters

REGEXP Includes support for Regular Expression pattern matching

CreateDirectory
RC RJ TID SDC SE2
( )

C, CreateDirectory, "C:/Test/SubTest"

Field 3 :DirectoryName
The full directory path name for the directory to be created.

CreateFile
RC RJ TID SDC SE2
( )

C, CreateFile, "C:\Test\FileTest.txt", "Output", "Write","^test_filenum"

C, CreateFile, "C:\Test\FileTest.txt", "Output", "Write","^test_filenum", 8

Field 3 :FileName
The full path file name of the file to be opened.

Field 4 :Mode
Mode to be used to create and open the file, Input, Output or Append. Random and Binary not supported

Field 5 :Access
Access to be used to create and open the file. Read, Write or Read Write.

Field 6 :FileNumberVariable
DDE Variable name of the variable to store the file number.

Field [7]:FileNumber
Optional File number to be used to open the file Otherwise next available file number is used

DeleteDirectory
RC RJ TID SDC SE2
( )

C, DeleteDirectory, "C:/Test/SubTest"

Field 3 :DirectoryName
The full directory path name for the directory to be deleted.

DeleteDirectoryContents
RJ TID SDC SE2
( )

C, DeleteDirectoryContents, "Datapool\Test"

C, DeleteDirectoryContents, "C:\Test\SubTest", true

Field 3 :DirectoryName
The directory name in which the contents will be deleted.
The directory name in which the contents will be deleted. The directory can be a fully-qualified path or a path that is relative to the SAFS Automation Project Directory.

Field [4]:DeleteDir
Indicate whether you want to also delete the directory with true or false. Default is false.

DeleteFile
RC RJ TID SDC SE2
( )

C, DeleteFile, "Test1.txt"

C, DeleteFile, "C:/test/Test1.tst"

C, DeleteFile, "C:/test/Test1.tst", "NoVerify"

Field 3 :FileName
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.

Field [4]:NoVerify
String Equal to "NOVERIFY" if file is not verified prior to deleting.

FilterImage
RJ TID SDC SE2
( )

C, FilterImage, "C:\in.jpg", "C:\out.jpg", COORD, 30;40;50;60 50%;30%;75%;50%

C_ FilterImage_ "C:\in.jpg"_ "C:\out.jpg"_ COORD_ 30,40,50,60

Field 3 :InputFilename
The input image file (FULL PATH)

Field 4 :OutputFilename
The output image file after filtering (FULL PATH)
The output image file after filtering (FULL PATH). The output image may overwrite the input image.

Field 5 :FilterMode
Mode by which the image is filtered
Mode by which the image is filtered. Currently, the only supported FilterMode is COORD.

Field 6 :Coords
Required parameter for the COORD FilterMode that defines the rectangle(s) of the input image that are to be filtered out.
Required parameter for the COORD FilterMode that defines the rectangles of the input image that are to be filtered out. Value of this app map reference must be in the format of a top-left and bottom-right pair, and can be either absolute coordinates or percentages ("x1,y1,x2,y2" or "x1%,y1%,x2%,y2%"). Coordinates are relative to the image, i.e. (0,0) and (0%,0%) are the minimum, and (image width, image height) and (100%,100%) are the maximum. Values exceeding the minimum/ maximum are forced to the nearest limiting value. Absolute and percent values can be mixed, so "0,0,50%,50%" is valid.
Note: Java-based engines like RFT should support using either a comma (,) or a semi-colon (;) as the Coords item separator. Also, there should be a space char separating each set of rectangle coordinates.

FilterTextFile
RC RJ TID SDC SE2
( )

C, FilterTextFile, C:\Temp\myfile.txt

C, FilterTextFile, C:\Temp\myfile.txt, RegExp, "19\d\d BC", "Last Centry"

C, FilterTextFile, myfile.txt, RegExp, "19\d\d BC", "Last Centry", CaseInsensitive

C, FilterTextFile, Datapool\myfile.txt, RegExp, "19\d\d BC"

C, FilterTextFile, Datapool\myfile.txt, RegExp, "19\d\d BC", , , "UTF-8"

Field 3 :File
The file to be filtered.
The file to be filtered. This can be a full path, a relative path, or a file name. For relative path, it is appended to the project's path to build the full path of the file. For file name, the file is saved under the project's Datapool\Test directory. In any case the parent folder of the file must exist.

Field 4 :FilterMode
The filter mode.
The filter mode.
"REGEXP" (Regular Expressions) is currently the only supported FILTERMODE that actually filters anything.

Field [5]:FilterOptions
Additional filter options.
Additional filter options. Depending on the filter mode, some filter options are required.

FILTERMODE FIELDS COMMENTS

Default(empty) (None) Default filtering. File is unchanged.

"RegExp" 5 - PATTERN (Required) REGEXP pattern to match for filtering. All occurrences of text in a file that match regular expression PATTERN will be removed and replaced with the REPLACE string (if any).

6 - REPLACE (Optional) Default value for REPLACE is "" (empty string). This tells REGEXP to remove matching PATTERN text from the file. Specifying a REPLACE string will remove matching PATTERN text from the file and insert the REPLACE string in its place.

7 - CASE (Optional) CASE specifies the case-sensitivity used when searching for matching text in the file. Use "CaseInsensitive" to ignore case when searching.
If not specified the default implementation is a CaseSensitive compare.

Field [6]:Encoding
The encoding to use to read and write file.
If user doesn't provide this parameter, program will detect the encoding automatically. If no encoding is provided and detected, program will use system default encoding.
If user provide this paramter, FilterOptions must be present (can be blank).

FindSqaFile
RC TID SDC
( )

C, FindSqaFile, "Test1.txt" , "^filepath"

C, FindSqaFile, "C:Test1.txt" , "^filepath"

Field 3 :FileName
The file path and file name of the file to be found.

Field 4 :FilePathVariable
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
RC RJ TID SDC SE2
( )

C, GetFileDateTime, "Test1.txt" , "^filedate"

C, GetFileDateTime, "C:\Test1.txt" , "^filedate"

C, GetFileDateTime, "C:\Test1.txt" , "^filedate", true, "Created"

C, GetFileDateTime, "C:\Test1.txt" , "^filedate", , "LastAccessed"

Field 3 :FileName
The file path and file name of the file to get the file date and time.

Field 4 :FileDateVariable
Name of the DDV variable to be used to store the file date and time

Field [5]:GetMilitaryTime
If true, the converted time is in 24-hours military time format
If this is true, the converted time will be in 24-hours military time format (0-23). If this parameter is omitted, it is false be default, the converted time will be in AM-PM 12-hours format (1-12). If not provided, by default it is false.

Field [6]:DateTimeType
You can get different date and time by providing a different value.
You have 3 options:

Created: get the created date and time for the file

LastModified: get the last modified date and time for the file

LastAccessed: get the last accessed date and time for the file

If not provided, by default it is "LastModified".

GetFileProtections
RJ TID SDC SE2
( )

C, GetFileProtections, "C:\afile.txt" , varName

Field 3 :FileName
The file path and file name of the file to get the file attribute.

Field 4 :VarName
variable name to place the attributes in

GetFiles
RC RJ TID SDC SE2
( )

C, GetFiles, "C:/Test", "D:/Test/filelist.txt", "16"

C, GetFiles, "C:/Test", "D:/Test/filelist.txt"

C, GetFiles,"^directory", "^file_list"

Field 3 :Directory
The full name of the directory to be searched for files.

Field 4 :FileName
Full file path and name of the file to store list of files found in the directory

Field [5]:FileAttributes
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.

Search directory using following file attributes. Default value is 0 - normal file.

0 - Normal file, returns only files without other attributes set

1 - Read Only file

2 - Hidden file

4 - System file (Window OS Only)

8 - Volume Label (Exclusive, if set, no other attribute counts.)

16 - Directory

32 - Archive file (Windows OS: attrib with 'A'; Other OS: file suffix is .jar, .tar, .rar, .gz etc.)

The values in the table can be added together to select multiple attributes.

For example, to list hidden and system files in addition to normal files set FileAttributes to 6 (6=2+4).

If FileAttributes is set to 8 (Volume Label), then returns the volume label of the drive specified in the pathname$, or of the current drive if drive is not explicitly specified.

If volume label attribute is set, all other attributes are ignored.

GetFileSize
RC RJ TID SDC SE2
( )

C, GetFileSize, "Test1.txt" , "^filesize"

C, GetFileSize, "C:Test1.txt" , "^filepath"

Field 3 :FileName
The file path and file name of the file to get file size.

Field 4 :FileSizeVariable
Name of the DDV variable to be used to store the file size of the file.

GetINIFileValue
RJ TID SDC SE2
( )

C, GetINIFileValue, "test.INI", Section, Item, Variable

C, GetINIFileValue, "C:\test.INI", Section, Item, Variable

Field 3 :FileName
The name of the file.
Note: For Java-based tools like RJ, TID, and SDC this can be a relative path filename. If the value is a simple filename with no path information then the file will be sought in the Project\Datapool\Runtime directory. If there is some relative path information provided then the file will be sought relative to the Project directory. then the file will be sought

Field 4 :Section
The Section of the file to look in.

Field 5 :Item
The item to look for.

Field 6 :Variable
Name of the DDV variable to be used to store the file date and time

GetStringCountInFile
RJ TID SDC SE2
( )

C, GetStringCountInFile, "\tidtest.ini", "SAFS_TEST"

C, GetStringCountInFile, "somefile.txt", "sample text", MyCounter

C, GetStringCountInFile, "somefile.txt", "SamPLe TexT", MyCounter, "CaseInsensitive"

C, GetStringCountInFile, "somefile.txt", "SamPLe TexT", MyCounter, "CaseInsensitive", "UTF-8"

Field 3 :File
The File to be searched.
This can be a full filepath, a relative path, or a simple filename. A relative path is appended to the Project's path to deduce the full filename. For a simple filename, the filename is appended to the Project's Datapool\Test directory path to deduce the full filename. An error will be logged if the file does not exist, or cannot be read.

Field 4 :String
The string to match and count in the file.

Field [5]:VarName
The name of the variable to receive the count.
Optional. This command should automatically clear the variable value to "0" before counting. If no variable name is provided, then a default variable name of 'GetStringCountInFile' will be used.

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive.
Optional. Comparisons are case-sensitive by default.

Field [7]:Encoding
Charset encoding string like "UTF-8", etc...
Optional. If not specified the default system encoding is assumed.

GetSubstringsInFile
RJ TID SDC SE2
( )

C GetSubstringsInFile ^file=^fullfilename ^regexstart="img id=""idChart" ^regexstop="""" ^rootname="Chart"

Field 3 :file
Fully-qualified filename

Field 4 :regexstart
The starting regular expression. Should not be empty.

Field 5 :regexstop
The stopping regular expression. Should not be empty.

Field 6 :rootname
The root name of the returned variable(s).
The rootname is used as a base to build the DDVariable names which contain the located substring(s). 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.

GetTextFromImage
RJ SDC TID SE2
( )

C, GetTextFromImage, image.gif, Var1, TOCR, en, 2.0

Field 3 :ImageFile
The name of the image file used to detect text in it.
The name of the image file used to detect text in it. The name of the text file used to store detected text. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.
The extension of the image file can be .bmp, .jpg, .gif, .tif, .png or .pnm.

Field 4 :VariableName
The name of the variable to receive detected text.
The name of the variable to receive detected text. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpreted as the name of the variable you wish to use.

Field [5]:OCRId
OCRId indicating the OCR used to recognize text.
Two OCR engines are supported. "TOCR" will be taken as default if the parameter is blank. "TOCR" stands for Tesseract OCR; "GOCR" stands for GOCR.
Note: Seems TOCR performs a bit better than GOCR (personal experience).

Field [6]:LangId
Optional LangId representing the language in use for selected OCR to recognize text.
For both TOCR and GOCR, only English is supported so far. Language Id takes standard language code, which can be gotten by calling Locale.ENGLISH.getLanguage().
LangId Language "en" --- English "cn" --- Chinese

If LangId is not specified with blank or empty string, the language of System locale will be used as default.

Field [7]:ScaleRatio
Optional ScaleRatio indicating the scale ratio for resizing the original image.
To fit in font size and DPI required by OCR, SAFS needs to resize images before sending them to OCR engines. For screen-captured images with 96DPI, TOCR takes 1.9 as default; GOCR takes 1.5 as default. You may try different ScaleRatio to find an appropriate value if default setting is unable to meet your requirement.

IfExistDir
RJ TID SDC SE2
( )

C, IfExistDir, "C:\temp\9\7", DeleteDirectory, "C:\temp\9\7"

Field 3 :DirectoryName
The full path name of directory to test for

Field 4 :ThenDriverCommand
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
RJ TID SDC SE2
( )

C, IfExistFile, "C:\temp\9\7\6.txt", DeleteFile, "C:\temp\9\7\6.txt"

Field 3 :FileName
The full path name of file to test for

Field 4 :ThenDriverCommand
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
RJ TID SDC SE2
( )

C, IsEndOfFile, 8, variable

Field 3 :FileNumber
The file number for the file to be closed.

Field 4 :Variable
Variable to assign true or false

OpenFile
RC RJ TID SDC SE2
( )

C, OpenFile, "C:\Test\FileTest.txt", "Input", "Read","test_filenum"

C, OpenFile, "C:\Test\FileTest.txt", "Output", "Write","test_filenum",8

Field 3 :FileName
The full path file name of the file to be opened.

Field 4 :Mode
Mode to be used to open the file, Input, Output, Append, and AppendRaw.
Text Files only. Random Access and Binary files are not supported.
Append Mode generally rewrites existing file contents with a NEWLINE between textual lines--stripping out OS-specific newline characters and making the file the same regardless of the platform.
AppendRaw Mode rewrites existing file contents without modification before appending any new data to the file.

Field 5 :Access
Access to be used to open the file. Read, Write or Read Write.

Field 6 :FileNumberVariable
DDE Variable name of the variable to store the file number.

Field [7]:FileNumber
Optional File number to be used to open the file Otherwise next available file number is used

OpenUTF8File
RJ TID SDC SE2
( )

C, OpenUTF8File, "C:\Test\FileTestUTF8.txt", "Input", "Read","test_filenum"

C, OpenUTF8File, "C:\Test\FileTestUTF8.txt", "Output", "Write","test_filenum",8

Field 3 :FileName
The full path file name of the UTF-8 file to be opened.

Field 4 :Mode
Mode to be used to open the file, Input, Output, Append, and AppendRaw.
Text Files only. Random Access and Binary files are not supported.
Append Mode generally rewrites existing file contents with a NEWLINE between textual lines--stripping out OS-specific newline characters and making the file the same regardless of the platform.
AppendRaw Mode rewrites existing file contents without modification before appending any new data to the file.

Field 5 :Access
Access to be used to open the UTF-8 file. Read, Write or Read Write.

Field 6 :FileNumberVariable
DDE Variable name of the variable to store the file number.

Field [7]:FileNumber
Optional File number to be used to open the UTF-8 file, otherwise, next available file number is used.

PrintToFile
RC RJ TID SDC SE2
( )

C, PrinttoFile, 3, ^printexp="This text printed to file",";"

C, PrinttoFile, ^filenumb, ^tempstring,","

C, PrinttoFile, ^filenumb, ^tempstring

Field 3 :FileNumber
The file number of the file to be written to.

Field 4 :ExpressionListVariable
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.

Field [5]:PrintOutputPlacement
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
RC RJ TID SDC SE2
( )

C, ReadFileChars, ^filenum , 5,"^charread"

C, ReadFileChars, 8, 5,"^charread"

C, ReadFileChars, 8, -1,"^charread"

Field 3 :FileNumber
The file number of the file to be read from.

Field 4 :NumberOfChar
Number of characters to be read from the file
If the number is -1, then the whole content will be read .

Field 5 :VariableName
Name of the DDV variable in which to store the characters read from the file

ReadFileLine
RC RJ TID SDC SE2
( )

C, ReadFileLine, ^filenum , "^line"

Field 3 :FileNumber
The file number of the file to be read from.

Field 4 :VariableName
Name of the DDV variable in which to store the line read from the file

ReadFileString
RC
( )

C, ReadFileString, ^filenum , "value"

Field 3 :FileNumber
The file number of the file to be read from.

Field 4 :VariableName
Name of the DDVariable in which to store the value read from the file.

RenameFile
RC RJ TID SDC SE2
( )

C, RenameFile, "C:/Test/Test1.txt" , "C:/Test/Test2.txt"

C, RenameFile, "C:/Test/Test1.txt" , "C:/Test/Test2.txt","NOVERIFY"

Field 3 :OldFileName
The file path and file name of the file to be renamed.

Field 4 :NewFileName
The new file path and file name of the file.

Field [5]:NoVerify
String Equal to "NOVERIFY" if file is not verified prior to renaming.

SaveTextFromImage
RJ SDC TID SE2
( )

C, SaveTextFromImage, image.gif, ocr.txt, TOCR, en,

Field 3 :ImageFile
The name of the image file used to detect text in it.
The name of the image file used to detect text in it. The name of the text file used to store detected text. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.
The extension of the image file can be .bmp, .jpg, .gif, .tif, .png or .pnm.

Field 4 :OutputFile
The name of the text file used to store detected text.
The name of the text file used to store detected text. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [5]:OCRId
OCRId indicating the OCR used to recognize text.
Two OCR engines are supported. "TOCR" will be taken as default if the parameter is blank. "TOCR" stands for Tesseract OCR; "GOCR" stands for GOCR.
Note: Seems TOCR performs a bit better than GOCR (personal experience).

Field [6]:LangId
Optional LangId representing the language in use for selected OCR to recognize text.
For both TOCR and GOCR, only English is supported so far. Language Id takes standard language code, which can be gotten by calling Locale.ENGLISH.getLanguage().
LangId Language "en" --- English "cn" --- Chinese

If LangId is not specified with blank or empty string, the language of System locale will be used as default.

Field [7]:ScaleRatio
Optional ScaleRatio indicating the scale ratio for resizing the original image.
To fit in font size and DPI required by OCR, SAFS needs to resize images before sending them to OCR engines. For screen-captured images with 96DPI, TOCR takes 1.9 as default; GOCR takes 1.5 as default. You may try different ScaleRatio to find an appropriate value if default setting is unable to meet your requirement.

SetFileProtections
RC RJ TID SDC SE2
( )

C, SetFileProtections, "Test1.txt" , 1

C, SetFileProtections, "C:Test1.txt" , 0

Field 3 :FileName
The file path and file name of the file change the file attribute.

Field 4 :FileProtection
New value of the attribute of the file to be changed

WriteFileChars
RJ TID SDC SE2
( )

C, WriteFileChars, 3, all, ^expression

C, WriteFileChars, ^filenumb, 4, "Text Output"

Field 3 :FileNumber
The file number/identifier of the file to be written to.

Field 4 :NumberOfChars
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.

Field 5 :ExpressionList
Expression List, if it begins with ^ then it is treated as a variable.

DDDriverFlowCommands

DDDriverFlowCommands Documentation.

CallCycle
RC TID WR
( )

C, CallCycle, "MyCycle"

C, CallCycle, "MyCycle", ";"

C, CallCycle, "AnotherCycle", "", ^FName="John", ^LName="Smith"

Field 3 :CycleName
The name of the Cycle table to execute.

Field [4]:CycleSeparator
The field separator used by the table--if required.
Only necessary if the table uses a different field separator than that already set for CycleDriver. Use an empty string or an empty field to keep the field separator already in use.
Typically, all the tables use the same separator so this can usually be left empty.

Field [5]:ParameterName
One or more parameter values to send to the Cycle--each in their own field.

CallJUnit
TID
( )

C, CallJUnit, "com.sas.spock.tests.SpockExperiment"

C, CallJUnit, "myapp.tests.APITest myapp.tests.RESTTest"

Field 3 :ClassName
The name of one or more Classes to execute.
Class names are in the normal full package.Class format. Multiple classes can be separated by SEMI-COLONs, COLONs, COMMAs, or SPACES-- whichever is NOT being used as the test record separator. The same separator should be used between all Classes.
The Classes to execute must be findable within the JVM ClassPath.

CallScript
SE2 RC IOS RJ WR
( )

C, CallScript, "MyScript"

C, CallScript, "AnotherScript", ^FName="John", ^LName="Smith"

Field 3 :ScriptName
The name of the Script to execute.

Field [4]:ParameterName
One or more parameter values to send to the script--each in their own field.

CallStep
RC TID WR
( )

C, CallStep, "AnotherStepTable"

C, CallStep, "MyStep", ";"

C, CallStep, "AnotherStep", "", ^FName="John", ^LName="Smith"

Field 3 :StepName
The name of the StepTable to execute.

Field [4]:StepSeparator
The field separator used by the Step table--if required.
Only necessary if the table uses a different field separator than that already set for StepDriver. Use an empty string or an empty field to keep the field separator already in use.
Typically, all the tables use the same separator so this can usually be left empty.

Field [5]:ParameterName
One or more parameter values to send to the table--each in their own field.

CallSuite
RC TID WR
( )

C, CallSuite, "MySuite"

C, CallSuite, "MySuite", ";"

C, CallSuite, "AnotherSuite", "", ^FName="John", ^LName="Smith"

Field 3 :SuiteName
The name of the Suite to execute.

Field [4]:SuiteSeparator
The field separator used by the Suite--if required.
The field separator used by the Suite--if required.
Only necessary if the Suite uses a different field separator than that already set for SuiteDriver. Use an empty string or an empty field to keep the field separator already in use.
Typically, all the tables use the same separator so this can usually be left empty.

Field [5]:ParameterName
One or more parameter values to send to the suite--each in their own field.

ExitCycle
RC TID WR
( )

C, ExitCycle

ExitSuite
RC TID WR
( )

C, ExitSuite

ExitTable
RC TID WR
( )

C, ExitTable

GotoBlockID
RC TID WR
( )

C, GotoBlockID, "ErrorHandler"

Field 3 :BlockID
The name of the block to Goto.

OnContainsGotoBlockID
RC TID WR
( )

C, OnContainsGotoBlockID, "NoError", Value1, Value2

C, OnContainsGotoBlockID, "NoError", Value1, VALUE1, CaseInsensitive

C, OnContainsGotoBlockID, "NoError", ^Value1, Value2

C, OnContainsGotoBlockID, "NoError", ^Value1, ^Value2

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The value to be searched for the Value2 substring

Field 5 :Value2
A string to search Value1 for an occurance of

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

OnDirectoryExistGotoBlockID
RC WR TID
( )

C, OnDirectoryExistGoToBlockId, DirectoryExist, "DirectoryName"

C, OnDirectoryExistGoToBlockId, DirectoryExist, DirectoryName, CaseInsensitive

Field 3 :BlockID
The name of the block to Goto.

Field 4 :DirectoryName
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
RC WR TID
( )

C, OnDirectoryNotExistGoToBlockId, DirectoryNotExist, DirectoryName

C, OnDirectoryNotExistGoToBlockId, DirectoryNotExist, DirectoryName, CaseInsensitive

Field 3 :BlockID
The name of the block to Goto.

Field 4 :DirectoryName
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
RC TID WR
( )

C, OnEqualGotoBlockID, "NoError", Value1, Value2

C, OnEqualGotoBlockID, "NoError", Value1, VALUE1, CaseInsensitive

C, OnEqualGotoBlockID, "NoError", ^Value1, Value2

C, OnEqualGotoBlockID, "NoError", ^Value1, ^Value2

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The first value for the comparison.

Field 5 :Value2
The second value for the comparison.

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

OnFileEOFGotoBlockID
RC RJ
( )

C, OnFileEOFGoToBlockId, "FileEOF", "FileNumber"

Field 3 :BlockID
The name of the block to Goto.

Field 4 :FileNumber
The file number of the file to be verified for EOF.

OnFileExistGotoBlockID
RC WR TID
( )

C, OnFileExistGoToBlockId, FileExist, "FileName"

C, OnFileExistGoToBlockId, FileExist, FileName, CaseInsensitive

Field 3 :BlockID
The name of the block to Goto.

Field 4 :FileName
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
RC WR TID
( )

C, OnFileNotExistGoToBlockId, FileNotExist, FileName

C, OnFileNotExistGoToBlockId, FileNotExist, FileName, CaseInsensitive

Field 3 :BlockID
The name of the block to Goto.

Field 4 :FileName
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
RC TID WR
( )

C, OnGreaterThanGotoBlockID, "NoError", Val2, Val1

C, OnGreaterThanGotoBlockID, "NoError", 500, 100

C, OnGreaterThanGotoBlockID, "NoError", ^Val1, ^Val2

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The value to be compared.

Field 5 :Value2
The value to be compared against.

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

OnGUIExistsGotoBlockID
DRD IOS RC RJ TID WR SE SE2 TC
( )

C, OnGUIExistsGotoBlockID, "WindowExists", AWindow, AWindow

C, OnGUIExistsGotoBlockID, "ButtonExists", AWindow, AButton, 10

Field 3 :BlockID
The name of the block to Goto.

Field 4 :WindowID
A Window reference from the app map.

Field 5 :ComponentID
A reference from the app map for the Component within the Window.
A reference from the app map for the Component within the Window. If the Window is the item of interest then both the WindowID and ComponentID will be the same.

Field [6]:TimeOut
Timeout value in seconds before exiting automatically (no branch).

OnGUINotExistGotoBlockID
DRD IOS RC RJ TID WR SE SE2 TC
( )

C, OnGUINotExistGotoBlockID, "WindowNotExist", AWindow, AWindow

C, OnGUINotExistGotoBlockID, "ButtonNotExist", AWindow, AButton, 10

Field 3 :BlockID
The name of the block to Goto.

Field 4 :WindowID
A Window reference from the app map.

Field 5 :ComponentID
A reference from the app map for the Component within the Window.
A reference from the app map for the Component within the Window. If the Window is the item of interest then both the WindowID and ComponentID will be the same.

Field [6]:TimeOut
Timeout value in seconds before exiting automatically (no branch).

OnInRangeGotoBlockID
RC TID WR
( )

C, OnInRangeGotoBlockID, "NoError", Val22, Val21, Val31

C, OnInRangeGotoBlockID, "NoError", 200, 100, 500

C, OnInRangeGotoBlockID, "NoError", ^Val1, ^Val2, ^Val3

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The value to be compared.

Field 5 :Value2
The low end of range to be compared against.

Field 6 :Value3
The high end of range to be compared against.

Field [7]:CaseSensitive
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

OnLessThanGotoBlockID
RC TID WR
( )

C, OnLessThanGotoBlockID, "NoError", Val1, Val2

C, OnLessThanGotoBlockID, "NoError", 100, 200

C, OnLessThanGotoBlockID, "NoError", ^Val1, ^Val2

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The value to be compared.

Field 5 :Value2
The value to be compared against.

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

OnMenuItemContainsStateGotoBlockID
RC RJ
( W )

C, OnMenuItemContainsStateGotoBlockID, "NoError", MainWindow, MainWindow, "View->Error", "Disabled"

Field 3 :BlockID
The name of the block to transfer control to if state is part of the state information of the menuitem.

Field 4 :WindowName
The window name.

Field 5 :ComponentName
The component name.

Field 6 :MenuItem
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.

Field 7 :State
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
TID RC
( )

C, OnNotContainsGotoBlockID, "NoError", Value1, Value2

C, OnNotContainsGotoBlockID, "NoError", Value1, VALUE1, CaseInsensitive

C, OnNotContainsGotoBlockID, "NoError", ^Value1, Value2

C, OnNotContainsGotoBlockID, "NoError", ^Value1, ^Value2

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The value to be searched for the Value2 substring

Field 5 :Value2
The substring to seek in VALUE1

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

OnNotEqualGotoBlockID
RC TID WR
( )

C, OnNotEqualGotoBlockID, "NoError", Value1, Value2

C, OnNotEqualGotoBlockID, "NoError", Value1, VALUE1, CaseInsensitive

C, OnNotEqualGotoBlockID, "NoError", 100, 200

C, OnNotEqualGotoBlockID, "NoError", ^Value1, ^Value2

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The first value for the comparison.

Field 5 :Value2
The second value for the comparison.

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

OnNotGreaterThanGotoBlockID
TID
( )

C, OnNotGreaterThanGotoBlockID, "NoError", Val1, Val2

C, OnNotGreaterThanGotoBlockID, "NoError", Val1, Val1

C, OnNotGreaterThanGotoBlockID, "NoError", Val2, Val1

C, OnNotGreaterThanGotoBlockID, "NoError", 100, 500

C, OnNotGreaterThanGotoBlockID, "NoError", ^Val1, ^Val2

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The value expected to be NOT greater than VALUE2.

Field 5 :Value2
The value expected to be equal or greater than VALUE1.

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so comparisons are NOT case-sensitive. Comparisons are case-sensitive by default.

OnNotInRangeGotoBlockID
RC TID WR
( )

C, OnNotInRangeGotoBlockID, "NoError", Val11, Val21, Val31

C, OnNotInRangeGotoBlockID, "NoError", 100, 200, 500

C, OnNotInRangeGotoBlockID, "NoError", ^Val1, ^Val2, ^Val3

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The value to be compared.

Field 5 :Value2
The low end of range to be compared against.

Field 6 :Value3
The high end of range to be compared against.

Field [7]:CaseSensitive
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

OnNotLessThanGotoBlockID
TID
( )

C, OnNotLessThanGotoBlockID, "NoError", Val2, Val1

C, OnNotLessThanGotoBlockID, "NoError", Val1, Val1

C, OnNotLessThanGotoBlockID, "NoError", Val1, Val2

C, OnNotLessThanGotoBlockID, "NoError", 200, 100

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Value1
The value that should be NOT less than VALUE2.

Field 5 :Value2
The value that should be equal or less than VALUE1.

Field [6]:CaseSensitive
Set to 'CaseInsensitive' so string comparisons are NOT case-sensitive. String Comparisons are case-sensitive by default.

OnPartialMenuItemContainsStateGotoBlockID
RC
( W )

C, OnMenuItemContainsStateGotoBlockID, "NoError", MainWindow, MainWindow, "View->Error", "Disabled"

Field 3 :BlockID
The name of the block to transfer control to if state is part of the state information of the menuitem.

Field 4 :WindowName
The window name.

Field 5 :ComponentName
The component name.

Field 6 :MenuItem
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.

Field 7 :State
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
TID SDC
( W )

C, OnRegistryKeyExistGotoBlockID, IBM_BLOCK, "HKLM\Software\Rational Software\Rational Test\8", "Install Directory", 0

C, OnRegistryKeyExistGotoBlockID, RJ_INSTALLED, "HKLM\Software\Rational Software\Rational Test\8", "Rational FT Install Directory"

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Key
The Registry Key to seek.

Field [5]:KeyValue
The optional Registry subkey value to seek.
The value name under the parent key. If not provided then we just check to see if the provided parent key exists.

Field [6]:TimeOut
Timeout value in seconds before exiting automatically (no branch).

OnRegistryKeyNotExistGotoBlockID
TID SDC
( W )

C, OnRegistryKeyNotExistGotoBlockID, NO_RATIONAL, "HKLM\Software\Rational Software\Rational Test\8", "Install Directory", 0

C, OnRegistryKeyNotExistGotoBlockID, NO_RFT, "HKLM\Software\Rational Software\Rational Test\8", "Rational FT Install Directory"

Field 3 :BlockID
The name of the block to Goto.

Field 4 :Key
The Registry Key to seek.

Field [5]:KeyValue
The optional Registry subkey value to seek.
The value name under the parent key. If not provided then we just check to see if the provided parent key exists.

Field [6]:TimeOut
Timeout value in seconds before exiting automatically (no branch).

SetExitTableBlock
RC TID WR
( )

C, SetExitTableBlock, "ProcessExit"

C, SetExitTableBlock, ""

Field [3]:BlockID
The name of the block to Goto when ExitTable is encountered.

SetGeneralScriptFailureBlock
RC TID WR
( )

C, SetGeneralScriptFailureBlock, "ErrorHandler"

C, SetGeneralScriptFailureBlock, ""

Field [3]:BlockID
The name of the block to Goto on status GeneralScriptFailure.

SetInvalidFileIOBlock
RC TID WR
( )

C, SetInvalidFileIOBlock, "IOHandler"

C, SetInvalidFileIOBlock, ""

Field [3]:BlockID
The name of the block to Goto on status InvalidFileIO.

SetNoScriptFailureBlock
RC TID WR
( )

C, SetNoScriptFailureBlock, "NoError"

C, SetNoScriptFailureBlock, ""

Field [3]:BlockID
The name of the block to Goto on status NoScriptFailure.

SetScriptNotExecutedBlock
RC TID WR
( )

C, SetScriptNotExecutedBlock, "AbortHandler"

C, SetScriptNotExecutedBlock, ""

Field [3]:BlockID
The name of the block to Goto on status ScriptNotExecuted.

SetScriptWarningBlock
RC TID WR
( )

C, SetScriptWarningBlock, "WarningHandler"

C, SetScriptWarningBlock, ""

Field [3]:BlockID
The name of the block to Goto on status ScriptWarning.

UseLocalFlowControl
TID
( )

C, UseLocalFlowControl

C, UseLocalFlowControl, TRUE

C, UseLocalFlowControl, FALSE

Field [3]:State
The TRUE or FALSE value to use.
If no value is provided then "TRUE" will be assumed.

DDDriverLogCommands

DDDriverLogCommands Documentation.

LogFailureOK
RC WR TID
( )

C LogFailureOK "Values should not match."

C LogFailureOK "Throw exception." "Data is out of bounds."

Field 3 :Message
The message to log.

Field [4]:Details
Additional detail to add to the message.

LogMessage
RC WR TID SE2
( )

C LogMessage "Starting Test 1"

C LogMessage "Starting Test 1" "Start Login Tests"

Field 3 :Message
The message to log.

Field [4]:Details
Additional detail to add to the message.

LogTestFailure
RC WR TID SE2
( )

C LogTestFailure "Failed Test 1"

C LogTestFailure "Failed Test 1" "Failed Login Tests"

Field 3 :Message
The message to log.

Field [4]:Details
Additional detail to add to the message.

LogTestSuccess
RC WR TID SE2
( )

C LogTestSuccess "Test 1 Passed"

C LogTestSuccess "Test 1 Passed" "Test 1 is good"

Field 3 :Message
The message to log.

Field [4]:Details
Additional detail to add to the message.

LogTestWarning
RC WR TID SE2
( )

C LogTestWarning "Test 1 may have problems"

C LogTestWarning "Test 1 may have problems" "Test 1 did not complete"

Field 3 :Message
The message to log.

Field [4]:Details
Additional detail to add to the message.

LogWarningOK
RC WR TID
( )

C LogWarningOK "No value specified."

C LogWarningOK "No value specified" "Using default value."

Field 3 :Message
The message to log.

Field [4]:Details
Additional detail to add to the message.

ResumeLogging
RC TID SE2
( )

C, ResumeLogging

C, ResumeLogging, MainLog

Field [3]:logName
The name of a Log Facility, other than the "current" one, to resume.
Normally, this parameter would NOT be specified, and thus ALL logging would be resumed. However, there may be the case that a test is using multiple different logs and the tester is trying to resume a specific one.

SuspendLogging
RC TID SE2
( )

C, SuspendLogging

C, SuspendLogging, MainLog

Field [3]:logName
The name of a Log Facility if other than the "current" one.
Normally, this parameter would NOT be specified, and thus ALL logging would be suspended. However, there may be the case that a test is using multiple different logs and the tester is trying to suspend a specific one.

DDDriverRestCommands

DDDriverRestCommands Documentation.

RestCleanResponseMap
TID
( )

C, RestCleanResponseMap, responseID

C, RestCleanResponseMap

Field [3]:responseID
The ID used to delete Response Object from internal Map.
Every single Request generates a new Response, which will be stored in a map internally. This responseID is the key to get that Response Object from that map. This responseID should be generated by SAFS after executing a REST request, such as GET, POST, DELETE, PUT etc.

RestDeleteResponse
TID
( )

C, RestDeleteResponse, ResponseID

Field 3 :responseID
The ID of the Response/Request (stored in persistence storages) to be deleted.

The Response/Request can stored be in more than one type of persistence storage; For example, it can be in a XML file, a JSON file and "a series of variables" at the same time. This keyword will delete all of them.
Please refer to keyword RestStoreResponse if you want to know exactly what type of persistence storage can be used to save a REST response/request.

RestDeleteResponseStore
TID
( )

C, RestDeleteResponseStore

RestHeadersLoad
TID
( )

C, RestHeadersLoad, C:\SAFS\projects\rest\HeadersFile, GET, JSON

C, RestHeadersLoad, C:\SAFS\projects\rest\HeadersFile, DELETE

C, RestHeadersLoad, C:\SAFS\projects\rest\HeadersFile, , JSON

C, RestHeadersLoad, C:\SAFS\projects\rest\HeadersFile

Field 3 :headersFile
The path to file holding headers information.
The content is to be decided. JSON=single/multi-line header
XML=single/multi-line header

Field [4]:method
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.

The possible methods are listed below:

DELETE

GET

HEAD

PATCH

POST

PUT

Field [5]:type
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.

The possible types are listed below:

BINARY

CSS

CUSTOM

HTML

JSON

IMAGE

SCRIPT

TEXT

XML

RestStoreResponse
TID
( )

C, RestStoreResponse, ResponseID, BayerCustomerGet

C, RestStoreResponse, ^ResponseIDVar, BayerCustomerGet

C, RestStoreResponse, ResponseID, BayerCustomerGet, True

C, RestStoreResponse, ResponseID, persistentFile, False, FILE

C, RestStoreResponse, ResponseID, persistentFile, False, FILE, JSON

C, RestStoreResponse, ResponseID, persistentFile, False, FILE, XML

Field 3 :responseID
The ID used to retrieve Response Object from internal Map.
Every single Request generates a new Response, which will be stored in a map internally. This responseID is the key to get that Response Object from that map. This responseID should be generated by SAFS after executing a REST request, such as GET, POST, DELETE, PUT etc.

Field 4 :variablePrefix
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.

If this parameter means a 'variable prefix'.
The variablePrefix is used to deduce variables to store a REST response. Deduced variables are listed as below:

variablePrefix.Response.Id

variablePrefix.Response.StatusCode

variablePrefix.Response.HttpVersion

variablePrefix.Response.ContentType

variablePrefix.Response.EntityBody

variablePrefix.Response.EntityLength

variablePrefix.Response.Headers

to be added ...

If the parameter storeRequest is true, then the originating REST Request will also be stored in the deduced variables listed as below:

variablePrefix.Request.Method

variablePrefix.Request.URI

variablePrefix.Request.HttpVersion

variablePrefix.Request.Headers

variablePrefix.Request.MessageBody

to be added ...

If this parameter means a file name, then the information of a REST Response (and Request if the parameter storeRequest is true) will be stored in a file.
The file could be a property file, a json file, or an XML file, examples as below:
Please pay attention to the special characters (new-line, double-quote, <?XML etc.) escaped by the escape character shown in read as below.

a JSON file example { "Response":{ "StatusCode": "200", "Headers" : "{Date=Tue, 13 Dec 2016 03:32:13 GMT, Content-Length=4574, Content-Type=application/xml}", "EntityBody" : "<?xml version=\"1.0\"?><CUSTOMERList xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n <CUSTOMER xlink:href=\"http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/\">0</CUSTOMER> \n</CUSTOMERList>", "Request": { "Method": "GET", "Headers": "{Date=Tue, 06 Dec 2016 03:08:12 GMT, Content-Length=4574}" } } } an XML file example: <Response> <StatusCode>200</StatusCode> <Headers>{Date=Tue, 13 Dec 2016 03:29:27 GMT, Content-Length=4574, Connection=keep-alive, Content-Type=application/xml}</Headers> <EntityBody><![CDATA[<?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink"> <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER> <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/49/">49</CUSTOMER> </CUSTOMERList>]]></EntityBody> <Request> <Method>GET</Method> <Headers> Content-Type:application/octet-stream, Accept:application/octet-stream </Headers> </Request> </Response> a Properties file example: Response.ContentType : application/xml Response.EntityBody : <?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">\
\n <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>\
\n <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/1/">1</CUSTOMER>\
\n </CUSTOMERList> Response.EntityLength : 0 Response.Headers : {Date=Mon, 12 Dec 2016 05:17:19 GMT, Content-Length=4762, Via=1.1 inetgw38 (squid), Connection=keep-alive, Content-Type=application/xml, X-Cache=MISS from inetgw38, Server=Apache-Coyote/1.1} Response.Request.Headers : Content-Type:application/octet-stream Accept:application/octet-stream

Field [5]:storeRequest
Store the originating Request information if this parameter is true. The default value is false.

Field [6]:persistenceType
The type of the persistence storage to save the Response/Request information.
The valid parameter values are listed below:

FILE

VARIABLE

Field [7]:fileType
The Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"
The valid parameter values are listed below:

JSON

PROPERTIES

XML

RestVerifyResponse
TID
( )

C, RestVerifyResponse, ResponseID, BenchFile

C, RestVerifyResponse, ResponseID, BenchFile, XML

C, RestVerifyResponse, ResponseID, BenchFile, XML, verifyResult

C, RestVerifyResponse, ResponseID, BenchFile, XML, , true

C, RestVerifyResponse, ResponseID, BenchFile, XML, , true, true, false

C, RestVerifyResponse, ResponseID, BenchFile, XML, , false, false, false

Field 3 :responseID
The ID used to retrieve Response Object from internal Map.
Every single Request generates a new Response, which will be stored in a map internally. This responseID is the key to get that Response Object from that map. This responseID should be generated by SAFS after executing a REST request, such as GET, POST, DELETE, PUT etc.

Field 4 :benchFile
The bench file for verifying a REST response.
The bench file can be a property file, a json file, or an XML file. Examples listed as below:
Please pay attention to the special characters (new-line, double-quote, <?XML etc.) escaped by the escape character shown in read as below.

a JSON file example { "Response":{ "StatusCode": "200", "Headers" : "{Date=Tue, 13 Dec 2016 03:32:13 GMT, Content-Length=4574, Content-Type=application/xml}", "EntityBody" : "<?xml version=\"1.0\"?><CUSTOMERList xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n <CUSTOMER xlink:href=\"http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/\">0</CUSTOMER> \n</CUSTOMERList>", "Request": { "Method": "GET", "Headers": "{Date=Tue, 06 Dec 2016 03:08:12 GMT, Content-Length=4574}" } } } an XML file example: <Response> <StatusCode>200</StatusCode> <Headers>{Date=Tue, 13 Dec 2016 03:29:27 GMT, Content-Length=4574, Connection=keep-alive, Content-Type=application/xml}</Headers> <EntityBody><![CDATA[<?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink"> <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER> <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/49/">49</CUSTOMER> </CUSTOMERList>]]></EntityBody> <Request> <Method>GET</Method> <Headers> Content-Type:application/octet-stream, Accept:application/octet-stream </Headers> </Request> </Response> a Properties file example: Response.ContentType : application/xml Response.EntityBody : <?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">\
\n <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>\
\n <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/1/">1</CUSTOMER>\
\n </CUSTOMERList> Response.EntityLength : 0 Response.Headers : {Date=Mon, 12 Dec 2016 05:17:19 GMT, Content-Length=4762, Via=1.1 inetgw38 (squid), Connection=keep-alive, Content-Type=application/xml, X-Cache=MISS from inetgw38, Server=Apache-Coyote/1.1} Response.Request.Headers : Content-Type:application/octet-stream Accept:application/octet-stream

Field [5]:fileType
The Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"
The valid parameter values are listed below:

JSON

PROPERTIES

XML

Field [6]:result
The variable holding the verification result.
If this parameter is not provided, then the 'verification result' will be automatically saved to a deduced variable "<responseID>.verification.result".

Field [7]:verifyRequest
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.

Field [8]:valueContains
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;

Field [9]:valueCaseSensitive
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
TID
( )

C, RestVerifyResponseContains, ResponseID, BenchFile

C, RestVerifyResponseContains, ResponseID, BenchFile, XML

C, RestVerifyResponseContains, ResponseID, BenchFile, XML, verifyResult

C, RestVerifyResponseContains, ResponseID, BenchFile, XML, , true

C, RestVerifyResponseContains, ResponseID, BenchFile, XML, , true, true, false

Field 3 :responseID
The ID used to retrieve Response Object from internal Map.
Every single Request generates a new Response, which will be stored in a map internally. This responseID is the key to get that Response Object from that map. This responseID should be generated by SAFS after executing a REST request, such as GET, POST, DELETE, PUT etc.

Field 4 :benchFile
The bench file for verifying a REST response.
The bench file can be a property file, a json file, or an XML file. Examples listed as below:
Please pay attention to the special characters (new-line, double-quote, <?XML etc.) escaped by the escape character shown in read as below.

a JSON file example { "Response":{ "StatusCode": "200", "Headers" : "{Date=Tue, 13 Dec 2016 03:32:13 GMT, Content-Length=4574, Content-Type=application/xml}", "EntityBody" : "<?xml version=\"1.0\"?><CUSTOMERList xmlns:xlink=\"http://www.w3.org/1999/xlink\">\n <CUSTOMER xlink:href=\"http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/\">0</CUSTOMER> \n</CUSTOMERList>", "Request": { "Method": "GET", "Headers": "{Date=Tue, 06 Dec 2016 03:08:12 GMT, Content-Length=4574}" } } } an XML file example: <Response> <StatusCode>200</StatusCode> <Headers>{Date=Tue, 13 Dec 2016 03:29:27 GMT, Content-Length=4574, Connection=keep-alive, Content-Type=application/xml}</Headers> <EntityBody><![CDATA[<?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink"> <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER> <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/49/">49</CUSTOMER> </CUSTOMERList>]]></EntityBody> <Request> <Method>GET</Method> <Headers> Content-Type:application/octet-stream, Accept:application/octet-stream </Headers> </Request> </Response> a Properties file example: Response.ContentType : application/xml Response.EntityBody : <?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">\
\n <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>\
\n <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/1/">1</CUSTOMER>\
\n </CUSTOMERList> Response.EntityLength : 0 Response.Headers : {Date=Mon, 12 Dec 2016 05:17:19 GMT, Content-Length=4762, Via=1.1 inetgw38 (squid), Connection=keep-alive, Content-Type=application/xml, X-Cache=MISS from inetgw38, Server=Apache-Coyote/1.1} Response.Request.Headers : Content-Type:application/octet-stream Accept:application/octet-stream

Field [5]:fileType
The Type of file to save Response/Request, ONLY useful when persistenceType is "FILE"
The valid parameter values are listed below:

JSON

PROPERTIES

XML

Field [6]:result
The variable holding the verification result.
If this parameter is not provided, then the 'verification result' will be automatically saved to a deduced variable "<responseID>.verification.result".

Field [7]:verifyRequest
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.

Field [8]:valueContains
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;

Field [9]:valueCaseSensitive
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;

DDDriverStringCommands

DDDriverStringCommands Documentation.

CleanString
RJ TID SDC RC SE2
( )

C, cleanString, "a^Abcd", var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :resultVar
the resultVar to place the result of the operation into

Compare
RJ TID SDC SE2
( )

C, Compare, "abc", "abcd", var

C, Compare, "Hi, Hello World with happy", "[H|h]ello [W|w]orld", var, true

C, Compare, "Hi, Hello World with happy", "^[H|h]ello [W|w]orld$", var, true

Field 3 :sourceString
The source string (could come from a ^variable) to compare.

Field 4 :dstString
The destination string (could come from a ^variable) to compare.
This is normally a simple string;
But it could be a regular expression if the parameter 'regexMatch' is true. Do NOT forget the leading symbol ^ and the ending symbol $ if the whole string should be considered; Without them, if a sub-string of the 'sourceString' can match the regex pattern, then it is considered matched.

Field 5 :resultVar
the resultVar to place the result of the operation into

Field [6]:regexMatch
Indicates if the comparison is in regex way.
This parameter is optional, the default value is false. If this is true, then the parameter 'dstString' should be provided with a regular expression. Else if this is false or not provided, the parameter 'dstString' will be treated as a normal string even if it is provided with a regular expression.

Concatenate
RJ TID SDC RC SE2
( )

C, Concatenate, "abc", "def", var

Field 3 :string1
string1 (could come from a ^variable)

Field 4 :string2
string2 (could come from a ^variable)

Field 5 :resultVar
the resultVar to place the result of the operation into

GetField
RC RJ TID SDC SE2
( )

C, getTrimmedField, "a|bc|d", 1, "|", var

Field 3 :InputString
The input string which contains the field to be returned

Field 4 :index
0-based index of which field to return

Field 5 :delimiter
delimiter(s) - one or more single characters used as delimiters

Field 6 :resultVar
the variable name to store the returned field in

GetFieldCount
RJ TID SDC RC SE2
( )

C, GetFieldCount, "a|bc|d", 0, "|", var

Field 3 :String1
String1 to parse and count fields

Field 4 :startindex
0-based startindex for parsing the string.

Field 5 :delimiters
delimiters -- each character is treated as a separate delimiter.

Field 6 :resultVar
the resultVar to place the result of the operation into

GetFixedWidthField
RJ TID SDC RC SE2
( )

C, getFixedWidthField, "abcdef", 1, 2, var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :fieldID
0-based field to retrieve. from 0.

Field 5 :fixedwidth
the fixedwidth alotted for each field in the record

Field 6 :resultVar
the resultVar to place the result of the operation into

GetMultiDelimitedField
RJ TID SDC RC SE2
( )

C, GetMultiDelimitedField, "a->b->c->d->e->f>", 2, 5, "->", "field"

Field 3 :sourceString
Source string in which to search for first delimited character

Field 4 :FieldID
The one based index of the field to find and return.

Field 5 :StartIndex
Integer (1-based) start position for search in sourceString

Field 6 :Delimiters
String list of delimiters to find

Field 7 :ResultVar

Name of DDVariable that will receive the result.

GetMultiDelimitedFieldCount
RJ TID SDC RC SE2
( )

C, GetMultiDelimitedFieldCount, string1, index, delimiter, "result"

Field 3 :String1
Source String in which to search for first delimited character

Field 4 :StartIndex
Integer (1-based) start position for search in inputRecord

Field 5 :Delimiters
String list of delimiters to find

Field 6 :ResultVar

Name of DDVariable to receive the result

GetNextDelimiterIndex
RJ TID SDC RC SE2
( )

C, GetNextDelimiterIndex, "a/|/", 0, "|/", var

Field 3 :String1
String1 to parse for field delimiters

Field 4 :startindex
0-based startindex to begin parsing the string.

Field 5 :delimiters
delimiters -- each character is treated as a separate delimiter.

Field 6 :resultVar
the resultVar to place the result of the operation into

GetREDelimitedField
RJ TID SDC SE2
( )

C, GetREDelimitedField, "All is well in the world", 4, "\s+", var

C, GetREDelimitedField, "RedXXOrangeXXYellowXXGreenXXBlueXXIndigoXXViolet", 2, "XX", var

C, GetREDelimitedField, "a|b&cd-efghi", 3, "[\|&\-g]", var

Field 3 :InputString
The input string to analyze.

Field 4 :index
1-based index of the field to return from the input string.

Field 5 :RegExp
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.

Field 6 :resultVar
resultVar contains the requested field from the input string.

GetREDelimitedFieldCount
RJ TID SDC SE2
( )

C, GetREDelimitedFieldCount, "All is well in the world", 4, "\s+", var

C, GetREDelimitedFieldCount, "a|b&cd-efghi", 0, "[\|&\-g]", var

Field 3 :InputString
The input string to analyze.

Field 4 :index
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.

Field 5 :RegExp
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.

Field 6 :resultVar
resultVar contains the number of fields in the input string.

GetSubstringsInString
RJ TID SDC SE2
( )

C GetSubstringsInString "XaaaB" ^regexstart="X" ^regexstop="B" ^VarName="MyVar"

Field 3 :String
String to search for substring.

Field 4 :RegexStart
The starting regular expression. Should not be empty.

Field 5 :RegexStop
The stopping regular expression. Should not be empty.

Field 6 :VarName
The name of the variable to contain the substring.

GetSystemEnviron
RJ RC TID SDC SE2
( )

C, GetSystemEnviron, "OS", var

Field 3 :string1
String1

Field 4 :resultVar
the resultVar to place the result of the operation into

GetSystemUser
RJ TID SDC RC SE2
( )

C, GetSystemUser, var

Field 3 :resultVar
the resultVar to place the USERID into

GetTrimmedField
RJ TID SDC RC SE2
( )

C, getTrimmedField, "a|bc|d", 1, "|", var

Field 3 :string1
string1

Field 4 :index
0-based index of which field to grab

Field 5 :delimiter
delimiter

Field 6 :resultVar
the resultVar to place the result of the operation into

Index
RJ TID SDC RC SE2
( )

C, Index, 0, "abc", "bc", var

Field 3 :start
0-based starting offset of the sourceString to search

Field 4 :sourceString
sourceString (could come from a ^variable)

Field 5 :findString
findString (could come from a ^variable)

Field 6 :resultVar
the resultVar to place the result of the operation into

Left
RJ TID SDC RC SE2
( )

C, Left, abc, 1, ^resultString

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :length
number of chars to copy

Field 5 :resultVar
the resultVar to place the result of the operation into

LeftTrim
RJ TID SDC RC SE2
( )

C, LeftTrim, " abc", var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :resultVar
the resultVar to place the result of the operation into

Length
RJ TID SDC RC SE2
( )

C, Length, "abc", lengthVar

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :resultVar
the resultVar to place the result of the length operation into

Replace
RJ TID SDC RC SE2
( )

C, Replace, "abc", "bc", "234", var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :findString
findString (could come from a ^variable)

Field 5 :replaceString
replaceString (could come from a ^variable)

Field 6 :resultVar
the resultVar to place the result of the operation into

Right
RJ TID SDC RC SE2
( )

C, Right, "abc", 2, var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :length
length

Field 5 :resultVar
the resultVar to place the result of the operation into

RightTrim
RJ TID SDC RC SE2
( )

C, RightTrim, "abc ", var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :resultVar
the resultVar to place the result of the operation into

SubString
RJ TID SDC RC SE2
( )

C, SubString, "abc", 1, 1, var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :start
starting 0-based offset character position

Field [5]:length
number of chars to copy. If not provided or less than 1 then all characters after the start index will be retrieved.

Field 6 :resultVar
the resultVar to place the result of the operation into

ToLowerCase
RJ TID SDC RC SE2
( )

C, ToLowerCase, "ABC", var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :resultVar
the resultVar to place the result of the operation into

ToUpperCase
RJ TID SDC RC SE2
( )

C, ToUpperCase, "abc", var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :resultVar
the resultVar to place the result of the operation into

Trim
RJ TID SDC RC SE2
( )

C, Trim, " abc ", var

Field 3 :sourceString
sourceString (could come from a ^variable)

Field 4 :resultVar
the resultVar to place the result of the operation into

DDDriverTimerCommands

DDDriverTimerCommands Documentation.

ResetTimer
RJ TID SDC
( )

C, ResetTimer, exampleTimer

Field 3 :timerName
timerName (should be unique)

StartTimer
RJ TID SDC
( )

C, StartTimer, exampleTimer

C, StartTimer, exampleTimer, 30

Field 3 :timerName
timerName (should be unique)

Field [4]:verifyValue
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
RJ TID SDC
( )

C, StopTimer, exampleTimer

Field 3 :timerName
timerName (should be unique)

StoreTimerInfo
RJ TID SDC
( )

C, StoreTimerInfo, exampleTimer, TimerVar

Field 3 :timerName
timerName (should be unique)

Field 4 :variable
variable to store time information in.

StoreTimerInfoFile
RJ TID SDC
( )

C, StoreTimerInfoFile, exampleTimer, "c:\temp\temp.csv"

Field 3 :timerName
timerName (should be unique)

Field 4 :fileLoc
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
RJ TID SDC
( )

C, VerifyElapsedTimeInRange, exampleTimer, 10, 30

Field 3 :timerName
timerName (should be unique)

Field 4 :verifyValue1
verifyValue1 will be used as the lower bounds of the check.

Field 5 :verifyValue2
verifyValue2 will be used as the higher bounds of the check.

VerifyElapsedTimeIsLess
RJ TID SDC
( )

C, VerifyElapsedTimeIsLess, exampleTimer, 10

Field 3 :timerName
timerName (should be unique)

Field 4 :verifyValue
verifyValue will be used to as the check value.

VerifyElapsedTimeIsMore
RJ TID SDC
( )

C, VerifyElapsedTimeIsMore, exampleTimer, 10

Field 3 :timerName
timerName (should be unique)

Field 4 :verifyValue
verifyValue will be used to as the check value.

VerifyTimer
RJ TID SDC
( )

C, VerifyTimer, exampleTimer 10

C, VerifyTimer, exampleTimer

Field 3 :timerName
timerName (should be unique)

Field [4]:verifyValue
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.

DDDriverDeprecatedCommands

DDDriverDeprecatedCommands Documentation.

EndRequirement
RC WR
( )

C EndRequirement Requirement1

C EndRequirement

Field [3]:RequirementID
The user-defined ID of the Requirement
The user-defined ID of the Requirement. The last Requirement provided with the SetRequirement command will be handled by default.

EndTestcase
RC WR
( )

C EndTestcase TestCase1

C EndTestcase

Field [3]:TestCaseID
The user-defined ID of the Testcase.
The user-defined ID of the Testcase. The last TestCase provided with the SetTestcase command will be handled by default.

GetVariableValueEx
RC WR
( )

C, GetVariableValueEx, srcvar, destvar

C, GetVariableValueEx, ^srcvarname, ^destvarname

C, GetVariableValueEx, ^basename & ^index, destvar

Field 3 :SourceVariable
The name of the variable to retrieve the value of

Field 4 :DestinationVariable
The name of the variable to hold the retrieved value

SetRequirement
RC WR
( )

C SetRequirement Requirement1

C SetRequirement Requirement1 "It Must Compile"

Field 3 :RequirementID
The user-defined ID of the Requirement

Field [4]:Description
A description of the Requirement

SetTestcase
RC WR
( )

C SetTestcase TestCase1

C SetTestcase TestCase1 "It Must Compile"

Field 3 :TestCaseID
The user-defined ID of the Testcase.

Field [4]:Description
A description of the Testcase

COMPONENT FUNCTIONS:

Generally, Component Function Data/Step tests (RecordTypes = "T", "TW", "TF")
(T=Test; W=Warning Expected\Allowed; F=Failure Expected\Allowed) formatted as: (expand to view)

T, WindowID, WindowID, AWindowAction, Param1, ...

T, WindowID, WindowID, AWindowAction

T, WindowID, ComponentID, AComponentAction, Param1, ...

T, WindowID, ComponentID, AComponentAction

Field 2 : TQ Reference for the Window to have context.
Field 3 : TQ Reference for the Component in Window to have context.
Field 4 : TQ Reference. The Action to perform on the Window/Component.
Field [5-N]: TQ String Zero or more parameters for the selected Action.
(If the Window itself receives the action then Fields 2 and 3 will be the same.)

CheckBoxFunctions

CheckBoxFunctions Documentation.

Check
RC RJ WR SE SE2 TC DRD
( )

T, WINDOW, Checkbox, CHECK

Click
WR
( )

T, WINDOW, Checkbox, CLICK

UnCheck
RC RJ WR SE SE2 TC DRD
( )

T, WINDOW, Checkbox, UNCHECK

ComboBoxFunctions

ComboBoxFunctions Documentation.

CaptureItemsToFile
RJ DRD TC SE2
( )

T, WINDOW, ComboBox, CaptureItemsToFile , afile.txt

T, WINDOW, ComboBox, CaptureItemsToFile , afile.txt, "UTF-8"

Field 5 :FileName
File name (if not absolute, then to test dir)
File name (if not absolute, then to test dir)

Field [6]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Click
WR TC
( )

T, WINDOW, ComboBox, CLICK

HideList
RJ SE2
( )

T, WINDOW, ComboBox, HideList

Select
RC RJ WR SE TC DRD SE2
( )

T, WINDOW, ComboBox, SELECT, "MySelection"

T, WINDOW, ComboBox, SELECT, "MySelection", "true"

Field 5 :TextValue
The case-sensitive item in the drop down list to select.

Field [6]:ForceRefresh
Force refreshing to update stale element after selection.

SelectIndex
RC RJ WR SE TC DRD SE2
( )

T, WINDOW, ComboBox, SELECTINDEX, "1"

T, WINDOW, ComboBox, SELECTINDEX, "1", "true"

Field 5 :IndexValue
The item index in the drop down list to select.
Some combo lists are 0-based (start with 0). Some are 1-based (start with 1). The user will have to determine the index base for their particular combo list.
It would appear that HTML Combo lists are 1-based.

Field [6]:ForceRefresh
Force refreshing to update stale element after selection.

SelectPartialMatch
RC RJ WR SE TC DRD SE2
( )

T, WINDOW, ComboBox, SelectPartialMatch, "ATextSubstring"

T, WINDOW, ComboBox, SelectPartialMatch, "ATextSubstring", "true"

Field 5 :TextValue
The case-sensitive substring of an item in the drop down list to select.

Field [6]:ForceRefresh
Force refreshing to update stale element after selection.

SelectUnverified
RC RJ WR SE TC DRD SE2
( )

T, WINDOW, ComboBox, SELECTUNVERIFIED, "MySelection"

T, WINDOW, ComboBox, SELECTUNVERIFIED, "MySelection", "true"

Field 5 :TextValue
The case-sensitive item in the drop down list to select.

Field [6]:ForceRefresh
Force refreshing to update stale element after selection.

SelectUnverifiedPartialMatch
SE2
( )

T, WINDOW, ComboBox, SelectUnverifiedPartialMatch, "ATextSubstring"

T, WINDOW, ComboBox, SelectUnverifiedPartialMatch, "ATextSubstring", "true"

Field 5 :TextValue
The case-sensitive substring of an item in the drop down list to select.

Field [6]:ForceRefresh
Force refreshing to update stale element after selection.

SetTextValue
RC RJ WR TC SE2
( )

T, WINDOW, ComboBox, SETTEXTVALUE, "MyPassword"

Field [5]:TextValue
The text that will be typed into the ComboBox.
TextValue will be the text that will be typed into the Combobox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

SetUnverifiedTextValue
RC RJ TC
( )

T, WINDOW, ComboBox, SETUNVERIFIEDTEXTVALUE, "MyPassword"

Field [5]:TextValue
The text that will be typed into the ComboBox.
TextValue will be the text that will be typed into the Combobox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

ShowList
RJ SE2
( )

T, WINDOW, ComboBox, ShowList

VerifySelected
RJ TC DRD SE2
( )

T, WINDOW, ComboBox, VerifySelected, "ATextSubstring"

Field 5 :TextValue
The case-sensitive substring to compare.

ComboEditBoxFunctions

ComboEditBoxFunctions Documentation.

Click
WR TC
( )

T, WINDOW, ComboEditBox, CLICK

Select
RC WR TC
( )

T, WINDOW, ComboEditBox, SELECT, "MySelection"

Field 5 :TextValue
The case-sensitive item in the drop down list to select.

SelectIndex
RC WR TC
( )

T, WINDOW, ComboEditBox, SELECTINDEX, "1"

Field 5 :IndexValue
The item index in the drop down list to select.

SelectPartialMatch
RC WR TC
( )

T, WINDOW, ComboEditBox, SelectPartialMatch, "ATextSubstring"

Field 5 :TextValue
The case-sensitive substring of an item in the drop down list to select.

SetTextValue
RC WR TC
( )

T, WINDOW, ComboEditBox, SETTEXTVALUE, "MyPassword"

Field [5]:TextValue
The text that will be typed into the ComboEditBox.
TextValue will be the text that will be typed into the ComboEditBox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

SetUnverifiedTextValue
RC TC
( )

T, WINDOW, ComboEditBox, SETUNVERIFIEDTEXTVALUE, "MyPassword"

Field [5]:TextValue
The text that will be typed into the ComboEditBox.
TextValue will be the text that will be typed into the ComboEditBox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

ComboListBoxFunctions

ComboListBoxFunctions Documentation.

Select
RC WR TC
( )

T, Window, ComboListBox, SELECT, "my text"

Field 5 :TextValue
The case-sensitive text item to select
TextValue should contain the case-sensitive text item to select. You can enclose this text in double-quotes to ensure proper retrieval.

SelectIndex
RC WR TC
( )

T, WINDOW, ComboListBox, SELECTINDEX, "1"

Field 5 :IndexValue
The item index in the exposed list to select.

DatabaseFunctions

DatabaseFunctions Documentation.

CopyDBTableColumnToFile
RC RJ
( )

T, ADBAlias, ATableAlias, CopyDBTableColumnToFile, Data Source Name (dsn), ^OutputFileName, ^SQLQuery, [^OutputDirectory], ^sqlStatus, "[Delimiter]", "[UID]", "[PWD]", "[prompt]"

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :FileOut
Name of the output file.

Field 7 :SQLQuery
The file will contain the results of the executed Query. The query is NOT validated by this function.

Field [8]:DirectoryOut
OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.

Field 9 :SQLStatus
A variable which holds the current SQL run status.

Field [10]:Delimiter
Optional Delimiter to be used between columns written to file.

Field [11]:UserID
UserID for accessing the Datasource (if required).

Field [12]:Password
Password for accessing the Datasource (if required).

Field [13]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

CopyDBTableToFile
RC RJ
( )

T, ADBAlias, ATableAlias, CopyDBTableToFile, Data Source Name (dsn), ^OutputFileName, tableName, [^ColumnCount],[^rowCount], [^SQLQuery], [^Delimiter], [^OutputDirectory], ^sqlStatus, "[UID]", "[PWD]", "[prompt]"

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :FileOut
Name of the output file.

Field 7 :DBTableName
Name of the TABLE to access within the DBSourceName

Field [8]:ColumnCount
If specified the output file will contain only the number of columns specified.

OPTIONAL parameter. If specified the output file will contain only the number of columns specified. This number will become the first dimension of the retreival array. If NOT specified the function will copy a maximum of 100 columns. (arbitrary limit for now)

Field [9]:RowCount
If specified the output file will contain only the number of rows specified.

OPTIONAL parameter. If specified the output file will contain only the number of columns specified. This number will become the first dimension of the retreival array. If NOT specified the function will copy a maximum of 100 columns. (arbitrary limit for now)

Field [10]:SQLQuery
OPTIONAL parameter. If specified, the file will contain the results of the executed Query. The query is NOT validated by this function.

Field [11]:delimiter
OPTIONAL parameter. If not specified the default ',' seperator will be used.

Field [12]:DirectoryOut
OPTIONAL parameter. If not specified the file will be stored under the project "Datapool\Test\" directory.

Field 13 :SQLStatus
A variable which holds the current SQL run status.

Field [14]:UserID
UserID for accessing the Datasource (if required).

Field [15]:Password
Password for accessing the Datasource (if required).

Field [16]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

DeleteDBTableRecords
RC RJ
( )

T, ADBAlias, ATableAlias, DeleteDBTableRecords, Clients, "CID = 25", ContactDatabase, "", "",""

Field 5 :DBTableName
Name of the TABLE to access within the DBSourceName

Field [6]:DBQueryCond
Expression allowed by the WHERE clause of the DELETE FROM sentence of the SQL driver
A query condition can be included, usually it is. 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'".
"where" will be added to any expression if it is not provided.

Field 7 :DBSourceName
Name of the Datasource containing the DBTable

Field [8]:UserID
UserID for accessing the Datasource (if required).

Field [9]:Password
Password for accessing the Datasource (if required).

Field [10]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

ExecSQLCommit
RJ
( )

T, ADBAlias, ATableAlias, ExecSQLCommit, Data Source Name (dsn), ^sqlStatus, "[UID]", "[PWD]"

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :SQLStatus
A variable which holds the current SQL run status.

Field [7]:UserID
UserID for accessing the Datasource (if required).

Field [8]:Password
Password for accessing the Datasource (if required).

ExecSQLQuery
RC RJ
( )

T, ADBAlias, ATableAlias, ExecSQLQuery, empODBC, "UPDATE Employee Set City = 'Pittsburgh' Where EmpID = '0023' ", ^sqlStatus, "", "", ""

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :queryStr
Actual query stored in a ^queryStr.

Field 7 :SQLStatusCode
SQL status code as a result of executing the query.

Field [8]:UserID
UserID for accessing the Datasource (if required).

Field [9]:Password
Password for accessing the Datasource (if required).

Field [10]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

GetDBTableColumnCount
RC RJ
( )

T, ADBAlias, ATableAlias, GetDBTableColumnCount, empODBC, Employee, ^columnCount, ^sqlStatus, "", "", ""

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 7 :ColumnCount
SQL result get stored in this return variable.

Field 8 :SQLStatusCode
SQL status code as a result of executing the query.

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field [11]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

GetDBTableRowCount
RC RJ
( )

T, ADBAlias, ATableAlias, GetDBTableRowCount, empODBC, Employee, ^rowCount, ^sqlStatus, "", "", ""

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field 7 :RowCount
SQL result get stored in this return variable.

Field 8 :SQLStatusCode
SQL status code as a result of executing the query.

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field [11]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

GetDBValue
RC RJ
( )

T, ADBAlias, ATableAlias, GetDBValue, empODBC, "Select LastName From Employee Where EmpID = '0023'", ^queryResult, ^sqlStatus, "", "", ""

Field 5 :DBSourceName
Name of the Datasource containing the DBTable

Field 6 :queryStr
Actual query stored in a ^queryStr.

Field 7 :QueryResult
SQL result get stored in this return variable.

Field 8 :SQLStatusCode
SQL status code as a result of executing the query.

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field [11]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

VerifyDatabaseNullValue
RC RJ
( )

T, ADBAlias, ATableAlias, VerifyDatabaseNullValue, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "",""

Field 5 :DBFieldName
Name of the FIELD within DBTableName used in the verification

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field [7]:DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included, usually it is. 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'".
"where" will be added to any expression if it is not provided.

Field 8 :DBSourceName
Name of the Datasource containing the DBTable

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field [11]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

VerifyDatabaseValue
RC RJ
( )

T, ADBAlias, ATableAlias, VerifyDBValue, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", "Smith",""

Field 5 :DBFieldName
Name of the FIELD within DBTableName used in the verification

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field [7]:DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included, usually it is. 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'".
"where" will be added to any expression if it is not provided.

Field 8 :DBSourceName
Name of the Datasource containing the DBTable

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field 11 :ExpectedValue
Benchmark value to compare against retrieved DBFieldName value

Field [12]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

VerifyDBNullValue
RC RJ
( )

T, ADBAlias, ATableAlias, VerifyDBNullValue, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "",""

Field 5 :DBFieldName
Name of the FIELD within DBTableName used in the verification

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field [7]:DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included, usually it is. 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'".
"where" will be added to any expression if it is not provided.

Field 8 :DBSourceName
Name of the Datasource containing the DBTable

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field [11]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

VerifyDBValue
RC RJ
( )

T, ADBAlias, ATableAlias, VerifyDBValue, LASTNAME, Clients, "CID = 25", ContactDatabase, "", "", "Smith",""

Field 5 :DBFieldName
Name of the FIELD within DBTableName used in the verification

Field 6 :DBTableName
Name of the TABLE to access within the DBSourceName

Field [7]:DBQueryCond
Expression allowed by the WHERE clause of the SELECT sentence of the SQL driver
A query condition can be included, usually it is. 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'".
"where" will be added to any expression if it is not provided.

Field 8 :DBSourceName
Name of the Datasource containing the DBTable

Field [9]:UserID
UserID for accessing the Datasource (if required).

Field [10]:Password
Password for accessing the Datasource (if required).

Field [11]:Prompt
Optional parameter valid values 1 - 4 [default is 4 no prompt] for ODBC driver login window.

Field 12 :ExpectedValue
Benchmark value to compare against retrieved DBFieldName value

DatePickerFunctions

DatePickerFunctions Documentation.

GetDate
DRD
( )

T, WINDOW, DatePicker, GetDate, currentDate

Field 5 :VariableName
The name of variable to contain the date string of DatePicker.
The name of variable to contain the date string of DatePicker. The date string will be in format "MM-dd-yyyy".

SetDate
DRD
( )

T, WINDOW, DatePicker, SetDate, "Dec 24 2012"

T, WINDOW, DatePicker, SetDate, "04/24/2012"

T, WINDOW, DatePicker, SetDate, "04-24-2012"

Field 5 :DateValue
DateValue to set.
DateValue to set. It can be in format of "MM-dd-yyyy", "MM/dd/yyyy" or "MMM dd yyyy". When you give it as the first two formats, you MUST quote it; otherwise the character '-' and '/' will be considered as arithmetic sign and the parameter will be calculated as arithmetic expression.

DotNetMenuFunctions

DotNetMenuFunctions Documentation.

SelectMenuItem
RJ
( )

T, WINDOW, FileMenu, SelectMenuItem

T, WINDOW, FileMenu, SelectMenuItem, "Exit"

T, WINDOW, Amenu, SelectMenuItem, "File"

T, WINDOW, AMenu, SelectMenuItem, "File->Exit"

T, WINDOW, Amenu, SelectMenuItem, "FileOpen"

Field [5]:TextValue
Case-insensitive text of menuItem to select OR an App Map reference.
TextValue is the case-sensitive text of the menuitem to select. Parent-Child relationships are separated by "->".
Alternatively, the TextValue can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit menu item text in the App Map.
In RRAFS, this command will work on both JavaMenu items and JavaPopupMenu items.

SelectMenuItemContains
RJ
( )

T, WINDOW, FileMenu, SelectMenuItemContains, "exi"

T, WINDOW, AMenu, SelectMenuItemContains, "f->exit"

Field [5]:TextValue
Case-insensitive substring of menuItem to select OR an App Map reference.
Parent-Child relationships are separated by "->"
Alternatively, the TextValue can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit menu item text in the App Map.
Note: RJ implementation: this field is required.

VerifyMenuItem
RJ
( )

T, Window, Menu, VerifyMenuItem, "File"

T, Window, Menu, VerifyMenuItem, "Weird->CheckBox", "Enabled Checked"

Field 5 :MenuItemText
Menu->MenuItem hierarchy string to identify which menuitem to find.
Menu->MenuItem hierarchy string to identify which menuitem to find. This menu hierarchy IS case-sensitive
TQ String. the full case-sensitive menu item path to select. Ampersands (&) indicating/preceding underlined characters are optional. The text must include the full text including spaces and any visible shortcut key combinations displayed in the text of the menu item.

Field [6]:ExpectedStatus
Expected status string (or part thereof) of the menuitem.
Expected status string (or part thereof) to verify. Only "Enabled" "Ungrayed" "Grayed" "Disabled" "Checked" "Unchecked" "Menu With N MenuItems" are supported now.
Ex: "Enabled Checked" OR "Grayed UnChecked" etc.
Each item separated by a space will be evaluated separately so the order of the status items does not matter. Only the state information of interest needs to be specified. These status items ARE case-insensitive,space-delimited.

VerifyMenuItemContains
RJ
( )

T, Window, Menu, VerifyMenuItemContains, "Fil->Sav"

T, Window, Menu, VerifyMenuItemContains, "Fil->Sav","Enabled"

Field 5 :MenuItemText
Menu->MenuItem hierarchy string to identify which menuitem to find.
Menu->MenuItem hierarchy string to identify which menuitem to find. This menu hierarchy IS case-sensitive
TQ String. the case-sensitive menu item path to select. Ampersands (&) indicating/preceding underlined characters are optional. The text can be any substring of the full text including spaces and any visible shortcut key combinations displayed in the text of the menu item.

Field [6]:ExpectedStatus
Expected status string (or part thereof) of the menuitem.
Expected status string (or part thereof) to verify. Only "Enabled" "Ungrayed" "Grayed" "Disabled" "Checked" "Unchecked" "Menu With N MenuItems" are supported now.
Ex: "Enabled Checked" OR "Grayed UnChecked" etc.
Each item separated by a space will be evaluated separately so the order of the status items does not matter. Only the state information of interest needs to be specified. These status items ARE case-insensitive,space-delimited.

DotNetTableFunctions

DotNetTableFunctions Documentation.

ActivateCell
RJ
( )

T, DotNetWin, DotNetTable, ActivateCell

T, DotNetWin, DotNetTable, ActivateCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

ActivateColumnLabel
RJ
( )

T, DotNetWin, DotNetTable, ActivateColumnLabel, "2"

Field 5 :ColNumber
The 1-based column label number to double click.

Field [6]:YOffset
(FUTURE) Number of pixels to adjust where the actual double click occurs.

AssignCellContainsTextRow
RJ
( )

T, DotNetWin, DotNetTable, AssignCellContainsTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be the user-defined variable +".Value".

Field 6 :Col
The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.
The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.
The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.

Field 8 :ValueN
A Value to search for in the 'COLN' column.
These values can be partial substrings and are not case-sensitive.

AssignCellTextRow
RJ
( )

T, DotNetWin, DotNetTable, AssignCellTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be this user-defined variable +".Value".

Field 6 :Col
The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in the 'COLN' column
These values are case-sensitive and must consititute an exact match.

AssignVariableCellText
RJ
( )

T, DotNetWin, DotNetTable, AssignVariableCellText, AVariableName

T, DotNetWin, DotNetTable, AssignVariableCellText, "AVariableName", 1 , 1

T, DotNetWin, DotNetTable, AssignVariableCellText, "^AVariableName", 4, "Field5"

C, SetVariableValues, ^AVariableName="NextVariableName"
T, DotNetWin, DotNetTable, AssignVariableCellText, ^AVariableName, "ADatum", 5

Field 5 :VariableName
The name of the variable to receive the property value.
The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

AssignVariableFuzzyCellText
RJ
( )

T, DotNetWin, DotNetTable, AssignVariableFuzzyCellText, AVariableName

T, DotNetWin, DotNetTable, AssignVariableFuzzyCellText, "AVariableName", 1 , 1

T, DotNetWin, DotNetTable, AssignVariableFuzzyCellText, "^AVariableName", 4, "field5"

C, SetVariableValues, ^AVariableName="NextVariableName"
T, DotNetWin, DotNetTable, AssignVariableFuzzyCellText, ^AVariableName, "datum", 5

Field 5 :VariableName
The name of the variable to receive the property value.
The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

CaptureFuzzyRangeToFile
RJ
( )

T, DotNetWin, DotNetTable, CaptureFuzzyRangeToFile, AFileName.txt

T, DotNetWin, DotNetTable, CaptureFuzzyRangeToFile, AFileName.txt, 1 , 1

T, DotNetWin, DotNetTable, CaptureFuzzyRangeToFile, AFileName.txt, 4, "field5", 2, 5

T, DotNetWin, DotNetTable, CaptureFuzzyRangeToFile, AFileName.txt, "datum", 5, , 2

T, DotNetWin, DotNetTable, CaptureFuzzyRangeToFile, AFileName.txt, , , , , "UTF-8"

Field 5 :FileName
The name of the file to receive the data.
The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
Any specified full or relative path must already exist.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Field [8]:Rows
The number of rows to capture.
If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
If the parameter is not provided, all subsequent rows from the specified starting row are captured.

Field [9]:Columns
The number of columns to capture.
If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
If the parameter is not provided, all subsequent columns from the specified starting column are captured.

Field [10]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [11]:FilterMode
(FUTURE) A file filter to use when processing the text values.

Field [12]:FilterOptions
(FUTURE) Filter options to use with the file filter.

CaptureRangeToFile
RJ
( )

T, DotNetWin, DotNetTable, CaptureRangeToFile, AFileName.txt

T, DotNetWin, DotNetTable, CaptureRangeToFile, AFileName.txt, 1 , 1

T, DotNetWin, DotNetTable, CaptureRangeToFile, AFileName.txt, 4, "Field5", 2, 5

T, DotNetWin, DotNetTable, CaptureRangeToFile, AFileName.txt, "ADatum", 5, , 2

T, DotNetWin, DotNetTable, CaptureRangeToFile, AFileName.txt, , , , , "UTF-8"

Field 5 :FileName
The name of the file to receive the data.
The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
Any specified full or relative path must already exist.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field [8]:Rows
The number of rows to capture.
If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
If the parameter is not provided, all subsequent rows from the specified starting row are captured.

Field [9]:Columns
The number of columns to capture.
If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
If the parameter is not provided, all subsequent columns from the specified starting column are captured.

Field [10]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [11]:FilterMode
(FUTURE) A file filter to use when processing the text values.

Field [12]:FilterOptions
(FUTURE) Filter options to use with the file filter.

ClickCell
RJ
( )

T, DotNetWin, DotNetTable, CLICKCELL

T, DotNetWin, DotNetTable, CLICKCELL, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

ClickColumnLabel
RJ
( )

T, DotNetWin, DotNetTable, ClickColumnLabel, "2"

Field 5 :ColNumber
The 1-based column label number to click.

Field [6]:YOffset
(FUTURE) Number of pixels to adjust where the actual click occurs.

DoubleClickCell
RJ
( )

T, DotNetWin, DotNetTable, DoubleClickCell

T, DotNetWin, DotNetTable, DoubleClickCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

DoubleClickColumnLabel
RJ
( )

T, DotNetWin, DotNetTable, DoubleClickColumnLabel, "2"

Field 5 :ColNumber
The 1-based column label number to double click.

Field [6]:YOffset
(FUTURE) Number of pixels to adjust where the actual double click occurs.

RightClickCell
RJ
( )

T, DotNetWin, DotNetTable, RightClickCell

T, DotNetWin, DotNetTable, RightClickCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

SelectCell
RJ
( )

T, DotNetWin, DotNetTable, SelectCell

T, DotNetWin, DotNetTable, SelectCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

SelectCellContainsTextFind
RJ
( )

T, DotNetWin, DotNetTable, SelectCellContainsTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # or header value, identifying the column for the select.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.
These comparisons are not case-sensitive and can be substrings of the actual table text.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.
These comparisons are not case-sensitive and can be substrings of the actual table text.

Field 8 :ValueN
A Value to search for in the 'COLN' column
The values are not case-sensitive and can be substrings of the actual table text.

SelectCellText
RJ
( )

T, DotNetWin, DotNetTable, SelectCellText

T, DotNetWin, DotNetTable, SelectCellText, 1 , 1

T, DotNetWin, DotNetTable, SelectCellText, 4, "Field5"

T, DotNetWin, DotNetTable, SelectCellText, "ADatum", 5

Field [5]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [6]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

SelectCellTextFind
RJ
( )

T, DotNetWin, DotNetTable, SelectCellTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # or header value, identifying the column for the select.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in the 'COLN' column

SelectCellTextSpecial
RJ
( )

T, Frame, custTableTable, SelectCellTextSpecial, Control, Left, 2, 3

T, Frame, custTableTable, SelectCellTextSpecial, Shift, Left, 2, 3

Field 5 :SpecialKey
The special key command used in the row selection. For now, ownly Control and Shift are supported.

Field 6 :MouseClick
The type of mouse click needed. For now, ownly Left and Right are supported.

Field 7 :Row
The 1-based cell row in the row/col specification.

Field 8 :Col
The 1-based cell column in the row/col specification.

SelectFuzzyCellText
RJ
( )

T, DotNetWin, DotNetTable, SelectFuzzyCellText

T, DotNetWin, DotNetTable, SelectFuzzyCellText, 1 , 1

T, DotNetWin, DotNetTable, SelectFuzzyCellText, 4, "field5"

T, DotNetWin, DotNetTable, SelectFuzzyCellText, "datum", 5

Field [5]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [6]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

SelectFuzzyCellTextFind
RJ
( )

T, DotNetWin, DotNetTable, SelectFuzzyCellTextFind, Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

VerifyCellEditable
RJ
( )

T, DotNetWin, DotNetTable, VerifyCellEditable, "2", "3", "true"

Field 5 :Row
The 1-based cell row in the row/col specification.

Field 6 :Col
The 1-based cell column in the row/col specification.

Field 7 :ExpectedValue
The case-insensitive value we expect for the editable value.

VerifyCellText
RJ
( )

T, DotNetWin, DotNetTable, VerifyCellText, FirstCellValue

T, DotNetWin, DotNetTable, VerifyCellText, "FirstCellValue", 1 , 1

T, DotNetWin, DotNetTable, VerifyCellText, "BenchValue", 4, "Field5"

T, DotNetWin, DotNetTable, VerifyCellText, "BenchData", "ADatum", 5

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

VerifyCellTextContains
RJ
( )

T, DotNetWin, DotNetTable, VerifyCellTextContains, FirstCellValue

T, DotNetWin, DotNetTable, VerifyCellTextContains, "firstcell", 1 , 1

T, DotNetWin, DotNetTable, VerifyCellTextContains, "bench", 4, "Field5"

T, DotNetWin, DotNetTable, VerifyCellTextContains, "bench", "ADatum", 5

Field 5 :BenchValue
The expected value for the specified cell.
The value can be a substring of the full expected value and is NOT case-sensitive.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

VerifyCellTextFind
RJ
( )

T, DotNetWin, DotNetTable, VerifyCellTextFind, "10/09/2003", Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field 6 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 7 :Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 8 :ColN
A 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 9 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

VerifyColumnLabel
RJ
( )

T, DotNetWin, DotNetTable, VerifyColumnLabel, "Foo", "4"

T, DotNetWin, DotNetTable, VerifyColumnLabel, "Foo SecondFoo", "4"

Field 5 :ColLabel
The case-insensitive expected value for the specified column label.

Field 6 :ColNumber
The 1-based column number of the label that needs verified.

VerifyFuzzyCellText
RJ
( )

T, DotNetWin, DotNetTable, VerifyFuzzyCellText, FirstCellValue

T, DotNetWin, DotNetTable, VerifyFuzzyCellText, "FirstCellValue", 1 , 1

T, DotNetWin, DotNetTable, VerifyFuzzyCellText, ABenchValue, 4, "field5"

T, DotNetWin, DotNetTable, VerifyFuzzyCellText, ^ABenchValue, "datum", 5

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

VerifyFuzzyCellTextContains
RJ
( )

T, DotNetWin, DotNetTable, VerifyFuzzyCellTextContains, FirstCellValue

T, DotNetWin, DotNetTable, VerifyFuzzyCellTextContains, "firstcell", 1 , 1

T, DotNetWin, DotNetTable, VerifyFuzzyCellTextContains, bench, 4, "field5"

T, DotNetWin, DotNetTable, VerifyFuzzyCellText, bench, "datum", 5

Field 5 :BenchValue
The expected value for the specified cell.
The value can be a substring of the full expected value and is NOT case-sensitive.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

VerifyFuzzyCellTextFind
RJ
( )

T, DotNetWin, DotNetTable, VerifyFuzzyCellTextFind, "10/09/2003", Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field 6 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 7 :Col
The 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 8 :ColN
A 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 9 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

DotNetTreeFunctions

DotNetTreeFunctions Documentation.

CaptureTreeDataToFile
RJ
( )

T, Browser, aTreeView, CaptureTreeDataToFile, aFilename.ext

T, Browser, aTree, CaptureTreeDataToFile, myDirectory\aFilename.ext, "Parent Bank->Branch Banking and Trust", "_"

T, Browser, aTreeView, CaptureTreeDataToFile, aFilename.ext, , , "UTF-8"

Field 5 :File
The name of the file used to store the tree data.
The name of the file used to store the tree data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:Branch
The full name of the tree branch to capture.
The full name of the tree branch to capture. If omitted, all branches/nodes are captured.

The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'PartialMatchTreeDataToFile' if you wish to specify case-insensitive substring matches for tree nodes.

Field [7]:IndentMark
The character(s) to use in the output file to indent the tree nodes from the parent tree branches.
The character(s) to use in the output file to indent the tree nodes from the parent tree branches. If omitted, a tab character is used.

Field [8]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [9]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [10]:FilterOptions
(Future) Specify filter options to use with the file filter.

ClickTextNode
RJ
( )

T, WINDOW, ATree, ClickTextNode, "Parent"

T, WINDOW, ATree, ClickTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to click.
TextValue is the case-sensitive text of the node to click. Parent-Child relationships are separated by "->"

ClickUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, ClickUnverifiedTextNode, "root->Parent"

T, WINDOW, ATree, ClickUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to click.
TextValue is the case-sensitive text of the node to click. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes then they must be provided.

Collapse
RJ
( )

T, WINDOW, ATree, Collapse, "Parent"

T, WINDOW, ATree, Collapse, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to collapse
TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->"

CollapsePartialTextNode
RJ
( )

T, WINDOW, ATree, CollapsePartialTextNode, "Parent"

T, WINDOW, ATree, CollapsePartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to collapse
TextValue is the case-insensitive text of the node to collapse. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

CollapseTextNode
RJ
( )

T, WINDOW, ATree, CollapseTextNode, "Parent"

T, WINDOW, ATree, CollapseTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to collapse
TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->"

CollapseUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, CollapseUnverifiedTextNode, "root->Parent"

T, WINDOW, ATree, CollapseUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to collapse
TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

CtrlClickUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, CtrlClickUnverifiedTextNode, "Parent"

T, WINDOW, ATree, CtrlClickUnverifiedTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to CTRL-click.
TextValue is the case-sensitive text of the node to CTRL-click. Parent-Child relationships are separated by "->"

DoubleClickTextNode
RJ
( )

T, WINDOW, ATree, DoubleClickTextNode, "Parent"

T, WINDOW, ATree, DoubleClickTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to double-click.
TextValue is the case-sensitive text of the node to double-click. Parent-Child relationships are separated by "->"

DoubleClickUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, DoubleClickUnverifiedTextNode, "root->Parent"

T, WINDOW, ATree, DoubleClickUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to double-click.
TextValue is the case-sensitive text of the node to double-click. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes then they must be provided.

Expand
RJ
( )

T, WINDOW, ATree, Expand, "Parent"

T, WINDOW, ATree, Expand, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to expand
TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->"

ExpandPartialTextNode
RJ
( )

T, WINDOW, ATree, ExpandPartialTextNode, "parent"

T, WINDOW, ATree, ExpandPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to match.
TextValue is the case-insensitive text of the node. Parent-Child relationships are separated by "->". For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

ExpandTextNode
RJ
( )

T, WINDOW, ATree, ExpandTextNode, "Parent"

T, WINDOW, ATree, ExpandTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to expand
TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->"

ExpandUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, ExpandUnverifiedTextNode, "root->Parent"

T, WINDOW, ATree, ExpandUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to expand
TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->". If the tree contains hidden root nodes the user must provide these.

MakeSelection
RJ
( )

T, WINDOW, ATree, MakeSelection, "Parent"

T, WINDOW, ATree, MakeSelection, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to select
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

PartialMatchTreeDataToFile
RJ
( )

T, Browser, aTreeView, PartialMatchTreeDataToFile, aFilename.ext

T, Browser, aTree, PartialMatchTreeDataToFile, myDirectory\aFilename.ext, "parent->branch", "_"

Field 5 :File
The name of the file used to store the tree data.
The name of the file used to store the tree data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:Branch
The full name of the tree branch to capture.
The full name of the tree branch to capture. If omitted, all branches/nodes are captured.

The search of the path to the node is a case-insensitive substring match of each node. Use 'CaptureTreeDataToFile' if you wish to specify case-sensitive exact matches for tree nodes.

Field [7]:IndentMark
The character(s) to use in the output file to indent the tree nodes from the parent tree branches.
The character(s) to use in the output file to indent the tree nodes from the parent tree branches. If omitted, a tab character is used.

Field [8]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [9]:FilterOptions
(Future) Specify filter options to use with the file filter.

RightClickTextNode
RJ
( )

T, WINDOW, ATree, RightClickTextNode, "Parent"

T, WINDOW, ATree, RightClickTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to right-click.
TextValue is the case-sensitive text of the node to right-click. Parent-Child relationships are separated by "->"

RightClickUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, RightClickUnverifiedTextNode, "root->Parent"

T, WINDOW, ATree, RightClickUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to right-click.
TextValue is the case-sensitive text of the node to right-click. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes then they must be provided.

SelectAnotherPartialTextNode
RJ
( )

T, WINDOW, ATree, SelectAnotherPartialTextNode, "parent"

T, WINDOW, ATree, SelectAnotherPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to select.
TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

SelectAnotherTextNode
RJ
( )

T, WINDOW, ATree, SelectAnotherTextNode, "Parent"

T, WINDOW, ATree, SelectAnotherTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

SelectAnotherUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, SelectAnotherUnverifiedTextNode, "root->Parent"

T, WINDOW, ATree, SelectAnotherUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

SelectPartialTextNode
RJ
( )

T, WINDOW, ATree, SelectPartialTextNode, "parent"

T, WINDOW, ATree, SelectPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to select.
TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

SelectTextNode
RJ
( )

T, WINDOW, ATree, SelectTextNode, "Parent"

T, WINDOW, ATree, SelectTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

SelectUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, SelectUnverifiedTextNode, "root->Parent"

T, WINDOW, ATree, SelectUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

SetTreeContainsNode
RJ
( )

T, Browser, aTreeView, SetTreeContainsNode, "Parent Bank->Branch Banking and Trust", isFound

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'SetTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.

Field 6 :ResultVar
The name of the variable which gets assigned the result.
The value of 'TRUE' indicates the node was found in the tree, and 'FALSE' indicates that the node was not found in the tree.

SetTreeContainsPartialMatch
RJ
( )

T, Browser, aTreeView, VerifyTreeContainsNode, "parent->branch", isFound

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'SetTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.

Field 6 :ResultVar
The name of the variable which gets assigned the result.
The value of 'TRUE' indicates the node was found in the tree, and 'FALSE' indicates that the node was not found in the tree.

ShiftClickUnverifiedTextNode
RJ
( )

T, WINDOW, ATree, ShiftClickUnverifiedTextNode, "Parent"

T, WINDOW, ATree, ShiftClickUnverifiedTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to SHIFT-click.
TextValue is the case-sensitive text of the node to SHIFT-click. Parent-Child relationships are separated by "->"

VerifyTreeContainsNode
RJ
( )

T, Browser, aTreeView, VerifyTreeContainsNode, "Parent Bank->Branch Banking and Trust"

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'VerifyTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.

VerifyTreeContainsPartialMatch
RJ
( )

T, Browser, aTreeView, VerifyTreeContainsNode, "parent->branch"

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'VerifyTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.

EditBoxFunctions

EditBoxFunctions Documentation.

SetTextCharacters
DRD RC RJ WR TC SE SE2
( )

T, WINDOW, EditBox, SETTEXTCHARACTERS, "MyPassword"

Field [5]:TextValue
The text that will be typed into the EditBox.
TextValue will be the text that will be typed into the Editbox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

SetTextValue
RC RJ WR TC SE SE2 DRD AUT
( )

T, WINDOW, EditBox, SetTextValue, "MyPassword"

Field [5]:TextValue
The text that will be typed into the EditBox and verified.
TextValue will be the text that will be typed into the Editbox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

SetUnverifiedTextCharacters
DRD RC RJ WR TC SE SE2
( )

T, WINDOW, EditBox, SetUnverifiedTextCharacters, "My+(Password)"

Field [5]:TextValue
The text that will be typed into the EditBox.
TextValue will be the text that will be typed into the Editbox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

SetUnverifiedTextValue
RC RJ WR TC SE SE2 DRD
( )

T, WINDOW, EditBox, SetUnverifiedTextValue, "MyPassword"

Field [5]:TextValue
The text that will be typed into the EditBox.
TextValue will be the text that will be typed into the Editbox. Quoted text may be used to ensure proper expected value retrieval. There is also no check for a missing field because that would be the same as specifying no text ("")--which is valid.

FlexColorFunctions

FlexColorFunctions Documentation.

SetColor
RJ
( )

T, FlexWINDOW, FlexColorPicker, SetColor, "#FF0000"

T, FlexWINDOW, FlexColorPicker, SetColor, "#0000FF"

Field 5 :ColorValue
ColorValue to set.
ColorValue is a hexdecimal string started with '#'.

FlexDateFunctions

FlexDateFunctions Documentation.

SetDate
RJ
( )

T, FlexWINDOW, FlexDate, SetDate, "Jun 6 2009"

T, FlexWINDOW, FlexDate, SetDate, "04/24/2009"

Field 5 :DateValue
DateValue to set.
DateValue to set.

FlexNumericStepperFunctions

FlexNumericStepperFunctions Documentation.

SetValue
RJ
( )

T, FLEXWINDOW, FlexNumericStepper, SetValue, 3

Field 5 :StepperValue
The value of the stepper to set.
The value of the stepper to set.

FlexSliderFunctions

FlexSliderFunctions Documentation.

SetValue
RJ
( )

T, FlexWINDOW, FlexSlider, SetValue, 3.2

Field 5 :SliderValue
The value of the slider to set.
The value of the slider to set.

FPSpreadFunctions

FPSpreadFunctions Documentation.

CaptureRangeToFile
RC
( W )

T, Window, FPSpreadGrid, CaptureRangeToFile, "captResult.txt"

Field 5 :CapturedFile
The name of the file used to save the captured data.
Typically, the captured file is stored in the Datapool\Test directory. Captured files will be TAB delimited files. This action only captures the data, it does not verify it against a benchmark file.

ClickCell
RC
( )

T, AWindow, AGrid, ClickCell

T, AWindow, AGrid, ClickCell, ^row=2, ^col=1

T, AWindow, AGrid, ClickCell, ^row=0, ^col=1

Field [5]:row
The 1-based logical row to click.
If no row is provided then row=1 is assumed. Row=0 is used for column headers.

Field [6]:col
The 1-based logical col to click.
If no col is provided then col=1 is assumed. Col=0 is used for row headers.

CtrlClickCell
RC
( )

T, AWindow, AGrid, CtrlClickCell

T, AWindow, AGrid, CtrlClickCell, ^row=2, ^col=1

T, AWindow, AGrid, CtrlClickCell, ^row=0, ^col=1

Field [5]:row
The 1-based logical row to Ctrl+Click.
If no row is provided then row=1 is assumed. Row=0 is used for column headers.

Field [6]:col
The 1-based logical col to Ctrl+Click.
If no col is provided then col=1 is assumed. Col=0 is used for row headers.

DoubleClickCell
RC
( )

T, AWindow, AGrid, DoubleClickCell

T, AWindow, AGrid, DoubleClickCell, ^row=2, ^col=1

T, AWindow, AGrid, DoubleClickCell, ^row=0, ^col=1

Field [5]:row
The 1-based logical row to double click.
If no row is provided then row=1 is assumed. Row=0 is used for column headers.

Field [6]:col
The 1-based logical col to double click.
If no col is provided then col=1 is assumed. Col=0 is used for row headers.

FindRowNumber
RC
( W )

T, AWindow, AGrid, FindRowNumber, "foo", "", "Name", "Bar", "|"

T, AWindow, AGrid, FindRowNumber, "foo", "10", "Name|City", "Bar|Pittsburgh", "|"

Field 5 :rowVarName
The name of the variable to store the row number into.

Field 6 :startingRow
The row to use to begin the search. Defaults to row 1.

Field 7 :searchColumns
The string of column names where you want to search.
You can have just a single column name, or multiple column names separated by the specified delimiter.

Field [8]:searchText
The string of search strings used to search in each specified column names.
The number of search strings you have should be equal to the number of search columns that you have.

Field 9 :DELIMITER
Delimiter used by the search columns and search text to separate the different columns/text.

RightClickCell
RC
( )

T, AWindow, AGrid, RightClickCell

T, AWindow, AGrid, RightClickCell, ^row=2, ^col=1

T, AWindow, AGrid, RightClickCell, ^row=0, ^col=1

Field [5]:row
The 1-based logical row to right click.
If no row is provided then row=1 is assumed. Row=0 is used for column headers.

Field [6]:col
The 1-based logical col to right click.
If no col is provided then col=1 is assumed. Col=0 is used for row headers.

ShiftClickCell
RC
( )

T, AWindow, AGrid, ShiftClickCell

T, AWindow, AGrid, ShiftClickCell, ^row=2, ^col=1

T, AWindow, AGrid, ShiftClickCell, ^row=0, ^col=1

Field [5]:row
The 1-based logical row to SHIFT+Click.
If no row is provided then row=1 is assumed. Row=0 is used for column headers.

Field [6]:col
The 1-based logical col to SHIFT+Click.
If no col is provided then col=1 is assumed. Col=0 is used for row headers.

VerifyCellText
RC
( W )

T, AWindow, AGrid, VerifyCellText, "foo"

T, AWindow, AGrid, VerifyCellText, "foo", ^row=2, ^col=1

T, AWindow, AGrid, VerifyCellText, "foo", ^row=0, ^col=1

Field 5 :ExpectedCellText
The expected text value of the specified cell.

Field [6]:row
The 1-based logical row to verify.
If no row is provided then row=1 is assumed. Row=0 is used for column headers.

Field [7]:col
The 1-based logical col to verify.
If no col is provided then col=1 is assumed. Col=0 is used for row headers.

GenericMasterFunctions (Available to nearly all components)

GenericMasterFunctions Documentation.

AssignPropertyVariable
RC IOS RJ WR SE SE2 TC
( )

T, WindowID, WindowID, AssignPropertyVariable, Visible, AVariableName

T, WindowID, WindowID, AssignPropertyVariable, Visible, AVariableName, SUPPRESSVALUE

T, WindowID, WindowID, AssignPropertyVariable, Visible, "AVariableName"

T, WindowID, WindowID, AssignPropertyVariable, Visible, "^AVariableName"

C, SetVariableValues, ^AVariableName="NextVariableName"
T, WindowID, WindowID, AssignPropertyVariable, Visible, ^AVariableName

Field 5 :PropertyName
The case-sensitive name of the object property.

Field 6 :VariableName
The name of the variable to receive the property value.
The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Field [7]:SuppressValue
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line property values.
The case-insensitive value "SUPPRESSVALUE" instructs the implementation to NOT log the recovered value of the property when logging its success. This is generally useful when retrieving property values that are exceedingly long, or contain large volumes of text that will break-up the format or readability of the output log.

CaptureObjectDataToFile
RC TC RJ SE SE2
( )

T, Browser, HTMLTable, CaptureObjectDataToFile, aFilename.ext, , "", ""

T, Browser, HTMLTable, CaptureObjectDataToFile, myDirectory\aFilename.ext, , "", ""

T, Browser, HTMLTable, CaptureObjectDataToFile, tableContent.ext

T, Browser, HTMLTable, CaptureObjectDataToFile, tableContent.ext, "UTF-8"

Field 5 :File
The name of the file used to store the object data.
The name of the file used to store the object data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [7]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [8]:FilterOptions
(Future) Specify filter options to use with the file filter.

CapturePropertiesToFile
RJ IOS SE SE2 TC DRD
( )

T, Window, Comp, CapturePropertiesToFile, aFilename.ext

T, Window, Comp, CapturePropertiesToFile, aFilename.properties, "UTF-8"

Field 5 :File
The name of the file used to store the property list data.
The name of the file used to store the property list data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:FileEncoding
Specify a character encoding to be used when saving data to a file.
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.
This parameter was added to this command in Nov 2011 as implemented for the Apple IOS engine and may not yet be supported in all engines otherwise supporting this command.

CapturePropertyToFile
RJ IOS SE SE2 TC
( )

T, Window, Comp, CapturePropertyToFile, propertyName, aFilename.ext

T, Window, Comp, CapturePropertyToFile, propertyName, aFilename.ext

T, Window, Comp, CapturePropertyToFile, propertyName, aFilename.ext, "UTF-8"

Field 5 :PropertyName
The case-sensitive name of the object array property to verify.

Field 6 :File
The name of the file used to store the property list data.
The name of the file used to store the property list data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [7]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

ClearAppMapCache
RJ SE2
( )

T, any, any, ClearAppMapCache

ClearCache
SE2
( )

T, WINDOW, COMPONENT, ClearCache

ExecuteScript
SE2
( )

T, WINDOW, COMPONENT, ExecuteScript, "arguments[0].innerHTML=arguments[1];", "The text to shown on page"

Field 5 :script
The script to execute.
The script to execute.

Field [6]:paramN
The paramters passed to script.
The paramters passed to script. You can specify more than one parameter or no parameter.
If the script will return a value, you can get it from variable "__$_SAFS_JAVASCRIPT_RESULT_$__".
Now, only the string result is supported.

GetComputedStyle
SE2
( )

T, WINDOW, COMPONENT, GetComputedStyle, "ComponentStyle.txt"

Field 5 :TestFile
The test file to save 'computed style'.
The test file to save 'computed style'.
The full absolute path to the test file or a relative path.
Relative path's should be sought in this order:

The Project's Test directory;

Relative to the Project's Datapool directory;

Relative to the Project's root directory;

GetGUIImage
DRD RC RJ IOS TID SE SE2 TC AUT
( )

T, WINDOW, COMPONENT, GetGUIImage, "C:\comp.bmp"

T, WINDOW, COMPONENT, GetGUIImage, "Datapool\comp.jpg"

T, WINDOW, COMPONENT, GetGUIImage, "Datapool\Logs\comp.bmp", SUBAREA

T, WINDOW, COMPONENT, GetGUIImage, "Datapool\comp.jpg", "", "Filter=0;0;10;10"

T, WINDOW, COMPONENT, GetGUIImage, "comp.jpg", "", "FilterMapKey"

Field 5 :OutputFile
Path (with filename) to the output image file.
Path/file name of the output image file. This can be a full path, a relative path or just a file name. If relative, it is appended to the Datapool directory; if only a file name without path, the file will be saved in Datapool\Test directory. The extension of the file must be either .bmp or .jpg. If not, .bmp is appended to this parameter to force a BITMAP export.

Field [6]:SubArea
Optional app map subkey indicating partial image of the component to capture.
Optional app map subkey indicating partial image of the component to capture. Value of this app map reference must be in the format of a top-left and bottom-right pair, and can be either absolute coordinates or percentages ("x1,y1,x2,y2" or "x1%,y1%,x2%,y2%"). Coordinates are relative to the component, i.e. (0,0) and (0%,0%) are the minimum, and (COMPONENT_WIDTH, COMPONENT_HEIGHT) and (100%,100%) are the maximum. Values exceeding the minimun/ maximum are forced to the nearest limiting value. Absolute and percent values can be mixed, so "0,0,50%,50%" is valid. If this parameter is omitted, full image of the component is captured (equivalent to "0,0,100%,100%").

Field [7]:FilteredAreas
"Filter=one or multiple areas" to filter the GUI image (or sub image of GUI if the parameter "SubArea" is present)
"Filter=one or multiple areas" to filter the GUI image (or sub image of GUI if the parameter "SubArea" is present)
The area is in the same format described for the parameter "SubArea".
Multiple areas are separated by a space character, such as "subarea1 subarea2 subarea3"
The filtered-image will be covered by black color at filtered areas.
Do NOT forget the prefix "Filter=", without it this parameter will be ignored.

GetTextFromGUI
RJ TID SE SE2
( )

T, Window, Comp, GetTextFromGUI, Var1, , GOCR, en,

Field 5 :VariableName
The name of the variable to receive detected text.
The name of the variable to receive detected text. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpreted as the name of the variable you wish to use.

Field [6]:SubArea
Optional app map subkey indicating partial image of the component to capture.
Optional app map subkey indicating partial image of the component to capture. Value of this app map reference must be in the format of a top-left and bottom-right pair, and can be either absolute coordinates or percentages ("x1,y1,x2,y2" or "x1%,y1%,x2%,y2%"). Coordinates are relative to the component, i.e. (0,0) and (0%,0%) are the minimum, and (COMPONENT_WIDTH, COMPONENT_HEIGHT) and (100%,100%) are the maximum. Values exceeding the minimun/ maximum are forced to the nearest limiting value. Absolute and percent values can be mixed, so "0,0,50%,50%" is valid.
If this parameter is omitted with blank or empty string, full image of the component is captured (equivalent to "0,0,100%,100%").

Field [7]:OCRId
OCRId indicating the OCR used to recognize text.
Two OCR engines are supported. "TOCR" will be taken as default if the parameter is blank. "TOCR" stands for Tesseract OCR; "GOCR" stands for GOCR.
Note: Seems TOCR performs a bit better than GOCR (personal experience).

Field [8]:LangId
Optional LangId representing the language in use for selected OCR to recognize text.
For both TOCR and GOCR, only English is supported so far. Language Id takes standard language code, which can be gotten by calling Locale.ENGLISH.getLanguage().
LangId Language "en" --- English "cn" --- Chinese

If LangId is not specified with blank or empty string, the language of System locale will be used as default.

Field [9]:ScaleRatio
Optional ScaleRatio indicating the scale ratio for resizing the original image.
To fit in font size and DPI required by OCR, SAFS needs to resize images before sending them to OCR engines. For screen-captured images with 96DPI, TOCR takes 1.9 as default; GOCR takes 1.5 as default. You may try different ScaleRatio to find an appropriate value if default setting is unable to meet your requirement.

GUIDoesExist
DRD IOS RC RJ TID WR SE SE2 TC
( , F )

T, AWindow, AWindow, GUIDoesExist

T, AWindow, AChild, GUIDoesExist

GUIDoesNotExist
DRD IOS RC RJ TID WR SE SE2 TC
( , F )

T, AWindow, AWindow, GUIDoesNotExist

T, AWindow, AChild, GUIDoesNotExist

HoverMouse
RC TID RJ TC SE SE2 AUT
( )

T, WINDOW, WINDOW, HoverMouse

T, WINDOW, WINDOW, HoverMouse, , -1

T, WINDOW, AnObject, HoverMouse, "Coords=200,400"

T, WINDOW, AnObject, HoverMouse, ASubObject, 1000

T, WINDOW, AnObject, HoverMouse, , 3000

Field [5]:AppMapSubkey
(Optional)Name of the AppMap subkey to lookup and use for the hover.
Without this we should hover on the center of the object.
Name of the AppMap subkey to lookup and use for the hover. We expect the AppMap to contain the item in the format "x,y":

[Component]
Node1="33,120" OR
Node1="Coords=33,120" OR
Node1="Icon" (or whatever is appropriate)

The results from the lookup are appended to the "Coords=" string used by the hover command in Robot (if necessary). So any valid content used with the hover command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Field [6]:HoverTime
(Optional)Number of milliseconds to hover.
If not specified, the mouse will hover for 2000 milliseconds over the object.
If it is provided as Constants.TIMEOUT_HOVERMOUSE_STAY_FOREVER, the mouse will saty forever over the object.

HoverScreenLocation
TID
( )

T, WINDOW, WINDOW, HoverScreenLocation

T, WINDOW, AnObject, HoverScreenLocation, "Coords=200,400"

T, WINDOW, AnObject, HoverScreenLocation, ASubObject, 1000

T, WINDOW, AnObject, HoverScreenLocation, , 3000

Field [5]:AppMapSubkey
(Sometimes Optional)Name of the AppMap subkey to lookup and use for the hover.
Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified.
Name of the AppMap subkey to lookup and use for the hover. We expect the AppMap to contain the coordinates in the following supported formats:
[Component] Node1="33,120" (comma-delimited) OR Node1="33;120" (semi-colon delimited) OR Node1="33 120" (space-delimited) OR Node1="Coords=33,120" (comma-delimited) OR Node1="Coords=33;120" (semi-colon delimited) OR Node1="Coords=33 120" (space-delimited)
Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above.

Field [6]:HoverTime
(Optional)Number of milliseconds to hover.
If not specified, the mouse will hover at the specified coordinates for 2000 milliseconds.

InputCharacters
RC DRD IOS RJ TID WR ABT SE SE2
( )

T, WINDOW, WINDOW, INPUTCHARACTERS, "Some Text to Input"

Field 5 :TextValue
String of keystrokes to send.
String of keystrokes to send. For RRAFS(RC): consult the documentation on the SQA InputChars command This routine sends the provided string unmodified to the InputChars command.

InputKeys
RC RJ TID WR ABT SE SE2 TC DRD
( )

T, WINDOW, COMPONENT, INPUTKEYS, "Some Text to Input"

Field 5 :TextValue
String of keystrokes to send.
String of keystrokes to send. For RRAFS (RC): consult the documentation on the SQA InputKeys command for syntax information for special characters and keys. This routine sends the provided string unmodified to the InputKeys command.
Note: the TID supports this command using InputKeys Support.

IsPropertyExist
RJ TC SE SE2
( , F )

T, Window, Component, IsPropertyExist, Visible, existVar

Field 5 :PropertyName
The case-sensitive name of the object property to verify.

Field 6 :PropertyExistVariable
The variable to store 'true' or 'false' to indicate if the property exist or not.

LocateScreenImage
RJ TID TC SE SE2
( )

T, WindowID, WindowID, LocateScreenImage, AVariableName

C, SetVariableValues, ^AVariableName="NextVariableName" T, WindowID, WindowID, LocateScreenImage, ^AVariableName

T, ParentWindow, Component, LocateScreenImage, AVariableName, parent

Field 5 :VariableName
The root name of the collection of variables to receive the location and dimensions.

Field [6]:WhomRelativeTo
This parameter decides the coordinates stored in VariableName is relative to the screen or the parent window. 'screen' means they are relative to the screen; 'parent' means they are relative to the parent window. The parameter is curently available in RJ only.

SaveTextFromGUI
RJ TID SE SE2
( )

T, Window, Comp, SaveTextFromGUI, ocr.txt, , TOCR, en, 2.0

Field 5 :OutputFile
The name of the text file used to store detected text.
The name of the text file used to store detected text. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:SubArea
Optional app map subkey indicating partial image of the component to capture.
Optional app map subkey indicating partial image of the component to capture. Value of this app map reference must be in the format of a top-left and bottom-right pair, and can be either absolute coordinates or percentages ("x1,y1,x2,y2" or "x1%,y1%,x2%,y2%"). Coordinates are relative to the component, i.e. (0,0) and (0%,0%) are the minimum, and (COMPONENT_WIDTH, COMPONENT_HEIGHT) and (100%,100%) are the maximum. Values exceeding the minimun/ maximum are forced to the nearest limiting value. Absolute and percent values can be mixed, so "0,0,50%,50%" is valid.
If this parameter is omitted with blank or empty string, full image of the component is captured (equivalent to "0,0,100%,100%").

Field [7]:OCRId
OCRId indicating the OCR used to recognize text.
Two OCR engines are supported. "TOCR" will be taken as default if the parameter is blank. "TOCR" stands for Tesseract OCR; "GOCR" stands for GOCR.
Note: Seems TOCR performs a bit better than GOCR (personal experience).

Field [8]:LangId
Optional LangId representing the language in use for selected OCR to recognize text.
For both TOCR and GOCR, only English is supported so far. Language Id takes standard language code, which can be gotten by calling Locale.ENGLISH.getLanguage().
LangId Language "en" --- English "cn" --- Chinese

If LangId is not specified with blank or empty string, the language of System locale will be used as default.

Field [9]:ScaleRatio
Optional ScaleRatio indicating the scale ratio for resizing the original image.
To fit in font size and DPI required by OCR, SAFS needs to resize images before sending them to OCR engines. For screen-captured images with 96DPI, TOCR takes 1.9 as default; GOCR takes 1.5 as default. You may try different ScaleRatio to find an appropriate value if default setting is unable to meet your requirement.

SendEvent
RJ TC
( )

T, Window, Comp, SendEvent, Close

T, Window, Comp, SendEvent, Change, Browse

T, Window, Comp, SendEvent, MyEvent, AnArg, 100, 200

Field 5 :Event
The potentially case-sensitive name of the event to send or trigger.
Some technologies may enforce case-sensitivity for event names while others will not. The tester is responsible to ensure the event name is appropriate for the item(s) being tested.

Field [6]:PARAM_N
The first of 0 or more parameters needed for the event.
This field will be blank or contain an empty string if no parameter value is to be sent. Otherwise, the field will contain an appropriate value as might be required or optional for the event being sent.
If the event accepts multiple parameters, then each parameter must be provided in a separate field in the test record. All fields will be evaluated until no more fields are found to exist. All fields will be sent in the order they are provided.

SetPropertyValue
RC RJ TC
( )

T, Browser, RadioButton, SetPropertyValue, "checked", True, ""

Field 5 :ObjectPropertyName
The name of the property of the object.
The name of the property of the object. This property will have the value set.

Field 6 :PropertyValue
The value to set the property to.

ShowOnPage
SE2
( )

T, Window, Comp

T, Window, Comp, True

Field [5]:verify
"True" to verify that the component is shown on page.
This parameter is boolean, default value is false. Verify that the component is shown on page if this parameter is true.

TypeChars
TID DRD SE2
( )

T, Anything, At All, TYPECHARS, "Some Text to Input"

Field 5 :TextValue
String of keystrokes to send.

TypeEncryption
TID
( )

T, Anything, At All, TypeEncryption, "C:\safs\passwords\application.pass", "D:\secretPath\private.key"

Field 5 :EncryptedDataFile
The full path of the file where the "encrypted data" is stored.

Field 6 :PrivateKeyFile
The full path of the file where the "private key" is stored.

This file should be kept VERY SECRECT, only the authorized users can access it.

TypeKeys
TID DRD SE2
( )

T, Anything, At All, TYPEKEYS, "%F{ENTER}"

Field 5 :TextValue
String of keystrokes to send.
String of keystrokes to send. Note: the TID supports this command using InputKeys Support.

VerifyArrayPropertyToFile
RC RJ WR
( W, F )

T, Window, MyListBox, VerifyArrayPropertyToFile, "List", aFilename.ext, "", ""

T, Window, MyListBox, VerifyArrayPropertyToFile, "List", c:\Dir\aFilename.ext

Field 5 :PropertyName
The case-sensitive name of the object array property to verify.

Field 6 :BenchmarkFile
The name of the file used as the comparison benchmark.
Typically, benchmarks are stored in the Datapool\Bench directory. In that event, only the filename.ext is needed.

Field [7]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [8]:FilterOptions
(Future) Specify filter options to use with the file filter.

VerifyBinaryFileToFile
RC RJ TID TC
( W, F )

T, Browser, HTMLTable, VerifyBinaryFileToFile, bFilename.ext, aFilename.ext, "", ""

T, Anything, AtAll, VerifyBinaryFileToFile, c:\Dir\bFilename.ext, c:\Dir\aFilename.ext

T, Anything, AtAll, VerifyBinaryFileToFile, c:\Dir\bFilename.png, c:\Dir\aFilename.png, "Tolerance", "90"

Field 5 :BenchmarkFile
File used as the comparison benchmark.
File used as the comparison benchmark.
This can be a full path, a relative path, or a file name. If it is a filename, it is expected to be in the project's Datapool\Bench directory. If it is a relative path, FindSQAFile is used to located the file.

Field 6 :ActualFile
File used as the comparison file under test.
File used as the comparison file under test.
This can be a full path, a relative path, or a file name. If it is a relative path or a file name, the command will try to find the file in the project's Datapool\Test directory.

Field [7]:FilterMode
Specify a filter to use to process the file content before comparison.
Specify a filter to use to process the file content before comparison.
"TOLERANCE", valid if the 2 binary files are images, this represents BitTolerance.

Field [8]:FilterOptions
Specify filter options to use with the filter.
Specify filter options to use with the filter.
If the filter is "TOLERANCE", this value should be an integer between 0 and 100. 100 means only 100% match, 2 images will be considered matched; 0 means even no bits match, 2 images will be considered matched.

VerifyClipboardToFile
RC RJ WR TC
( W, F )

T, Browser, HTMLTable, VerifyClipboardToFile, aFilename.ext, "", ""

T, Anything, AtAll, VerifyClipboardToFile, c:\Dir\aFilename.ext

Field 5 :BenchmarkFile
The name of the file used as the comparison benchmark.
The name of the file used as the comparison benchmark.
Typically, benchmarks are stored in the Datapool\Bench directory. In that event, only the filename.ext is needed.

Field [6]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [7]:FilterOptions
(Future) Specify filter options to use with the file filter.

VerifyClipboardVP
RC WR
( )

T, Nonsense, NonsenseToo, VerifyClipboardVP, ClipboardContentsVP

T, Browser, Browser, VerifyClipboardVP, BrowserContentsVP

T, Browser, HTMLTable, VerifyClipboardVP, TableContentsVP

Field 5 :VPName
The name of the ClipboardVP from the currently running script.

VerifyComputedStyle
SE2
( )

T, WINDOW, COMPONENT, VerifyComputedStyle, "ComponentStyle.txt"

Field 5 :BenchFile
The benchmake file to compare against.
The benchmark file to compare against.
The full absolute path to the benchmark file or a relative path.
Relative path's should be sought in this order:

The Project's Bench directory;

Relative to the Project's Datapool directory;

Relative to the Project's root directory;

VerifyFileToFile
RC RJ TID TC
( W, F )

T, Browser, HTMLTable, VerifyFileToFile, bFilename.ext, aFilename.ext, "", ""

T, Anything, AtAll, VerifyFileToFile, c:\Dir\bFilename.ext, c:\Dir\aFilename.ext

Field 5 :BenchmarkFile
File used as the comparison benchmark.
File used as the comparison benchmark.
This can be a full path, a relative path, or a file name. If it is a filename, it is expected to be in the project's Datapool\Bench directory. If it is a relative path, FindSQAFile is used to located the file.

Field 6 :ActualFile
File used as the comparison file under test.
File used as the comparison file under test.
This can be a full path, a relative path, or a file name. If it is a relative path or a file name, the command will try to find the file in the project's Datapool\Test directory.

Field [7]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [8]:FilterOptions
(Future) Specify filter options to use with the file filter.

VerifyGUIImageToFile
RC RJ IOS TID SE SE2 TC
( W, F )

T, WINDOW, COMPONENT, VerifyGUIImageToFile, "comp.bmp"

T, WINDOW, COMPONENT, VerifyGUIImageToFile, "comp.bmp", "", "", "UUID=False"

T, WINDOW, COMPONENT, VerifyGUIImageToFile, "comp.jpg"

T, WINDOW, COMPONENT, VerifyGUIImageToFile, "comp.jpg", "", 95

T, WINDOW, COMPONENT, VerifyGUIImageToFile, "comp.bmp", SUBAREA

T, WINDOW, COMPONENT, VerifyGUIImageToFile, "comp.jpg", "", "", "", "Filter=0;0;10;10 60;60;10;15"

T, WINDOW, COMPONENT, VerifyGUIImageToFile, "comp.jpg", "", "", "", "FilterMapKey"

Field 5 :BenchmarkFile
Name of the benchmark image file.
Name of the benchmark image file. Relative paths suitable for FindSQAFile can be used. Normally, the Benchmark file would reside in the Project's Datapool\Bench directory. A test file with the same name would be created in the Datapool\Test folder. The resulting dif file with .txt extension would be saved under the Datapool\Dif folder. The extension of the benchmark file should be .bmp or .jpg. If not, it is considered a BMP file, i.e. the test file would have a .bmp extension.

Field [6]:SubArea
Optional app map subkey indicating partial image of the component to verify.
Optional app map subkey indicating partial image of the component to verify. Value of this app map reference must be in the format of a top-left and bottom-right pair, and can be either absolute coordinates or percentages ("x1,y1,x2,y2" or "x1%,y1%,x2%,y2%"). Coordinates are relative to the component, i.e. (0,0) and (0%,0%) are the minimum, and (COMPONENT_WIDTH, COMPONENT_HEIGHT) and (100%,100%) are the maximum. Values exceeding the minimun/ maximum are forced to the nearest limiting value. Absolute and percent values can be mixed, so "0,0,50%,50%" is valid. If this parameter is omitted, full image of the component is captured (equivalent to "0,0,100%,100%").

Field [7]:PercentageTolerance
The percentage of bits need to be matched.
The percentage of bits need to be matched. it is between 0 and 100.
100 means only all bits of images match, the images will be considered matched.
0 means even no bits matche, the images will be considered matched.

Field [8]:UUIDFlag
"UUID=False" to make Test/Actuals Filenames the same as the Benchmark.
If "UUID=False" is present, and the Engine defaults to appending Universally Unique IDs to the filenames stored as runtime Test/Actuals, then this setting will prevent the appending of those UUIDs to the runtime Test/Actual filename. Essentially, the Test/Actual filename will generally be given the same filename as the benchmark.

Field [9]:FilteredAreas
"Filter=one or multiple areas" to filter the GUI image (or sub image of GUI if the parameter "SubArea" is present) and it will also be used to filter the bench image before comparing. If there are some differences, the diff image will be made between these 2 filtered images (not the acutal and bench image).
"Filter=one or multiple areas" to filter the GUI image (or sub image of GUI if the parameter "SubArea" is present) and it will also be used to filter the bench image before comparing. If there are some differences, the diff image will be made between these 2 filtered images (not the acutal and bench image).
The area is in the same format described for the parameter "SubArea".
Multiple areas are separated by a space character, such as "subarea1 subarea2 subarea3"
The actual-image and bench-image will be covered by black color at filtered areas.
Do NOT forget the prefix "Filter=", without it this parameter will be ignored.

VerifyObjectDataToFile
RC RJ SE SE2
( W, F )

T, Browser, HTMLTable, VerifyObjectDataToFile, aFilename.ext, , "", ""

T, Browser, HTMLTable, VerifyObjectDataToFile, aFilename.ext, "UTF-8"

Field 5 :BenchmarkFile
The name of the file used as the comparison benchmark.
The name of the file used as the comparison benchmark.
Typically, benchmarks are stored in the Datapool\Bench directory. In that event, only the filename.ext is needed.

Field [6]:FileEncoding
Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [7]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [8]:FilterOptions
(Future) Specify filter options to use with the file filter.

VerifyPropertiesSubsetToFile
SE SE2
( )

T, Window, Comp, VerifyPropertiesSubsetToFile, aFilename.ext

T, Window, Comp, VerifyPropertiesSubsetToFile, aFilename.properties, "UTF-8"

Field 5 :BenchFile
The name of the file used to store the benchmark property data.
The name of the file used to store the benchmark property data. By default, the files are expected in the active "Bench" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:FileEncoding
Specify a character encoding to be used when loading data from the file.
Specify a character encoding to be used when loading data from the file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

VerifyPropertiesToFile
IOS DRD SE SE2
( )

T, Window, Comp, VerifyPropertiesToFile, aFilename.ext

T, Window, Comp, VerifyPropertiesToFile, aFilename.properties, "UTF-8"

Field 5 :BenchFile
The name of the file used to store the benchmark property data.
The name of the file used to store the benchmark property data. By default, the files are expected in the active "Bench" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:FileEncoding
Specify a character encoding to be used when loading data from the file.
Specify a character encoding to be used when loading data from the file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

VerifyProperty
RC RJ IOS WR SE SE2 TC
( , F )

T, WindowID, WindowID, VerifyProperty, Visible, True, ^CASESENSITIVE="False"

T, WindowID, CheckboxID, VerifyProperty, State, "Unchecked"

Field 5 :PropertyName
The case-sensitive name of the object property to verify.

Field 6 :ExpectedValue
The case-sensitive value we expect to get from the object property.

Field [7]:CaseInsensitive
Values of "CASE-INSENSITIVE", "CASEINSENSITIVE", and "FALSE" will cause the comparison of the property value and the expected value to ignore case.

VerifyPropertyContains
RC RJ IOS WR SE SE2 TC
( , F )

T, WindowID, WindowID, VerifyPropertyContains, Value, someSubstring, ^CaseSensitive="False"

T, WindowID, CheckboxID, VerifyPropertyContains, State, "Unc"

Field 5 :PropertyName
The case-sensitive name of the object property to verify.

Field 6 :SearchString
The case-sensitive value we expect the object property to contain.

Field [7]:CaseInsensitive
Values of "CASE-INSENSITIVE", "CASEINSENSITIVE", and "FALSE" will cause the comparison of the property value and the expected value to ignore case.

VerifyPropertyToFile
RC IOS RJ WR TC SE SE2
( W, F )

T, Browser, HTMLTable, VerifyPropertyToFile, "innerText", aFilename.ext, , "", ""

T, Browser, HTMLTable, VerifyPropertyToFile, "innerText", c:\Dir\aFilename.ext

T, Browser, HTMLTable, VerifyPropertyToFile, "innerText", c:\Dir\aFilename.ext, "UTF-8"

Field 5 :PropertyName
The case-sensitive name of the object property to verify.

Field 6 :BenchmarkFile
The name of the file used as the comparison benchmark.
The name of the file used as the comparison benchmark.
Typically, benchmarks are stored in the Datapool\Bench directory. In that event, only the filename.ext is needed.

Field [7]:FileEncoding
Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [8]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [9]:FilterOptions
(Future) Specify filter options to use with the file filter.

VerifyTabOrder
RC WR
( )

T, Window, Window, VerifyTabOrder, FileName

T, Window, Component, VerifyTabOrder, FileName

Field 5 :FileName
Filename of TabOrder benchmark file.
Filename of TabOrder benchmark file.
The file is simply a list of component names in the order we expect to find them as we tab through the interface. Each line in the file will contain a single component name.
This file would normally be placed in the Datapool\Bench directory.

VerifyTextFileToFile
RC RJ TID TC
( W, F )

T, Browser, HTMLTable, VerifyTextFileToFile, bFilename.ext, aFilename.ext, "", ""

T, Anything, AtAll, VerifyTextFileToFile, c:\Dir\bFilename.ext, c:\Dir\aFilename.ext

Field 5 :BenchmarkFile
File used as the comparison benchmark.
File used as the comparison benchmark.
This can be a full path, a relative path, or a file name. If it is a filename, it is expected to be in the project's Datapool\Bench directory. If it is a relative path, FindSQAFile is used to located the file.

Field 6 :ActualFile
File used as the comparison file under test.
File used as the comparison file under test.
This can be a full path, a relative path, or a file name. If it is a relative path or a file name, the command will try to find the file in the project's Datapool\Test directory.

Field [7]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [8]:FilterOptions
(Future) Specify filter options to use with the file filter.

VerifyValueContains
RC RJ TID WR TC
( , F )

T, anything, anything, VerifyValueContains, someString, someSubstring

T, anything, anything, VerifyValueContains, "here i am", "re i"

T, anything, anything, VerifyValueContains, ^myVariable, "substr"

T, anything, anything, VerifyValueContains, "someString", ^myVariable

T, anything, anything, VerifyValueContains, ^yourVariable, ^myVariable

T, anything, anything, VerifyValueContains, ^yourVariable, ^myVariable, "SuppressValue"

Field 5 :Value
The case-sensitive string value to verify.
If this string is blank, the only possible match is if the SearchString is also blank.

Field 6 :SearchString
The case-sensitive value we expect the preceeding string to contain.
If the SearchString is blank, that will match the searched Value ONLY if that value is also blank. Note: not true for RobotJ version. In RobotJ version, if SearchString is blank, then it will always match. If you want to see if both strings are blank, use the keyword 'VerifyValues' instead.

Field [7]:SuppressValue
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.
The case-insensitive value "SUPPRESSVALUE" instructs the implementation to NOT log the Value when logging. This is generally useful with Values that are exceedingly long, or contain large volumes of text that will break-up the format or readability of the output log.

VerifyValueContainsIgnoreCase
TC TID
( , F )

T, anything, anything, VerifyValueContainsIgnoreCase, someString, someSubstring

T, anything, anything, VerifyValueContainsIgnoreCase, "here i am", "re i"

T, anything, anything, VerifyValueContainsIgnoreCase, ^myVariable, "substr"

T, anything, anything, VerifyValueContainsIgnoreCase, "someString", ^myVariable

T, anything, anything, VerifyValueContainsIgnoreCase, ^yourVariable, ^myVariable

T, anything, anything, VerifyValueContainsIgnoreCase, ^yourVariable, ^myVariable, "SuppressValue"

Field 5 :Value
The case-insensitive string value to verify.
If this string is blank, the only possible match is if the SearchString is also blank.

Field 6 :SearchString
The case-insensitive value we expect the preceeding string to contain.
If the SearchString is blank, that will match the searched Value ONLY if that value is also blank.

Field [7]:SuppressValue
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.
The case-insensitive value "SUPPRESSVALUE" instructs the implementation to NOT log the Value when logging. This is generally useful with Values that are exceedingly long, or contain large volumes of text that will break-up the format or readability of the output log.

VerifyValueDoesNotContain
TID
( )

T, Anything, AtAll, VerifyValueDoesNotContain, "someString", "another"

T, Anything, AtAll, VerifyValueDoesNotContain, ^myVariable, "substr"

T, Anything, AtAll, VerifyValueDoesNotContain, "someString", ^myVariable

T, Anything, AtAll, VerifyValueDoesNotContain, "someString", ^myVariable, "SuppressValue"

Field 5 :Value
The case-sensitive string value to verify.
If this string is blank, the compare value should NOT be blank.

Field 6 :SearchString
The case-sensitive value we do NOT want to find in the provided Value.
If the SearchString is blank, success if Value is NOT blank.

Field [7]:SuppressValue
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.
The case-insensitive value "SUPPRESSVALUE" instructs the implementation to NOT log the Value when logging. This is generally useful with Values that are exceedingly long, or contain large volumes of text that will break-up the format or readability of the output log.

VerifyValues
RC RJ TID WR TC
( , F )

T, anything, anything, VerifyValues, ^myVariable, "astring"

T, anything, anything, VerifyValues, "astring", ^myVariable

T, anything, anything, VerifyValues, ^yourVariable, ^myVariable

T, anything, anything, VerifyValues, ^yourVariable, ^myVariable, "SuppressValue"

Field 5 :Value1
A case-sensitive string value to compare.
If this string is blank, the only possible match is if Value2 is also blank.

Field 6 :Value2
A case-sensitive value to compare.
If this string is blank, the only possible match is if Value1 is also blank.

Field [7]:SuppressValue
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.
The case-insensitive value "SUPPRESSVALUE" instructs the implementation to NOT log the Value when logging. This is generally useful with Values that are exceedingly long, or contain large volumes of text that will break-up the format or readability of the output log.

VerifyValuesIgnoreCase
RC RJ TID WR TC
( , F )

T, anything, anything, VerifyValuesIgnoreCase, ^myVariable, "aSTring"

T, anything, anything, VerifyValuesIgnoreCase, "asTRing", ^myVariable

T, anything, anything, VerifyValuesIgnoreCase, ^yourVariable, ^myVariable

T, anything, anything, VerifyValuesIgnoreCase, ^yourVariable, ^myVariable, "SuppressValue"

Field 5 :Value1
A case-insensitive string value to compare.
If this string is blank, the only possible match is if Value2 is also blank.

Field 6 :Value2
A case-insensitive value to compare.
If this string is blank, the only possible match is if Value1 is also blank.

Field [7]:SuppressValue
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.
The case-insensitive value "SUPPRESSVALUE" instructs the implementation to NOT log the Value when logging. This is generally useful with Values that are exceedingly long, or contain large volumes of text that will break-up the format or readability of the output log.

VerifyValuesNotEqual
TID
( )

T, Anything, AtAll, VerifyValuesNotEqual, ^myVariable, "astring"

T, Anything, AtAll, VerifyValuesNotEqual, "astring", ^myVariable

T, Anything, AtAll, VerifyValuesNotEqual, ^yourVariable, ^myVariable

T, Anything, AtAll, VerifyValuesNotEqual, ^yourVariable, ^myVariable, "SUPPRESSVALUE"

Field 5 :Value1
A case-sensitive string value to compare.
If this string is blank, the only possible success is if Value2 is NOT blank.

Field 6 :Value2
A case-sensitive value to compare.
If this string is blank, the only possible success is if Value1 is NOT blank.

Field [7]:SuppressValue
Set to "SUPPRESSVALUE" to prevent the logging of ugly multi-line values.
The case-insensitive value "SUPPRESSVALUE" instructs the implementation to NOT log the Value when logging. This is generally useful with Values that are exceedingly long, or contain large volumes of text that will break-up the format or readability of the output log.

GenericObjectFunctions

GenericObjectFunctions Documentation.

AltLeftDrag
RJ TC SE2
( )

T, WINDOW, WINDOW, ALTLEFTDRAG, AnObject

T, WINDOW, AnObject, ALTLEFTDRAG, ASubObject

T, WINDOW, AnObject, ALTLEFTDRAG, "Coords=10;20;200;300"

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup or literal text to use for an ALT left mouse drag.

Name of the AppMap subkey to lookup and use for an ALT left mouse drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

[GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20"

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Click
DRD RC RJ IOS TID WR TC ABT SE SE2 AUT
( )

T, WINDOW, COMPONENT, CLICK

T, WINDOW, WINDOW, CLICK, AnObject

T, WINDOW, AnObject, CLICK, ASubObject

T, WINDOW, AnObject, CLICK, 10;20

T, WINDOW, AnObject, CLICK, "Coords=10;20"

T, WINDOW, AnObject, CLICK, 10;20, False

Field [5]:AppMapSubkey
(Optional)Name of the AppMap subkey to lookup or the literal text to use for the click.
Without this we should click on the center of the object.
Name of the AppMap subkey to lookup and use for the click. We expect the AppMap or literal text to contain the item in the format "x,y":

[FolderTree] Node1="33,120" OR Node1="Coords=33,120" ... [AnHTMLImage] AMappdedRegion=Coords=10,10 ANamedRegion=AreaName=TechSupport AnIndexedRegion=AreaIndex=2 AnotherRegion=AreaID=Contact
The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (only if necessary). So any valid content used with the Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.
The Rational Robot implementation also supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.
Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "50,200"

";" (semi-colon) Example: "50;200"

" " (space) Example: "50 200"

Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.
Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).

For IOS: Any optional coordinates MUST be specified as an integer number between 0-100. 0 represents the extreme left (or top), while 100 represents the extreme right (or bottom). IOS does not use absolute coordinates, but relative coordinates representing a percentage of the element width or height.

Field [6]:AutoScroll
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.
If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

ClickScreenImage
TID
( )

T, WINDOW, COMPONENT, ClickScreenImage

T, WINDOW, COMPONENT, ClickScreenImage, AppMapLookup

T, WINDOW, COMPONENT, ClickScreenImage, "Coords=50;200"

Field [5]:AppMapSubKey
(Optional) AppMapSubKey type of use as documented in the CLICK command.

ClickScreenLocation
TID
( )

T, WINDOW, WINDOW, ClickScreenLocation

T, WINDOW, AnObject, ClickScreenLocation, "Coords=200,400"

T, WINDOW, AnObject, ClickScreenLocation, ASubObject

T, WINDOW, AnObject, ClickScreenLocation

Field [5]:AppMapSubkey
(Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.
Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified.
Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats:
[Component] Node1="33,120" (comma-delimited) OR Node1="33;120" (semi-colon delimited) OR Node1="33 120" (space-delimited) OR Node1="Coords=33,120" (comma-delimited) OR Node1="Coords=33;120" (semi-colon delimited) OR Node1="Coords=33 120" (space-delimited)
Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above.

ClickScreenPoint
TID
( )

T, BogusWin, BogusComp, ClickScreenPoint, 33;120

Field 5 :Coords
The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click.
The coordinates must be in the following supported formats:
"33,120" (comma-delimited) OR "33;120" (semi-colon delimited) OR "33 120" (space-delimited)
Note the "Coords=" prefix is NOT supported for this deprecated command.

CompareStoredData
RC
( )

T, WebBrowser, SiteMapImage, COMPARESTOREDDATA, "AStoredVP"

T, WINDOW, AnObject, COMPARESTOREDDATA, "AStoredVP", "ExpectedResult=FAIL"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

Field [6]:AddParams
Additional parameter name used for lookup, or as literal text.
Another parameter that can be stored as a lookup reference in the app map that will be added to any also stored in the app map under the VP name. This parameter will also be treated as literal text if lookup in the app map fails. In this way, we can add parameters to the VP thru literal text instead of requiring any App Map entry.

CompareStoredProperties
RC WR
( )

T, WINDOW, AnObject, COMPARESTOREDPROPERTIES, "AStoredVP"

T, WINDOW, AnObject, COMPARESTOREDPROPERTIES, "AStoredVP", "ExpectedResult=FAIL"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script.

Field [6]:AddParams
Additional parameter name used for lookup, or as literal text.
Another parameter that can be stored as a lookup reference in the app map that will be added to any also stored in the app map under the VP name. This parameter will also be treated as literal text if lookup in the app map fails. In this way, we can add parameters to the VP thru literal text instead of requiring any App Map entry.

CtrlAltLeftDrag
RJ TC SE2
( )

T, WINDOW, WINDOW, CTRLALTLEFTDRAG, AnObject

T, WINDOW, AnObject, CTRLALTLEFTDRAG, ASubObject

T, WINDOW, AnObject, CTRLALTLEFTDRAG, "Coords=10;20;200;300"

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup or literal text to use for the CTRL ALT left mouse drag.

Name of the AppMap subkey to lookup and use for the CTRL ALT left mouse drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

[GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20"

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

CtrlClick
RC RJ WR TID TC ABT SE SE2 AUT
( )

T, WINDOW, WINDOW, CTRLCLICK

T, WINDOW, WINDOW, CTRLCLICK, , False

T, WINDOW, WINDOW, CTRLCLICK, AnObject

T, WINDOW, AnObject, CTRLCLICK, ASubObject

Field [5]:AppMapSubkey
(Optional) Name of the AppMap subkey to lookup and use for the CTRL-click.
Without this we should click the center of the object.
Name of the AppMap subkey to lookup and use for the CTRL-click. We expect the AppMap to contain the item in the format "x,y":

[ToolItem] PrintTool="33,120" OR PrintTool="Coords=33,120"

The results from the lookup are appended to the "Coords=" string used by the GenericObject Ctrl_Click command in Robot (if necessary). So any valid content used with the Ctrl_Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.
Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "50,200"

";" (semi-colon) Example: "50;200"

" " (space) Example: "50 200"

Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).

Field [6]:AutoScroll
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.
If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

CtrlClickScreenImage
TID
( )

T, WINDOW, COMPONENT, CtrlClickScreenImage

T, WINDOW, COMPONENT, CtrlClickScreenImage, AppMapLookup

T, WINDOW, COMPONENT, CtrlClickScreenImage, "Coords=50;200"

Field [5]:AppMapSubKey
(Optional) AppMapSubKey type of use as documented in the CLICK command.

CtrlLeftDrag
RJ TC SE2
( )

T, WINDOW, WINDOW, CTRLLEFTDRAG, AnObject

T, WINDOW, AnObject, CTRLLEFTDRAG, ASubObject

T, WINDOW, AnObject, CTRLLEFTDRAG, "Coords=10;20;200;300"

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup or literal text to use for the CTRL left mouse drag.

Name of the AppMap subkey to lookup and use for the CTRL left drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

[GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20"

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

CtrlRightClick
RC TID RJ SE SE2
( )

T, WINDOW, WINDOW, CtrlRightClick

T, WINDOW, WINDOW, CtrlRightClick, , False

T, WINDOW, WINDOW, CtrlRightClick, AnObject

T, WINDOW, AnObject, CtrlRightClick, ASubObject

Field [5]:AppMapSubkey
(Optional) Name of the AppMap subkey to lookup and use for the CTRL-Right-Click.
Without this we should click the center of the object.
Name of the AppMap subkey to lookup and use for the CTRL-Right-Click. We expect the AppMap to contain the item in the format "x,y":

[ToolItem] PrintTool="33,120" OR PrintTool="Coords=33,120"

The results from the lookup are appended to the "Coords=" string used by the GenericObject CTRL-Right-Click command in Robot (if necessary). So any valid content used with the CTRL-Right-Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Field [6]:AutoScroll
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.
If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

CtrlRightClickScreenImage
TID
( )

T, WINDOW, COMPONENT, CtrlRightClickScreenImage

T, WINDOW, COMPONENT, CtrlRightClickScreenImage, AppMapLookup

T, WINDOW, COMPONENT, CtrlRightClickScreenImage, "Coords=50;200"

Field [5]:AppMapSubKey
(Optional) AppMapSubKey type of use as documented in the CLICK command.

CtrlShiftLeftDrag
RJ TC SE2
( )

T, WINDOW, WINDOW, CTRLSHIFTLEFTDRAG, AnObject

T, WINDOW, AnObject, CTRLSHIFTLEFTDRAG, ASubObject

T, WINDOW, AnObject, CTRLSHIFTLEFTDRAG, "Coords=10;20;200;300"

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup or literal text to use for the CTRL SHIFT left mouse drag.

Name of the AppMap subkey to lookup and use for the CTRL SHIFT left mouse drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

[GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20"

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

DoubleClick
RC RJ IOS TID TC WR ABT SE SE2 AUT
( )

T, WINDOW, COMPONENT, DOUBLECLICK

T, WINDOW, COMPONENT, DOUBLECLICK, , False

T, WINDOW, WINDOW, DOUBLECLICK, AnObject

T, WINDOW, AnObject, DOUBLECLICK, ASubObject

T, WINDOW, AnObject, DOUBLECLICK, "Coords=10;20"

Field [5]:AppMapSubkey
(Optional) Name of the AppMap subkey to lookup or the literal text to use for the double click.
Without this we should click the center of the object.
Name of the AppMap subkey to lookup and use for the double click. We expect the AppMap or literal text to contain the item in the format "x,y":

[FolderTree] Node1="33,120" OR Node1="Coords=33,120"

The results from the lookup are appended to the "Coords=" string used by the GenericObject DBLClick command in Robot (if necessary). So any valid content used with the DBLClick command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).
Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "50,200"

";" (semi-colon) Example: "50;200"

" " (space) Example: "50 200"

Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.
Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

For IOS: Any optional coordinates MUST be specified as an integer number between 0-100. 0 represents the extreme left (or top), while 100 represents the extreme right (or bottom). IOS does not use absolute coordinates, but relative coordinates representing a percentage of the element width or height.

Field [6]:AutoScroll
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.
If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

DoubleClickScreenImage
TID
( )

T, WINDOW, COMPONENT, DoubleClickScreenImage

T, WINDOW, COMPONENT, DoubleClickScreenImage, AppMapItem

T, WINDOW, COMPONENT, DoubleClickScreenImage, "50;100"

T, WINDOW, COMPONENT, DoubleClickScreenImage, "Coords=50;100"

Field [5]:AppMapSubKey
(Optional) AppMapSubKey as documented in the CLICK command.

DoubleClickScreenLocation
TID
( )

T, WINDOW, WINDOW, DoubleClickScreenLocation

T, WINDOW, AnObject, DoubleClickScreenLocation, "Coords=200,400"

T, WINDOW, AnObject, DoubleClickScreenLocation, ASubObject

T, WINDOW, AnObject, DoubleClickScreenLocation

Field [5]:AppMapSubkey
(Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.
Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified.
Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats:
[Component] Node1="33,120" (comma-delimited) OR Node1="33;120" (semi-colon delimited) OR Node1="33 120" (space-delimited) OR Node1="Coords=33,120" (comma-delimited) OR Node1="Coords=33;120" (semi-colon delimited) OR Node1="Coords=33 120" (space-delimited)
Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above.

DoubleClickScreenPoint
TID
( )

T, BogusWin, BogusComp, DoubleClickScreenPoint, 33;120

Field 5 :Coords
The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click.
The coordinates must be in the following supported formats:
"33,120" (comma-delimited) OR "33;120" (semi-colon delimited) OR "33 120" (space-delimited)
Note the "Coords=" prefix is NOT supported for this deprecated command.

DoubleTap
IOS
( )

DragTo
TC SE2
( )

T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT

T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT,"50%,50%,50%,50%"

T, WINDOW,COMPONENT, DRAGTO, WINDOW,COMPONENT,"50%;50%;75%;75%"

T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT,"50%,50%,50%,50%","FromSubItem"

T, WINDOW,COMPONENT, DRAGTO, ToWINDOW,ToCOMPONENT,50%,50%,50%,50%,"FromSubItem","ToSubItem"

Field 5 :ToWindow
ToWindow object.
ToWindow recognition string define into AppMap.

Field 6 :ToComponent
ToComponent object.
ToComponent recognition string define into AppMap.

Field [7]:Offsets
Drag and release location of from-component and to-component. Offsets syntax will be "50%,50%,70%,70%"", where first two percentages are for from-component and second two are for to-component. If offsets are not specified then center will be used.
Default value, both components center.

Field [8]:FromSubItem
Text of from-component's sub item.
FromSubItem as text. e.g tree node or list item or any sub main component's item.

Field [9]:ToSubItem
Text of to-component's sub item.
ToSubItem as text. e.g tree node or list item or any sub main component item.

Field [10]:Pause
Pause time in millisecond to hold the button before releasing.
The default pause time is 800 milliseconds, which may not enough for the AUT to react. User could provide a larger value according to his needs.

Flick
IOS
( )

T, WINDOW, COMPONENT, Flick

T, MainApp, MyTree, Flick, TopRightToBottom

T, MainApp, MyTree, Flick, TopRightToBottom, 3

T, MainApp, MyTree, Flick, "", "", 2

T, MainApp, MyTree, Flick, "", "", "", 3

Field [5]:AppMapSubKey
Optional AppMap SubKey (or literal text) containing x1,y1,x2,y2 flick offsets within the object.
Without this we should perform a default right-to-left Flick.
Name of the AppMap subkey to lookup and use for the command. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

[ComponentName] OffsetName="0;0;100;100"
Both Fields #3 (Component Name) and #5 (Offset Name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.
If no such App Map lookup exists, then we will assume the field contains the offset value directly.
Offsets are "relative" to the object. Each value should be an integer 0-100 representing the relative percentage where 0 is the minimum (left or top) and 100 is the maximum width or height of the object. Thus: 0,0,100,100 represents a flick from the topleft corner to the bottomright corner of the object.
Engines should attempt to support offsets separated by different characters. The most common separators that should be supported would be:

"," (comma) Example: "0,0,100,100" (topleft to bottomright)

";" (semi-colon) Example: "100;0;0;100" (topright to bottomleft)

" " (space) Example: "0 50 100 50" (leftcenter to rightcenter)

Field [6]:Duration
Optional number of seconds (0 to N) to press on the object.
Optional number of seconds (0 to N) to press on the item. The default value is 1.

Field [7]:Touches
Optional number of touches or fingers to use.
Optional number of touches or fingers to use. The default value is 1.

Field [8]:Repeat
Optional number of times to repeat the operation.
Optional number of times to repeat the operation.

FlickDown
IOS
( )

T, WINDOW, COMPONENT, FlickDown

T, WINDOW, COMPONENT, FlickDown, 3

Field [5]:Repeat
Optional number of times to repeat the operation.
Optional number of times to repeat the operation.

FlickLeft
IOS
( )

T, WINDOW, COMPONENT, FlickLeft

T, WINDOW, COMPONENT, FlickLeft, 3

Field [5]:Repeat
Optional number of times to repeat the operation.
Optional number of times to repeat the operation.

FlickRight
IOS
( )

T, WINDOW, COMPONENT, FlickRight

T, WINDOW, COMPONENT, FlickRight, 3

Field [5]:Repeat
Optional number of times to repeat the operation.
Optional number of times to repeat the operation.

FlickUp
IOS
( )

T, WINDOW, COMPONENT, FlickUp

T, WINDOW, COMPONENT, FlickUp, 3

Field [5]:Repeat
Optional number of times to repeat the operation.
Optional number of times to repeat the operation.

HScrollTo
RC RJ TC
( )

T, WINDOW, Object, HSCROLLTO, 0

T, WINDOW, Object, HSCROLLTO, 10

Field 5 :POSITION
Integer value that specifies the absolute position to scroll to.
Integer value that specifies the absolute position to scroll to, as would be used in the "Position=%" parameter for the HScrollTo action of the SQABasic GenericObject command.

JavaMenuSelect
RC WR
( )

T, WINDOW, MAINMENU, JavaMenuSelect, FileOpen

Field 5 :JavaMenuItem
Name of the Java menuitem to lookup and use for the selection.

Name of the Java menuitem to lookup and use for the selection. We expect the AppMap to contain the item in the format "Path=Menu->Item":

[MainMenu] FileOpen="Path=File->Open"

The full results from the AppMap lookup are used, so any valid content used with the JavaMenu Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

LeftDrag
RC RJ TID TC WR SE2
( )

T, WINDOW, WINDOW, LEFTDRAG, AnObject

T, WINDOW, AnObject, LEFTDRAG, ASubObject

T, WINDOW, AnObject, LEFTDRAG, "Coords=10;20;200;300"

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup or literal text to use for the left mouse drag.

Name of the AppMap subkey to lookup and use for the left drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

[GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20"

The results from the lookup are appended to the "Coords=" string used by the GenericObject Left_Drag command in Robot (if necessary). So any valid content used with the Left_Drag command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.
Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

MouseClick
RJ
( )

T, WINDOW, COMPONENT, MOUSECLICK

T, WINDOW, WINDOW, MOUSECLICK, AnObject

T, WINDOW, AnObject, MOUSECLICK, ASubObject

T, WINDOW, AnObject, MOUSECLICK, 10;20

T, WINDOW, AnObject, MOUSECLICK, "Coords=10;20"

Field [5]:AppMapSubkey
(Optional)Name of the AppMap subkey to lookup or the literal text to use for the click.
Without this we should click on the center of the object.
Name of the AppMap subkey to lookup and use for the click. We expect the AppMap or literal text to contain the item in the format "x,y":

[FolderTree] Node1="33,120" OR Node1="Coords=33,120" ... [AnHTMLImage] AMappdedRegion=Coords=10,10 ANamedRegion=AreaName=TechSupport AnIndexedRegion=AreaIndex=2 AnotherRegion=AreaID=Contact
The results from the lookup are appended to the "Coords=" string used by the MouseClick command in Robot (only if necessary). So any valid content used with the MouseClick command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.
The Rational Robot implementation also supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.
Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "50,200"

";" (semi-colon) Example: "50;200"

" " (space) Example: "50 200"

MultiClick
TID
( )

T, WINDOW, COMPONENT, MULTICLICK

T, WINDOW, COMPONENT, MULTICLICK, "", "4"

T, WINDOW, WINDOW, MULTICLICK, AnObject

T, WINDOW, COMPONENT, MULTICLICK, ASubObject

T, WINDOW, COMPONENT, MULTICLICK, 10;20

T, WINDOW, AnObject, MULTICLICK, "Coords=10;20", "4"

Field [5]:AppMapSubkey
(Optional)Name of the AppMap subkey to lookup or the literal text to use for the clicks.
Without this we should click on the center of the object.
Name of the AppMap subkey to lookup and use for the click. We expect the AppMap or literal text to contain the item in the format "x,y":

[FolderTree] Node1="33,120" OR Node1="Coords=33,120" ... [AnHTMLImage] AMappdedRegion=Coords=10,10 ANamedRegion=AreaName=TechSupport AnIndexedRegion=AreaIndex=2 AnotherRegion=AreaID=Contact
The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (only if necessary). So any valid content used with the Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.
Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

Field [6]:ClickCount
Optional number of times (1 to N) to click the item.
Optional number of times (1 to N) to click the item. The default if no value is provided is 3.

MultiClickScreenImage
TID
( )

T, WINDOW, COMPONENT, MULTICLICKSCREENIMAGE

T, WINDOW, COMPONENT, MULTICLICKSCREENIMAGE, "", "4"

T, WINDOW, WINDOW, MULTICLICKSCREENIMAGE, AnObject

T, WINDOW, COMPONENT, MULTICLICKSCREENIMAGE, ASubObject

T, WINDOW, COMPONENT, MULTICLICKSCREENIMAGE, 10;20

T, WINDOW, AnObject, MULTICLICKSCREENIMAGE, "Coords=10;20", "4"

Field [5]:AppMapSubkey
(Optional)Name of the AppMap subkey to lookup or the literal text to use for the clicks.
Same as MULTICLICK.
The keyword is simply provided as a means to differentiate Object-Based Testing from Image-Based Testing in your tests. However, this differentiation is not required.
Note: the TID supports this command using Image-Based Testing techniques and App Map entries as well as literal text coordinates.

Field [6]:ClickCount
Optional number of times (1 to N) to click the item.
Optional number of times (1 to N) to click the item. The default if no value is provided is 3.

Press
DRD IOS
( )

T, WINDOW, COMPONENT, Press

T, WINDOW, COMPONENT, Press, 3

Field [5]:Duration
Optional number of seconds (0 to N) to press on the object.
Optional number of seconds (0 to N) to press on the item. The default if no value is provided is 0.

RightClick
RC RJ TID TC WR ABT SE SE2 AUT
( )

T, WINDOW, WINDOW, RIGHTCLICK

T, WINDOW, WINDOW, RIGHTCLICK, , False

T, WINDOW, WINDOW, RIGHTCLICK, AnObject

T, WINDOW, AnObject, RIGHTCLICK, ASubObject

T, WINDOW, AnObject, RIGHTCLICK, "Coords=10;20"

Field [5]:AppMapSubkey
(Optional) Name of the AppMap subkey to lookup or the literal text to use for the right click.
Without this we should click on the center of the object.
Name of the AppMap subkey to lookup and use for the right click. We expect the AppMap or literal text to contain the item in the format "x,y":

[ToolItem] PrintTool="33,120" OR PrintTool="Coords=33,120"

The results from the lookup are appended to the "Coords=" string used by the GenericObject Right_Click command in Robot (if necessary). So any valid content used with the Right_Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.
Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "50,200"

";" (semi-colon) Example: "50;200"

" " (space) Example: "50 200"

Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.
Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).

Field [6]:AutoScroll
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.
If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

RightClickScreenImage
TID
( )

T, WINDOW, COMPONENT, RightClickScreenImage

T, WINDOW, AnObject, RightClickScreenImage, "Coords=10;20"

Field [5]:AppMapSubKey
(Optional) AppMapSubKey or literal text as documented in the CLICK command.

RightClickScreenLocation
TID
( )

T, WINDOW, WINDOW, RightClickScreenLocation

T, WINDOW, AnObject, RightClickScreenLocation, "Coords=200,400"

T, WINDOW, AnObject, RightClickScreenLocation, ASubObject

T, WINDOW, AnObject, RightClickScreenLocation

Field [5]:AppMapSubkey
(Sometimes Optional)Name of the AppMap subkey to locate in the AppMap.
Without this there MUST be absolute screen coordinates stored in the AppMap for the Window:Component specified.
Name of the AppMap subkey to locate in the App Map. We expect the AppMap to contain the coordinates in the following supported formats:
[Component] Node1="33,120" (comma-delimited) OR Node1="33;120" (semi-colon delimited) OR Node1="33 120" (space-delimited) OR Node1="Coords=33,120" (comma-delimited) OR Node1="Coords=33;120" (semi-colon delimited) OR Node1="Coords=33 120" (space-delimited)
Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

This field can instead contain the literal text of any absolute or relative coordinates in the same formats as shown above.

RightClickScreenPoint
TID
( )

T, BogusWin, BogusComp, RightClickScreenPoint, 33;120

Field 5 :Coords
The hardcoded X,Y screen coordinates--or the result of an expression--that provides the absolute screen coordinates to click.
The coordinates must be in the following supported formats:
"33,120" (comma-delimited) OR "33;120" (semi-colon delimited) OR "33 120" (space-delimited)
Note the "Coords=" prefix is NOT supported for this deprecated command.

RightDrag
RC RJ TID WR TC SE2
( )

T, WINDOW, WINDOW, RIGHTDRAG, AnObject

T, WINDOW, AnObject, LEFTDRAG, ASubObject

T, WINDOW, AnObject, RIGHTDRAG, "Coords=10;20;200;300"

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup or literal text to use for the right mouse drag.

Name of the AppMap subkey to lookup and use for the right drag. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

[GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20"

The results from the lookup are appended to the "Coords=" string used by the GenericObject Left_Drag command in Robot (if necessary). So any valid content used with the Right_Drag command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Important TID note. The TID IBT implementation supports using literal text in this parameter instead of an AppMapSubKey. If the value retrieved from this field is NOT found to exist in the App Map as a Sub Key then it will be used as literal text as if it HAD been retrieved from the App Map.
Any coordinates provided for TID IBT are considered relative to the top-left (0,0) of the image or item found unless PointRelative and\or Hotspot information in the IBT recognition string change this initial relative point to be somewhere else.

ShiftClick
RC RJ TID TC WR ABT SE SE2 AUT
( )

T, WINDOW, WINDOW, SHIFTCLICK

T, WINDOW, WINDOW, SHIFTCLICK, , False

T, WINDOW, WINDOW, SHIFTCLICK, AnObject

T, WINDOW, AnObject, SHIFTCLICK, ASubObject

Field [5]:AppMapSubkey
(Optional) Name of the AppMap subkey to lookup and use for the SHIFT click.
Without this we should click on the center of the object.
Name of the AppMap subkey to lookup and use for the SHIFT click. We expect the AppMap to contain the item in the format "x,y":

[ToolItem]
PrintTool="33,120" OR PrintTool="Coords=33,120"

The results from the lookup are appended to the "Coords=" string used by the GenericObject Shift_Click command in Robot (if necessary). So any valid content used with the Shift_Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.
Engines should also attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "50,200"

";" (semi-colon) Example: "50;200"

" " (space) Example: "50 200"

Important Abbot note. Presently, there is no support for AppMapSubkey specification (5th field).

Field [6]:AutoScroll
(Optional) True|False. If the component will be scrolled into view automatically before clicking. The default value is true.
If the component is out of view, the click action will not succeed. Normally we will scroll the component into view, and then perform the click action. But sometimes, the component is partially shown and click could work and user does not want the component shift, then we could turn off the auto-scroll ability by setting this parameter to false.
If this auto-scroll is turned off, user needs to make sure that component is shown by himself.

ShiftClickScreenImage
TID
( )

T, WINDOW, COMPONENT, ShiftClickScreenImage

T, WINDOW, COMPONENT, ShiftClickScreenImage, AppMapLookup

T, WINDOW, COMPONENT, ShiftClickScreenImage, "Coords=50;200"

Field [5]:AppMapSubKey
(Optional) AppMapSubKey type of use as documented in the CLICK command.

ShiftLeftDrag
RJ TC SE2
( )

T, WINDOW, WINDOW, SHIFTLEFTDRAG, AnObject

T, WINDOW, AnObject, SHIFTLEFTDRAG, ASubObject

T, WINDOW, AnObject, SHIFTLEFTDRAG, "Coords=10;20;200;300"

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup or literal text to use for the SHIFT left mouse drag.

Name of the AppMap subkey to lookup and use for the operation. We expect the AppMap or literal text to contain the item in the format "x1,y1,x2,y2":

[GenericItem] DragName="3,10,12,20" OR DragName="Coords=3,10,12,20"

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Tap
DRD IOS
( )

TwoFingerTap
IOS
( )

T, WINDOW, COMPONENT, TwoFingerTap

VerifyImage
RC
( )

T, WINDOW, AnObject, VERIFYIMAGE, "AStoredVP"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then a RegionImageVP will be attempted.

VScrollTo
RC RJ TC
( )

T, WINDOW, Object, VSCROLLTO, 0

T, WINDOW, Object, VSCROLLTO, 10

Field 5 :POSITION
Integer value that specifies the absolute position to scroll to.
Integer value that specifies the absolute position to scroll to, as would be used in the "Position=%" parameter for the VScrollTo action of the SQABasic GenericObject command.

GraphicControlFunctions

GraphicControlFunctions Documentation.

Click
WR
( )

T, WINDOW, GraphicControl, CLICK

ClickButton
RC WR
( )

T, WINDOW, GraphicControl, CLICKBUTTON

HTMLDocumentFunctions

HTMLDocumentFunctions Documentation.

CaptureBodySourceToFile
RC RJ SE
( )

T, WebBrowser, WebPage, CaptureBodySourceTofile, OutputFile

T, WebBrowser, WebPage, CaptureBodySourceTofile, OutputFile, "UTF-8"

Field 5 :Filename
Name of the output file to create in the active "Test" directory.
Name of the output file to create in the active "Test" directory. This is the name only, no path information is expected. If the file extension is omitted then the default extension of ".TXT" will be used.

Field [6]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

CaptureBodyTextToFile
RC RJ SE
( )

T, WebBrowser, WebPage, CaptureBodyTextTofile, OutputFile

T, WebBrowser, WebPage, CaptureBodyTextTofile, OutputFile, "UTF-8"

Field 5 :Filename
Name of the output file to create in the active "Test" directory.
Name of the output file to create in the active "Test" directory. This is the name only, no path information is expected. If the file extension is omitted then the default extension of ".TXT" will be used.

Field [6]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

ClickLink
RC RJ SE
( )

T, WebBrowser, WebPage, CLICKLINK, "Yearly Reports"

T, WebBrowser, WebPage, CLICKLINK, "Yearly Reports", 1, "CaseSensitive"

T, WebBrowser, WebPage, CLICKLINK, "Yearly Reports", 4

Field 5 :CompareTextValue
The text to compare with each Link.
The text to compare with each Link. By default this comparison is not case-sensitive.

Field [6]:MatchIndex
Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. The index is 1-based. "1" selects the first matching link, "2" selects the second matching link, etc..

Field [7]:CaseSensitive
"Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.
"Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

ClickLinkBeginning
RC RJ SE
( )

T, WebBrowser, WebPage, CLICKLINKBEGINNING, "Report Generated on"

T, WebBrowser, WebPage, CLICKLINKBEGINNING, "Report Generated on", 4

T, WebBrowser, WebPage, CLICKLINKBEGINNING, "Report", 1, ^CaseSensitive="TRUE"

Field 5 :BeginningTextValue
The text (NOT case-sensitive) to compare with the beginning of each Link.
The text (NOT case-sensitive) to compare with the beginning of each Link.

Field [6]:MatchIndex
Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. The index is 1-based. "1" selects the first matching link, "2" selects the second matching link, etc..

Field [7]:CaseSensitive
"Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.
"Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

ClickLinkContaining
RC RJ SE
( )

T, WebBrowser, WebPage, CLICKLINKCONTAINING, "Yearly Reports"

T, WebBrowser, WebPage, CLICKLINKCONTAINING, "Yearly Reports", 1, "CaseSensitive"

T, WebBrowser, WebPage, CLICKLINKCONTAINING, "Yearly Reports", 4

Field 5 :CompareTextValue
The text to compare with each Link.
The text (NOT case-sensitive) to compare with each Link.

Field [6]:MatchIndex
Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. The index is 1-based. "1" selects the first matching link, "2" selects the second matching link, etc..

Field [7]:CaseSensitive
"Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.
"Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

ClickLinkMatching
RC SE
( )

T, WebBrowser, WebPage, ClickLinkMatching, "Yearly Reports"

T, WebBrowser, WebPage, ClickLinkMatching, "Yearly Reports", 1, "CaseSensitive"

T, WebBrowser, WebPage, ClickLinkMatching, "Yearly Reports", 4

Field 5 :CompareTextValue
The text to compare with each Link.
The text to compare with each Link. By default this comparison is not case-sensitive.

Field [6]:MatchIndex
Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches.
Optional match index indicating the desired link is not the first link that matches, but the "nth" link that matches. The index is 1-based. "1" selects the first matching link, "2" selects the second matching link, etc..

Field [7]:CaseSensitive
"Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.
"Case-Sensitive", "CaseSensitive", or "True" will make search case-sensitive.

VerifyBodySource
RC RJ SE
( W )

T, WebBrowser, WebPage, VERIFYBODYSOURCE, BenchmarkFile.TXT

T, WebBrowser, WebPage, VERIFYBODYSOURCE, BenchmarkFile.TXT, "UTF-8"

Field 5 :Benchmark
Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.
Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison. This is the name only, no path information is expected. If the file extension is omitted then the default extension of ".TXT" will be used.

Field [6]:FileEncoding
Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

VerifyBodyText
RC RJ SE
( W )

T, WebBrowser, WebPage, VERIFYBODYTEXT, BenchmarkFile.TXT

T, WebBrowser, WebPage, VERIFYBODYTEXT, BenchmarkFile.TXT, "UTF-8"

Field 5 :Benchmark
Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison.
Name of the benchmark file in the active "Bench" directory to use for the actual test file comparison. This is the name only, no path information is expected. If the file extension is omitted then the default extension of ".TXT" will be used.

Field [6]:FileEncoding
Specify a character encoding to be used when opening a bench file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

HTMLFunctions

HTMLFunctions Documentation.

HTMLImageFunctions

HTMLImageFunctions Documentation.

Click
WR
( )

T, WebBrowser, SiteMapImage, CLICK, Center

Field [5]:AppMapSubkey
Name of the AppMap subkey to lookup and use for the click.

(OPTIONAL) Name of the AppMap subkey to lookup and use for the click. The AppMap can contain the item in any of the following formats:

[AnImage] AMappdedRegion=Coords=10,10 ANamedRegion=AreaName=TechSupport AnIndexedRegion=AreaIndex=2 AnotherRegion=AreaID=Contact
Any valid content used with the HTMLImage Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

ClickArea
RJ
( )

T, WebBrowser, ADefinedArea, ClickArea

Field [5]:AppMapSubkey
(FUTURE) Name of the AppMap subkey to lookup and use for the image area click.
(FUTURE) Not used by RobotJ at this time.
The AppMap could contain the item in any of the following formats:
[AnImage] AMappdedRegion=Coords=10,10 ANamedRegion=AreaName=TechSupport AnIndexedRegion=AreaIndex=2 AnotherRegion=AreaID=Contact
Both Fields #3 and #5 would be used to locate the item in the App Map. This routine does not specify an App Map so only the current Map would be used and it is expected to be valid.

CompareStoredData
WR
( )

T, WebBrowser, SiteMapImage, COMPARESTOREDDATA, "AStoredVP"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

CompareStoredProperties
WR
( )

T, WebBrowser, SiteMapImage, COMPARESTOREDPROPERTIES, "AStoredVP"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

SaveHTMLImage
RC RJ
( )

T, WebBrowser, myImage, SaveHTMLImage, ^filename=myImage.jpg

T WebBrowser myImage SaveHTMLImage ^filename=c:\images\myImage.jpg ^xy="25,25"

T WebBrowser myImage SaveHTMLImage ^filename=images\myImage.jpg ^xy="Coords=25,25"

T WebBrowser myImage SaveHTMLImage ^filename=images\myImage.jpg ^xy="TopRight"

Field 5 :FileName
Name of the image file.

(Required) Name of the file to use for the image save-as command. This can be a full or relative path or a simple filename. A relative path will be stored relative to the Project's root directory. If a simple filename is provided it will be stored in the Project's Datapool\Test directory.

Field [6]:Coords
The explicit coordinates ("x,y"), or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyImage] TopRight=50,10 Center=25,25 BottomRight=Coords=50,40
The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

If this parameter is not provided, we will use default coordinates of 3,3 for the right click.

VerifyHTMLImage
RC RJ
( W )

T, WebBrowser, myImage, VerifHTMLImage, ^bench=myImage.jpg

T, WebBrowser, myImage, VerifHTMLImage, ^bench=myImage.jpg, ^rightclick="Coords=15,15"

T, WebBrowser, myImage, VerifHTMLImage, ^bench=myImage.jpg, ^rightclick=TopLeft

Field 5 :BenchmarkFile
Name of the Benchmark image file.

(REQUIRED) Name of the file to use for the image save-as command and the benchmark file. This can also be a full or relative path suitable for FindSQAFile. If no full path or relative path is given then the benchmark file is expected to be found in the project's Datapool\Bench directory.

The captured image will be stored in the project's Datapool\Test project's Datapool/Test directory. Any comparison difference will be stored in the project's Datapool\Dif directory.

Field [6]:Coords
The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyImage] TopLeft=10,10 Center=Coords=25,25
The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

If this parameter is not provided, we will use default coordinates of 3,3 for the right click.

HTMLLinkFunctions

HTMLLinkFunctions Documentation.

Click
WR
( )

T, WebBrowser, URLLink, CLICK

CompareStoredData
WR
( )

T, WebBrowser, URLLink, COMPARESTOREDDATA, "AStoredVP"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

CompareStoredProperties
WR
( )

T, WebBrowser, URLLink, COMPARESTOREDPROPERTIES, "AStoredVP"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

HTMLTableFunctions

HTMLTableFunctions Documentation.

ActivateCell
RJ SE
( )

T, WebBrowser, WebTable, ActivateCell

T, WebBrowser, WebTable, ActivateCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

AssignCellContainsTextRow
RJ SE
( )

T, WebBrowser, WebTable, AssignCellContainsTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be the user-defined variable +".Value".

Field 6 :Col
The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.
The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.
The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.

Field 8 :ValueN
A Value to search for in the 'COLN' column.
These values can be partial substrings and are not case-sensitive.

AssignCellTextRow
RJ SE
( )

T, WebBrowser, WebTable, AssignCellTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be this user-defined variable +".Value".

Field 6 :Col
The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in the 'COLN' column
These values are case-sensitive and must consititute an exact match.

AssignVariableCellText
RJ SE
( )

T, WebBrowser, WebTable, AssignVariableCellText, AVariableName

T, WebBrowser, WebTable, AssignVariableCellText, "AVariableName", 1 , 1

T, WebBrowser, WebTable, AssignVariableCellText, "^AVariableName", ^row=4, ^col="5"

C, SetVariableValues, ^AVariableName="NextVariableName"
T, WebBrowser, WebTable, AssignVariableCellText, ^AVariableName, ^row="5", ^col=2

Field 5 :VariableName
The name of the variable to receive the property value.
The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Field [6]:Row
The 1-based cell row # in the row/col specification.
RJ: Does not yet support using a unique row value in column 1 as a row identifier.

Field [7]:Col
The 1-based cell column # in the row/col specification.
RJ: Does not yet support using a unique col header value as a column identifier.

CaptureFuzzyRangeToFile
RJ SE
( )

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt, 1 , 1

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt, 4, "field5", 2, 5

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt, "datum", 5, , 2

T, WebBrowser, WebTable, CaptureFuzzyRangeToFile, AFileName.txt, , , , , "UTF-8"

Field 5 :FileName
The name of the file to receive the data.
The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
Any specified full or relative path must already exist.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Field [8]:Rows
The number of rows to capture.
If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
If the parameter is not provided, all subsequent rows from the specified starting row are captured.

Field [9]:Columns
The number of columns to capture.
If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
If the parameter is not provided, all subsequent columns from the specified starting column are captured.

Field [10]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [11]:FilterMode
(FUTURE) A file filter to use when processing the text values.

Field [12]:FilterOptions
(FUTURE) Filter options to use with the file filter.

CaptureRangeToFile
RJ SE
( )

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt, 1 , 1

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt, 4, "Field5", 2, 5

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt, "ADatum", 5, , 2

T, WebBrowser, WebTable, CaptureRangeToFile, AFileName.txt, , , , , "UTF-8"

Field 5 :FileName
The name of the file to receive the data.
The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
Any specified full or relative path must already exist.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field [8]:Rows
The number of rows to capture.
If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
If the parameter is not provided, all subsequent rows from the specified starting row are captured.

Field [9]:Columns
The number of columns to capture.
If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
If the parameter is not provided, all subsequent columns from the specified starting column are captured.

Field [10]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [11]:FilterMode
(FUTURE) A file filter to use when processing the text values.

Field [12]:FilterOptions
(FUTURE) Filter options to use with the file filter.

Click
WR
( )

T, WebBrowser, WebTable, CLICK, Centert

Field [5]:AppMapSubkey
Name of the AppMap subkey to lookup and use for the click.

Name of the AppMap subkey to lookup and use for the click. The AppMap can contain the item in any of the following formats:

[ATable]
AMappedRegion=Coords=10,10
ANamedRegion=Coords=10,10,25,25
AnIndexedRegion=Col=1;Row=1

Any valid content used with the HTMLTable Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

ClickCell
RC RJ WR SE
( )

T, WebBrowser, WebTable, ClickCell, 1, 3

Field 5 :Row
The row of the cell to click.
The cell is fully defined by the intersection of the row and column values.

Field 6 :Col
The column of the cell to click.
The cell is fully defined by the intersection of the row and column values.

CompareStoredData
WR
( )

T, WebBrowser, WebPage, COMPARESTOREDDATA, "AStoredVP"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

CompareStoredProperties
WR
( )

T, WebBrowser, WebPage, COMPARESTOREDPROPERTIES, "AStoredVP"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.
Name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then the additional stored parameters are appended to the VP call.

DoubleClickCell
RJ SE
( )

T, WebBrowser, WebTable, DoubleClickCell

T, WebBrowser, WebTable, DoubleClickCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

RightClickCell
RJ SE
( )

T, WebBrowser, WebTable, RightClickCell

T, WebBrowser, WebTable, RightClickCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

SelectCell
RJ SE
( )

T, WebBrowser, WebTable, SelectCell

T, WebBrowser, WebTable, SelectCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

SelectCellContainsTextFind
RJ SE
( )

T, WebBrowser, WebTable, SelectCellContainsTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # or header value, identifying the column for the select.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.
These comparisons are not case-sensitive and can be substrings of the actual table text.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.
These comparisons are not case-sensitive and can be substrings of the actual table text.

Field 8 :ValueN
A Value to search for in the 'COLN' column
The values are not case-sensitive and can be substrings of the actual table text.

SelectCellText
RJ SE
( )

T, WebBrowser, WebTable, SelectCellText

T, WebBrowser, WebTable, SelectCellText, 1 , 1

T, WebBrowser, WebTable, SelectCellText, 4, "Field5"

T, WebBrowser, WebTable, SelectCellText, "ADatum", 5

Field [5]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [6]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

SelectCellTextFind
RJ SE
( )

T, WebBrowser, WebTable, SelectCellTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # or header value, identifying the column for the select.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in the 'COLN' column

SelectCellTextSpecial
RJ
( )

T, WebBrowser, WebTable, SelectCellTextSpecial, Control, Left, 2, 3

T, WebBrowser, WebTable, SelectCellTextSpecial, Shift, Left, 2, 3

Field 5 :SpecialKey
The special key command used in the row selection. For now, ownly "Control" and "Shift" are supported.

Field 6 :MouseClick
The type of mouse click needed. For now, ownly "Left" and "Right" are supported.

Field 7 :Row
The 1-based cell row in the row/col specification.

Field 8 :Col
The 1-based cell column in the row/col specification.

SelectFuzzyCellText
RJ SE
( )

T, WebBrowser, WebTable, SelectFuzzyCellText

T, WebBrowser, WebTable, SelectFuzzyCellText, 1 , 1

T, WebBrowser, WebTable, SelectFuzzyCellText, 4, "field5"

T, WebBrowser, WebTable, SelectFuzzyCellText, "datum", 5

Field [5]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [6]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

SelectFuzzyCellTextFind
RJ SE
( )

T, WebBrowser, WebTable, SelectFuzzyCellTextFind, Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

VerifyCellEditable
RJ SE
( )

T, WebBrowser, WebTable, VerifyCellEditable, "2", "3", "true"

Field 5 :Row
The 1-based cell row in the row/col specification.

Field 6 :Col
The 1-based cell column in the row/col specification.

Field 7 :ExpectedValue
The case-insensitive value we expect for the editable value ("true" or"false").

VerifyCellText
RJ SE
( )

T, WebBrowser, WebTable, VerifyCellText, FirstCellValue

T, WebBrowser, WebTable, VerifyCellText, "FirstCellValue", 1 , 1

T, WebBrowser, WebTable, VerifyCellText, "BenchValue", ^row=4, ^col="5"

T, WebBrowser, WebTable, VerifyCellText, "BenchData", ^row="5", ^col=2

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field [6]:Row
The 1-based cell row # in the row/col specification.
RJ: Does not yet support using a row value in Column 1 as a row identifier.

Field [7]:Col
The 1-based cell column # in the row/col specification.
RJ: Does not yet support using a column header value as a column identifier.

VerifyCellTextContains
RJ SE
( )

T, WebBrowser, WebTable, VerifyCellTextContains, FirstCellValue

T, WebBrowser, WebTable, VerifyCellTextContains, "firstcell", 1 , 1

T, WebBrowser, WebTable, VerifyCellTextContains, "bench", ^row=4, ^col="5"

Field 5 :BenchValue
The expected value for the specified cell.
The value can be a substring of the full expected value and is NOT case-sensitive.

Field [6]:Row
The 1-based cell row # in the row/col specification.
RJ: Does not yet support using a unique row value in Column 1 as a row specifier.

Field [7]:Col
The 1-based cell column # in the row/col specification.
RJ: Does not yet support using a unique column header value as a column specifier.

VerifyCellTextFind
RJ SE
( )

T, WebBrowser, WebTable, VerifyCellTextFind, "10/09/2003", Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field 6 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 7 :Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 8 :ColN
A 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 9 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

VerifyCellValue
RJ WR SE
( )

T, WebBrowser, WebTable, VerifyCellValue, ExpectedValue

T, WebBrowser, WebTable, VerifyCellValue, ExpectedValue, "2,2"

Field 5 :ExpectedValue
The Expected Value of the cell.
The Expected Value of the cell, this will be used to compare with the actual value of the cell and logged as a pass or fail. This value is case sensitive and should acurately reflect the text string of the cell being tested.

Field [6]:Cell
This is the optional cell location to be tested
This is the optional cell location to be tested, it will be assummed if value is not present that the command is referencing cell 1,1

VerifyColumnLabel
RJ SE
( )

T, WebBrowser, WebTable, VerifyColumnLabel, "Foo", "4"

T, WebBrowser, WebTable, VerifyColumnLabel, "Foo SecondFoo", "4"

Field 5 :ColLabel
The case-insensitive expected value for the specified column label.

Field 6 :ColNumber
The 1-based column number of the label that needs verified.

VerifyFuzzyCellText
RJ SE
( )

T, WebBrowser, WebTable, VerifyFuzzyCellText, FirstCellValue

T, WebBrowser, WebTable, VerifyFuzzyCellText, "FirstCellValue", 1 , 1

T, WebBrowser, WebTable, VerifyFuzzyCellText, ABenchValue, 4, "field5"

T, WebBrowser, WebTable, VerifyFuzzyCellText, ^ABenchValue, "datum", 5

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

VerifyFuzzyCellTextContains
RJ SE
( )

T, WebBrowser, WebTable, VerifyFuzzyCellTextContains, FirstCellValue

T, WebBrowser, WebTable, VerifyFuzzyCellTextContains, "firstcell", 1 , 1

T, WebBrowser, WebTable, VerifyFuzzyCellTextContains, bench, 4, "field5"

T, WebBrowser, WebTable, VerifyFuzzyCellText, bench, "datum", 5

Field 5 :BenchValue
The expected value for the specified cell.
The value can be a substring of the full expected value and is NOT case-sensitive.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

VerifyFuzzyCellTextFind
RJ SE
( )

T, WebBrowser, WebTable, VerifyFuzzyCellTextFind, "10/09/2003", Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field 6 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 7 :Col
The 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 8 :ColN
A 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 9 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

JavaMenuFunctions

JavaMenuFunctions Documentation.

ResetMenuCache
TC
( )

T, JavaWindow, JavaMenu, ResetMenuCache

SelectMenuItem
RC RJ TC SE2
( )

T, WINDOW, FileMenu, SelectMenuItem

T, WINDOW, FileMenu, SelectMenuItem, "Exit"

T, WINDOW, AJmenu, SelectMenuItem, "File"

T, WINDOW, AJMenu, SelectMenuItem, "File->Exit"

T, WINDOW, AJmenu, SelectMenuItem, "FileOpen"

T, WINDOW, AJMenu, SelectMenuItem, "File->Exit", "1->2"

T, WINDOW, AJMenu, SelectMenuItem, "Fil*->[eE]xit"

Field [5]:TextValue
Case-sensitive text of menuItem to select OR an App Map reference.
TextValue is the case-sensitive text of the menuitem to select. Parent-Child relationships are separated by "->".
Alternatively, the TextValue can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit menu item text in the App Map.

Field [6]:indexPath
The index for item of each level. It is 1-based.
The index for item of each level. It is 1-based. If there are several menuitem in the same level with same text, this parameter can be used to indicate which one is wanted. Parent-Child relationships are separated by "->".
Alternatively, the indexPath can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit indexes in the App Map.

SelectMenuItemContains
RC RJ TC SE2
( )

T, WINDOW, FileMenu, SelectMenuItemContains, "exi"

T, WINDOW, AJMenu, SelectMenuItemContains, "f->exit"

T, WINDOW, AJMenu, SelectMenuItemContains, "file->e", "1->2"

Field [5]:TextValue
Case-insensitive substring of menuItem to select OR an App Map reference.
Parent-Child relationships are separated by "->"
Alternatively, the TextValue can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit menu item text in the App Map.
Note: RJ implementation: this field is required.

Field [6]:indexPath
The index for item of each level. It is 1-based.
The index for item of each level. It is 1-based. If there are several menuitem in the same level with same text, this parameter can be used to indicate which one is wanted. Parent-Child relationships are separated by "->".
Alternatively, the indexPath can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit indexes in the App Map.

SelectUnverifiedMenuItem
RJ TC SE2
( )

T, WINDOW, AJmenu, SelectUnverifiedMenuItem, "File"

T, WINDOW, AJMenu, SelectUnverifiedMenuItem, "File->Exit"

T, WINDOW, AJmenu, SelectUnverifiedMenuItem, "FileOpen"

T, WINDOW, AJMenu, SelectUnverifiedMenuItem, "file->edit", "1->2"

T, WINDOW, AJMenu, SelectMenuItem, "Fil*->[eE]xit"

Field 5 :TextValue
Case-sensitive text of menuItem to select OR an App Map reference.
TextValue is the case-sensitive text of the menuitem to select. Parent-Child relationships are separated by "->".
Alternatively, the TextValue can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit menu item text in the App Map.

Field [6]:indexPath
The index for item of each level. It is 1-based.
The index for item of each level. It is 1-based. If there are several menuitem in the same level with same text, this parameter can be used to indicate which one is wanted. Parent-Child relationships are separated by "->".
Alternatively, the indexPath can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit indexes in the App Map.

VerifyMenuItem
RJ TC SE2
( )

T, JavaWindow, JavaMenu, VerifyMenuItem, "File"

T, JavaWindow, JavaMenu, VerifyMenuItem, "Weird->CheckBox", "Enabled Checked"

T, WINDOW, AJMenu, VerifyMenuItem, "file->edit","Enabled", "1->2"

Field 5 :MenuItemText
Menu->MenuItem hierarchy string to identify which menuitem to find.
Menu->MenuItem hierarchy string to identify which menuitem to find. This menu hierarchy IS case-sensitive
TQ String. the full case-sensitive menu item path to select. Ampersands (&) indicating/preceding underlined characters are optional. The text must include the full text including spaces and any visible shortcut key combinations displayed in the text of the menu item.

Field [6]:ExpectedStatus
Expected status string (or part thereof) of the menuitem.
Expected status string (or part thereof) to verify. Only "Enabled" "Ungrayed" "Grayed" "Disabled" "Checked" "Unchecked" "Menu With N MenuItems" are supported now.
Ex: "Enabled Checked" OR "Grayed UnChecked" etc.
Each item separated by a space will be evaluated separately so the order of the status items does not matter. Only the state information of interest needs to be specified. These status items ARE case-insensitive,space-delimited.

Field [7]:indexPath
The index for item of each level. It is 1-based.
The index for item of each level. It is 1-based. If there are several menuitem in the same level with same text, this parameter can be used to indicate which one is wanted. Parent-Child relationships are separated by "->".
Alternatively, the indexPath can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit indexes in the App Map.

VerifyMenuItemContains
RJ TC SE2
( )

T, JavaWindow, JavaMenu, VerifyMenuItemContains, "Fil->Sav"

T, JavaWindow, JavaMenu, VerifyMenuItemContains, "Fil->Sav","Enabled"

T, WINDOW, AJMenu, VerifyMenuItemContains, "fi->e","Enabled", "1->2"

Field 5 :MenuItemText
Menu->MenuItem hierarchy string to identify which menuitem to find.
Menu->MenuItem hierarchy string to identify which menuitem to find. This menu hierarchy IS case-sensitive
TQ String. the case-sensitive menu item path to select. Ampersands (&) indicating/preceding underlined characters are optional. The text can be any substring of the full text including spaces and any visible shortcut key combinations displayed in the text of the menu item.

Field [6]:ExpectedStatus
Expected status string (or part thereof) of the menuitem.
Expected status string (or part thereof) to verify. Only "Enabled" "Ungrayed" "Grayed" "Disabled" "Checked" "Unchecked" "Menu With N MenuItems" are supported now.
Ex: "Enabled Checked" OR "Grayed UnChecked" etc.
Each item separated by a space will be evaluated separately so the order of the status items does not matter. Only the state information of interest needs to be specified. These status items ARE case-insensitive,space-delimited.

Field [7]:indexPath
The index for item of each level. It is 1-based.
The index for item of each level. It is 1-based. If there are several menuitem in the same level with same text, this parameter can be used to indicate which one is wanted. Parent-Child relationships are separated by "->".
Alternatively, the indexPath can be an App Map reference item used in conjunction with the Component Name (field #3) that allows us to store explicit indexes in the App Map.

JavaTableFunctions

JavaTableFunctions Documentation.

ActivateCell
RC RJ TC
( )

T, JavaWin, JTable, ActivateCell

T, JavaWin, JTable, ActivateCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

ActivateColumnLabel
RJ TC
( )

T, JavaWin, JTable, ActivateColumnLabel, "2"

Field 5 :ColNumber
The 1-based column label number to double click.

Field [6]:YOffset
(FUTURE) Number of pixels to adjust where the actual double click occurs.

AssignCellContainsTextRow
RC RJ TC
( )

T, JavaWin, JTable, AssignCellContainsTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be the user-defined variable +".Value".

Field 6 :Col
The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.
The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.
The field header comparisons are not case-senstive, and provided values can be substrings of the actual header value in the table.

Field 8 :ValueN
A Value to search for in the 'COLN' column.
These values can be partial substrings and are not case-sensitive.

AssignCellTextRow
RC RJ TC
( )

T, JavaWin, JTable, AssignCellTextRow, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string. This variable also is the rootname for the variable that will receive the cell text value once the row # is identified. The cell value variable will be this user-defined variable +".Value".

Field 6 :Col
The 1-based cell column # or header value, identifying the column for extracting the cell value into variable +".Value".
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in the 'COLN' column
These values are case-sensitive and must consititute an exact match.

AssignVariableCellText
RC RJ TC
( )

T, JavaWin, JTable, AssignVariableCellText, AVariableName

T, JavaWin, JTable, AssignVariableCellText, "AVariableName", 1 , 1

T, JavaWin, JTable, AssignVariableCellText, "^AVariableName", 4, "Field5"

C, SetVariableValues, ^AVariableName="NextVariableName"
T, JavaWin, JTable, AssignVariableCellText, ^AVariableName, "ADatum", 5

Field 5 :VariableName
The name of the variable to receive the property value.
The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

AssignVariableFuzzyCellText
RC RJ TC
( )

T, JavaWin, JTable, AssignVariableFuzzyCellText, AVariableName

T, JavaWin, JTable, AssignVariableFuzzyCellText, "AVariableName", 1 , 1

T, JavaWin, JTable, AssignVariableFuzzyCellText, "^AVariableName", 4, "field5"

C, SetVariableValues, ^AVariableName="NextVariableName"
T, JavaWin, JTable, AssignVariableFuzzyCellText, ^AVariableName, "datum", 5

Field 5 :VariableName
The name of the variable to receive the property value.
The name of the variable to receive the property value. Note, if you supply the name of the variable and include the leading caret (^) symbol then the variable must be enclosed in quotes. Otherwise, that variable will be used like any other variable and the substituted value of that variable will be interpretted as the name of the variable you wish to use.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

CaptureFuzzyRangeToFile
RC RJ TC
( )

T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt

T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt, 1 , 1

T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt, 4, "field5", 2, 5

T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt, "datum", 5, , 2

T, JavaWin, JTable, CaptureFuzzyRangeToFile, AFileName.txt, , , , , "UTF-8"

Field 5 :FileName
The name of the file to receive the data.
The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
Any specified full or relative path must already exist.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

Field [8]:Rows
The number of rows to capture.
If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
If the parameter is not provided, all subsequent rows from the specified starting row are captured.

Field [9]:Columns
The number of columns to capture.
If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
If the parameter is not provided, all subsequent columns from the specified starting column are captured.

Field [10]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [11]:FilterMode
(FUTURE) A file filter to use when processing the text values.

Field [12]:FilterOptions
(FUTURE) Filter options to use with the file filter.

CaptureRangeToFile
RC RJ TC
( )

T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt

T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt, 1 , 1

T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt, 4, "Field5", 2, 5

T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt, "ADatum", 5, , 2

T, JavaWin, JTable, CaptureRangeToFile, AFileName.txt, , , , , "UTF-8"

Field 5 :FileName
The name of the file to receive the data.
The data will be output as TAB delimited values. The filename is usually just the short filename.ext and as such will be stored in the project's Datapool\Test directory.
If you specify a relative path, the path is relative to the project's root directory. "Datapool" is a subdirectory of that root directory.
Any specified full or relative path must already exist.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field [8]:Rows
The number of rows to capture.
If there are not enough rows to satisfy the request then we will obviously only capture up to the last available row.
If the parameter is not provided, all subsequent rows from the specified starting row are captured.

Field [9]:Columns
The number of columns to capture.
If there are not enough columns to satisfy the request then we will obviously only capture up to the last available column.
If the parameter is not provided, all subsequent columns from the specified starting column are captured.

Field [10]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [11]:FilterMode
(FUTURE) A file filter to use when processing the text values.

Field [12]:FilterOptions
(FUTURE) Filter options to use with the file filter.

ClickCell
RC RJ TC
( )

T, JavaWin, JTable, CLICKCELL

T, JavaWin, JTable, CLICKCELL, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

ClickColumnLabel
RJ TC
( )

T, JavaWin, JTable, ClickColumnLabel, "2"

Field 5 :ColNumber
The 1-based column label number to click.

Field [6]:YOffset
(FUTURE) Number of pixels to adjust where the actual click occurs.

DoubleClickCell
RC RJ TC
( )

T, JavaWin, JTable, DoubleClickCell

T, JavaWin, JTable, DoubleClickCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

DoubleClickColumnLabel
RJ TC
( )

T, JavaWin, JTable, DoubleClickColumnLabel, "2"

Field 5 :ColNumber
The 1-based column label number to double click.

Field [6]:YOffset
(FUTURE) Number of pixels to adjust where the actual double click occurs.

RightClickCell
RC RJ TC
( )

T, JavaWin, JTable, RightClickCell

T, JavaWin, JTable, RightClickCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

RightClickColumnLabel
RJ TC
( )

T, JavaWin, JTable, RightClickColumnLabel, "2"

Field 5 :ColNumber
The 1-based column label number to click.

Field [6]:YOffset
(FUTURE) Number of pixels to adjust where the actual click occurs.

SelectCell
RC RJ TC
( )

T, JavaWin, JTable, SelectCell

T, JavaWin, JTable, SelectCell, 3, 4

Field [5]:Row
The 1-based cell row in the row/col specification.

Field [6]:Col
The 1-based cell column in the row/col specification.

SelectCellContainsTextFind
RC RJ TC
( )

T, JavaWin, JTable, SelectCellContainsTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # or header value, identifying the column for the select.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.
These comparisons are not case-sensitive and can be substrings of the actual table text.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.
These comparisons are not case-sensitive and can be substrings of the actual table text.

Field 8 :ValueN
A Value to search for in the 'COLN' column
The values are not case-sensitive and can be substrings of the actual table text.

SelectCellText
RC RJ TC
( )

T, JavaWin, JTable, SelectCellText

T, JavaWin, JTable, SelectCellText, 1 , 1

T, JavaWin, JTable, SelectCellText, 4, "Field5"

T, JavaWin, JTable, SelectCellText, "ADatum", 5

Field [5]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [6]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

SelectCellTextFind
RC RJ TC
( )

T, JavaWin, JTable, SelectCellTextFind, Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # or header value, identifying the column for the select.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column #, or header value, identifying the column to locate the VALUEN below.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in the 'COLN' column

SelectCellTextSpecial
RJ TC
( )

T, Frame, custTableTable, SelectCellTextSpecial, Control, Left, 2, 3

T, Frame, custTableTable, SelectCellTextSpecial, Shift, Left, 2, 3

Field 5 :SpecialKey
The special key command used in the row selection. For now, ownly Control and Shift are supported.

Field 6 :MouseClick
The type of mouse click needed. For now, ownly Left and Right are supported.

Field 7 :Row
The 1-based cell row in the row/col specification.

Field 8 :Col
The 1-based cell column in the row/col specification.

SelectFuzzyCellText
RC RJ TC
( )

T, JavaWin, JTable, SelectFuzzyCellText

T, JavaWin, JTable, SelectFuzzyCellText, 1 , 1

T, JavaWin, JTable, SelectFuzzyCellText, 4, "field5"

T, JavaWin, JTable, SelectFuzzyCellText, "datum", 5

Field [5]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [6]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

SelectFuzzyCellTextFind
RC RJ TC
( )

T, JavaWin, JTable, SelectFuzzyCellTextFind, Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"

Field 5 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 6 :Col
The 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 7 :ColN
A 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 8 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

VerifyCellEditable
RJ TC
( )

T, JavaWin, JTable, VerifyCellEditable, "2", "3", "true"

Field 5 :Row
The 1-based cell row in the row/col specification.

Field 6 :Col
The 1-based cell column in the row/col specification.

Field 7 :ExpectedValue
The case-insensitive value we expect for the editable value.

VerifyCellText
RC RJ TC
( )

T, JavaWin, JTable, VerifyCellText, FirstCellValue

T, JavaWin, JTable, VerifyCellText, "FirstCellValue", 1 , 1

T, JavaWin, JTable, VerifyCellText, "BenchValue", 4, "Field5"

T, JavaWin, JTable, VerifyCellText, "BenchData", "ADatum", 5

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

VerifyCellTextContains
RC RJ TC
( )

T, JavaWin, JTable, VerifyCellTextContains, FirstCellValue

T, JavaWin, JTable, VerifyCellTextContains, "firstcell", 1 , 1

T, JavaWin, JTable, VerifyCellTextContains, "bench", 4, "Field5"

T, JavaWin, JTable, VerifyCellTextContains, "bench", "ADatum", 5

Field 5 :BenchValue
The expected value for the specified cell.
The value can be a substring of the full expected value and is NOT case-sensitive.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

VerifyCellTextFind
RJ TC
( )

T, JavaWin, JTable, VerifyCellTextFind, "10/09/2003", Variable, "Date","Time", "09:58 AM", "Change","Change #2","Revision", "2"

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field 6 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 7 :Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 8 :ColN
A 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 9 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

VerifyColumnLabel
RJ TC
( )

T, JavaWin, JTable, VerifyColumnLabel, "Foo", "4"

T, JavaWin, JTable, VerifyColumnLabel, "Foo SecondFoo", "4"

Field 5 :ColLabel
The case-insensitive expected value for the specified column label.

Field 6 :ColNumber
The 1-based column number of the label that needs verified.

VerifyFuzzyCellText
RC RJ TC
( )

T, JavaWin, JTable, VerifyFuzzyCellText, FirstCellValue

T, JavaWin, JTable, VerifyFuzzyCellText, "FirstCellValue", 1 , 1

T, JavaWin, JTable, VerifyFuzzyCellText, ABenchValue, 4, "field5"

T, JavaWin, JTable, VerifyFuzzyCellText, ^ABenchValue, "datum", 5

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

VerifyFuzzyCellTextContains
RC RJ TC
( )

T, JavaWin, JTable, VerifyFuzzyCellTextContains, FirstCellValue

T, JavaWin, JTable, VerifyFuzzyCellTextContains, "firstcell", 1 , 1

T, JavaWin, JTable, VerifyFuzzyCellTextContains, bench, 4, "field5"

T, JavaWin, JTable, VerifyFuzzyCellText, bench, "datum", 5

Field 5 :BenchValue
The expected value for the specified cell.
The value can be a substring of the full expected value and is NOT case-sensitive.

Field [6]:Row
The 1-based cell row # in the row/col specification or a unique row value in column 1.
The routine will first attempt to match any provided value with a cell value in column 1. If no match is found, it will expect the value to be a valid 1-based row number. This command allows for case-insensitive substring matches for row text when used in place of an actual row index.

Field [7]:Col
The 1-based cell column # in the row/col specification or column header text.
The routine will first attempt to match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This command allows for case-insensitive substring matches for header text when used in place of an actual column index.

VerifyFuzzyCellTextFind
RJ TC
( )

T, JavaWin, JTable, VerifyFuzzyCellTextFind, "10/09/2003", Variable, "Da","Ti", "09:58 AM", "Cha","Change #2","Rev", "2"

Field 5 :BenchValue
The case-sensitive expected value for the specified cell.

Field 6 :Var
The variable which gets assigned the row found.
The variable which gets assigned the row found. If not found then it will get a zero length string

Field 7 :Col
The 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number.

Field 8 :ColN
A 1-based cell column # in the row/col specification or fuzzy column header text.
The routine will first attempt to fuzzy-match any provided value with a field header. If no match is found, it will expect the value to be a valid 1-based column number. This must be accompanied by the next parameter, 'ValueN', and as many of the ColN/ValueN parameter pairs can be supplied as desired in order to match for a row based on cell contents.

Field 9 :ValueN
A Value to search for in a cell under the 'ColN' column
A Value to search for in a cell under the 'ColN' column

JavaTreeFunctions

JavaTreeFunctions Documentation.

CaptureTreeDataToFile
RC RJ
( )

T, Browser, aTreeView, CaptureTreeDataToFile, aFilename.ext

T, Browser, aJavaTree, CaptureTreeDataToFile, myDirectory\aFilename.ext, "Parent Bank->Branch Banking and Trust", "_"

T, Browser, aTreeView, CaptureTreeDataToFile, aFilename.ext, , , "UTF-8"

Field 5 :File
The name of the file used to store the tree data.
The name of the file used to store the tree data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:Branch
The full name of the tree branch to capture.
The full name of the tree branch to capture. If omitted, all branches/nodes are captured.

The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'PartialMatchTreeDataToFile' if you wish to specify case-insensitive substring matches for tree nodes.

Field [7]:IndentMark
The character(s) to use in the output file to indent the tree nodes from the parent tree branches.
The character(s) to use in the output file to indent the tree nodes from the parent tree branches. If omitted, a tab character is used.

Field [8]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [9]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [10]:FilterOptions
(Future) Specify filter options to use with the file filter.

ClickTextNode
RC RJ
( )

T, WINDOW, AJTree, ClickTextNode, "Parent"

T, WINDOW, AJTree, ClickTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to click.
TextValue is the case-sensitive text of the node to click. Parent-Child relationships are separated by "->"

ClickUnverifiedTextNode
RC RJ
( )

T, WINDOW, AJTree, ClickUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, ClickUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to click.
TextValue is the case-sensitive text of the node to click. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes then they must be provided.

Collapse
RC RJ
( )

T, WINDOW, AJTree, Collapse, "Parent"

T, WINDOW, AJTree, Collapse, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to collapse
TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->"

CollapsePartialTextNode
RC RJ
( )

T, WINDOW, AJTree, CollapsePartialTextNode, "Parent"

T, WINDOW, AJTree, CollapsePartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to collapse
TextValue is the case-insensitive text of the node to collapse. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

CollapseTextNode
RC RJ
( )

T, WINDOW, AJTree, CollapseTextNode, "Parent"

T, WINDOW, AJTree, CollapseTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to collapse
TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->"

CollapseUnverifiedTextNode
RC RJ
( )

T, WINDOW, AJTree, CollapseUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, CollapseUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to collapse
TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

CtrlClickUnverifiedTextNode
RJ
( )

T, WINDOW, AJTree, CtrlClickUnverifiedTextNode, "Parent"

T, WINDOW, AJTree, CtrlClickUnverifiedTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to CTRL-click.
TextValue is the case-sensitive text of the node to CTRL-click. Parent-Child relationships are separated by "->"

DoubleClickTextNode
RC RJ
( )

T, WINDOW, AJTree, DoubleClickTextNode, "Parent"

T, WINDOW, AJTree, DoubleClickTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to double-click.
TextValue is the case-sensitive text of the node to double-click. Parent-Child relationships are separated by "->"

DoubleClickUnverifiedTextNode
RC RJ
( )

T, WINDOW, AJTree, DoubleClickUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, DoubleClickUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to double-click.
TextValue is the case-sensitive text of the node to double-click. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes then they must be provided.

Expand
RC RJ
( )

T, WINDOW, AJTree, Expand, "Parent"

T, WINDOW, AJTree, Expand, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to expand
TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->"

ExpandPartialTextNode
RC RJ
( )

T, WINDOW, AJTree, ExpandPartialTextNode, "parent"

T, WINDOW, AJTree, ExpandPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to match.
TextValue is the case-insensitive text of the node. Parent-Child relationships are separated by "->". For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

ExpandTextNode
RC RJ
( )

T, WINDOW, AJTree, ExpandTextNode, "Parent"

T, WINDOW, AJTree, ExpandTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to expand
TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->"

ExpandUnverifiedTextNode
RC RJ
( )

T, WINDOW, AJTree, ExpandUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, ExpandUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to expand
TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->". If the tree contains hidden root nodes the user must provide these.

MakeSelection
RC RJ
( )

T, WINDOW, AJTree, MakeSelection, "Parent"

T, WINDOW, AJTree, MakeSelection, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to select
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

PartialMatchTreeDataToFile
RC RJ
( )

T, Browser, aTreeView, PartialMatchTreeDataToFile, aFilename.ext

T, Browser, aJavaTree, PartialMatchTreeDataToFile, myDirectory\aFilename.ext, "parent->branch", "_"

Field 5 :File
The name of the file used to store the tree data.
The name of the file used to store the tree data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:Branch
The full name of the tree branch to capture.
The full name of the tree branch to capture. If omitted, all branches/nodes are captured.

The search of the path to the node is a case-insensitive substring match of each node. Use 'CaptureTreeDataToFile' if you wish to specify case-sensitive exact matches for tree nodes.

Field [7]:IndentMark
The character(s) to use in the output file to indent the tree nodes from the parent tree branches.
The character(s) to use in the output file to indent the tree nodes from the parent tree branches. If omitted, a tab character is used.

Field [8]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [9]:FilterOptions
(Future) Specify filter options to use with the file filter.

RightClickTextNode
RC RJ
( )

T, WINDOW, AJTree, RightClickTextNode, "Parent"

T, WINDOW, AJTree, RightClickTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to right-click.
TextValue is the case-sensitive text of the node to right-click. Parent-Child relationships are separated by "->"

RightClickUnverifiedTextNode
RC RJ
( )

T, WINDOW, AJTree, RightClickUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, RightClickUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to right-click.
TextValue is the case-sensitive text of the node to right-click. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes then they must be provided.

SelectAnotherPartialTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectAnotherPartialTextNode, "parent"

T, WINDOW, AJTree, SelectAnotherPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to select.
TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

SelectAnotherTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectAnotherTextNode, "Parent"

T, WINDOW, AJTree, SelectAnotherTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

SelectAnotherUnverifiedTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectAnotherUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, SelectAnotherUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

SelectPartialTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectPartialTextNode, "parent"

T, WINDOW, AJTree, SelectPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to select.
TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

SelectTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectTextNode, "Parent"

T, WINDOW, AJTree, SelectTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

SelectUnverifiedTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, SelectUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

SetTreeContainsNode
RC RJ
( )

T, Browser, aTreeView, SetTreeContainsNode, "Parent Bank->Branch Banking and Trust", isFound

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'SetTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.

Field 6 :ResultVar
The name of the variable which gets assigned the result.
The value of 'TRUE' indicates the node was found in the tree, and 'FALSE' indicates that the node was not found in the tree.

SetTreeContainsPartialMatch
RC RJ
( )

T, Browser, aTreeView, VerifyTreeContainsNode, "parent->branch", isFound

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'SetTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.

Field 6 :ResultVar
The name of the variable which gets assigned the result.
The value of 'TRUE' indicates the node was found in the tree, and 'FALSE' indicates that the node was not found in the tree.

ShiftClickUnverifiedTextNode
RJ
( )

T, WINDOW, AJTree, ShiftClickUnverifiedTextNode, "Parent"

T, WINDOW, AJTree, ShiftClickUnverifiedTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to SHIFT-click.
TextValue is the case-sensitive text of the node to SHIFT-click. Parent-Child relationships are separated by "->"

VerifyTreeContainsNode
RC RJ
( )

T, Browser, aTreeView, VerifyTreeContainsNode, "Parent Bank->Branch Banking and Trust"

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'VerifyTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.

VerifyTreeContainsPartialMatch
RC RJ
( )

T, Browser, aTreeView, VerifyTreeContainsNode, "parent->branch"

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'VerifyTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.

LabelFunctions

LabelFunctions Documentation.

Click
WR
( )

T, AWindow, ALabel, CLICK

ListBoxFunctions

ListBoxFunctions Documentation.

ActivatePartialMatch
RC RJ WR SE
( )

T, WINDOW, ListBox, ActivatePartialMatch , "ATextSubstring"

Field 5 :TextValue
Case-sensitive substring of node to DblClick and verify.
TextValue should contain the case-sensitive substring to DblClick and verify.

ActivateTextItem
RC RJ WR SE
( )

T, WINDOW, ListBox, ActivateTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to DblClick and verify.
TextValue should contain the case-sensitive text item to DblClick and verify.

ActivateUnverifiedPartialMatch
RC RJ SE
( )

T, WINDOW, ListBox, ActivateUnverifiedPartialMatch , "ATextSubstring"

Field 5 :TextValue
Case-sensitive substring of node to DblClick.
TextValue should contain the case-sensitive substring to DblClick.

ActivateUnverifiedTextItem
RC RJ SE
( )

T, WINDOW, ListBox, ActivateUnverifiedTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to DblClick.
TextValue should contain the case-sensitive text item to DblClick.
No check is performed after the selection to verify success. This is typically done for cases when the listbox is only temporary in nature and disappears immediately upon a selection.

CaptureItemsToFile
RJ
( )

T, WINDOW, ListBox, CaptureItemsToFile , afile.txt

T, WINDOW, ListBox, CaptureItemsToFile , afile.txt, "UTF-8"

Field 5 :FileName
File name (if not absolute, then to test dir)
File name (if not absolute, then to test dir)

Field [6]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

ClickColumnIndex
RJ
( )

T, WINDOW, ListBox, ClickColumnIndex , 1

Field 5 :Index
Index of the column header to click, starting from 1
Index of the column header to click, starting from 1

ClickColumnLabel
RJ
( )

T, WINDOW, ListBox, ClickColumnLabel , "Product"

Field 5 :Label
Label of the column header to click
Label of the column header to click

ClickTextItem
RJ
( )

T, WINDOW, ListBox, ClickTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue should contain the case-sensitive text item to select.

ExtendSelectionToTextItem
RJ
( )

T, WINDOW, ListBox, ExtendSelectionToTextItem, "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to select and verify.

RightClickTextItem
RJ
( )

T, WINDOW, ListBox, RightClickTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to right-click on.
TextValue should contain the case-sensitive text item to right-click.

SelectAnotherTextItem
RC RJ SE
( )

T, WINDOW, ListBox, SelectAnotherTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to select and verify.

SelectAnotherUnverifiedTextItem
RC RJ SE
( )

T, WINDOW, ListBox, SelectAnotherUnverifiedTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to select.

SelectIndex
RJ SE
( )

T, WINDOW, ListBox, SelectIndex , 1

Field 5 :Index
Index of the text item to select, starting from 1
Index of the text item to select, starting from 1

SelectPartialMatch
RC RJ WR SE
( )

T, WINDOW, ListBox, SelectPartialMatch , "ATextSubstring"

Field 5 :TextValue
Case-sensitive substring of node to select and verify.
TextValue should contain the case-sensitive substring to select and verify.

SelectTextItem
RC RJ WR SE
( )

T, WINDOW, ListBox, SelectTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to select and verify.
TextValue should contain the case-sensitive text item to select and verify.

SelectUnverifiedAnotherTextItem
RC
( )

T, WINDOW, ListBox, SelectUnverifiedAnotherTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to select.

SelectUnverifiedPartialMatch
RC RJ SE
( )

T, WINDOW, ListBox, SelectUnverifiedPartialMatch , "ATextSubstring"

Field 5 :TextValue
Case-sensitive substring of node to select.
TextValue should contain the case-sensitive substring to select.

SelectUnverifiedTextItem
RC RJ SE
( )

T, WINDOW, ListBox, SelectUnverifiedTextItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue should contain the case-sensitive text item to select.
No check is performed after the selection to verify success. This is typically done for cases when the listbox is only temporary in nature and disappears immediately upon a selection.

SetListContains
RJ
( )

T, WINDOW, ListView, SetListContains , "AParticularServerName", isFound

Field 5 :ItemText
The case-sensitive name of the sought item.
ItemText should contain the case-sensitive text item to find in the list view. A message is sent to the log confirming whether or not the item is found in the list view.

Field 6 :ResultVar
The name of the variable receiving the result.
This variable is set with 'TRUE' if the item is found or 'FALSE' if the item is not found.

VerifyItem
RJ
( )

T, WINDOW, ListBox, VerifyItem, 1, "ATextString"

T, WINDOW, ListBox, VerifyItem, 10, "ATextString10"

Field 5 :Index
Index of the item in the list starting from 1
Index of the item in the list starting from 1

Field 6 :TextValue
Case-sensitive string to compare to the text of the node at the index.
Case-sensitive string to compare to the text of the node at the index.

VerifyItemUnselected
RC RJ WR SE
( )

T, WINDOW, ListBox, VerifyItemUnselected, "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node that will be verified as unselected
TextValue should contain the case-sensitive text of the item that is expected to NOT be selected.

VerifyListContains
RC RJ WR SE
( )

T, WINDOW, ListBox, VerifyListContains, "ATextString", "True"

T, WINDOW, ListBox, VerifyListContains, "ATextString", "Case-Sensitive"

T, WINDOW, ListBox, VerifyListContains, "ATextString10", "False"

T, WINDOW, ListBox, VerifyListContains, "ATextString10"

Field 5 :TextValue
String to look for in the list.
String to look for in the list.

Field [6]:CaseSensitive
Optional "True" for case-sensitive search
Optional "True" for case-sensitive search.
Robot (others?) also supports "CASE-SENSITIVE" in place of "TRUE" for this parameter.

VerifyListContainsPartialMatch
RC RJ SE
( )

T, WINDOW, ListBox, VerifyListContainsPartialMatch, "Text", "True"

T, WINDOW, ListBox, VerifyListContainsPartialMatch, "Text", "Case-Sensitive"

T, WINDOW, ListBox, VerifyListContainsPartialMatch, "Text", "False"

T, WINDOW, ListBox, VerifyListContainsPartialMatch, "Text"

Field 5 :TextValue
SubString to look for in the list.
SubString to look for in the list.

Field [6]:CaseSensitive
Optional "True" for case-sensitive search
Optional "True" for case-sensitive search.
Robot (others?) also supports "CASE-SENSITIVE" in place of "TRUE" for this parameter.

VerifyListDoesNotContain
RC RJ WR SE
( )

T, WINDOW, ListBox, VerifyListDoesNotContain, "ATextString", "True"

T, WINDOW, ListBox, VerifyListDoesNotContain, "ATextString", "Case-Sensitive"

T, WINDOW, ListBox, VerifyListDoesNotContain, "ATextString10", "False"

T, WINDOW, ListBox, VerifyListDoesNotContain, "ATextString10"

Field 5 :TextValue
String to look for in the list.
String to look for in the list.

Field [6]:CaseSensitive
Optional "True" for case-sensitive search
Optional "True" for case-sensitive search. Robot also supports the literal string "CASE-SENSITIVE" instead of "TRUE".

VerifyListDoesNotContainPartialMatch
RC RJ SE
( )

T, WINDOW, ListBox, VerifyListDoesNotContainPartialMatch, "Text", "True"

T, WINDOW, ListBox, VerifyListDoesNotContainPartialMatch, "String", "Case-Sensitive"

T, WINDOW, ListBox, VerifyListDoesNotContainPartialMatch, "String", "False"

T, WINDOW, ListBox, VerifyListDoesNotContainPartialMatch, "Text"

Field 5 :TextValue
SubString to look for in the list.
SubString to look for in the list.

Field [6]:CaseSensitive
Optional "True" for case-sensitive search
Optional "True" for case-sensitive search. Robot also supports the literal string "CASE-SENSITIVE" instead of "TRUE".

VerifyMenuItem
RJ
( )

T, WINDOW, ListBox, VerifyMenuItem, "ATextString"

T, WINDOW, ListBox, VerifyMenuItem, "ATextString10"

Field 5 :TextValue
Case-sensitive string to compare to the text of any node in the list.
Case-sensitive string to compare to the text of any node in the list.

VerifyMenuPartialMatch
RJ
( )

T, WINDOW, ListBox, VerifyMenuPartialMatch, "ATextString"

T, WINDOW, ListBox, VerifyMenuPartialMatch, "10"

Field 5 :TextValue
Case-insensitive substring to compare to the text of any node in the list.
Case-insensitive substring to compare to the text of any node in the list.

VerifyPartialMatch
RJ
( )

T, WINDOW, ListBox, VerifyPartialMatch, 1, "AText"

T, WINDOW, ListBox, VerifyItem, 10, "10"

Field 5 :Index
Index of the item in the list starting from 1
Index of the item in the list starting from 1

Field 6 :TextValue
Case-insensitive substring to compare to the text of the node at the index.
Case-insensitive substring to compare to the text of the node at the index.

VerifySelectedItem
RC RJ WR SE
( )

T, WINDOW, ListBox, VerifySelectedItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node that will be verified as selected
TextValue should contain the case-sensitive text of the item expected to already be selected

VerifySelectedPartialMatch
RC RJ WR SE
( )

T, WINDOW, ListBox, VerifySelectedPartialMatch , "ATextSubstring"

Field 5 :TextValue
Case-sensitive substring of node that will be verified selected
TextValue should contain the case-sensitive substring of the item expected to already be selected

ListViewFunctions

ListViewFunctions Documentation.

ActivateIndex
DRD SE2
( )

T, WINDOW, ListBox, ActivateIndex , 3

Field 5 :Index
Index of the text item to select
It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

ActivateIndexItem
DRD SE2
( )

T, WINDOW, ListView, ActivateIndexItem , 3

Field 5 :IndexValue
Index of item to activate.
It is important to note that some ListViews index their values differently. For example, you may need to select an item by text by using a property whose starting index is 1. Yet, if you request to seek an item strictly by index, the starting index is 0. So, the test developer may need to evaluate their ListView object for these differences.

ActivatePartialMatch
TC DRD SE2
( )

T, WINDOW, ListView, ActivatePartialMatch, "ATextSubstring"

T, WINDOW, ListView, ActivatePartialMatch , "ATextSubstring", "Index=2"

Field 5 :PartialTextValue
Case-sensitive substring of text item to select
PartialTextValue should be a case-sensitive substring of text item to select.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

ActivateTextItem
RC WR TC DRD SE2
( )

T, WINDOW, ListView, ActivateTextItem , "AParticularUserID"

T, WINDOW, ListView, ActivateTextItem , "AParticularUserID", "Index=2"

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to select.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

ActivateTextItemCoords
RC SE2
( )

T WINDOW MyList ActivateTextItemCoords "AParticularUserID" "5,20"

T WINDOW MyList ActivateTextItemCoords "AParticularUserID" "5,20" "Index=3"

T WINDOW MyList ActivateTextItemCoords "AParticularUserID" "Coords=5,20"

T WINDOW MyList ActivateTextItemCoords "AParticularUserID" CENTER

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to select.

Field 6 :Coords
The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyListView]
Center=5,120 OR
Center=Coords=5,120

The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Field [7]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

ActivateUnverifiedTextItem
RC TC DRD SE2
( )

T, WINDOW, ListView, ActivateUnverifiedTextItem , "AParticularUserID"

T, WINDOW, ListView, ActivateUnverifiedTextItem , "AParticularUserID", "Index=3"

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to select. The selection will not be verified.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

ActivateUnverifiedTextItemCoords
RC SE2
( )

T WINDOW MyList ActivateUnverifiedTextItemCoords "AParticularUserID" "5,20"

T WINDOW MyList ActivateUnverifiedTextItemCoords "AParticularUserID" "5,20" "Index=2"

T WINDOW MyList ActivateUnverifiedTextItemCoords "AParticularUserID" "Coords=5,20"

T WINDOW MyList ActivateUnverifiedTextItemCoords "AParticularUserID" CENTER

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to select.

Field 6 :Coords
The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyListView]
Center=5,120 OR
Center=Coords=5,120

The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Field [7]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

AssignCellValue
RC
( )

T WINDOW MyList AssignCellValue "^variablename" 2 3

Field 5 :Varibale
Name of variable to assign value
The variable name that should be used to hold the value retrieved by this command.

Field 6 :RowCoord
The coordinate of the row in the listview that you want to capture the value.
We will capture the row, column value in the listview and assign it to the variable value. First you identify the row and then the column.

Field 7 :ColCoord
The coordinate of the column in the listview that you want to capture the value.
We will capture the row, column value in the listview and assign it to the variable value. First you identify the row and then the column.

CaptureItemsToFile
DRD TC SE2
( )

T, WINDOW, ListBox, CaptureItemsToFile , afile.txt

T, WINDOW, ListBox, CaptureItemsToFile , afile.txt, "UTF-8"

Field 5 :FileName
File name (if not absolute, then to test dir)
File name (if not absolute, then to test dir)

Field [6]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

ClickIndex
DRD SE2
( )

T, WINDOW, ListBox, ClickIndex , 3

Field 5 :Index
See ListView ActivateIndexItem

ClickIndexItem
DRD SE2
( )

T, WINDOW, ListBox, ClickIndexItem , 3

Field 5 :Index
See ListView ActivateIndexItem

ExtendSelectionToTextItem
TC SE2
( )

T, WINDOW, ListView, ExtendSelectionToTextItem, "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node to select and verify.

RightClickTextItem
RC TC SE2
( )

T, WINDOW, ListView, RightClickTextItem , "AParticularUserID"

T, WINDOW, ListView, RightClickTextItem , "AParticularUserID", "Index=2"

Field 5 :SelectTextValue
Case-sensitive text of node to RightClick
SelectTextValue should contain the case-sensitive text item to RightClick.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

RightClickTextItemCoords
RC SE2
( )

T WINDOW MyList RightClickTextItemCoords "AParticularUserID" "5,20"

T WINDOW MyList RightClickTextItemCoords "AParticularUserID" "5,20" "Index=2"

T WINDOW MyList RightClickTextItemCoords "AParticularUserID" "Coords=5,20"

T WINDOW MyList RightClickTextItemCoords "AParticularUserID" CENTER

Field 5 :SelectTextValue
Case-sensitive text of node to RightClick
SelectTextValue should contain the case-sensitive text item to RightClick.

Field 6 :Coords
The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyListView]
Center=5,120 OR
Center=Coords=5,120

The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Field [7]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

RightClickUnverifiedTextItem
RC
( )

T, WINDOW, ListView, RightClickUnverifiedTextItem , "AParticularUserID"

T, WINDOW, ListView, RightClickUnverifiedTextItem , "AParticularUserID", "Index=3"

Field 5 :SelectTextValue
Case-sensitive text of node to RightClick
SelectTextValue should contain the case-sensitive text item to RightClick. The selection will not be verified.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

RightClickUnverifiedTextItemCoords
RC
( )

T WINDOW MyList RightClickUnverifiedTextItemCoords "AParticularUserID" "5,20"

T WINDOW MyList RightClickUnverifiedTextItemCoords "AParticularUserID" "5,20" "Index=3"

T WINDOW MyList RightClickUnverifiedTextItemCoords "AParticularUserID" "Coords=5,20"

T WINDOW MyList RightClickUnverifiedTextItemCoords "AParticularUserID" CENTER

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to RightClick.

Field 6 :Coords
The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyListView]
Center=5,120 OR
Center=Coords=5,120

Field [7]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

SelectAnotherPartialMatch
TC SE2
( )

T, WINDOW, ListView, SelectAnotherPartialMatch, "ASubstring"

T, WINDOW, ListView, SelectAnotherPartialMatch, "ASubstring", "Index=2"

Field 5 :PartialTextValue
Case-sensitive substring of text item to select.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

SelectAnotherTextItem
TC SE2
( )

T, WINDOW, ListView, SelectAnotherTextItem , "AParticularUserID"

T, WINDOW, ListView, SelectAnotherTextItem , "AParticularUserID", "Index=2"

Field 5 :TextValue
Case-sensitive text of node to select.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

SelectIndex
DRD SE2
( )

T, WINDOW, ListBox, SelectIndex , 3

Field 5 :Index
See ListView SelectIndexItem

SelectIndexItem
RC WR TC DRD SE2
( )

T, WINDOW, ListView, SelectIndexItem , 4

Field 5 :ItemIndex
Index of node to select.

SelectIndexItemCoords
RC SE2
( )

T WINDOW MyList SelectIndexItemCoords "2" "5,20"

T WINDOW MyList SelectIndexItemCoords "2" "Coords=5,20"

T WINDOW MyList SelectIndexItemCoords "2" "Center"

Field 5 :ItemIndex
Index of node to select.

Field 6 :Coords
The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyListView]
Center=5,120 OR
Center=Coords=5,120

SelectPartialMatch
TC DRD SE2
( )

T, WINDOW, ListView, SelectPartialMatch , "APartialString"

T, WINDOW, ListView, SelectPartialMatch , "APartialString", "Index=2"

Field 5 :PartialTextValue
Case-sensitive substring of node to select
PartialTextValue should be a case-sensitive substring of text item to select.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

SelectRandomItems
RC WR
( )

T, WINDOW, ListView, SelectRandomItems , "3"

Field 5 :ItemCount
The quantity of items to randomly select in the object.

SelectTextItem
RC WR TC DRD SE2
( )

T, WINDOW, ListView, SelectTextItem , "AParticularUserID"

T, WINDOW, ListView, SelectTextItem , "AParticularUserID", "Index=2"

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to select.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

SelectTextItemCoords
RC SE2
( )

T WINDOW MyList SelectTextItemCoords "AParticularUserID" "5,20"

T WINDOW MyList SelectTextItemCoords "AParticularUserID" "5,20" "Index=2"

T WINDOW MyList SelectTextItemCoords "AParticularUserID" "Coords=5,20"

T WINDOW MyList SelectTextItemCoords "AParticularUserID" CENTER

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to select.

Field 6 :Coords
The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyListView]
Center=5,120 OR
Center=Coords=5,120

The results from the lookup are appended to the "Coords=" string used by the Click command in Robot (if necessary).

Both Fields #3(component name) and #6(coords reference name) are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

Field [7]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

SelectUnverifiedTextItem
RC TC DRD SE2
( )

T, WINDOW, ListView, SelectUnverifiedTextItem , "AParticularUserID"

T, WINDOW, ListView, SelectUnverifiedTextItem , "AParticularUserID", "Index=3"

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to select. The selection will not be verified.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

SelectUnverifiedTextItemCoords
RC SE2
( )

T WINDOW MyList SelectUnverifiedTextItemCoords "AParticularUserID" "5,20"

T WINDOW MyList SelectUnverifiedTextItemCoords "AParticularUserID" "5,20" "Index=3"

T WINDOW MyList SelectUnverifiedTextItemCoords "AParticularUserID" "Coords=5,20"

T WINDOW MyList SelectUnverifiedTextItemCoords "AParticularUserID" CENTER

Field 5 :SelectTextValue
Case-sensitive text of node to select
SelectTextValue should contain the case-sensitive text item to select.

Field 6 :Coords
The explicit coordinates ("x,y") or an App Map reference to pre-defined coordinates.
We first check to see if the field contains a reference to an App Map item. If that cannot be found, we will assume the field contains explicit coordinates.
We expect the coordinates in the format "x,y":

[MyListView]
Center=5,120 OR
Center=Coords=5,120

Field [7]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

SetListContains
RC TC SE2
( )

T, WINDOW, ListView, SetListContains , "AParticularServerName", isFound

Field 5 :ItemText
The case-sensitive name of the sought item.
ItemText should contain the case-sensitive text item to find in the list view. A message is sent to the log confirming whether or not the item is found in the list view.

Field 6 :ResultVar
The name of the variable receiving the result.
This variable is set with 'TRUE' if the item is found or 'FALSE' if the item is not found.

VerifyItemUnselected
RC WR TC SE2
( )

T, WINDOW, ListView, VerifyItemUnselected, "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node that will be verified unselected
TextValue should contain the case-sensitive text of the item that is expected NOT to be selected.

VerifyListContains
RC TC SE2
( )

T, WINDOW, ListView, VerifyListContains , "AParticularServerName"

Field 5 :ItemText
The case-sensitive name of the item to verify.
ItemText should contain the case-sensitive text item to find in the list view. A message is sent to the log confirming whether or not the item is found in the list view.

VerifySelectedItem
RC WR TC SE2
( )

T, WINDOW, ListView, VerifySelectedItem , "AParticularUserID"

Field 5 :TextValue
Case-sensitive text of node that will be verified selected
TextValue should contain the case-sensitive text of the item expected to already be selected

PopupMenuFunctions

PopupMenuFunctions Documentation.

SelectPopupMenuID
RC
( )

T, Anything, AtAll, SelectPopupMenuID, 1001

Field 5 :MenuItemID
The Windows menuID of the menuItem to select.

SelectPopupMenuItem
RC RJ TC
( )

T, Anything, AtAll, SelectPopupMenuItem, "File->Save Ctrl+S"

T, Anything, AtAll, SelectPopupMenuItem, "&File->&Save Ctrl+S"

T, ParentWindow, popupMenu, SelectPopupMenuItem, "File->Save"

T, ParentWindow, popupFileMenu, SelectPopupMenuItem, "Save"

T, ParentWindow, popupSaveMenu, SelectPopupMenuItem

Field 5 :MenuItemText
Menu->MenuItem hierarchy to the menuItem to select.
Menu->MenuItem hierarchy string to identify which menuitem to select.
NOTE:SQA can only handle submenus up to 5 levels deep.
NOTE:For RJ implementation, this field is optional if the "child" is a "MenuItem"

SelectUnverifiedPopupMenuItem
RC RJ TC
( )

T, Anything, AtAll, SelectUnverifiedPopupMenuItem, "File->Save Ctrl+S"

T, Anything, AtAll, SelectUnverifiedPopupMenuItem, "&File->&Save Ctrl+S"

T, ParentWindow, popupMenu, SelectUnverifiedPopupMenuItem, "File->Save"

T, ParentWindow, popupFileMenu, SelectUnverifiedPopupMenuItem, "Save"

Field 5 :MenuItemText
Menu->MenuItem hierarchy to the menuItem to select.
Menu->MenuItem hierarchy string to identify which menuitem to select.
NOTE:SQA can only handle submenus up to 5 levels deep.

VerifyPopupMenu
RC RJ
( , F )

T, Anything, AtAll, VerifyPopupMenu, BenchFile.ext

T, Anything, AtAll, VerifyPopupMenu, BenchFile.ext, "Normal App State Menu"

T, Anything, AtAll, VerifyPopupMenu, BenchFile.ext, "", TestFile.ext, DiffFile.ext

Field 5 :BenchmarkFile
The name.ext of the file used as the comparison benchmark.
The name.ext of the file used as the comparison benchmark.
Typically, benchmarks are stored in the Datapool\Bench directory. In that event, only the filename.ext is needed. Otherwise, the full file path is needed.

Field [6]:HeaderText
Optional descriptive header line of text to match with the benchmark.
Optional header line of text to match with the benchmark.
If the benchmark file was created with or contains an initial line of descriptive text then that line must be provided here for the comparison to be successful.

Field [7]:ActualFile
The optional name.ext of the file used for the captured menu status.
The optional name.ext of the file used for the captured menu status.
Typically, actuals are stored in the Datapool\Test directory with the same name as the benchmark file. Thus, you would normally leave this blank.

Field [8]:DiffFile
The optional name.ext of the file used to contain the differences found.
The optional name.ext of the file used to contain the differences found.
Typically, diffs are stored in the Datapool\Dif directory with the same name as the benchmark file. Thus, you would normally leave this blank.

VerifyPopupMenuID
RC
( , F )

T, Anything, AtAll, VerifyPopupMenuID, 1001, "Enabled Menu With 7 MenuItems"

T, Anything, AtAll, VerifyPopupMenuID, 10400, "Disabled Unchecked"

Field 5 :MenuItemID
The Windows menuID of the menuItem to verify.

Field 6 :StateInfo
Expected status string (or part thereof) to verify.
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 (listed below) currently ARE case-sensitive.
"Enabled" "Grayed" "BarBreak" "Bitmap" "Disabled" "Ungrayed" "Separator" "Break" "Checked" "Hilited" "Default" "Menu With N MenuItems" "Unchecked" "Unhilited" "Normal" (not default)

VerifyPopupMenuItem
RC RJ
( , F )

T, Anything, AtAll, VerifyPopupMenuItem, "File", "Enabled Menu With 7 MenuItems"

T, Anything, AtAll, VerifyPopupMenuItem, "&View->&Toolbars->P&aint", "Disabled Unchecked"

T, parentWindow, popupMenu, VerifyPopupMenuItem, "Weird->CheckBox", "Enabled"

T, parentWindow, popupWeirdMenu, VerifyPopupMenuItem, "CheckBox", "Enabled Unchecked"

Field 5 :MenuItemText
Menu->MenuItem hierarchy to the menuItem to verify.
Menu->MenuItem hierarchy string to identify which menuitem to verify.
NOTE:SQA can only handle submenus up to 5 levels deep.
For RC and Win32 popups: The Window and Component references are not used and can be anything. They just cannot be blank.

For Java popups: Valid recognition information for the Java window and "child" popup menu must be provided.

Also refer to JavaMenuFunctions for support specific to Java menus and popup menus.

Field 6 :StateInfo
Expected status string (or part thereof) to verify.

Note: this parameter is partial supported for RJ.

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 (listed below) currently ARE case-sensitive.

"Enabled" "Grayed" "BarBreak" "Bitmap" "Disabled" "Ungrayed" "Separator" "Break" "Checked" "Hilited" "Default" "Menu With N MenuItems" "Unchecked" "Unhilited" "Normal" (not default)

"Enabled" "Grayed" "Bitmap" "Disabled" "Ungrayed" "Separator" "Checked" "Unchecked" "Menu With N MenuItems" are supported by RJ.

VerifyPopupMenuPartialMatch
RJ
( , F )

T, ParentWindow, popupMenu, VerifyPopupMenuPartialMatch, "Fil->Ope"

Field 5 :MenuItemText
Menu->MenuItem hierarchy substring to the menuItem to search for.
Menu->MenuItem hierarchy substring to identify which menuitem to search for.

For Java popups: Valid recognition information for the Java window and "child" popup menu must be provided.

Also refer to JavaMenuFunctions for support specific to Java menus and popup menus.

ProgressBarFunctions

ProgressBarFunctions Documentation.

GetProgress
DRD
( )

T, WINDOW, ProgressBar, GetProgress, currentPrimaryProgress

T, WINDOW, ProgressBar, GetProgress, currentSecondaryProgress, False

Field 5 :VariableName
The variable VariableName will contain the progress of progress bar in percentage.
The variable VariableName will contain the progress of progress bar in percentage. If the current progress is 52%, this variable will be set to "52%".

Field [6]:IsPrimary
IsPrimary is boolean value (default is true). It indicates which indicator to get.
IsPrimary is boolean value (default is true). It indicates which indicator to get. Android progress bar has 2 indicators, primary and secondary. If it is True or Yes, the primary indicator's progress will be got; otherwise the secondary's will be got.

GetRating
DRD
( )

T, WINDOW, RatingBar, GetRating, currentRating

Field 5 :VariableName
The variable VariableName will contain the rating of rating bar.
The variable VariableName will contain the rating of rating bar. It will contain a float number which represents the rating (number of stars filled). If 5 stars are filled, then this variable will contain 5.0

SetProgress
DRD
( )

T, WINDOW, ProgressBar, SetProgress, "0.35"

T, WINDOW, ProgressBar, SetProgress, "59%", False

Field 5 :ProgressValue
ProgressValue to set.
ProgressValue to set. It can be a number between 0 and 1, or a percentage number like 52%.

Field [6]:IsPrimary
IsPrimary is boolean value (default is true). It indicates which indicator to set.
IsPrimary is boolean value (default is true). It indicates which indicator to set. Android progress bar has 2 indicators, primary and secondary. If it is True or Yes, the primary indicator will be set; otherwise the secondary will be set.

SetRating
DRD
( )

T, WINDOW, RatingBar, SetRating, "3.5"

Field 5 :RatingValue
RatingValue to set.
RatingValue to set. It is a float number which represents the rating (number of stars filled).

PushButtonFunctions

PushButtonFunctions Documentation.

Click
WR TC
( )

T, WINDOW, PushButton, CLICK

ClickButton
RC WR TC
( )

T, WINDOW, PushButton, CLICKBUTTON

RadioButtonFunctions

RadioButtonFunctions Documentation.

Click
WR TC
( )

T, WINDOW, RadioButton, CLICK

ScrollBarFunctions

ScrollBarFunctions Documentation.

OneDown
RC RJ WR TC DRD SE2
( )

T, WINDOW, ScrollBar, ONEDOWN

T, WINDOW, ScrollBar, ONEDOWN, 12

Field [5]:IntegerValue
Optional integer to specify how many times to perform the action.

OneLeft
RC RJ WR TC DRD SE2
( )

T, WINDOW, ScrollBar, ONELEFT

T, WINDOW, ScrollBar, ONELEFT, 12

Field [5]:IntegerValue
Optional integer to specify how many times to perform the action.

OneRight
RC RJ WR TC DRD SE2
( )

T, WINDOW, ScrollBar, ONERIGHT

T, WINDOW, ScrollBar, ONERIGHT, 12

Field [5]:IntegerValue
Optional integer to specify how many times to perform the action.

OneUp
RC RJ WR TC DRD SE2
( )

T, WINDOW, ScrollBar, ONEUP

T, WINDOW, ScrollBar, ONEUP, 12

Field [5]:IntegerValue
Optional integer to specify how many times to perform the action.

PageDown
RC RJ WR TC DRD SE2
( )

T, WINDOW, ScrollBar, PAGEDOWN

T, WINDOW, ScrollBar, PAGEDOWN, 12

Field [5]:IntegerValue
Optional integer to specify how many times to perform the action.

PageLeft
RC RJ WR TC DRD SE2
( )

T, WINDOW, ScrollBar, PAGELEFT

T, WINDOW, ScrollBar, PAGELEFT, 12

Field [5]:IntegerValue
Optional integer to specify how many times to perform the action.

PageRight
RC RJ WR TC DRD SE2
( )

T, WINDOW, ScrollBar, PAGERIGHT

T, WINDOW, ScrollBar, PAGERIGHT, 12

Field [5]:IntegerValue
Optional integer to specify how many times to perform the action.

PageUp
RC RJ WR TC DRD SE2
( )

T, WINDOW, ScrollBar, PAGEUP

T, WINDOW, ScrollBar, PAGEUP, 12

Field [5]:IntegerValue
Optional integer to specify how many times to perform the action.

SSTreeFunctions

SSTreeFunctions Documentation.

CollapseNode
RC WR
( )

T, WINDOW, DirectoryTree, COLLAPSENODE, MyNode

Field 5 :AppMapSubkey
The named reference of the coordinates to expand/collapse
The named reference of the coordinates to expand/collapse

ExpandNode
RC WR
( )

T, WINDOW, DirectoryTree, EXPANDNODE, MyNode

Field 5 :AppMapSubkey
The named reference of the coordinates to expand/collapse
The named reference of the coordinates to expand/collapse

SelectNode
RC WR
( )

T, WINDOW, DirectoryTree, SELECTNODE, MyNode

Field 5 :AppMapSubkey
The named reference of the coordinates to click
The named reference of the coordinates to click

VerifyExpandedState
RC WR
( )

T, WINDOW, DirectoryTree, VERIFYEXPANDEDSTATE, "My Node", "True"

Field 5 :TextValue
Case-sensitive text of the node to check.
Case-sensitive text of the node to check.

Field 6 :ExpectedState
Expected State: "True" or "False" (not case-sensitive)
Expected State: "True" or "False" (not case-sensitive)

VerifySelectedText
RC WR
( )

T, WINDOW, DirectoryTree, SELECTTEXTNODE, "My Node"

Field 5 :TextValue
Case-sensitive text expected in the selected node.
Case-sensitive text expected in the selected node.

TabControlFunctions

TabControlFunctions Documentation.

Click
WR
( )

T, WINDOW, TabControl, CLICK, "StatsTab"

Field 5 :TextValue
Case-sensitive text* on the tab to identify which tab to click.
TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

Field [6]:process
Indicator for unverified click.
When process=1, this indicates we are performing an unverified click.

ClickTab
RC RJ WR TC DRD SE2
( )

T, WINDOW, TabControl, CLICKTAB, "StatsTab"

Field 5 :TextValue
Case-sensitive text on the tab to identify which tab to click.
TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

ClickTabContains
RJ TC DRD SE2
( )

T, PropertiesWin, TabControl, ClickTabContains, "StatsTab"

Field 5 :TextValue
Partial case-sensitive text on the tab to identify which tab to click.
TextValue is the partial case-sensitive text on the tab to identify which tab to click.

MakeSelection
RC RJ WR TC DRD SE2
( )

T, WINDOW, TabControl, MAKESELECTION, "StatsTab"

Field 5 :TextValue
Case-sensitive text on the tab to identify which tab to click.
TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

SelectTab
RC RJ WR TC DRD SE2
( )

T, WINDOW, TabControl, SelectTab, "StatsTab"

Field 5 :TextValue
Case-sensitive text on the tab to identify which tab to click.
TextValue is the case-sensitive text on the tab to identify which tab to click. If the provided text value contains ampersands (for hotkey characters) then ampersands will be retained in the TabControl text for comparisons performed to identify the correct tab to click. Otherwise, ampersands are stripped out of the TabControl text to facilitate these comparisons.

SelectTabIndex
RC RJ TC DRD SE2
( )

T, WINDOW, TabControl, SelectTabIndex, 2

Field 5 :TabIndex
Index of the tab to click.
The index of the tab to click. The user needs to know whether the TabControl indices are 0-based or 1-based. SAFS for RFT attempts to allow the user to use 1-based indices for all controls.

UnverifiedClick
WR
( )

T, WINDOW, TabControl, UNVERIFIEDCLICK, "StatsTab"

Field 5 :TextValue
Case-sensitive text* on the tab to identify which tab to click.
TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

UnverifiedClickTab
RC RJ TC DRD SE2
( )

T, WINDOW, TabControl, UnverifiedClickTab, "StatsTab"

Field 5 :TextValue
Case-sensitive text* on the tab to identify which tab to click.
TextValue is the case-sensitive text on the tab to identify which tab to click. *For Sheridan SSActiveTabs this will be treated as an AppMap reference to an item that contains coordinates in the form of "xcoord,ycoord". The item will be retrieved from the section in the AppMap with the Components name (Field #3).

TableViewFunctions

TableViewFunctions Documentation.

ActivateTableRow
WR
( )

T, WINDOWNAME, COMPNAME, ACTIVATETABLEROW, 5

Field 5 :Row
The row number to activate.
Activates the row to the one specified here

GetCellValue
WR
( )

T, WINDOWNAME, COMPNAME, GetCellValue, VARIABLENAME, 1, 1

T, WINDOWNAME, COMPNAME, GetCellValue, "^VARIABLENAME", 1, 1

T, WINDOWNAME, COMPNAME, GetCellValue, VARIABLENAME, ^row=1, ^column=1

Field 5 :VariableName
The variable that the data will be stored in.

Field 6 :Row
The row that the data will be extracted from

Field 7 :Column
The column that the data will be extracted from.

GetRowCount
WR
( )

T, WINDOWNAME, COMPNAME, GetRowCount, VARIABLENAME

Field 5 :RowCount
The variable that the number of rows will be stored in.

SetSelectedColumn
WR
( )

T, WINDOWNAME, COMPNAME, SETSELECTEDCOLUMN, 5

Field 5 :Column
The column number that the TableView should be set to.
Set the current column to the one specified in this parameter.

SetSelectedRow
WR
( )

T, WINDOWNAME, COMPNAME, SETSELECTEDROW, 5

Field 5 :Row
The row number that the TableView should be set to.
Set the current row to the one specified in this parameter.

SetTableCellData
WR
( )

T, WINDOWNAME, COMPNAME, SETTABLECELLDATA, 5, 7, "Cell Value"

T, WINDOWNAME, COMPNAME, SETTABLECELLDATA, 5, 7, ^CellValue

Field 5 :Row
The row that the cell you want to set is in.

Field 6 :Column
The column that the cell you want to set is in.

Field 7 :TextValue
The text value to set the cell value to.

VerifyCellValue
WR
( )

T, WINDOWNAME, COMPNAME, VERIFYCELLVALUE, "The string to equal", ROW, COLUMN

T, WINDOWNAME, COMPNAME, VERIFYCELLVALUE, ^ExpectedString, ROW, COLUMN

Field 5 :ExpectedText
The value that the data in the cell is expected to equal.

Field 6 :Row
The row number of the cell to be verified.

Field 7 :Column
The column number of the cell to be verified.

TIDRestFunctions

TIDRestFunctions Documentation.

RestDeleteBinary

( )

RestDeleteCSS

( )

RestDeleteCustom
TID
( )

T, SAFSREST, ServiceIdItem, RestDeleteCustom, "relativeURL", "ResponseIDVariable", customHeader

T, SAFSREST, ServiceIdItemNonExist, RestDeleteCustom, "http://www.service.com/relativeURL/", "GetResponseIDVariable", "rest\customHeader.txt"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field 7 :headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [8]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestDeleteHTML

( )

RestDeleteImage

( )

RestDeleteJSON

( )

RestDeleteScript

( )

RestDeleteText

( )

RestDeleteXML

( )

RestEndServiceSession
TID
( )

T, SAFSREST, BayerSessionID, RestEndServiceSession

RestGetBinary
TID
( )

T, SAFSREST, BayerServiceIdItem, RestGetBinary, "sqlrest/CUSTOMER/", "BayerCustomerGetResponseIDVariable"

T, SAFSREST, BayerServiceIdItemNonExist, RestGet, "http://www.thomas-bayer.com/sqlrest/CUSTOMER/", "BayerCustomerGetResponseIDVariable"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The "response ID" is generated internally, and it is used to get the Response Object from the internal Map.

Field [7]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [8]:headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestGetCSS
TID
( )

T, SAFSREST, ServiceIdItem, RestGetCSS, "relativeURL", "ResponseIDVariable"

T, SAFSREST, ServiceIdItemNonExist, RestGetCSS, "http://www.service.com/relativeURL/", "GetResponseIDVariable"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field [7]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [8]:headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestGetCustom
TID
( )

T, SAFSREST, ServiceIdItem, RestGetCustom, "relativeURL", "ResponseIDVariable", customHeader

T, SAFSREST, ServiceIdItemNonExist, RestGetCustom, "http://www.service.com/relativeURL/", "GetResponseIDVariable", "rest\customHeader.txt"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field 7 :headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [8]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestGetHTML
TID
( )

T, SAFSREST, ServiceIdItem, RestGetCustom, "relativeURL", "ResponseIDVariable"

T, SAFSREST, ServiceIdItemNonExist, RestGetCustom, "http://www.service.com/relativeURL/", "GetResponseIDVariable"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field [7]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [8]:headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestGetImage
TID
( )

T, SAFSREST, ServiceIdItem, RestGetImage, "relativeURL", "ResponseIDVariable"

T, SAFSREST, ServiceIdItemNonExist, RestGetImage, "http://www.service.com/relativeURL/", "GetResponseIDVariable"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field [7]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [8]:headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestGetJSON
TID
( )

T, SAFSREST, ServiceIdItem, RestGetJSON, "relativeURL", "ResponseIDVariable"

T, SAFSREST, ServiceIdItemNonExist, RestGetJSON, "http://www.service.com/relativeURL/", "GetResponseIDVariable"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field [7]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [8]:headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestGetScript
TID
( )

T, SAFSREST, ServiceIdItem, RestGetScript, "relativeURL", "ResponseIDVariable"

T, SAFSREST, ServiceIdItemNonExist, RestGetScript, "http://www.service.com/relativeURL/", "GetResponseIDVariable"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field [7]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [8]:headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestGetText
TID
( )

T, SAFSREST, ServiceIdItem, RestGetText, "relativeURL", "ResponseIDVariable"

T, SAFSREST, ServiceIdItemNonExist, RestGetText, "http://www.service.com/relativeURL/", "GetResponseIDVariable"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field [7]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [8]:headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestGetXML
TID
( )

T, SAFSREST, ServiceIdItem, RestGetXML, "relativeURL", "ResponseIDVariable"

T, SAFSREST, ServiceIdItemNonExist, RestGetXML, "http://www.service.com/relativeURL/", "GetResponseIDVariable"

Field 5 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI (the base-URL is provided in a session). BUT it should be full path URL if the field SessionIDItem is not provided or invalid.

Field 6 :responseIdVar
The name of the variable holding "response ID", which is used by rest driver commands to verify/delete response.
The ID is generated internally, and it is used to get the Response Object from the internal Map.

Field [7]:body
The body to send with this REST request.
It can be

a literal text string for something simple.

a project-relative or full path to a file of larger body content in the proper format.

The body's content-type could be defined in the headers.

Field [8]:headers
The headers to be included in this REST request.
It can be

a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".

a map item holding the literal-string or header-file-path.

a project-relative-path or full-path to a file holding the literal header string.

Field [9]:authentication
The custom authentication/authorization information.
It can be

a project-relative-path or full-path to a file holding the authentication/authorization information.

a map item holding the auth-file-path.

This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect only in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestHeadBinary

( )

RestHeadCSS

( )

RestHeadCustom

( )

RestHeadHTML

( )

RestHeadImage

( )

RestHeadJSON

( )

RestHeadScript

( )

RestHeadText

( )

RestHeadXML

( )

RestPatchBinary

( )

RestPatchCSS

( )

RestPatchCustom

( )

RestPatchHTML

( )

RestPatchImage

( )

RestPatchJSON

( )

RestPatchScript

( )

RestPatchText

( )

RestPatchXML

( )

RestPostBinary

( )

RestPostCSS

( )

RestPostCustom

( )

RestPostHTML

( )

RestPostImage

( )

RestPostJSON

( )

RestPostScript

( )

RestPostText

( )

RestPostXML

( )

RestPutBinary

( )

RestPutCSS

( )

RestPutCustom

( )

RestPutHTML

( )

RestPutImage

( )

RestPutJSON

( )

RestPutScript

( )

RestPutText

( )

RestPutXML

( )

RestRequest
TID
( )

T, SAFSREST, BayerServiceItem, RestRequest, PUT, "sqlrest/PRODUCT/61/", "BayerProductPutResponseIDVariable", "<resource><NAME>CarSeat</NAME><PRICE>125.00</PRICE></resource>", "Content-Type: text/xml"

T, SAFSREST, BayerServiceItemNonExist, RestPut, PUT, "http://www.thomas-bayer.com/sqlrest/PRODUCT/61/", "BayerProductPutResponseIDVariable", "<resource><NAME>CarSeat</NAME><PRICE>125.00</PRICE></resource>", "Content-Type: text/xml"

Field 5 :HTTPMethod
The HTTP method to execute.
It can be one of "GET" "DELETE" "POST" "PUT" "PATCH" "HEAD".

Field 6 :relativeURI
The relative URI combined with a base-URL (stored in a session) to form a REST service URL.
This is normally a relative URI as the base-URL is provided in a session. BUT it should be full path URL if the parameter sessionID is not provided.

Field 7 :responseIdVar
The name of the variable holding the ID (generated internally), which is used to get the Response Object from the internal Map.

Field [8]:body
The body to send with this REST request.
The body could be a literal text string for something simple. The body could also be a project-relative or full path to a file of larger body content in the proper format.

Field [9]:headers
The headers to be included in this REST request.
It can be a literal string, such as "If-Modified-Since: Sat, 29 OCT 1994 19:43:31 GMT".
It can also be a project-relative-path or full-path to a file holding the literal header string.
It can also be a map item holding the literal-string or header-file-path.

Field [10]:authentication
The custom authentication/authorization information.
It can be a project-relative-path or full-path to a file holding the authentication/authorization information.
It can also be a map item holding the auth-file-path.
This custom authentication/authorization information will override the global settings (in .ini file or by VM parameter.)
and take effect in this keyword execution. In the next keyword execution, the global authentication/authorization setting
will still be taken in account if no custom auth information is specified.

RestStartServiceSession
TID
( )

T, SAFSREST, BayerSessionID, RestStartServiceSession, "http://www.thomas-bayer.com/"

T, SAFSREST, BayerSessionID, RestStartServiceSession, "http://www.thomas-bayer.com/", configure/simpleauth.xml

Field 5 :baseURL
The base URL to be stored with a session.
This base URL will be prepended to a relative URI to form a REST service URL for the later invocation of other REST actions.

Field [6]:authentication
The file holding authentication information to be used during this session.
Normally, the authentication information will be loaded from "JVM -D parameters", "Map", or global external file, those settings are considered to be global. This parameter can be used to alternate the authentication information, it will override the global settings.
It is normally provided as a file name holding the authentication information. The file is relative to the project's root directory, and it can contain sub directories.
If it is provided as NOAUTHENTICATION, then no authentication is needed during the session even the global settings are set.

TimePickerFunctions

TimePickerFunctions Documentation.

GetTime
DRD
( )

T, WINDOW, TimePicker, GetTime, currentTime

Field 5 :VariableName
The name of variable to contain the time string of TimePicker.
The name of variable to contain the time string of TimePicker. The time string will be in format "HH:mm:ss", the hour is in military format (24-hour).

SetTime
DRD
( )

T, WINDOW, TimePicker, SetTime, "23:45:12"

T, WINDOW, TimePicker, SetTime, "7:56"

Field 5 :TimeValue
TimeValue to set.
TimeValue to set. It can be in format of "HH:mm:ss" or "HH:mm". The hour should be in military format (24-hour). For the second, it is ignored for now, as Android TimePicker doesn't support it yet.

ToolBarFunctions

ToolBarFunctions Documentation.

ClickButton
RC TC
( )

T, WINDOW, ToolBar, ClickButton, "AParticularButtonText"

T, WINDOW, ToolBar, ClickButton, "aparticularbuttontext", CaseInsensitive

Field 5 :ButtonTextValue
Case-sensitive text of the toolbar button to select.
Case-sensitive text of the toolbar button to select.

Field [6]:CaseInsensitive
"1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

ClickButtonIndex
RJ TC
( )

T, WINDOW, ToolBar, ClickButtonIndex, 3

T, WINDOW, ToolBar, ClickButtonIndex, 1, "55;8"

Field 5 :Index
Index described which icon to be clicked in the toolbar.
Index described which icon to be clicked in the toolbar.
RJ Note:

If the index is bigger than the number of children of toolbar, the last icon will be clicked.

The tool bar separator is not counted for indexing. If the toolbar contains "button1 | button2", button1 is at index 1, button2 is at index 2, the separator between these two buttons is not counted.

Field [6]:Coordination
A position within the toolbar button, the mouse will be click there.
RJ Note: This parameter is special for RJ implementation.

ClickButtonText
RC RJ TC
( )

T, WINDOW, ToolBar, ClickButtonText, "AParticularButtonText"

T, WINDOW, ToolBar, ClickButtonText, "aparticularbuttontext", CaseInsensitive

T, WINDOW, ToolBar, ClickButtonText, "parent->child", CaseInsensitive

T, WINDOW, ToolBar, ClickButtonText, "AButtonText", , "55;8"

Field 5 :ButtonTextValue
Case-sensitive text of the toolbar button to select.
Case-sensitive text of the toolbar button to select.
RJ Note: This parameter may be a path like "a->b->c"

Field [6]:CaseInsensitive
"1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

Field [7]:Coordination
A position within the toolbar button, the mouse will be click there.
RJ Note: This parameter is special for RJ implementation.

ClickButtonTooltip
RJ
( )

T, WINDOW, ToolBar, ClickButtonTooltip, "Connections"

Field 5 :Tooltip
Tooltip is description of the icon on ToolBar.
Tooltip is description of the icon on ToolBar.

ClickUnverifiedButtonID
RC
( )

T, WINDOW, ToolBar, ClickUnverifiedButtonID, "1017"

Field 5 :ButtonID
ID for a particular button in the toolbar to select.
ID for a particular button in the toolbar to select.

ClickUnverifiedButtonText
RC RJ TC
( W )

T, WINDOW, ToolBar, ClickUnverifiedButtonText, "AParticularButtonText"

T, WINDOW, ToolBar, ClickUnverifiedButtonText, "aparticularbuttontext", CaseInsensitive

T, WINDOW, ToolBar, ClickUnverifiedButtonText, "parent->child", CaseInsensitive

T, WINDOW, ToolBar, ClickUnverifiedButtonText, "AButtonText", , "55;8"

Field 5 :ButtonTextValue
Case-sensitive text of the toolbar button to select.
Case-sensitive text of the toolbar button to select.
RJ Note: This parameter may be a path like "a->b->c"

Field [6]:CaseInsensitive
"1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.
Not all toolbars and buttons will be able to support this case-insensitive option.

Field [7]:Coordination
A position within the toolbar button, the mouse will be click there. RJ Note: This parameter is special for RJ implementation.

VerifyButtonClicked
RC
( )

T, WINDOW, ToolBar, VerifyButtonClicked, "AParticularButtonText"

Field 5 :ButtonTextValue
Case-sensitive text(Button.Key) of button that will be verified as clicked
TextValue should contain the case-sensitive text(Button.Key) of the item expected to already be clicked

VerifyButtonCount
RC
( )

T, WINDOW, ToolBar, VerifyButtonCount, "buttonCount"

Field 5 :ButtonCount
Numeric count value represents the total button counts in the Toolbar.
Numeric count value represents the total button counts in the Toolbar.

VerifyButtonText
RC
( )

T, WINDOW, ToolBar, VerifyButtonText, "AParticularButtonText"

T, WINDOW, ToolBar, VerifyButtonText, "aparticularbuttontext", "Case-Insensitive"

Field 5 :ButtonTextValue
Case-sensitive text (button.key) item that will be verified as exists
TextValue should contain the case-sensitive text of the item expected to exist. The user has an optional parameter to specify that the provided text is case-insensitive.

Field [6]:CaseInsensitive
"1", "CaseInsensitive", or "Case-Insensitive" to match button text in a case-insensitive manner.

VerifyButtonUnClicked
RC
( )

T, WINDOW, ToolBar, VerifyButtonUnClicked, "AParticularButtonText"

Field 5 :ButtonTextValue
Case-sensitive text(Button.Key) of button that will be verified as unselected
TextValue should contain the case-sensitive text(Button.Key) of the item expected to be unselected

TreeViewFunctions

TreeViewFunctions Documentation.

ActivateUnverifiedTextNode
RC RJ
( )

T, WINDOW, TreeView, ActivateUnverifiedTextNode, "MyParent->MyBranch->MyNode"

T, WINDOW, TreeView, ActivateUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"

T, WINDOW, TreeView, ActivateUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

CaptureTreeDataToFile
RC RJ TC SE2
( )

T, Browser, aTreeView, CaptureTreeDataToFile, aFilename.ext

T, Browser, aJavaTree, CaptureTreeDataToFile, myDirectory\aFilename.ext, "Parent Bank->Branch Banking and Trust", "_"

T, Browser, aTreeView, CaptureTreeDataToFile, aFilename.ext, , , "UTF-8"

Field 5 :File
The name of the file used to store the tree data.
The name of the file used to store the tree data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:Branch
The full name of the tree branch to capture.
The full name of the tree branch to capture. If omitted, all branches/nodes are captured.

The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'PartialMatchTreeDataToFile' if you wish to specify case-insensitive substring matches for tree nodes.

Field [7]:IndentMark
The character(s) to use in the output file to indent the tree nodes from the parent tree branches.
The character(s) to use in the output file to indent the tree nodes from the parent tree branches. If omitted, a tab character is used.

Field [8]:FileEncoding
Specify a character encoding to be used when saving data to a file. If it is not specified, the system default file encoding will be used. The encoding should be a valid string supported by Java; if it is not valid, the system default file encoding will be used instead.

Field [9]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [10]:FilterOptions
(Future) Specify filter options to use with the file filter.

CheckTextNode
RC
( )

T, WINDOW, TreeView, CheckTextNode, "MyNode"

T, WINDOW, TreeView, CheckTextNode, "MyNode", 3

T, WINDOW, TreeView, CheckTextNode, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be checked.
TextValue is the case-sensitive text of the node to be checked.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

ClickPartial
RC RJ TC SE2
( )

T, WINDOW, ATreeView, ClickPartial, "parent"

T, WINDOW, ATreeView, ClickPartial, "parent", "3"

T, WINDOW, ATreeView, ClickPartial, "parent", "Index=3"

T, WINDOW, ATreeView, ClickPartial, "parent->child"

T, WINDOW, ATreeView, ClickPartial, "parent->child", "3"

Field 5 :TextValue
Case-Insensitive text of node to click.
TextValue is the case-insensitive text of the node to click. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

ClickTextNode
RC RJ TC SE2
( )

T, WINDOW, ATreeView, ClickTextNode, "Parent"

T, WINDOW, ATreeView, ClickTextNode, "Parent", "3"

T, WINDOW, ATreeView, ClickTextNode, "Parent", "Index=3"

T, WINDOW, ATreeView, ClickTextNode, "Parent->Child"

T, WINDOW, ATreeView, ClickTextNode, "Parent->Child", "3"

Field 5 :TextValue
Case-sensitive text of node to click.
TextValue is the case-sensitive text of the node to click. Parent-Child relationships are separated by "->"

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

ClickUnverifiedTextNode
RC RJ TC SE2
( )

T, WINDOW, TreeView, ClickUnverifiedTextNode, "MyParent->MyBranch->MyNode"

T, WINDOW, TreeView, ClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"

T, WINDOW, TreeView, ClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

Collapse
RC RJ TC SE2
( )

T, WINDOW, ATreeView, Collapse, "Parent"

T, WINDOW, ATreeView, Collapse, "Parent", "3"

T, WINDOW, ATreeView, Collapse, "Parent", "Index=3"

T, WINDOW, ATreeView, Collapse, "Parent->Child"

T, WINDOW, ATreeView, Collapse, "Parent->Child", "3"

Field 5 :TextValue
Case-sensitive text of node to collapse
TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->"

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

CollapsePartial
RC RJ TC SE2
( )

T, WINDOW, ATreeView, CollapsePartial, "parent"

T, WINDOW, ATreeView, CollapsePartial, "parent", "3"

T, WINDOW, ATreeView, CollapsePartial, "parent", "Index=3"

T, WINDOW, ATreeView, CollapsePartial, "parent->child"

T, WINDOW, ATreeView, CollapsePartial, "parent->child", "3"

Field 5 :TextValue
Case-Insensitive text of node to collapse
TextValue is the case-insensitive text of the node to collapse. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

CollapsePartialTextNode
RC RJ
( )

T, WINDOW, AJTree, CollapsePartialTextNode, "Parent"

T, WINDOW, AJTree, CollapsePartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to collapse
TextValue is the case-insensitive text of the node to collapse. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

CollapseTextNode
RC RJ WR TC
( )

T, WINDOW, TreeView, COLLAPSETEXTNODE, "MyNode"

T, WINDOW, TreeView, COLLAPSETEXTNODE, "MyNode", 3

T, WINDOW, TreeView, COLLAPSETEXTNODE, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of node to collapse
TextValue is the case-sensitive text of the node to collapse
RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

CollapseUnverifiedTextNode
RC RJ SE2
( )

T, WINDOW, AJTree, CollapseUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, CollapseUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to collapse
TextValue is the case-sensitive text of the node to collapse. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

CtrlClickUnverifiedTextNode
RJ SE2
( )

T, WINDOW, AJTree, CtrlClickUnverifiedTextNode, "Parent"

T, WINDOW, AJTree, CtrlClickUnverifiedTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to CTRL-click.
TextValue is the case-sensitive text of the node to CTRL-click. Parent-Child relationships are separated by "->"

DoubleClickPartial
RC RJ TC SE2
( )

T, WINDOW, ATreeView, DoubleClickPartial, "parent"

T, WINDOW, ATreeView, DoubleClickPartial, "parent", "3"

T, WINDOW, ATreeView, DoubleClickPartial, "parent", "Index=3"

T, WINDOW, ATreeView, DoubleClickPartial, "parent->child"

T, WINDOW, ATreeView, DoubleClickPartial, "parent->child", "3"

Field 5 :TextValue
Case-Insensitive text of node to double click.
TextValue is the case-insensitive text of the node to double click. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

DoubleClickTextNode
RC RJ TC SE2
( )

T, WINDOW, ATreeView, DoubleClickTextNode, "Parent"

T, WINDOW, ATreeView, DoubleClickTextNode, "Parent", 3

T, WINDOW, ATreeView, DoubleClickTextNode, "Parent", "Index=3"

T, WINDOW, ATreeView, DoubleClickTextNode, "Parent->Child"

T, WINDOW, ATreeView, DoubleClickTextNode, "Parent->Child", 3

Field 5 :TextValue
Case-sensitive text of node to double click.
TextValue is the case-sensitive text of the node to double click. Parent-Child relationships are separated by "->"

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

DoubleClickUnverifiedTextNode
RC RJ TC SE2
( )

T, WINDOW, TreeView, DoubleClickUnverifiedTextNode, "MyParent->MyBranch->MyNode"

T, WINDOW, TreeView, DoubleClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"

T, WINDOW, TreeView, DoubleClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

Expand
RC RJ TC SE2
( )

T, WINDOW, ATreeView, Expand, "Parent"

T, WINDOW, ATreeView, Expand, "Parent", 3

T, WINDOW, ATreeView, Expand, "Parent", "Index=3"

T, WINDOW, ATreeView, Expand, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to expand
TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->"

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

ExpandPartial
RC RJ TC SE2
( )

T, WINDOW, ATreeView, ExpandPartial, "parent"

T, WINDOW, ATreeView, ExpandPartial, "parent", "3"

T, WINDOW, ATreeView, ExpandPartial, "parent", "Index=3"

T, WINDOW, ATreeView, ExpandPartial, "parent->child"

T, WINDOW, ATreeView, ExpandPartial, "parent->child", "3"

Field 5 :TextValue
Case-Insensitive text of node to match.
TextValue is the case-insensitive text of the node. Parent-Child relationships are separated by "->". For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

ExpandPartialTextNode
RC RJ
( )

T, WINDOW, AJTree, ExpandPartialTextNode, "parent"

T, WINDOW, AJTree, ExpandPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to match.
TextValue is the case-insensitive text of the node. Parent-Child relationships are separated by "->". For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

ExpandTextNode
RC RJ WR TC
( )

T, WINDOW, TreeView, EXPANDTEXTNODE, "MyNode"

T, WINDOW, TreeView, EXPANDTEXTNODE, "MyNode", "3"

T, WINDOW, TreeView, EXPANDTEXTNODE, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of node to expand
TextValue is the case-sensitive text of the node to expand.
RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

ExpandUnverifiedTextNode
RC RJ SE2
( )

T, WINDOW, AJTree, ExpandUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, ExpandUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to expand
TextValue is the case-sensitive text of the node to expand. Parent-Child relationships are separated by "->". If the tree contains hidden root nodes the user must provide these.

PartialMatchTreeDataToFile
RC RJ
( )

T, Browser, aTreeView, PartialMatchTreeDataToFile, aFilename.ext

T, Browser, aJavaTree, PartialMatchTreeDataToFile, myDirectory\aFilename.ext, "parent->branch", "_"

Field 5 :File
The name of the file used to store the tree data.
The name of the file used to store the tree data. By default, the files will be stored in the active "Test" directory. If you specify a relative path, the path will be relative to the project directory. The directory for a full or relative path must already exist.

Field [6]:Branch
The full name of the tree branch to capture.
The full name of the tree branch to capture. If omitted, all branches/nodes are captured.

The search of the path to the node is a case-insensitive substring match of each node. Use 'CaptureTreeDataToFile' if you wish to specify case-sensitive exact matches for tree nodes.

Field [7]:IndentMark
The character(s) to use in the output file to indent the tree nodes from the parent tree branches.
The character(s) to use in the output file to indent the tree nodes from the parent tree branches. If omitted, a tab character is used.

Field [8]:FilterMode
(Future) Specify a file filter to use to process the text before comparison.

Field [9]:FilterOptions
(Future) Specify filter options to use with the file filter.

RightClickPartial
RC RJ TC SE2
( )

T, WINDOW, ATreeView, RightClickPartial, "parent"

T, WINDOW, ATreeView, RightClickPartial, "parent", "3"

T, WINDOW, ATreeView, RightClickPartial, "parent", "Index=3"

T, WINDOW, ATreeView, RightClickPartial, "parent->child"

T, WINDOW, ATreeView, RightClickPartial, "parent->child", "3"

Field 5 :TextValue
Case-Insensitive text of node to right click.
TextValue is the case-insensitive text of the node to right click. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

RightClickTextNode
RC RJ TC SE2
( )

T, WINDOW, TreeView, RightClickTextNode, "MyParent->MyBranch->MyNode"

T, WINDOW, TreeView, RightClickTextNode, "MyParent->MyBranch->MyNode", "3"

T, WINDOW, TreeView, RightClickTextNode, "MyParent->MyBranch->MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

RightClickUnverifiedTextNode
RC RJ TC SE2
( )

T, WINDOW, TreeView, RightClickUnverifiedTextNode, "MyParent->MyBranch->MyNode"

T, WINDOW, TreeView, RightClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"

T, WINDOW, TreeView, RightClickUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

Select
RC RJ TC SE2
( )

T, WINDOW, ATreeView, Select, "Parent"

T, WINDOW, ATreeView, Select, "Parent", 3

T, WINDOW, ATreeView, Select, "Parent", "Index=3"

T, WINDOW, ATreeView, Select, "Parent->Child"

T, WINDOW, ATreeView, Select, "Parent->Child", "3"

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

SelectAnotherPartialTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectAnotherPartialTextNode, "parent"

T, WINDOW, AJTree, SelectAnotherPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to select.
TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

SelectAnotherTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectAnotherTextNode, "Parent"

T, WINDOW, AJTree, SelectAnotherTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->"

SelectAnotherUnverifiedTextNode
RC RJ
( )

T, WINDOW, AJTree, SelectAnotherUnverifiedTextNode, "root->Parent"

T, WINDOW, AJTree, SelectAnotherUnverifiedTextNode, "root->Parent->Child"

Field 5 :TextValue
Case-sensitive full path text of node to select.
TextValue is the case-sensitive text of the node to select. Parent-Child relationships are separated by "->" If the tree contains hidden root nodes they must be provided.

SelectPartial
RC RJ TC SE2
( )

T, WINDOW, ATreeView, SelectPartial, "parent"

T, WINDOW, ATreeView, SelectPartial, "parent", "3"

T, WINDOW, ATreeView, SelectPartial, "parent", "Index=3"

T, WINDOW, ATreeView, SelectPartial, "parent->child"

T, WINDOW, ATreeView, SelectPartial, "parent->child", "3"

Field 5 :TextValue
Case-Insensitive text of node to select.
TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

SelectPartialTextNode
RC RJ TC
( )

T, WINDOW, AJTree, SelectPartialTextNode, "parent"

T, WINDOW, AJTree, SelectPartialTextNode, "parent->child"

Field 5 :TextValue
Case-Insensitive text of node to select.
TextValue is the case-insensitive text of the node to select. Parent-Child relationships are separated by "->" For each level, a text comparison is performed. If the node contains the requested substring anywhere in its text, then that node is considered a match.

SelectPartialTextNodeSpecial
TC
( )

T, WINDOW, ATreeView, SelectPartialTextNodeSpecial, "parent", , Shift, Left

T, WINDOW, ATreeView, SelectPartialTextNodeSpecial, "parent", , Control, Left

Field 5 :TextValue
Case-Insensitive text (can be a part of whole text) of node to select.
TextValue is the case-insensitive text (can be a part of whole text) of the node to select.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

Field 7 :SpecialKey
The special key command used in the row selection. For now, only Control and Shift are supported.

Field 8 :MouseClick
The type of mouse click needed. For now, only Left and Right are supported.

SelectStateIcon
RC
( )

T, WINDOW, TreeView, SELECTSTATEICON, "MyNode"

T, WINDOW, TreeView, SELECTSTATEICON, "MyNode", 3

T, WINDOW, TreeView, SELECTSTATEICON, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be selected/checked.
TextValue is the case-sensitive text of the node to be selected/checked.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

SelectTextNode
RC RJ WR TC
( )

T, WINDOW, TreeView, SELECTTEXTNODE, "MyNode"

T, WINDOW, TreeView, SELECTTEXTNODE, "MyNode", 3

T, WINDOW, TreeView, SELECTTEXTNODE, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be selected.
TextValue is the case-sensitive text of the node to be selected.
RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

SelectTextNodeSpecial
TC
( )

T, WINDOW, ATreeView, SelectTextNodeSpecial, "Parent", , Shift, Left

T, WINDOW, ATreeView, SelectTextNodeSpecial, "Parent", , Control, Left

Field 5 :TextValue
Case-sensitive text of node to select.
TextValue is the case-sensitive text of the node to select.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

Field 7 :SpecialKey
The special key command used in the row selection. For now, only Control and Shift are supported.

Field 8 :MouseClick
The type of mouse click needed. For now, only Left and Right are supported.

SelectUnverifiedTextNode
RC RJ TC SE2
( )

T, WINDOW, TreeView, SelectUnverifiedTextNode, "MyParent->MyBranch->MyNode"

T, WINDOW, TreeView, SelectUnverifiedTextNode, "MyParent->MyBranch->MyNode", "3"

T, WINDOW, TreeView, SelectUnverifiedTextNode, "MyParent->MyBranch->MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

SelectUnverifiedTextNodeRightClick
RC TC
( )

T, WINDOW, TreeView, SelectUnverifiedTextNodeRightClick, "MyParent->MyBranch->MyNode"

T, WINDOW, TreeView, SelectUnverifiedTextNodeRightClick, "MyParent->MyBranch->MyNode", "3"

Field 5 :TextValue
Case-sensitive text of the node to be clicked
TextValue is the case-sensitive text of the node to be clicked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

SetTreeContainsNode
RC RJ TC SE2
( )

T, Browser, aTreeView, SetTreeContainsNode, "Parent Bank->Branch Banking and Trust", isFound

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'SetTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.
RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

Field 6 :ResultVar
The name of the variable which gets assigned the result.
The value of 'TRUE' indicates the node was found in the tree, and 'FALSE' indicates that the node was not found in the tree.

SetTreeContainsPartialMatch
RC RJ SE2
( )

T, Browser, aTreeView, SetTreeContainsPartialMatch, "parent->branch", isFound

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'SetTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.
RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

Field 6 :ResultVar
The name of the variable which gets assigned the result.
The value of 'TRUE' indicates the node was found in the tree, and 'FALSE' indicates that the node was not found in the tree.

ShiftClickUnverifiedTextNode
RJ SE2
( )

T, WINDOW, AJTree, ShiftClickUnverifiedTextNode, "Parent"

T, WINDOW, AJTree, ShiftClickUnverifiedTextNode, "Parent->Child"

Field 5 :TextValue
Case-sensitive text of node to SHIFT-click.
TextValue is the case-sensitive text of the node to SHIFT-click. Parent-Child relationships are separated by "->"

UnCheckTextNode
RC
( )

T, WINDOW, TreeView, UnCheckTextNode, "MyNode"

T, WINDOW, TreeView, UnCheckTextNode, "MyNode", 3

T, WINDOW, TreeView, UnCheckTextNode, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of the node to be unchecked.
TextValue is the case-sensitive text of the node to be unchecked.

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

VerifyNodeUnselected
RC RJ WR TC SE2
( )

T, WINDOW, TreeView, VERIFYNODEUNSELECTED, "MyNode"

Field 5 :TextValue
Case-sensitive text of node to be verified NOT selected
TextValue is the case-sensitive text of the node to be verified NOT selected
RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

VerifySelectedNode
RC RJ WR TC SE2
( )

T, WINDOW, TreeView, VERIFYSELECTEDNODE, "MyNode"

Field 5 :TextValue
Case-sensitive text of node to be verified selected
TextValue is the case-sensitive text of the node to be verified selected
RJ Implementation:TextValue must be given as full path with separator "->". Example: "Parent->Child"

VerifyStateIcon
RC
( )

T, WINDOW, TreeView, VERIFYSTATEICON, "MyNode"

T, WINDOW, TreeView, VERIFYSTATEICON, "MyNode", "3"

T, WINDOW, TreeView, VERIFYSTATEICON, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of state icon to be verified selected
TextValue is the case-sensitive text of the state icon to be verified selected/checked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

VerifyStateIconUnselected
RC
( )

T, WINDOW, TreeView, VERIFYSTATEICONUNSELECTED, "MyNode"

T, WINDOW, TreeView, VERIFYSTATEICONUNSELECTED, "MyNode", "3"

T, WINDOW, TreeView, VERIFYSTATEICONUNSELECTED, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of state icon to be verified NOT selected/checked
TextValue is the case-sensitive text of the state icon to be verified NOT selected/checked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

VerifyTextNodeChecked
RC
( )

T, WINDOW, TreeView, VerifyTextNodeChecked, "MyNode"

T, WINDOW, TreeView, VerifyTextNodeChecked, "MyNode", "3"

T, WINDOW, TreeView, VerifyTextNodeChecked, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of state icon to be verified selected/checked
TextValue is the case-sensitive text of the state icon to be verified selected/checked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

VerifyTextNodeUnChecked
RC
( )

T, WINDOW, TreeView, VerifyTextNodeUnChecked, "MyNode"

T, WINDOW, TreeView, VerifyTextNodeUnChecked, "MyNode", "3"

T, WINDOW, TreeView, VerifyTextNodeUnChecked, "MyNode", "Index=3"

Field 5 :TextValue
Case-sensitive text of state icon to be verified NOT checked
TextValue is the case-sensitive text of the state icon to be verified NOT checked

Field [6]:MatchIndex
Optional index of the Nth duplicate item to match.
Allows us to match duplicate item N in a list containing duplicate entries. For example, match the 2nd (or specified Nth) item whose text matches the provided text value.
The value of the parameter can have 2 forms:

A numeric value. Ex: "3"

Index prefixed value. Ex: "Index=3"

If the field parameter data does not match one of these two forms then the data is ignored and the default(first match) is used.

VerifyTreeContainsNode
RC RJ TC SE2
( )

T, Browser, aTreeView, VerifyTreeContainsNode, "Parent Bank->Branch Banking and Trust"

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-sensitive exact match of each node. Use 'VerifyTreeContainsPartialMatch' if you wish to specify case-insensitive substring matches for tree nodes.

VerifyTreeContainsPartialMatch
RC RJ TC SE2
( )

T, Browser, aTreeView, VerifyTreeContainsNode, "parent->branch"

Field 5 :Node
The name of the node to verify.
The search of the path to the node is expected to be a case-insensitive substring match of each node. Use 'VerifyTreeContainsNode' if you wish to specify case-sensitive substring matches for tree nodes.

VSFlexGridFunctions

VSFlexGridFunctions Documentation.

ClickCell
RC
( )

T, AWindow, AGrid, ClickCell, ^row=2, ^col=1

Field [5]:row
The 1-based logical row to select.
If no row is provided then row=1 is assumed.

Field [6]:col
The 1-based logical col to select.
If no col is provided then col=1 is assumed.

SelectCell
RC
( )

T, AWindow, AGrid, SelectCell, ^row=2, ^col=1

Field [5]:row
The 1-based logical row to select.
If no row is provided then row=1 is assumed.

Field [6]:col
The 1-based logical col to select.
If no col is provided then col=1 is assumed.

VerifyValuesToFile
RC
( W )

T, Window, VSFGrid, VerifyGridToFile, "bench.ext"

T, Window, VSFGrid, VerifyGridToFile, "bench.ext", 1, 5

T, Window, VSFGrid, VerifyGridToFile, "bench.ext", 1, 5, 3, 6

T, Window, VSFGrid, VerifyGridToFile, "bench.ext", 1, 5, "First Name", "Zip Code"

Field 5 :BenchmarkFile
The name of the file used as the comparison benchmark.
The name of the file used as the comparison benchmark.
Typically, benchmarks are stored in the Datapool\Bench directory. In that event, only the filename.ext is needed. Benchmarks and captures will be TAB delimited files.

Field [6]:rowMin
The first row to include in the capture and compare.
By default, the first row of the grid is used.

Field [7]:rowMax
The last row to include in the capture and compare.
By default, the last row of the entire grid is used.

Field [8]:colMin
The first col to include in the capture and compare.
By default, the first col of the grid is used. Columns can also be specified by full or partial column header text.

Field [9]:colMax
The last col to include in the capture and compare.
By default, the last col of the entire grid is used. Columns can also be specified by full or partial column header text.

WindowFunctions

WindowFunctions Documentation.

Click
WR
( )

T, WINDOW, WINDOW, CLICK, AnObject

T, WINDOW, AnObject, CLICK, ASubObject

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup and use for the click.

Name of the AppMap subkey to lookup and use for the click. We expect the AppMap to contain the item in the format "x,y":

[FileMenu] Exit=33,120 OR Exit=Coords=33,120

The results from the lookup are appended to the "Coords=" string used by the Window Click command in Robot (if necessary). So any valid content used with the Window Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

CloseWindow
RC RJ WR SE SE2 TC AUT
( )

T, WINDOW, WINDOW, CLOSEWINDOW

CompareStoredProperties
WR
( )

T, WINDOW, WINDOW, COMPARESTOREDPROPERTIES, "AStoredVP"

Field 5 :VPAsset
Name of the pre-existing VP asset stored in the currently running script.

DoubleClick
WR
( )

T, WINDOW, WINDOW, DOUBLECLICK, AnObject

T, WINDOW, AnObject, DOUBLECLICK, ASubObject

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup and use for the double-click.

Name of the AppMap subkey to lookup and use for the double-click. We expect the AppMap to contain the item in the format "x,y":

[FileMenu] Exit=33,120 OR Exit=Coords=33,120

The results from the lookup are appended to the "Coords=" string used by the Window DBLClick command in Robot (if necessary). So any valid content used with the Window DBLClick command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

GetWinInfo
WR
( )

T, WINDOWNAME, WINDOWNAME, GETWININFO, Caption, ^TitleValue

Field 5 :PropertyName
The name of the property to retrieve.

Field 6 :VariableName
The name of the variable that the property value should be stored in.

GoBack
DRD
( )

T, WINDOWNAME, WINDOWNAME, GoBack

T, Anything, AtAll, GoBack

InputCharacters
WR
( )

T, WINDOW, WINDOW, INPUTCHARACTERS, "Some Text to Input"

Field 5 :TextValue
String of keystrokes to send.
String of keystrokes to send. Consult the documentation on the SQA InputKeys command for syntax information for special characters and keys. This routine sends the provided string unmodified to the InputKeys command.

InputKeys
WR
( )

T, WINDOW, WINDOW, INPUTKEYS, "Some Text to Input"

Field 5 :TextValue
String of keystrokes to send.
String of keystrokes to send. Consult the documentation on the SQA InputKeys command for syntax information for special characters and keys. This routine sends the provided string unmodified to the InputKeys command.

Maximize
RC RJ WR SE TC SE2 AUT
( )

T, WINDOW, WINDOW, MAXIMIZE

Minimize
RC RJ WR SE TC SE2 AUT
( )

T, WINDOW, WINDOW, MINIMIZE

PinchClose
IOS
( )

T, AppWindow, AppWindow, PinchClose, Origin1, Resize2

T, AppWindow, AppWindow, PinchClose, Origin1, "-40;-40", 3

Field 5 :OriginSubKey
The AppMapSubkey that contains the onscreen rectangle for the pinch operation.
Name of the AppMap subkey to lookup and use for OriginRect or the actual literal text for the values.
We expect the rectangle stored in the App Map or the literal text to be specified as integer rectangle coordinates and size in pixels: X,Y,Width,Height.
[AppWindow] ... Origin1="50,200,25,25" OR Origin2="Coords=100,75,125,125" ...

Engines should attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "50,200,25,25"

";" (semi-colon) Example: "50;200;25;25"

" " (space) Example: "50 200 25 25"

If the App Map does not contain the subkey item then the engines should assume the value is the literal text of the rectangle coordinate and size values.

Field 6 :ResizeSubKey
Name of the AppMap subkey to lookup for the resize value or the literal text of the resize values.
Name of the AppMap subkey to lookup for the resize value or the literal text of the resize values.
We expect the resize value stored in the App Map or the literal text to be specified as integer values (in pixels): +/-Width, +/-Height.
[AppWindow] ... Resize1="0,-50" (no width change, but shrink the height by 50 pixels) Resize2="Coords=-40,0" (shrink width by 40 pixels, with no change in height.) ...

These resize offsets can be positive or negative integer values and will be added to the existing width and/or height of OrigRect.
Engines should attempt to support values separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "0,50"

";" (semi-colon) Example: "0;50"

" " (space) Example: "0 50"

If the App Map does not contain the subkey item then the engines should assume the value is the literal text of the resize values.

Field [7]:Duration
The number of seconds to take for the operation.
Where supported, the engine should attempt to make the operation take up to N seconds in duration. The default is 1 second.

PinchOpen
IOS
( )

T, AppWindow, AppWindow, PinchOpen, Origin1, Resize1

T, AppWindow, AppWindow, PinchOpen, Origin1, "40;40", 3

Field 5 :OriginSubKey
The AppMapSubkey that contains the onscreen rectangle for the pinch operation.
Name of the AppMap subkey to lookup and use for OriginRect or the actual literal text for the values.
We expect the rectangle stored in the App Map or the literal text to be specified as integer rectangle coordinates and size in pixels: X,Y,Width,Height.
[AppWindow] ... Origin1="50,200,25,25" OR Origin2="Coords=100,75,125,125" ...

Engines should attempt to support coordinates separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "50,200,25,25"

";" (semi-colon) Example: "50;200;25;25"

" " (space) Example: "50 200 25 25"

If the App Map does not contain the subkey item then the engines should assume the value is the literal text of the rectangle coordinate and size values.

Field 6 :ResizeSubKey
Name of the AppMap subkey to lookup for the resize value or the literal text of the resize values.
Name of the AppMap subkey to lookup for the resize value or the literal text of the resize values.
We expect the resize value stored in the App Map or the literal text to be specified as integer values (in pixels): +/-Width, +/-Height.
[AppWindow] ... Resize1="0,50" (no width change, but grow in height by 50 pixels) Resize2="Coords=50,0" (grow width by 50 pixels, with no change in height.) ...

These resize offsets can be positive or negative integer values and will be added to the existing width and/or height of OrigRect.
Engines should attempt to support values separated by alternate separators. The most common separators that should be supported would be:

"," (comma) Example: "0,50"

";" (semi-colon) Example: "0;50"

" " (space) Example: "0 50"

If the App Map does not contain the subkey item then the engines should assume the value is the literal text of the resize values.

Field [7]:Duration
The number of seconds to take for the operation.
Where supported, the engine should attempt to make the operation take up to N seconds in duration. The default is 1 second.

Restore
RC RJ WR SE TC SE2 AUT
( )

T, WINDOW, WINDOW, RESTORE

RightClick
WR
( )

T, WINDOW, WINDOW, RIGHTCLICK, AnObject

T, WINDOW, AnObject, RIGHTCLICK, ASubObject

Field 5 :AppMapSubkey
Name of the AppMap subkey to lookup and use for the right-click.

Name of the AppMap subkey to lookup and use for the right-click. We expect the AppMap to contain the item in the format "x,y":

[FileMenu] Exit=33,120 OR Exit=Coords=33,120

The results from the lookup are appended to the "Coords=" string used by the Window Right_Click command in Robot (if necessary). So any valid content used with the Window Right_Click command can be part of this AppMap entry.

Both Fields #3 and #5 are used to locate the item in the App Map. This routine does not specify an App Map so only the current Map is used and it is expected to be valid.

SelectMenuID
RC WR
( )

T, WINDOW, WINDOW, SELECTMENUID, 37

Field 5 :MenuID
MenuID to identify which menuitem to select.
MenuID to identify which menuitem to select.

SelectMenuItem
RC RJ WR
( )

T, WINDOW, WINDOW, SELECTMENUITEM, "&File->&Save Ctrl+S"

T, PopupMenu, PopupMenu, SELECTMENUITEM, "Exit"

Field 5 :TextValue
Menu->MenuItem hierarchy string to identify which menuitem to select.
Menu->MenuItem hierarchy string to identify which menuitem to select. NOTE:RC (Robot) can only handle submenus up to 5 levels deep.

SelectMenuItemContains
RC RJ WR
( )

T, WINDOW, WINDOW, SELECTMENUITEMCONTAINS, "&File->&Save"

T, PopupMenu, PopupMenu, SELECTMENUITEMCONTAINS, "x"

Field 5 :TextValue
Menu->MenuItem hierarchy string to identify which menuitem to select.
Menu->MenuItem hierarchy string to identify which menuitem to select. NOTE:RC (Robot) can only handle submenus up to 5 levels deep.

SetFocus
SE
( )

T, WINDOW, WINDOW, SETFOCUS

SetPosition
RC RJ WR SE TC SE2 AUT
( )

T, WINDOW, WINDOW, SETPOSITION, Preset1

Field 5 :PresetReference
String specifying a preset reference in the Application for the position, size, and state of the Window.
String specifying a preset reference in the Application for the position, size, and state of the Window. command.

VerifyImage
RC WR
( )

T, WINDOW, WINDOW, VERIFYIMAGE, "AStoredVP"

Field 5 :VPAsset
TextValue is the name of the pre-existing VP asset stored in the currently running script.
TextValue is the name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then a RegionImageVP will be attempted.

VerifyMainMenu
RC WR
( , F )

T, WINDOW, WINDOW, VERIFYMAINMENU, "BenchFile.ext"

T, WINDOW, AnObject, VERIFYMAINMENU, "BenchFile.ext", "Descriptive Text"

T, WINDOW, AnObject, VERIFYMAINMENU, "BenchFile.ext", "Descriptive Text", "TestFile.ext"

T, WINDOW, AnObject, VERIFYMAINMENU, "BenchFile.ext", , "TestFile.ext", "DiffFile.ext"

Field 5 :BenchmarkFile
name.ext of benchmark file on repositiory's Datapool\Bench directory

Field [6]:DescriptiveText
Optional expected descriptive text at start of file (first line of bench).
Optional expected descriptive text at start of file (first line of bench). (If bench has this descriptive text this field is REQUIRED to pass.)

Field [7]:TestFile
optional name.ext to give current structure in repository's Datapool\Test directory for compare with benchmark.
optional name.ext to give current structure in repository's Datapool\Test directory for compare with benchmark. If no name is given then the bench name is used.

Field [8]:DiffFile
Optional name.ext to store difference information
Optional name.ext to store difference information in repository's Datapool\Dif. If no name is given then the bench name is used.

VerifyMenuID
RC WR
( , F )

T, WINDOW, WINDOW, VERIFYMENUID, 37,"Enabled Checked"

Field 5 :MenuID
MenuID to identify which menuitem to test.
MenuID to identify which menuitem to test. This is generally used when the menuitem is a bitmap or other item that does not have text. This value can be retrieved from the the menu by index or by manual lookup from a menu structure output from MenuUtilities.

Field 6 :ExpectedStatus
Expected status string (or part thereof) to verify.
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.

VerifyMenuItem
RC RJ WR
( , F )

T, WINDOW, WINDOW, VERIFYMENUITEM, "File","Enabled Menu With 7 MenuItems"

Field 5 :MenuItemText
Menu->MenuItem hierarchy string to identify which menuitem to test.
Menu->MenuItem hierarchy string to identify which menuitem to test. This menu hierarchy IS case-sensitive

Field 6 :ExpectedStatus
Expected status string (or part thereof) to verify.
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.

VerifyMenuItemContains
RC RJ WR
( , F )

T, WINDOW, WINDOW, VERIFYMENUITEMCONTAINS, "File->Save","Enabled"

Field 5 :MenuItemText
Menu->MenuItem hierarchy string to identify which menuitem to test.
Menu->MenuItem hierarchy string to identify which menuitem to test. This menu hierarchy IS case-sensitive

Field 6 :ExpectedStatus
Expected status string (or part thereof) to verify.
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.

VerifyOCRValue
RC WR
( )

T, LoginWindow, SomeWindowObject, VERIFYOCRVALUE, "AStoredVP", 1, "<Expected Value>"

Field 5 :VPAsset
VPTextValue is the name of the pre-existing VP asset stored in the currently running script.
TextValue is the name of the pre-existing VP asset stored in the currently running script. If the name also exists in the app map under the component then a RegionImageVP will be invoked instead of a CompareImageVP.

Field 6 :OCRIntegerValue
IntegerValue is the numeric OCR region mask to get the text from.
IntegerValue is the numeric OCR region mask to get the text from. These values are defined in the VP itself and can be viewed in Robot's ImageComparator/Editor. A number can be used directly or a named reference can be used if it is found to exist in the Application Map in a section with the same name as the VP.

Field 7 :ExpectedTextValue
Text baseline to compare against the retrieved OCR text.

DDE Setup, DDEngineReference, Using DDVariables, Error Recovery and Flow Control, Custom Extensions

FilterMode	Comments
WILDCARD	Default. Includes support for * and ? wildcard characters
REGEXP	Includes support for Regular Expression pattern matching

FILTERMODE	FIELDS	COMMENTS
Default(empty)	(None)	Default filtering. File is unchanged.
"RegExp"	5 - PATTERN (Required)	REGEXP pattern to match for filtering. All occurrences of text in a file that match regular expression PATTERN will be removed and replaced with the REPLACE string (if any).
	6 - REPLACE (Optional)	Default value for REPLACE is "" (empty string). This tells REGEXP to remove matching PATTERN text from the file. Specifying a REPLACE string will remove matching PATTERN text from the file and insert the REPLACE string in its place.
	7 - CASE (Optional)	CASE specifies the case-sensitivity used when searching for matching text in the file. Use "CaseInsensitive" to ignore case when searching. If not specified the default implementation is a CaseSensitive compare.