Data-Driven Engine Reference

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 for information on various forms of test automation and specifically on our data driven or keyword driven form of automation.

• Creating an Application Map for your application.
• Download ClassicsC Excel Examples for Excel-based samples of tests and scripts that can interact with the engine.
• Sample Application Map developed with 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.)

Reference:

• Framework Details and Instruction
• 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 CycleDriver, SuiteDriver, and StepDriver
    • 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 GOTO Driver Commands and 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 Robot must be running in 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 ( )
          • C, AppMapChaining, OFF
            • Field 3 :Mode
              Enable("ON") or Disable("OFF") this feature.
              
        • AppMapResolve ( )
          • C, AppMapResolve, OFF
            • Field 3 :Mode
              Enable("ON") or Disable("OFF") this feature.
              
        • AssignClipboardVariable ( )
          • 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 ( )
          • 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 ( , 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 ( )
          • C, ClearAllVariables
        • ClearAppMapCache ( )
          • C, ClearAppMapCache
        • ClearClipboard ( )
          • C, ClearClipboard
        • CloseApplication ( W, F )
          • C, CloseApplication, NotePad
            • Field 3 :ApplicationID
              The Application ID or reference provided to LaunchApplication
              
        • CopyVariableValueEx ( )
          • 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 ( )
          • C, Delay, 300
            • Field 3 :Timeout
              The number of milliseconds to delay.
              
        • DisableDomain ( )
          • 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 ( )
          • 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 ( )
          • C, Expressions, ON
            • Field 3 :Mode
              The status for enhanced expression handling.
              
        • GetAppMapValue ( )
          • 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 ( )
          • 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 ( )
          • 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.

              
              
        • GetSystemDate ( )
          • 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 ( )
          • C, GetSystemDateTime, SystemDate
          • C, GetSystemDateTime, "SystemDate"
          • C, GetSystemDateTime, "^SystemDate"
          • C, SetVariableValues, ^SystemDate="TodaysDate"
            C, GetSystemDateTime, ^SystemDate
            • 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.
        • GetSystemTime ( )
          • C, GetSystemTime, SystemTime
          • C, GetSystemTime, "SystemTime"
          • C, GetSystemTime, "^SystemTime"
          • C, SetVariableValues, ^SystemTime="CurrentTime"
            C, GetSystemTime, ^SystemTime
            • 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.
        • GetVersion ( )
          • C Version var
            • Field 3 :Variable
              A variable to accept the VERSION
              
        • LaunchApplication ( 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
            • 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.

            • 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.
            • 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. Try to include all command line parameters within the ExecutablePath.
              If you DO provide separate command line paratmeters then the DDE cannot automatically terminate the application if things go really bad.
            • 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.
        • Pause ( )
          • C, Pause, 30
            • Field 3 :Timeout
              The number of seconds to Pause.
              
        • SaveClipboardToFile ( )
          • C, SaveClipboardToFile, C:\Temp\myclipboard.txt
          • C, SaveClipboardToFile, Datapool\myclipboard.txt
          • C, SaveClipboardToFile, myclipboard.txt
            • 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.
        • SetApplicationMap ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( 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 ( )
          • 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.
        • SetProjectDirectory ( )
          • C, SetProjectDirectory, "C:\MyRepo\MyProject\AltPath"
            • Field 3 :Path
              The full path to the new directory.
              
        • SetRootVerifyDirectory ( )
          • 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.
              
        • SetTestDirectory ( )
          • 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 ( )
          • 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 ( )
          • 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
              
        • StartWebBrowser ( )
          • C, StartWebBrowser
          • C, StartWebBrowser, "", WebBrowser
          • C, StartWebBrowser, "http://aUrl.jsp", WebBrowser
            • Field [3]:URL
              URL of a web resource to load in the new browser instance.
              
            • Field [4]:WindowTag
              A WindowTag or name to call the new browser instance.
              
        • UseRobotJFunctions ( 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 ( 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 ( W )
          • C, UseSeleniumFunctions, ON
            • Field 3 :Mode
              The switch status for enabling the use of the Selenium hook. Valid values are "ON" and "OFF".
              
        • VerifyClipboardToFile ( )
          • C, VerifyClipboardToFile, myclipboard.txt
          • C, VerifyClipboardToFile, C:\Temp\myclipboard.txt
            • 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.
        • Version ( )
          • C Version 1.0
            • Field 3 :Version
              The VERSION of the table format. Initially "1.0"
              
        • WaitForGUI ( 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 ( 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 ( 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 ( 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.
        • WaitForWebPage ( 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • C, SetJdbcDriver, "oracle.jdbc.driver.OracleDriver"
            • Field 3 :DriverClassName
              Name of the driver class
              
        • VerifyDatabaseNullValue ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • C, Breakpoints, ON
            • Field 3 :Mode
              The status for this debug mode.
              
        • CommandDebug ( )
          • C, CommandDebug, ON
            • Field 3 :Mode
              The status for this debug mode.
              
        • RecordsDebug ( )
          • C, RecordsDebug, ON
            • Field 3 :Mode
              The status for this debug mode.
              
        • TestDebug ( )
          • C, TestDebug, ON
            • Field 3 :Mode
              The status for this debug mode.
              
      • DDDriverFileCommands
        • DDDriverFileCommands Documentation.
        • CloseFile ( )
          • C, CloseFile, 8
          • C, CloseFile, ^file_number
            • Field 3 :FileNumber
              The file number for the file to be closed.
              
        • CopyFile ( )
          • 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 ( )
          • 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 ( )
          • C, CreateDirectory, "C:/Test/SubTest"
            • Field 3 :DirectoryName
              The full directory path name for the directory to be created.
              
        • CreateFile ( )
          • C, OpenFile, "C:\Test\FileTest.txt", "Output", "Write","^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 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 ( )
          • C, DeleteDirectory, "C:/Test/SubTest"
            • Field 3 :DirectoryName
              The full directory path name for the directory to be deleted.
              
        • DeleteDirectoryContents ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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"
            • 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.

        • FindSqaFile ( )
          • 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 ( )
          • C, GetFileDateTime, "Test1.txt" , "^filedate"
          • C, GetFileDateTime, "C:Test1.txt" , "^filedate"
            • 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
              
        • GetFileProtections ( )
          • 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 ( )
          • 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
              

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

              0 - Normal files, returns only files without directory, hidden, system, or volume label attributes set

              2 - Add hidden files

              4 - Add system files

              8 - Return Volume label

              16 - Add directories

              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, the Dir function 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.

              NOTE: Java-based engines like RJ, TID, and SDC do not yet support this optional parameter.

        • GetFileSize ( )
          • 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 ( )
          • 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
              
        • GetSubstringsInFile ( )
          • 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:
              1. DDVariable Chart1 contains the first substring, and
              2. DDVariable Chart2 contains the second substring.
              3. DDVariable ChartCount contains the number of matches found.
        • IfExistDir ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 or Append. Random and Binary not supported
              
            • 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 ( )
          • 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 UTF-8 file, Input, Output or Append. Random and Binary not supported
              
            • 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 ( )
          • 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. NOTE: this parameter is not used by the RobotJ version.
              
        • ReadFileChars ( )
          • C, ReadFileChars, ^filenum , 5,"^charread"
          • C, ReadFileChars, 8, 5,"^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
              
            • Field 5 :VariableName
              Name of the DDV variable in which to store the characters read from the file
              
        • ReadFileLine ( )
          • 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 ( )
          • 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 ( )
          • 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.
              
        • SetFileProtections ( )
          • 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 ( )
          • C, WriteFileChars, 3, all, ^expression
          • C, PrinttoFile, ^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 ( )
          • 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.
              
        • CallScript ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • C, ExitCycle
        • ExitSuite ( )
          • C, ExitSuite
        • ExitTable ( )
          • C, ExitTable
        • GotoBlockID ( )
          • C, GotoBlockID, "ErrorHandler"
            • Field 3 :BlockID
              The name of the block to Goto.
              
        • OnContainsGotoBlockID ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( 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.
              
        • SetExitTableBlock ( )
          • C, SetExitTableBlock, "ProcessExit"
          • C, SetExitTableBlock, ""
            • Field [3]:BlockID
              The name of the block to Goto when ExitTable is encountered.
              
        • SetGeneralScriptFailureBlock ( )
          • C, SetGeneralScriptFailureBlock, "ErrorHandler"
          • C, SetGeneralScriptFailureBlock, ""
            • Field [3]:BlockID
              The name of the block to Goto on status GeneralScriptFailure.
              
        • SetInvalidFileIOBlock ( )
          • C, SetInvalidFileIOBlock, "IOHandler"
          • C, SetInvalidFileIOBlock, ""
            • Field [3]:BlockID
              The name of the block to Goto on status InvalidFileIO.
              
        • SetNoScriptFailureBlock ( )
          • C, SetNoScriptFailureBlock, "NoError"
          • C, SetNoScriptFailureBlock, ""
            • Field [3]:BlockID
              The name of the block to Goto on status NoScriptFailure.
              
        • SetScriptNotExecutedBlock ( )
          • C, SetScriptNotExecutedBlock, "AbortHandler"
          • C, SetScriptNotExecutedBlock, ""
            • Field [3]:BlockID
              The name of the block to Goto on status ScriptNotExecuted.
              
        • SetScriptWarningBlock ( )
          • C, SetScriptWarningBlock, "WarningHandler"
          • C, SetScriptWarningBlock, ""
            • Field [3]:BlockID
              The name of the block to Goto on status ScriptWarning.
              
        • UseLocalFlowControl ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • C, ResumeLogging
            • Field [3]:logName
              (Future) The name of a Log Facility, other than the "current" one, to receive the resumption notice.
              When suppport for named Log Facilities is provided you will be able to specify which of these you wish to receive the resumption notice.
        • SuspendLogging ( )
          • C, SuspendLogging
            • Field [3]: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 suspension notice.
      • DDDriverStringCommands
        • DDDriverStringCommands Documentation.
        • CleanString ( )
          • 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 ( )
          • C, Compare, "abc", "abcd", var
            • Field 3 :sourceString
              sourceString (could come from a ^variable)
              
            • Field 4 :dstString
              dstString (could come from a ^variable)
              
            • Field 5 :resultVar
              the resultVar to place the result of the operation into
              
        • Concatenate ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • C, GetSystemEnviron, "OS", var
            • Field 3 :string1
              String1
              
            • Field 4 :resultVar
              the resultVar to place the result of the operation into
              
        • GetSystemUser ( )
          • C, GetSystemUser, var
            • Field 3 :resultVar
              the resultVar to place the USERID into
              
        • GetTrimmedField ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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.
        • StartTimer ( )
          • 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 ( )
          • C, StopTimer, exampleTimer
            • Field 3 :timerName
              timerName (should be unique)
              
        • StoreTimerInfo ( )
          • C, StoreTimerInfo, exampleTimer, TimerVar
            • Field 3 :timerName
              timerName (should be unique)
              
            • Field 4 :variable
              variable to store time information in.
              
        • StoreTimerInfoFile ( )
          • 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 ( )
          • 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 ( )
          • C, VerifyElapsedTimeIsLess, exampleTimer, 10
            • Field 3 :timerName
              timerName (should be unique)
              
            • Field 4 :verifyValue
              verifyValue will be used to as the check value.
              
        • VerifyElapsedTimeIsMore ( )
          • C, VerifyElapsedTimeIsMore, exampleTimer, 10
            • Field 3 :timerName
              timerName (should be unique)
              
            • Field 4 :verifyValue
              verifyValue will be used to as the check value.
              
        • VerifyTimer ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
          • 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 ( )
      • T, WINDOW, Checkbox, CHECK
    • Click ( )
      • T, WINDOW, Checkbox, CLICK
    • UnCheck ( )
      • T, WINDOW, Checkbox, UNCHECK
  • ComboBoxFunctions
    • ComboBoxFunctions Documentation.
    • CaptureItemsToFile ( )
      • T, WINDOW, ComboBox, CaptureItemsToFile , afile.txt
        • Field 5 :FileName
          File name (if not absolute, then to test dir)
          File name (if not absolute, then to test dir)
    • Click ( )
      • T, WINDOW, ComboBox, CLICK
    • HideList ( )
      • T, WINDOW, ComboBox, HideList
    • Select ( )
      • T, WINDOW, ComboBox, SELECT, "MySelection"
        • Field 5 :TextValue
          The case-sensitive item in the drop down list to select.
          
    • SelectIndex ( )
      • T, WINDOW, ComboBox, SELECTINDEX, "1"
        • 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.
    • SelectPartialMatch ( )
      • T, WINDOW, ComboBox, SelectPartialMatch, "ATextSubstring"
        • Field 5 :TextValue
          The case-sensitive substring of an item in the drop down list to select.
          
    • SelectUnverified ( )
      • T, WINDOW, ComboBox, SELECTUNVERIFIED, "MySelection"
        • Field 5 :TextValue
          The case-sensitive item in the drop down list to select.
          
    • SetTextValue ( )
      • T, WINDOW, ComboBox, SETTEXTVALUE, "MyPassword"
        • Field [5]:TextValue
          The text that will be typed into the ComboBox.