INTRODUCTION...................................................................................5
The Product ............................................................................................................................................5 Soft-phone - more features than Hard-phone ................................................................................5 Purpose of this guide............................................................................................................................5 Scope ........................................................................................................................................................6 Intended Readership.............................................................................................................................6 Applicability Statement........................................................................................................................6 Overview of this manual......................................................................................................................6 How to use this document...................................................................................................................6 Related Documents ...............................................................................................................................7 Licensing..............................................................................................................................................7 Customer Support..............................................................................................................................7
UNINSTALLING ................................................................................. 51 TROUBLE SHOOTING .......................................................................... 56 APPENDIXES .................................................................................... 58
Common Features ...............................................................................................................................58 IP desktop Softphone in different environments.........................................................................59 Table of Figures ...................................................................................................................................62
1 Introduction
1.1 The Product
Congratulations on your opting for: IP Desktop Soft Phone. You have indeed made a wise choice. Now you can enjoy the benefits of more than a sophisticated hardphone, at the ease of mouse clicks. This is an application that displays an image of a hard-phone in your system’s screen. You can activate its various keys and buttons using mouse clicks. This softphone accommodates customizations to suit the preferences of users. If you have installed this in a laptop, you can use the soft-phone when you connect your laptop to your LAN. Installation of this application is easy, quick and user friendly. This application is also known as IP Desktop Soft Phone Agent, when used in the Call centre Environment.
1.2 Soft-phone - more features than Hard-phone
Unlike hard-phones, to add a new terminal, you need not buy a new one and configure it. Instead, you can install the application in a system existing in that PABX network. It does not occupy more space, and saves on connectivity and other hardware problems. Besides these advantages, this soft-phone provides more features than a hard-phone. This is best suited for the Home working or the remote working with 100% feature transparency of the IP Hard phone. The Limitation of distance is no more a problem. As long as you can connect to your network using Internet/VPN, you are never out of reach. With the Wireless Network card and the Bluetooth, you can be always connected to the system and this helps you in getting all your calls when you are on the move.
This manual targets at the System Administrator, and provides him with all necessary information to complete the above tasks.
1.4 Scope
This manual covers all activities necessary for installing the application in a PC and provides guidelines to configure it. It also covers all necessary information to create the environment suitable for the installation. This document does not cover the usage details of this application. Please refer the IP Desktop Soft Phone – User Guide for the same.
1.5 Intended Readership
This manual targets System Administrator who also does networking. This is not relevant to the user of this application
1.6 Applicability Statement
This manual applies to installation of the application: IP Desktop Soft Phone only.
1.7 Overview of this manual
This manual is split into different sections. The first section acts as a starter, providing preliminary and superficial information. Chapter 2 provides the mainstream information. The third chapter deals with customizing the installed application. Other sections provide vital support information. The last section states those that are implied, and provides for navigation by screenshots. In the main part of this manual, i.e.: second chapter, tasks are explained with numbered steps. In between the steps, explanations given are marked by bullets for differentiation purposes. The steps are backed by screenshots, and the screenshots are given above their explanations. So, going through this manual would give you the feel of actually performing the task.
2 Installing
2.1 Requirements for installing
Below given are minimum requirements, without which, this application will not function properly. So, before installing this application, please ensure these minimum requirements are met. 2.1.1 Hardware Processor RAM 1.6 GHz Minimum 512 MB for Windows XP 1 GB for Windows Vista 50 MB free space Integrated sound card or USB headset
Disk Space Sound card Note:
The above table lists the minimum hardware requirement. With additional hardware, you can establish many types of connections. Some of them are illustrated in point # 7.2 IP desktop Soft phone in different environments: 2.1.2 USB Headset USB (preferably USB2) Headset or a USB hands-free is an optional enhancement. By default, the application uses the default PC media devices (PC default microphone and PC speakers). When a USB headset is connected to the user PC with a sound card, IP Desktop Soft Phone can use it instead of the default media devices. When using the headset, the General tab of the Options menu allows the user to select a sound card for ringing and another one for voice. A USB headset connection can make the best out of this facility. You can set the options to send the ringing to the default media device, and voice to USB headset.
2.2 Installation Process
Installation process is easy, quick and user friendly. During the process of installation, when you answer a few dialog boxes, that completes basic configuration. Below are the steps for installing the application: 1. Ensure that hardware, software and networking requirements are in place, as prescribed. 2. Close all running applications 3. Run the file: IpDesktopSoftPhoneInst.exe 4. This displays the following screen. In it, select the language in which you intend to install this application
This page displays the Alcatel-Lucent License Agreement. This same text is given under point #1.10 Licensing, under Introduction.
7. Read through the agreement, and if it is acceptable to you, click on the 1st radio button against: I accept the terms in the License Agreement • If you click on the other radio button, then the installation process will abort, when you click Next. This cancellation happens after getting your confirmation.
This screen lets you to select components to install. When you move your mouse over any of the components listed, its description displays at right. NOE IP Phone is a mandatory installation and so you do not have choice there – you cannot undo the selection.
9. By default, all components are selected. If any of those components are already installed in your system, you can undo their selection. 10. Click Next.
11. This screen displays the folder where it will install the files by default. If needed, you can change this folder, by using the Browse button nearby. 12. Click Install
Now the installation is in progress. This screen shows the progress bar at the top. It displays the files actually installed, in the box below. This is for your information only. This process would take a while. So, wait. If .NET Framework 2.0 is not present in your system, then, its installation begins. Its opening screen is given below:
This screen displays the End User License Agreement for installation of .NET Framework. To move further into installation, tick the checkbox against: I accept the terms of the License Agreement.
Installation of software is complete. In the above screen you need to give connectivity information.
16. In the 1st entry box, give the IP address of your Call Server (ROLE MAIN Address). This is mandatory 17. In the 2nd entry box, enter the IP address of the backup server for the main Call Server. You can give it if you have such a backup server. If you have Call server Duplication configured, then here you have to enter the Role MAIN address of the Standby Call Server. This is optional • At this point, the application will not connect to the Server. So, it will not give any error messages for wrong entries. So, take care to make the correct entries.
19. In the 1st entry box, the URL for automatic updating is given by default. You can change this entry if you want to update the application from an intranet website. (for security reasons) 20. Second entry box is for selecting the language for this application. Available languages are: English (EN), French (FR), German (GE), and Latin (IT). Select your desired language. 21. The 3rd entry box impacts the keys that display at the bottom of the telephone image. Each of the choices given here is prefixed with the number: 4068. This refers to model number of the phone. Then 6 alphabets follow this number. These refer to the first 6 alphabets from top left of the keys set. The choice you make here, determines the keypad displays. The choice you make and the resultant display are listed below. Based on these, make your choice in this dropdown box.
2.3 Launching the Application
Before you could start using the soft phone, you will have to create a directory number for this soft phone on the OXE. The minimum requirement of OXE version is: Release 7.1 (F5-401-11-d) 1. In the call server, create a user. Sample text for this process is given below:
SCREENSHOT 22 – User creation in OXE
2. TSC IP Emulation should be set to Yes as shown in the following illustration:
3. Click on the following icon that the application had placed during the process of installing this application.
Alternatively, from the task bar, you can activate the application using following path: Start Programs IpDesktopSoftPhone IpDesktopSoftPhone
4. This displays the image of the soft phone on the screen. The actual display depends on the type of skin you had selected during the installation process. Few samples of these images are given below:
7. For this display, key in your extension number. Once you have entered the configured number it automatically moves to next screen. The next screen prompts for the related password. The default password is: 0000. This screen looks like this:
SCREENSHOT 28 – Enter Password
8. Once you have keyed in the password, it moves to next screen. No need to press Enter key. The next screen is for confirmation. It displays like this:
SCREENSHOT 29 – Registration confirmation
9. The above screen does not display during a new installation. It displays only during reinstallation. In this screen, press 1 to register. This confirms your registration, and initiates connectivity. So the display turns to:
SCREENSHOT 30 – Connection in progress
10. Once this connecting process is over, you can see the following display:
3 Customizing:
In the system administration level, you can customize the application to suit your existing environment. You can do this customization, only after installing the application. Steps to do that are given below: 1. Right-click on the phone image, but outside the display window. 2. In the list box that displays, select: Options Applications, as given below:
3. This displays options screen with 4 tabs as given below:
4. In this screen, the first 2 tabs are relevant to end-users only. So they are outside the purview of this manual. The User Guide for this application explains those tabs. 5. Select the 3rd tab: Network. In the entry boxes in this tab, you can see the values you had entered during the installation process. Now, you can change these default entries as you require. The following table explains these entries:
Field Name Network Adaptor: Description Name Tftp: Tftp Server (Main)
Description This refers to the Ethernet card. The application automatically detects existing cards in the system, and lists them here. You can select the card you prefer. This automatically displays. This is for your information. You cannot change it.
This refers to the IP address of your call server. The entry you see here is the one you had keyed in during the installation process. You can change if required. Any error in the entry would deprive connectivity. This is a mandatory entry.
Tftp Server (Backup)
If there is a Passive call server configured, The IP address of the Passive call server is displayed here. Tftp Server (Backup 2) This value is automatically provided by the NOE protocol and cannot be modified manually.
Optional. This is the IP address of the 2nd CPU. Please enter the 2nd Role MAIN IP address here if Spacial redundancy is managed.
6. Once you have completed making changes, click on Apply to save your entries. If you click OK, it saves the entries and closes this screen. 7. Move on to 4th tab. Its displays as below:
8. This tab is specifically for customizing automatic updates. The table below explains the components of this tab:
Field Name Description
Default button
By default, it is not ticked. Tick this checkbox to update the Activate automatic application automatically. If this is not ticked, then, the update application will not be updated automatically. Besides, entries in this page will not have any effect. You can see the default display in the above screenshot. If Url for automatic needed, you can change this. This will be necessary if you update intend to update from any source other than the given URL. This URL is mandatory, if you opt for automatic updating. Proxy This is optional. Give Proxy details for connecting to
Cancels the changes made and displays default values
Give the Password used for accessing URL if necessary. Undoes the changes made
Give the Login name used for accessing URL if necessary.
Saves the changes and closes the screen.
9. Now the application is operational. You can change the settings whenever you require, following these steps. 10. The automatic update will check for availability of updates during the launch of this application. It will display a message if an updated version is available.
Note: • • • (*) This port range is only used to transport voice using RTP protocol and fax using T.38 protocol. The lower bound range is 32000 for OXE <= R5.0Lx and 32512 for OXE >= R5.1. The upper bound range is 32255 for OXE <= R5.0Lx and 32767 for OXE >= R5.1. (**) The Basic Port is retrieved from the OmniPCX at TFTP initialization step.
3.2 QoS Activation
3.2.1 Type Of Service (TOS)/DiffServ Differentiated services enhancements to the Internet protocol are intended to enable scalable service discrimination in the Internet without the need for per-flow state and signaling at every hop. A variety of services may be built from a small, well-defined set of building blocks, which are deployed in network nodes. The services may be either endto-end or intra-domain; they include both those that can satisfy quantitative performance requirements (e.g., peak bandwidth) and those based on relative performance (e.g., "class" differentiation). Services can be constructed by a combination of setting bits in an IP header field at network boundaries (autonomous system boundaries, internal administrative boundaries, or hosts), using those bits to determine how packets are forwarded by the nodes inside the network, and conditioning the marked packets at network boundaries in accordance with the requirements or rules of each service. On IP Desktop Soft Phone, the CS using the UA StartRTP message configures this field automatically. So no manual configuration is needed. 3.2.2: 802 1P/Q Note: 1) 802 1P/Q is supported in Windows VISTA and Windows XP OS. 2) For Windows VISTA, please refer the release notes for Limitations.. For the 802.1P/Q (Ethernet Priority and VLAN tagging) use by IP Desktop Soft Phone, Alcatel-Lucent MUX-IM, Intermediate Driver should be installed and configured on the user PC. • For Alcatel MUX-IM Intermediate Driver installation and configuration, refer to section #4 Alcatel-Lucent MUX-IM Intermediate Driver.
For IP Desktop Soft Phone used voice port, refer to 3.1 UDP Used Ports.
4 Alcatel-Lucent MUX-IM Intermediate Driver
This section deals with the installation & configuration of: Alcatel MUX-IM Intermediate Driver
4.1 General Description
4.1.1 What is Alcatel-Lucent MUX Intermediate Miniport Driver The Alcatel-Lucent MUX Intermediate Miniport (IM) driver is an NDIS 5 driver that demonstrates the operation of an “N:1” MUX driver, i.e. one that creates multiple virtual network devices on top of a single lower adapter. Protocols bind to these virtual adapters as if they are real adapters. It implements IEEE 802.1Q VLAN tagging, which is enabled by changing the default VLAN ID to a non-zero valid value. It also implements IEEE 802.1P Ethernet priority for voice packets. Thus, users can be parts of multiple virtual LANs with their computers. It is not necessary to have more than one Ethernet device: Alcatel MUXIM driver allow users, with only one Ethernet card to be part of different VLANs (2 Vlans: Data and Voice), and tag their packets according to their origin: Voice application or Data application. 4.1.2 Requirements
Alcatel-Lucent MUX Intermediate Driver is used only on the Wired Networks.
Alcatel-Lucent MUX Intermediate Driver needs a PC responding to the following requirements:
Requirement type Operating System Network card Windows XP SP1 or later
Details 10/100 Mbits Ethernet card (Only wired network cards: wireless network cards are not compatible with Alcatel-Lucent MUX Intermediate Driver)
With Alcatel-Lucent miniport driver, PCs can belong to both Data Vlan and voice Vlan. Applications can then send data to data Vlan (data applications), and voice-to-voice Vlan (softphones).
4.3 Installation Procedure
The installation procedure must be done with administrator rights. 4.3.1 Requirement • • OS : Windows XP platform. No intermediate driver should be installed for LAN connections, if so uninstall it.
Before starting installation, the Installer should get from enterprise network administrator the values of Vlan ID for data, the Vlan ID for voice and the 802.1P priority for voice packets.
4.3.2 Installation
Before starting installation, save your connections TCP/IP configuration.
SCREENSHOT 34 – MUX-IM Intermediate Driver: IP & DNS server addresses
Click OK or Yes each time the system prompts with a warning regarding installation of unsigned files. This is necessary because binaries generated via the DDK build environment are not signed. Two .INF files are needed rather than one because MUX is installed both as a protocol and a miniport. For each Ethernet connection already present, a new connection is added representing the Alcatel-Lucent MUX-IM Miniport driver. You can see in the figure below, an example of two added connections to the original connections (3 and 55 that represents two Ethernet cards on the computer)
• •
4.4 Configuration
4.4.1 TCP/IP configuration Each added connection replaces the old one, and should be configured the same way as the old one. 1. Select the new added connection. Right-click it and choose Properties.
2. Select TCP/IP then click on Properties. 3. Fill the TCP/IP fields as they were in the old connection. 4. Then click on Apply and OK. 4.4.2 VLAN configuration Each newly added connection can be configured with two Vlans (Voice and Data). 1. Right-click on it and choose Properties
4. You can then fill 802.1P/Q information: (the following three fields must filled with the values given by network administrator) • User Priority 802.1P: 0 is default value, possible values are from 0 to 7, it concerns only packets tagged with Vlan ID Voice. Packets of Vlan Data have always the 0 priority. Vlan ID Data 802.1Q: Default is 0; possible values are from 0 to 4095 Vlan ID Voice: 0 is default value; possible values are from 0 to 4095 Voice Ports 802.1Q: Identify the UDP ports of applications supposed to communicate via the Voice Vlan.
Example: User Priority = 3, Vlan ID Data = 2, Vlan ID Voice = 3 and Voice Ports = 32514; 32518; 32512 According to this configuration, Alcatel-Lucent IM driver will tag with Vlan ID Voice “3” and User Priority “3” the UDP packets with port number equal to 32514, 32518 or 32512. All other packets (UDP or TCP) will be tagged with Vlan id data “2” and with priority “0”. If Vlan ID data is equal to 0, all data packets (not voice ones), will not be tagged neither 802.1p nor 802.1Q. 5. Once finished click on OK
4.5 Un Installation Procedure
1. Right-click on your original connection 2. Choose Properties 3. Select the driver as shown 4. Click Uninstall 5. Click Yes for question that follows.
SCREENSHOT 44 – MUX-IM Intermediate Driver: Local Area Connection 55 Properties
4.6 Configuring VLAN ID using DHCP
The Vlan Id Voice configuration (section 4.2) can be done using (DHCP). To do so, the package “Alcatel-Lucent DHCP Vlan must be installed (this package is installed as a Microsoft Windows Service) : 1. Execute the file “DHCPVlanSetup.exe” 2. Click “next”:
SCREENSHOT 45 – DHCP Vlan Service R.1.0 Setup opening screen
3. Read the license agreement, if accepted click “next”:
5 Uninstalling
This application comes to you with inbuilt uninstalling facility. This process uninstalls this application only. It does not uninstall supporting software that it installed during its installation process. To uninstall, follow the below given steps: 1. From the taskbar, activate the uninstalling file using the following path: Start Programs IpDesktopSoft-phone Uninstall
SCREENSHOT 48 – Language Selection
2. This displays the above screen. Select the Language to your preference. Available choices are: English & French. 3. Click OK.
This page shows the progress bar that shows the progress of uninstalling process.
SCREENSHOT 52 – Directory removal confirmation
6. During the progress of this uninstalling, this screen shows up. This is to get your confirmation for deleting the directory that the installation process had created. Click Yes. Clicking No retains this directory
6 Trouble Shooting
The table below lists some of the problems you could face, along with their remedial measures:
# 1. Problem Connection establishment fails o o o Remedy Check if your network connection is enabled. Check that tftp address is correct and make sure you reach it by a “ping” You may be using the wrong network adapter: check in “Network” tab using Options Application menu
2.
“Set is out of service” message is shown on IP Desktop Soft Phone screen
3.
4.
When logged in as IP Softphone agent, Softphone frequently disconnects with a message: "Set not registered."
5. 6.
VPN UAIP user is unable to communicate with another UAIP user on LAN environment. Noise during conversation
In the Descend Hierarchy of Users, set IP Softphone Emulation to "No." To do this, login to the OXE (call server). Follow the path: Users Review and Modify Directory Number (Enter the number of the terminal) the list that displays, for Reset for update authorized, change the setting from "True" to "False."
Check the Firewall or the Access lists. Ensure that the ports used by the Softphone are OPEN (refer the Section: 3.1 for more details) Management to be performed at PBX end: System Down Hierarchy Other system param Down Hierarchy Compression Param Review Modify Voice Activity Detection : False.
When the agent is logged-in, if the Softphone program is closed, or if the IP connection of the PC is lost, the Softphone set does not work. Instead, when it is opened, it gives the following message on the Soft phone’s screen: "Set not registered." To overcome this situation, we need to force log-off the agent, and re-open the Softphone program.
If you get this during the Installation, then one of the reason could be when the “IP-Soft phone Emulation” is not activated in the PABX: Ask your administrator to activate it in mgr >user>2nd level>TSCIP at PABX side This is a normal behavior. However, to solve this problem, move the extension type from 4068 to 4037 for the Agent and set the following parameters: User TSC IP User IP-Softphone Emulation: YES
7. 8.
The application does not initialize in laptops connected to LAN through VPN The application does not start with the system boot
This is due to problem in the LAN. Please contact your Administrator in this respect. May be due to network settings (firewall etc) Copy either the .exe file of the application, or its shortcut and paste it in the following directory: C:\Documents and Settings\user\ Start Menu\Programs\Startup
7 Appendixes
7.1 Common Features
1. Outline numbering is followed throughout this guide 2. To indicate emphasis or to distinguish objects in a sentence, they are given Bold formatting. 3. Process of accomplishing tasks is given in numbered steps. 4. In a process, intervening explanations are bulleted. 5. As much as possible, screenshots are provided to visualize actual displays