Академический Документы
Профессиональный Документы
Культура Документы
Software
for
User's Manual
Version 1.1.1.32 for Windows Mobile and Windows-32, 26.Jan.2011
Chapter
Introduction
This manual tries to give an introduction to the functionality and the features of the
PocketOptimizer software. You should read this manual carefully if you are not familiar with the
tool. If youre already comfortable with the functionalities and the workflows, you might need the
technical documentation in chapters 4 and 5.
Introduction
Introduction
v1.0.5.2 - 24.Jun.2008
new text metric 127: sysinfo (output of AT^SYSINFO command)
improved HTTP href parsing
removed unit 'dBm' from signal level (text metric 123)
v1.0.5.1 - 28.May.2008
added host name in HTTP GET
added common metrics for RAS connections
fixed byte counters in sniffer analysis
v1.0.5.0 - 02.Apr.2008
changed delays from sec to ms in front end
changed device ID for Windows Mobile 6
v1.0.4.0 - 20.Jan.2008
bugfix: cmd_autoclose didn't work
v1.0.3.0 - 14.Nov.2007
Sniffer support for Win32: Microsoft's NetCap is supported to record the traffic during
measurements
decoder support for Win32: TShark.exe is supported to decode netcap/ethereal capture file
during measurements
new KPIs for TCP sessions: an integrated TCP stream analyzer decodes the capture files and
calculates important performance indicators
reporting/synchronization has been moved to a separate window
v1.0.2.4 - 14.Oct.2007
additional garbage collections during measurement
v1.0.2.3 - 03.Oct.2007
added parameter Report-Oldfiles to global job section to transmit pending reports
v1.0.2.2 - 25.Sep.2007
added parameter Ras-Wait to RAS section (additional delay before RAS)
added command line arguments for Win32 edition
v1.0.2.1 - 16.Sept.2007
added periodic garbage collection during ICMP measurements to prevent resource outage due
to problems in .NET framework 1.1
v1.0.2.0 - 05.Sept.2007
added unit information to XML tickets
changed UDP throuput KPI in XML tickets from byte/s to bit/s
added exclusion of packets from ICMP statistics (parameter Ping-DontAverage)
added 10 sec throughput average for HTTP and FTP and RTT average for ICMP in real time
status
added minimum RTT for FTP measurements to log files
changed FTP result user-data-rate to session-data-rate in log files
added FTP measurement timeout (parameter Ftp-Meas-To)
added mobile status information to log files and XML tickets (Win32 only)
better loop information during job execution
improvements in timeout handling for serial connections
v1.0.1.3 - 29.Oct.2006
Increased timeout from FTP '226 Transfer complete' until sending ABOR to 10 seconds
added new text metrics 104 (IP address) and 105 (job measurement time)
fixed job issue: global parameter Pause was not used up to v1.0.1.2
v1.0.1.2 - 12.Oct.2006
Modifications in GPS support for Pocket PC
fixed RAS connection issues: don't force RAS disconnection for successive iterations
v1.0.1.0 - 4.Oct.2006
added GPS support
changed reporting of RAS parameters and added new text metrics
v1.0.0.8 - 13.June.2006
changed UDP measurement algorithm
changed FTP thread start to fix asynchronous received issues
v1.0.0.7 - 5.May.2006
improvements in algorithms and log files for UDP measurement
added socket buffer of 512 kB for UDP measurements
fixed access violations in UDP measurement timer routine
PocketOptimizer 1.1.1.32 26.Jan.2011
Introduction
v1.0.0.6 - 4.May.2006
close HTTP sockets with keep-alive
v1.0.0.5 - 2.May.2006
support for HTTP connection keep-alive
v1.0.0.4 - 10.Apr.2006
fixed FTP roundtrip time calculation
added follow http image checkbox and Http-Follow parameter
v1.0.0.3 - 26.Feb.2006
changed KPI523 from byte/s to bit/s
occasional access violations in RAS setup fixed
v1.0.0.2 - 26.Nov.2005
Mobilkom Austria maintenance release
support for Pocket PCs without unique id
some minor fixes and improvements
v1.0.0.0 - 21.Nov.2005
Mobilkom Austria final release
v0.0.3.0 - 18.Nov.2005
Mobilkom Austria final acceptance pre-release
v0.0.2.8 - 14.Nov.2005
Mobilkom Austria pre-release
Introduction
Chapter
Installation
This chapter covers the installation of PocketOptimizer on Windows Mobile and Windows 32
platforms.
Installation
C:\Program files\PocketOptimizer.
Installation
You have to pass the Machine Id either to a license server or to your license administrator. Please
refer to the next chapters for details.
Installation
To submit or create a registration request, use the function Send a registration request and click
Proceed.
Enter your company name and address, user name and e-mail address. An information e-mail will
be sent to this address when the registration server's database has been updated to provide you
with unlocking data.
Click Proceed to move to the request sheet. This sheet provides some additional input fields that
might or might not be applicable for you:
License: Select Purchased or Evaluation of you have already purchased a license or are
requesting an evaluation license.
Request: This field influences how the registration server will process your request:
o Extend active registration ... This is the default value. If an unlock item is existing in the
license server's database, you will immediately provided with the unlocking data. Otherwise
the data is forwarded to a sales representative or license administrator.
o Manually check my request ... In this case the server does not provide you with unlocking
data automatically, instead your request is always forwarded to sales representative or
license administrator. Use this function if you changed input fields or need a different
license type.
o Unlock code does not work ... This case is similar to the previous one, but the request is
forwarded to our support team.
Vendor: Enter your vendor code if you purchased the software from a reseller. Otherwise leave
the field empty.
Offer No: Enter your software vendor's offer number if you have received different offers with
different software features. Leave the field empty if you only have one offer or are requesting
an evaluation license.
Agent Id: If you want to use a special agent id (e.g. if you want to re-use an Id), enter it here.
Agent Pool: If your company uses different pools of agent Ids (e.g. for different departments),
you can enter the required pool name here.
Message: Use this field to provide a message to your sales representative or license
administrator.
Please ensure your machine is connected to the internet and use the button Send requ. to submit
the request to the license server. If an existing unlock item is found in the database, you will
immediately provided with the unlock data, otherwise you will be informed that the request will be
processed. Usually the unlock information should be available within 15..30 minutes. If required
close PocketOptimizer while waiting for the unlock data, your input will be saved for further use.
If it is not possible to send the data directly, use the button Save... to save the license request to a
file and send this file to your sales representative or license administrator via e-mail.
Fetching the unlock data
You will be sent an e-mail when your registration has been processed.
To fetch the license data from the server, simply submit the license request again without
changing any information on the Licensee sheet. Please ensure that you use the request Extend
active registration, otherwise the server will not provide the unlock data.
PocketOptimizer 1.1.1.32 26.Jan.2011
Installation
If unlock data is available on the server, the unlocking data is automatically inserted into the input
fields.
Check the option I accept the license terms if you agree to the license terms and use the button
Register to save the registration information.
Installation
http://www.i-qos.com/config/po/demo
Alternatively it is possible to directly enter the URL before starting the synchronization.
logs
jobs
reports
archive
sniffer
To change the directories, overwrite the corresponding values. When starting with a backslash, the
directories are absolute (e.g. \CF Card\logs) other directories are relative to the installation
directory.
10
Installation
GPS before RAS: The GPS connection is opened prior to the establishment of a RAS
connection. This mode is similar to the previous mode, the GPS location will be stored once in
the log files and reported in the measurement ticket.
GPS continuous: The GPS connection is opened during the measurement. The GPS location will
be stored for every record in the log files and reported in the measurement ticket.
The button Start can be used to start the GPS background thread or re-start it with new
parameters.
The control GPS status shows GPS information for diagnostic purposes.
the first line displays the current status (either GPS data valid or some error information)
the second line displays the GPS UTC time, latitude, longitude and the number of satellites.
the next three lines contain the last three GPS messages from the receiver.
The main GPS status is displayed in the upper right corner of the GPS and the User data tab
sheets.
A green GPS symbol means that GPS data is valid.
A yellow GPS symbol indicates that GPS data is received but not valid.
A red GPS symbol shows that no GPS data is received or the connection could not be
established.
GPS issues on Pocket PC
This section describes some special issues for Bluetooth GPS receivers on Windows Mobile 2003.
These issues have been noticed with this particular edition of Windows CE but can occur on other
versions, too.
The main problem on this platform is that only one serial port for outgoing serial connections is
available and this port is not directly mapped to a device. The port can be determined in the
Bluetooth configuration as shown below. If the application connects to the virtual serial port,
Windows CE blocks this call and prompts the user to select the device as shown in the second
screenshot. The background GPS thread is blocked in this situation and PocketOptimizer cannot be
terminated. After selecting a device, Windows tries to connect to the device (blocking the GPS
thread). On success the port is opened and the background thread will continue execution.
Otherwise an error message as shown in the third screenshot is displayed (again blocking the
background thread).
11
Installation
If another window or PocketOptimizer is moved to the foreground it might happen that one of the
Bluetooth windows is not visible but still blocks the GPS background thread.
In order to use Bluetooth GPS receivers you will have to
manually select the GPS receiver if Windows prompts you.
manually acknowledge Bluetooth error messages.
If you experience problems with the GPS background thread please
check if background windows are requiring user input.
try to manually connect to the GPS receiver with the Bluetooth manager.
try to disable Bluetooth.
12
Installation
Chapter
Operations Manual
This section describes how to use PocketOptimizer.
The first four edit controls are for informational purposes and for reporting only. The information is
stored in the log files and in XML reports but not required by PocketOptimizer.
User name is stored in the log files and reported as text metric (Id 301) in the XML report.
Location is stored in the log files and reported as text metric (Id 302) in the XML report.
Alternatively the location can be derived from GPS coordinates (see the /autolocation command
line argument).
Cell ID is stored in the log files and reported as text metric (Id 303) in the XML report
The list of operators is fetched from the system configuration file. The selected value is stored
in the log files and reported as text metric 300 in the XML report. Alternatively it can be
derived from the mobile's MSISDN (see the /autooperator command line argument).
Use the combo box to select the RAS connection to be used or select <none> if you want to use a
LAN or a user managed RAS connection.
The combo box will contain Huawei NDIS connections in the Win32 edition if the API dll ndisapi.dll
is installed into the application directory (i.e. into the same directory as PocketOptimizer.exe). For
legal reasons the file cannot be delivered in the setup package.
13
Operations Manual
The interactive measurements can be accessed via the main menu entry Interactive.
HTTP measurements support downloads from standard HTTP servers.
FTP measurements allow download and upload measurements from/to standard FTP servers.
ICMP measurements allow Ping measurements to any machine answering Ping requests.
UDP measurements can be used for UDP stream analysis with a special UDP data generator
(NDFA server).
Job measurements can be accessed via the main menu entry Jobs.
The menu item Jobs contains the functions to execute pre-defined measurement jobs.
The menu item Sync and Reporting contains functions for synchronizing the configuration and
jobs from a central server, and to transmit pending reports.
Online help can be accessed in all screens with the menu entry Help.
The menu item Exit terminates the application.
Use the profile combo box to select a pre-defined profile either from the system or the user
configuration file to load the profile's values.
o The ellipsis button (...) opens the profile manager. Use this function to save your settings
to a user defined profile and to manage your profiles.
Use the custom URL text field to enter a custom URL or use the ellipsis button (...) to view a
history of URLs.
Uncheck the checkbox follow image tags to deactivate the download of embedded image files.
Specify the maximum number of TCP connections for HTML downloads. This parameter will
only be used for text/html files containing images (<img src> tags) if follow image tags is
enabled.
A number of repetitions and the pause between those repetitions can be specified with loops
and delay.
The checkbox act/deact RAS connection in every loop specifies if the RAS connection will be
closed and re-opened in every loop iteration or if the same RAS connection will be used for all
measurements.
PocketOptimizer 1.1.1.32 26.Jan.2011
14
Operations Manual
The checkbox logfile has to be checked if the measurement's log file is to be saved in the log
file directory.
The checkbox sniffer activates a third party packet sniffer.
Hit the button Start to start the measurement or proceed to the next tab sheet to configure
advanced parameters.
HTTP Advanced parameters
This tab sheet contains some advanced HTTP measurement parameters.
The checkbox use prelod URL has to be checked if a preload URL has to be downloaded prior
to the measurement. The preload URL will be loaded once after a RAS connection has been
established and
can be used to initialize a web based accelerator or to acquire a high rate radio access bearer.
Specify the desired custom preload URL in the text edit control or hit the ellipsis button (...) to
pick one of the recent URLs.
An additional post preload delay can be specified if required. The system will be idle for the
specified time after a preload URL has been fetched before starting the measurement.
Navigate back to the tab sheet Config after the data has been configured to start the
measurement.
HTTP Status
This tab sheet will display the HTTP measurement's status and main results during the
measurement.
The current loop iteration and the status information are displayed on top.
The field bytes received displays the number of bytes successfully received including both
HTTP headers and payload (i.e. TCP payload not including TCP and IP headers).
The average throughput is calculated from the first to the last receive time stamp and can thus
be slightly higher than the real throughput.
The first RTT is calculated from the transmission of the HTTP request to the reception of the
HTTP server's response.
The graph control displays the estimated throughput per one second interval. Usually the
display scale is in kByte/s=1000Byte/s, it can be switched to kbit/s=1000bit/s by setting the
parameter GraphModeKBit: True in the user configuration file's [GUI] section.
PocketOptimizer 1.1.1.32 26.Jan.2011
15
Operations Manual
Use the profile combo box to select a pre-defined profile either from the system or the user
configuration file to load the profile's values.
o The ellipsis button (...) opens the profile manager. Use this function to save your settings
to a user defined profile and to manage your profiles.
Use the custom URL text field to enter a custom URL or use the ellipsis button (...) to view a
history of URLs.
Note: If the URL specifies a directory (i.e. ends with a slash), the agent Id will automatically be
used as the filename to avoid problems due to simultaneous uploads of several users.
Alternatively the placeholder %agent% will be replaced by the agent id.
Specify the direction with the Get and Put radio buttons.
The download data size will be specified by the data file, the data size for uploads can be
specified with the data size control.
Check passive mode if you want to use FTP passive mode.
A number of repetitions and the pause between those repetitions can be specified with loops
and delay.
The checkbox act/deact RAS connection in every loop specifies if the RAS connection will be
closed and re-opened in every loop iteration or if the same RAS connection will be used for all
measurements.
The checkbox logfile has to be checked if the measurement's log file is to be saved in the log
file directory.
The checkbox sniffer activates a third party packet sniffer.
Hit the button Start to start the measurement.
16
Operations Manual
FTP Status
This tab sheet will display the FTP measurement's status and main results during the
measurement.
The current loop iteration and the status information are displayed on top.
The field bytes sent/received displays the number of bytes successfully sent or received on the
data connection (TCP payload not including control connection).
The average throughput is calculated from the first to the last receive timestamp and can thus
be slightly higher than the real throughput.
The first RTT is calculated from the transmission of the FTP USER request to the reception of
the FTP server's control connection response.
The graph control displays the estimated throughput per one second interval. Usually the
display scale is in kByte/s=1000Byte/s, it can be switched to kbit/s=1000bit/s by setting the
parameter GraphModeKBit: True in the user configuration file's [GUI] section.
Hit the Cancel button to cancel any active measurement.
FTP Log
The log sheet contains the measurement's log. Major events and their time stamps are displayed in
the log window for informational and diagnostic purposes.
FTP Results
The results sheet contains the measurement's detailed results. A list of throughput values per one
second interval can be viewed during the measurement by hitting the Update button or is
automatically updated at the end of the measurement. This allows to view the data even if it is not
automatically saved to a log file.
17
Operations Manual
Use the profile combo box to select a pre-defined profile either from the system or the user
configuration file to load the profile's values.
o The ellipsis button (...) opens the profile manager. Use this function to save your settings
to a user defined profile and to manage your profiles.
Use the host text field to enter a custom host or IP address or use the ellipsis button (...) to
view a history of hosts.
Specify the number of packets per block with the corresponding edit control. See the
description of the block parameter below, usually you will use one block.
If you specify Unix mode packets will be transmitted with a constant time increment as
specified with the advance parameter (adv ms). In default (Windows) mode, a packet will be
transmitted either after a timeout (to ms) or adv ms after the reception of a packet as specified
with the advance parameter.
The ICMP payload size will directly influence the ICMP and IP packet sizes:
ICMP packet size: ICMP payload size + 8 bytes ICMP header
IP packet size: ICMP packet size + 20 bytes IP header
The receive timeout is specified with the parameter to (ms).
In Unix mode a packet is always transmitted after adv ms, thus the timeout value is only
relevant for the last (lost) packets. In Windows mode a packet is only transmitted after the
reception of a packet or
after a timeout.
The timing advance is specified with the adv (ms) parameter.
In Unix mode this is the time increment from transmission to transmission, in Windows mode it
specifies the time increment from packet reception to next transmission.
In addition to the loops, it is possible to specify a number of blocks to be transmitted. Every
block includes the specified number of packets succeeded by an idle time as specified with
pause. The RAS connection is not disconnected between blocks.
The checkbox act/deact RAS connection in every loop specifies if the RAS connection will be
closed and re-opened in every loop iteration or if the same RAS connection will be used for all
measurements.
The checkbox logfile has to be checked if the measurement's log file is to be saved in the log
directory.
The checkbox sniffer activates a third party packet sniffer.
Hit the button Start to start the measurement.
ICMP Status
This tab sheet will display the ICMP measurement's status and main results during the
measurement.
The current loop iteration and the status information are displayed on top.
Block/seq no displays the current block number (starting with 1) and the current sequence
number (starting with 1 in the first block). The sequence value displayed at the and of a loop
iteration is thus
the # of packets transmitted (packets x blocks).
The Average RTT is calculated on a per block basis.
The number of Packets lost is counted per loop as the sequence number is. If all packets are
lost, this value will thus be equal to the sequence number.
The graph control displays the round trip time on a per packet basis, a green bar is used to
show activity (response has not been received but timeout has not expired, yet), a red bar
indicates packet loss (timeout for the packet has expired).
PocketOptimizer 1.1.1.32 26.Jan.2011
18
Operations Manual
Use the profile combo box to select a pre-defined profile either from the system or the user
configuration file to load the profile's values.
o The ellipsis button (...) opens the profile manager. Use this function to save your settings
to a user defined profile and to manage your profiles.
Specify uplink and downlink packet size (UDP payload) in the UDP packet size edit controls.
UDP packet size: UDP payload size + 8 bytes UDP header
IP packet size: UDP packet size + 20 bytes IP header
Uplink and downlink packet rates can be specified in UDP packet rate.
Specify the measurement duration in seconds. Packets will be transmitted in both directions
until the required data has been committed by the remote side or a timeout has occurred.
A number of repetitions and the pause between those repetitions can be specified with loops
and delay.
The checkbox act/deact RAS connection in every loop specifies if the RAS connection will be
closed and re-opened in every loop iteration or if the same RAS connection will be used for all
measurements.
The checkbox logfile has to be checked if the measurement's log file is to be saved in the log
file directory.
The checkbox sniffer is available on Pocket PC only and activates a third party packet sniffer.
Note: As there are no GUI controls for the server, username and password, be sure to specify
proper values in either the [UdpDefaults] section or in the profile you're using.
Hit the button Start to start the measurement.
19
Operations Manual
UDP Status
This tab sheet will display the UDP measurement's status and main results during the
measurement.
The current loop iteration and the status information are displayed on top.
dl (kbit/s) and ul (kbit/s) show average uplink and downlink data rates calculated from the first
to the last received packet.
dl jtr (ms) and ul jtr (ms) show average effective jitter.
dl loss and ul loss display the total number of packets lost.
The graph control displays the estimated data rates per one second interval in
kByte/s=1000Byte/s, it can be switched to kbit/s=1000bit/s by setting the parameter
GraphModeKBit: True in the user configuration file's [GUI] section. In addition red bars are used
to display the number of lost packets per interval (25% height .. 1 packet lost, 50% .. 2
packets lost, 75% .. 3 packets lost, 100% .. 4 or more packets lost).
Hit the Cancel button to cancel any active measurement.
UDP Log
The log sheet contains the measurement's log. Major events and their time stamps are displayed in
the log window for informational and diagnostic purposes.
UDP Result
The results sheet contains the measurement's detailed results. A detailed list of statistics per on
second interval can be viewed during the measurement by hitting the Update button or is
automatically updated at the end of the measurement. This allows to view the data even if it is not
automatically saved to a log file.
Simply enter a new name in the edit control (to create a new profile) or select an existing name
from the list box (to overwrite an existing profile) and hit the Save as button. In addition, existing
profiles can be deleted with the Delete button after specifying their name.
PocketOptimizer 1.1.1.32 26.Jan.2011
20
Operations Manual
Hit the Start button to start the job. During execution the status information sheet will display
progress information as well as a graphical overview.
After the measurement is completed, an XML report file is generated. Depending on the
specification in the job file this XML ticket can either be stored in a local directory or sent to a
server. If transmission is not possible, the file will be kept in the local directory for later
submission.
21
Operations Manual
3.4.1 Synchronization
Simply hit the button Sync to reload the system configuration file (including the system task
profiles) and the job files from the measurement server. PocketOptimizer will prompt if to open a
RAS connection and load the required files.
If the default synchronization URL is not usable, it is possible to adjust it as required.
Please note that the synchronization URL is stored in the system configuration file and is
automatically updated by the synchronization process. The new value will be used when
PocketOptimizer is started the next time.
3.4.2 Reporting
The reporting functionality can be used to submit XML tickets to the ticket receiver, i.e. a HTTP
server accepting HTTP POST requests.
Depending on your job files, reports can either be automatically submitted to the HTTP server or
will have to be transferred manually. In the second case or if transmission is not possible in the
first case, the XML report files will be placed in PocketOptimizer's report directory. They can then
be sent manually or moved to the archive folder.
Note: It's up to the user to remove old report files from the archive folder.
Hit the Refresh button to load a list of files ready for transmission, the Select button can be used
to toggle the
selection in addition to manual file selection by checking or un-checking single items in the list.
Hit the Report button to submit the files to the server or the Archive button to move the files to the
archive folder.
22
Operations Manual
Chapter
Administrators Manual
This section contains information for the system and license administrator and is not intended for end
users.
23
Administrators Manual
0.0.1
force
delete
Note: force is not a special keyword, its simply a version different to the version in the job file to
force update.
For the Update-URL specified above, the URLs fetched will be
http://www.i-qos.com/config/po/demo/jobs/test-http.job
http://www.i-qos.com/config/po/demo/jobs/test-ftp.job
24
Administrators Manual
<agent id="101">PocketOptimizer</agent><CRLF>
<duration>10.222</duration><CRLF>
<comment>loop 1, block 2, loop 1 (icmp)</comment><CRLF>
<qi>10</qi><CRLF>
<rating>1</rating><CRLF>
<metrics><CRLF>
<metric id="1001" comment="1001-ping-tx-count">20</metric><CRLF>
<metric id="1002" comment="1002-ping-lost">0</metric><CRLF>
<metric id="1003" comment="1003-ping-avg-rtt">0.183</metric><CRLF>
<metric id="100" comment="operator">23201</metric>
<text id="101" comment="user">your user name</text>
<text id="102" comment="location">your location</text>
<text id="103" comment="cell-id">your cell id</text>
<text id="104" comment="IP-addrs">128.130.6.7</text>
<text id="105" comment="jobtime">2006-11-13T01:33:42+01:00</text>
</metrics><CRLF>
</scenario><CRLF>
</ticket><CRLF>
25
Administrators Manual
Chapter
Technical Reference
This chapter includes PocketOptimizer's technical specifications.
http://qts.i-qos.com:8808/
http://www.i-qos.com/config/po/demo
[HttpProfile]
Name:
i-qos.com 10kB
;Loop-Count:
1
; ... loop iterations
;Loop-Pause:
1000
; (ms) pause between and after last repetition
;Ras-Dial:
No
; (No|Auto|Forced|Iterated)
;Ras-Hangup:
No
; (No|Yes)
Http-Url:
http://www.i-qos.com/test/test01-00010kB.bin
;Http-Follow:
Yes
; follow img src tags in html files
;Http-FollowMulti:
Yes
; load img src tags multiple even if same URL
;Http-Threads:
1
; parallel threads for html files
;Http-KeepAlive:
Yes
; use keepalive
;Http-UsePreload:
Yes
; (No|Yes) ... use preload url
;Http-PreloadUrl:
http://www.i-qos.com/test/test01-00010kB.bin
;Http-PreloadDelay: 2000
; (ms) ... delay after preload
;Http-Connect-To:
60000
; (ms) ... socket connect timeout
;Http-Recv-To:
60000
; (ms) ... socket rx timeout
;Http-Send-To:
60000
; (ms) ... socket tx timeout
;Http-Master-To:
180000
; (ms) ... total timeout
[HttpProfile]
Name:
Http-Url:
i-qos.com 100kB
http://www.i-qos.com/test/test01-00100kB.bin
[HttpProfile]
Name:
i-qos.com 1MB
26
Technical Reference
Http-Url:
http://www.i-qos.com/test/test02-001MB.bin
[HttpProfile]
Name:
Http-Url:
i-qos.com 10MB
http://www.i-qos.com/test/test02-010MB.bin
[HttpProfile]
Name:
Http-Url:
Http-Threads:
i-qos.com 100x1kB
http://www.i-qos.com/test/test-100x1kB.html
10
[HttpProfile]
Name:
Http-Url:
Http-Threads:
i-qos.com 100x10kB
http://www.i-qos.com/test/test-100x10kB.html
10
[HttpProfile]
Name:
Http-Url:
GD main
http://gd.tuwien.ac.at/
[FtpProfile]
Name:
i-qos.com 10kB DL
;Loop-Count:
1
; ... loop iterations
;Loop-Pause:
1000
; (ms) ... pause between loops
;Ras-Dial:
No
; (No|Auto|Forced|Iterated)
;Ras-Hangup.
No
; (No|Yes)
Ftp-Url:
ftp://www.i-qos.com/test/test01-00010kB.bin
Ftp-User:
FTPTest
; user if required
Ftp-Pass:
iFTP17q
; password if required
;Ftp-Direction:
Get
; (Get|Put) ... direction
;Ftp-Passive:
Yes
; (No|Yes) ... use pasv mode
;Ftp-DataSize:
1024
; ... bytes (for upload only)
;Ftp-Connect-To:
60000
; (ms) ... socket connect timeout
;Ftp-Recv-To:
60000
; (ms) ... socket rx timeout
;Ftp-Send-To:
60000
; (ms) ... socket tx timeout
;Ftp-Noop-To:
30000
; (ms) ... timeout to send Noop command
;Ftp-Master-To:
180000
; (ms) ... total timeout
;Ftp-Meas-To:
60000
; (ms) ... stop measurement after timeout
;Ftp-BlockSize:
2048
; receive/transmit block size
(large enough for DL, small enough for UL)
[FtpProfile]
Name:
Ftp-Url:
Ftp-User:
Ftp-Pass:
i-qos.com 100kB DL
ftp://www.i-qos.com/test/test01-00010kB.bin
FTPTest
; user if required
iFTP17q
; password if required
[FtpProfile]
Name:
Ftp-Url:
Ftp-User:
Ftp-Pass:
i-qos.com 1MB DL
ftp://www.i-qos.com/test/test02-001MB.bin
FTPTest
; user if required
iFTP17q
; password if required
[FtpProfile]
Name:
Ftp-Url:
Ftp-User:
Ftp-Pass:
i-qos.com 10MB DL
ftp://www.i-qos.com/test/test02-010MB.bin
FTPTest
; user if required
iFTP17q
; password if required
[FtpProfile]
Name:
i-qos.com 10kB UL
Ftp-Url:
ftp://www.i-qos.com/test/Upload/test-ul-10kB-%agent%.bin
FTP-User:
FTPTest
FTP-Pass:
iFTP17q
FTP-DataSize:
10240
FTP-Direction:
Put
Ftp-BlockSize:
1420
; receive/transmit block size
(large enough for DL, small enough for UL)
; for 1464 MTU size we use
1464-20(TCP)-20(IP)-4=1420 bytes to avoid IP fragementation
[FtpProfile]
Name:
Ftp-Url:
FTP-User:
FTP-Pass:
FTP-DataSize:
FTP-Direction:
Ftp-BlockSize:
i-qos.com 100kB UL
ftp://www.i-qos.com/test/Upload/test-ul-100kB-%agent%.bin
FTPTest
iFTP17q
102400
Put
1420
27
Technical Reference
[FtpProfile]
Name:
Ftp-Url:
FTP-User:
FTP-Pass:
FTP-DataSize:
FTP-Direction:
Ftp-BlockSize:
i-qos.com 1MB UL
ftp://www.i-qos.com/test/Upload/test-ul-1MB-%agent%.bin
FTPTest
iFTP17q
1048576
Put
1420
[FtpProfile]
Name:
Ftp-Url:
Ftp-User:
Ftp-Pass:
GD welcome (small)
ftp://gd.tuwien.ac.at/welcome.txt
anonymous
; user if required
me@here.com
; password if required
[PingProfile]
Name:
;Loop-Count:
;Loop-Pause:
;Ras-Dial:
;Ras-Hangup.
Ping-Addr:
Ping-Count:
Ping-Size:
Ping-Unix:
Ping-Advance:
Ping-Timeout:
Ping-Blocks:
Ping-Delay:
;Ping-DontAverage:
i-qos.com (win)
1
1000
No
No
www.i-qos.com
20
0
No
1000
4000
1
5000
0
[PingProfile]
Name:
Ping-Addr:
Ping-Count:
Ping-Size:
Ping-Unix:
Ping-Advance:
Ping-Timeout:
Ping-Blocks:
Ping-Delay:
i-qos.com (unix)
www.i-qos.com
20
0
True
1000
5000
1
5000
[PingProfile]
Name:
Ping-Addr:
Ping-Count:
Ping-Size:
Ping-Unix:
Ping-Advance:
Ping-Timeout:
Ping-Blocks:
Ping-Delay:
[UdpProfile]
Name:
;Loop-Count:
;Loop-Pause:
;Ras-Dial:
;Ras-Hangup.
Udp-DL-Size:
Udp-UL-Size:
Udp-DL-Rate:
Udp-UL-Rate:
Udp-Duration:
Udp-Server:
Udp-User:
Udp-Pass:
i-qos.com (2x12.8/16kbit/s)
1
; ... loop iterations
1000
; (ms) ... pause between loops
No
; (No|Auto|Forced|Iterated)
No
; (No|Yes)
160
; (bytes) ... DL UDP payload size
160
; (bytes) ... UL UDP payload size
10
; (pkts/sec) ... DL packet rate
10
; (pkts/sec) ... UL packet rate
; 10/s * 160 * 8 = 12800 bit/s (UP payload)
; 10/s * (160 + 40) * 8 = 16000 bit/s (IP total)
20
; (sec) ... measureent duration
www.i-qos.com:8888 ; ... server name or IP address
demo
; ... server user name
ndfademo
; ... server password
[HttpDefaults]
[FtpDefaults]
Ftp-User:
Ftp-Pass:
anonymous
me@here.com
[PingDefaults]
[UdpDefaults]
PocketOptimizer 1.1.1.32 26.Jan.2011
28
Technical Reference
[RasDefaults]
;Ras-DontClose:
;Ras-Timeout:
;Ras-User:
;Ras-Password:
;Ras-Retries:
[Operators]
;Operator01:
;Operator02:
;Operator03:
;Operator04:
;Operator05:
;Operator06:
;IMSI01:
;InitStr01:
Yes
60000
;
;
;
;
;
23201=A1
23203=T-Mobile AT
23205=Orange AT
23207=T-Mobile TR AT
23210=H3G AT
23211=A1 Bob
23201
"at+cgdcont=1,""IP"",""A1.net"""
only once
only once
any number
only once
any number
only once
any number
only once
any number
only once
only once
only once
[http://]<host>[:<port>]/[<path>]
(string, optional)
Specifies the URL for delivering XML reports. The server has to be a HTTP server or a ticket receiver
accepting HTTP POST requests to the specified URL.
Update-Url:
[http://]<host>[:<port>]/[<path>]
(string, optional)
Specifies the URL for getting the configuration files. The server has to be a HTTP server accepting
HTTP GET requests, the specified path has to include the system configuration file (system.cfg) and
a job configuration file (jobs.cfg). Job files can be stored in the same path or in subfolders of the
specified path.
Section [Help]
The configuration file may include a single [Help] section.
Known parameters in system config [Help]
Content:
<file>
(string, optional)
Specifies an alternate help file name. The file will be opened with a shell execute, all file types
supported by windows can be used.
Section [HttpProfile]
The configuration file may include any number of [HttpProfile] sections, every section creates one
entry in the HTTP profile selection combo box.
Parameters not specified in this section will be loaded from the [HttpDefaults] section in the user
configuration file for individual measurements. If not defined there, they will be loaded from the
[HttpDefaults] section in the system configuration file. HTTP tasks in job files will only be expanded by
the [HttpDefaults] section in the system configuration file.
Please refer to section 5.2.4.1 for a list of known parameters.
29
Technical Reference
Section [HttpDefaults]
The configuration file may include one [HttpDefaults] section. Values not specified in the [HttpProfile]
section are first searched in the user configuration files [HttpDefaults] section (interactive
measurements only), then in the system configuration files [HttpDefaults] section.
Known parameters in system config [HttpDefaults]
Http-Url:
Http-Threads:
Http-KeepAlive:
Http-UsePreload:
Http-PreloadUrl:
Http-PreloadDelay:
Http-Connect-To:
Http-Recv-To:
Http-Send-To:
Http-Master-To:
[http://]<host>[:port]/[<path>]
<threads>
(No|Yes)
(No|Yes)
[http://]<host>[:port]/[<path>]
<ms>
<ms>
<ms>
<ms>
<ms>
(string)
(integer, optional, default:1)
(bool, optional, default:Yes)
(bool, optional, default:No)
(string, optional)
(integer, optional,
def:2000)
(integer, optional, def:60000)
(integer, optional, def:60000)
(integer, optional, def:60000)
(integer, optional, def:180000)
Section [FtpProfile]
The configuration file may include any number of [FtpProfile] sections, every section creates one entry
in the FTP profile selection combo box.
Parameters not specified in this section will be loaded from the [FtpDefaults] section in the user
configuration file for individual measurements. If not defined there, they will be loaded from the
[FtpDefaults] section in the system configuration file. FTP tasks in job files will only be expanded by
[FtpDefaults] section in the system configuration file.
Please refer to section 5.2.4.2 for a list of known parameters.
Section [FtpDefaults]
The configuration file may include one [FtpDefaults] section. Values not specified in the [FtpProfile]
section are first searched in the user configuration files [FtpDefaults] section (interactive
measurements only), then in the system configuration files [FtpDefaults] section.
Known parameters in system config [FtpDefaults]
Ftp-Url:
Ftp-User:
Ftp-Pass:
Ftp-Direction:
Ftp-Passive:
Ftp-DataSize:
Ftp-Connect-To:
Ftp-Recv-To:
Ftp-Send-To:
Ftp-Noop-To:
Ftp-Master-To:
Ftp-Meas-to:
[http://]<host>[:port]/[<path>]
<user>
<password>
(Get|Put)
(Yes|No)
<bytes>
<ms>
<ms>
<ms>
<ms>
<ms>
<ms>
(string)
(string, optional)
(string, optional)
(list, optional, default:Get)
(bool, optional, default:Yes)
(integer, mandatory for upload)
(integer, optional, def:60000)
(integer, optional, def:60000)
(integer, optional, def:60000)
(integer, optional, def:30000)
(integer, optional, def:180000)
(integer, optional, def:none)
Section [PingProfile]
The configuration file may include any number of [PingProfile] sections, every section creates one
entry in the ICMP profile selection combo box.
Parameters not specified in this section will be loaded from the [PingDefaults] section in the user
configuration file for individual measurements. If not defined there, they will be loaded from the
[PingDefaults] section in the system configuration file. ICMP tasks in job files will only be expanded by
[PingDefaults] section in the system configuration file.
Please refer to section 5.2.4.3 for a list of known parameters.
Section [PingDefaults]
The configuration file may include one [PingDefaults] section. Values not specified in the [PingProfile]
section are first searched in the user configuration files [PingDefaults] section (interactive
measurements only), then in the system configuration files [PingDefaults] section.
Known parameters in system config [PingDefaults]
Ping-Addr:
Ping-Count:
Ping-Size:
Ping-Unix:
Ping-Advance:
Ping-Timeout:
Ping-Blocks:
Ping-Delay:
<host>
<number>
<bytes>
(True|False)
<ms>
<ms>
<number>
<ms>
(string)
(integer, optional, default:10)
(integer, optional, default:0)
(bool, optional, default:False)
(integer, optional, def:1000)
(integer, optional, def:5000)
(integer, optional, def:1)
(integer, optional, def:1000)
30
Technical Reference
Ping-DontAverage:
<number>
Section [UdpProfile]
The configuration file may include any number of [UdpProfile] sections, every section creates one
entry in the UDP profile selection combo box.
Parameters not specified in this section will be loaded from the [UdpDefaults] section in the user
configuration file for individual measurements. If not defined there, they will be loaded from the
[UdpDefaults] section in the system configuration file. UDP tasks in job files will only be expanded by
[UdpDefaults] section in the system configuration file.
Please refer to section 5.2.4.4 for a list of known parameters.
Section [UdpDefaults]
The configuration file may include one [UdpDefaults] section. Values not specified in the [UdpProfile]
section are first searched in the user configuration files [UdpDefaults] section (interactive
measurements only), then in the system configuration files [UdpDefaults] section.
Known parameters in system config [UdpDefaults]
Udp-Server:
Udp-User:
Udp-Pass:
Udp-DL-Size:
Udp-UL-Size:
Udp-DL-Rate:
Udp-UL-Rate:
Udp-Duration:
Udp-Connect-To:
Udp-Recv-To:
Udp-Send-To:
Udp-Master-To:
<host>:<port>
<user>
<password>
<bytes>
<bytes>
<pkts/sec>
<pkts/sec>
<seconds>
<ms>
<ms>
<ms>
<ms>
(string, mandatory)
(string, optional)
(string, optional)
(integer, optional, default:64)
(integer, optional, default:64)
(float, optional, default:10)
(float, optional, default:10)
(float, optional, default:30)
(integer, optional, def:60000)
(integer, optional, def:60000)
(integer, optional, def:60000)
(integer, optional, def:180000)
Section [RasDefaults]
The configuration file may include one [RasDefaults] section. Values are automatically loaded from the
user configuration file (interactive measurements) or the system configuration file for interactive and
job measurements.
Please refer to section 5.2.4.5 for a list of known parameters. Please note that [RasDefaults] cannot
contain the parameter RAS-Entry as it is provided by the GUI.
Section [Operators]
Specifies the operators that can be selected in the user data screen.
Known parameters in system config [Operators]
Operator<nn>:
<id>[=description]
(string, optional)
Specifies the operator id and an optional description. The selected operator id is reported as metric
100.
Default:
<number>
(integer, optional)
Specifies the default operator id, if not specified, the first operator is used.
IMSI<nn>:
<number>[,<number>...]
(integer, optional)
Specifies the IMSI start characters for operator n. Multiple values can be separated by commas. The
starting characters are required for the /autooperator and /autoinitstr command line arguments.
InitStr<nn>:
<text>
(string, optional)
Specifies the modem init string for operator n. The modem init string is required for the
/autooperator command line argument.
31
Technical Reference
[GUI]
;DecimalSeparator:
;GraphModeKBit:
.
Yes
[FtpHistory]
FtpUrl:
ftp://194.48.139.238/gprs/200KB
[PingHistory]
PingAddr:
PingAddr.0:
www.tuwien.ac.at
www.a1.net
[HttpHistory]
HttpUrl:
HttpUrl.0:
http://gd.tuwien.ac.at/
http://194.48.139.238/merlin/PocketOptimizer/120mal1KB.htm
[PingProfile]
Name:
Loop-Count:
Loop-Pause:
Ras-Dial:
Ping-Addr:
Ping-Count:
Ping-Size:
Ping-Unix:
Ping-Advance:
Ping-Timeout:
Ping-Blocks:
Ping-Delay:
dial
1
3000
Auto
www.tuwien.ac.at
9999
0
True
5000
4000
1
5000
only once
only once
only once
only once
only once
any number
only once
any number
only once
any number
only once
any number
only once
only once
(string, optional)
<informative location>
(string, optional)
(string, optional)
(string, optional)
Stores the RAS connection to be used for interactive and job measurements.
Section [GUI]
This section contains additional configuration parameters and is not maintained by PocketOptimizer
32
Technical Reference
<character>
(char, optional)
Specifies the decimal separator for log file output. The default value is the systems decimal
separator, for some tasks it may be more convenient to use the dot (.) as decimal separator.
GraphModeKBit:
(Yes|No)
<url>
<url>
<url>
<url>
(string)
(string)
(string)
(string)
Section [FtpHistory]
The section contains the custom FTP URL history. The last 10 values are stored to improve GUI
usability.
Known parameters in user config [FtpHistory]
FtpUrl:
FtpUrl.n:
<url>
<url>
(string)
(string)
Section [PingHistory]
The section contains the ping host history. The last 10 values are stored to improve GUI usability.
Known parameters in user config [PingHistory]
PingAddr:
PingAddr.n:
<url>
<url>
(string)
(string)
logs
jobs
reports
archive
[Registration]
AgentId:
UnlockCode:
102
B516-E7C5-B619-8ECA-6A1B
[Sniffer]
;ExeName:
;CaptureTo-Folder:
;CaptureTo-Type:
;CaptureTo-Location:
;DumpFile-Path:
"\Programme\CEMyNetwork Wireless1.0\cemynetworkw.exe"
SnifferFiles
Ethereal, tcpdump (*.cap)
"CF Karte"
"\CF Karte\SnifferFiles\"
33
Technical Reference
;DumpFile-Ext:
;DontTerminate:
[TShark]
;ExeName:
.cap
True
D:\Software\Wireshark\TShark.exe
only
only
only
only
only
once
once
once
once (Win32 only)
once (Pocket PC only)
<path>
<path>
Specifies the path containing job files. The job files synchronized from the server will be placed
there.
Report-Path:
<path>
Specifies the path for report files that have not been reported to a server.
Archive-Path:
<path>
<path>
<agent-id>
(integer, mandatory)
<code>
(string, mandatory)
<file name>
<dialog folder>
<dialog file format>
<dialog folder type>
<sniffer folder>
<file extension>
(True|False)
<params>
<interface>
<interface>
(string, optional)
(string, optional, PPC only)
(string, optional, PPC only)
(string, optional, PPC only)
(string, optional, PPC only)
(string, optional)
(bool, optional, PPC only)
(string, optional, Win32 only)
(string, optional, Win32 only)
(string, optional, Win32 only)
Section [TShark]
This section is only available for the Win32 edition and stores the configuration for the TShark
executable. TShark is used to decode the sniffer files, not for capturing. Please see section 5.6.2 for
details.
Known parameters in machine config [TShark]
34
Technical Reference
ExeName:
<file name>
(string, optional)
Section [RIL]
This section is only available for the Pocket PC edition and stores the configuration for the Radio
Interface Layer. This interface allows querying the radio status similar to AT commands. RIL is only
available on Smart Phones (not on Pocket PC without builtin GSM/UMTS phone) and can provide the
text metrics 120..128. It has been tested with HTC TyTN II devices.
Known parameters in machine config [RIL]
Ril-Enable:
<True|False>
Use this parameter to disable RIL if required. RIL availability is checked automatically by
PocketOptimizer and usage of RIL functions is disabled if RIL or modem is not available, thus setting
Ril-Enable to false should not be required in most cases.
Ril-RasNameNN:
<ras name>
The parameters Ril-RasName00 .. Ril-RasName19 can be used to specify the RAS connections using
RIL devices. The default configuration is Ril-RasName00: * meaning that all RAS connections use the
device associated with RIL.
If you are using both Bluetooth connections (e.g. RAS name UMTS-GPRS-BT, cannot be queried
with RIL) and builtin modem connections (e.g. RAS name UMTS-GPRS-INT, associated with RIL),
the configuration can be Ril-RasName00: UMTS-GPRS-INT. In this case only the RAS connection
UMTS-GPRS-INT will be analyzed with RIL, for all other connections RIL will not be used.
35
Technical Reference
[RAS]
;RAS-Timeout:
60
; RAS connection timeout
;RAS-Retries:
3
; # of RAS retries
; possible tasks are HTTP, FTP, ICMP, UDP, Parallel, RAS_REPORT, RAS-CONNECT and RAS-HANGUP
[TASK]
Task-Type:
Scenario-Id:
RAS-Connect
110
[TASK]
Task-Type:
Task-Comment:
Scenario-Id:
Loop-Count:
Http-Url:
HTTP
; task type
100k HTTP download ; comment displayed in status
113
; scenario for XML reporting
2
; # of task iterations
http://194.48.139.238/merlin/HTTP_Files/100KB.dl
[TASK]
Task-Type:
Task-Comment:
Scenario-Id:
Loop-Count:
Ping-Addr:
Ping-Count:
Ping-Size:
Ping-Unix:
Ping-Advance:
Ping-Timeout:
Ping-Blocks:
Ping-Delay:
ICMP
2x10 Pings
114
2
www.mobilkom.at
10
0
True
1000
5000
2
2000
;
;
;
;
;
;
;
;
;
;
;
;
[TASK]
Task-Type:
RAS-Hangup
; task type
; task type
; scenario for XML reporting (RAS KPIs)
task type
comment displayed in status
scenario for XML reporting
# of task iterations
host name or IP address
# of pings per block
payload size in bytes
windows/unix mode
increment in ms
timeout in ms
# of blocks
delay between blocks in ms
only once
only once
any number
36
Technical Reference
<text>
(string, optional)
The description will be displayed when selecting a job. Enter any comment you find useful.
Iterations:
<loop count>
<ms>
Specifies the pause after each task in ms. Only used if the task's Loop-Pause is not specified.
Reporting:
(Off|File|Http)
<system>
(string, optional)
Specifies the value to be used in the XML ticket's system tag. If using a ticket receiver for reporting,
this has to be one of the ticket receiver's system, i.e. database names.
WriteLogFile:
(Yes|No)
(Yes|No)
Specifies if the packet sniffer is to be used (only if a sniffer is supported for the platform).
UseTShark:
(Yes|No)
Specifies if TShark is used to decode the sniffer files for TCP connections and generate additional
KPIs.
Report-OldFiles:
<count>
(integer, optional)
Specifies the number of report files to be submitted after job execution. If the value is greater than
zero, the specified number of report files from the folder reports will be submitted to a ticket
receiver if the reporting mode is http.
Section [RAS]
This section can include additional RAS parameters, please refer section 5.2.4.5 for a detailed
specification.
Known parameters in job [RAS]
RAS-User:
RAS-Password:
RAS-APN:
RAS-DefUser:
RAS-DefPassword:
RAS-DefAPN:
RAS-DontClose:
RAS-Timeout:
RAS-Retries:
RAS-ModemInfo-Enable:
RAS-ModemInfo-Timeout:
<user>
<password>
<apn>
<user>
<password>
<apn>
(Yes|No)
<ms>
<number>
(Yes|No)
<ms>
(string, optional)
(string, optional)
(string, optional)
(string, optional)
(string, optional)
(string, optional)
(bool, optional, default:No)
(integer, optional, def:60000)
(integer, optional, default:3)
(bool, optional, default:Yes)
(integer, optional, def:30000)
Section [Task]
This section contains the individual task definitions. Refer to section 5.2.4 for the task's parameters.
Known parameters in job [Task]
Task-Type:
(HTTP|FTP|ICMP|UDP|Parallel|RAS-Connect|RAS-Hangup|AT-Command
The description will be displayed in the status window to provide additional information to the user.
You should include information allowing the user to estimate the task's runtime (e.g. # of bytes to
be transferred or # of pings to be sent).
Task-Comment:
<text>
(string, optional)
The description will be displayed in the status window to provide additional information to the user.
You should include information allowing the user to estimate the task's runtime (e.g. # of bytes to
be transferred or # of pings to be sent).
Scenario-Id:
<integer>
(integer, optional)
The scenario id is the unique key for XML reporting. Thus you should assign a different scenario id
to every task you're using. Otherwise it will not easily be possible to distinguish different
37
Technical Reference
measurements in the reported data. For example you shouldn't assign the same scenario id to
100kB and 1000kB downloads as some of the KPIs will be very different for those tasks.
Parallel:
(No|Yes)
Defines if a task shall be executed in parallel with other tasks. Parallel tasks have to be preceded by
a special task with task type Parallel. All tasks following this parallel task with attribute parallel=true
will be executed in parallel. Please note that RAS tasks and RAS operations are not possible in
parallel tasks.
The following example demonstrates how to use parallel tasks:
[Task]
Task-Type:
Parallel
[Task]
Task-Type:
Parallel:
Http-Url:
HTTP
true
http://www.i-qos.com/test/test02-010MB.bin
[Task]
Task-Type:
Parallel:
Http-Url:
Http-Method:
HTTP
true
http://www.i-qos.com/uploader/test01.bin
post
Additional known parameters depend on the task type, please refer to section 5.2.4 for the parameter
specification for the individual measurement tasks.
<profile_name>
(string)
Specifies the profile name to be displayed in the profile selection combo box. The name should be
unique to allow the user to identify the HTTP profile.
Loop-Count:
<count>
Specifies the total number of loop iterations for this task (GUI parameter loops).
Loop-Pause:
<ms>
(integer, optional)
Specifies the pause between loop iterations (GUI parameter loop delay).
Ras-Dial:
(No|Auto|Forced|Iterated)
Specifies the RAS connection mode (GUI parameter act/deact RAS conn..), possible values are:
No
... The RAS connection will not be established, even if it is not active
Auto
... The RAS connection will only be established if not already active.
Forced
... The RAS connection will be disconnected if active and then re-connected in the
first loop iteration. Subsequent loop iterations will use Auto behavior, i.e. the
RAS connection will be re-used if possible, a new connection will be established
if the existing connection got lost.
Iterated
... The RAS connection will be disconnected if active and then re-connected in
every loop iteration.
Interactive measurements support Auto and Iterated only, depending on the checkbox act/deact
RAS conn. in every loop. All values are supported in job execution, default mode is No.
Ras-Hangup:
(No|Yes)
Specifies the RAS hang up mode (no GUI parameter available), possible values are:
No
... The RAS connection will not be closed.
Yes
... The RAS connection will be closed in every loop iteration.
This parameter is not used in interactive measurements (RAS-Dial is used instead). The parameter
is supported in job execution, default mode is No.
38
Technical Reference
Note: In addition to these RAS parameters, the parameters in the [RasDefaults] sections are used.
Usually the RAS connection will be closed after a measurement, this behavior can be overruled by
setting Ras-DontClose: True in [RasDefaults].
Ras-Wait:
<ms>
(integer, optional)
[http://]<host>[:port]/[<path>]
(string)
The HTTP URL used for download, HTTP protocol specifier and port can be omitted, the default port
is 80 (GUI parameter custom-URL). If the content type returned by the server is text/html,
embedded images identified by img src tags will be fetched, too.
Http-Follow:
<No|Yes>
<threads>
Specifies the number of threads used for parallel downloads of embedded images (GUI parameter
max. # of parallel TCP connections)
Http-KeepAlive:
(No|Yes)
(No|Yes)
Specifies if a preload URL has to be loaded prior to the measurement (GUI parameter use preload
URL).
Http-PreloadUrl:
[http://]<host>[:port]/[<path>]
(string, optional)
Specifies the preload URL similar to Http-Url (GUI parameter custom preload URL).
Http-PreloadDelay:
<ms>
Specifies an additional delay after loading the preload URL (GUI parameter post preload delay).
Http-Connect-To:
<ms>
Specifies the timeout interval for establishing the TCP socket connection.
Http-Recv-To:
<ms>
<ms>
<ms>
Specifies the overall timeout for the entire HTTP operation (applied individually for the preload URL
and every main URL loop iteration).
Http-MaxSize:
<bytes>
Defines the maximum allowed size for the HTTP payload returned by the server. Sizes exceeding
the allowed maximum will be rejected to prevent denial of service attacks.
Http-Method:
(GET|POST)
Specifies the HTTP request type. Default is GET, alternatively it is possible to send data to the
server if the POST method is specified. Please note that the data size has to be specified in this
case.
Http-DataSize:
<bytes>
Specifies the data size in bytes for HTTP POST requests. The parameter is not used in case of get
requests.
Http-BlockSize:
<bytes>
Block size for HTTP reception and transmission on windows socket level. The block size should be a
tradeoff between measurement accuracy (small blocks) and good performance (large blocks).
Optimum performance can be achieved if the block size is chosen to generate IP packets of the
specified MTU size. If for example the MTU size is 1464 bytes, the optimum buffer size is 1424 bytes
(1464 - 20 bytes IP header - 20 bytes TCP header). Good measurement quality requires small
blocks, e.g. for GPRS with 100 kbit/s 15 kB/s with throughput accuracy of 10 %, the buffer size
should be approximately 1500 bytes.
DontUseDefaults:
<bool>
39
Technical Reference
<profile_name>
(string)
Specifies the profile name to be displayed in the profile selection combo box. The name should be
unique to allow the user to identify the FTP profile.
Loop-Count:
<count>
Specifies the total number of loop iterations for this task (GUI parameter loops).
Loop-Pause:
<ms>
(integer, optional)
Specifies the pause between loop iterations (GUI parameter loop delay).
Ras-Dial:
(No|Auto|Forced|Iterated)
Specifies the RAS connection mode (GUI parameter act/deact RAS conn..), possible values are:
No
... The RAS connection will not be established, even if it is not active
Auto
... The RAS connection will only be established if not already active.
Forced
... The RAS connection will be disconnected if active and then re-connected in the
first loop iteration. Subsequent loop iterations will use Auto behavior, i.e. the
RAS connection will be re-used if possible, a new connection will be established
if the existing connection got lost.
Iterated
... The RAS connection will be disconnected if active and then re-connected in
every loop iteration.
Interactive measurements support Auto and Iterated only, depending on the checkbox act/deact
RAS conn. in every loop. All values are supported in job execution, default mode is No.
Ras-Hangup:
(No|Yes)
Specifies the RAS hang up mode (no GUI parameter available), possible values are:
No
... The RAS connection will not be closed.
Yes
... The RAS connection will be closed in every loop iteration.
This parameter is not used in interactive measurements (RAS-Dial is used instead). The parameter
is supported in job execution, default mode is No.
Note: In addition to these RAS parameters, the parameters in the [RasDefaults] sections are used.
Usually the RAS connection will be closed after a measurement, this behavior can be overruled by
setting Ras-DontClose: True in [RasDefaults].
Ras-Wait:
<ms>
(integer, optional)
[ftp://]<host>[:port]/[<path>]
(string)
Specifies the URL for the FTP transfer (GUI parameter custom URL). If nofile name is given (i.e. the
URL ends with a slash), the agent id is used as the file name, otherwise the placeholder %agent% will
be replaced by the agent id.
Ftp-User:
<user>
(string, optional)
The user name can be specified if required (no GUI parameter available).
Ftp-Pass:
<password>
(string, optional)
(Get|Put)
(Yes|No)
<bytes>
Specifies the upload data size in bytes (GUI parameter data size).
Ftp-Connect-To:
<ms>
Specifies the timeout interval for establishing the TCP socket connection.
Ftp-Recv-To:
<ms>
<ms>
40
Technical Reference
Ftp-Noop-To:
<ms>
Specifies the timeout interval until NOOP commands are transmitted on the control connection.
Ftp-Master-To:
<ms>
Specifies the overall timeout for the entire operation (applied individually for every loop iteration).
Ftp-Meas-To:
<ms>
Specifies the measurement timeout for the download operation. Even if not all bytes have been
transferred when reaching this timeout, the measurement is gracefully terminated. Use this option
to achieve constant measurement duration regardless of the current transfer speed.
Ftp-BlockSize:
<bytes>
Block size for FTP reception and transmission on windows socket level. The block size should be a
tradeoff between measurement accuracy (small blocks) and good performance (large blocks).
Optimum performance can be achieved if the block size is chosen to generate IP packets of the
specified MTU size. If for example the MTU size is 1464 bytes, the optimum buffer size is 1424 bytes
(1464 - 20 bytes IP header - 20 bytes TCP header). Good measurement quality requires small
blocks, e.g. for GPRS with 100 kbit/s 15 kB/s with throughput accuracy of 10 %, the buffer size
should be approximately 1500 bytes.
DontUseDefaults:
<bool>
<profile_name>
(string)
Specifies the profile name to be displayed in the profile selection combo box. The name should be
unique to allow the user to identify the ICMP profile.
Loop-Count:
<count>
Specifies the total number of loop iterations for this task (GUI parameter loops).
Loop-Pause:
<ms>
(integer, optional)
Specifies the pause between loop iterations (GUI parameter loop delay).
Ras-Dial:
(No|Auto|Forced|Iterated)
Specifies the RAS connection mode (GUI parameter act/deact RAS conn..), possible values are:
No
... The RAS connection will not be established, even if it is not active
Auto
... The RAS connection will only be established if not already active.
Forced
... The RAS connection will be disconnected if active and then re-connected in the
first loop iteration. Subsequent loop iterations will use Auto behavior, i.e. the
RAS connection will be re-used if possible, a new connection will be established
if the existing connection got lost.
Iterated
... The RAS connection will be disconnected if active and then re-connected in
every loop iteration.
Interactive measurements support Auto and Iterated only, depending on the checkbox act/deact
RAS conn. in every loop. All values are supported in job execution, default mode is No.
Ras-Hangup:
(No|Yes)
Specifies the RAS hang up mode (no GUI parameter available), possible values are:
No
... The RAS connection will not be closed.
Yes
... The RAS connection will be closed in every loop iteration.
This parameter is not used in interactive measurements (RAS-Dial is used instead). The parameter
is supported in job execution, default mode is No.
Note: In addition to these RAS parameters, the parameters in the [RasDefaults] sections are used.
Usually the RAS connection will be closed after a measurement, this behavior can be overruled by
setting Ras-DontClose: True in [RasDefaults].
Ras-Wait:
<ms>
(integer, optional)
<host>
(string, mandatory)
Specifies the host the packet should be sent to (GUI parameter host). Please be sure the specified
host will respond to ICMP ping requests.
41
Technical Reference
Note: Some personal firewalls dont accept ping packets with 0 bytes payload, use some payload
bytes if you experience this problem.
Ping-Count:
<number>
Specifies the number of packets to be transmitted per block (GUI parameter packets).
Ping-Size:
<bytes>
Specifies the payload size in bytes (GUI parameter payload) and will directly influence the ICMP and
IP packet sizes:
ICMP packet size: ICMP payload size + 8 bytes ICMP header
IP packet size:
ICMP packet size + 20 bytes IP header
Ping-Unix:
(True|False)
Specifies if windows or unix mode is to be used (GUI parameter unix mode). If you specify Unix
mode packets will be transmitted with a constant time increment as specified with the advance
parameter
(Ping-Advance). In default (Windows) mode, a packet will be transmitted either after
a timeout (Ping-Timeout) or after the reception of a packet as specified with the advance parameter
(Ping-Advance).
Ping-Advance:
<ms>
Specifies the timing advance parameter (GUI parameter adv). In Unix mode this is the time
increment from transmission to transmission, in Windows mode it specifies the time increment from
packet reception to the
next transmission.
Ping-Timeout:
<ms>
Specifies the receive timeout parameter (GUI parameter to). In Unix mode a packet is always
transmitted after Ping-Advance ms, thus the timeout value is only relevant for the last (lost)
packets, in Windows mode a packet is transmitted Ping-Advance ms after the reception of a packet
or after a timeout.
Ping-Blocks:
<number>
In addition to the loop iterations, it is possible to specify a number of block iterations (GUI
parameter blocks). Every block includes the specified number of packets succeeded by an idle time
as specified with Ping-Delay. The RAS connection is not disconnected between blocks.
Ping-Delay:
<ms>
<number>
Specifies the number of packets not to be included in average RTT calculation. If Ping-Count is 10
and Ping-DontAverage is 4, only the last 6 packets are included in the average.
DontUseDefaults:
<bool>
<profile_name>
(string)
Specifies the profile name to be displayed in the profile selection combo box. The name should be
unique to allow the user to identify the UDP profile.
Loop-Count:
<count>
Specifies the total number of loop iterations for this task (GUI parameter loops).
Loop-Pause:
<ms>
(integer, optional)
Specifies the pause between loop iterations (GUI parameter loop delay).
Ras-Dial:
(No|Auto|Forced|Iterated)
Specifies the RAS connection mode (GUI parameter act/deact RAS conn..), possible values are:
No
... The RAS connection will not be established, even if it is not active
Auto
... The RAS connection will only be established if not already active.
Forced
... The RAS connection will be disconnected if active and then re-connected in the
first loop iteration. Subsequent loop iterations will use Auto behavior, i.e. the
RAS connection will be re-used if possible, a new connection will be established
if the existing connection got lost.
Iterated
... The RAS connection will be disconnected if active and then re-connected in
every loop iteration.
PocketOptimizer 1.1.1.32 26.Jan.2011
42
Technical Reference
Interactive measurements support Auto and Iterated only, depending on the checkbox act/deact
RAS conn. in every loop. All values are supported in job execution, default mode is No.
Ras-Hangup:
(No|Yes)
Specifies the RAS hang up mode (no GUI parameter available), possible values are:
No
... The RAS connection will not be closed.
Yes
... The RAS connection will be closed in every loop iteration.
This parameter is not used in interactive measurements (RAS-Dial is used instead). The parameter
is supported in job execution, default mode is No.
Note: In addition to these RAS parameters, the parameters in the [RasDefaults] sections are used.
Usually the RAS connection will be closed after a measurement, this behavior can be overruled by
setting Ras-DontClose: True in [RasDefaults].
Ras-Wait:
<ms>
(integer, optional)
<host>:<port>
(string, mandatory)
Specifies the traffic server and TCP port to be used (no GUI parameter available). The remote
endpoint for UDP measurements has to be a traffic generator server supporting PocketOptimizer's
traffic generator protocol, currently this is NDFA server 0.40 and above.
Udp-User:
<user>
(string, optional)
Specifies the user name for the traffic generator server (no GUI parameter available).
Udp-Pass:
<password>
(string, optional)
Specifies the password for the traffic generator server (no GUI parameter available).
Udp-DL-Size:
<bytes>
<bytes>
<pkts/sec>
<pkts/sec>
<seconds>
<ms>
Specifies the timeout interval for establishing the TCP control socket connection.
Udp-Recv-To:
<ms>
<ms>
<ms>
Specifies the overall timeout for the entire operation (applied individually for every loop iteration).
DontUseDefaults:
<bool>
RAS:<entry>|HwNd:<device>
(string, internal)
The parameter RAS-Entry is an internal parameter that is not available in job or configuration files.
It is automatically provided by the GUI an contains the selected connection.
RAS-User:
<user>
(string, optional)
Specifies the RAS user name. If user name and password are empty, the RAS entrys user is used.
RAS-Password:
<password>
(string, optional)
Specifies the RAS password. If user name and password are empty, the RAS entrys password is
used.
43
Technical Reference
RAS-APN:
<apn>
(string, optional)
Specifies the APN if required by the internet connection. The parameter is not used for RAS
connections but is required for Huawei NDIS connections.
RAS-DefUser:
<user>
(string, optional)
Specifies the default RAS user name. This user name is only used if RAS-User is empty and the RAS
entry does not contain a user name and a password.
RAS-DefPassword:
<password>
(string, optional)
Specifies the default RAS password. This password is only is only used if RAS-Password is empty
and the RAS entry does not contain a user name and a password.
RAS-DefAPN:
<apn>
(string, optional)
Specifies the default APN if required by the internet connection. The parameter is used if RAS-APN is
empty.
RAS-DontClose:
(Yes|No)
Specifies if the RAS connection is to be kept open after an individual measurement or a job
execution. The default behavior is to close any connection established by PocketOptimizer
RAS-Timeout:
<ms>
<number>
(Yes|No)
(bool, internal)
This parameter is not available in job and configuration files. It is set to true if the command line
argument /norasdial is specified.
RAS-ModemInfo-Enable: (Yes|NO)
Specifies if the modem and network registration shall be queried (with AT commands or RIL).
RAS-ModemInfo-Timeout: <ms>
RAS:<entry>|HwNd:<device>
(string, internal)
The parameter RAS-Entry is an internal parameter that is not available in job or configuration files.
It is automatically provided by the GUI and contains the selected connection.
AT-Command-<nn>:
<AT command>
(string, optional)
<ms>
<count>
(Yes|No)
Defines if the sequence of AT commands shall be continued if an error occurs. Otherwise the
sequence is interrupted and restarted at the first command.
AT-Master-To:
<ms>
Timeout to wait for network registration. If the value is set to 0, no registration check is executed.
Otherwise the modem is given the specified time to achieve network registration.
5.2.4.7 Parameters for parallel tasks
Parallel tasks only support a minimum parameter set.
Known parameters in for parallel tasks
Name:
<profile_name>
(string)
Specifies the profile name to be displayed in the profile selection combo box. The name should be
unique to allow the user to identify the HTTP profile.
44
Technical Reference
Loop-Count:
<count>
Specifies the total number of loop iterations for this task (GUI parameter loops).
Loop-Pause:
<ms>
(integer, optional)
Specifies the pause between loop iterations (GUI parameter loop delay).
Soft-Stop:
<true/false/yes/no>
(bool, optional)
If this parameter is set to true, all parallel tasks are soft stopped as soon as the first parallel task
ends. Soft stop is similar to the measurement timeout, i.e. the task is assumed successful even if
not all bytes have been transferred. This feature can be used in parallel up/downloads to ensure the
entire measurement is parallel. Soft stop is supported by FTP tasks only.
Force use of the specified RAS connection, the value overrides the previous input on the tab sheet
user data. An error is generated if the connection does not exist.
/job:<job-name>
Force use of the specified job. The argument has to be the job's file name without path and
extension and overrides the job selection in the job form. An error is generated if the job does not
exist.
/initstr:<modem init string>
Force the specified modem init string. This function is only available if /ras is used. The value
overrides the modem settings for the RAS connection's modem in the registry before establishing
the connection. Write access to SYSTEM\\CurrentControlSet\\Control\\Class\\{4D36E96D-E32511CE-BFC1-08002BE10318} is required.
/masterlog:<file>
Write master log output to the specified file. The absolute file name should be given.
One line per task is appended to the master log file to check job execution. It is recommended to
use WinTail or a similar application to watch the output of the master log file during or after a
measurement.
/needgps
Force GPS coordinates. An error will be generated if GPS coordinates are not available after a 30
second timeout.
/needlocation
Force input of a location in the tab sheet user data. If the argument is specified, a previous location
is cleared and the user is forced to enter a location before starting a job. Alternatively the location
can be fetched from a configuration file if /autolocation is specified.
/needoperator
Force input of an operator in the tab sheet user data. If the argument is specified, a previous
operator is cleared and the user is forced to enter an operator before starting a job. Alternatively
the location can be queried from the RAS connection's associated modem if /autooperator is
specified.
/clearlocation
Clear the content of the location in the tab sheet user data (automatically done if /autolocation is
specified).
/clearoperator
Clear the content of the operator in the tab sheet user data (automatically done if /autooperator is
specified).
/autoinitstr
Force modem initialization string for current operator. This function is only available if /ras is
specified. PocketOptimizer will try to query the mobile's IMSI and determine the associated
operator. If the mobile is associated a modem init string, it will be forced for the RAS connection's
mobile (see /initstr).
Please refer to chapter 5.1.2.3, section [Operators] for details on operator configuration.
45
Technical Reference
/autooperator
Enable automatic operator detection. This function is only available if /ras is specified.
PocketOptimizer will try to query the mobile's IMSI and determine the associated operator. An error
will be generated if the operator cannot be determined.
Please refer to section chapter 5.1.2.3, section [Operators] for details on operator configuration.
/autolocation
Enable automatic location determination. PocketOptimizer matches the GPS coordinates to the
coordinates in the file coordinates.csv and selects the proper location. An error will be generated if
the operator cannot be determined.
Please refer to section 5.1.6 for details on location configuration.
/autorun
Automatically execute the job specified in the /job argument. PocketOptimizer will automatically
terminate after the job has finished.
/silent
Prevent modal error messages for unattended operation. If the argument is not specified, a
message box will indicate errors due to command line arguments and block the application until the
user acknowledges it. If the argument is specified, no message box will be displayed, the error will
only be written to the master log file. This avoids blocking unattended operation in measurement
scripts.
trigger points:
timeout:
calculation:
m.1000,
m.1001,
m.1002,
m.1003,
m.1004,
[1]
[1]
[1]
[seconds]
[seconds]
RAS-Connect
110
46
Technical Reference
...
calculation:
calculation:
calculation:
the local time in XML format when the job was started
calculation:
5.4.2.2 Text definition for all measurements (mobile status for Win32 only)
These texts are only available for the Win32 platform. On the Pocket PC platform it is currently not
supported to access the mobile directly, thus the information is not available and the tests are not
created.
Text 120: IMSI
calculation:
calculation:
calculation:
calculation:
AT+CREG sent to mobile or RIL_GetCellTowerInfo (not all mobiles support extended network info)
AT+CREG sent to mobile or RIL_GetCellTowerInfo (not all mobiles support extended network info)
calculation:
AT^SYSINFO sent to mobile (not all mobiles support extended network registration info),
not available with RIL
calculation:
AT^SYSINFO decoded or RIL_GetCurrentSystemType used
possible values: AT. AMPS, CDMA, GSM, HDR, UMTS, GPS, NONE, N/A
RIL: IS95A, IS95B, CDMA, GSM, GPRS, EDGE, EVDO, EVDV, UMTS, HSPA, NONE, N/A
47
Technical Reference
300
301
302
303
304
305
120
121
123
124
125
126
127
128
129
Operator Id
User name
Location
Cell Id
IP Address(es)
Job time
IMSI
IMEI
signal level
MCC-MNC
LAC
CI
SysInfo
SysType
CGI
[1]
1 - (1-PI520c)(1-PI520d)
PI521b + PI521c
trigger points:
timeout:
calculation:
as in PI523a
defined in job file
# incomplete transfers (timeout) / # total transfers
calculation:
1 (1-PI520d)(1-KPI522)
calculation:
PI521c + PI523a
48
Technical Reference
calculation:
same as in PI520d
t(stop trigger) t(start trigger) = t(first response) - t(first request)
start trigger:
stop trigger:
calculation:
same PI523a
same PI523a
please refer to chapter 5.4.8.1
start trigger:
stop trigger:
calculation:
before TCP connect (i.e. connect() API call, i.e. before TCP SYN packet)
after TCP lookup (i.e. connect() API call, i.e. after TCP SYN/ACK response)
t(stop trigger) t(start trigger)
Note: Time consumption and data transferred for fetching preload-URLs will not be considered in KPI
calculation.
Note: In addition to the HTTP KPIs described here, TCP KPIs can be generated if the NetCap sniffer
and TShark decoding is used (Win32 only).
5.4.3.2 Report/KPI transmission for HTTP measurements
ticket/scenario/qi:
ticket/scenario/rating:
ticket/scenario/metrics/metric.id=5204
ticket/scenario/metrics/metric.id=5213
ticket/scenario/metrics/metric.id=5200
ticket/scenario/metrics/metric.id=5210
ticket/scenario/metrics/metric.id=5220
ticket/scenario/metrics/metric.id=5231
ticket/scenario/metrics/metric.id=5230
ticket/scenario/metrics/metric.id=5239
ticket/scenario/metrics/metric.id=5240
ticket/scenario/metrics/metric.id=5250
ticket/scenario/metrics/metric.id=5012
10 on success, 0 otherwise
always 1
PI520d, IP Service Access Failure Ratio
PI521c, IP Service Access Time
KPI520, Service Non Accessibility
KPI521, Service Access Time
KPI522, Data Transfer Cut-off Ratio
PI523a, Data Transfer Time
KPI523, Mean User Data Rate,
PI523x, Data Byte Count
KPI524, Session Failure Ratio
KPI525, Session Time
M.5012, Peak Throughput (2s)
[TASK]
Task-Type:
RAS-Connect
[TASK]
Task-Type:
Task-Comment:
Scenario-Id:
Loop-Count:
Http-Url:
HTTP
100kB HTTP download
111
1
http://194.48.139.238/merlin/HTTP_Files/100KB.dl
[TASK]
Task-Type:
RAS-Hangup
49
Technical Reference
[1]
[1]
[1]
[seconds]
[1]
[seconds]
[1]
[seconds]
[bit/s]
[bytes]
[1]
[seconds]
[bit/s]
</location>
<duration>7.076</duration>
<comment>loop 1, block 2, loop 1 (http)</comment>
<qi>10</qi>
<rating>1</rating>
<metrics>
<metric id="5204" comment="520d-ipsvc-acc-fail-ratio" unit="">0</metric>
<metric id="5213" comment="521c-ipsvc-acc-time" unit="sec">0.784</metric>
<metric id="5200" comment="520-svc-non-acc-ratio" unit="">0</metric>
<metric id="5210" comment="521-svc-acc-time" unit="sec">0.784</metric>
<metric id="5220" comment="522-data-xfer-cutoff-ratio" unit="">0</metric>
<metric id="5231" comment="523a-data-xfer-time" unit="sec">6.174</metric>
<metric id="5230" comment="523-mean-data-rate" unit="bit/s">16630.0</metric>
<metric id="5239" comment="523x-data-bytes" unit="bytes">102674</metric>
<metric id="5240" comment="524-session-fail-ratio" unit="">0</metric>
<metric id="5250" comment="525-session-time" unit="sec">6.958</metric>
<metric id="5012" comment="peak_thput_2s" unit="bit/s">18234.0</metric>
<metric id="300" comment="operator">23201</metric>
<text id="301" comment="user">your user name</text>
<text id="302" comment="location">your location</text>
<text id="303" comment="cell-id">your cell id</text>
<text id="304" comment="IP-addrs">128.130.6.7</text>
<text id="305" comment="jobtime">2005-11-13T01:23:28+01:00</text>
<text id="120" comment="imsi">232014520069332</text>
<text id="121" comment="imei">356936000650783,NZ2A5BP032</text>
<text id="123" comment="signal_dbm">-105 dBm</text>
<text id="124" comment="mcc_mnc">232-01</text>
<text id="125" comment="creg_lac">0002</text>
<text id="126" comment="creg_ci">5803</text>
</metrics>
</scenario>
</ticket>
1 - (1-PI520c)(1-PI520d)
calculation:
PI521b + PI521c
as in PI523a
defined in job file
# incomplete transfers (timeout) / # total transfers
calculation:
1 (1-PI520d)(1-KPI522)
calculation:
PI521c + PI523a
same as in PI520d
t(stop trigger) t(start trigger) = t(first response) - t(first request)
start trigger:
stop trigger:
calculation:
same PI523a
same PI523a
please refer to chapter 5.4.8.1
start trigger:
50
Technical Reference
stop trigger:
calculation:
start trigger:
stop trigger:
calculation:
before TCP connect (i.e. connect() API call, i.e. before TCP SYN packet)
after TCP lookup (i.e. connect() API call, i.e. after TCP SYN/ACK response)
t(stop trigger) t(start trigger)
Note: In addition to the FTP KPIs described here, TCP KPIs can be generated if the NetCap sniffer
and TShark decoding is used (Win32 only).
5.4.4.2 Report/KPI transmission for FTP measurements
ticket/scenario/qi:
ticket/scenario/rating:
ticket/scenario/metrics/metric.id=5204
ticket/scenario/metrics/metric.id=5213
ticket/scenario/metrics/metric.id=5200
ticket/scenario/metrics/metric.id=5210
ticket/scenario/metrics/metric.id=5220
ticket/scenario/metrics/metric.id=5231
ticket/scenario/metrics/metric.id=5230
ticket/scenario/metrics/metric.id=5239
ticket/scenario/metrics/metric.id=5240
ticket/scenario/metrics/metric.id=5250
ticket/scenario/metrics/metric.id=5012
10 on success, 0 otherwise
always 1
PI520d, IP Service Access Failure Ratio
PI521c, IP Service Access Time
KPI520, Service Non Accessibility
KPI521, Service Access Time
KPI522, Data Transfer Cut-off Ratio
PI523a, Data Transfer Time
KPI523, Mean User Data Rate
PI523x, Data Byte Count
KPI524, Session Failure Ratio
KPI525, Session Time
M.5012, Peak Throughput (2s)
[1]
[1]
[1]
[seconds]
[1]
[seconds]
[1]
[seconds]
[bit/s]
[bytes]
[1]
[seconds]
[bit/s]
[TASK]
Task-Type:
RAS-Connect
[TASK]
Task-Type:
Task-Comment:
Scenario-Id:
Loop-Count:
Ftp-Url:
Ftp-DataSize:
Ftp-Direction:
Ftp-User:
Ftp-Pass:
FTP
100kB FTP upload
112
1
ftp://merlin.mobilkom.at/upload.txt
102400
Put
user
pass
[TASK]
Task-Type:
RAS-Hangup
51
Technical Reference
Metric
Metric
Metric
Metric
Metric
2001:
2002:
2003:
2004:
2005:
ping
ping
ping
ping
ping
tx count
packets lost
average RTT
min RTT
max RTT
10 * packets_rx / packets_tx
always 1
ping tx count
ping packets lost
ping avg RTT
ping min RTT
ping max RTT
[TASK]
Task-Type:
RAS-Connect
[TASK]
Task-Type:
Task-Comment:
Scenario-Id:
Loop-Count:
Loop-Pause:
Ras-Dial:
Ping-Addr:
Ping-Count:
Ping-Size:
Ping-Unix:
Ping-Advance:
Ping-Timeout:
Ping-Blocks:
Ping-Delay:
ICMP
20 pings
113
1
1000
Auto
www.mobilkom.at
20
0
True
500
4000
1
5000
[TASK]
Task-Type:
RAS-Hangup
52
Technical Reference
[1]
[pkts]
[pkts]
[seconds]
[seconds]
[seconds]
<scenario id="113">
<mtime>2005-11-13T01:33:43+01:00</mtime>
<agent id="101">PocketOptimizer</agent>
<location id="" type="WGS84">
<longitude>48.22765</longitude>
<latitude>16.39849</latitude>
</location>
<duration>10.222</duration>
<comment>loop 1, block 2, loop 1 (icmp)</comment>
<qi>10</qi>
<rating>1</rating>
<metrics>
<metric id="2001" comment="2001-ping-tx-count" unit="">20</metric>
<metric id="2002" comment="2002-ping-lost" unit="">0</metric>
<metric id="2003" comment="2003-ping-avg-rtt" unit="sec">0.183</metric>
<metric id="2004" comment="2004-ping-min-rtt" unit="sec">0.181</metric>
<metric id="2005" comment="2005-ping-max-rtt" unit="sec">0.187</metric>
<metric id="300" comment="operator">23201</metric>
<text id="301" comment="user">your user name</text>
<text id="302" comment="location">your location</text>
<text id="303" comment="cell-id">your cell id</text>
<text id="304" comment="IP-addrs">128.130.6.7</text>
<text id="305" comment="jobtime">2005-11-13T01:33:43+01:00</text>
<text id="120" comment="imsi">232014520069332</text>
<text id="121" comment="imei">356936000650783,NZ2A5BP032</text>
<text id="123" comment="signal_dbm">-105 dBm</text>
<text id="124" comment="mcc_mnc">232-01</text>
<text id="125" comment="creg_lac">0002</text>
<text id="126" comment="creg_ci">5803</text>
</metrics>
</scenario>
</ticket>
calculation:
start trigger:
stop trigger:
calculation:
calculation:
calculation:
calculation:
start trigger:
stop trigger:
calculation:
calculation:
10 * packets_rx / packets_tx
always 1
UDP DL packet count
UDP DL packet loss
UDP DL throughput
UDP DL jitter
UDP DL RTT
UDP UL packet count
UDP UL packet loss
53
Technical Reference
[1]
[pkts]
[pkts]
[bits/s]
[seconds]
[seconds]
[pkts]
[pkts]
ticket/scenario/metrics/metric.id=2123
ticket/scenario/metrics/metric.id=2124
ticket/scenario/metrics/metric.id=2125
UDP UL throughput
UDP UL jitter
UDP UL RTT
[bits/s]
[seconds]
[seconds]
[TASK]
Task-Type:
RAS-Connect
[TASK]
Task-Type:
Task-Comment:
Scenario-Id:
Loop-Count:
Udp-DL-Size:
Udp-UL-Size:
Udp-DL-Rate:
Udp-UL-Rate:
Udp-Duration:
Udp-Server:
Udp-User:
Udp-Pass:
UDP
10 sec UDP test
114
1
64
64
10
10
10
merlin.mobilkom.at:8877
user
pass
[TASK]
Task-Type:
RAS-Hangup
54
Technical Reference
average of all IP packet sizes for the analyzed TCP stream in one direction
description:
maximum of all IP packet sizes for the analyzed TCP stream in one direction
description:
# of packets not including the first SYN packets and the packets from RST or FIN
if the connection is terminated with RST pending retransmissions for data before the sequence number at
the occurrence of RST are included in the evaluation, all other
the fraction of re-transmitted data packets over the number of data packets
packets are selected as for KPI 6x11
KPI 6x13 / KPI 6x12
calculation:
the maximum TCP window size for the data direction (that is indicated in the reverse direction)
packets are selected as for KPI 6x11
the average TCP window size for the data direction (that is indicated in the reverse direction)
packets are selected as for KPI 6x11
the average TCP window size for re-transmitted packets (that is indicated in the reverse direction)
description:
description:
average delay from packet loss (if detected) to retransmission (lower bound)
55
Technical Reference
the time is calculated from the packet following the packet loss to the re-transmitted packet
average delay from packet loss (if detected) to retransmission (upper bound)
the time is calculated from the packet preceeding the packet loss to the re-transmitted packet
description of connection(s)
avg. IP packet len
max. IP packet len
frac. of packets with max. IP packet len
number of packets
number of re-transmitted packets
frac. of retransmitted packets
frac. of retransmitted/lost bytes
max. TCP window size
avg. TCP window size
avg. rem. TCP window size
avg. inter-packet time
stddev. inter-packet time
retransmission delay (lower bound)
retransmission delay (upper bound)
[bytes]
[bytes]
[1]
[pkts]
[pkts]
[1]
[1]
[bytes]
[bytes]
[bytes]
[s]
[s]
[s]
[s]
56
Technical Reference
ExeName:
CaptureTo-Folder:
CaptureTo-Type:
CaptureTo-Location:
DumpFile-Path:
DumpFile-Ext:
DontTerminate:
"\Programme\CEMyNetwork Wireless1.0\cemynetworkw.exe"
SnifferFiles
Ethereal, tcpdump (*.cap)
"CF Karte"
"\CF Karte\SnifferFiles\"
.cap
True
Note: It's important to enter the exact characters into the configuration file!
Edit the machine configuration file and enter the values as gathered from the dialog window.
ExeName:
the sniffer's executeable file name
CaptureTo-Folder:
the folder name as selected in the Capture To... dialog
CaptureTo-Type:
the file type as selected in the Capture To... dialog
CaptureTo-Location:
the location as Capture To... dialog
DumpFile-Path:
this is the full path given by CaptureTo-Location and CaptureTo-Folder
DumpFile-Ext:
the extension as specified by CaptureTo-Type
DontTerminate:
set this parameter to true to avoid termination of the sniffer application
Note: DumpFile-Path and DumpFile-Ext are required to copy the sniffer file to PocketOptimizer's log
directory. If these parameters are not correct, PocketOptimizer will not be able to locate the sniffer file
in the file system and copy it to the log directory.
"C:\Program Files\SupportToolsXP\NetCap.exe"
.cap
"LAN-Verbindung"
"WAN (PPP/SLIP) Interface"
57
Technical Reference
Look up the desired LAN interface if required and the desired RAS interface
Edit the machine configuration file and enter the values as gathered from the dialog window.
ExeName:
the sniffer's executeable file name
DumpFile-Ext:
the file extension, usually .cap
SnifferParams:
additional parameters to the sniffer if required
InterfaceName:
name of interface to be used, better use InterfaceName-LAN or RAS
instead
InterfaceName-LAN:
interface name if no RAS connection is used
InterfaceName-RAS:
interface name if a RAS connection is used
58
Technical Reference
59
Technical Reference
60
Technical Reference
;mobile_signal_dbm:
-83 dBm
;mobile_cops:
+COPS: 0,2,"23201",2
;mobile_mcc_mnc:
232-01
;mobile_creg:
+CREG: 0,1
;mobile_creg_lac:
N/A
;mobile_creg_ci:
N/A
;mobile_cgatt:
+CGATT: 1
;mobile_sysinfo:
^SYSINFO:2,3,0,5,1,,4
;gps 48,22758 16,39877
20:38:02
;loop seq
thput gps_lat
gps_lon
gps_time
0
0
8,76
48,22753
16,39878
20:38:09
0
1
8,76
48,22753
16,39880
20:38:10
0
2
8,76
48,22754
16,39881
20:38:11
0
3
13,14 48,22753
16,39881
20:38:12
0
4
17,52 48,22752
16,39881
20:38:13
0
5
13,14 48,22752
16,39881
20:38:14
0
6
17,52 48,22751
16,39881
20:38:15
0
7
35,04 48,22750
16,39881
20:38:16
0
8
48,18 48,22749
16,39881
20:38:17
0
9
33,98 48,22749
16,39881
20:38:18
;ras-setup-time:
3385
ms
;meas-time:
15512 ms
;ip-addresses:
192.168.1.61 10.248.40.74
;ftp-success:
ok
;init-time:
0
ms (1..2)
;dns-lookup-time:
40
ms (2..3)
;tcp-conn-time:
3264
ms (3..4)
;ftp-setup-time:
1073
ms (4..5)
;ftp-cmd-time:
800
ms (5..6)
;data-xfer-time:
9794
ms (6..7, PI523a)
;shutdown-time:
271
ms (7..8)
;destruct-time:
113
ms (8..9)
;meas-time:
15355 ms (1..9)
;session-time:
15242 ms (2..8)
;first-resp-delay:
10
ms
;first-rtt:
161
ms
;data-bytes:
204800
;mean-data-rate:
20,91 kB/s (KPI523) = 167,29 bit/s (PL) ~
;session-data-rate: 13,44 kB/s
= 107,49 bit/s (PL) ~
61
Technical Reference
;mobile_creg_ci:
N/A
;mobile_cgatt:
+CGATT: 1
;mobile_sysinfo:
^SYSINFO:2,3,0,5,1,,4
;gps 48,22754 16,39879
20:39:24
;loop seq
start stop
rtt
gps_lat
0
0
120
270
145
48,22754
0
1
1091
1211
123
48,22754
0
2
2093
2213
121
48,22754
0
3
3094
3214
116
48,22754
0
4
4096
4216
117
48,22753
0
5
5097
5207
115
48,22753
0
6
6098
6429
334
48,22753
0
7
7090
7230
140
48,22753
0
8
8091
8231
142
48,22753
0
9
9093
9213
119
48,22753
0
10
10094 10214 117
48,22752
0
11
11096 11216 117
48,22752
0
12
12097 12207 115
48,22751
0
13
13098 13209 114
48,22750
0
14
14090 14210 122
48,22749
0
15
15091 15212 121
48,22748
0
16
16093 16213 119
48,22748
0
17
17094 17234 138
48,22747
0
18
18096 18216 115
48,22746
0
19
19097 19227 135
48,22746
;ras-setup-time:
3475
ms
;meas-time:
20099 ms
;ip-addresses:
192.168.1.61 10.248.40.78
;icmp-tx-count:
20
;icmp-loss:
0
(0,0 %)
;average-rtt:
134,3 ms
;min-rtt:
114
ms
;max-rtt:
334
ms
gps_lon
16,39879
16,39879
16,39879
16,39879
16,39879
16,39879
16,39879
16,39879
16,39879
16,39880
16,39880
16,39880
16,39881
16,39881
16,39881
16,39881
16,39881
16,39881
16,39881
16,39882
gps_time
20:39:24
20:39:25
20:39:26
20:39:27
20:39:28
20:39:29
20:39:30
20:39:31
20:39:32
20:39:33
20:39:34
20:39:35
20:39:36
20:39:37
20:39:38
20:39:39
20:39:40
20:39:41
20:39:42
20:39:43
62
Technical Reference
deg
deg
0
0
0.661
0.687
5.288
5.496
48.22785 16.39859 21:03:26
0
1
0.639
0.626
5.112
5.008
48.22786 16.39859 21:03:28
0
2
0.639
0.639
5.112
5.112
48.22786 16.39859 21:03:28
...
;ras-setup-time:
3274 ms
;meas-time:
28711 ms
;ip-addresses:
192.168.1.61 10.248.40.80
;dl-pkt-count:
150
;dl-pkt-loss:
0
;dl-thput:
0.65 kB/s = 5.16 kbit/s
;dl-jitter:
37.8 ms
;dl-rtt:
139.7 ms
;ul-pkt-count:
150
;ul-pkt-loss:
0
;ul-thput:
0.65 kB/s = 5.16 kbit/s
;ul-jitter:
14.4 ms
;ul-rtt:
136.2 ms
128.6
148.3
16.3
30.0
0
134.3
140.4
8.1
11.0
0
136.6
138.1
10.8
13.1
0
(PL) ~ 7.42
kbit/s (IP)
(PL) ~ 7.42
kbit/s (IP)
Additional log files containing the packets individual time stamps are automatically generated
according to the NDFA file format specification.
63
Technical Reference
m.5230:
m.5230,e.ext1.thput
[PO.RAS]
mfid:
m.2003:
PO.RAS.User
m.2003,e.ext2.min_rtt
64
Technical Reference
Contents
Introduction................................................................................................................................................1
1.1 What is PocketOptimizer......................................................................................................................1
1.2 Field of application ..............................................................................................................................1
1.3 Revision History ..................................................................................................................................2
1.4 Known limitations................................................................................................................................4
1.5 This manual........................................................................................................................................4
Installation .................................................................................................................................................5
2.1 System requirements...........................................................................................................................5
2.1.1 System requirements for PocketOptimizer Mobile Edition.................................................................5
2.1.2 System requirements for PocketOptimizer Win32 Edition .................................................................5
2.2 Removing previous installations ...........................................................................................................5
2.2.1 Removing PocketOptimizer Mobile Edition ......................................................................................5
2.2.2 Removing PocketOptimizer Win32 Edition.......................................................................................6
2.3 Installing PocketOptimizer ...................................................................................................................6
2.3.1 Installing PocketOptimizer Mobile Edition........................................................................................6
2.3.2 Installing PocketOptimizer Win32 Edition........................................................................................6
2.3.3 Additional Installation information..................................................................................................7
2.4 Registering PocketOptimizer ................................................................................................................7
2.4.1 Getting the Machine Id..................................................................................................................7
2.4.2 Automatic registration with license server.......................................................................................7
2.4.3 Manual registration with license server ...........................................................................................9
2.4.4 Manual registration with license utility (branded versions only) ........................................................9
2.5 Setting up the configuration.................................................................................................................9
2.5.1 Configuration file format.............................................................................................................. 10
2.5.2 Setting up a different server for synchronization ........................................................................... 10
2.5.3 Setting up directories .................................................................................................................. 10
2.5.4 GPS configuration ....................................................................................................................... 10
2.5.5 Sniffer configuration.................................................................................................................... 12
Operations Manual .................................................................................................................................... 13
3.1 PocketOptimizers main window ......................................................................................................... 13
3.1.1 User data and RAS configuration.................................................................................................. 13
3.1.2 Main menu functions................................................................................................................... 13
3.2 Interactive measurements ................................................................................................................. 14
3.2.1 HTTP measurements................................................................................................................... 14
3.2.2 FTP measurements ..................................................................................................................... 16
3.2.3 ICMP measurements ................................................................................................................... 17
3.2.4 UDP measurements .................................................................................................................... 19
3.2.5 Profile manager .......................................................................................................................... 20
3.3 Job measurements ............................................................................................................................ 21
3.3.1 Running Jobs.............................................................................................................................. 21
3.3.2 Creating jobs .............................................................................................................................. 21
3.4 Synchronization and reporting............................................................................................................ 21
3.4.1 Synchronization .......................................................................................................................... 22
3.4.2 Reporting ................................................................................................................................... 22
Administrators Manual .............................................................................................................................. 23
4.1 PocketOptimizer Registration Utility .................................................................................................... 23
4.2 Synchronization server reference ....................................................................................................... 24
4.2.1 HTTP server requirements ........................................................................................................... 24
4.2.2 Job configuration requirements.................................................................................................... 24
4.3 Reporting server reference ................................................................................................................ 24
Technical Reference .................................................................................................................................. 26
5.1 Configuration file reference................................................................................................................ 26
5.1.1 System configuration file ............................................................................................................. 26
5.1.2 User configuration file ................................................................................................................. 31
5.1.3 Machine configuration file............................................................................................................ 33
5.1.4 Registration info file .................................................................................................................... 35
PocketOptimizer 1.1.1.32 26.Jan.2011
65
Contents
66
Contents