MyVoIPSpeed Server Manual

Introduction

Getting Started on Unix

STEP 1 : Start the Speed Test Applet

Unzip the mvss.tar file, then untar the mss.tar file in a fresh directory.

(If you are familiar with 'rpm' you could download mvss.rpm instead.
If you have chosen the rpm file, you can install with 'rpm -i <file>)

With either the tar file or the rpm file, the configure script should be run. Run the myvoipspeed_configure.sh script on Linux with:-

sh myvoipspeed_configure.sh

and on Solaris or FreeBSD

ksh myvoipspeed_configure.sh

The script will ask what directory you want to install MyVoIPSpeed into. The script will then look for and test each installed Java JVM. The first JVM that passes the test will be used. If one is not found in the /usr and /opt directory structure, you will be advised on how to obtain one.

The script will then test if there is only one ip-address the availability of port 80. If it is free that ipaddress port combination is used. If there is more than one ipaddress the script will present a list. Port 80 of the chosen address is tested, and if free it is used otherwise the user is asked to provide a port number to use, which is then again tested for availability. If that port is found to be used, the loop of question of ip-address and port is asked again until the ipaddress port is free.

For those hosts that have 'chkconfig' the script will ask if you want to install MyVoIPSpeed as a system service, so that it is started at machine boot.

Finally the script will start MyVoIPSpeed from the chosen install directory, and after a short delay of post installation configuration, the running process will tell you that you can browse to the chosen ipaddress:port

STEP 2. Start the MyVoIPSpeed Server Engine

The starting and stopping of the MyVoIPSpeed engine is with the 'start_myvoipspeed.sh' script created in step 1.

The syntax for starting is

sh <install directory>/start_myvoipspeed.sh

or if you are in that directory

start_myvoipspeed.sh

and for stopping

sh <install directory>/stop_myvoipspeed.sh

or if you are in that directory

stop_myvoipspeed.sh

When the server starts you will see some confirmation messages including the IP address and port number allocated. You can now use a browser to request the main control panel by using the URL http://<ip address:port>.

Port 80 - best practices

Please note when configuring MyVoIPSpeed, that chosing a port other than port 80 may have firewall access issues for customers.

It is suggested that you use another IP address on the server that has port 80 free.

STEP 3: Speed Test Web Pages

Once you have completed Step 2 above, you may use the example web pages provided or create your pages that incorporate the MyVoIPSpeed Server applet. In addition, there are many ways to customize the appearance and behavior of the VoIP test applet.

Using MyVoIPSpeed 's Built-in Web Server for Demonstration and Reporting Pages

The Control Panel web page (as shown in Step 2 above) and accompanying demonstration pages allow you to easily test of many MyVoIPSpeed Server features, and serve as templates for pages you can provide on your web site.

To access the control panel you just need to start up a browser with the URL address of the IP:Port displayed in Step 2, for example http://<IPaddress:port>.

Select the Perform New Test option to run VoIP tests and view various options including Custom Branding, Continous Test, and Email Results.

To view the database reports, select one of the Last Hour, Last Day or Last 30 Days options to see all speed test results for the specified time frame.

Select the Advanced Log Search option to create custom reports, line graph views or data export.

NOTE: The default password/username to access the reports is MyVoIPSpeed /iscool. You may change the account access in the myspeed.ini file. To access the Server Administration options such as server resource usage and settings, you would need to enable the AdminAccount in the myspeed.ini file. Details.

Using MyVoIPSpeed Web Pages on a Apache/IIS Server:
Setting the Codebase Parameter

To run MyVoIPSpeed bandwidth tests on your own web server such as Apache, you will need to enable the codebase option and then insert it in the HTML of the MyVoIPSpeed web page. The codebase option allows you to serve the MyVoIPSpeed test applet from a web server other than the MyVoIPSpeed web server, or even from a different system from where MyVoIPSpeed Server is installed. Details.

STEP 1

Modify the myspeed.ini file to declare the URL used to access the web page as the authorized codebase URL. For security reasons MyVoIPSpeed Server only allows requests to codebase the MyVoIPSpeed applet from the URL declared in the myspeed.ini file.

To proceed, using a text editor such as vi, scroll to the line below in the myspeed.ini file, and modify the domain and IP address to correspond to your MyVoIPSpeed Server location.

CodebaseDomains=myvoipspeed.visualware.com+205.234.111.147

STEP 2

Modify the HTML code of the voiptest.html web page copied to your web server in Getting Started Step 1 to add a codebase option in the APPLET tags, as shown below.

<applet name="myvoipspeed" code="myspeed.class" archive="voip.jar" width=600 height=400 codebase=http://myvoipspeedserver:port></applet>

In the above HTML, myvoipspeedserver is the domain (such as www.visualware.com) or IP address of your MyVoIPSpeed Server. If MyVoIPSpeed Server is using port 80 (recommended, see note below), it is not necessary to indicate the port number.

Once the codebase option is declared in the myspeed.ini and enabled in the web page, you should be able to view the speed test applet on your web server by going to http://<yourserver>/speedtest.html.

You can further modify the speedtest.html web page to include your own branding and messaging. You can also incorporate the MyVoIPSpeed applet into your own web pages by inserting the APPLET tags above into your own pages between the BODY tags.

IMPORTANT: The codebase URL declared in the myspeed.ini file must always match the IP address and/or domain name used to access the Apache/IIS web page, otherwise a ‘not authorized’ error is generated. If the MyVoIPSpeed Server and the front-end IIS/Apache web server are on the same computer server then it is advisable to allocate at least 2 IP addresses to that computer server so each web server (IIS/Apache or MyVoIPSpeed ) can both use the default port 80. If you do not do this then one of the server engines will be forced to use a port other than 80 which may cause firewall access issues for users that block the allocated port number.

The VoIP/speed test is always conducted from the server where the MyVoIPSpeed applet is served, not from where the web page is served. This is important because using the codebase option allows you to configure the installation so the front-end web servers (Apache or IIS) are not responsible for conducting the actual speed tests themselves; instead the codebase redirects the traffic to a designated backend server(s).

Customizing the Speed Test Applet

You can control many aspects of the MyVoIPSpeed Server display and behaviors through use of:

declared parameters in APPLET HTML tags of the MyVoIPSpeed web page, and/or
modifying the MyVoIPSpeed .bin file.

Some of the features that can be controlled are listed below. More information.

Modification of display text, including changing the text to another language
Change in the test parameters such as bytes per second, packets per second
Opening animation
Use of an overlay image for custom branding (Professional and NOC Editions)
Automatic start of speed test (Professional and NOC Editions)
Session ID to identify individual speed test results (Professional and NOC Editions)

You can create multiple web pages that utilize the same applet but have different display properties, and/or perform different behaviors using Javascript or myspeed.bin parameters.

Customizing the Speed Test Web Page

You can modify the voiptest.html or other example web pages to include your own branding and messaging. You can also incorporate the MyVoIPSpeed applet into your own web pages by inserting the APPLET tags above into your own pages between the BODY tags.

The Professional and NOC Editions include the ability to add an overlay image, such as your corporate logo, to the MyVoIPSpeed Server applet display. Details.

Configuring the Web Server

This section references use of the myspeed.ini file. The myspeed.ini file is located in the root install directory and may be edited with a text editor such as vi. The lines beginning with # are comments to help explain use of the various parameters.

To configure the built-in web server simply involves selecting the desired IP address and port plus some additional security options. This is done by editing the myspeed.ini found in the root install directory.

IP Address/Port. In the myspeed.ini go to the section as below:

#-----------------------------------------------------------------------
# Server bind address / port. If you do not specify a ServerAddress,
# any/all available IP addresses will be taken.
#-----------------------------------------------------------------------

ServerAddress=205.234.111.148
ServerPort=80

Simply type the IP address in the 'ServerAddress=' section and type the port number in the 'ServerPort=' section.

Recommend: You should use port 80 for web server HTTP applications, as use of other ports may be blocked by firewalls which prevent the user from accessing the server. If the server has more than one IP address it is always advisable to select one rather than defaulting to any/all.

The section below allows MyVoIPSpeed Server to automatically allocate a port.

#-----------------------------------------------------------------------
# Server port autosearch feature. If set to 'yes', and the ServerPort
# specified above is unavailable, then the product will automatically
# choose the next available port to bind to. This allows the product to
# work 'out of the box'.
#-----------------------------------------------------------------------

ServerAutoSearchPort=yes

If yes is chosen then MyVoIPSpeed Server will automatically allocate a port if the port selected is not free.

Recommend: No, otherwise a port other than port 80 may be allocated.

Throttle Delay: In the myspeed.ini go to the section as below:

#-----------------------------------------------------------------------
# Server delay system - allows throttling of requests. Specify the
# minimun number of milliseconds permitted between subsequent connection
# tests. Set ServerDelayEnabled to 'yes' to enable this feature.
# connection tests you are willing to acce
#-----------------------------------------------------------------------

ServerDelayEnabled=yes
ServerDelay=2000

Setting the throttle delay to Yes enables an automated resource management process that ensures MyVoIPSpeed maintains a comfortable workload.

Recommend: The average test time can vary but is normally around 20 seconds. Decide on how many concurrent speed tests you require and set the delay value to (average test time/concurrent tests)x1000.

VoIP Simulation Server: In the myspeed.ini go to the section as below:

#-----------------------------------------------------------------------
# VoIP simulation server - specify a UDP port to bind the server to. The
# server will be bound to the address specified in ServerAddress.
# To disable the VoIP simulation server, put VoipServerEnabled=no.
#-----------------------------------------------------------------------

VoipServerEnabled=yes
VoipServerPort=20000
VoipServerDoUpload=yes
VoipUploadServerPort=20001

MyVoIPSpeed Server conducts an actual VoIP simulation to measure the jitter and the packet loss (packets dropped) including packet discards (packets that arrive too late). Packet loss (discards and dropped) will severely affect the quality of a VoIP call. MyVoIPSpeed Server will measure packets dropped both upload and separately as download however this requires MyVoIPSpeed Server to communicate using UDP which in turn requires a UDP port to be configured.

Allow VoIP Simulations:

Set 'VoipServerEnabled' to 'yes' to enable VoIP simulations to measure Jitter and packet loss and set 'VoipServerPort' to the port number wanted for the VoIP Server.

Set 'VoipServerDoUpload' to 'yes' to enable VoIP simulations for upload, and set 'VoipUploadServerPort' to the port number wanted for the upload simulation.

Recommended: Check this option and use the default port number setting 200000.

Set up Reporting / Admin Accounts: In the myspeed.ini go to the section below:

#-----------------------------------------------------------------------
# Web accounts - used to set username / password for access to
# /MySpeedServer/ objects. Should be of the form username:password.
# ReportAccount has access to /MySpeedServer/report and
# /MySpeedServer/search, which provide log file view/search facilities.
# AdminAccount also has access to /MySpeedServer/admin which provides
# administrative tools such as performance metrics and server settings.
# To enable the ReportAccount, set ReportAccountEnabled=yes.
# To enable the AdminAccount, set AdminAccountEnabled=yes.
#
# IMPORTANT:
# If you do not specify a password, or comment out the *Account line,
# then the account will be enabled BUT REQUIRE NO PASSWORD.
# Therefore, in most cases you should NEVER set AdminAccountEnabled=yes
# without first setting AdminAccount=xxxx:yyyyy - this would be a
# security risk.
#-----------------------------------------------------------------------

ReportAccountEnabled=yes
ReportAccount=

AdminAccountEnabled=yes
AdminAccount=xxxxx:yyyyy

It is advisable to set an access username and password for both reporting and admin users. This is done by editiing the options shown above.

To enable the ReportAccount, set ReportAccountEnabled=yes.
To enable the AdminAccount, set AdminAccountEnabled=yes.

If you do not specify a password, or comment out the *Account line, then the account will be enabled BUT REQUIRE NO PASSWORD. Therefore, in most cases you should NEVER set AdminAccountEnabled=yes without first setting AdminAccount=xxxx:yyyyy - this would be a security risk. xxxxx = username and yyyyy = password.

ReportAccountEnabled.

Recommend: Yes, otherwise test reporting is disabled and no database reports are available.

ReportAccount: Enter the desired username and password or leave blank

Recommend: Leave blank if you want any and all users to have access to the MyVoIPSpeed reports. Enter a value if you want users to enter a usercode/password to review reports.

AdminAccountEnabled. You must type yes in the Enable Admin string to enable Admin reporting which includes resource reports and usage reports to better manage MyVoIPSpeed as well as test reporting.

Recommend: Yes, otherwise Admin reporting is disabled and no usage reports are available.

Username and Password: Enter the desired username and password or leave blank.

Recommend: Enter a value if you want to restrict server admin reports to a limited number of users.

Speed Test Options - Socket connection configuration: Professional and NOC Edition ONLY - in the myspeed.ini go to the section as below:

#-----------------------------------------------------------------------
# Socket servers - this is for more accurate measuring of upload /
# download speeds for those clients whose networks allow it.
# Uploads use a separate port to downloads. The IP that will be used is
# the one specified in ServerAddress. The port you specify is TCP.
# To disable the upload/download socket servers, put
# SocketServerEnabled=no.
#-----------------------------------------------------------------------

SocketServerEnabled=yes
SocketServerUploadPort=20001
SocketServerDownloadPort=20000

MyVoIPSpeed Server can run speed tests in two distinct modes: socket and HTTP. Socket mode is available in the Professional and NOC Editions. Socket mode allows MyVoIPSpeed Server to operate a test at the fastest possible speed the hardware/software can support using a raw socket-to-socket connection. This is the most accurate method for measuring the maximum speed a connection can handle.

Set SocketServerEnabled to yes to enable accurate socket speed testing and select the TCP port number to use for both upload and download. If the port is unavailable for a specific test because of firewall or other similar restrictions, then MyVoIPSpeed Server will automatically fail-over to an HTTP speed test. Assuming Port 80 is being used for HTTP this is highly unlikely to fail.

Recommend: Check box and leave default port number setting of 20000 and 20001 respectively.

NOC Edition Password

The NOC Edition includes Remote Test Agents (RTAs), sophisticated testing agents that continually measure the performance and quality of one or more Internet/Intranet connections from predefined locations. The NOC Edition password should be set prior to testing or deploying RTAs.

Set up NOC RTA password: In the myspeed.ini go to the section as below:

#-----------------------------------------------------------------------
# ***** THIS FEATURE APPLIES ONLY TO THE NOC EDITION ***********
# Allows you to set the password required by the NOC RTA agents.
# If this line is removed, the password will default to 'hello'.
#-----------------------------------------------------------------------

NOCRTAPass=mvsspassword

This allows you to set the password required by the NOC RTA agents. If this line is removed then the password will default to hello.

The Remote Testing Agent (RTA) provides the means to support automated speed testing from unattended remote locations (see RTA manual). The RTA password is needed by the RTA for secure authentication when connecting to the MyVoIPSpeed Server. If authentication fails no speed test is accepted by the server.

Recommend: To prevent non-authorized RTA agents testing against your server it is important that you change the default password of hello to a stronger password. It is recommended that you use 8 or more alphanumeric characters although MyVoIPSpeed Server does not enforce this rule

Entering a License Key

A license key is not required during the trial evaluation. Once a license key has been purchase, use the steps below to apply the key on a Unix/Linux machine:

1. Download the speedkey.zip file from the download link sent after specifying your domain to Visualware.

2. Once downloaded, unzip it and place the speedkey.bin into the /www folder in the root install directory.

3. The next time the MyVoIPSpeed Server is viewed it will show as registered (note the page may need refreshing first).

Running MyVoIPSpeed Server on an IIS/Apache Server

Best Practices

MyVoIPSpeed Server is a self contained web server which negates the need to use a commercial web server such as IIS or Apache. However it is expected that well established web sites will have the mandatory requirement to serve MyVoIPSpeed from existing IIS and/or Apache web servers. In other words the MyVoIPSpeed web pages are served directly from an IIS or Apache server and not from the MyVoIPSpeed server.

The MyVoIPSpeed Sever supports the indirect deployment model where the IIS/Apache server is responsible for serving the MyVoIPSpeed to the requesting user at the front end and MyVoIPSpeed Server is responsible for the application at the backend. To conform to the security model that governs applications running on a desktop in this way the MyVoIPSpeed applet must use the standard HTML codebase options on the IIS/Apache server. For security reasons MyVoIPSpeed Server has to be configured to allow front-end servers permission to access and serve the MyVoIPSpeed applet. If permission is not granted MyVoIPSpeed Server will decline the request and the applet will not function.

Once you have setup and deployed the web pages you want to serve MyVoIPSpeed on you must then add the necessary codebase options the applet definitions on any and all pages hosted by IIS and/or apache.

Now set the codebase on the applet

Hosting MyVoIPSpeed Applet (Standalone)

MyVoIPSpeed Standard Edition only supports running in the client browser and does not use the MyVoIPSpeed Server. In Standard mode the MyVoIPSpeed applet is restricted to initiating HTTP tests only as there is no server component available to manage the socket connection. This is test provides more of an application level speed test than a socket level speed test and is accurate only up to 10mb. Please review speed test results FAQ. Note, when running MyVoIPSpeed without the support of the MyVoIPSpeed Server the following files need to be copied from the installed MyVoIPSpeed Server www directory to the web server directory where the web page is hosted:

- data.bin
- speedkey.bin
- upload.bin
- <webpage title>.html
- MySpeed.bin
- MySpeed.jar

MyVoIPSpeed Professional and MyVoIPSpeed NOC editions also support this model if desired and allow the MyVoIPSpeed applet to be deployed as documented above.

Best Practice

MyVoIPSpeed Professional and NOC Editions support the additional ability to invoke an HTTP test while still using the MyVoIPSpeed Server. This provides the added advantage of recording the test results into the MyVoIPSpeed Server database which allows the data to be compared with other MyVoIPSpeed test results including socket versus HTTP.

Setup Applet Codebase Options

For security reasons, if the MyVoIPSpeed applet is being served from another web server or servers for example IIS or Apache then you have to authorize these front-end server access to MyVoIPSpeed . This is necessary to prevent the MyVoIPSpeed Server being used by unauthorized web servers on the Internet.

The first step in this process is to add the IP address or domain name used to access the front end server. For example if the URL is speedtest.mydomain.com then you would need to add 'speedtest.mydomain.com' as a permitted site.

Scroll down to the codebase section in the myspeed.ini (step 1)

#-----------------------------------------------------------------------
# Server codebase domains. This is a '+' separated list of domains/IP
# addresses that are permitted to host the applet. During the trial only
# one item is permitted in this list. In licensed mode, you can specify
# as many items as your license permits.
# If you specify more items than permitted, subsequent items will be
# ignored, and you will need to upgrade your license to support them.
# Leave blank or comment out to disable codebasing completely.
#-----------------------------------------------------------------------

CodebaseDomains=MyVoIPSpeed .visualware.com+205.234.111.147

This is a '+' separated list of domains/IP addresses that are permitted to host the applet. During the trial only one item is permitted in this list. In licensed mode, you can specify as many items as your license permits. If you specify more items than permitted, subsequent items will be ignored, and you will need to upgrade your license to support them. Leave blank or comment out to disable codebasing completely.

The second step is to amend the applet declaration in the web page or pages to add the codebase option to point to the installed MyVoIPSpeed Server. This requires the addition of the codebase=domain syntax for example codebase=http://www.yourdomain.com. A typical web page serving MyVoIPSpeed would therefore have an applet tag that would look like:

<applet MAYSCRIPT archive="MyVoIPSpeed .jar" code="MyVoIPSpeed .class" width=600 height=400 codebase="http://www.visualware.com" >

With the codebase option present in the web page being served the browser will request the applet from the MyVoIPSpeed Server. If the authorisation has been correctly configured (step 1 above) the request will be approved and the applet will be served.

MyVoIPSpeed Server Control Panel

Control Panel View

The MyVoIPSpeed Server Control Panel is provided only as an example page to provide ideas on how you can configure and present the MyVoIPSpeed service to your users.

Main Menu
The Main Menu provides access to the three core components namely 'New speed test', 'Database reporting' and 'administration reporting' these are documented below.

New Speed Test - Serves the MyVoIPSpeed applet and allows the user to initiate a speed test
Database reporting - Serves the Report Selection page and allows the user to search and report on previously conducted speed tests. Some predefined reports are provided:
Administration - Serves the MyVoIPSpeed administrators menu to report on resource and resource usage.
Last Hour - Reports a list of speed tests performed in the last hour
Last Day - Reports a list of speed tests performed in the last day
Last 30 days - Reports a list of speed tests performed in the last 30 days
Advanced Log Search- Take you to the database reporting view where you can specify your own criteria for a search.
Perform new test - Takes you to the MyVoIPSpeed Applet page so the user can perform a test
Administration - Take you to the Server Administration Menu (requires admin username and password if configured)

Perform a New Test

A number of example configurations for MyVoIPSpeed server are provided in the default example page. Furthermore MyVoIPSpeed Server provides a number of powerful JavaScript features that allow the user to have considerable control over how the applet performs and interacts when doing a test.

The options at the top (1 thru 6) are different types of test you can do and are explained below:

Continuous - Professional and NOC Editions only. Selecting this option will initiate a continuous test. The test will restart 10 seconds after the current test has finished and keep doing so until 5 tests have been completed. The results of the 5 tests are display as a table on the web page and all data is recorded to the reporting database and can be viewed in the reporting section.

Email Results - Selecting this option will display an 'email results' link on the web page. This provides the means email the results of the test to your service provider or system administrator depending on the reasons for doing the test. Clicking the 'email results' link will initiate the default email client and open a new email message window. At this point you can add and extra wording as explanation to the result information.
Session ID - Professional and NOC Editions only. Selecting this example option allows the user to enter a session ID (a name or something unique to identify the test). The test when complete will be tagged with this session ID. When you view the reports this session ID will appear to easily identify specific groups of tests. The session ID can also be used as a search parameter. NOTE: The session ID feature can be used to set a session ID that the user cannot change. This is useful when the session ID is allocated by a user log-on process and works well with the Auto Start (see below) option to automate testing without user interaction but still being able to record the user identification.
Branding - Professional and NOC Editions only. Selecting this option shows an example of how the MyVoIPSpeed applet can be customized and branded to provide an new look and feel.
Scripting - Selecting this option will demonstrate the use of the JavaScript feature. The demonstration uses the JavaScript call to display the results of the test in an HTML table on the web page for the user to read. This is a very powerful feature which allows the user to interact with the results to derive value beyond the simple test numbers. For example you can calculate the time it would take to transfer a file and describe that in a language that makes sense to the user.
Auto Start - Professional and NOC Editions only. Selecting this option demonstrates the ability to make the MyVoIPSpeed test start automatically, i.e. does not require the user to click a 'start test' button.

Connection Test

MyVoIPSpeed Server accomplishes the test process as two distinct phases.

The first undertakes the VoIP test which measures jitter and lost packets, including packets dropped and discarded packets. These measures are significant when assessing the quality of the Internet connection for VoIP calls or other latency sensitive applications like video and multimedia applications such as online conferencing.

Phase two measures bandwidth throughput speed for both upload and download. These results can be compared between service providers and utilized to underwrite service level performance and quality. Connection quality is a crucial element in managing applications such as VoIP and conferencing.

Phase 1

Phase one is the VoIP test. Click the start button to begin the test. Once started you will see a screen as below, when it has finished it will move onto phase 2 automatically.

The initial view shows the VoIP stats. The left side shows the average jitter on the current connection, the right side shows the packet loss as a percentage for the connection. The graph is shaded from green (good) down to red (bad) for easy analysis.

Phase 2

Phase two undertakes a bandwidth throughput speed test for both upload and download. Once this has finished it will produce the Summary and Advanced tabs.

This tab shows the upload and download speed for the current connection. It is displayed on a sloping graph as shown above, the green to red shading indicates good to bad speed.

Results

The colored circles on the left indicate if the data is good or bad for a VoIP connection. The first two ‘lights’ tell you if the download and upload speed is good enough to support VoIP. The third light indicates the Quality of Service. The next light indicates your connections jitter and the last light indicates the packet loss. The description at each stage will explain if the connection can support VoIP and if problems will likely be encountered.

The next Advanced tab is only available in Professional and NOC Editions.

This tab gives a run down of all results, like download/upload speed, QoS. Other information includes Jitter (ms) and packet loss from your machine to the server and from the server to your machine. It also gives the Server ID # for the test.

#-------------------------------------------------------------------------------
# The values behind the above conclusions text. If a value is better than
# 'xxxwarnnum' then it is marked as 'good'. If it is worse than 'xxxbadnum' then
# it is marked as 'bad'. Otherwise it is marked as 'warn'.
#-------------------------------------------------------------------------------

dspeedwarnnum=75000
dspeedbadnum=55000

uspeedwarnnum=75000
uspeedbadnum=55000

qoswarnnum=85
qosbadnum=55

jitterwarnnum=8
jitterbadnum=30

losswarnnum=1
lossbadnum=5

Database Reports

Reporting Options

MyVoIPSpeed Server Professional and NOC Editions support a test results database. This provides the network and customer support groups access to the VoIP, Speed and Quality results both in summary and detail form. This data is stored in a database and is made available for selection, review and reporting in a several ways to provide flexibility of the data views. Choosing any of the predefined report types in the main server view presents the user with the standard report selection page as shown below:

The first section is the Search Parameters combined with the output choices. This panel allows the user to select:

What data
• is extracted based on a start-time and an end-time
• is selected based on filters namely IP (IP address), DNS (Domain name assigned to IP address) and SID (session ID) recorded for the speed test

What format
• is used for output of the selected data

What field elements
• are included in the report body

1. What Data

From - Simply choose the date and time range you want to search between (Note the time is time zone neutral)

IP - Enter a particular IP for the report selection (Supports the use of wild carding with the * character). This is the IP address that initiated the test. Note: If the security option to suppress the IP address is used then the IP address is not available for reporting. This security option can defined for Reporting and Administrative users separately.

DNS - Enter the DNS name for report selection (Supports the use of wild carding with the * character). This is the name of the workstation or server that initiated the test.

SID - Enter the particular session ID for the report selection (Supports the use of wild carding with the * character). The session ID is available only in the Professional and NOC editions and provides the means to assign user defined data to the test. For the NOC edition this is normally used for identifying the location of the automated Remote Testing Agent (RTA)

2. What format

Table / Graph - Selecting this option will report the results in table or graph format
Spreadsheet / Text - Selecting either Spreadsheet or Text provides the means to export the MyVoIPSpeed report data for use in an external application such as Microsoft Excel

3. What Field elements
The second section defines what field elements are required to be included in the report, simply check or uncheck and click 'search' to run the report selection. Note these options are not available for the graph selection. The graph legend allows the user to select or deselect what is included in the graph.

Database Search Examples

Table View

Below is an example of a table of results when using the search feature. Note the IP address filter is using the generic * to match all IP addresses starting with 192.168. The use of the matching * can be used on all the filter options. The table is self explanatory in that it lays all the data out from all the tests that have occurred for the selection the parameters you have used. You can view the detail log for each test by clicking the Detail id number link at the end of each row.

Graph View

Below is an example of a report where the output type has been switched from Table to Graph. Note that Display fields selection is disabled for selection when you choose the graph output, the graph view allows you to quickly enable or disable the individual graph elements (lines) by clicking the legend colors on the right hand side. In the example below the plotting of Round Trip Time has been disabled.

The vertical red line shown below is the automatic scope tool, this line moves as you scroll the mouse from left to right. The light blue box slightly to the right of the red vertical line display the graph measures for the point where the red line is shown. Clicking the left mouse button allows the plot data time window to be scrolled also. This is useful for graphs that contain a wide range of data over a long period of time. The vertical scope tool can be disabled if not required by clicking the hide option in the blue legend panel.

Data Export Example

Selecting either of the output types Spreadsheet or Text provides the means to export selected MyVoIPSpeed Server data into an external application such as a spreadsheet or report document. Selecting Spreadsheet will allow the selection of save or open depending on whether you want to have a spread sheet view within the MyVoIPSpeed report as shown below, or open the spreadsheet application as a separate window. Selecting the Text option provides the data as a simple tab delimited file in a text window for the user to cut/paste/print as required.