Your e-Business Quality Partner eValid™ -- Automated Web Quality Solution
Browser-Based, Client-Side, Functional Testing & Validation,
Load & Performance Tuning, Page Timing, Website Analysis,
and Rich Internet Application Monitoring.
© Copyright 2000-2008 by Software Research, Inc.

eValid -- V8 Script Language Definitions and Explanations
Alphabetic Index of Commands
eValid Home

Summary
This page specifies the standard eValid recording, editing, and playback interface. Each recording is a simple, intuitive, program sequence that embodies a single test composed of a sequence of activities that have specific outcomes. As an eValid script runs the Error Flag, the Alarm Flag or the Warning Flag could be set by one or more commands. This state can be sensed during playback.

Intrinsic and Extrinsic Commands
Some command definitions listed below do not occur during the making of recordings; they are called extrinsic commands. Such commands are provided so an eValid user can edit a script to produce special effects or results.

Table Organization
In the table of script definitions below these definitions apply. There is a complete Alphabetic Index of Commands available for easy access to the ~235 commands that eValid recognizes.

[ Top | Index ]

eValid Script Group Minimum Required
Feature Key
Prolog and Postlog STAN
Script Identification & Naming STAN
Navigation STAN
Timing & StopWatch STAN
License and Version Options STAN
Cache Management STAN
Wait Time/Date Manipulation STAN
Synchronization Support PROF
Playback Oriented STAN, PROF
Element-Oriented Events PROF
Link Check Wizard PROF
Validation PROF
String Matching PROF
Monitoring Support PROF
Flag Processing PROF
Dom-Based Sync Support PAGEMAP
Extracting DOM, Page, and Screen Content PAGEMAP
Index Motion Commands PAGEMAP
DOM Manipulation Commands PAGEMAP
Applet Support PROF
Absolute Position PROF
Modal Dialog PROF
Window Management STAN, PROF
Keyboard & Desktop Operations PROF
External File Processing PROF
Script Manipulation and Annotation PROF
Server Loading LOAD
eV.Generate Operation GEN
Site Analysis Support SITEMAP

[ Top | Index ]

Notes on Format of Command Descriptions

Errors, Warnings, or Notes of various kinds are issued to the message area during playback if problems are detected.
Generally the goal of playback is to complete the script if possible, but eV.Manager may treat a playback with any messages as a FAILed test.

  • Parameters in "quotes like this" are literal strings which cannot contain "'s or 's; (use your editor to include such characters in hex).
  • All other parameters [not in quotes] are integers.
  • Parameters that need additional explanations are marked.
  • wid is the window identifier with "0" for the parent, and "1", "2",... for children.
  • idx is the internal HTML element number (index) assigned by eValid.
  • frame_path is the name of the frame and/or frame sequence, with "name:title" for labeled frames (if they have a non-blank title) and with "number:N" for unnamed frames, where N is a unique frame number (ordinal number) that depends on the frame position within the actual frameset for the page.

    The value of N starts with 0 (for the first encountered frame) and increases by +1, e.g. 1,2,3,4..., in an order that is internally determined and is unique to the page properties.

    Note that the frame_path will always be expressed in terms of an ordinal the "number:N" format if you have chosen the "Record Frame Names as Ordinal Values" setting in the eValid preferences.

    Also, in case a frame has no name, or in the case of an iframe which does not permit use of a frame_path, then eValid will use the "number:N" format to make sure there is no ambiguity.

  • Commands that optionally result in a navigation will contain an additional last field [ NAV ] when navigation is required, and otherwise not.
  • Commands that reference another file may require a [PATH] specification, that is, a fully qualified path, if the file is not found in the local folder.

[ Top | Index ]

Prolog and Postlog Commands
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
STAN
#
# Recording by eValid V8.
# (c) Copyright by Software Research, Inc...
# Recording made on: system
# Recording started at: date
#
Record
Edit
This notice appears at the head of each recording. It documents the operating system that the recording was made on, as well as the time the recording was started.  
STAN
#
# Recording stopped at: date
#
Record
Edit
This notice appears at the end of each recording. It documents the time the recording was completed.  
STAN
#
# Insert-Recording Started at: date
...
(Recording Inserted Here)
...
# Insert-Recording Stopped at: date
# 
Record
Edit
These notices appear at the beginning and end of an Insert Recording action.  
STAN
ScreenSize [current screen resolution details]
	
Record
Edit
This script command appears at the beginning of a Recording. It tells the user of the screen resolution used when the script was created. A messagebox appears if the screen resolution used to playback a script is lower than the recorded screen size.
STAN
FontSize [current Size of Web Page Text]
Record
Edit
This script command appears at the beginning of a Recording. It tells the user of the size of the web page's text used when the script was created. On script playback, if the the web page text size differs from the recorded size, eValid will automatically resize the text to the recorded size.
STAN ProjectID "Name"
GroupID "Name"
TestID "Name"
LogID "Type"
Record
Edit
These commands specify the Project, Group, Test and Log names.

The ProjectID and GroupID are used to identify the project and group folders.

The LogID "Type" command is used to determine the Log File Names. Two values for Type are supported:

  1. DEFAULT will cause eValid to use the Log File Names that were set in the Preferences Menu.

  2. AUTO will cause eValid to use Log File Names based on the standard suffixes to the filename set in TestID.
 

[ Top | Index ]

Script Identification and Naming
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
STAN LogID Record
Edit
These commands specify the Project, Group, Test and Log names.

The ProjectID and GroupID are used to identify the project and group folders.

The LogID "Type" command is used to determine the Log File Names. Two values for Type are supported:

  1. DEFAULT will cause eValid to use the Log File Names that were set in the Preferences Menu.

  2. AUTO will cause eValid to use Log File Names based on the standard suffixes to the filename set in TestID.
 
STAN GroupID Record
Edit
The GroupID Name command is used as the name of the script file.  
STAN ProjectID Record
Edit
The ProjectID Name command is used as the name of the script file.  
STAN TestID Record
Edit
The TestID Name command is used as the name of the script file.  

[ Top | Index ]

Navigation
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
STAN FollowLink wid idx "visible_text" "URL" "frame_path" [NO_NAV] Record
Edit
Adaptive
eVlite
Synchronization
Follows the specified URL in the browser, waits for the page to come up (if it can within the required minimum time), and gives control back to the user.

Note all fields are assigned automatically by eValid and are required during playback to match to those for the current page.

Adaptive Playback is available for this command.

A Warning is issued if visible_text differs from what was recorded.

A Warning is issued if URL-string differs from what was recorded.

STAN GoBackTo wid step "URL" "frame_path" Record
Edit
eVlite
Synchronization
Goes Back to the previous page.

The step number denotes the number of URLs to skip.

If previous page does not match, it goes to the page that was specified.
STAN GoForwardTo
wid step "URL" "frame_path"
Record
Edit
Synchronization
Presses the FORWARD button once.

The step number denotes the number of URLs to skip.

If next page does not match it goes to the page that was specified.
STAN GotoLink wid "URL" "frame_path" Record
Wizard
Edit
Adaptive
eVlite
Synchronization
Goes to the specified URL with the browser, waits for the page to come up (if it can within the required minimum time), and gives control back to the user.

If the WebSite has frames active then the recording includes the frame_path of the frame; on playback this is the frame to which the browser is pointed with the URL.

This action is the same as typing in a URL and pressing RETURN.

A Warning is issued if URL-string is not found or if retrieval time exceeds the preset maximum.
STAN InitLink "URL" Record
Wizard
Edit
eVlite
Start the playback session from the specified URL.

This commands overrides the effect of the current home URL, which is set with an environment variable.

This command resets all timers (see Timer Section).

Normally this command is the first "active" command in a playback script. Wherever eValid is pointing before this command, evalid will return to the starting page after this command is complete.

A WARNING is issued if URL-string is not found or if the page download time exceeds the preset maximum.

Adaptive Playback is available for this command.

STAN Redirect wid "URL" "frame_path" Record
Edit
Synchronization
This command is recorded as a comment to view the URL's redirection. In some rare cases where the redirection does not work, one solution is uncomment the command to explicitly navigate to the URL specified.  
STAN Reload wid Record
Edit
Synchronization
Reloads the current page.  

[ Top | Index ]

Timing & StopWatch
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
STAN Delay msecs Edit Waits (ignoring any Delay Multiplier & Wait Ceiling settings) for the specified number of msecs (int). The regular internal timers run during a Delay operation. eValid automatically imposes a ceiling of approximately 1.6 million seconds (approximately 455 hours) on the delay value it accepts.
STAN ElapsedTime ["Message"] Record
Edit
Shows elapsed times in timing output file but does not reset the clock[s]. If the optional "Message" appears that message is inserted into the logfiles.  
STAN Wait msecs Record
Edit
During playback, waits msec milliseconds.

All delays are multiplied by the current delay multiplier (the default value of 1.0 implies 100% TrueTime). The "wait-ceiling" specifies the maximum wait time.

 
STAN PauseTimer Edit Pauses the timer.  
STAN ResumeTimer Edit Turns the timer back on if it was paused.  
STAN ResetTimer Record
Edit
Prints all timer[s] values and resets all timer[s]. Time resolution is 1.0 msec.  

[ Top | Index ]

License and Version Options
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
STAN ValidAfter MM DD YYYY Edit Prohibits use of this script except after MM DD YYYY.  
STAN ValidUntil MM DD YYYY Edit Allows the script file to run until the specified date MM DD YYYY.  
STAN ValidVersion Major Minor Build Edit Prevents playback of the current script unless the current eValid version number detail meets these constraints: Major > 0; Minor < 100; Build < 1000. When this command is present in a playback script you will get an error message if the assertion about version numbers is found to be false. In that case, playback will not continue for that build.

Example: eValid will satisfy the requirement imposed with this command:
  ValidVersion 7 0 240.

This command works with eValid and does not require a particular feature key.

[ Top | Index ]

Cache Management
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
STAN DeleteCache Record
Edit
Deletes all current non-cookie entries the cache.  
STAN DeleteCookies Record
Edit
Deletes all current cookies in the cache.  
STAN DeleteSession Record
Edit
Ends the current browser session. (That is, this command flushes entries not in use from the password cache on the hard drive and resets the cache time used when sync mode is once-per-session [MSDN documentation]). Unlike DeleteCache or DeleteCookies, DeleteSession does not (or should not) affect the browser sessions of other instances of eValid, but it may affect the browser sessions of child windows.

[ Top | Index ]

Wait Time/Date Manipulation
 

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
STAN IdleTimer ON
IdleTimer OFF
Edit The Idle Timer is OFF by default. This means idle time is NOT counted during playback.

The user can turn idle time accounting ON with IdleTimer ON in the script file (recommended as a first or early command).

When OFF none of the playback idle time (e.g. waiting for Lock, waiting for cache access, etc.) is counted in the timings for individual commands or the script as a whole.

The END time (shown in the Log Files) thus represents the time the set of script commands has taken to execute (excluding idle time). Putting a ElapsedTime command at the end of the script will show the total time (Real Time) that the script took to run.

If the IdleTimer ON command is used the end-of-playback time the ElapsedTime output will show the same time (accurate to between 1-10 msec depending on script length).

 
STAN WaitDate MM DD Edit Waits until the system time's month and date meet or exceed the specified month 'MM' and the specified date 'DD'.

The month parameter has a range of 01-12.
The date parameter has a range of 01-31.

A Warning is issued if the specified month does not contain the specified date.

A value specified over the valid range will cause a syntax error.

STAN WaitDateTime MM DD hh mm Edit Waits until the system time's month, date, and time meet or exceed the specified month 'MM', the specified date 'DD', and the specified time 'hh':'mm' (hour:minute).

The month parameter has a range of 01-12.
The date parameter has a range of 01-31.
The hour parameter has a range of 00-23.
The minute parameter has a range of 00-59.

A Warning is issued if the specified month does not contain the specified date.

A value specified over the valid range will cause a script syntax error.

STAN WaitHH [value]
WaitMM [value]
WaitModHH [value]
WaitModMM [value]
WaitTime HH MM
WaitTimeMod HH MM
Edit
eVlite
Runs the scripts at a specific time based on the value specified in the Wait commands.

For HH commands, the value parameter has a range of 00-23.

For all MM commands, the value parameter has a range of 00-59.

WaitTime will wait for the exact hour 'HH' and exact minute 'MM' before running the next command.

WaitModHH will wait for the next exact hour that is a multiple of 'value' before running the next command.

WaitModMM will wait for the next exact minute that is a multiple of 'value' before running the next command.

WaitTimeMod will wait for the next exact hour that is a multiple of 'HH' and the next exact minute that is a multiple of 'MM' before running the next command.

WaitMod commands should ideally use values that are exactly divisible into 24 (for HH) and 60 (for MM).

A value specified over the specified valid range will cause a script syntax error.
STAN WaitRandomUniform lo-value hi-value Edit Waits a random number of milliseconds using a uniform distribution random number between the lo-value and the hi-value.  

[ Top | Index ]

Synchronization Support

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF clSyncRect wid x y w h checksum
xySyncRect wid x y w h checksum

(SyncOnScreenRect top-left-rect-x, top-left-rect-y width height checksum top-left-browser-x top-left-browser-y bottom-left-browser-x bottom-left-browser-y)

(AbsValidateScreenRect ...)

Record
Edit
Desktop
Synchronization
Allows the user to select an area of the screen to be validated by the checksum on the pixels. eValid will wait and recheck the selected screen rectangle until the checksum is found or until the time threshold (as set in the Advanced Preferences menu) is reached.
The coordinates used during recording are relative to the client window (inside the browser).

Note: The main frame will reposition itself if necessary.

(Both the previously named AbsValidateScreenRect and SyncOnScreenRect commands are deprecated in this release.)
PROF SyncOnText wid "text" "frame_path" Record
Edit
Synchronization
Allows the user to select text to be validated. eValid will wait until the text is found or until the time threshold (as set in the Advanced Preferences menu) is reached. This command is accessible from both the eValid window and with Ctrl-Y. If no frame_path is specified the command assumes "frame:0".
PROF SyncOnURL "URL" Edit
Synchronization
Waits until the indicated URL has been retrieved. If the URL returns a 404, eValid waits a short time (the synchronize retry interval) and tries again to get the indicated URL. Respects the maximum wait time value.

Application Note: This feature lets any number of remote eValids all be loaded with the same script and all wait until someone "touches" the URL to launch all eValid's paying attention.

 
PROF Lock
Lock [n]
Unlock
Edit
Desktop
Synchronization
Lock is used to lock the current eValid window in the desktop foreground to facilitate working with ModalDialogs, to provide for unique access to cache data, and to prevent other eValid's commands that require window focus from interfering with the current playback.

Any concurrently executing eValid windows that use the Lock & Unlock commands will wait until there are no windows locked (i.e. in focus) before proceeding.

Lock can take an optional number parameter that specifies the number of milliseconds before the lock times out. This is only effective if no Unlock command is given or if the Unlock command is not reached before the timeout. If no parameter is given a default of 60000 msecs (1 minute) is used.

The Lock & Unlock commands are essential for scripts that involve ModalDialog commands, or for scripts which require focus to be maintained on a particular window. The block of eValid playback script commands that need to have exclusive focus locked should be wrapped in a Lock ... Unlock block, for example:

...
Commands...
Lock
   SubmitClick [parameters]
   ModalDialogWait 4000
   ModalDialogEnter
...
Unlock
OtherCommands...
...
Lock & Unlock can be used at other times to ensure that the script runs in the foreground and all other eValid processes will wail until no other eValid windows are locked before continuing script playback.

Note 1: AbsMouse and Keyboard events implicitly lock the playback process for the duration of the command. However, use of Lock/Unlock will enhance the reliability.

Note 2: SyncOnScreenRect locks the playback process before each attempt to validate the screen, and releases it after each attempt. It will NOT lock the process for the whole time it is attempting to validate. It will also be released when the validation has succeeded or has timed out. This allows multiple validations in different scripts to work concurrently.

 

[ Top | Index ]

Playback Oriented

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF Adaptive [ "ON" | "OFF" ] Edit Turns the Adaptive Playback feature "ON" or "OFF". When "ON" the eValid playback engine behaves as intelligently as it can when encountering objects that have moved to a new location on the page, or have changed names or both.  
PROF Breakpoint "Name" Edit Pauses the Playback; puts message in Log with "Name".
Playback must be resumed by user (by using the F8 key).
 
PROF PlayValue "key" value Edit Click here for more information on PlayValue.  
STAN MessageBox "message" Edit
Desktop
Pops up a modal dialog box of a automatically determined size based on the message text saying:
    [eValid Modal Popup]
    "message"
    Click OK to Continue
    [OK]
Everything stops pending the user clicking on OK.
 
STAN MessageWindow "message" [time [ x y w h ]] Edit
Desktop
Pops up a window containing the "message". If time is specified then the window persists for the specified length of time (in seconds). If in addition the sizes are specified then the window will be of the specified width w and height h at location x y. Note: The popup window generated by this command is a browser so it accepts HTML.
PROF SecureDataID "name" Record
Edit
Security
Declaring the name of a SecureDataID enables eValid to maintain state when in secure sessions. This command must directly follow EnterSecureZone. More than one can be entered, but each command has only a single parameter. Secure Data ID's will remain valid until an ExitSecureZone. If another EnterSecureZone is called before exiting the first secure zone, the SecureDataID(s) need to be respecified (or different ones need to be specified).  
PROF AuthenticateUser wid "username" "password" Record
Edit
Security
This command is used to handle the Client Authentication processes.

During browsing and recording, eValid displays its own dialog with simple explanations of the problem encountered.

During playback of scripts and during site analysis runs this dialog is not displayed, but encounters with Client Authentications are recorded as MESSAGEs.

Note that the first occurring Client Authentication command in a current script is the one that applies; second and subsequent instances in the same script are ignored.

Modal popup suppression preferences do not apply to Client Authentication processes.

 
PROF EnterSecureZone
ExitSecureZone
Record
Edit
Security
During recording of a session that on playback will require processing of URL modifiers, the user can signal entry or exit from the "secure zone" by clicking on the corresponding eValid menu items or editing these commands into the script. 

The initial state of "secure zone" processing is OFF.

Extra Precaution: Generally not required because eValid will handle most security issues implicitly.
PROF SetUserAgent "user-agent-string" Edit If the string specified user-agent-string is non-blank, sets that string value as the user agent for eValid. Once set the user agent string setting persists until eValid is re-launched.
STAN WaitRedirect wid "url" "frame_path" Record
Edit
eVlite
Synchronization
When eValid detects a redirection, a WaitRedirect script command is inserted rather than a GotoLink command. Adaptive Playback is available for this command.

[ Top | Index ]

Element-Oriented Events

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF ElementClick wid idx [x y] "id" "visible_text" "frame_path" [NAV] Record
Edit
Adaptive
Clicks on specified element. The optional x and y values specified are offsets within the object that are supplied by the DOM. eValid will record these script commands if the user clicks on an HTML element that uses these events.
PROF ElementDblClick wid idx [x y] "id" "visible_text" "frame_path" [NAV] Record
Edit
Adaptive
Records double click on specified element. The x and y values specified are offsets within the object that are supplied by the DOM. eValid will record these script commands if the user clicks on an HTML element that uses these events.
PROF ElementBlur wid idx "id" "visible_text" "frame_path" [NAV] Record
Edit
Adaptive
Sends an elementBlur event to the HTML element. eValid will record these script commands if the user mouses out of an HTML element for which focus is sensitive to this event.
PROF ElementFocus wid idx "id" "visible_text" "frame_path" [NAV] Record
Edit
Adaptive
Sends an elementFocus event to the HTML element. eValid will record these script commands if the user mouses over an HTML element for which focus is sensitive to this event.
PROF ElementMouseDown wid idx [x y] "id" "visible_text" "frame_path" [NAV] Record
Edit
Adaptive
Sends an onmouseDown event to the HTML element. Uses the NAV parameter if the event is expected to perform a navigation. eValid will record these script commands if the user clicks on an HTML element that uses these events.
PROF ElementMouseUp wid idx [x y] "id" "visible_text" "frame_path" [NAV] Record
Edit
Adaptive
Sends an onmouseUP event to the HTML element. Uses the NAV parameter if the event is expected to perform a navigation. Will record these script commands if the user clicks on an HTML element that uses these events.
PROF ElementMouseOver wid idx x y "id" "frame_path" [NAV] Record
Edit
Adaptive
Sends an onmouseover event to the HTML element. Uses the NAV parameter if the event is expected to perform a navigation. The x and y values specified are offsets within the object that are supplied by the DOM.  
PROF ElementMouseOut wid idx x y "id" "frame_path" [NAV] Record
Edit
Adaptive
Synchronization
Sends an onmouseout event to the HTML element. Uses the NAV parameter if the event is expected to perform a navigation. The x and y values specified are offsets within the object that are supplied by the DOM.  
PROF ButtonClick wid idx "id" "name" "label" "frame_path" Record
Edit
Wizard
Adaptive
Synchronization
A FORM's radio button is pushed and its current status value is recorded.

The Adaptive search looks for the first element whose name matches the string specified in the script file. If the specified name is empty, as is the case for many of these elements, then the label is searched instead.

A Warning is issued if label differs on playback from what was recorded.

Adaptive Playback is available for this command.

PROF GotoLinkSubmit wid "URL?DATA" "frame_path" Record
Edit
eVlite
Synchronization
Same as GotoLink but includes "?" (Get) Data  
PROF InputImageClick wid idx "source-url" "alt-text" "frame_path" Record
Edit
Adaptive
Synchronization
An input Image is clicked and its properties are recorded. A Warning is issued if the image properties differs on playback from what found during recording.
PROF ResetClick wid idx "id" "name" "label" "frame_path" Record
Edit
Wizard
Adaptive
The reset-form button and visible_text associated with it is recorded.

The Adaptive search looks for the first element whose name matches the string specified in the script file. If the specified name is empty, as is the case for many of these elements then the label is searched instead.

 
PROF SubmitClick wid idx "id" "name" "label" "frame_path" Record
Edit
Wizard
Adaptive
Synchronization
The submit-form button and the visible_text associated with it is recorded. 

The Adaptive search looks for the first element whose name matches the string specified in the script file. If the specified name is empty, as is the case for many of these elements then the label is searched instead.

A Warning is issued if visible_text differs on playback from what is recorded.
STAN InputValue wid idx "type" "id" "name" "extra-1" "extra-2" "frame_path" Record
Edit
Adaptive
For extra information concerning the Type, Extra-1, and Extra-2 parameter please see below. Please see the detailed explanation at: InputValue Processing in Playback.

"type" Parameter
"extra-1" Parameter "extra-2" Parameter
TEXT value property ""
TEXTAREA value property ""
HIDDEN value property ""
RADIO value property "TRUE" or "FALSE"
CHECKBOX value property "TRUE" or "FALSE"
SELECT-ONE text of selected option selected index, e.g. "1"
SELECT-MULT Text of all selected options. Each option is separated by ||. For example A||B||C||... Comma-separated list of selected indexes

[ Top | Index ]

Link Check Wizard

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF DynamicLinkCheck wid
DynamicLinkCheckX wid
Record
Edit
Runs the built-in one-page Link Wizard on the current page, puts the resulting eValid commands in a special temporary file named base-DLC.evs, and then plays that script.

This command is important if you wish to check all of the links on a page for which the content is generated dynamically.

 

[ Top | Index ]

Validation

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF ValidateClipboardText "Text" Record
Edit
Desktop
This can be used when validating contents inside a clipboard. Note that eValid does not have a record capability for processing clipboard text, but it does have a playback capability that will let you simulate the effect of Copy/Cut/Paste provided you already have highlighted something.
PROF ValidateDocumentBodyText
wid offset "text" "frame_path"
Record
Edit
DOM
Records and validates text in the BODY HTML element starting at offset in the current page. Error messages are issued if differences are detected during playback.
PROF ValidateDocumentChecksum wid checksum "frame_path" Record
Edit
Records and validates the CRC32 checksum of the entire outer HTML of the page with the given frame_path. The CRC32 checksum recorded is in decimal format. Error messages are issued if differences are detected during playback.
PROF ValidateDocumentElements wid num-elements "frame_path" Record
Edit
Records and validates the number of elements (num-elements) on the current page. Error messages are issued if differences are detected during playback.
PROF ValidateDocumentLastModified wid "Date-String" "frame_path" Record
Edit
Records and validates the last modified date of the current page. Error messages are issued if differences are detected during playback.
PROF ValidateDocumentSize num-bytes wid "frame_path" Record
Edit
Records and validates the size (num-bytes) of the current page. Error messages are issued if differences are detected during playback.
PROF ValidateDocumentTitle wid "title" "frame_path" Record
Edit
Records and validates the document title of the current page. Error messages are issued of differences are detected during playback.
PROF ValidateDocumentURL wid "URL" "frame_path" Record
Edit
Records and validates. Error messages are issued if differences are detected during playback.
PROF ValidateSelectedObjProperty wid idx [["id_name"] "id_value"] name value "frame_path"

[1] ValidateSelectedObjProperty wid idx name value "frame_path"

[2] ValidateSelectedObjProperty wid idx ["id_value"] name value "frame_path"

[3] ValidateSelectedObjProperty wid idx [["id_name"] "id_value"] name value "frame_path"

Record
Edit
Adaptive
DOM
Validates the specific content of the described DOM object in the indicated frame (as specified by the frame_path).

Details of the available names are usually found using the eValid PageMap facility.

If the object found at idx does not have the given name, or if name is correct and the value the name currently has is incorrect, or if name is not found, an ERROR results.

If the object with ID equal to id_value exists and the name has the specified value, or if name is correct and the value the name currently has is incorrect, or if name is not found, an ERROR results.

If the object with object id_name equal to id_value exists and the name has the specified value, or if name is correct and the value the name currently has is incorrect, or if name is not found, an ERROR results.

Validation of text items is case sensitive.

Adaptive Playback is available for this command only if the command has one or two additional parameters.

PROF clValidateSavedSelectedImage wid "uniqueID" idx "frame_path"

ValidateSavedSelectedImage wid "uniqueID" idx "frame_path"

Record
Edit
DOM
At record time, eValid saves the selected image in a file named in a file named "<testname>-B.<uniqueID>.gif.

At playback time, eValid saves the selected image in a file named in a file named "<testname>-R.<uniqueID>.gif.

The two files -- Baseline and Response are intended for use in offline validation operations (e.g. with eV.Manager).

Error messages are issued if differences are detected on the response and base files during playback.
In V8+ the coordinates used during recording are relative to the client window (inside the browser).
PROF ValidateSavedSelectedText wid "uniqueID" idx offset length "frame_path" Record
Edit
DOM
Records and validates. Error messages are issued if differences are detected on the response and base files during playback.
PROF ValidateSavedWindow wid "uniqueID" Record
Edit
Desktop
Records and validates the area of a window. Error messages are issued if differences are detected on the response and base files during playback.
PROF ValidateSavedWindowFace wid "uniqueID" Record
Edit
Desktop
Records and validates the client area of a window. Error messages are issued if differences are detected on the response and base files during playback.
PROF ValidateSelectedApplet wid idx "name" "jclass" width height "frame_path" Record
Edit
Records and validates all applets Error messages are issued if differences are detected during playback.
PROF ValidateSelectedCell wid idx "cell-html" "frame_path" Record 
Edit
Adaptive
DOM
Records the index value and contents of the selected table cell, up to 256 bytes. Error messages are issued if differences are detected during playback.
PROF ValidateSelectedID wid "ID-Property" "frame_path" Record 
Edit
DOM
Records all ID projects Error messages are issued if it is not present on playback
PROF ValidateSelectedImage wid idx "image-url" byte-count width height date "frame_path" Record
Edit
DOM
Records basic facts, including the index value and the length in bytes, about the selected image. Error messages are issued if differences are detected during playback
PROF ValidateSelectedText wid idx offset "selected_text" "frame_path" Record 
Edit
Adaptive
DOM
Records and validates the selected text.

The string match is attempted beginning at offset many characters from the beginning of page element idx in window wid (on "frame_path").

An ERROR is issued if the text during playback is different from that recorded. Adaptive playback may find a string match and that will result in a WARNING message.
PROF ValidateSelectedValueRange wid idx offset "low-value" "hi-value" "frame_path"

ValidateSelectedValuePercent wid idx offset "selected_text" "range-percent" "frame_path"

Edit
Adaptive
DOM
Validates that the value at the indicated location is within the specified numeric range or within the specified tolerance (plus or minus). The selected string is extracted and converted in the usual way into a floating point number. An error is issued if the selected value is outside the closed range specified, or if the contents of the string does not convert to a numeric value.

These commands are the edited replacement for a ValidateSelectedText but with the added range values.

An Error is issued if the value validated during playback is outside the specified range.
PROF ValidateDocumentProtocol wid "protocol" "frame_path" Edit Validates the document protocol, that is, the information up to the ":" only. Other information beyond that point is ignored. Error messages are issued if differences are detected during playback.
PROF ValidateDocumentServer wid "URL" "frame_path" Edit Validates the the hostname and port of the current document. Error messages are issued if differences are detected during playback.
PROF ValidateDocumentPartialURL wid "URL" "frame_path" Edit Validates the information in the current URL only for the number of characters extant in the URL string as shown in the command. Other information in the URL string of the actual page beyond that point is ignored. Error messages are issued if differences are detected during playback.

[ Top | Index ]

String Matching
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF MatchString wid "text" key ["frame_path"] Edit
Adaptive
Synchronization
DOM
Matches any non-zero-length text located anywhere within the current page and on the specified frame_path. . Note that this search will match any content on the page, whether visible or not.

The key can be one of two options (other values produce errors):
0 - Case Insensitive
1 - Case Sensitive

Error messages are issued if differences are detected during playback.
PROF MatchNotString wid "text" key ["frame_path"] Edit
Adaptive
Synchronization
DOM
Checks to confirm that any non-zero-length text is NOT located anywhere in the current page. Note that this search will match on (and hence FAIL) on any content on the page, whether visible or not.

The key can be one of two options (other values produce errors):
0 - Case Insensitive
1 - Case Sensitive

Error messages are issued if differences are detected during playback.

[ Top | Index ]

Monitoring Support Commands
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF SaveRecord File "Formatted String" [OVERWRITE] Edit Writes information to the named file based on the contents of the "Formatted String".

If the optional tag OVERWRITE is present, the named file is deleted (if it exists) and THIS is the first record in the new file.

Complete Command Explanation
Meaning of Parameters in Formatted String
  • %e is replaced by the elapsed cumlative time since the last instance of a SaveRecord command. Resets across CallScript boundaries.
  • %E is replaced by the elapsed cumlative time of the current playback. Resets across CallScript boundaries.

  • %f is replaced by the elapsed total time since the last ResetTimer command. Does not reset across CallScript boundaries.
  • %F is replaced by the elapsed total time of the current playback session. Does not reset across CallScript boundaries.

  • %k is replaced by the total number of bytes downloaded as a result of the last command completed that caused a download. Does not reset across CallScript boundaries.
  • %K is replaced by the total number of bytes downloaded so far in the current playback. Does not reset across CallScript boundaries.

  • \t is replaced by a tab character.
  • \n is replaced by a newline character.

  • In addition, all of the C runtime function strftime's formatting codes (see complete list below) are processed in the normal way, including for example:
    • %T is replaced by the current date/time in the format: YYYY/MM/DD HH:MM:SS.
    • %I is replaced by the current time in 12-hour format.
    • %Z is replaced by the current time zone abbreviation code (e.g. PDT).
PROF TimeStamp File "ID-Tag" "Message-Text" [OVERWRITE] Edit Writes a standard one-line current timestamp record to the named file. This line includes the specified "ID-Tag" and and includes the "Message-Text" at the end of the line.

If the optional tag OVERWRITE is present, the named file is deleted (if it exists) and THIS is the first record in the new file.

Detailed Explanation

[ Top | Index ]

Flag Processing Commands
All types of flags are processed "one time" only, and the sense of a "flag is thrown" is reset after the alternative processing occurs. Also, for example, , a second OnAlarmGoScript command in an execution sequence cancels the error state and this cancellation is reflected in the exit code for the run.

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF OnAlarmEmail "email-address" "subject" "message" "attachment-path" Edit
Flag
If an ALARM is issued during a script playback, eValid will immediately send an e-mail. Refer to Email for more information. Refer to Email for more information.
PROF OnAlarmGoScript "[PATH]script-name" Edit 
Flag
If an ALARM is issued during a script playback, eValid will immediately open a new script file and continue to play back with the new script. Note: Alarm STOP will override OnAlarmGoScript, but Alarm PAUSE will not.

After called script has finished playback, eValid will NOT return to the original script.

PROF OnAlarmSendFile "email-address" "subject" "filename" Edit
Flag
If an ALARM is issued during a script playback, eValid will immediately send the named file to the indicated email address. Refer to SendFile for more information.
PROF OnErrorEmail "email-address" "subject" "message" "attachment-path" Edit 
Flag
If an ERROR is issued during a script playback, eValid will immediately send an e-mail. Refer to Email for more information. Refer to Email for more information.
PROF OnErrorGoScript "[PATH]script-name" Edit
Flag
If an ERROR is issued during script playback eValid will immediately open the named script file and continue playback with that script. After called script has finished playback, eValid will NOT return to the original script.
PROF OnErrorSendFile "email-address" "subject" "filename" Edit
Flag
If an ERROR is issued during a script playback, eValid will immediately send the named file to the indicated email address. Refer to SendFile for more information.
PROF OnTimeoutEmail "email-address" "subject" "message" "attachment-path" Edit 
Flag
If a TIMEOUT is issued during a script playback, eValid will immediately send an e-mail. Refer to Email for more information. Refer to Email for more information.
PROF OnTimeoutGoScript "[PATH]script-name" Edit
Flag
If a TIMEOUT is issued during a script playback, eValid will immediately open a new script file and continue to play back with the new script. After called script has finished playback, eValid will NOT return to the original script.
PROF OnTimeoutSendFile "email-address" "subject" "filename" Edit
Flag
If a TIMEOUT is issued during a script playback, eValid will immediately send the named file to the indicated email address. Refer to SendFile for more information.
PROF OnWarningEmail "email-address" "subject" "message" "attachment-path" Edit 
Flag
If a WARNING is issued during a script playback, eValid will immediately send an e-mail. Refer to Email for more information. Refer to Email for more information.
PROF OnWarningGoScript "[PATH]script-name" Edit
Flag
If a WARNING is issued during script playback eValid will immediately open the named script file and continue playback with that script. After called script has finished playback, eValid will NOT return to the original script.
PROF OnWarningSendFile "email-address" "subject" "filename" Edit
Flag
If a WARNING is issued during a script playback, eValid will immediately send the named file to the indicated email address. Refer to SendFile for more information.
PROF OvertimeAlarm msec "text" "URL" "email" action Record
Edit
Flag
Available from the GUI during recording or editable, the user can establish a maximum time, specify an alarm message text, declare a URL to invoke on playback, and specify the action to be taken in case the alarm flag is thrown.

The action variable specifies what to do if the alarm flag is thrown: 0 = Stop playback; 1 = Pause (the user can resume playback manually); 2 = Continue playing the script.

During playback eValid issues an Alarm message with the specified text if the current elapsed time value exceeds msec milliseconds.

Alarm times are measured from the start of playback or from the last time a ResetTimer command was issued.

 

[ Top | Index ]

Dom-Based Sync Support
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
Strong Synchronization Commands (With Adaptive Playback)
PAGEMAP SyncOnSelectedObjProperty wid idx [["id_name"] "id_value"] DOM_name DOM_value "frame_path"


[1] SyncOnSelectedObjProperty wid idx DOM_name DOM_value "frame_path"

[2] SyncOnSelectedObjProperty wid idx "id_value" DOM_name DOM_value "frame_path"

[3] SyncOnSelectedObjProperty wid idx "id_name" "id_value" DOM_name DOM_value "frame_path"

Record
Edit
Adaptive
Synchronization
DOM
Waits for the value of the specified DOM_name property at index idx to take on the specified DOM_value.

This command uses the Retry Interval and respects the Maximum Retry Time settings values.

Playback resumes as soon as the match occurs, or after the maximum retry time has passed.

Please see the Complete Command Behavior Explanation.

Adaptive playback is applicable to this command, unless adaptive playback is turned OFF.

When adaptive playback is ON, then if the object at idx does not have an element with DOM_name, eValid will look elsewhere in the DOM tree for an object with the [unique] DOM_name, and then wait for that named element to take on the required DOM_value.

PAGEMAP SyncNotOnSelectedObjProperty wid idx [["id_name"] "id_value"] DOM_name DOM_value "frame_path"


[1] SyncNotOnSelectedObjProperty wid idx DOM_name DOM_value "frame_path"

[2] SyncNotOnSelectedObjProperty wid idx "id_value" DOM_name DOM_value "frame_path"

[3] SyncNotOnSelectedObjProperty wid idx "id_name" "id_value" DOM_name DOM_value "frame_path"

Edit
Adaptive
Synchronization
DOM
Performs the reverse of the above command, and playback continues when the first instance is found when the specified information is NOT true.

This command uses the Retry Interval and respects the Maximum Retry Time settings values.

Please see the Complete Command Behavior Explanation.

Adaptive playback is applicable to this command, unless adaptive playback is turned OFF.

When adaptive playback is ON, then if the object at idx does not have an element with DOM_name, eValid will look elsewhere in the DOM tree for an object with the [unique] DOM_name, and then wait for that named element to take on the required DOM_value.

Standard Synchronization Commands (Without Adaptive Playback)
PAGEMAP SyncOnElementProperty wid "name" "Value" "frame_path" Edit
Adaptive
Synchronization
DOM
Waits for a named element property to have a specified value. Playback continues when any element's specified property has the required value. Applies to ANY property of ANY element ANYwhere in the DOM.

Please see the Complete Command Behavior Explanation.

Adaptive playback does not apply.
PAGEMAP SyncNotOnElementProperty wid "name" "Value" "frame_path" Edit
Adaptive
Synchronization
DOM
Waits for a named element property and value to NOT be found -- anywhere in the DOM. Playback continues the first time that any element has the required property not equal to the required value.

Please see the Complete Command Behavior Explanation.

Applies to any property of any element anywhere in the DOM.

Adaptive playback does not apply.

[ Top | Index ]

Extracting DOM, Page, and Screen Content
These commands create local files that contain various parts of a screen. No validation of data is performed. If the file exists it will be overwritten.

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PAGEMAP SaveSelectedObjProperties wid idx count "filename" "frame_path" [ALL] Edit
DOM
Writes the contents of each DOM object for the indicated window from the specified index onward number objects into the named file. Dumps a specified number of HTML elements' properties, starting from the specified index "idx" (0 being the first element).

The parameter "count" denotes the number of elements to dump. All elements are dumped if the starting index is less than 0.

All elements starting from the starting index are dumped if "count" is less than 1. By default, only properties with non-blank values are saved.

To dump most(*) properties, specify the optional ALL parameter.

In standard eValid the saved file is in ASCII text form in a single-byte character set.

In the Unicode release of eValid this will be in a two-byte character set. The size of the character in bytes will be remarked within the header of the text file. The declaration of each HTML element starts with [Element #n], where n is the element's source index.

The properties are grouped together and each group is identified by a string enclosed in brackets, e.g. "[HTMLStyle]". Each property is declared and defined in the format:

  property_name:size=property_value

where,

"property_name" is the name of the property.
'property_value' is the value of the property.
'size' is the number of characters in 'property_value'.

(*) - Only obtainable properties are dumped. InnerHTML and OuterHTML properties are not dumped for obvious reasons.

 
PAGEMAP SaveHTML wid "filename" "frame_path" Edit
DOM
On playback, for the selected window the full HTML, or the full HTML for the selected frame, is saved in filename. This file will contain the "raw" HTML prior to internal processing.
PAGEMAP SaveFullHTML wid "filename" "frame_path" Edit
DOM
On playback, for the selected window the full HTML, or the full HTML for the selected frame, is saved in filename. The "full" HTML is extracted from the internal post-rendering image and it may differ in content and format from the contents of the raw, un-processed HTML.
PROF SaveMessage "filename" "message-text" [APPEND] Edit
DOM
Writes the specified message to the named file. If the optional APPEND argument is present in the command, the message is appended to the file. Otherwise the file is overwritten if it already exists, and created if it does not.  
PROF SaveSelectedText wid "filename" idx position length "frame_path" [APPEND] Record
Edit
DOM
On recording, the selected text from the page coordinates is copied into the specified filename.

On playback, for the selected window and the selected frame, the text at the specified idx, position, length, and frame is saved in filename.

If APPEND appears at the end of the command, the saved data will be appended to end of the file.

 
PROF SaveSelectedImage wid "unique-id" idx "frame_path" Record
Edit
DOM
At recording time, eValid saves the selected window in a file named "<testname>-R.<unique-id>.gif".

On playback, eValid saves the information in the same filename.

 
PROF CompareImages "base" "response" Edit
DOM
Compares two images saved locally. Writes OK to the EventLog if the images are identical or ERROR to the EventLog if they differ at all (even by one bit in one pixel).

The current working folder is assumed if no working folder path is provided.

An FAIL message is issued if eValid is unable to copy the source file.
PROF SaveVisibleText wid "filename" "frame_path" Edit
Desktop
DOM
On playback, for the selected window and on the selected frame, the visible text is saved in filename. The visible text is extracted from the internal post-rendering data and it may be formatted somewhat differently than it was in the raw HTML file.
PROF SaveWindow wid "uniqueID" Record
Edit
Desktop
On playback the screen shot of the entire window is saved in the file <script>-R.<uniqueID>.bmp, where script.evs is the name of the playback script file.  
PROF SaveWindowFace wid "uniqueID" Record
Edit
Desktop
On playback a screen shot of the indicated window face is saved in the file script-R.uniqueID.bmp, where script.evs is the name of the playback script file.  

[ Top | Index ]

Index Motion Commands
 

Working Assumptions About These Commands:
  • There is only one sourceIndex known to eValid at any time.
  • The sourceIndex is always an integer.
  • The initial value of the sourceIndex is always set to zero.
  • The value of the sourceIndex persists between pages.
  • Commands that use this [internally stored] sourceIndex value always refer to the current page.
  • eValid does not modify the sourceIndex except by action of the commands below.
  • Because motion on the page is from the perspective of the view, a search DOWN toward the bottom of the page means increasing index numbers, whereas a search UP toward the top of the page means decreasing index numbers.
  • If that's not confusing enough, maybe this will help (or not): if you go all the way UP on a page, you're at sourceIndex 0.
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PAGEMAP IndexElementClick wid "frame_path" [NAV] Edit
DOM
Similar to the Element Click command, this command issues a click at the current sourceIndex as set by a preceding IndexSet, IndexMove, or IndexFindElement command

The optional NAV parameter implies to expect navigation, and follows eValid's regular rules about how to handle NAVs.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

This command usually follows a search process, and sends a click to what is assumed to be an element that accepts a click meaningfully.

No adaptive playback activity is performed for this command.

PAGEMAP IndexElementEvent wid "event_name" "property_name" "property_value"
[ "property_name" "property_value" ] ... "frame_path" [NAV]
Edit This command involves specifying an event_name and a sequence of "property_name" "property_value" in pairs.

Complete details on how these parameters work are provided in the IndexElementEvent command description.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed.

Use the PageMap to identify index values and attribute names.

PAGEMAP IndexFindElement wid { UP | DOWN } "property_name" ["property_value"] "frame_path" Edit
DOM
Starting from the current sourceIndex, this command moves up or down in the DOM element index number sequence until eValid reaches the next element with a property of the specified "property_name" [or until it reaches the next element with a property of the specified "property_name" which has the specified "property_value"], or until eValid reaches the end [or beginning] of the page.

The index movement is either UP (increasing index numbers) initial index is positive or zero. of DOWN (decreasing index numbers).

When a match if found this command leaves the sourceIndex set to the index of the matching HTML element, if found. If no match is found, the sourceIndex will remain the same.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

This is a primary command in the Index Motion/Manipulation set. Use it to find where to take an action.

No adaptive playback activity is performed for this command.

PAGEMAP IndexFindElementEx wid { UP | DOWN } "string" [ "string" ] ... "frame_path" Edit Starting from the current sourceIndex, this command moves up or down in the DOM element index number sequence searching for a Regular Expression match.

For a complete explanation please see the Detailed Command Explanation.

This is a primary command in the Index Motion/Manipulation set. Use it to find where to take an action.

No adaptive playback activity is performed for this command.

PAGEMAP IndexFollowLink wid "frame_path" [NO_NAV] Edit
DOM
Similar to the FollowLink script command, the IndexElementClick employs the sourceIndex command issues a click at the current sourceIndex as set by a preceding IndexSet, IndexMove, or IndexFindElement command

Like the FollowLink command, a NAV is expected, hence there is only an optional NO_NAV parameter.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

This command usually follows a search process, and sends a click to what is assumed to be an element that accepts a click meaningfully.

No adaptive playback activity is performed for this command.

PAGEMAP IndexMove number Edit
DOM
Moves forward (positive number) or backward (negative number) the specified number of source index positions, possibly resulting in arriving at the top or bottom of page (but NOT wrapping around).

If an IndexMove command attempts to reach beyond the end of the page, or above the beginning of the page, the current index will be set to 0 and a Warning will be issued to the Event Log.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands

You will probably have to have a good idea of where your target is, or you may want to run an additional IndexFindElement command to reposition the current source index.

No adaptive playback activity is performed for this command.

PAGEMAP IndexSet idx Edit
DOM
Moves the internally remembered current index to idx.

  • idx = 0 for the first element of the page.
  • idx if you know the specific index you want.

An illegal value is corrected to 0 and a message is issued to the Event Log.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

Subsequent commands can be based on this starting index.
PAGEMAP IndexSetEnd wid "frame_path" Edit Moves the internally remembered current sourceIndex to the last (largest currently available) index in the frame of the specified window.

Note: If the page and frame changes the sourceIndex then may either be out of range or may not be the last one on the page.

On a page with multiple frames specifying the exact frame_path is necessary because the number of the last element varies with each frame.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

Subsequent commands can be based on this starting index.
PAGEMAP IndexSubmitClick wid "frame_path" Edit
DOM
Similar to SubmitClick command, with same parameters and meaning.

Clicks the button pointed to by the SourceIndex.

A navigation is expected to occur.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed for this command.
PAGEMAP IndexInputValue wid "type" "extra-1" "extra-2" "frame_path" [NAV] Edit
DOM
This is the "Index" version of the InputValue command. Behavior is similar to the InputValue command, with same parameters and meanings.

An optional NAV parameter specifies whether or not to expect navigation.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed for this command.

For a complete explanation of the extra-1 and extra-2 parameters please check the detailed explanation at: InputValue Processing in Playback.

PAGEMAP IndexValidateObjProperty wid "property-name" "expected-value" "frame_path" Edit Validates that on the current sourceIndex the property named takes on the specified value.

If the validation fails then an ERROR is logged in the EventLog.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed for this command.
PAGEMAP IndexSaveObjProperty wid "property-name" "filename" "frame_path" [APPEND] Edit On the current sourceIndex in the page, saves the the named property named to the specified filename. If the property does not exist, no action is taken.

If the optional APPEND argument appears the data is written to the end of the named file.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed for this command.
PAGEMAP IndexElementMouseOver wid x y "frame_path" [NAV] Edit At the current sourceIndex, executes a left-button MouseOver command.

The "x y" values specified are offsets within the object supplied by the DOM.

The optional NAV parameter needs to be specified if the action is expected to generate a navigation action.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed for this command.
PAGEMAP IndexElementMouseDown wid [x y] "frame_path" [NAV] Edit At the current sourceIndex, executes a left-button MouseDown command.

The optional [x y] values specified are offsets within the object that are supplied by the DOM.

The optional NAV parameter needs to be specified if the action is expected to generate a navigation action.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed for this command.
PAGEMAP IndexElementMouseUp wid [x y] "frame_path" [NAV] Edit At the current sourceIndex, executes a left-button MouseUp command.

The optional [x y] values specified are offsets within the object that are supplied by the DOM.

The optional NAV parameter needs to be specified if the action is expected to generate a navigation action.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed for this command.
PAGEMAP IndexElementMouseOut wid x y "frame_path" [NAV] Edit At the current sourceIndex, executes a left-button MouseOut command.

The "x y" values specified are offsets within the object supplied by the DOM.

The optional NAV parameter needs to be specified if the action is expected to generate a navigation action.

See the complete documentation of these commands at DOM Element Manipulation/Motion Commands.

No adaptive playback activity is performed for this command.

[ Top | Index ]

DOM Manipulation Commands

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PAGEMAP ValueSet value Edit Sets the elementValue to the specified value. The initial elementValue is blank.

Please see the DOM Value Manipulation Command Documentation.

PAGEMAP ValueGetElement wid name "frame_path" Edit Gets the value of the named element at sourceIndex and saves it in elementValue.

Details of the available names are usually found using the eValid PageMap facility.

If the object found at sourceIndex does not have the given name, or if name is correct and the value the name currently has is incorrect, or if name is not found, an ERROR results.

 

Please see the DOM Value Manipulation Command Documentation.

PAGEMAP ValuePutElement wid name "frame_path" Edit Inserts the current elementValue into the specific attribute of the described DOM object in the indicated frame (as specified by the frame_path).

Details of the available names are usually found using the eValid PageMap facility.

 

Please see the DOM Value Manipulation Command Documentation.

PAGEMAP IndexSave "filename" Edit Saves the sourceIndex into the specified filename. Please see the DOM Input/Output Operations Documentation.
PAGEMAP IndexRead "filename" Edit Reads the sourceIndex from the specified filename. If the file is empty, the sourceIndex is set to zero.

Please see the DOM Input/Output Operations Documentation.

PAGEMAP ValueSave "filename" Edit Saves the elementValue into the specified filename. Please see the DOM Input/Output Operations Documentation.
PAGEMAP ValueRead "filename" Edit Reads the elementValue from the specified filename. If the file is empty, the elementValue is set to blank.

Please see the DOM Input/Output Operations Documentation.

[ Top | Index ]

Applet Support

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF AppletMouseClick wid idx "jclass-name" x y "frame_path" Record
Edit
Desktop
Mouse Click on an applet  
PROF AppletMouseDown wid idx "jclass-name" x y "frame_path" Record
Edit
Desktop
Mouse Down on an applet  
PROF AppletMouseDrag wid idx "jclass-name" x y "frame_path" Record
Edit
Desktop
Mouse Drag on an applet  
PROF AppletMouseOver
wid idx "jclass-name" x y "frame_path"
Record
Edit
Desktop
Mouse Over on an applet  
PROF AppletNavigate
wid idx "jclass-name" "applet-frame"
"URL" "target-frame"
Record
Edit
Desktop
Navigate to a new HTML from an Applet  
PROF AppletTabStop
wid idx "jclass-name"
ShiftKey-status* "frame_path"
Record
Edit
Desktop
*ShiftKey-status: 0=Up, 1(or any non-zero value) = Down  
PROF AppletTextEntry
wid idx "jclass-name"
"text-to-enter" "frame_path"
Record
Edit
Desktop
Enter Text into an applet (Text Arena)  

[ Top | Index ]

Absolute Position Commands

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF clLClick wid x y time [NAV]
xyLClick wid x y time [NAV]
Record
Edit
Desktop
Record a Mouse Left-Button Click at an absolute coordinates relative to browser.
The coordinates used during recording are relative to the client window (inside the browser).
 
PROF clMouseOver wid x y xyMouseOver wid x y Record
Edit
Desktop
Record a MouseOver at absolute coordinates relative to the browser.
The coordinates used during recording are relative to the client window (inside the browser).
 
PROF clLDrag wid x y x1 y1 time [NAV]
xyLDrag wid x y x1 y1 time [NAV]
Record
Edit
Desktop
Record a Mouse Left-Button Drag at an absolute coordinates relative to browser.
The coordinates used during recording are relative to the client window (inside the browser).
 
PROF clRClick wid x y
xyRClick wid x y
Record
Edit
Desktop
Record a Mouse Right-Button Click at absolute coordinates relative to the browser.
he coordinates used during recording are relative to the client window (inside the browser).
 

[ Top | Index ]

ModalDialog (Modal Popup) Commands
Note: In these commands an instance of [wid] implies an optional window id. If this parameter is missing wid = 0 is assumed. This is used as the default to assure backward compatibility with existing V6 scripts.

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF ModalDialogEnter [wid] Record
Edit
Desktop
Sends an "Enter" key message to a Modal Dialog Modal dialog commands can be entered into the script from the Script Window
PROF ModalDialogSuppress { ALL | SOME | NONE } Edit  If set to ALL eValid suppresses any modal dialog window that pops up during playback. If set to SOME eValid suppress only "simple popups," i.e. those which require only one user input to click one button.  
PROF ModalDialogSpace [wid] Record
Edit
Desktop
Sends a "Space" key message to a Modal Dialog Modal dialog commands can be entered into the script from the Script Window
PROF ModalDialogTab [wid] ShiftKey-Status* Record
Edit
Desktop
Send a "Tab" key message to a Modal Dialog *Shift Key: 1=Down 0=Up Modal dialog commands can be entered into the script from the Script Window
PROF ModalDialogText [wid] "literal-text" Record
Edit
Desktop
Sends the literal-text string to a Modal Dialog. Modal dialog commands can be entered into the script from the Script Window
PROF ModalDialogUp [wid [Repeat]]
ModalDialogDown [wid [Repeat]]
ModalDialogLeft [wid [Repeat]]
ModalDialogRight [wid [Repeat]]
Record
Edit
Desktop
Arrow keys in Modal Dialogs. The optional Repeat argument specifies the repeat count to apply [as if "holding down" the key]. The default value if there is no Repeat parameter specified is 1. Modal dialog commands can be entered into the script from the Script Window
Note: To have a repeat count work correctly you will need to have specified a wid parameter.
PROF ModalDialogWait msecs Record
Edit
Desktop
During playback, waits msec milliseconds.

All wait times are multiplied by the current wait-time multiplier value (the default value of 1.0 implies 100% "TrueTime" playback).

Modal dialog commands can be entered into the script from the Script Window

[ Top | Index ]

Window Management

These eValid commands are produced when a recording involves multiple sub-browser or sub-windows in application mode

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF DWindowSet wid Title x y w h Record
Edit
Desktop
This command is added when there is a need to be able to record Windows applications within the desktop. This is extremely useful when there is an interaction between the browser and Windows Applications.  
PROF EWindowSet / Init wid Title x y w h Record
Edit
Desktop
Initiates a recording on the sub-window of eValid. This is usually used when a recording involves pop-up windows in the site which require the two windows to be able to communicate with each other.  
STAN FontSize N Record
Edit
Documents the current font size as an integer, N. On playback, eValid sets the font size to correspond to what was used during recording.  
STAN Maximize wid Edit
Desktop
Maximizes the eValid window with the window id 'wid'.  
STAN Minimize wid Edit
Desktop
Minimizes the eValid window with the window id 'wid'.  
STAN NewWindow URL seconds [ x y w h ] Edit
Desktop
Creates a new minimal eValid window of default size [or of specified width w and height h at location x y] that renders the specified URL. The window disappears automatically after seconds seconds [not milliseconds]. If time = 0 the window is persistent (but the user can close it).  
STAN Resize wid w h Edit
Desktop
Resizes the main frame to w, h (integers, representing screen pixels).

Does NOT reposition the window.

 
STAN Restore wid Edit
Desktop
Restores browser window to original size. Companion to Maximize and Minimize.  
STAN Reposition wid x y Edit
Desktop
Reposition the main frame to x, y (integers, representing screen coordinates).

Does NOT resize the window.

 
PROF ScreenSize W H Record
Edit
Desktop
Documents the screen resolution used when a recording is made. W and H are the screen width and height in pixels. If the screen resolution on playback is smaller than what was specified, and the script contains any "xy" commands, a WARNING message will be written to the log files noting that playback may not be successful.  
STAN SubWindowCloseAll Edit
Desktop
Closes all subwindows opened from the parent window, if any. The event log will show the names of windows closed, if any, but this command does not produce any flags.  
PROF WindowClose wid Record
Edit
A command which is recorded once eValid detects that the sub-window that has been previously launched has been or is attempting to close.  
PROFWindowPos wid x y w h Record
Edit
Desktop
A command which is recorded in the script once the sub-window is resized or moved to a different coordinate.  
PROF SubFrameSet wid "window title" Record
Edit
Desktop
A command which is recorded in the script once the sub-window is launched. A WARNING message is generated if the name of the sub-browser window identified does not match the name expected; noted by the window title parameter.
PROF clSaveScreenRect wid "uniqueID" width height x-offset y-offset "frame_path"

SaveScreenRect wid "uniqueID" width height x-offset y-offset "frame_path"

Record
Edit
Desktop
DOM
On playback, the indicated screen rectangle image is saved in the file script-R.uniqueID.bmp, where script.evs is the name of the playback script file.
he coordinates used during recording are relative to the client window (inside the browser).
 
PROF clValidateSavedScreenRect wid "uniqueID" width height x-offset y-offset "frame_path"

ValidateSavedScreenRect wid "uniqueID" width height x-offset y-offset "frame_path"

Record
Edit
Desktop
DOM
On playback, the indicated screen rectangle image is validated from the file script-R.uniqueID.bmp, where script.evs is the name of the playback script file.
he coordinates used during recording are relative to the client window (inside the browser).
 
PROF TouchFile "filename" Edit Creates the named file if it does not exist. Otherwise the file is touched. Current working folder is assumed, if no path is specified. An Error is issued if the specified file cannot be touched or created.

[ Top | Index ]

keyboard & Desktop Operations

KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF Copy wid Edit
Desktop
Simulates the effect of the user typing Ctrl+C.

Note: This command assumes that the user has, through separate means such as by Application Mode Recording, already highlighted something for the Copy command to act upon.

 
PROF Cut wid Edit
Desktop
Simulates the effect of the user typing Ctrl+X.

Note: This command assumes that the user has, through separate means such as by Application Mode Recording, already highlighted something for the Cut command to act upon.

 
PROF EnterKey wid "id" "frame_path" [NAV] Record
Edit
Types an ENTER key into the desktop. "id" is the string that identifies the HTML element about to receive the input. NAV appears if the typein causes a navigation to occur. Adaptive playback will apply if needed assuming that the element has a "id" tag. In this case eValid will type the Enter key into the object that has the closest matching "id".
PROF KeySys wid key_code sys_key_info repcnt [NAV] Record
Edit
Desktop
• key_code [number] = The ASCII code number of the key that to be pressed, e.g. 13=EnterKey, 09=TabKey, etc.

• sys_key_info [number] = Represents the state of the Alt, Ctrl, and Shift keys, as follows:


    01 = SHIFT
    02 = CONTROL
    03 = ALT

• repcnt [number] = repeat count for the key.

• [NAV] (optional constant) = If the key press starts a navigation the NAV parameter is added.

Will not be activated if there is no application in the browser
PROF KeyText wid "Text" Edit
Desktop
This can be used to replace the InputValue(n, TEXT,...) command if absolutely necessary.  
PROF Focus wid Edit Causes focus to be given to the named window, or to the named frame within the current window if a frame is specified.  
PROF Paste wid Edit
Desktop
Simulates the effect of the user typing Ctrl+V.

Note: This command assumes that the user has, through separate means such as by Application Mode Recording, already highlighted something for the Paste command to act upon.

 
PROF ScrollKey
"SCROLL-KEY"* repeat-count
"frame_path" frame-x-pos
frame-y-pos frame-width frame-height
Record
Edit
*SCROLL-KEY will be one of:
DOWN_ARROW
UP_ARROW
RIGHT_ARROW
PAGE_DOWN
PAGE_UP
HOME
END
 
PROF SpaceKey wid rep-count Record
Edit
Desktop
SpaceKey will simulate pressing the Space Bar on the keyboard rep-count times.  
PROF TabKey wid ["NEW_WINDOW_CONSTANT"] Record
Edit
Desktop
Types a TAB key into the desktop.  

[ Top | Index ]

External File Processing
KEY COMMAND SYNTAX PROPERTIES EXPLANATION COMMENTS
PROF CopyFile "source" "target" overwrite-key Edit Copies indicated source file to indicated target file. Set overwrite-key to 1 to overwrite an existing target file. Otherwise set overwrite-key to 0.

The current working folder is assumed if no path is provided. Stopping playback while a file is being copied cancels the operation.

A Fail message is issued if eValid is unable to copy the source file.
PROF DataSynthesisFile "Filename" Edit Performs data substitution on the current script using the values from the specified text file. Each line in the specified data synthesis file consists of variable declarations and its definitions for one playback in the script. Variable declarations begin with a dollar sign ($) and variable definitions begin with an equal sign (=).

For example, the line $first=john $last=doe defines two variables, $first and $last, with the values john and doe, respectively. Upon playback in "Synthesized Mode", any occurrences of the script $first will be replaced with the string john, and any occurrences of the script $last will be replaced with the string doe.

Full technical details.  
PROF EnvironmentVariableFile "Filename" Edit Performs data substitution on the current script using the values from the specified text file. The specified environment variables file consists of variable declarations and definitions that are to be applied to the script. Variable declarations begin with a dollar sign ($) and variable definitions begin with an equal sign (=) and end with a blank.

For example $first=john $last=doe defines two variables, $first and $last, with the values john and doe, respectively. At playback time all instances of $first are replaced with john and all instances of $last are replaced with doe.

Full technical details.  
PROF Email "email-address" "subject" "message" "attachment-path" EditSends the indicated message to the indicated email address. Attachment-path denotes the path of the file you want attached to the email. Leave it blank if no file is to be attached. You must configure your Email settings in the eValid Preferences before using this script command. Error message is issued if problems occur connecting to the mail server, or if the e-mail was not sent successfully.
PROF GetURL "URL" Edit Recorded when a ButtonClick or an AbsClick is performed during a recording and ignored on playback unless a "Serve URL" command is present in the script. NOTE: The recording process has been modified to not use this command directly. The command remains available for use in eValid if needed.
PROF PostURL "URL" Edit Recorded when a ButtonClick or an AbsClick is performed during a recording and ignored on playback unless a Serve_URL command is present in the script. NOTE: The recording process has been modified to not use this command directly. The command remains available for use in eValid if needed.
PROF RemoveFile "filename" Edit Removes the named file if it exists. The current working folder is assumed if no path is specified. An Error message is issued if eValid is unable to delete the file.
PROF SendFile "email-address" "subject" "filename" EditCreates an email message with the indicated subject, containing the contents of the named ASCII file, and sends it to the indicated email address.

This command can be used to collect results, e.g. logfiles, from remotely controlled tests in a common location, e.g. at the end of script playback.

Error message is issued if problems occur connecting to the mail server, or if the e-mail was not sent successfully.
PROF !filename
!filename|line
Edit This syntax can appear in those commands where a $NAME=value parameter can appear, namely: CallScript; GoScript; and _eValid commands.

In addition the !filename construction can appear as the argument of a -DATA switch in the command line interface.

The purpose of this structure is to pass values from the named file into the current command line. The initial "!" distinguishes this structure from a $NAME=value structure.

This structure is used when there are many $NAME=value parameters to assign, or if the $NAME=value parameters are arranged in a table of lines e.g. from a spreadsheet.

  • If !filename appears then filename specifies the actual path to the file, or the name of the local file, and the entire 1st line [or the only line] of the file is placed in the command.

  • If !filename|line appears then the contents of the numbered line in filename is used.

The !file[|line] structure cannot have unescaped blank characters; if blanks are required