diagnosticResult

This topic lists API fields (and their descriptions) associated with data returned from a query using TAO’s diagnostic tool. The entities described in this topic are considered to be the most meaningful when performing a query of a this data - not all entities returned with a query are listed..

bandwidth

This field validates how much data the network can handle. It will display as a pass/fail result.

• showBandwidthMessage: Enable or disable the pass/fail result message by setting this field to true/false. By default, it is set to true.

browserCompatibility

This field checks is your browser is one of TAO’s supported versions.

connectionCompatibility

This field validates whether current network connection satisfies the required parameters. The connection is checked by running files upload and download, plus latency is measured as time for establishing connection to the server. See the section on audioCompatibility below for more details.

This field is only used if audioCompatibilityis not enabled for the query.

endpointsReachability

This field checks if required list of servers are available by url.

audioCompatibility

This field validates whether current network connection satisfies the required parameters. The connection is checked by running files upload and download, plus latency is measured as time for establishing connection to the server.

• concurrentUsers: This value is used only for a text in the warning on the last screen. The number of concurrent users should be defined beforehand and all other metrics should be adjusted accordingly.

• download:

  • acceptable: The minimal acceptable value. Displayed in bytes per second (= 4 Mb/s).

  • measures:

    • size: The size of file downloaded for validation, in MB.

    • timeout: Displays how long to wait before aborting check, in milliseconds.

    • thread: The number of parallel download streams to run.

• jitter: The variation in latency values over time.

  • measures: How many measurements are taken to calculate the middle value.

• latency: The time it takes for data to travel from source to destination and back.

  • acceptable: The maximum acceptable value for connection establishment, in milliseconds.

  • measures: How many measurements are taken to calculate the middle value.

• upload:

  • acceptable: The minimal acceptable value. Displayed in bytes per second (= 4 Mb/s).

  • measures:

    • size: The size of file downloaded for validation, in MB.

    • timeout: Displays how long to wait before aborting check, in milliseconds.

    • thread: The number of parallel download streams to run.

webSocketConnection

This field checks whether the user's browser supports the WebSocket protocol. WebSocket support is required for the test runner engine to function correctly. The timeout value specified in the configuration file determines how long the system waits for a WebSocket response before marking the test as failed.

• timeout: How long to wait for the websocket response before marking the test as failed, in milliseconds.