These commands are generally for interrogating engines about the Windows and Components they can find. These are not normally used during testing. (But they can be used during testing like any other command record.)

For example, these commands are heavily used by STAFProcessContainer during test design time.

Each engine command has different parameters as described in its documentation. For reference, the first fields of ALL Engine Command test records are defined below:

Field #1 -- "E" = ENGINE COMMAND record type specifier.

Field #2 -- The Engine Command keyword.

Example:

E, GetTopLevelWindows

Engine Command parameters must be placed in the test record in the field position specified in the documentation. Some parameters are optional. However, the field associated with that parameter must be honored. If you wish to skip an optional parameter you must still provide an empty field for that parameter.

Example:

The above example shows two optional fields after Value2 which are given no value(skipped).

Engine commands that return a value do so in the SAFS/Hook/statusinfo variable of SAFSVARS which is populated via TestRecordData.statusinfo.

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            ^TCAFS.UID.Count  = [Number of UID References created last]
            ^TCAFS.UID.1      = [First UID Reference created]
            ^TCAFS.UID.n      = [UID Reference number n]            
            

The TestRecordData.statuscode is set to NO_SCRIPT_FAILURE if the engine supports and processes the command. This is true even if the command results in an empty, missing, or null return value.

SCRIPT_NOT_EXECUTED should be returned in TestRecordData.statuscode if the engine does not support the command.

Note that the full availablility of all Engine Commands may be spread across several files. Together, all of these files define all the Engine Commands available to the core framework.

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            ^TCAFS.UID.Count  = [Number of UID References created last]
            ^TCAFS.UID.1      = [First UID Reference created]
            

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

If the Level cannot be determined then the engine should return -1.

Returns a character delimited string of child references. The first character in the returned string defines the delimiter used to separate the items.

Currently, the engine command processors only support returning the first child matching the recognition string.

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

If no match is found the engine should return: "<SAFS_NULL>".

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

Example return string showing a single value (1 row and 1 column): ",1,1,MyValue"

Missing values are represented simply by two delimiters back-to-back with no value between them.

Example return string of 3 rows with 2 columns with missing values in the last two rows:

",3,2,a,b,,d,e,"

Whitespace in a value is retained. Everything between delimiters is treated as part of the value.

If there is no retrievable text or data the engine should return "<SAFS_NULL>".

If there is no superclass or hierarchy the engine will return a delimited list of one value--the component's classname. (Ex: ",Html.BUTTON")

When a superclass hierarchy does exist the first value after the delimiter is the component's classname. Each delimited value after that goes one higher in the hierarchy until the topmost superclass has been processed.
(Ex: ",CustomButton,java.awt.Button,java.awt.Component,java.lang.Object")

If the component itself has no classname and no hierarchy (unusual!) then the engine should simply return an empty, 0-length string.

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            

The engine's array of objects will be returned as a delimited list of fields. The first character in the String will identify the separator used between each reference. If no top level windows were found then the engine will return an empty string.

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.UID.Count  = [Number of UID References created last]
            ^TCAFS.UID.1      = [First UID Reference created]
            ^TCAFS.UID.n      = [UID Reference number n]            
            

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            

Normally, this is only valid for components whose subitems, nodes, or children are found by Path syntax: Root->Branch->Leaf. This is often the case for Menus, MenuItems, and Tree nodes.

Returns text "true" if an object matching the provided Path was found. Returns text "false" if no such object was found.

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.
            

The Android Engine also persists these values as SAFS variables.

            ^DroidEngine.Command    = [command]
            ^DroidEngine.StatusCode = [statuscode string]
            ^DroidEngine.StatusInfo = [statusinfo]
            

See DEngineCommandProcessor.setStatusVars().

The TestComplete Engine (TCAFS) also persists these values as SAFS variables.

            
            ^TCAFS.Command    = [command]
            ^TCAFS.StatusCode = [statuscode string]
            ^TCAFS.StatusInfo = [statusinfo]
            ^TCAFS.FullName   = [object.FullName] -- the TestObjects.FullName string--if command returns only 1 reference.