Installation Admin Guide
Installation Admin Guide
Enterprise
Communication Server
Alcatel, Lucent, Alcatel-Lucent and the Alcatel-Lucent logo are trademarks of Alcatel-
Lucent. All other trademarks are the property of their respective owners.
1 INTRODUCTION .................................................................................5
1.10 Licensing..............................................................................................................................................7
7 UNINSTALLING ................................................................................ 80
8 TROUBLE SHOOTING......................................................................... 88
9 APPENDIXES ................................................................................... 90
Congratulations on your opting for: IP Desktop SoftPhone (IPDSP). You have indeed
made a wise choice. Now you can enjoy the benefits of more than a sophisticated
hard-phone, at the ease of mouse clicks.
Installation of this application is easy, quick and user friendly. This application is
also known as IP Desktop SoftPhone Agent, when used in the Call centre
Environment.
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 SoftPhone 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.
3. Basic configuration.
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 SoftPhone – User Guide for the same.
This manual targets System Administrator who also does networking. This is not
relevant to the user of this application
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.
If you intend to straightaway get into the installation of this application, start at
chapter 2. Ensure if the preparatory requirement for installing are in place by going
through section 2.1. Then you can embark on the installation process by going
through section 2.2. This also includes configuration activities.
Once the installation is over, go through the section on Customizing. You can refer
to rest of the sections, when you are necessitated to do those tasks.
If you are looking for information about the manual superficially, then chapter 1
would be appropriate. If you intend to go by the screenshots, refer to Table of
Figures that is given in Appendix.
1.10 Licensing
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
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 # 9.2 IP desktop SoftPhone in different environments:
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.
Note: Only the off hook/on hook feature is supported with the USB2 headset
buttons
Brand Model
NB: Jabra headset GN 9330 is removed from the list and is no more supported due to
malfunctioning in case of transfer calls.
2.1.3 Software
Windows 7
Editions: Professional, Home Premium,
Ultimate
2.1.4 Networking
Note:
Please note that: IPDSP does not support 802.1Q, but it supports only TOS
• Business and
• Pro ACD.
Following are the licensing and other differences between using the SoftPhone as
Business or as Pro ACD. You can decide on the mode, based on these.
They can have their own IP Desktop They can use the same IP Desktop
SoftPhone SoftPhone without buying additional
licenses
Choosing Business mode will link the Choosing Pro-ACD mode will link the
SoftPhone ID to the user (One ID per user SoftPhone ID to the PC (One ID only per
account enabled) PC)
ID & Config data stored in USER Account ID & Config data stored in ALL USERS
One phone number per user = One License One phone number per pc = One License
per user per pc
Limitations:
2. If you are using SoftPhone in PRO-ACD mode, BUSINESS users will not be
able to have their own phone
If you have an earlier version of this application installed in your system, then you
will have to do the following, before you commence installing this version (9.x):
i. Run the earlier version of this application that you have installed in you
system.
ii. Dial the prefix for Out Of Service. Eg 400 This code sends required
message to OXE server.
iii. You will be asked to provide your password. Key it in and click: Apply.
iv. Now you have put the application out of service. The screen will show as
below.
To install this application, you can use either of the following 2 files:
1. IpDesktopSoftPhoneInst_v9.x.exe OR
2. IPdesktopSoftphone_9_x.msi
IpDesktopSoftPhoneInst_v9.x.exe
If you use this file, the installation is complete, and it does not give you any choices
for custom installation. During the process of installation, you are required to input
server and other specific details. Thanks to these inputs, you can start using the
application immediately after installation.
IPdesktopSoftphone_9_x.msi
If you use this file for installation, then you get the option for selecting either:
- Typical
- Custom or
- Complete
installation of the application. You can select the modules for installation, in
different ways. Besides, during the process of installation, it provides a view of
different partitions in your hard disk. There, it provides details of their sizes and
space availability in each, for installation.
But by the time you complete installation, you would not have fed in server details
and your choice of Business/ProACD. You will have to configure them manually,
post installation. To overcome this, you can invoke this installation file from
Command Prompt, where you can provide Server address, language and
ProACD/Business option as parameters. This way, when installation completes, all
In subsequent pages, you can find details of installing the application, using all
these methods.
4. This displays the following screen. In it, select the language in which you
intend to install this application
5. Click OK.
6. Click Next.
• 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.
7. Click Next.
9. Click Next.
10. 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.
11. At bottom left, you can see the status of space availability for installation.
If the space available is short of required space, then delete files to make
room for installation.
• 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.
• If .NET Framework 2.0 is not present in your system, then, its installation
begins. Its opening screen is given below. if you have installed the previous
version of this application, .NET framework will already be existing in your
system. So, you will not see the screens shown 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.
• This is the progress bar showing installation of .NET Framework. Wait until
it completes. Once it completes, the screen would change as given below:
16. Microsoft Visual C++ 2005 SP1 installation begins. Its opening screen is
given below. if Visual C++ 2005 SP1 will already be existing in your system
just click No. So, you will not see the 2 screens shown below.
• Once Visual C++ 2005 SP1 installed, the IpDesktopSoftPhone setup process
will continue as in the above screen.
17. In the 1st entry box, give the IP address of your Call Server (ROLE MAIN
Address). This is mandatory
18. 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. At your option, you can tick the check box against Activate FlexOffice. Only
when you tick this check box, the other check boxes at right will have effect.
20. In the entry boxes at right, you can see the entries that display by default.
You can change them as needed, and fill the empty boxes with entries
applicable to your environment.
SCREENSHOT 20 – Customizing - 1
23. 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)
24. Second entry box is for selecting the language for this application. Here, the
languages are listed in abbreviated form. Those abbreviations and their
expansions are tabulated below:
Abbreviation Expansion
En English
Fr French
Ge German
It Italian
25. The 9rd entry box lists the available skins for the phone display. They are:
• 4028_MediumBlack
• 4028_MediumWhite
• 4038_MediumAquaWhite
• 4038_MediumMetal
• 4068Medium AquaWhite
• 4068MediumBlack
• 4068MediumMetal
• Mini4068Aqua Blue
• Mini4068Aqua White
• Mini4068Black
• Mini4068Metal
• SkinPEPS
In pages following, you can see what display you get for the selection you
make here. The sequence given in the above list match the display you
get, when the IPDSP is operational.
26. Based on the above screenshots, make your choice of skin here.
27. To activate automatic updates, tick the checkbox at the bottom of the
screen.
28. Select required mode - Business or Pro-ACD, according to the given guidance.
If you select Business, different users of this application are given different
MAC IDs. If you select Pro-ACD, then despite the number of users, the MAC
ID remains same.
30. To run this application immediately, tick the checkbox in this screen.
• This screen displays only when .NET Framework 2.0 is installed during this
installation process. Otherwise there is no need to reboot.
32. Installation is now complete. For the installation to take effect, reboot the
system. To do so, click Yes In the screen above.
33. If you click No, the system will not reboot. But you will not be able to use
the SoftPhone.
1. See if .NET Framework 2.0 and VC++ 2005 are already installed. If they are
already installed, then you can go ahead with installing this application
directly. Otherwise, when you invoke the installation process, the following
warning message would display, and the installation process will be aborted:
2. When .NET and VC++ 2005 are not installed, then you will have to first, run
the setup.exe file.
4. Here if the system is not updated with the dotnet framework 2.0, then that
package also will be displayed and will get installed.
7. Now you can proceed with the installation of IPDSP application using .msi
file. To do so,
10. Open command prompt screen. You can do this by clicking on: Start
Run. In the screen that displays, key in: cmd. This opens the command
prompt screen.
12. There, key in the following. Below is the template. In the place of those
given in blue fonts enclosed within “<>”, give the actual values as applicable
to you.
- Below is a sample, where actual values are given in the place of variables given
in the template above:
- Below table explains the different components that constitute this command:
Component Description
‘msi’ extension
13. But you need not necessarily key in the full command given. That command
displays all the options available. PBXADDR is the only mandatory
parameter. Other parameters are optional.
14. After keying the command, the installation process would commence and the
application will open the following screen.
17. This is License agreement. You can use the scroll bar to read it fully. Check
the box below the agreement text box to agree to this License. Then click
Next.
a. Type: Custom:
If you select this type, you can select the portions that should be
installed. You can use this option, in the following manner:
iii) When you click on: IpDesktopPhone, the following sub-option list
displays, for you to select from:
iv) From the sub-option that displays, you can make your choice.
v) You get the following display, when you click on: Program. You can
make your choice likewise.
vii) The button: Disk Usage displays hard disk details. Based on that
information, you can decide on the hard disk or its partition, to
install the application. Its display is below:
19. Whatever choice you make among Typical or Complete, the above screen
displays. If you select: Custom, then also, after making your selections, you
reach this page.
21. This triggers the installation process. The screen that follows, shows its
progress:
23. The installation process is now complete. Click on the Finish button to close
this screen.
1. In the call server, create a user. Sample text for this process is given below:
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:
4. When you launch the application for the first time, it displays the image of
the IP Touch phone, overlapped by the Audio Tuning Wizard window as given
below. This need to be completed during the first launch of the application.
Here, you can view the various audio devices and configure them as needed.
You can find details of these under point #6.2 Audio Wizard in this manual.
5. Once you have completed the settings of the Audio Tuning Wizard, close the
screen. Now you will have to deal with the display screen of IP Touch
phone.
6. Initially, there will not be any connectivity. So, the display panel displays as
follows:
8. 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:
9. Once you have keyed in the password, it moves to next screen. No need to
press Enter key.
10. It verifies your credentials, and once this process is over, you can see the
following display:
• Applications
• Audio Wizard
• Volume Level
6.1 Applications
2. In the list box that displays, select: Options Applications, as given below:
Note:
Current version of IPDSP does not support Encryption and VLAN. The
Protected Mode in the above screenshot is relevant only where encryption is
already in existence.
4. By default, the General tab opens. For a System Administrator, only the
field: AOM that is marked by the red outline is relevant.
• AOM10
• AOMEL
• NONE
In the phone image, when you click on the button that the arrow points to,
then a pad extends. It contains AOM (Add-on Module) buttons. The
programming that you do in the OXE server determines the number of
buttons that this pad would contain. It has the following 2 choices:
AOM10:
To provide for 10-key extending pad, in the OXE server, you will have to key
in as given below:
In the above sample, note the portion enclosed within red box. This is the
place where you will have to make the change. Once you do this, then the
phone display will have the extending pad with 10 buttons option. When
the pad is extended, it will look as below:
AOMEL:
To provide for 14-key extending pad, in the OXE server, you will have to key
in as given below:
In the above sample, note the portion enclosed within red box. This is the
place where you will have to make the change. Once you do this, then the
phone display will have the option of extending pad with 14 buttons. When
the pad is extended, it will look as below:
In the General tab, in the field: AOM, the user can opt for either AOM10 of
AOMEL, based on your programming only.
6. The tab: Sounds is relevant to users only. You can skip this tab, and click on
the tab: Network. This opens the following page:
7. 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:
Network Adaptor:
This refers to the Ethernet card. The application
automatically detects existing cards in the system,
Description
and lists them here. You can select the card you
prefer.
This automatically displays. This is for your
Name
information. You cannot change it.
Tftp:
Tftp Server (Main) This refers to the IP address of your call server.
8. 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.
10. This tab is specifically for customizing automatic updates. The table below
explains the components of this tab:
11. Now the application is operational. You can change the settings whenever
you require, following these steps.
12. 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.
This section is dedicated for configuring different types of audio devices for the
application. Whenever you add/change audio devices, you will have to run this
wizard again and select your preferences. Otherwise, the changes in audio hardware
will not have any effect.
3. This opens the starting page for customizing. As given in that page, close
all running programs that deal with audio playing or recording.
• In the above screen, the installed audio devices are listed in the dropdown
boxes. You can select different or same device for the different tasks listed.
The following table explains the fields in this page:
5. Once done with this page, click Next. The following screen opens:
• This page is for setting the volume level of phone speakers. The device that
this setting impacts, is given at the top of this page. Once you have set the
levels, you can get a sample of this volume, by clicking on the Play button at
left. When you do so, it plays the file selected for Ringing in the previous
step.
6. Once done with this page, click Next. The following screen opens:
• This page is for setting the volume level of phone speaker, that uses another
device. The device that this setting impacts, is given at the top of this page.
Once you have set the level, you can get a sample of this volume, by clicking
on the Test button at left. When you do so, it plays the file selected for
Ringing in the previous step.
7. After completing this page, click Next. The following screen opens:
9. The volume set with the Audio Wizard will be the volume level and
sensitivity level for the Speakers and mic respectively. The volume
changes during the conversation period can be done with the volume level
option which is mentioned below.
By default, the volume you had set using Audio Tuning Wizard will be active. But if
you want to temporarily change the volume during conversation, then you can use
this facility. Once the call is over, this setting will not be in effect
Under this link, you have only one page. To access this page:
2. In the list box that displays, select: Options Volume, as given below:
4. In this page, you can set the volume by moving the handle up and down.
5. Once done, click on the x given at top right to close this window.
The table below, lists the ports that this application uses:
Note:
• (*) This port range is only used to transport voice using RTP protocol and fax
using T.98 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.
Before attempting to uninstall the application, close it. To do so, right click on the
body of the SoftPhone, and select Quit.
If you try to uninstall the application before closing it, it will display the following
error message:
To uninstall, you will have to use the same type of file that was used for installing.
There are two types of files for installing:
- IpDesktopSoftPhoneInst_v9.x.exe
- IPdesktopSoftphone_9_x.msi
When you uninstall this application, the extension - .exe or .msi – should be
identical with the file used for installing. When you uninstall from Windows using
the following path, then it takes care of this issue automatically:
When you are uninstalling from command prompt, you will have to use different
commands, as explained later here.
1. From the taskbar, activate the uninstalling file using the following path:
3. Click OK.
5. This page is also for your information only. This tells you from which folder, it is
uninstalling the application. Click Uninstall.
• This page shows the progress bar that shows the progress of uninstalling
process.
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
7. Now, the uninstalling process is over. Click Finish to close this screen.
1. Open command prompt screen. You can do this by clicking on: Start
Run. In the screen that displays, key in: cmd. This opens the command
prompt screen.
- Below table explains the different components that constitute this command:
22 – Finnish
29 – Dutch
24 – Russian
40 – Chinese
42 – Korean
4. After keying the command, the uninstalling process would commence and
the application will open the following screen.
7. Once uninstalling is over, this screen closes all by itself. This indicates that
the uninstalling is complete.
# Problem Remedy
o Check if your network connection is
enabled.
o Check that tftp address is correct and
1. Connection establishment fails make sure you reach it by a “ping”
o You may be using the wrong network
adapter: check in “Network” tab using
Options Application menu
If you get this during the Installation, then one
of the reason could be when the “IP-SoftPhone
Emulation” is not activated in the PABX: Ask
your administrator to activate it in
“Set is out of service” message is mgr > Users >Descend Hierarchy > TSC IP
2.
shown on IP Desktop SoftPhone screen Users > Review and Modify >Directory
Number (Enter the number of the terminal) >
Ctrl+V >Select parameter IP SoftPhone
Emulation > press Enter to change the
parameter from NO to YES at PABX side
When the agent is logged-in, if the This is a normal behavior. However, to solve
SoftPhone program is closed, or if the IP this problem, move the extension type from
connection of the PC is lost, the 4068 to 4097 for the Agent and set the
SoftPhone set does not work. Instead, following parameters:
when it is opened, it gives the following mgr > Users >Descend Hierarchy > TSC IP
3.
message on the SoftPhone’s screen: "Set Users > Review and Modify >Directory
not registered." To overcome this Number (Enter the number of the terminal) >
situation, we need to force log-off the Ctrl+V >Select parameter IP SoftPhone
agent, and re-open the SoftPhone Emulation > press Enter to change the
program. parameter from NO to YES
In the Descend Hierarchy of Users, set IP
SoftPhone Emulation to "No." To do this, login
to the OXE (call server). Follow the path:
When logged in as IP SoftPhone agent, Users Descend Hierarchy TSC IP Users
4. SoftPhone frequently disconnects with a Review and Modify Directory Number (Enter
message: "Set not registered." the number of the terminal) press Ctrl+V. In
the list that displays, for Reset for update
authorized, change the setting from "True" to
"False."
VPN UAIP user is unable to communicate Check the Firewall or the Access lists. Ensure
5. with another UAIP user on LAN that the ports used by the SoftPhone are OPEN
environment. (refer the Section: 6.4 for more details)
6. Noise during conversation Management to be performed at PBX end: