Professional Documents
Culture Documents
User Guide
Release 14.0.1.9
Document Version 1
Copyright Notice
Copyright © 2007 BroadSoft, Inc.
All rights reserved.
Any technical documentation that is made available by BroadSoft, Inc. is proprietary and
confidential and is considered the copyrighted work of BroadSoft, Inc.
This publication is for distribution under BroadSoft non-disclosure agreement only.
No part of this publication may be duplicated without the express written permission of
BroadSoft, Inc. 220 Perry Parkway, Gaithersburg, MD 20877.
BroadSoft reserves the right to make changes without prior notice.
Trademarks
BroadWorks® and BroadWorks Assistant™ are trademarks of BroadSoft, Inc.
Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft
Corporation. Other product names mentioned in this manual may be trademarks or
registered trademarks of their respective companies and are hereby acknowledged.
This document is printed in the United States of America.
13.0.8.27 2 Made changes for settings tabs and April 3, 2006 BroadSoft
video calls.
14.0. 1.0 1 Updated document for changes in January 28, 2007 BroadSoft
user interface and functionality.
The BroadWorks Communicator is an audio and video SIP softphone for Windows
platform, which is tightly integrated with the BroadWorks platform.
With audio and video capabilities, the BroadWorks Communicator allows users to place
calls anytime and anywhere from their PC, with a high-speed Internet connection.
This guide provides a detailed step-by-step configuration of the BroadWorks
Communicator.
It is assumed that the user is familiar with the system login, directory number (DN)
assignment, and other configuration items in BroadWorks. The following section outlines
the steps to configure BroadWorks Release 14 to inter-work with the BroadWorks
Communicator.
If JRE (version 1.5) is not installed on the user’s computer and the user tries to launch
Communicator by double-clicking on the application, the following error message appears:
After BroadWorks Communicator has completed loading, a login screen appears. The
login screen enables users to enter their credentials so that they can register with
BroadWorks.
If auto provision is enabled, you have the option to log in to the application. However, if
auto provision is disabled, then you first must enter Communicator settings. For more
information, see section 2.2 BroadWorks Communicator Settings.
To register Communicator with BroadWorks:
The following describes the licensing scheme (with their specific licensing feature sets) for
BroadWorks Release 13 for audio, audio with G.729, audio plus video, and audio (with
G.729) plus video. There are three licenses available:
BroadWorks Communicator = ClientLicense11
BroadWorks Communicator Multimedia = ClientLicense12
BroadWorks Communicator G.729 = ClientLicense13
Users must have the ClientLicence11 assigned to use Communicator. The license
combinations are:
BroadWorks Communicator = Audio only without G.729
BroadWorks Communicator + BroadWorks Communicator G.729 = Audio only with
G.729
BroadWorks Communicator + BroadWorks Communicator Multimedia = Audio and
video without G.729
BroadWorks Communicator + BroadWorks Communicator G.729 + BroadWorks
Communicator Multimedia = All features
With auto provision enabled, the settings are as shown in Figure 5 BroadWorks
Communicator – Settings (Auto Provision Enabled). There are two setting options:
Application Settings
Media Settings
For more information about auto provisioning, see the BroadWorks Communicator
Administration Guide [1].
Sip Settings
The SIP server is responsible for managing and connecting calls using IP and the PSTN.
This section describes SIP server information for Communicator, which is required to
register. The SIP settings enable Communicator to communicate with BroadWorks. In
addition, Communicator can authenticate the user’s credentials.
These setting are usually configured through the Deployment Toolkit, which correctly
configures Communicator with the correct BroadWorks settings as well as the correct SIP
settings.
Domain: This is the SIP server IP address or domain name of network, for example,
“my_domain.com”.
Server Address: This is the SIP server IP address or FQDN, for example,
“my_domain.com”.
Out-bound-Proxy: This is the IP address or FQDN of the proxy server.
Select Line Type: You can select the line type to associate with this device. There
are three options:
− Primary
− SharedCall
− VideoAddOn
User: This is the SIP user name used to register with the server. This is usually the
line or port. If the domain is not provided, the default domain is used.
Authentication User Name: This is the user name defined for the Authentication
service settings.
Authentication Password: This is the associated Authentication service password
for the user’s account. This credential is used for line port registration.
Language
User Language: You can select the preferred language for the user from the drop-
down list. Communicator always starts up with last selected language. If Server
Default is selected, then Communicator checks the language information from the
server for this user and uses that language. If the language is not available,
Communicator uses English.
Device Integration
Enable Polycom: Check this option if you want to integrate a Polycom device with
Communicator. It is selected by default.
Networking
SIP Listen Port: This is the port used to listen to SIP messages on the user’s
computer. This can be changed by setting the Override SIP Listen Port.
Communicator listens to the port (local PC) for all server responses. This port is
usually 5060 but can be changed. Note that this is important because there may be
other applications using same port, for example, another softphone device.
Override SIP Listen Port: This setting disables the SIP Listen Port and also allows
the user to enter a SIP listen port.
The audio codec frame size and Tos value can be set.
− Audio Codec Frame Size: Select the duration of one frame (measured in
milliseconds [ms]) from the drop-down list. The default is “Auto”.
− Tos Value: This is a packet Quality of Service Bit tag. This tag lets routers or
network devices know that this packet should receive priority. System
administrators can set specific priority to some Tos values. The user should set
this value by consulting with the system administrator. The user can enable or
disable reception and transmission for DTMF In-Band.
Other parameters that can be selected are as follows:
− Transmission DTMF Out of Band: The label is changed to “Send RTP Event
(RFC2833)”. If enabled, Communicator sends RTP Events for DTMF Tones.
− Acoustic Gain Controller: Recording gain control is automatically controlled
depending on the acoustic echo from the remote end.
− Acoustic Echo Canceller: If it is enabled, the local acoustic echo is cancelled.
− Voice Activity Detector: Checks if voice activity is available from the
microphone. If it is not, silence is passed in the stream.
Device List: The available video devices are automatically shown on the list and the
user can select the preferred device.
By default, the “System Default” device is selected. This is the device that the
operating system is currently using. To find out which device the operating system is
using (this depends upon the webcam installed), go to the Control Panel or My
Computer. The user can manually override this and change the preferred device.
Advanced: The user can set the Transmission Video Size for the video transmission,
enable a Fast Update, set the fast update rate, and change the bandwidth and Tos
value.
− Transmission Video Size: Select the video format from the drop-down list.
Available options are Auto, CIF, and QCIF. CIF supports the video with
dimensions of 352 x 288 and QICF supports 176 x 144 pixels. The default is
“Auto”.
− Video Frame Rate: This is the rate of the video capture in frames per second.
The user can define the video frame rate; however, it is best to select “Auto”.
− Fast Update: This forces Communicator to send in-time frames. In-time frames
are full picture rather than relative changes of an in-time frame. Output of a video
codec is a frame. The frame can carry complete (in-time) information about a
picture or picture segment. These frames are known as “intra” frames. To save
bandwidth, other frames can only carry changes relative to previously sent
frames. Frames carrying relative information are known as “inter” frames.
RTP packets may be lost while traveling through the network, therefore the
decoder at the remote end may lose the original in-time frame. When this
happens the user sees green patches on the screen. To solve this problem,
Communicator sends in-time frames after a specified interval.
− Fast Update Rate (per sec): This is the interval at which in-time frames are
transmitted.
− Tos Value: This is a packet Quality of Service Bit tag. This tag indicates to
routers or network devices that this packet should receive priority. System
administrators can set the specific priority to some Tos values. The user should
set this value by consulting with the system administrator.
The user can have different Tos values for voice and video.
After Communicator has been successfully installed and the user has logged in, the
BroadWorks Communicator home screen appears, as shown in Figure 15 BroadWorks
Communicator Home.
Note that after you log in, a title appears on the BroadWorks Communicator home screen,
which is either BroadWorks Communicator Multimedia or BroadWorks Communicator. If it
is BroadWorks Communicator Multimedia, it means the application supports multimedia
(audio and video are available). If the title shows BroadWorks Communicator, it means
this version only has the audio feature and the video functionality cannot be used.
BroadWorks Communicator screen has four tabs as follows:
Home
Contacts
Call Logs
Active Calls
1 Menu Bar
The Menu Bar has five menu options: File, View, Action, Tools, and Help.
For Communicator, the most important is the Settings option, which is available from the
File menu. The user can check which features they have by selecting About BroadWorks
Communicator from the Help menu option. A pop-up window appears on the screen that
shows which features are enabled and also provides codec-related information.
2 Home Tab
This tab appears the first time a user successfully logs into Communicator. From this tab
the user can make a call (voice or video) to a desired number.
3 Dial Pad
The dial pad is used for making phone calls. There are 12 number buttons that are used
to enter a number in the Number Entry box.
4 Status Bar
During the login process, Communicator displays its status on the status bar, which
appears at the bottom of the window. The status bar also contains Dial and Mute icons.
8 Call Button
After entering a number in the Number Entry box, the user clicks the CALL button to make
a new call.
9 Mute Button
During a voice or video call the user can mute/unmute (activate/deactivate) using the
Mute button, which is available on the status bar.
10 User Status
The User Status option is also available on the status bar. There are three status options
available: Manual Answer, Auto Answer, and Do Not Disturb. Users can select their
status and subsequently inform calling parties.
1 Contacts Tab
All Contacts 6
3 Outlook Contacts
Extension with
10
Location code
4 Contact Details
Call Icon 7
Extension Number 11
Search Option 8
2 Contacts
Displays the user’s BroadWorks contact list.
3 Outlook Contacts
Displays the user’s Outlook contact list.
4 Contact Details
Displays the names, numbers, and account type for the user’s contacts.
6 All Contacts
Displays all contacts along with detailed information.
7 Call Icon
Used to make a call by clicking on the yellow phone icon beside a contact.
8 Search Option
Used to search for particular contact.
4 Call Details
Displays call details, such as name, number, and time of call.
8 Call Icon
Used to make a call by clicking on the yellow phone icon beside a contact.
2 Dial Pad
By clicking the dial pad icon, a dial pad pop-up appears as shown in Figure 20 Dial Pad.
The user can dial an extension or a number that may be required in an ongoing call.
3 Video On/Off
By clicking this button, the user can turn on or off video privacy during an established
video call. When turned off, video privacy is established and the caller’s video is blocked.
5. Video Panel 1
Video panel 1 shows the local video, that is, the video of the user.
6 Hang-up Button
This hangs up the call and disconnects the user from other parties.
7 Zoom Display
This increases the size of the video display.
8 Transfer Button
This transfers the call to another party.
9 Hold Button
This holds the call.
10 Video Panel 2
This displays the remote party’s video.
Once the user has logged in, the BroadWorks Communicator page appears with the
Home tab. The Home tab consists of a dial pad, a drop-down menu to enter telephone
numbers, a CALL button to make a call, a messages indicator, and a call log.
There are two different ways to make an audio call:
Using the dial pad to select the telephone number to dial
Clicking on the drop-down menu and entering the telephone number using the key
pad on the keyboard
NOTE 1: A call can also be initiated by SIP URL, for example; johndoe@broadsoft.com.
NOTE 2: The CALL button once clicked, automatically determines if it is an audio or video call
depending on the endpoint capability (if the endpoint is capable of receiving video streams, that
is, another Communicator installed at the endpoint configured for video). If the endpoint is a
land line or a cell phone, then Communicator initiates an audio call.
The Home tab switches to the Active Calls tab; a line appears, showing the audio call that
has been initiated and displaying the number that has been dialed.
Figure 22 Active Calls shows an audio call that has been initiated with the status of the
call as Ringing.
Once the endpoint answers the call that had been initiated earlier, the status of the call
changes from Ringing to Active. Active means that both parties are on a call.
Figure 23 Status – Active shows the line appearance status that is Active:
After a call has become Active, the line appearance of the call displays several options to
control the call. These options are HOLD, TRANSFER, and HANG-UP.
HOLD enables the call to be place on hold.
TRANSFER enables the call to be transferred to another party.
HANG-UP enables the initiated call to be terminated.
NOTE: A video call can also be initiated using a SIP URL, for example,
johndoe@broadsoft.com.
3) Once the endpoint answers the call, the status of the video call changes to Active,
which means that both parties are on a call.
Figure 26 Video Call – Active shows the line appearance status as Active.
To answer the call, click Answer or to ignore the call, click Ignore.
If you answer the call, it becomes active.
After the HOLD button has been clicked, the Active call is placed on hold. If Music On
Hold service has been turned on (in the server) for the user, the calling party that was
placed on hold hears music.
Figure 32 Transfer
After the TRANSFER button has been clicked, the Active call is placed on hold and the
Transfer Call window opens.
The Transfer Call window enables you to place the calling party on hold and transfer the
party to another endpoint. There are two ways to determine where to transfer the call to:
You can select a contact to transfer the call to, by choosing a contact from the All
Contacts box.
OR
Using the key pad on the keyboard, you can enter the telephone number manually
into the Number box.
After selecting a party and thus indicating where the call is transferred, you can transfer
the call in two ways. The two ways to transfer a call are:
Blind Transfer
Consultative Transfer
Blind Transfer
Once a contact has been selected to transfer the call to, click the SEND DIRECTLY TO
button in the Transfer Call window to transfer the call to the selected party. This is
considered a blind transfer.
Consultative Transfer
To initiate a consultative transfer, first select the contact you want to transfer the call to, but
instead of clicking on the SEND DIRECTLY TO button that initiates a blind transfer, click
the CALL button. By clicking the CALL button, the selected contact endpoint rings. Once
the selected contact answers and if the party is ready to accept the transferred call
(agreed over phone), then click the TRANSFER button to transfer the call. This is called a
consultative transfer.
Once the call has been transferred, the call appearance disappears from the Active Calls
tab.
Note that when there is a consultative call in the Active Calls tab, the call is converted to
audio even if the user has multimedia features.
The Transfer Call window has a search option that is used to quickly find a contact and
transfer the call to that particular person.
Assume that party A and B are in conversation. Now party A wants to bring party C in a
conference.
1) Party A clicks the CONFERENCE button to get a dial tone and puts party B on hold.
2) Party A dials party C’s number, and then clicks the CALL button from the Home tab to
make the call.
3) If party C answers the call, then the CONFERENCE button appears for party B and
party C. At this time party B is in status Hold and party C is in Active state.
4) Party A clicks the corresponding CONFERENCE button to bring party B and party C
in the conference. If party A clicks party C’s CONFERENCE button (in Active state),
the status shows as Call Initiating and then Active. Now party A and party C are in
conference.
5) Click party B’s CONFERENCE, which shows the status as Adding to conference.
NOTE 1: During the conference, if party B or party C drops the call, the remaining two parties
can still talk. However if party A, the conference initiator, hangs up, all calls are terminated.
NOTE 2: The conference call can only be: 1) HOLD, and 2) HANG-UP.
NOTE: When a contact has been added, the contact information is stored and retained on the
BroadWorks Personal Directory. None of the contact information is stored locally on
Communicator.
5) To verify that a contact was added, check the Contacts window where it shows the
new contact information.
NOTE: Both group and enterprise contacts can be dialed through BroadWorks Communicator
using Click-To-Dial. Both the group and enterprise contacts are stored on BroadWorks. They
are not stored locally on BroadWorks Communicator.
NOTE: All call logs, that is, All Calls, Missed Calls, Received Calls, and Outgoing Calls, are all
stored on BroadWorks. The logs are not stored locally on Communicator.
Figure 50 Mute
You can easily mute your voice during the voice conversation with other parties. For
example, party A, party B, or party C can mute their voice during a call. If party A mutes
his or her voice, then party B and party C are not able to hear party A’s voice. However,
party A is able to hear the voices of party B and party C. The same applies to party B and
party C if they create the same scenario.
When the mute function is activated, the microphone icon has a red circle with a line
through it to indicate that mute is “on”. To deactivate it, simply click the microphone icon.
4.19 User Status (Manual Answer, Auto Answer, and Do Not Disturb)
Users can define their status by using this feature, which is available at the bottom of the
Communicator screen beside the microphone icon.
By default, the user status is set to “Manual Answer”. When a user receives a call
invitation, the user has to receive that call manually. If the user does not want to do this
manually, then the user can select Auto Answer mode. All the calls are automatically
accepted in the Auto Answer mode. The user can also show the user status as Do not
Disturb, which results in other parties being informed that the user is busy.
If there is any update patch in the auto update site location, the following pop-up screen
appears:
NOTE: The user can also check for updates while in off-line mode. It is highly recommended to
update the application to obtain all new features.
This section contains information that may aid those having difficulty using BroadWorks
Communicator. If your problem is not listed in the index, contact your service provider for
assistance.
Q2 I have installed the BroadWorks Communicator but cannot log in. What am I
supposed to do?
A2 After installation of the BroadWorks Communicator, you have to check the
prerequisite for the server authentication and authorization section.
The prerequisites for login are:
− You must have a BroadWorks username/password to use for logging in to
the BroadWorks Communicator.
− If Authentication service is enabled for you, your authentication username
and password must be provided.
If the prerequisites for login are not in place for your account, then contact your
system administrator and if the prerequisite for login is in place for your account,
then check the following:
− You must log in with the BroadWorks username/password provided by your
System administrator. Here you can check if you can log in with the
username/password to the BroadWorks server. If you cannot log in, you
receive a message in the status bar of the application Home tab. Following
are some examples of messages:
− “Failed to find BroadWorks server”, when any information is not correct
under “Settings → BroadWorks Settings”. (In this case the server
address, server port, and server version are provided for BroadWorks
Connection.)
− “Invalid login ID: aa@broadsoft.com”, when you have provided any
login ID that is unavailable in the server to which you are connected
(according to the information under “Settings → BroadWorks Settings”).
− “Login is failed for user: aa@broadsoft.com”, when the user name and
password do not match when logging in to the BroadWorks server.
− “Invalid password”, when you have provided an incorrect password for
the user ID.
− “Account disabled”, if the account is disabled from the server.
Check the information that you are providing and also contact your system
administrator:
Q3 I have changed the codecs, but the codec is not activated for the BroadWorks
Communicator. What am I supposed to do?
A3 Restart the application. Then the new codec setting is activated.
5.2 Settings
Q4 I have changed the settings, but now they are not working. Please get me back to the
default settings.
A4 Restart the BroadWorks Communicator with auto provision enabled. You should get
the default settings back. If this does not work, contact your system administrator.
5.3 Media
5.4 Login/Authentication
Q7 I am getting the error message “Failed to register sip server”. What am I supposed to
do?
A7 Check your SIP server setup in the setting and contact the system administrator.
Q8 I am getting the message “UDP port already used. Select another UD….” What does
this mean?
Q9 My codec list G729 is showing, but the call is not being established using G729. What
can I do?
A9 Check with your system administrator that you have the license for the codec G729.
Q13 I have installed the video device, but I am not receiving any video. What should I
do?
A13 Check the following:
− Another application is using the web cam.
− You have the correct license, that is, the multimedia license. Check in the
“About” or title of the BroadWorks Communicator. If you do not have the
licenses, contact your system administrator.
Q14 I have added some new contacts in Outlook, but BroadWorks Communicator is not
showing them.
A14 You have to re-import your updated contact list in the BroadWorks Communicator.
Q17 I have successfully logged in and I made a call, but I cannot hear anything.
A17 Check the following:
− The other party is not set to “mute”.
− Your audio device is properly configured, that is, the device you are using is
selected in the audio setting of the BroadWorks Communicator.
− The other party’s audio device setup is properly set up.
Q18 I have successfully logged in and I made a call. I can hear, but the other side cannot
hear me.
A18 Check the following:
− You are not set to “mute”.
− Your audio device is properly configured, that is, the device you are using is
selected in the audio setting of the BroadWorks Communicator. See the media
→ audio device settings.
− The other party’s audio device setup is properly set up.
Q19 I have successfully logged in and I made a call. I can hear, but my local video is not
shown although a webcam is installed in my PC.
A19 Check the following:
− Your video device is properly configured, that is, the device you are using is
selected in the video setting of the BroadWorks Communicator. Select the
preferred video device in settings → media → video → video device settings.
− You have a license for the video. Go to “About” to check your license.
Q20 I have successfully logged in and I made a call. Call proceeding is shown on the
Communicator screen. I can hear, but my video is not shown to the person I have
called.
A20 Check the following:
− Your video device is properly configured on the other side, that is, the device
you are using is selected in the audio setting of the BroadWorks Communicator.
Select the preferred video device in settings → media → video → video device
settings.
− Your privacy button text is “Turn Video On”. (This may be the cause of the
situation).
− You have a license for the video. Go to “About” to check your license.
Q21 I have successfully logged in and I made a call. Call proceeding is shown on the
Communicator screen. I can hear and my local video is shown, but I cannot see the
other party.
A21 Check the following:
Q22 The call is connected, but I cannot hear the person at the other end.
A22 Check if the other party’s speaker is working.
Q23 The call is connected, but the audio keeps breaking up.
A23 Check your network bandwidth.
5.7 Transfer
Q25 I am in an active call. Suddenly I cannot hear anything, but the call appearance is
showing that the call is active. What is wrong with my BroadWorks Communicator?
A25 Check if your:
− Remote party has put you on hold.
− Connection is okay.
Q26 I am trying to transfer, but the transfer is not being done. It is showing a busy tone.
What is the problem?
A26 Check if your current remote party and the party to whom you are trying to transfer
have a common codec.
Q27 I am clicking on my messages envelope icon (voice message portal icon) on the
Home tab page, but I am receiving an invalid number error.
A27 Check your extension number with your system administrator, obtain the correct
number, and dial manually.
Q29 When I am in an active call, I do not receive any new calls. How can I receive a call
when I am in an active call or in a conference?
A29 You need Call Waiting service. Contact your system administrator to enable the
service.
Q31 I have not been licensed to use Communicator but I am trying to sign in. What will
happen?
A31 Communicator displays “License not available”. If you see this message, then you
must contact your service provider.