Avaya one-X® Communicator

Quick Setup

November 2009
Notice
While reasonable efforts were made to ensure that the information in this document was
complete and accurate at the time of printing, Avaya Inc. can assume no liability for any errors.
Changes and corrections to the information in this document may be incorporated in future
releases.
For full support information, please see the complete document, Avaya Support Notices
for Software Documentation, document number 03-600758.
To locate this document on our Web site, simply go to http://www.avaya.com/support and
search for the document number in the search box.
Documentation disclaimer
Avaya Inc. is not responsible for any modifications, additions, or deletions to the original
published version of this documentation unless such modifications, additions, or deletions were
performed by Avaya. Customer and/or End User agree to indemnify and hold harmless Avaya,
Avaya's agents, servants and employees against all claims, lawsuits, demands and judgments
arising out of, or in connection with, subsequent modifications, additions or deletions to this
documentation to the extent made by the Customer or End User.
Link disclaimer
Avaya Inc. is not responsible for the contents or reliability of any linked Web sites referenced
elsewhere within this documentation, and Avaya does not necessarily endorse the products,
services, or information described or offered within them. We cannot guarantee that these links
will work all of the time and we have no control over the availability of the linked pages.
Warranty
Avaya Inc. provides a limited warranty on this product. Refer to your sales agreement to establish
the terms of the limited warranty. In addition, Avaya’s standard warranty language, as well as
information regarding support for this product, while under warranty, is available through the
following Web site:
http://www.avaya.com/support.
Copyright
Except where expressly stated otherwise, the Product is protected by copyright and other laws
respecting proprietary rights. Unauthorized reproduction, transfer, and or use can be a criminal,
as well as a civil, offense under the applicable law.
Avaya support
Avaya provides a telephone number for you to use to report problems or to ask questions about
your product. The support telephone number is 18002422121 in the United States. For additional
support telephone numbers, see the Avaya Web site: http://www.avaya.com/support.
Contents

About this guide.................................................................................................................. 4

Avaya Aura™ Communication Manager Requirements .................................................... 4
SIP Enablement Services Requirements............................................................................. 4
Licensing Requirements...................................................................................................... 4
Supported telephones .......................................................................................................... 5
Avaya Video Telephony Solution Requirements ............................................................... 5
Avaya one-X® Portal Integration Requirements................................................................. 6
one-X Portal Presence Requirements.................................................................................. 6
Microsoft OCS/MOC Integration via one-X Portal and Presence Services Requirements 6
Visual voice mail Requirements ......................................................................................... 7
Visual Audio Conferencing via one-X Portal and Avaya Meeting Exchange
Requirements ...................................................................................................................... 7
Configure one-X Communicator as an H.323 Endpoint on Communication Manager...... 7
Configure one-X Communicator as a SIP Endpoint on Communication Manager and SIP
Enablement Services........................................................................................................... 8
Procedure 1: Create an AWOH Station in Communication Manager ............................ 8
Procedure 2: Configure an OPTIM Extension................................................................ 8
Procedure 3: Add a User in SIP Enablement Services ................................................... 9
Microsoft Office Communicator Integration ...................................................................... 9
Requirements .................................................................................................................. 9
Administration ................................................................................................................ 9
Procedure 1: Configure the Server Files................................................................... 10
Procedure 2: Configure the Microsoft Office Communicator Client ....................... 10
one-X Portal Integration ................................................................................................... 12
Requirements ................................................................................................................ 12
Administration .............................................................................................................. 12
Sametime Integration ........................................................................................................ 12
Requirements ................................................................................................................ 12
Administration .............................................................................................................. 13
The Discover Feature........................................................................................................ 14
Configuration Checklist .................................................................................................... 16
one-X Communicator rebranding and customization ....................................................... 17
Customizing the emergency call-handling disclaimer.................................................. 17
Customizing the Avaya one-X logo.............................................................................. 17
Customizing the title on the Login and Welcome windows ......................................... 18

3
About this guide
This Administration Quick Setup guide describes how to administer one-X
Communicator Release 5.2.
For more information on one-X Communicator, you can refer to the following guides:
• Overview and Planning for Avaya one-X Communicator® guide. This guide
provides an overview of Avaya one-X Communicator and its deployment options.
• Avaya one-X® Communicator Getting Started guide. This document provides
step-by-step instructions for installing, upgrading, and configuring one-X
Communicator on your computer.

Avaya Aura™ Communication Manager Requirements

Communication Manager must be installed and administered properly. The following
releases are supported:
• For H.323 voice calls: Communication Manager Release 5.0 or later
• For H.323 video calls: Communication Manager Release 5.0 or later
• For SIP voice calls: Communication Manager Release 5.0 or later, Avaya Aura™
SIP Enablement Services (SES) Release 5.2 and Avaya one-X desk phone SIP
firmware version 2.5 or later (for Desk Phone mode support)

SIP Enablement Services Requirements

You must install SIP Enablement Services Release 5.2 and administer it properly to use
one-X Communicator as a SIP endpoint.

Licensing Requirements
You need the following licenses:
• A SIP Enablement Services Home Seat license to build a SIP Enablement
Services extension.
• A Communication Manager OPS license to add an extension to the OPTIM form
in Communication Manager. This only applies to SIP endpoints.

4
Supported telephones
The supported telephones depend on whether you installed the one-X Communicator in
H.323 mode or in the SIP mode and the user mode you want to use.
one-X Communicator supports the following telephone types in H.323 mode:
H.323 mode:
• Avaya 2400 Series telephones
• Avaya 4600 Series telephones
• Avaya 6400 Series telephones
• Avaya 9600 Series telephones
NOTE:
All 16xx phones configured as 46xx phones on the Communication Manager
sever are also supported. one-X Communicator does not support the Avaya 9610
telephone in H.323 mode.
SIP Mode with all modes
• 4600 Series telephones
• 9600 Series telephones
NOTE:
• one-X Communicator does not support the 9610 telephone in SIP mode.
• one-X Communicator supports only 9600 series telephones in SIP mode
with Desk phone mode (shared control via server).
NOTE:
Any phone not listed above is not supported.

Avaya Video Telephony Solution Requirements

Before you can use one-X Communicator Release 5.2 for video calls, you must ensure:
• Your network is capable of supporting the high bandwidth demands of video over
IP.
• Your network is configured properly to support video.
NOTE:
one-X Communicator Release 5.2 supports video in H.323 mode only.

See the Avaya Video Telephony Solution Release 4.0 Networking Guide, 16-601423 for
more information.

5
To handle video calls with one-X Communicator, users need:
• Avaya-recommended USB Web camera (such as Logitech Quickcam® Pro series
cameras and Creative Notebook Pro series cameras) and the recommended
drivers installed on your PC. Please see www.avaya.com/support for the latest
list of supported cameras.
• 1 GB of RAM
The PC must meet the system requirements for the Web camera.

Avaya one-X® Portal Integration Requirements

To use one-X Communicator with one-X Portal integration, one-X Portal Release 5.2
must be installed and operating properly.
one-X Portal Release 5.2 is required to provide Intelligent Presence, visual voice mail,
centralized call logs, visual audio conferencing, and MOC/OCS integration. Refer to the
one-X Portal documentation regarding one-X Portal requirements.
NOTE:
one-X Portal integration is supported only if you are using one-X Communicator in H.323
mode.

one-X Portal Presence Requirements

To use presence with one-X Portal:
• one-X Portal Release 5.2 must be installed and administered properly
• Avaya Aura™ Presence Services Release 1.0 must be installed and
administered properly
NOTE:
For instant messaging presence, Presence Services should be integrated with Microsoft
OCS 2007 server Release 1 and Release 2 through Microsoft Edge server.

Microsoft OCS/MOC Integration via one-X Portal and

Presence Services Requirements
To integrate the presence capabilities of OCS and Presence Services with one-X
Communicator:
• Microsoft OCS/OC 2007 Release 1 or Release 2 must be installed and
administered properly (if you want to integrate one-X Communicator with
Microsoft OCS/OC 2007 Release 1 or Release 2)

NOTE:
Avaya Aura™ Application Enablement Services Release 4.2.2 or 5.2 is required
for presence to work correctly including Microsoft OCS/OC 2007 Release 1 or
Release 2 published IM presence.
• one-X Portal Release 5.2 must be installed and administered properly
• Presence Services Release 1.0 must be installed and administered properly

6
Visual voice mail Requirements
To use visual voice mail with one-X Communicator:
• one-X Portal Release 5.2 must be installed and administered properly
• Avaya Modular Messaging Release 4.0 or Release 5.2 must be installed and
administered properly

Visual Audio Conferencing via one-X Portal and Avaya

Meeting Exchange Requirements
To use visual audio conferencing with one-X Communicator:
• one-X Portal Release 5.2 must be installed and administered properly
• Avaya Meeting Exchange Release 4.1 or 5.2 must be installed and administered
properly

Configure one-X Communicator as an H.323 Endpoint on

Communication Manager
Perform the following steps to configure one-X Communicator as an H.323 endpoint on
the Communication Manager:
1. Determine the maximum number of one-X Communicator endpoints your voice
system supports:
a. Use the display system-parameters customer-options command to
access the Optional Features form.
b. On page 10 of the form, verify the oneX_Comm setting. This number is
provided by the RFA license file.
2. Perform one of the following steps on Communication Manager:
• If you want to add a new station that uses one-X Communicator, use the add
station command.
• If you want to modify an existing station that uses one-X Communicator, use
the change station xxxx (where xxxx is the number of the station you want
to modify) command.
The Station form appears.
3. Enter the appropriate information for this station.
4. Set IP Softphone to y.
5. If you want this station to handle video calls:
• Set IP Video Softphone to y.
• If you want this station to be able to make priority video calls, make sure you
select a COS level that has Priority Video Calling enabled.
6. Repeat Steps 2 through 5 for each one-X Communicator endpoint you want to
configure on Communication Manager.

7
Configure one-X Communicator as a SIP Endpoint on
Communication Manager and SIP Enablement Services
This section provides the steps you must perform to configure one-X Communicator as a
SIP endpoint. You must perform these steps for each one-X Communicator user.

Procedure 1: Create an AWOH Station in Communication

Manager
Use the add station # command to create an AWOH (Administration Without Hardware)
station for the one-X Communicator in Communication Manager.
When adding the station, be sure to perform the following steps:
1. In the BUTTON ASSIGNMENTS section (page 4), be sure to specify at least five
call appearances for this station.
2. In the BUTTON ASSIGNMENTS section (page 4), assign the appropriate
Advanced SIP Telephony features for this station.

Procedure 2: Configure an OPTIM Extension

To configure an OPTIM extension in Communication Manager:
1. Use the add off-pbx-telephone station-mapping command to configure an
OPTIM extension. Set the following parameters:
• Station Extension to the extension of the one-X Communicator. (You added
this extension in Procedure 1.)
• Application to “OPS.”
• Phone Number to the extension of one-X Communicator.
• Dial Prefix to the AAR/ARS code used for the SIP trunk if AAR/ARS is being
used. Otherwise, this field is blank.
• Set Trunk Selection to either “aar,” “ars,” or the trunk number of the SIP trunk.
Avaya recommends that you use the trunk number.
• Configuration Set. Enter 1 if you want to use the default settings. Be sure to
review the fields under the configuration set to customize for each customer.
You must set Fast Connect on Origination to “No.”
• Call Limit to at least 5 (Page 2)
2. If extended features are used, use the change off-pbx-telephone feature-
name-extensions command to assign extensions to available features (such as
conferencing, call forwarding, and send all calls).

8
Procedure 3: Add a User in SIP Enablement Services
Using the SIP Enablement Services administration interface, add a user to SIP
Enablement Services. Set the following parameters:
• Primary Handle
• User ID
• Password
• Host to which the user registers
• First Name of user
• Last Name of user
• Add Media Server Extension. The Media Server Extension should match the
AWOH extension created in Communication Manager.
NOTE:
Advance SIP telephony support requires the Primary Handle and User ID to be numeric
(extension).

Microsoft Office Communicator Integration

This section describes how to integrate Microsoft Office Communicator 2007 Release 1
or Release2 with one-X Communicator.

Requirements
Before performing the procedures in this section, make sure the following conditions
exist:
• Microsoft OCS/OC 2007 Release 1 or Release2 is installed and operating
properly.
NOTE:
Application Enablement Services Release 4.2.2 or 5.2 is required for presence to
work correctly including Microsoft OCS/OC 2007 Release 1 or Release2
published IM presence. Application Enablement Services is required for call
control through Microsoft OCS/OC 2007 Release 1 or Release2 integration.
• Microsoft Internet Explorer 7.0 is installed and operating properly on the user’s
PC.
• Microsoft Visual C++ 2005 Redistributable Package for Office (VSTO)
• one-X Communicator is installed and operating properly on the user’s PC.

Administration
To integrate Microsoft OCS/OC 2007 Release 1 or Release2 with one-X Communicator,
you must:
1. Configure the web-server files.
2. Configure the Microsoft Office Communicator client.

9
Procedure 1: Configure the Server Files
To configure the web-server files:
1. Download the file tabui.zip.
2. Unzip the contents of tabui.zip to a folder.
3. Copy contents of the zipped file to a folder on a web server that users can
access (for example, http://mywebserver.com/oneXC/tabui/onexcuitab.xbap and
http://mywebserver.com/oneXC/tabui/icon.png).
4. Copy the file tabs.xml to a web server (for example,
http://mywebserver.com/ocTabs/tabs.xml).
5. Using Notepad, open the tabs.xml file.
6. Update the <image> element with the correct URL for the icon.png file hosted in
your environment.
7. Update the <contenturl> element with the current URL for the onexcuitab.xbap
file hosted in your environment.
NOTE:
Do not change the format of the XML tabs in this file. Such a change can corrupt
the file and make it unusable. If you are having issues seeing the tab, you should
verify in Notepad that your XML file is formatted exactly as the original file
provided or specified in the Microsoft Office Communicator 2007 Deployment
Guide.
8. Save your changes and exit the file.

Procedure 2: Configure the Microsoft Office Communicator Client

Perform the following steps on each PC running the Microsoft Office Communicator
client:
1. Open the Registry Editor. (Go to Start > Run and type regedit).
2. Add the following string value (if it does not exist already):
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Communicator\TabURL.
3. Set the value data to be the URL of the tabs.xml file hosted in your environment
(for example, http://mywebserver.com/ocTabs/tabs.xml).
4. Download the certificate file for one-X Communicator.
5. Open Certificates. (Go to Start > Run and type certmgr.msc).
6. Import the mycredentials.spc certificate to the following logical stores:
• Trusted Root Certification Authorities
• Trusted Publishers
To import the certificate:
a. Select the logical store, and right-click the mouse.
b. Choose All Tasks > Import.
c. Complete the Certificate Import Wizard (no password).

10
7. Start Microsoft Internet Explorer 7.0.
8. Select Tools > Internet Options.
9. Click the Security tab.
10. Select the Trusted Sites zone.
11. Click Sites.
12. Add the site hosting the tab to the trusted sites list (for example,
http://mywebserver.com).
13. Start Microsoft Office Communicator and log in.
14. Start one-X Communicator and log in.
The Avaya tab appears at the bottom of the Microsoft Office Communicator
window.
15. Repeat Steps 1 through 14 for each Microsoft Office Communicator client.

11
one-X Portal Integration
This section describes how to integrate one-X Communicator with one-X Portal.

Requirements
Before performing the procedures in this section, make sure one-X Portal Release 5.2 is
installed and operating properly.

Administration
Make sure the following services are configured properly on the one-X Portal Server:
• Call History service
Provides access to the one-X Portal Server call logs.
• Contacts service
Provides access to the one-X Portal Server contacts.
• Modular Messaging (MM) server
Provides access to voice messages.
• Meeting Exchange (MX) server
Provides access to Meeting Exchange bridge conferences.
• Presence service
Shows presence for users.
• User Assistant service
Provides access to the one-X Portal Server login modes.

Sametime Integration
This section describes how to integrate one-X Communicator with IBM Lotus Sametime
Connect 8 client.

Requirements
Make sure the following conditions exist:
• IBM Lotus Sametime Server Version 8.0 is installed and operating properly.
• IBM Lotus Sametime Connect 8.0 client is installed and operating properly on the
user’s PC.
• one-X Communicator is installed and operating properly on the user’s computer.

12
Administration
To integrate one-X Communicator with IBM Lotus Sametime Connect clients:
1. Download the file Avaya_oneXCommunicator_Plugin_Update_Site.zip.
2. Unzip the file into a folder on a web server that is accessible by the IBM Domino
server. This location is the URL that is used to configure the Update Site in the
Domino server. For example, if the file was unzipped into a folder called
c:\webroot\SametimeUpdateSite on a Web server called internal.web.server,
the URL would be:

http://internal.web.server/SametimeUpdateSite/Plugin_Update_Site/features/site.x
ml.
3. Add the update site URL in "URL for UIM Provisioning" in the stconfig.nsf
"CommunityClient” document.
4. Add the update site URL in "Sametime Update Site URL" in the stpolicy.nsf
"DefaultPVS" document.
5. Save the changes.
6. Restart the Domino server.
Approximately five minutes after the server restarts, each Sametime client should
receive a notification that this update was installed. When the clients receive this
message, the users must click the Restart Now button.

13
The Discover Feature
After one-X Communicator is installed on a PC, users must specify the configuration
settings. Users are not able to log in and use one-X Communicator until these settings
are administered. To simplify the configuration process, one-X Communicator provides
the Discover feature. When a user clicks the Discover button in a settings dialog box,
one-X Communicator retrieves the appropriate information from the DHCP server. This
information is defined in the 46xxsettings.txt file hosted on an HTTP server. The HTTP
server IP is retrieved from the DHCP server, option 242 or 176 (whichever is
configured).
NOTE:
The Discover feature does not work properly if you are using one-X Communicator
through a VPN connection.

To use the Discover feature, you must set the following parameters in the
46xxsettings.txt file:
• # Phone related parameters
o MCIPADD: Specify the list of servers. (The first server is the “Primary,”
and the other servers are “Alternate.”) This is an H.323-specific
parameter.
o SIPDOMAIN: Specify the SIP domain. This is a SIP-specific parameter.
o SIPPROXYSRVR: Specify the SIP proxy server. This is a SIP-specific
parameter.
o ENABLE_AVAYA_ENVIRONMENT: This parameter must be set to
Avaya Environment. This is a SIP-specific parameter.
o SIPSIGNAL: Specify the transport type (that is, TLS, UDP, or TCP).
• # Dialing rules related parameters
o PHNOL: Specify the digit(s) you must dial to access an outside line.
o PHNCC: Specify your country code.
o PHNDPLENGTH: Specify the extension length for internal extension
calls.
o PHNIC: Specify the digit(s) you must dial for international calls.
o PHNLD: Specify the digit(s) dial for long distance calls
o PHNLDLENGTH: Specify the national telephone number length.
o DIALPLANAREACODE: Specify your area/city code. This is an one-X
Communicator-specific parameter. You must enter this parameter in
the file manually.
o DIALPLANLOCALCALLPREFIX: Specify whether you must dial your
area/city code when you make a local call. If you must dial the area/city
code, enter true. Otherwise, enter false. This is an one-X Communicator-
specific parameter. You must enter this parameter in the file
manually.

14
 o DIALPLANNATIONALPHONENUMLENGTHLIST: Specify a comma
separated list of national phone number length. This is an one-X
Communicator-specific parameter. You must enter this parameter in
the file manually.
• # Directory related parameters
o SP_DIRSRVR: Specify the IP address or fully-qualified domain name
(FQDN) of the LDAP directory server name or address.
o SP_DIRSRVRPORT: Specify the TCP port number of the LDAP directory
server. The default is 389.
o SP_DIRTOPDN: Specify the directory topmost distinguished name.
o SP_DIRTYPE: Specify the directory type. The value should be in capital
letters (for example, ACTIVEDIRECTORY, DOMINO, or NOVELL). This
is an one-X Communicator-specific parameter. You must enter this
parameter in the file manually.
• # one-X Portal related parameters
ONEXPORTAL_URL: Specify the one-X Portal URL. This is an one-X
Communicator-specific parameter. You must enter this parameter in the
file manually.

15
Configuration Checklist
To administer the one-X Communicator configuration settings, users must have the
following information.
NOTE:
If you configure the Discover feature properly, one-X Communicator populates the
following fields when the user clicks the Discover button in the corresponding dialog
box.
Phone Settings
IP address of the Avaya telephone server: __________________________________
Domain of SES (SIP mode only): __________________________________________
Transport protocol for SES (SIP mode only): TLS UDP TCP
one-X Portal Account Settings
URL of one-X Portal server (FQDN): __________________________________
Dialing Rules Settings
Digit(s) you must dial to access an outside line: __________
Country code: ___________________
Area/city code: __________________
PBX Main Prefix: ________
Digit(s) you must dial to make long-distance calls: ___________________
Digit(s) you must dial to make international calls: ____________________
Extension length for internal extensions: ______________________________________
Length of national phone numbers: ________________
Do you have to dial the area/city code when making a local call? Yes No
Public Directory Settings
Directory Type: Active Directory Domino Novell
IP address of the directory server: ___________________________________________
User name (if required): __________________________________
Password (if required): __________________________________
Search root: _______________________________________
Server port: ____________________________

16
one-X Communicator rebranding and customization

Customizing the emergency call-handling disclaimer

one-X Communicator allows you to create a customized emergency call-handling
disclaimer that is specific to your company.

Note: Your customized disclaimer displays directly below the non-customizable Avaya
disclaimer in the Welcome window.

one-X Communicator looks for the custom disclaimer file in the following path:
<one-X Communicator installation path>\custom\disclaimer.txt.

To create a custom disclaimer file, perform the following steps:

1. Go to the installation path.

2. Create a directory and name it ‘Custom.’
3. In the Custom directory, create a disclaimer.txt file.
4. Open the text file and type your custom disclaimer message.
5. Save the file.
6. Log in to one-X Communicator.
In the one-X Communicator Welcome window, the custom disclaimer message is
displayed below the default Avaya disclaimer message.

Customizing the Avaya one-X logo

You can customize the Avaya one-X logo that is displayed in many one-X Communicator
windows. You can replace the Avaya one-X logo by a logo of your choice.

Note: The Avaya one-X logo in the About Avaya one-X Communicator window is not
customizable.

one-X Communicator looks for the custom logo file in the following path:
<one-X Communicator installation path>\custom\logo.png

To customize the Avaya one-X logo, perform the following steps:

1. Go to the installation path.
2. Create a directory and name it ‘Custom.’
3. In the Custom directory, copy the logo.png file.
Note: The size of the logo file should be 121 pixels (width) and 22 pixels (height).
4. Log in to one-X Communicator.
In the one-X Communicator Login and all other windows, the custom logo is
displayed in place of the Avaya one-X logo.

17
Customizing the title on the Login and Welcome windows
You can customize the title that is displayed in one-X Communicator Login and
Welcome windows. You can replace these titles by a title of your choice.

one-X Communicator looks for the custom title.txt files in the following path:
For the Login window title:
<one-X Communicator installation path>\custom\login.txt

For the Welcome window title:

<one-X Communicator installation path>\custom\welcome.txt

To customize the window titles, perform the following steps:

1. Go to the installation path.
2. Create a directory and name it ‘Custom.’
3. In the Custom directory, create login.txt and welcome.txt text files.
4. Open the text files and type your custom title.
5. Save the file.
6. Log in to one-X Communicator.
In the one-X Communicator Login and Welcome windows, the custom title is
displayed in place of the Avaya default title.

18