VON@Link
TeamOnCall
v1.1 for Windows
VON@Link
TeamOnCall
v1.1 for Windows
Last updated: May. 7, 2007
1 Introduction
1.1 Who should read this guide
1.2 Conventions
1.3 System requirements
1.3.1 Verifying NTFS driver/partition
1.4 Installation
1.4.1 Installing IIS on Vista
1.4.2 Installing IIS on XP Pro, 2003, or 2000
1.4.3 Installing TeamOnCall
1.4.4 Updating an installation
1.5 Obtaining an evaluation serial number2 Network setup
2.1 Using a hub for 6 phones or less
2.2 Using port mirroring on a managed switch for more than 6 phones
2.2.1 Configuring port mirroring on a switch3 Configuring the web server
3.1 Configuring IIS 7
3.1.1 Verifying IP address binding
3.1.2 Creating the scripts virtual directory
3.1.3 Setting up permissions
3.2 Configuring IIS 6 and 5
3.2.1 Verifying IP address binding
3.2.2 Creating the Scripts virtual directory (if required)
3.2.3 Verifying settings for Scripts virtual directory
3.2.4 IIS 6.0 Web Service Extension
3.2.5 IIS 6.0 Running IIS 5.0 isolation mode
3.2.6 XP Pro Firewall
3.3 Configuring other web server
3.3.1 Apache4 Accessing the TeamOnCall Web Application
4.1 Web address
4.2 Login
4.3 Changing the password5 Network cards
5.1 Exclude IP address from discovery
5.2 Subscription service6 Managing users
6.1 Adding a phone
6.2 Listing phones
6.3 Deleting a phone7 Managing groups
7.1 Adding a group
7.2 Listing groups
7.3 Deleting a group
8 LogAppendix A HTML Template Customization
Appendix B Resetting the Administrator PasswordAppendix C Disabling sleep mode on Vista
Appendix D Capturing a network trace
Appendix E API
E.1 Do not disturb (DND)Appendix F Subscription Service
F.1 Developing a client
This guide is for persons responsible for installing and administrating VONaLink TeamOnCall on Windows Server 2003, Windows XP Professional and Windows 2000.
Read answers to frequently asked questions at www.vonalink.com/faq
Unless otherwise stated:
Windows Server 2003 and XP Professional are based on Windows 2000, so many of these concepts are the same. The default appearance of Windows XP Professional is different from Windows 2000 but these differences are purely cosmetic. Where there are real differences, it will be noted.
Bring up the Computer Management window by selecting the menus: Control Panel > Administrative Tools > Computer Management. Click on Disk Management under Storage. This will display whether the drive or partition is NTFS or FAT.
TeamOnCall must be installed on a NTFS drive or partition.
TeamOnCall requires the use of a web server. It may be Microsoft Internet Information Server (IIS), or other web server such as Apache.
If IIS is to be used, IIS should be installed before installing TeamOnCall.
If you are using one of the following, IIS is installed by default.
If you are using one of the following, IIS is not installed by default.
1. Go to Control Panel > Program and Features
2. On the left panel, click on Turn Windows features on and off
3. Select Internet Information Services checkbox.
4. Under World Wide Web Services, expand
Application Development Features and select the CGI checkbox.
5. Click OK.
IIS is installed by default for Server 2003 Web Edition and 2000 Server.
To install IIS on Windows Server 2003, go to Control Panel > Add/Remove Programs > Add/Remove Windows Components. Select Application Server > Internet Information Server for installation.
To install IIS on XP Professional or Windows 2000 Professional, go to Control Panel > Add/Remove Programs > Add/Remove Windows Components. Select Internet Information Server for installation.
|
If you are using Vista, power saving sleep mode must be disabled. |
When TeamOnCall is already installed and you wish to update the installation, you do not need to un-install. Run VLonCallSetup.exe on top of the previous installation. Configuration is maintained.
Before you can use TeamOnCall, you must obtain an evaluation serial number. An evaluation serial number may be requested at www.vonalink.com/download
VoIP phone calls use a variety of algorithms, known as codecs, to encode speech packets. For best sound quality, choose the G.711 codec. If Vonage is your provider, see Appendix C Setting Vonage sound quality.
TeamOnCall works by unobtrusively monitoring network packets as they travel between your phone and VoIP provider. The network setup depends on the type of VoIP phone that you have. For 6 phones or less you could use a 8 port hub. For more than 6 phones, you will need a network switch with SPAN or port mirroring capability.
If your computer has 2 network adapters, TeamOnCall can monitor both of them.
Using TeamOnCall on a wireless network is not supported.
A network hub is a "dumb" device that allows computers connected to the same hub to read all packets that flow through the hub. Because of this, TeamOnCall running on one computer can read the network packets destined for a phone plugged into the same hub. In contrast, a unmanaged network switch is a "smart" device that improves performance by allowing packets between the specified sender and receiver only, so network monitoring is not possible.
The price of a hub is less than that of a unmanaged switch. Because the cost difference between a hub and unmanaged switch is small, and most people prefer the performance of a unmanaged switch, most computer stores stock unmanaged switches. You will need to shop at a store that carry a wide range of network devices to find a hub. Some models are listed on the Support page.
Ports on a router are
switched, so a hub is still needed.. 
A IP phone resembles the typical home phone, but connects directly to a network. A soft phone is a software program that runs on your computer and uses the
connected microphone and headset.
Managed or smart network switches typically have a feature known as port mirroring, port monitoring, or Switched Port Analyzer (SPAN). The network switch is configured such that all traffic from the port designated as the Observe (source) Port is mirrored to the port designated as the Analysis (target) Port. Some models are listed on the Support page.
The following diagram shows the TeamOnCall server as having 2 network adapters (NIC). It is possible to have only one adapter and connect it to the Analysis Port of the switch, but the TeamOnCall server is then isolated from the rest of the network. To allow TeamOnCall server access to and from the rest of the network, a second adapter is needed.
If 2 network adapters are used, set the network adapter used for monitoring with a static IP address.
Follow the steps in the User Guide for your network switch to enable port mirroring. Many of today's switches allow configuration via a web browser. For the Source Port, choose the port that connects to your PBX or broadband. For the Target Port, choose the port that connects to the TeamOnCall server. Choose to mirror both send and receive packets.
s
TeamOnCall uses Microsoft IIS, or another web server such as Apache.
During installation, the file TeamOnCall.exe is copied into the scripts directory of IIS (i.e. C:\InetPub\scripts).
IIS 7 is shipped with Windows Vista.
3.1.1 Verifying IP address binding
1. Open
Control Panel > Administrative Tools > Internet Information Services (IIS) Manager.
2. On the left panel, expand the tree until you see Default Web Site
under Web Sites.
3. Right click on Default Web Site and select Edit bindings.
4. Verify that the IP address is set to *.
If for some reason, you could not set the IP address to All Unassigned, or the web server is not responding at IP address 127.0.0.1, do the following:
1. Use Notepad to create the file \vonalink\cfg\adminIP.cfg
2. Edit the file to have 1 line as follows:
CHECK_IP=N
This will allow you to access the TeamOnCall Web Application to do administration without having to use the IP address 127.0.0.1.
3.1.2 Creating the scripts virtual directory
Right click on Default Web Site and select Add Virtual Directory.
Enter scripts as the Alias. For Physical path, browse or enter C:\inetpub\scripts. Click OK.
Double click on Handler Mappings from the Feature View.
On the right panel, click on Edit Handler Permissions.
Select the Execute checkbox. Click OK.
The CGI-exe handler will be displayed under Enabled.
On the left panel, click on the server. From the middle panel Features View, double click on ISAPI and CGI Restrictions.
From the Actions panel, click on Add.
For CGI path, browse or enter C:\inetpub\scripts\TeamOnCall.exe. For Description, enter TeamOnCall. Select the Allow extension path to execute checkbox.
TeamOnCall will show up in the list as Allowed.
3.2.1 Verifying IP address binding
1. Open
Control Panel > Administrative Tools > Internet Information Services (IIS) Manager.
2. Double click on Web Sites to expand it. Right click on
Default Web Site and select Properties.
3. Verify that the IP address field is set to All Unassigned.
If for some reason, you could not set the IP address to All Unassigned, or the web server is not responding at IP address 127.0.0.1, do the following:
1. Use Notepad to create the file \vonalink\cfg\adminIP.cfg
2. Edit the file to have 1 line as follows:
CHECK_IP=N
This will allow you to access the TeamOnCall Web Application to do administration without having to use the IP address 127.0.0.1.
3.2.2 Creating the Scripts virtual directory (if required)
The IIS installation for Windows 2000 creates the Scripts folder under Default Web site by default. Proceed to 3.2.3.
The IIS installation for Windows Server 2003 and XP Professional do not create the Scripts folder under Default Web site by default. To create a virtual directory under Default Web Site, right click on Default Web Site
Click on New > Virtual Directory to open the Virtual Directory Creation Wizard. Click on Next.
Enter Scripts as the alias name. Click on Next.
Enter c:\netpub\scripts as the directory. Click on Next.
Enable only Execute access permission. Click on Next and then Finish.
3.2.3 Verifying settings for Scripts virtual directory
Verify that the IIS has been configured to recognized that the scripts directory contains executable files.
Bring up the Information Services Manager by selecting the menus: Control Panel > Administrative Tools > Information Services Manager.
Notice that TeamOnCall.exe is inside the Scripts folder. Right click on the Scripts folder and select Properties to open the Scripts Properties window:
Notice that the Local Path is C:\inetpub\scripts and that Execute Permissions is set to Scripts and Executables.
3.2.4 IIS 6 Web Service Extension
IIS 6, shipped with Windows Server 2003, introduces an additional level of security called Web Service Extensions. Right click on Web Service Extensions and select Add a new Web service extension.
Enter Vonalink as the Extension name. Add C:\Inetpub\scripts\TeamOnCall.exe to list of required files. Select the Set extension status to Allowed checkbox. Click on OK.
The Vonalink Web Service Extension should be added and its status should be Allowed.
3.2.5 IIS 6.0 Running IIS 5.0 isolation mode
On Windows Server 2003, you may need to run IIS in 5.0 isolation mode. From IIS Manager, right click on Web Sites and select Properties. Go the Service tab. Select the checkbox Run WWW service in IIS 5.0 isolation mode, and click OK.
3.2.6 XP Pro Firewall
If TeamOnCall is installed on Windows XP Pro Service Pack 2 or later, you will need to configure Windows Firewall to allow incoming HTTP and/or HTTPS traffic.
1. Go to the Windows Control Panel.
2. Click on Windows Firewall.
3. Switch to Advanced tab.
4. Click on Settings for Network Connection Settings
5. Enable the services Web Server (HTTP), and/or Secure Web Server
(HTTPS) if applicable.
6. Click on OK.
Apache is a widely used, open source web server that may be downloaded free. The following steps are based on Apache v2.0.55.
1. Select the menu Start > All Programs > Apache HTTP Server 2.x > Configure
Apache Server > Edit the Apache httpd.conf Configuration File
2. If you wish to use a port other 80, edit the following line to specify the
port number:
Listen 80
3. Locate the ScriptAlias section and add the line:
ScriptAlias /scripts/ "C:/InetPub/scripts/"
4. Save httpd.conf
5. Select the menu Start > All Programs > Apache HTTP Server 2.x > Control
Apache Server > Restart
The TeamOnCall Web Application can be used with a standard web server or a secure (SSL) web server.
The only difference between the two addresses is the protocol – http or https. For https to work, your web server must be configured with a digital certificate obtained from a Certificate Authority (CA) such as Verisign or Thawte. Read your web server documentation on how to do this.
You will probably want to setup a link to the above address from one of your web pages to make it easy for users.
To login from the same machine that TeamOnCall is installed, use:
To start things off, a TeamOnCall administrator has already been created. The user name is admin and the password is vonalink. Login to TeamOnCall with this user. User names and passwords are case sensitive.
During the first login to
TeamOnCall as admin, you must change the
password.
Since all TeamOnCall systems start with the same initial password for admin,
failure to change the password on your TeamOnCall system will allow
unauthorized access.
Click on the Preferences link. Type in a new password in the password fields and click on Save Preferences.
If your server has multiple network interface cards (NIC), you can select which ones to monitor. By default, TeamOnCall will monitor up to 2 cards.
Log into TeamOnCall as admin, click on Administration link. For security reasons, network configuration is available only if you access TeamOnCall from the local machine:
Unselect the Monitor checkboxes of any NIC that you do not wish to monitor, and click on Save Network Configuration. Changes will take effect after you reboot, or if you manually re-start the VONaLink Packet Monitor Service.
If your PBX is on the same subnet as the phones, the PBX must be excluded from the discovery process. Enter the IP address of the PBX and click on Exclude Address. Any phones to be excluded may also be added.
TeamOnCall provides an optional mechanism for ScreenPop and custom client application to receive notification of call events. Specify the TCP/IP port to which clients can connect, and click on Save Port.
For security reasons, a client is allowed to connect to the Subscription service only if its IP address is in the allow list. Enter a IP address or a IP subnet, and click on Add Client IP Address.
Log into TeamOnCall as admin, click on Administration link. For security reasons, phone management is available only if you access TeamOnCall from the local machine:
| User | Enter a login name without spaces. |
| Password | Specify a password for the new user. |
Click on Add User.
From the list of users, click on the Delete link to remove that user.
Log into TeamOnCall as admin, click on Administration link. For security reasons, phone management is available only if you access TeamOnCall from the local machine:
A group is a flexible way for you to organize a collection of phones. The meaning of a group is up to you. A group could be a department name, job function, skill set, language, etc. A phone can belong to one or more groups.
| Group | Enter a name for the group. The name may contain spaces. |
Click on Add Group.
To see the list of phones assigned to a group, click on Phones.
To delete a phone from a group, click on the Delete link. The assignment of a phone to a group is done from the Activity view.
From the list of groups, click on the Delete link to remove that group.
Log into TeamOnCall as admin, click on Administration link. A log file is created for each day of the week. The log for each new day overwrites the one from one week ago. In this way, you have the last 7 days of logs without having to manually attend to them.
You can also see the log files using Windows Explorer. The files are located under installDrive:\vonalink\log folder. The files are named as vona-N.log where N is from 0 to 6. For example, Sunday's log is vona-0.log.
Log into TeamOnCall as admin, click on Administration link, followed by the License link. For security reasons, licensing is available only if you access TeamOnCall from the local machine:
This page shows the ID of your computer as generated by TeamOnCall. A TeamOnCall serial number is associated with a particular computer. You will be asked for computer ID from this page when purchasing TeamOnCall.
TeamOnCall is licensed by the number of phones. To record more phones, purchase additional licenses and you will be provided with a new serial number. Enter the new serial number and click on Enter Upgrade Serial Number.
If
your evaluation has expired and you cannot login to TeamOnCall to read the
Computer ID, look in:
\vonalink\cfg\id-oc.cfg
The page that you see in the Web Application is generated from a HTML template that you can customized. The template is named TeamOnCallTemplate.htm and it is found in \vonalink\htm.
Before you change the standard template, it is recommended that you make a backup copy of it. If you comfortable with editing HTML, you can use a text editor to modify the template. Otherwise, use a visual HTML editor. The standard template has an embedded style sheet for controlling fonts and the color of table headings.
TeamOnCall defines three comment tags to indicate the position of dynamic content.
| <!VL-REFRESH> | Specify page auto-refresh |
| <!VL-TITLE> | Shows the page title |
| <!VL-USER> | Shows the user name |
| <!VL-TIME> | Shows the time |
| <!VL-BODY> | Shows the body |
Note: Keep the length of each line under 500 characters.
In the event that everyone forgot the password for the user admin, the password can be reset to the default password of vonalink.
PASSWORD=e6fffef1fcf9fefb
If your computer goes into sleep mode to save power, this interferes with network packet reading. To disable sleep mode, go to Windows Control Panel > Power Options. Select High performance.
Click on High performance Change plan settings to verify that Put the computer to sleep is set to Never.
The procedure is performed only if requested by VONaLink technical support.
1. Open up a Command Prompt window (Start menu > Accessories > Command
Prompt)
2. Type:
cd \vonalink\bin
3. Type:
vonapkt trace on
4. To get current trace state, type:
vonapkt trace
5. Wait 15 seconds. Talk on your VoIP phone. Hang up.
6. Type:
vonapkt trace off
7. A file with the pcap extension is saved in \vonalink\log\trace. If
the file is large, compress it using
7-zip or
Winzip.
8. Send the file to Technical Support
Some IP phones such as the ones from Snom allow an URL to be called when Do not disturb is enabled or disabled.
To notify that DND is enabled:
http://server/scripts/teamoncall.exe?cmd=dnd&value=1&mac=macAddress
To notify that DND is disabled:
http://server/scripts/teamoncall.exe?cmd=dnd&value=0&mac=macAddress
TeamRecord provides an optional mechanism for remote client notification of call events.
When a client connects, the service will respond with:
220 Ready
The client program may be written in any programming language (i.e. Java) that supports TCP/IP sockets.
| Request | Response | Meaning |
|---|---|---|
| ADD-PHONE phone | 200 OK | If phone is specified, only events related to the specified phone are subscribed. If phone is not specified, then all phones are added. |
| DELETE-PHONE phone | 200 OK | If phone is specified, the phone is deleted. If phone is not specified, all phones are deleted. |
| SUBSCRIBE CALL-DIAL | 200 OK | Subscribe to CALL-DIAL event |
| SUBSCRIBE CALL-OUT | 200 OK | Subscribe to CALL-OUT event |
| SUBSCRIBE CALL-IN | 200 OK | Subscribe to CALL-IN event |
| SUBSCRIBE CALL-START | 200 OK | Subscribe to CALL-START event |
| SUBSCRIBE CALL-WAITING | 200 OK | Subscribe to CALL-WAITING event |
| SUBSCRIBE CALL-END | 200 OK | Subscribe to CALL-END call event |
| SUBSCRIBE | 200 OK | Subscribe to all events including ones added in later releases. Be prepared to ignore any new events. |
| UNSUBSCRIBE | 200 OK | Unsubscribe from all event types |
| BYE | Disconnect | |
| HELP | Available commands followed by 200 OK |
List available commands |
All events notifications start with a timestamp. This is the number of seconds since Jan.1, 1970 GMT, a standard time reference found on most operating systems.
1. CALL-DIAL event
When an outgoing call is placed and before it is answered, the following line is sent to all interested clients.
EVENT timestamp CALL-DIAL local=localPhone remote=remotePhone
For example:
EVENT 1175642156 CALL-DIAL local=16474775050 remote=19057372391
2. CALL-OUT event
When an outgoing call is answered, the following line is sent to all interested clients.
EVENT timestamp CALL-OUT local=localPhone remote=remotePhone
For example:
EVENT 1175642156 CALL-OUT local=16474775050 remote=19057372391
3. CALL-IN event
When an incoming call is ringing, the following line is sent to all interested clients.
timestamp EVENT CALL-IN local=localPhone remote=remotePhone remoteName=name
The remoteName parameter is optional.
For example:
EVENT 1175642156 CALL-IN local=16474775050 remote=19057372391 remoteName=LEUNG_T
4. CALL-START event
When an incoming call is answered, the following line is sent to all interested clients.
EVENT timestamp CALL-START local=localPhone remote=remotePhone remoteName=name
The remoteName parameter is optional.
For example:
EVENT 1175642156 CALL-START local=16474775050 remote=19057372391 remoteName=LEUNG_T
5. CALL-WAITING event
When an incoming call is in progress and another incoming call arrives, the following line is sent to all interested clients.
EVENT timestamp CALL-WAITING local=localPhone remote=remotePhone remoteName=name
The remoteName parameter is optional.
For example:
EVENT 1175642156 CALL-WAITING local=16474775050 remote=19057372391 remoteName=LEUNG_T
6. CALL-END event
When a call ends, the following line is sent to all interested clients.
EVENT timestamp CALL-END local=localPhone remote=remotePhone remoteName=name
The remoteName parameter is optional.
For example:
EVENT 1175642156 CALL-END local=16474775050 remote=19057372391 remoteName=LEUNG_T
The client program may be written in any programming language (i.e. Java) that supports TCP/IP sockets.
To test without coding, the standard telnet utility may be used.
Windows is a registered trademark of Microsoft Corporation in the U.S. and other countries.