Skip to content

Running WebLOAD from the Command Line

You can run the following WebLOAD components from the command line:

  • WebLOAD License – You can register and update your WebLOAD license.
  • WebLOAD Console – You can launch a WebLOAD test that invokes the WebLOAD Console and runs a specified test according to the specified parameters.
  • WebLOAD Analytics – You can launch WebLOAD Analytics and generate a report for a specified session, then publish or print it.
  • WebLOAD Recorder – You can launch a WebLOAD Recorder test that invokes the WebLOAD Recorder and runs a specified test according to the specified parameters.

Registering and Updating your WebLOAD License through the CLI

You can register or upload a WebLOAD license through a command line interface. You can enter the WebLOAD Update License command into a batch file or into an external script and it will run directly, without user intervention, using the parameters specified.

To register or update you WebLOAD license through the command line interface:

Enter the wlUpdateLicenseApplicationCmd command together with the optional parameters (described below) into your external script, to automatically launch a WebLOAD License action.

Syntax

Use the following syntax to define the parameters for registering or updating a WebLOAD license through a command line interface:

wlUpdateLicenseApplicationCmd {-help}|{-info}|{-free}|{-file ``*license\_file*}|{-server *server\_address*}|{-hostid}

Parameters

Parameter Description Comments
-help Display all available command parameters and their syntax.
-info Display the full license details of the installed license.
-free Create and install a license for a free WebLOAD version. This version provides 50 virtual clients, and is available for an unlimited period of time. You can use the free WebLOAD edition immediately after running this command.

-file

license_file

Install the specified license file, which you received from RadView (refer to the WebLOAD Installation Guide for further explanations). If license registration is successful, a confirmation appears in the command-line output. You can then begin working with WebLOAD.

- server

server_address

Connect to the WebRM server, whose address is the specified IP address. This option is relevant if you installed a WebRM server. For further explanations, refer to the WebLOAD Installation Guide.
-hostid Display the host ID of the computer. This information is needed if you wish to receive a WebLOAD license file from RadView. For further explanations, refer to the WebLOAD Installation Guide.

Examples

Example 1:

wlUpdateLicenseApplicationCmd -info

This command provides as output the license information.

Example 2:

wlUpdateLicenseApplicationCmd -file webload.lic

This command uploads the specified license file, and installs it. Following successful installation, you can begin working with WebLOAD.

Running a WebLOAD Console Test through the CLI

You can perform load testing through a command line interface. You can enter the WebLOAD Console launch command into a batch file or into an external script and WebLOAD Console will run directly, without user intervention, using the parameters specified.

To run WebLOAD Console through the command line interface:

Enter the WebLOAD.exe command together with a series of optional parameters (described below) into your external script to automatically launch a WebLOAD test. When your script runs, the executable file will invoke WebLOAD Console and run the specified test according to the specified parameters.

Note: Verify that the script used with the template specified, and any included files, are accessible to the Load Template or Load Session file that will be run.

Syntax

Use the following syntax to define the parameters for running a WebLOAD test through a command line interface:

WebLOAD.exe [<file name to open>][] [<flags>]

Parameters

Parameter Description Comments
File name to open The name of the *.tpl or *.ls file (Load Template or Load Session file) to run. Optional parameter
File name to save The name of the *.ls file containing the test data. This file will be saved in the current directory unless otherwise specified. Optional parameter
Flags

- /ar – Automatically run the WebLOAD test without waiting for user input. If this flag is not specified, the Console is called up with the specified Load Template/Load Session but the test is not automatically run. The system waits for user input.

- /ar <*time*> – Automatically run the test for the length of time specified in <time>/

- /vc – The number of Virtual Client licenses to allocate when using WebRM License Server.

- /pc <num>– The number of Probing Client licenses to allocate when using WebRM License Server.

- /rc <*results\_file\_name*> – Place the results in the specified file (an XML file).

- /ag <script name> - The name of an existing script (*.wlp) to open.

Optional parameter

The parameters are all optional. If no parameters are entered, the executable launches the Console and does not run a test. If the autorun flag </ar> flag is not set, the

<file name to save> and the <time> parameters are ignored.

Note: If there is a conflict between the time defined in this command and the time defined in the WebLOAD Scheduler, the load test runs for the shorter of the two periods defined.

Examples

Example 1

WebLOAD.exe test1.tpl

This command opens the Console and the test1.tpl template. The Console waits for user input.

Example 2

WebLOAD.exe test1.tpl march9.ls /ar 30

This command opens the Console and automatically runs a test using the test1.tpl template file. The test results are saved in the Load Session file march9.ls, which includes all of the test data and results. This file is saved in the current directory, unless otherwise specified. The autorun flag is set, meaning that the test runs without user intervention. The test will run for 30 seconds.

Example 3

WebLOAD.exe /ag c:\agendas\MyAgenda.wlp

This command opens the Console and the WebLOAD Wizard to the script/Mix Selection dialog box. The MyAgenda.wlp script is automatically selected and the WebLOAD Wizard waits for user input.

Example 4

WebLOAD.exe test1.tpl march9.ls /ar 30 /rc result1.xml

This command performs all the actions described in Example 2 above, and in addition the execution return code is saved in result1.xml.

Example 5

WebLOAD.exe test1.tpl march9.ls /ar 30 /vc 100 /pc 3

This command performs all the actions described in Example 2 above, and in addition it allocates 100 virtual clients and 3 probing clients from the WebRM server.

Generating an Analytics Report through the CLI

WebLOAD Analytics can be executed in command line mode. This enables incorporating WebLOAD Analytics in scripts. Two executables are available:

  • WLAnalyticsCMD.exe – Automatically generates a report for a specified session, and publishes or prints it. WebLOAD Analytics then closes.
  • WLAnalytics.exe – Launches the WebLOAD Analytics UI, and generates a report for a specified session.

The executables are located in <Installation dir>\bin. For example:

C:\Program Files\RadView\WebLOAD\bin.

Running WLAnalyticsCMD.exe

Use this executable to generate a report for a specified session, and publish or print it.

Syntax

WLAnalyticsCmd.exe –m U|P {-t template_path}|{-p portfolio_path}

{-s session_name}|{-ls session_path} [-f DOC|ODT|HTML|XLS|RTF|PDF] [-l report_location] [-n output_report_name] [-h]

Parameters

ParameterDescriptionComments
-m

Indicates the action. Specify one of the following

U – Publish.

P – Print.

Mandatory parameter.
-t template_path

Generates a chart from a specified template.

You must specify the path to the template directory (either absolute or relative to the gallery).

You must specify one of the two options:

-t or –p.

-p portfolio_path

Generates a report from a portfolio.

You must specify the path to the portfolio directory (either absolute or relative to the Portfolio category).

-s session_name

Specifies a session already loaded into WebLOAD. You must specify the session name.

Note: You can use this parameter multiple times to specify multiple sessions. This is necessary if you are generating a regression chart.

You must specify one of the two options:

-s or –ls.

-ls session_path

Specifies a load session file to import into WebLOAD.

You must specify the full path.

Note: You can use this parameter multiple times to load multiple sessions. This is necessary if you are generating a regression chart.

-f

Specifies the output format for a published report. Select one of the following: DOC, ODT, HTML, XLS, RTF, or PDF.

If you do not specify an output format, the default format, specified in Analytics Preferences, is used.

Optional parameter.
-l report_location

Specifies the location of the published report.

If you do not specify a location, the default location, specified in Analytics Preferences, is used.

Optional parameter.

-n

output_report_name

Specifies a name for the newly created report. If you do not specify a name, the application provides a default name.Optional parameter.
-hDisplays the help.Optional parameter.

Note: Note that you must specify:

  • Publish or print.
  • A template or portfolio.
  • A session, either previously loaded or to be imported.

Examples:

Example 1:

To load the mysession.ls Load Session, generate a ‘General/Load Size Summary’ chart, and publish it in the default file format, in the default location, under the name test-report:

WLAnalyticsCmd.exe -m U -t "General\Load Size Summary" -ls "C:\mysession.ls" –n "test-report"

Example 2:

To use the loaded first-session Load Session, generate a ‘Summary Portfolio’ portfolio, and print it:

WLAnalyticsCmd.exe -m P -p "Summary Portfolio" -s “first- session"

Example 3:

To use the loaded first-session and second-session Load Sessions, generate a ‘Regression/Load Size Summary’ regression chart, and publish it as a PDF file in C:\myreports, using a default name:

WLAnalyticsCmd.exe -m U -t "Regression\Load Size Summary" -s

“first-session" -s "second-session" –f PDF –l “c:\myreports”

Running WLAnalytics.exe

Use this executable to open the WebLOAD Analytics UI, and open a report or generate a report for a specified session.

Syntax

**WLAnalytics.exe** {**-t** *template\_path*}|{**- p** *portfolio\_path*}

{**-s** *session\_name*}|{**-ls** *session\_path*} [**-h**] [**-noSplash**]

Parameters

ParameterDescriptionComments
-t template_path

Generates a chart from a specified template.

You must specify the path to the template directory (either absolute or relative to the gallery).

You must specify one of the two options:

-t or –p.

-p portfolio_path

Generates a report from a portfolio.

You must specify the path to the portfolio directory (either absolute or relative to the Portfolio category).

-s session_name

Specifies a session already loaded into WebLOAD. You must specify the session name.

Note: You can use this parameter multiple times to specify multiple sessions. This is necessary if you are generating a regression chart.

You must specify one of the two options:

-s or –ls.

-ls session_path

Specifies a load session file to import into WebLOAD.

You must specify the full path.

Note: You can use this parameter multiple times to load multiple sessions. This is necessary if you are generating a regression chart.

-hDisplays the help.Optional parameter.
-noSplashLaunches without a Splash screen.Optional parameter.

Note: Note that you must specify:

  • A template, report, or portfolio.
  • A session, either previously loaded or to be imported.

Examples

Example 1:

To open the WebLOAD Analytics UI, load the mysession.ls Load Session, and generate a ‘General/Load Size Summary’ chart:

WLAnalytics.exe -t "General\Load Size Summary" -ls "C:\mysession.ls"

Example 2:

To open the WebLOAD Analytics UI, use the loaded first-session Load Session, and generate a ‘Summary Portfolio’ portfolio:

WLAnalytics.exe -p "Summary Portfolio" -s “first-session"

Running WebLOAD Recorder Testing through the CLI

You can initiate WebLOAD Recorder testing directly through the CLI. You can enter the WebLOAD Recorder launch command into a batch file or into an external script and WebLOAD Recorder will run directly, without user intervention, using the parameters specified.

To run WebLOAD Recorder testing through the CLI:

Enter the webloadIDE.exe command together with a series of optional parameters (described below) into your external script to automatically launch a WebLOAD Recorder test. When your script runs, the executable file will invoke WebLOAD Recorder and run the specified test according to the specified parameters.

Syntax

Use the following syntax to define the parameters for running a WebLOAD Recorder test through a Command Line Interface.:

webloadide.exe [<flags>][] [<session name to save to>][]

To run more than one session, append all relevant parameters at the end of the syntax. See examples 2 and 3 in Examples .

Parameters

When running a test invoked by the executable, you can specify the following parameters:

Parameter Description Comments
Flags

/a - auto run

Automatically run the WebLOAD Recorder test without waiting for user input. If this flag is not specified, WebLOAD Recorder is opened with the specified project / session but the test is not automatically run. The system waits for user input.

Optional parameter
Project or session name to open The name of the .wlp file or .wls file (Project file or Session file) to run. Optional parameter
Session name to save to The name of the .wls file containing the test data. This file will be saved in the current directory unless otherwise specified. Optional parameter
Number of rounds to run The number of iterations to run during runtime. The default value is 1. Optional parameter

The parameters are all optional. If no parameters are entered, the executable launches WebLOAD Recorder and does not run a test. If the autorun flag flag is not set, the < Session name to save to >, and the < Number of rounds to run > parameters are ignored.

Examples

Example 1:

webloadide.exe test1.wlp

This command opens WebLOAD Recorder with the test1 project file and waits for user input.

Example 2:

webloadide.exe /a test1.wlp test2.wlp 3

This command:

  • Opens WebLOAD Recorder and automatically runs a test using the test1.wlp project file.

  • Runs the project for three iterations.

  • Saves the test results in the WebLOAD Recorder session file test1.wls, which includes all of the test data and results.

Example 3:

webloadide.exe /a test1.wlp test1.wls 3 /a test2.wlp test2.wls 2

This command:

  • Opens WebLOAD Recorder and automatically runs a test using the test1.wlp project file.

  • Runs the project test1.wlp for three iterations.

  • Saves the test results in the WebLOAD Recorder session file test1.wls, which includes all of the test data and results.
  • Opens the WebLOAD Recorder project file test2.wlp.
  • Runs the project test2.wlp for two iterations.
  • Saves the test results in the WebLOAD Recorder session file test2.wls, which includes all of the test data and results.