User Guide

Overview

This User Guide will walk you through the Nectar Endpoint Client user interface and help you locate features and data sets.

To view the Nectar Endpoint Client Overview screen, navigate to and click on Platform, then select Proactive Testing. The sections below will appear on the Nectar Endpoint Client 's default Overview screen.

• Filters
• All Endpoints & Map
• Test Sessions
• Tests Overview

Filters

You can select specific filters and within the filters you have additional options like search fields, single or multiple selections, etc. All the selections are applied to all Sections of the Overview screen.

All Endpoints & Map

In this section you will be able to view both Passed and Failed test results for all the Endpoints with options to drill-down to specific Users and/or Endpoints. 

Tests Summary

In the left pane of this section is a summary of test results that can be sorted or customized to drill-down to the Endpoint you may looking for.  

Here is a breakdown of the presented data:

1. Total Tests, Failed Tests, and Passed Tests.
   1. This is a summary of all tests.
2. Default and Custom tabs.
   1. The Default settings show the Endpoints with lowest Test Success % first; worst performing Endpoints.
   2. The Custom tab enables you to search--by name--for key location(s) and select them to be viewed in the below tables and map.
      1. When the Custom tab is selected, a pencil icon appears at the end of the column header, click on the pencil icon and a Search dialog window will pop-up. 
3.  HUB Endpoints & Endpoints Sections and columns:
   1. HUB Endpoints / Endpoints - this is a list of Endpoints and their designated names.
   2. Test Success % - this is a list of tests sorted by worst performing tests; can be sorted by clicking on the column heading. 
   3. Num Of Tests - this is a list of the number tests per Endpoint; can be sorted by clicking on the column heading. 

Map Summary & Features

The Map reflects a lot of the same features seen in the Tests Summary pane but adds the benefit of being able to see the location of the Endpoint(s). 

Key Features:

• Filter between All Endpoints, Endpoints, or HUB Endpoints.
• White Circles indicate HUB Endpoints and Black Circles indicate Endpoints.
• Color-coded Endpoints, these are the colors around the black & white circles on the map and they indicate the level of Passed (green) and Failed (red) tests.
• Click on an Endpoint (black/white circle) to initiate a pop-up that displays the Total Test results (i.e., Passed, Failed). 
• Zoom in to street level or Zoom out to see a global view.
• The map also displays the number of Undefined Locations. 

Test Sessions

This section displays a color-coded (green equals pass and red equals fail) bar graph and by using the Time Period filter, you can drill-down to the hour, or view a 30-day snapshot. Hovering your cursor over one of the bar(s) displays a breakdown by test (e.g., Audio). 

Tests Overview

This section displays a list of the all the Test Results and allows you to drill-down and view details of each Test Session. Remember, all the Filters affect the data you see in this section. 

Key Features: 

• You can filter by either Passed (All tests) or Failed tests.
• You can select what Columns and data to display--Test Type, ISP, etc. 
• You can view anywhere from 10 to 50 Test Results.
• Drill-down to a single Test Session to more details like the User, Endpoint, etc. 

Test Session Details

You can view a Test Session's details by double-clicking on a Test Result (row) in the Tests Overview screen.

Overview Tab

On the Test Session details screen you will see the following:

1. Start/End Time of Session
2. User's Name
3. Endpoint Client Type
4. Endpoint Client Location
5. Session Alerts
6. Health Domains
   1. Endpoint
   2. Network Details (IP address) 

Advanced Tab

Within the Advanced tab you will find three sub-categories that will provide you more details about each Test Session. To view the data, click on the drop-down arrow next to each sub-category.

• The Test Details section provides information such as Test version and Date/timestamp.
• The Endpoint Details section provides information such as the machine name and IP address/port.
• The P2P Test Details section provides information such as the Estimated bandwidth available and Packet loss rate.

If you have further questions on Nectar's Endpoint Client, please visit the FAQ Section.