|
|
Introduction
This page describes the interfaces between eValid and its local environment
and also describes how to activate eValid from the command line,
from a batch file,
or from eV.Manager.
You can execute eValid to play back a recording or a manually created script
using the following command line format that can override settings stored
in the registry:
Command Format
Switch processing is case-independent.
Switches can be preceded by either "-" (minus) or "/" (slash).
Some switches are order dependent;
e.g. the -B switch that names a script file for playback must be given before
any switches that affect processing of that script.
Important Note: When a Windows file path includes blanks you need express the path "inside quotation marks" ("like this").
| Command Line Codes | |
| Switch | Explanation |
| Batch Mode Operation Basics | |
| -B scriptfile.evs | Batch Mode Playback of Regular Script File. The eValid browser will run the named regular script and will close at the end of playback. |
| -B scriptfile.evl | Batch Mode Playback of LoadTest Script File. The eValid browser will run the named load test script and will close at the end of playback. eValid will automatially delete any prior LoadTest Monitor and will not create a performance chart. |
| -DATA "$NAME=value [$NAME=value]" |
Data Substitution Value Specifications.
A Data Substitution String in the command lines contains
one or more data substitute commands/pairs
of the form $NAME=value.
String substitutions are carried out on the script file before playback of the script. This switch must appear after the -B filename switch. |
| -DATASYN | Enable Data Synthesis on Command Line. Allows data substitution operations within the playback process using data from a specified Data Synthesis File. |
| -O | Remain Open After Playback. The -O switch instructs eValid to remain open at the end of playback. The -O switch must occur after -B scriptfile.evs. |
| -S | Suppress Modal Dialogs. The addition of the -S switch instructs eValid to suppress modal dialogs. The -S switch must occur after -B scriptfile.evs. |
| -I file | Interactive Mode. This switch activates eValid interactive mode, and names filename as the script file from which the interactive mode commands are to be read. This file must have at least one command it, so that eValid in interactive mode can open the file, read the command and execute it, and then release the file handle for the scripting environment to use. |
| -RT msecs | Runtime Time Maximum Switch.
This switch specifies the maximum permitted time for the eValid run in msecs.
When eValid's running time exceeds the the -RT value, eValid attempts to close itself cleanly (so that all of its work is done and all files are saved). If that does not succeed, and eValid is still running after 10 seconds more, then a second non-graceful attempt is made, and eValid is closed possibly non-cleanly (some of the work may be lost and some log files may be truncated). |
| -AGENT "user_agent_string" | User Agent String Switch. This switch specifies the User Agent String to use for this instance of the eValid browser. |
|
As a general safety precaution eValid does not create new folders from batch commands. You must make sure that the folder(s) needed for the filename you use already exist. References to files in folders that don't exist are ignored. These switches override the current registry-saved preferences (settings). If you don't have a log-file specified (e.g. EventLog) to be generated, then the switches have no effect for that log-file (i.e. -FE myfile will not produce myfile). | |
| Switch | Explanation |
| -LOG LogKey | LogKey Specification.
Specifies which of the four Log Files should be generated.
This switch is required if any of the log files is going to be generated.
The switches below specify the locations for the log files; otherwise the
log files are placed in the location specified by the settings.
The LogKey can be any combination of these letters: E = Event Log
A zero anywhere in the string will switch ALL the logs off.
|
| -FE file | Event Log Name Specification. Specifies the name of the event log file to be generated during eValid operation. |
| -FM file | Message Log Name Specification. Specifies the name of the message log file to be generated during eValid operation. |
| -FP file | Performance Log Name Specification. Specifies the name of the performance log file to be generated during eValid operation. |
| -FT file | Timing Log Name Specification. Specifies the name of the timing log file to be generated during eValid operation. |
| -FC file | Custom Log File Name Specification. Specifies the name of the timing log file to be generated during eValid operation. |
| -FS file | Playback Summary File Name Specification. Specifies the name of the playback summary file to be generated during eValid operation. |
| -CLFF file | Custom Log File Filter Name File. Specifies the name of the file to be used for filtering the Event Log into the Custom Log. |
| -CLCS [ Y | N ] | Custom Log File Filter Substring Search Switch. Specifies whether to perform a case-sensitive search [Y]. The default is case-insensitive [N]. |
| -FV | Auto View Event Log and Script File. Display the Event Log and Script File windows during current session. |
| -FF | Dynamic Log Naming.
If used in Batch Mode (-B), eValid will
name the log files based on the current system time in seconds.
For example, if the system time is 987654321 (millisecond resolution)
the resulting log file names would be:
e-987654321.log If used in LoadTest mode, the logs will be named by using the CommandID parameter as defined in the .evl file. For example, if the current line defines the CommandID as ID-1 the log file names would be: e-ID-1.log Note that if the CommandID is not defined, eValid will use the line number of the script to identify the log files. |
|
The -PI and -PJ switches allow the user to override the minimum and maximum values defined in Preferences. Care must be taken to ensure that reasonable values are set. If the value for any of the -PU, -PB, -PA, PH, PN, or -PV switch is not explicitly "Y" or "y" the value will default to "N/ (False | Unchecked). |
|
| Switch | Explanation |
| -PN [ Y | N ] | Playback Status Notification. Y = Yes / N = No. This is normally set through the Settings > Record/Play Preferences menu. |
| -PF number | Form Fill Delay Time Specification. This is the milliseconds of delay between actions on FORM fill ins. The default value is 1000. This is normally set through the Settings > Record/Play Preferences menu. |
| -PM number | Delay Multiplier Specification. This is the value by which all Waits are multiplied during playback. The default value is 1. This is normally set through the Settings > Record/Play Preferences menu. |
| -PC number | Wait Time Ceiling Specification. The maximum amount of user wait time, including effect of the delay multiplier. The default value is 10000 milliseconds, and is normally set through the Settings > Record/Play Preferences menu. |
| -PB [ Y | N ] | Audible Alerts (Sound Beeps on Alarm). Y = Yes / N = No. This is normally set through the Settings > Record/Play Preferences menu. |
| -PA [ Y | N ] | Append to Log Files. Y = Yes / N = No. This is normally set through the Settings > Record/Play Preferences menu. |
| -PH [ Y | N ] | Repair HTML on Error. Y = Yes / N = No. Applies only to files that use file://... in the address field. This is normally set through the Settings > Record/Play Preferences menu. |
| -PX number | Playback the current script file number times. This is normally set through the Settings > Record/Play Preferences menu. |
| -PL [ 1 | 2 | 3 ] | Level of Messages to Logs: 1 = Simple 2 = Standard 3 = Detailed. This is normally set through the Settings > Record/Play Preferences menu. |
| -PI number | Retry Interval for Validation of Screen Rectangle. The interval is expressed in milliseconds. This value is normally set through the Settings > Record/Play Preferences > Advanced Preferences menu. |
| -PJ number | Max. Retry Time for Validation of Screen Rectangle. The interval is expressed in milliseconds. This is normally set through the Settings > Record/Play Advanced Preferences menu. |
| -PR rate | Simulated Modem Rate.
This switch causes eValid to simulate playback
through a modem at a specified maximum transfer speed.
rate is an integer that declares,
in 1000s of bits per second (Kbps),
the desired modem rate.
Example: A 56,600 bps modem is specified with -PR 56.
The valid range for the Simulated Modem Rate is 1 to 1024. Values outside this range are ignored. The user must make sure that the Never Use Cache option is chosen; otherwise the results will likely be in error. During playback each event involving a complete download of a file has the total playback time padded by an amount such that the effective download speed is not greater than the specified Simulated Modem Rate. Illustration: Assuming that you have a web connection faster than conventional modem speeds, a page that downloads in 0.2 seconds, but which would take 1.0 sec to download at the -PR specified rate, would have a padding delay of 0.8 sec added to the playback. If the page actually downloads at a total time of 1.2 seconds, then no padding will be added (none is necessary). This value is normally set through the Settings > Record/Play Preferences menu. |
| -PT number | Maximum Download Time. In milliseconds, limited to 300,000. If not set, it will default to the value set in the Settings > Record/Play Preferences menu. |
| -PU [ Y | N ] | Minimize Log Messages for Screen Validation. Y = Yes / N = No. This is normally set through the Settings > Record/Play Advanced Preferences menu. |
| -PV [ Y | N ] | Draw Visible Outline. Y = Yes / N = No. This is normally set through the Settings > Record/Play Advanced Preferences menu. |
| Switches That Affect User Cache Management | |
| Switch | Explanation |
| -CI | Ignore Cache Specification. Ignore the cache during playback (delete all entries as they accumulate). This is normally set through the Settings > Cache Manager menu. |
| -CK | Empty Cache Before Playback. Empty the cache before playback begins. This is normally set through the Settings > Cache Manager menu. |
| -CU | Use Cache Specification. Always use browser cache. |
| Note: If more than one of the above switches are used the LAST one will take priority. (The earlier ones will be overwritten.) | |
| -CC [ Y | N ] | Keep Cookies Switch. If -CI or -CK (Ignore and Empty cache, respectively) is used, -CC will NOT delete/ignore cookies. Y = Yes / N = No. This value is normally set through the Settings > Cache Manager menu. |
| Switches That Affect Browser Window Positioning and Size | |
| Switch | Explanation |
| -WW number | Frame Width. Integer, greater than or equal to zero. If too small, the operating system imposes a minimum size. |
| -WH number | Frame Height. Integer, greater than or equal to zero. If too small, the operating system imposes a minimum size. |
| -WX number | X Coordinate. Integer, greater than or equal to zero. |
| -WY number | Y Coordinate. Integer, greater than or equal to zero. |
| Switches That Affect Folder Usage | |
| Switch | Explanation |
| -DD folder_name | Working folder Specification.
This switch specifies the absolute
or relative path name to use as the working folder.
NOTE: The parent and child scripts must be present in the path specified by the -DD switch or eValid will be unable to find them. NOTE ON COMPATIBILITY: The -d switch used in previous versions of eValid is still functional; -d == -DD |
| -D1 folder_name | Parent Folder Logs Specification.
This switch specifies
the absolute or relative path name to use
as the folder for the parent script's logs.
NOTE: If this option is not specified, the parent script logs will be written to the -DD specified folder, or, if that is not set, the folder specified in the Settings > Record/Play Preferences menu. NOTE: The parent script must be present in the same working folder as set by either the -DD switch or in the Settings > Record/Play Preferences menu. |
| -DW folder_name | Working Folder Specification.
This switch specifies the
path name to use as the base working folder, normally set through the
Settings > Record/Play Preferences menu.
NOTE: The complete working folder will be a combination of the base folder plus the project and group name. NOTE: This switch will override the -DD switch, regardless of the order passed in the parameter list. |
| -DP project_name | Project Name Specification.
This switch specifies the
Project Name, normally set through the
Settings > Record/Play Preferences menu.
NOTE: The complete working folder will be a combination of the base folder plus the project and group name. NOTE: This switch will override the -DD switch, regardless of the order passed in the parameter list. |
| -DG group_name | Group Name Specification.
This switch specifies the
Group Name, normally set through the
Settings > Record/Play Preferences menu.
NOTE: The complete working folder will be a combination of the base folder plus the project and group name. NOTE: This switch will override the -DD switch, regardless of the order passed in the parameter list. |
| Switches That Affect Profile Names | |
| Switch | Explanation |
| -UPM mapProfileName | Site Map Profile Name Specification.
This switch specifies the Profile Name to be used for eValid site mapping operations.
The Profile Name is established with the Settings > Profile action.
NOTE: Any switch appearing after the -UPM switch overwrites previous settings. |
| -UPR rec_playProfileName | Record Play Profile Name Specification.
This switch specifies the Profile Name to be used for eValid record/play
(functional test) operations.
The Profile Name is established with the Settings > Profile action.
NOTE: Any switch appearing after the -UPR switch overwrites previous settings. |
|
Switches That Affect Site Analysis in Batch Mode -MAPP, -MAPR, -MAPF are dependent of the -MAPB switch. -D3 is dependent on the -MAPF switch. Using the -B switch in conjunction with the -MAPB switch will cause the playback to fail; to perform a site analysis run after doing some functional playback commands, e.g. to complete a login sequence, use the &SiteAnalysis command. |
|
| Switch | Explanation |
| -MAPB url | Site Analysis Batch Mode. This switch activates the Site Analysis command built in eValid with the URL specified in the command line. |
| -MAPP profile_name | Profile Name Specification. Same as the -UPM switch above. |
| -MAPR report_value | Report Value Specification.
This switch is used to select the reports you wish to have generated.
The number used must be a value between 0 and 31,
composed of the sum of the indicated values.
+0 = No Maps [Binary: 00 000]Examples of Usage:
Note: The Popup Prompt for Map Types never shows in Batch Mode, so excluding this switch from the command line results in NO MAPS. |
| -MAPF base_file_name | Base File Name Specification.
This switch specifies the name to be used
when saving the reports generated by the Site Analysis. All reports are always saved to the eValid/Program/Docs/Session folder. Reports are named as follows (according to which ones are selected): Base_Name-status.html |
| -D3 folder_name | Folder Name Specification. This switch specifies the folder where the base file name specified will be saved. Using this command without the -MAPF switch will not produce any result. |
|
These switches allow batch mode creation of standard test records. These records are appended to a file after each complete eValid playback. | |
| Switch | Explanation |
| -SUM filename | Standard Test Record Filename Specification. Instructs eValid to place standard test records in the named file. Records are appended to the file at the end of each playback. |
| -SEP character | Specifies the separation character [character string] to be used in the standard test record. |
| -Minimize | Minimize Option. Open eValid minimized. This is used when you want to have a run made without showing the eValid browser face unnecessarily. |
|
These switches allow batch mode operation of eV.Manager with commands of the format. | |
| Switch | Explanation |
| -RUN number | Run Number Specification. Runs the currently selected test suite [specified in the default EVM] the specified number of times. |
| -Q | eV.Manager Run Termination Option. Instructs eV.Manager to quit after all of the specified tests have been run. Requires use of the -RUN switch. |
| -RT msecs | Runtime Time Maximum Switch.
This switch specifies the maximum time eV.Manager can run, in msecs.
When eV.Manager's running time exceeds the the -RT value, eV.Manager attempts to close itself cleanly (so that all of its work is done and all files are saved). If that does not succeed, and eV.Manager is still running after 10 seconds more, then a second non-graceful attempt is made, and eV.Manager is closed possibly non-cleanly (some of the work may be lost and some log files may be truncated). |
|
These switches are used by eValid to communicate to eValid, eValidT, or eVlite during a load test run. As a user you should not use these switches. They are documented here for reference. | |
| Switch | Explanation |
| -LCID UserID | User Identifier. This string is used to associate data during a LoadTest run for min/average/max values on the timing chart. |
| -LFILE Filenamwe | LoadTest Log Filename. This specifies the name of the LoadTest logfile. |
| -LDSS "$Name=Value, [$NAME=Value]" | Name Value Pairs. The specified $Name=Value pairs are used to substitute in the named script file. |
| Alphabetic Index Of Command Line Switches | ||
| -AGENT user_agent_string
-B scriptfile.evs -CC [Y | N ] -CI -CK -CU -CLFF -CLCS -D1 folder_name -D3 folder_name -DATA "$NAME=value..." -DATASYN -DD folder_name -DG group_name -DP project_name -DW folder_name -FC file -FE file -FF -FM file -FP file | -FS file
-FT file -FV file -I file -LCID -LDSS -LFILE -LOG -MAPB url -MAPF base_file_name -MAPP profile_name -MAPR report_value -Minimize -O -PA [ Y | N ] -PB [ Y | N ] -PC number -PF number -PH [ Y | N ] -PI number -PJ number | -PL [ 1 | 2 | 3 ]
-PM number -PN [ Y | N ] -PR rate -PT -PU [ Y | N ] -PV [ Y | N ] -PX number -Q -RUN number -RT msecs -RT msecs (Manager) -S -SEP character -SUM filename -UPM mapProfileName -UPR rec_playProfileName -WH number -WW number -WX number -WY number |
