Sonar User Guide

Configuration Parameters

URL Query Parameters

The URL that is used to start Sonar can include a number of parameters.  The format of the link is:

http://community.tribelab.com/sonar.html?[name=value]...&...[name=value]

server

The name of the server that the marker will be sent to. Can't be used in conjunction with url option.

port

An open TCP port on the destination server that the marker will be sent to. Default is 80. Can't be used in conjunction with url option.

uri

An address on the server that the marker will be sent to. Can't be used in conjunction with url option. e.g. uri=tlz would result in a marker URL being sent to http://server:80/tlz.

hide

Set as hide=true to hide everything from the user other than the 'Send Marker' button. When you create a link to distribute to your users you may wish to hide the form fields so they are not accidentally changed. Default is hide=false.

protocol

Either http or https to define the protocol used. Default is http. Can't be used in conjunction with url option.

timeout

Timeout allows you to specify the length of time to wait for a response from the destination server before the client times out. This value is declared in milliseconds with a default of 500ms.

seed

Seed specifies the starting number for the markers.  For example, if the seed value is set to 100 the first marker with have a suffix ?m=100, the next ?m=101 and so on.

url

A list of url's designating procotol, server, port and uri . Multiple URL's can be specified using a comma.


Examples

URL Marker
sonar.html?server=www.google.com http://www.google.com/a7?m=1
sonar.html?server=www.google.com&protocol=https https://www.google.com/a7?m=1
sonar.html?server=www.google.com&uri=tlz http://www.google.com/tlz?m=1
sonar.html?port=443 http://www.google.com:443/a7?m=1
sonar.html?seed=100 http://www.google.com/a7?m=1
sonar.html?url=http://web,http://db,http://app http://web/a7?m=1
http://db/a7?m=1
http://app/a7?m=1
sonar.html?server=web&hide=true http://server/a7?m=1
sonar.html?timeout=5000 http://www.google.com/a7?m=1