Avaya Aura Application Enablement Services Integration Guide for IBM Lotus Sametime

Avaya Aura Application Enablement Services Integration Guide for IBM Lotus Sametime 02-602818 Release 5.2 December 2010 Issue 4

2010 Avaya Inc. All Rights Reserved. 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 might be incorporated in future releases. 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 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 Avaya Support Web site: http://www.avaya.com/support Licenses USE OR INSTALLATION OF THE PRODUCT INDICATES THE END USER'S ACCEPTANCE OF THE TERMS SET FORTH HEREIN AND THE GENERAL LICENSE TERMS AVAILABLE ON THE AVAYA WEB SITE http://support.avaya.com/licenseinfo/ ("GENERAL LICENSE TERMS"). IF YOU DO NOT WISH TO BE BOUND BY THESE TERMS, YOU MUST RETURN THE PRODUCT(S) TO THE POINT OF PURCHASE WITHIN TEN (10) DAYS OF DELIVERY FOR A REFUND OR CREDIT. Avaya grants End User a license within the scope of the license types described below. The applicable number of licenses and units of capacity for which the license is granted will be one (1), unless a different number of licenses or units of capacity is specified in the Documentation or other materials available to End User. "Designated Processor" means a single stand-alone computing device. "Server" means a Designated Processor that hosts a software application to be accessed by multiple users. "Software" means the computer programs in object code, originally licensed by Avaya and ultimately utilized by End User, whether as stand-alone Products or pre-installed on Hardware. "Hardware" means the standard hardware Products, originally sold by Avaya and ultimately utilized by End User. License type(s) Designated System(s) License (DS). End User may install and use each copy of the Software on only one Designated Processor, unless a different number of Designated Processors is indicated in the Documentation or other materials available to End User. Avaya may require the Designated Processor(s) to be identified by type, serial number, feature key, location or other specific designation, or to be provided by End User to Avaya through electronic means established by Avaya specifically for this purpose. Concurrent User License (CU). End User may install and use the Software on multiple Designated Processors or one or more Servers, so long as only the licensed number of Units are accessing and using the Software at any given time. A Unit means the unit on which Avaya, at its sole discretion, bases the pricing of its licenses and can be, without limitation, an agent, port or user, an e-mail or voice mail account in the name of a person or corporate function (e.g., webmaster or helpdesk), or a directory entry in the administrative database utilized by the Product that permits one user to interface with the Software. Units may be linked to a specific, identified Server. Database License (DL). Customer may install and use each copy of the Software on one Server or on multiple Servers provided that each of the Servers on which the Software is installed communicate with no more than a single instance of the same database. CPU License (CP). End User may install and use each copy of the Software on a number of Servers up to the number indicated by Avaya provided that the performance capacity of the Server(s) does not exceed the performance capacity specified for the Software. End User may not re-install or operate the Software on Server(s) with a larger performance capacity without Avaya's prior consent and payment of an upgrade fee. Named User License (NU). Customer may: (i) install and use the Software on a single Designated Processor or Server per authorized Named User (defined below); or (ii) install and use the Software on a Server so long as only authorized Named Users access and use the Software. "Named User," means a user or device that has been expressly authorized by Avaya to access and use the Software. At Avaya's sole discretion, a "Named User" may be, without limitation, designated by name, corporate function (e.g., webmaster or helpdesk), an e-mail or voice mail account in the name of a person or corporate function, or a directory entry in the administrative database utilized by the Product that permits one user to interface with the Product. Shrinkwrap License (SR). With respect to Software that contains elements provided by third party suppliers, End User may install and use the Software in accordance with the terms and conditions of the applicable license agreements, such as "shrinkwrap" or "clickwrap" license accompanying or applicable to the Software ("Shrinkwrap License"). The text of the Shrinkwrap License will be available from Avaya upon End User s request (see Third-party Components" for more information). 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. Third-party components Certain software programs or portions thereof included in the Product may contain software distributed under third party agreements ("Third Party Components"), which may contain terms that expand or limit rights to use certain portions of the Product ("Third Party Terms"). Information identifying Third Party Components and the Third Party Terms that apply to them is available on the Avaya Support Web site: http://support.avaya.com/thirdpartylicense/ Preventing toll fraud "Toll fraud" is the unauthorized use of your telecommunications system by an unauthorized party (for example, a person who is not a corporate employee, agent, subcontractor, or is not working on your company's behalf). Be aware that there can be a risk of toll fraud associated with your system and that, if toll fraud occurs, it can result in substantial additional charges for your telecommunications services. Avaya fraud intervention If you suspect that you are being victimized by toll fraud and you need technical assistance or support, call Technical Service Center Toll Fraud Intervention Hotline at +1-800-643-2353 for the United States and Canada. For additional support telephone numbers, see the Avaya Support Web site: http://www.avaya.com/support Trademarks Avaya and Avaya Aura are registered trademarks of Avaya Inc. All non-avaya trademarks are the property of their respective owners. Downloading documents For the most current versions of documentation, see the Avaya Support Web site: http://www.avaya.com/support Contact 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 1-800-242-2121 in the United States. For additional support telephone numbers, see the Avaya Support Web site: http://www.avaya.com/support

Contents About this document................................... 7 About the AE Services Integration for IBM Lotus Sametime............ 7 Intended audience................................... 7 Related documents.................................. 8 Avaya Application Enablement Services documents............ 8 IBM Lotus Sametime documents....................... 8 Conventions...................................... 9 Contacting Avaya................................... 9 Chapter 1: System Overview............................... 11 Overview of the AE Services Integration for IBM Lotus Sametime......... 11 Features of the AE Services Integration for IBM Lotus Sametime....... 13 A brief summary of IBM Lotus Sametime.................... 15 Architectural Summary................................ 16 Making a simple phone call............................ 18 Setting up the dial plan -- converting E.164 numbers to dial strings..... 19 Known Issues..................................... 20 Performance and Capacities............................. 21 Sametime Community Server with Co-Resident Multiplexer.......... 21 Clustered Sametime Community Server with Standalone Multiplexer..... 21 Clustered Sametime Media Manager....................... 22 Chapter 2: AES and Sametime Clustering Guidelines................. 23 Considerations When Clustering........................... 23 AES Telephony Presence Configuration....................... 24 AES TCSPI (Conference Service) Configuration.................. 25 AES Server Discovery................................. 28 Chapter 3: Planning your installation.......................... 29 Preparing for the AE Services Integration for IBM Lotus Sametime........ 29 Configuring Sametime directories and setting up the LDAP properties in the Avaya configuration properties file.......... 31 Sametime configurations with the Domino directory............ 31 Sametime configurations with an LDAP directory.............. 33 DN entries and scope of search......................... 34 Avoid making the Base Search DN too specific............... 34 Community Server LDAP Discovery......................... 35 Software Requirements................................ 36 Software platform............................... 36 Sametime Server Operating Systems supported by AE Services..... 36 AE Services Integration Guide for IBM Lotus Sametime December 2010 3

Contents Requirements for SDK downloads...................... 37 Hardware Requirements................................ 38 IBM Lotus Sametime servers........................... 38 AE Services requirements............................ 39 Communication Manager and media servers.................. 39 Licensing...................................... 40 Phone number requirements........................... 40 Additional Requirements - SDK downloads................... 40 Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime............................ 41 About Installing and Configuring the AE Services Integration for IBM Lotus Sametime................................. 41 Testing Sametime................................... 43 AE Services Integration for IBM Sametime - checklist............... 44 Setting up the IBM Sametime Connect clients.................... 47 Make sure you have an IBM account....................... 47 Install the Sametime Connect client plug-in................... 47 Enabling Sametime 8.5.1 Unified Telephony, extended status, and telephony status in the client........................ 47 Install the Sametime Connect plug-in using the AES Sametime plug-in package................................ 49 Download and install the IBM Sametime Connect plug-in......... 49 Setting up the Java Environment........................... 50 Setting up the Avaya Conference and Presence Services on the Sametime Server 52 Choosing the Correct IBM Sametime Server for Installation............ 52 Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server................................... 53 Upgrading the AE Services Integration for IBM Lotus Sametime on the Sametime Server................................... 62 Setting up the IBM Lotus Sametime Server..................... 64 Configuring Telephony on Sametime 8.5.1 System Console.......... 64 Configuring Presence on the Sametime 8.5.1 Media Manager......... 65 Increasing memory available to the JVM for IBM Lotus Sametime...... 65 Increasing memory available to the JVM for IBM Sametime 8.5.1 Media Manager.................................. 66 Setting up a keystore and importing a trusted certificate........... 67 Importing a trusted certificate into the Java keystore............ 67 Administering certificates on the AE Server or the LDAPS server..... 68 Interactive configuration utility............................ 68 AE Services information for the interactive configuration utility........ 69 4 AE Services Integration Guide for IBM Lotus Sametime December 2010

Contents LDAP server information for the interactive configuration utility....... 69 LDAP schema information for the interactive configuration utility...... 69 How the interactive configuration utility works................. 70 Editing the AE Services property files on the Sametime Server.......... 71 Tips for editing the property files......................... 71 About the ConferenceManager.properties file.................. 72 Configuration.................................. 72 Manually Editing the avaya-aes-sametime.properties file........... 72 Administering the AE Services Security Database in the AE Services Management Console.............................. 84 Sametime Application Account.......................... 85 Setting up the dial plan.............................. 85 Configuring the Sametime client........................... 86 Testing the Configuration............................... 86 Serviceability Considerations............................. 88 Authentication of moderator and participants phone numbers.......... 88 "How it works"-- using the Lotus Sametime Connect client............ 89 About conferencing and Sametime client configuration.......... 90 User name and call window states...................... 91 Uninstalling the AES Service Integration for IBM Lotus Sametime........ 92 Chapter 5: Administering Dial Plan Settings...................... 93 Administering Dial Plan Settings in the AE Services Management Console... 93 Before you begin.................................. 93 About Tel URI formats and device IDs...................... 94 About the From TelURI rules........................... 94 From TelURI operations............................ 94 Valid dial string characters and using the asterisk............. 95 The From Tel URI table............................ 96 From TelURI settings for fixed-length extensions.............. 97 From TelURI settings for variable-length extensions............ 99 Pattern matching -- using Pattern and RegEx (regular expressions)... 101 Methods for administering dial plan settings.................... 103 Administering dial plan settings on a per-switch basis........... 104 Administering default dial plan settings................... 105 Chapter 6: Troubleshooting................................ 107 Sametime........................................ 107 Client........................................ 107 Logging..................................... 107 AE Services Integration Guide for IBM Lotus Sametime December 2010 5

Contents Server.......................................... 108 Configuration Issues............................... 108 Presence Service................................. 108 Logging....................................... 108 Sametime 8.5.1 Media Manager Conference Service Logging....... 109 Sametime Community Server Conference Service Logging........ 109 Presence Service............................... 111 Exceptions................................... 111 LDAP or AE Services............................. 112 LDAP...................................... 112 AE Services.................................. 114 Conference Service.............................. 115 Presence Service............................... 116 AE Services...................................... 119 Logging......................................... 119 Logging Levels..................................... 120 Appendix A: Downloading the software......................... 123 Downloading software from PLDS.......................... 124 Downloading clients and SDKs from Avaya Support................ 126 Downloading clients and SDKs from Avaya DevConnect.............. 127 Appendix B: Customizing the Sametime Environment................. 129 About this appendix.................................. 129 Enabling Telephony Conferencing.......................... 129 Determining if the Sametime Server can find the JRE............... 130 Testing Sametime................................... 130 Appendix C: LDAP tester - sample output........................ 131 Index........................................ 133 6 AE Services Integration Guide for IBM Lotus Sametime December 2010

About this document About the AE Services Integration for IBM Lotus Sametime About the AE Services Integration for IBM Lotus Sametime The AE Services Integration for IBM Lotus Sametime is an application that provides click-to-call, click-to-conference, and telephony presence. It enables users to operate more efficiently by launching phone calls from the Sametime Connect client. As a result, people, teams, and organizations are able to communicate simply and effectively while working with Avaya and IBM Lotus Sametime applications. The AE Services Integration for IBM Lotus Sametime is for customers who want a click-to-call solution that takes advantage of their existing Communication Manager. Intended audience This guide is written for technical support representatives and IT administrators who install and configure the AE Services Integration for IBM Sametime. AE Services Integration for IBM Lotus Sametime December 2010 7

About this document Related documents This document assumes that you already have an IBM Sametime configuration and an AE Services configuration in place. This topic, Related documents, lists the primary references that are used for setting up both configurations. Avaya Application Enablement Services documents For information about setting up AE Services, Release 5.2, see the following documents. Implementing Avaya Aura Application Enablement Services for Avaya Aura System Platform, 02-603468 Implementing Avaya Aura Application Enablement Services for a Bundled Server Upgrade, 02-300356 Implementing Avaya Aura Application Enablement Services in a Software-Only Environment, 02-300355 Avaya Aura Application Enablement Services Administration and Maintenance Guide, 02-300357 Avaya Aura Application Enablement Services Management Console online help (which is included with the AE Services server software) Administering Meeting Exchange Applications, 04-603544 AE Services documents are available from the Web in Portable Document Format (.pdf) at the Avaya Support Web Site (http://www.avaya.com/support). IBM Lotus Sametime documents AE Services supports Lotus Sametime 8.5.1 configurations. For information about IBM Sametime, see the following documents. IBM Lotus Sametime 8.5.1 documents: For information about setting up IBM Lotus Sametime 8.5.1, see the following documents. IBM Lotus Sametime 8.5.1 Release Notes IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 1 IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 2 IBM Lotus Sametime Connect Client Help IBM Lotus Sametime 8.5.1 documents are available at: http://www.ibm.com/developerworks/lotus/documentation/sametime/index.html 8 AE Services Integration for IBM Lotus Sametime December 2010

Conventions Conventions The following table lists the documentation conventions that this document uses. Convention Example Usage bold monospace add station Indicates a command line interface. Bold monospace indicates that you input (type) characters exactly as depicted. italic monospace in angle brackets <modname> Indicates a command line interface. Italic monospace indicates that you input (type) an appropriate substitution for the term in italics. Angle brackets are used as visual cues, do not type them. plain monospace Port: Indicates command line interface. Plain monospace indicates standard output from the terminal display or command prompt. bold Start Indicates a Graphical User Interface (GUI). Bold can indicate the following: Mouse and keyboard selections Web page displays Text you would type in a text box or a selection you would make from a drop-down list. bold italic service name Indicates a GUI. Bold italic indicates that you input (type) an appropriate substitution for the term in italics. Contacting Avaya For information about contacting Avaya, see the Avaya Aura Application Enablement Services Overview, 02-300360. AE Services Integration for IBM Lotus Sametime December 2010 9

About this document 10 AE Services Integration for IBM Lotus Sametime December 2010

Overview of the AE Services Integration for IBM Lotus Sametime Chapter 1: System Overview The AE Services Integration for IBM Lotus Sametime is for customers who want a click-to-call solution that takes advantage of their existing Communication Manager calling capabilities. The AE Services Integration for IBM Sametime is an application that provides click-to-call, click-to-conference, and telephony presence. Overview of the AE Services Integration for IBM Lotus Sametime The AE Services Integration for IBM Lotus Sametime integrates IBM Sametime with AE Services. Table 1: IBM Sametime tasks summarizes the tasks for IBM Lotus Sametime. Table 2: AE Services tasks on page 12 summarizes the tasks for AE Services. For complete descriptions of the of tasks see, Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime on page 41. Table 1: IBM Sametime tasks Install and configure the Domino Server. Install and configure Lotus Notes (Admin). Install and administer the Sametime Server. Install and administer Media Manager (optional). Test Sametime. Install the Sametime SDK. Install AE Services Integration for IBM Sametime. AE Services Integration Guide for IBM Lotus Sametime December 2010 11

Chapter 1: System Overview Table 2: AE Services tasks Install AE Services 5.2 or upgrade to AE Services 5.2 (on the AE Server). Install the AE Services 5.2 License file (on the AE Server). Administer a CTI Link (Type ADJ-IP) on Avaya Communication Manager. Administer AE Services as follows: Administer a Switch Connection. Administer a TSAPI Link. Administer a Sametime user account in User Service. Enable the Unrestricted Telephony Access setting for the Sametime user. Configure the Dial Plan. When the integration is complete, AE Services will be transparent to IBM Sametime, and IBM Sametime will be transparent to AE Services. As a result of the integration, IBM Sametime Connect clients will be able to use click to call, click to conference, and other telephony-related features. 12 AE Services Integration Guide for IBM Lotus Sametime December 2010

Overview of the AE Services Integration for IBM Lotus Sametime Features of the AE Services Integration for IBM Lotus Sametime The AE Services Integration for IBM Lotus Sametime includes two client-side services that provide click-to-dial and presence capabilities. The Avaya Conference Service provides the following click-to-dial capabilities: - Click to Call - Click to Conference - End Call - Add a Party - Remove Party The Avaya Presence Service provides telephony presence. Figure 1: AE Services - as seen from Sametime connect Avaya brings enterprise telephony to Sametime Connect! Avaya Provides the telephony connection! You can use click-to-call in Sametime Connect " You can escalate an instant message to a call " Presence is shared " Live Names "Dial an outside line! The solution is endpoint-neutral AE Services Integration Guide for IBM Lotus Sametime December 2010 13

Chapter 1: System Overview Figure 2: System-level view of the AE Services Integration for IBM Lotus Sametime IBM Lotus Sametime Server AE Services 5.2 Endpoints SIP H.323 Avaya CTI TDM/Analog VPN Remote Avaya Communication Manager Sametime Virtual Places (VP) Protocol one-x Portal Cell Phone: extension to cellular /one-x Mobile IP Softphone Computer running IBM Sametime Connect or Lotus Notes 14 AE Services Integration Guide for IBM Lotus Sametime December 2010

Overview of the AE Services Integration for IBM Lotus Sametime A brief summary of IBM Lotus Sametime If the IBM Lotus Sametime environment is new to you, use this section to familiarize yourself with a few terms and concepts. IBM Sametime Connect clients IBM Sametime Connect client provides users with access to the features and capabilities of the IBM Sametime environment. AE Services supports the current Sametime connect client platforms: Windows, and Linux. IBM Lotus Domino (also referred to as the Domino server) Domino provides integrated messaging - the ability to handle voicemail and email in a single "mailbox" that you can access by an email client or by phone. Additionally, it provides LDAP services and Web services. You must install and configure the Domino server before you install the Sametime server. IBM Lotus Notes (also referred to as Notes) Lotus Notes provides email as well as an online calendar and scheduling tool. The Lotus Notes client also provides you with the means for setting up "Domino Administrator" capabilities. The Domino Administrator capabilities enable you to set up the Domino Server. IBM Lotus Sametime (also referred to as the Sametime Community server) IBM Lotus Sametime provides instant, real-time communication and presence awareness. In the Sametime environment, a user s status or presence is known to other Sametime users -- that is, they are available, away, in a meeting, and so on. When integrated with AE Services, Sametime provides telephony presence (On a Call, Not on a Call, and so forth). IBM Lotus Sametime Media Manager The IBM Lotus Sametime Media Manager runs on the WebSphere Application Server to provide audio visual services for chats and meetings. It requires a Lotus Sametime Community server. The Lotus Sametime Media Manager uses the Session Initiation Protocol (SIP) to provide support for point-to-point and multipoint calls. It is designed to support standard audio and video codecs so that it works with other external audio and video vendors. AE Services Integration Guide for IBM Lotus Sametime December 2010 15

Chapter 1: System Overview Architectural Summary The AE Services Integration for IBM Lotus Sametime is a teleconferencing service provider interface based on the IBM Lotus Sametime Telephony Conferencing Service Provider Interface (TCSPI) application programming interface. In terms of AE Services, this TCSPI component (or plug-in) is a DMCC Java client application (as illustrated in Figure 3). The TCSPI plug-in is the integration point for AE Services and IBM Lotus Sametime -- it manages click-to-call and conferencing. Version 1.2 of the AE Services Integration for IBM Lotus Sametme provides an AE Services plug-in for: IBM Sametime 8.5.1 Community Server IBM Sametime 8.5.1 Media Manager Setting up the AE Services Integration for IBM Lotus Sametime is primarily a matter of installing or upgrading the plug-in and configuring the plug-in. The procedures for installing and upgrading the plug-in are described in the following sections of this document: Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server on page 53 Upgrading the AE Services Integration for IBM Lotus Sametime on the Sametime Server on page 62 Configuring the Sametime client on page 86 Bear in mind that the purpose of this summary is only to help you understand key concepts of the integration, it is not a task summary. You will need to complete all of the procedures described in Installing and Configuring the AE Services Integration for IBM Lotus Sametime on page 41. 16 AE Services Integration Guide for IBM Lotus Sametime December 2010

Architectural Summary Figure 3: AE Services Integration with IBM Lotus Sametime architecture PCs are running IBM Sametime Connect, Lotus Notes, or Microsoft Office IBM Lotus Sametime Server Avaya Conference Service Avaya Presence Service TCSPI plug-in AE Services DMCC Java SDK/Client AE Services DMCC Java SDK/Client Avaya AE Services Call Control Service TSAPI Service CTI Link IP Avaya Communication Manager 4.x or 5.0 AE Services Integration Guide for IBM Lotus Sametime December 2010 17

Chapter 1: System Overview Making a simple phone call Recall from the architectural diagram (Figure 3) that the AE Services TCSPI plug-in on the IBM Sametime Server, along with the AE Server and Communication Manager make it possible for you to manage and control calls. Figure 4 illustrates a simple call path (using MakeCall) from an IBM Lotus Sametime Connect client to an H.323 endpoint. While Connect is shown in this diagram as controlling an H.323 telephone, it is also capable of controlling a SIP phone, a digital phone, an analog phone, or an IP Softphone. Figure 4: Making a simple phone call IBM Sametime Server Communication Manager +13035551235 AE Services 5.2 AE Services converts the dialed number CTI link 51235 Connect 51234 to 51235 51235 51236 51237 Connect client calls +13035551235 IP Softphone TDM/Analog SIP Cell (EC500) 51234 Connect registers with +13035551234 on login H.323 18 AE Services Integration Guide for IBM Lotus Sametime December 2010

Architectural Summary Setting up the dial plan -- converting E.164 numbers to dial strings Phone numbers that you store in your directory (Domino, LDAP, or Active Directory) must be in E.164 format. The Dial Plan Settings Web page in the AE Services Management Console displays is used for converting E.164 numbers to dial strings. For more information, see Chapter 5: Administering Dial Plan Settings on page 93. Figure 5: AE Services Integration for IBM Lotus Sametime - dial plan IBM Sametime Server E.164 number +13035551234 AE Services Server 5.2 5551234 From TelURI Communication Manager 4.x or 5.x Administer Dial Plan settings (From TelURI) in AE Services Management Console E.164 number +13035381234 IBM Sametime Connect client Enter conversion rules into the From TelURI table so AE Services can convert E.164 numbers into dial strings. AE Services Integration Guide for IBM Lotus Sametime December 2010 19

Chapter 1: System Overview Known Issues This topic describes the currently-known issues for the AE Services Integration for IBM Lotus Sametime. When using the Extend to Cellular feature of Avaya Communication Manager, if a called party answers on their mobile device, the fact that the user is on a call is not reflected in their Sametime telephony presence. This is a consequence of the fact that the Presence Service monitors the Avaya device for presence events, but picking up on a mobile device causes the event to occur elsewhere. By design, the AE Services Integration for IBM Lotus Sametime does not support Sametime Web Conferencing. Any attempt to schedule a Sametime Web Conference using the AE Services/Sametime Conference Service will not succeed. The "Alert Me When" feature of Sametime Connect does not work with telephony presence. Starting or restarting the Presence Service during business hours results in the Presence Service competing with the Conference Service for resources on the AE Services server. It is advised that the administrator start or restart the Presence Service after business hours only, in order to provide the best response time to the users of the Conference Service (i.e., Sametime Connect users making phone calls). When making a trunk call, the amount of signaling information available about the state of the call (such as ringing and answered) can be limited. Depending on the type of the trunk, this can result in incorrect state appearing in a Sametime Connect call window. This will happen if the trunk is an analog trunk. For example, a user can appear in the Connecting state even after they answered the call. Another manifestation of this phenomenon occurs when a user selects multiple parties in their Sametime Connect contacts list and calls them simultaneously; if the first called party is a trunk call, subsequent participants may not be conferenced in. The TSAPI switch links used by the AE Services IBM Sametime Integration must have lowercase names. That is, when you administer a switch connection in AE Services (Administration > Switch Connections), the connection name must use lowercase characters. If the TSAPI link goes down or Communication Manager is rebooted, the device monitors created by the Presence Service and Conference Service are lost and not re-added. Restarting either AE Services or both the Presence Service and Conference Service will fix the problem. When you are running the configurator.bat file and configuring more than one AES server, the configurator.bat file will generate exception messages. This is not service affecting. Continue the configuration and save the changes. 20 AE Services Integration Guide for IBM Lotus Sametime December 2010

Performance and Capacities Performance and Capacities Sametime Community Server with Co-Resident Multiplexer Number of Concurrent Sametime Users -The AE Services Integration for IBM Lotus Sametime supports 10,000 concurrent Sametime users when the multiplexer is co-resident with the Community server. Maximum BHCC - The maximum Busy Hour Call Completion (BHCC) rate that the AE Services Integration for IBM Lotus Sametime integration supports is 12,000 calls per hour. These rates are based on counting a Make Call request and an Answer Call request as separate calls on the AE Server. One IBM Sametime Connect client user calling another IBM Sametime Connect client user would therefore count as two calls in the BHCC measurements. Also review Increasing memory available to the JVM for IBM Lotus Sametime on page 65. Clustered Sametime Community Server with Standalone Multiplexer These rates are per Community server (physical machine). Number of Concurrent Sametime Users -The AE Services Integration for IBM Lotus Sametime supports a total off 20,000 concurrent Sametime users when the multiplexer is installed on a separate machine. Each AE Server can handle a total of 10,000 concurrent users so more than one AE Server is required to reach the maximum capacity. Maximum BHCC - The maximum BHCC rate that the AE Services Integration for IBM Lotus Sametime integration supports is 24,000 calls per hour. These rates are based on counting a Make Call request and an Answer Call request as separate calls on the AE Server. One IBM Sametime Connect client user calling another IBM Sametime Connect client user would therefore count as two calls in the BHCC measurements. Also review Increasing memory available to the JVM for IBM Lotus Sametime on page 65. AE Services Integration Guide for IBM Lotus Sametime December 2010 21

Chapter 1: System Overview Clustered Sametime Media Manager These rates are per Conference Manager (physical machine). Number of Concurrent Sametime Users - The AE Services Integration for IBM Lotus Sametime supports a total of 20,000 concurrent Sametime users per physical Conference Manager. Each AE Server can handle a total of 10,000 concurrent users so more than one AE Server is required to reach the maximum capacity. This total capacity also assumes your Community servers are configured to handle this many concurrent users. Maximum BHCC - The maximum BHCC rate that the AE Services Integration for IBM Lotus Sametime integration supports is 24,000 calls per hour. These rates are based on counting a Make Call request and an Answer Call request as separate calls on the AE Server. One IBM Sametime Connect client user calling another IBM Sametime Connect client user would therefore count as two calls in the BHCC measurements. Also review Increasing memory available to the JVM for IBM Sametime 8.5.1 Media Manager on page 66. 22 AE Services Integration Guide for IBM Lotus Sametime December 2010

Considerations When Clustering Chapter 2: AES and Sametime Clustering Guidelines The guidelines here are meant to assist with the planning of an AES click-to-call and Telephony Presence installation in a cluster of AES and Sametime servers. There are many different ways to cluster Sametime and AES servers together however this section will only focus on two of those configurations. Although the focus is only on two clustering scenarios, the guidelines and considerations here should be applied to any clustered environment. First, there are two aspects of an enterprise Sametime server configuration that distinguish it from a smaller scale, standalone Sametime server configuration: Sametime clusters and the standalone Sametime multiplexer. In a standalone Sametime server configuration, the Sametime multiplexer (or mux) is actually installed on the same machine as the Sametime server. In an enterprise configuration, the mux is installed on a separate machine. Whether it is installed on the same machine or standalone, the mux manages the potentially very large number of sockets to the Sametime clients, tunneling their traffic to the Sametime server over a significantly smaller number of sockets. Putting the mux on a separate machine off loads the overhead of managing those sockets, thereby increasing the number of connections that a single Sametime server can handle. In addition to the Standalone mux, Sametime clusters can be viewed as a farm of horizontal or vertical servers configured to load balance and provide redundancy. The majority of the servers in the Sametime family can be clustered in various ways and can result in multiple instances of the Community Server or Media Manager components. This requires additional configuration which is described in this section so please review the following notes before installing and configuring your clustered environment. Considerations When Clustering When clustering IBM Sametime and AE Servers there are three main considerations: 1. AES Telephony Presence Configuration 2. AES TCSPI (Conference Service) Configuration 3. AES Server Discovery AE Services Integration Guide for IBM Lotus Sametime December 2010 23

Chapter 2: AES and Sametime Clustering Guidelines AES Telephony Presence Configuration There are a few ways to configure the Presence Service in a Sametime cluster: 1. 1 instance of the Presence Service handling all n users in the community. 2. m instances of the Presence Service, each handling all n users in the community. 3. m instances of the Presence Service, each handling n/m users from the community. Each option has different performance and availability characteristics so please plan according to your system requirements and needs. Option 1 doesn t create any duplicate telephony presence-related traffic in the cluster, but the instance of the Presence Service is a single point of failure. Option 2 generates m times as much telephony presence-related traffic than option 1, but it has the virtue that presence will continue to be provided as long as one of the m instances is still running. Option 3 doesn t create any duplicate telephony presence traffic, but telephony presence for 1/m of the users will cease to function when one of the instances becomes unavailable. Options 1 and 3 result in n monitors being added via the AE Server. Option 2 is much worse on that account: it adds n*m monitors. Keep in mind that each instance of the Presence service must be running on a separate machine to achieve m instances. For a Community Server cluster this can easily be achieved since IBM only supports horizontal clustering in that type of environment. The Media Manager can be vertically clustered so if this is your deployment scenario beware that you will only be able to install 1 instance of the Presence Service since there is only one physical machine. Note: Note: At this time the Telephony Presence Service can not be installed as a standalone service. It must be installed on the same machine as the AES TCSPI. 24 AE Services Integration Guide for IBM Lotus Sametime December 2010

AES TCSPI (Conference Service) Configuration AES TCSPI (Conference Service) Configuration Clustering IBM Sametime servers adds some additional requirements to the AES TCSPI Conference Service configuration due to the interaction between the IBM Sametime servers. There are two installation types for the AES TCSPI either (1) the Media Manager or (2) the Community Server. Although there are only two deployment types there are many different ways to cluster these servers and it is outside the scope of this document to specify how every deployment should be configured. Figure 6 and Figure 7 represent the two configurations tested by Avaya for an IBM Sametime Media Manager cluster and an IBM Sametime Community Server cluster. These are presented to give a more thorough understanding of how the AES TCSPI and Presence Components interact in a cluster and these same techniques can be applied to your specific configuration. The key to configuring the AES TCSPI Conference Service in a cluster is that the Conference Service must be available on the Sametime server where the connect client lands during login. In a cluster like that depicted in Figure 6, a connect client has the potential to land on Community Server 1 or Community Server 2 during the login process. This means that the AES TCSPI must be installed on Community Server 1 and Community Server 2. In addition, both of these TCSPIs must have a valid AES connection where the user s extension resides. Depending on how your Community Server cluster is configured you may have a HomeServer attribute to force a user to login to a specific Community Server. In this case you may not require a valid connection to all AES servers for the community. However, in general when you deploy a cluster document in a Sametime Community you will no longer use the HomeServer attribute. With the release of IBM Sametime 8.5.1, a new component called the IBM Sametime Media Manager was introduced and changes how the cluster is configured. Figure 7 depicts a clustered environment which includes a vertically clustered Media Manager. It is important to note that the Media Manager still requires a Community Server to operate but once the Media Manager is installed the AES TCSPI must be installed in the Conference Manager component of the Media Manager and not the Community Server. As shown in Figure 7, there are actually two Conference Manager instances running in the cluster and you can see that each Community Server will maintain a single connection with the Media Manager. In this instance the AES TCSPI must be installed on both instances of the Conference Manager since a Sametime Connect user could potentially be routed to either Conference Manager. This is true regardless of a Vertical or Horizontal Media Manager cluster, and again both of the TCSPIs must have a valid AES connection where the user s extension resides. In a cluster where more than one AES connection is required per Sametime Server (as depicted in Figure 6 and Figure 7), you will need to add an additional LDAP attribute. This LDAP attribute is used by the AES TCSPI to properly route the dial request. For more information on this see AES Server Discovery on page 28. Figure 6 shows an IBM Sametime Community server horizontal cluster that consists of two Community servers, two AES servers, and two Avaya Communication Managers tied by an ISDN trunk. AE Services Integration Guide for IBM Lotus Sametime December 2010 25

Chapter 2: AES and Sametime Clustering Guidelines Figure 6: IBM Sametime Community Server Horizontal Cluster IBM WebSphere EdgeServer IBM Sametime Mux 1 IBM Sametime Mux 2 To CS1 and CS2 LDAP Directory Server IBM Sametime System Console IBM Sametime Community Server 1 IBM Sametime Community Server 2 Avaya Aura AES 1 Avaya Aura AES 2 26 AE Services Integration Guide for IBM Lotus Sametime December 2010

AES TCSPI (Conference Service) Configuration Figure 7 shows an IBM Sametime Media Manager vertical cluster that consists of two Conference Managers (single machine), two Community servers, two AES servers, and two Avaya Communication Managers tied by an ISDN trunk. Figure 7: IBM Sametime Media Manager Vertical Cluster IBM WebSphere EdgeServer IBM Sametime Mux 1 IBM Sametime Mux 2 To CS1 and CS2 IBM Sametime Community Server 1 SIP Proxy/Registrar IBM Sametime Media Manager Vertical Cluster IBM Sametime Community Server 2 Conference Manager 1 IBM Sametime System Console TCSPI and Presence Conference Manager 2 LDAP Directory Server Avaya Aura AES 1 Avaya Aura AES 2 Avaya Aura Communication Manager 1 Avaya Aura Communication Manager 2 AE Services Integration Guide for IBM Lotus Sametime December 2010 27

Chapter 2: AES and Sametime Clustering Guidelines AES Server Discovery In a Sametime cluster with more than one AES server, there is an additional requirement that the LDAP store must contain an attribute AvayaAESServer. The value is required for the Conference Service and Presence Service to properly discovery which AES server to use for a particular users extension. The value of the attribute must be the name or IP address of the AES server with a connection to the Communication Manager on which the user s extension is administered. Note: Note: The value of the AvayaAESserver attribute for a user must be the same as the value of one of the numbered avaya.aes.sametime.cmapi.server_ip property for that AES server. If the LDAP attribute specifies an IP address, then the corresponding (numbered) avaya.aes.sametime.cmapi.server_ip property shall specify the same IP address. If the LDAP attribute specifies a host name, then the corresponding (numbered) avaya.aes.sametime.cmapi.server_ip property shall be a host name. The attribute AvayaAESServer is not necessary in a Sametime environment which has only one AES server. There are many tools available to add and modify LDAP to populate this attribute. One example is the ldapmodify tool: ldapmodify -h ldap.example.com -p 389 -D "cn=ldap admin,o=acme" - w "password" -x -f test.ldif where test.ldif is: dn: cn=sametime User1,o=acme changetype: modify add: avayaaesserver avayaaesserver: aes-server1.example.com dn: cn=sametime User2,o=acme changetype: modify add: avayaaesserver avayaaesserver: aes-server2.example.com However when modifying LDAP, you should ultimately consult the documentation provided by your specific server (for example, Domino, Active Directory, OpenLDAP). If the integration is configured with multiple AES servers, and if the AES server for a given user is not found in the list of configured AES server connections, the following message will be logged: No Avaya AES server found for [username]. The value of the user s AvayaAESServer attribute is [value from directory] and the list of AES servers is [list of AES servers]. 28 AE Services Integration Guide for IBM Lotus Sametime December 2010

Preparing for the AE Services Integration for IBM Lotus Sametime Chapter 3: Planning your installation Read through this chapter to make sure you are prepared to install the AE Services Integration for IBM Lotus Sametime. Preparing for the AE Services Integration for IBM Lotus Sametime Before you install Domino and Sametime on a server, make sure you have the following: A server for the Domino, Sametime, and the AE Services integration software. You will be performing the installation on this server, which is referred to as the IBM Lotus Sametime Server. - The IP address of the IBM Lotus Sametime Server - The fully qualified domain name of the IBM Lotus Sametime Server (for example, hostname.example.com) - The Domino installation file, which you downloaded from the IBM download site to your server - The AE Services Integration for IBM Lotus Sametime software, which is delivered in the file Avaya-AES-Sametime-Installer.exe. For information about downloading the AE Services Integration for IBM Lotus Sametime software, see Appendix A: Downloading the software. LDAP information, for example: - the URL of the LDAP server, the user account and password for the LDAP server - the distinguished name to use for directory searches For more information about configuring LDAP settings, see the following sections: LDAP Properties - Connectivity on page 75 LDAP Properties - Queries on page 76 LDAP Properties - Updating E.164 phone numbers in your directory on page 78 AE Services Integration Guide for IBM Lotus Sametime December 2010 29

Chapter 3: Planning your installation Note: Note: Note: When you are setting LDAP properties in the avaya-aes-sametime.properties file, be sure to use the ldap-tester file to verify your configuration settings. For Community server, the ldap-tester file is found in.\telephony_ext\aes\bin\ ldap-tester.bat. For Media Manager, the ldap-tester file is found in.\ sametime_tcspi\aes\bin\ldap-tester.bat. AE Services information: - the user name and password for the account that logs into the AE Server - the DNS name or IP address of the AE Server For more information, see AE Services properties on page 73. Note: When you are setting AE Services properties in the avaya-aes-sametime.properties file, be sure to use the aes-tester file to verify your configuration settings. The command should be run from within cmd.exe. For Community server, the aes-tester file is found in.\telephony_ext\ AES\bin\aes-tester.bat. For Media Manager, the aes-tester file is found in.\ sametime_tcspi\aes\bin\aes-tester.bat. 30 AE Services Integration Guide for IBM Lotus Sametime December 2010

Preparing for the AE Services Integration for IBM Lotus Sametime Configuring Sametime directories and setting up the LDAP properties in the Avaya configuration properties file Sametime relies on directory services to determine user presence and awareness. Sametime supports the following directory configurations: Domino, also referred to as an internal Domino directory. For more information, see Sametime configurations with the Domino directory. LDAP, also referred to as an external LDAP directory (see Figure 8). For more information, see Sametime configurations with an LDAP directory on page 33 Figure 8: Sametime directory configuration options Sametime configurations with the Domino directory If your configuration uses a Domino directory, you must specify a value for the following LDAP connectivity properties in the Avaya configuration properties file (avaya-aes-sametime.properties). avaya.aes.sametime.ldap.url avaya.aes.sametime.ldap.admin_dn avaya.aes.sametime.ldap.admin_password avaya.aes.sametime.ldap.base_search_dn AE Services Integration Guide for IBM Lotus Sametime December 2010 31

Chapter 3: Planning your installation For the following LDAP query attributes in the avaya-aes-sametime.properties file, you can use the default values listed in Table 3. Table 3: Default LDAP settings in the avaya-aes-sametime.properties file Property avaya.aes.sametime.ldap.telephone_number_attr avaya.aes.sametime.ldap.conference.user_attr avaya.aes.sametime.ldap.presence.user_attr Default telephonenumber dn uid or displayname (Use uid or displayname; the value must be unique) If you plan to use secure LDAP (LDAPS), you will need to set the properties for the trust store location and password: avaya.aes.sametime.trust_store_location avaya.aes.sametime.trust_store_password See Setting up a keystore and importing a trusted certificate on page 67 for more information on administering an LDAPS connection or using your own AE Services certificate. For more information about completing the avaya-aes-sametime.properties file, and to see the contents of the avaya-aes-sametime.properties file, refer to Manually Editing the avaya-aes-sametime.properties file on page 72. 32 AE Services Integration Guide for IBM Lotus Sametime December 2010

Preparing for the AE Services Integration for IBM Lotus Sametime Sametime configurations with an LDAP directory If your configuration uses an LDAP directory (also referred to as an external LDAP directory), which is the choice depicted in Figure 8: Sametime directory configuration options on page 31, the LDAP connectivity properties (ldap.url, ldap.admin_dn, ldap.admin_password, and ldap.base_search_dn) in the avaya-aes-sametime.properties file are not applicable. Instead, you must set up the LDAP connectivity and base search information in the Sametime browser administration screens (http://<sametime_server>). Use the Connectivity screen (LDAP Directory > Connectivity) to set up the connectivity information. Use the Basics screen (LDAP Directory > Basics) to set up the base search information, which is labeled as "Where to start searching for people (Base object for person entries)." Sametime configurations with an LDAP directory use the LDAP query attributes in the avaya-aes-sametime.properties file. For the following LDAP query attributes, you can use the default values listed in Table 4. Table 4: Default LDAP settings in the avaya-aes-sametime.properties file Property avaya.aes.sametime.ldap.telephone_number_attr avaya.aes.sametime.ldap.conference.user_attr avaya.aes.sametime.ldap.presence.user_attr Default telephonenumber dn dn avaya.aes.sametime.ldap.page_size 500 If you plan to use secure LDAP (LDAPS), you will need to set the properties for the trust store location and password: avaya.aes.sametime.trust_store_location avaya.aes.sametime.trust_store_password For more information about completing the avaya-aes-sametime.properties file, and to see the contents of the avaya-aes-sametime.properties file, refer to Manually Editing the avaya-aes-sametime.properties file on page 72. AE Services Integration Guide for IBM Lotus Sametime December 2010 33

Chapter 3: Planning your installation DN entries and scope of search The base search DN that you specify in the avaya-aes-sametime.properties file or the Sametime browser administration screens is, in effect, a search path in an LDAP structure. Consider the DN examples used in Figure 9: DN entries and scope of search on page 34: user DN cn=pat Brown,cn=sertech,cn=services,cn=users,dc=example,dc=com base search DN cn=users,dc=example,dc=com Both DNs are unique, but the user DN is more specific than the base search DN. Avoid making the Base Search DN too specific If you were to specify a base search DN of cn=development,cn=users,dc=example,dc=com the users in services and sales would not be able to establish a session. Instead, you should specify a base search DN that is less specific, such as cn=users,dc=example,dc=com. Figure 9: DN entries and scope of search com (dc=com) example (dc=example) base search DN (includes everything below) users (cn=users) sales (cn=sales) saltech (cn=saltechs) services (cn=services) sertechs (cn=sertechs) development (cn=development) devtechs (cn=devtechs) Green, Sam (cn=green, Sam) Pat Brown (cn=pat Brown) Al Grey (cn=grey, Al) 34 AE Services Integration Guide for IBM Lotus Sametime December 2010

Community Server LDAP Discovery Community Server LDAP Discovery When the Conference and Presence services are installed on a Community Server, there is an option to automatically detect some LDAP configurations from the SametimeCommunity2.xml file located in the Domino directory. This option will only be used if the value of avaya.aes.sametime.community2_xml_enabled is set to "true" by the configurator. The SametimeCommunity2.xml file is configured on the IBM Sametime Community server and can be accessed various ways. One way to access this file is via the stcenter.nsf web interface Administer this server > LDAP Directory. The SametimeCommunity2.xml configurations will take precedence over what has been configured in the avaya-aes-sametime.properties file if the Conference and Presence services are able to detect any enabled LDAP servers in the SametimeCommunity2.xml file. The following properties are ignored when the SametimeCommunity2.xml file is present and avaya.aes.sametime.community2_xml_enabled=true: avaya.aes.sametime.ldap.url avaya.aes.sametime.ldap.admin_dn avaya.aes.sametime.ldap.admin_password avaya.aes.sametime.ldap.base_search_dn This does not apply to the LDAPS truststore location and password or any of the following properties which are always retrieved from the avaya-aes-sametime.properties file by the Conference and Presence services: avaya.aes.sametime.trust_store_location avaya.aes.sametime.trust_store_password avaya.aes.sametime.ldap.page_size avaya.aes.sametime.ldap.presence.user_attr avaya.aes.sametime.ldap.conference.user_attr avaya.aes.sametime.ldap.telephone_number_attr avaya.aes.sametime.ldap.users_attr avaya.aes.sametime.ldap.users_attr_value Note: Note: LDAP discovery works only when you are using a Community Server, and its release is less than 8.5.1. AE Services Integration Guide for IBM Lotus Sametime December 2010 35

Chapter 3: Planning your installation Software Requirements Software platform Avaya Application Enablement Services, Release 5.2 (either the AE Services Bundled or Software-Only Server) Avaya Communication Manager, Release 4.x, or later IBM Lotus Sametime Community Server 8.0 through 8.5.1 IBM Lotus Sametime Media Manager 8.5 through 8.5.1 Sametime Server Operating Systems supported by AE Services The AE Services Integration for Sametime is supported with Sametime Community or Media Manager servers 8.5.1 on the following operating systems. Microsoft Windows Server 2003 Standard Edition SP1 or later Microsoft Windows Server 2003 Standard Edition 64-bit (32-bit certification only) Microsoft Windows Server 2003 Enterprise Edition SP1 or later Microsoft Windows Server 2003 Enterprise Edition 64-bit (32-bit certification only) Microsoft Windows Server 2008 Standard Edition Microsoft Windows Server 2008 Standard Edition 64-bit (32-bit certification only) Microsoft Windows Server 2008 Enterprise Edition Microsoft Windows Server 2008 Enterprise Edition 64-bit (32-bit certification only) Note: Note: "32-bit certification only" means that the Sametime server will run only in 32-bit application mode when installed on a 64-bit variation of the operating system. AE Services supports an AE Server configured with the AE Service Integration for IBM Sametime and another application (such as a TSAPI-, JTAPI-, DLG-, CVLAN-, or DMCC-based application), subject to performance constraints. An AE Services administrative workstation: The AE Services Bundled Server does not provide a Web browser, and the AE Services Software Only solution does not assume that you will install one. To administer AE Services, you need an administrative workstation -- a computer running a browser with network access to the AE Server. 36 AE Services Integration Guide for IBM Lotus Sametime December 2010

Software Requirements SIP Requirements : Specific Avaya SIP endpoints can be controlled with AE Services 4.1 (or later) and Communication Manager 5.0 (or later). AE Services 5.2 supports SIP enabled endpoints (Avaya 16CC and 9620, 9630, 9630G, 9640, and 9640G SIP endpoints with firmware version 2). The requirements for SIP support are as follows: Communication Manager 5.0, or later SIP Enablement Services (SES) 5 Note: Note: The Session Initiation Protocol (SIP) is a control (signaling) protocol for creating, modifying, and terminating sessions with one or more participants. These sessions include Internet telephone calls, multimedia distribution, and multimedia conferences. In more familiar terms, SIP means real-time communication, presence, and collaboration in a variety of forms including voice, video, or instant text messaging. Requirements for SDK downloads You will need an IBM account to download the Sametime SDK. A developerworks or PartnerWorld account can act as an IBM account, but if you do not have a developerworks or PartnerWorld account, you can register on the IBM web site for IBM account. AE Services Integration Guide for IBM Lotus Sametime December 2010 37

Chapter 3: Planning your installation Hardware Requirements This topic describes the hardware requirements for IBM Lotus Sametime and Avaya Application Enablement Services. IBM Lotus Sametime servers See the IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 1 for a listing of minimum and recommended requirements. Note: Note: To reach the maximum capacities, the server must have up to 1.5 GB of dedicated RAM per Conference Service and 1 GB of dedicated RAM per Presence Service. 38 AE Services Integration Guide for IBM Lotus Sametime December 2010

Hardware Requirements AE Services requirements See the following documents for AE Services requirements. Implementing Avaya Aura Application Enablement Services on Avaya Aura System Platform, 02-603468 Implementing Avaya Aura Application Enablement Services for a Bundled Server Upgrade, 02-300356 Implementing Avaya Aura Application Enablement Services in a Software-Only Environment, 02-300355 Communication Manager and media servers To use AE Services Release 5.2, you must have the official Avaya Communication Manager Release 4.x or 5.x software running on an IP-enabled media server. AE Services Integration Guide for IBM Lotus Sametime December 2010 39

Chapter 3: Planning your installation Licensing The AE Services Integration for IBM Lotus Sametime licensing arrangements are as follows: The AE Services/ IBM Lotus Sametime integration uses the Unified Desktop Edition License. The Presence Service will consume one Unified Desktop license for each Avaya device it monitors for telephony presence. The Conference Service will consume one Unified Desktop license for each Avaya device used to make or receive Sametime-initiated calls. Licenses are consumed once per device, so if a license is consumed by the Presence Service when it monitors some Avaya device, an additional license is not consumed by the Conference Service when it engages the same Avaya device in a call. Neither CMAPI IP-API_A nor TSAPI Basic users licenses will be required. Simultaneous Connection RTUs are still required - two simultaneous connections are provided by default. The AE Services Integration for IBM Lotus Sametime requires an AE Services 5.2 license file. You must obtain IBM licenses from IBM. Phone number requirements Phone numbers stored in the directory (Domino, LDAP, or Active Directory) and entered by the user must be in E.164 format. For example: +13035551212 Phone numbers entered as Preferred Numbers in Sametime Connect and phone numbers entered into the "Type a name or phone number" Sametime Connect input field do not require the leading plus sign. The Conference Service prepends the plus sign to any dialed number before sending the number to the AE Services server for conversion by the dial plan. Additional Requirements - SDK downloads You will need an IBM account to download the Sametime SDK. A developerworks or PartnerWorld account can act as an IBM account, but if you do not have a developerworks or PartnerWorld account, you can register on the IBM web site for IBM account. 40 AE Services Integration Guide for IBM Lotus Sametime December 2010

About Installing and Configuring the AE Services Integration for IBM Lotus Sametime Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime Use the information in this chapter to integrate Application Enablement Services (AE Services) with IBM Lotus Sametime. About Installing and Configuring the AE Services Integration for IBM Lotus Sametime This document assumes that the AE Services Integration for IBM Lotus Sametime plug-in is being installed in an existing Domino and Sametime environment. For new customers or existing Domino customers who need to install all or a portion of the required environmental components see Customizing the Sametime Environment on page 129. (Table 5 summarizes the tasks in Appendix A). After you have completed these tasks, proceed with Testing Sametime on page 43 If you already have these components in place, proceed with Testing Sametime on page 43. After you have completed Testing Sametime on page 43, continue with the tasks in Table 6: Checklist for integrating AE Services with IBM Sametime on page 44. Table 5: Summary of tasks for installing all or a portion of the required environmental components (see also Appendix A) Task Admin Domain Document or location in this document 1 Install IBM Lotus Domino Sametime Server See the IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 1. 2 Set up the IBM Lotus Domino server Sametime Server See the IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 1. AE Services Integration Guide for IBM Lotus Sametime December 2010 41

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime Table 5: Summary of tasks for installing all or a portion of the required environmental components (see also Appendix A) (continued) Task Admin Domain Document or location in this document 3 Install Lotus Notes with the Domino Admin client feature. 4 Set up the Domino Admin account. 5 Install the Sametime server. 6 Set up the IBM Lotus Media Manager (optional). 7 Enable Telephony Conferencing. 8 Configure the classpath for the Sametime server. Sametime Server See the IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 1. Sametime Server See the IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 1. Sametime Server See the IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 1. Sametime Server See the IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 1. Sametime Server Sametime Server See Enabling Telephony Conferencing on page 129. See Determining if the Sametime Server can find the JRE on page 130. 42 AE Services Integration Guide for IBM Lotus Sametime December 2010

Testing Sametime Testing Sametime Use this procedure to test the Sametime installation. 1. Start domino (which should auto start Sametime). 2. Use the services application to verify that all Sametime services have started. 3. Test the Sametime Installation as follows: a. From your Web browser go to the Sametime Center administration Web page on your Sametime server. For example, if the name of your Sametime server is sametime.example.com, go to the following Web page: http://sametime.example.com/stcenter.nsf. b. Click Schedule a Meeting. c. Click Test Meeting on the left task bar. d. On the Test Meeting page, click Test My Browser. You may be prompted to install a JVM at this point. If you are, go to www.java.com to obtain it, then restart your browser. You may receive a popup requesting you to run the meeting application. e. Once you accept, a test meeting should now open. You can close it, your test was successful. Note: Note: If you schedule a meeting and are not able to join because the meeting room stops at Joining Meeting you may have not updated your copy of Windows with the latest hotfixes. Open the Java console, if you see an error indicating STMeetingRoomApplet. Apply hotfix KB933566 from Microsoft for your client machine. AE Services Integration Guide for IBM Lotus Sametime December 2010 43

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime AE Services Integration for IBM Sametime - checklist Use the checklist in Table 6 for integrating AE Services with IBM Lotus Sametime. Table 6: Checklist for integrating AE Services with IBM Sametime Task Admin domain Document or location in this document 1 Install Sametime Connect Client. 2 Install Extended Status Feature and Telephony Status Feature Plug-ins. 3 Administer the Sametime Server for integration with AE Services. 4 Administer a CTI link (ADJ-IP). 5 Check the status of the switch connection (from Communication Manger to AE Services). 6 Administer a switch connection from AE Services to Communication Manager. 7 Check the status of the switch connection (from AE Services to Communication Manager). Sametime Server Sametime Server Sametime Server Avaya Communication Manager Avaya Communication Manager AE Services AE Services See Setting up the IBM Sametime Connect clients on page 47. See Setting up the IBM Sametime Connect clients on page 47. See Manually Editing the avaya-aes-sametime.properties file on page 72. See "Administering a CTI Link for TSAPI, JTAPI, DMCC with Call Control, Telephony Web Service, or an AE Services integration (Microsoft or IBM Sametime)," in Chapter 1 of the Avaya Aura Application Enablement Services Administration and Maintenance Guide, 02-300357. See "Checking the status of a Switch Connection - from Communication Manager to the AE Server," in Chapter 1 of the Avaya Aura Application Enablement Services Administration and Maintenance Guide, 02-300357. See "AE Services integration for IBM Lotus Sametime - checklist," in Chapter 3 of the Avaya Aura Application Enablement Services Administration and Maintenance Guide, 02-300357. 1 of 3 44 AE Services Integration Guide for IBM Lotus Sametime December 2010

AE Services Integration for IBM Sametime - checklist Table 6: Checklist for integrating AE Services with IBM Sametime (continued) Task Admin domain Document or location in this document 8 Administer an encrypted TSAPI Link. 9 Verify that DMCC Server port 4722 is enabled (the default setting). This port is used for secure communication. 10 Add users to the AE Services Security Database (SDB). Note: You can not add a user directly to the SDB. You must add a user to the local LDAP database (AE Services User Management) and designate the user as a CT user. 11 Administer settings for the dial plan. AE Services AE Services AE Services (User Management) AE Services (AE Services Management Console) See "Administering TSAPI Links" in Chapter 3 of the Avaya Aura Application Enablement Services Administration and Maintenance Guide, 02-300357. IMPORTANT: For the AE Services Integration for IBM Lotus Sametime, you must administer TSAPI links as Encrypted or Both. Use Both if your AE Server supports another application that uses encrypted links. To do this, select Administration > CTI Link Admin > TSAPI Links). On the TSAPI Links page, click Add Link. Then, on the Add / Edit TSAPI Links page, in the Security pull-down, select Encrypted or Both. Select Encrypted if your AE Server is dedicated to the AE Services Integration for IBM Lotus Sametime. Select Both if your AE Server supports another application that uses encrypted TSAPI links. In the AE Services Management Console, make sure the setting for DMCC Server Ports, Encrypted Port is enabled (Networking > Ports). See Administering the AE Services Security Database in the AE Services Management Console on page 84. See Chapter 5: Administering Dial Plan Settings on page 93. 2 of 3 AE Services Integration Guide for IBM Lotus Sametime December 2010 45

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime Table 6: Checklist for integrating AE Services with IBM Sametime (continued) Task Admin domain Document or location in this document 12 Configure the Sametime Connect Client. IBM Sametime Connect Client 13 Test the configuration. IBM Sametime Connect Client See IBM Lotus Sametime 8.5.1 Installation and Administration Guide Part 2. See Testing the Configuration on page 86. 3 of 3 46 AE Services Integration Guide for IBM Lotus Sametime December 2010

Setting up the IBM Sametime Connect clients Setting up the IBM Sametime Connect clients Follow these instructions to set up the IBM Sametime Connect clients. Make sure you have an IBM account You will need an IBM account to download the Sametime SDK. A developerworks or PartnerWorld account can act as an IBM account. If you do not have a developerworks or PartnerWorld account, go to http://www.ibm.com/us/. Select My Accounts and follow the instructions for setting up an account. Install the Sametime Connect client plug-in Since the release of Sametime 8.5.1, the Connect client plug-in is shipped with the client so there is no need to directly install the plug-in. However, it is required that the administrator enable the plug-in by configuring the client preferences with the Expeditor managed settings framework. (For full details, see the Lotus Sametime Installation and Administration Guide for these instructions.) The instructions to enable the plug-in for a Sametime 8.5.1 Connect client are provided in this section. For older Sametime clients (such as the Sametime 8.0.2 Standalone and Lotus Notes clients embedded with the 8.0.2 client), the required client plug-in can be installed via one of two methods: using the AES plug-in package or downloaded from IBM. Utilize the following instructions for your desired method. Enabling Sametime 8.5.1 Unified Telephony, extended status, and telephony status in the client The IBM Lotus Sametime Connect 8.5.1 client, both standalone and integrated with Lotus Notes, includes the following plug-ins that were available separately in previous releases: Sametime Unified Telephony plug-ins Extended status plug-in Telephony status plug-in Lotus Sametime provides different options for administrators to change client preferences without requiring any action from end users. You can use any of these options to modify the three client preferences described previously. However, IBM recommends the managed preferences mechanism for changing these and other client preferences. Here is an overview of the managed preferences mechanism: AE Services Integration Guide for IBM Lotus Sametime December 2010 47

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime It was first supported by the Lotus Sametime Connect 8.5 client, but does not require a Sametime 8.5 server. You place a file name "managed-settings.xml" on your server at the location specified by the administration update site URL. This is the same URL that specifies where the client looks for updated features posted by the administrator, which are automatically installed. This URL is specified by a Sametime user policy. So, a different URL can be used for different users and groups. Lotus Sametime Connect 8.5 and later clients use the administration update site URL to look for updated features and the "managed-settings.xml" file. If found, the settings from the managed-settings.xml file are read and processed by the client. Older clients use the administration update site URL to look for updated features, but ignore the managed-settings.xml file at that location. Below is the format of the managed-settings.xml file that you should use to enable or disable Unified Telephony, extended status, and telephony status. The values set here are a minimum for the Avaya AES presence to be visible in the Connect client: <Managed Settings> <settinggroup name="com.ibm.collaboration.realtime"> <setting name="enablesut" value="false"/> <setting name="enabletelephonystatus" value="true"/> <setting name="enableextendedstatus" value="true"/> </settinggroup> </ManagedSettings> For more information on using managed settings, see the section on configuring client preferences with the Expeditor managed settings framework in the Lotus Sametime Installation and Administration Guide. Note: Note: Unlike other client preferences, changes to Unified Telephony, extended status, and telephony status do not take effect until the client is restarted. Because the end user is unaware of preferences changes made using the manage preferences mechanism, a dialog box appears and displays the following message if changes are detected to any of these three preferences: Sametime has detected a configuration change from the administrator and needs to restart. From this dialog box, the user can choose to restart the client. 48 AE Services Integration Guide for IBM Lotus Sametime December 2010

Setting up the IBM Sametime Connect clients Install the Sametime Connect plug-in using the AES Sametime plug-in package The Avaya AES Sametime Connect plug-in install contains an embedded update site for the necessary client plug-in. 1. After installation, locate the appropriate install folder on the client system. 2. Within the Sametime Client plug-in install, select as an update site the file system location <AES Sametime plug-in install location>\telephony_ext\aes\presence\client-plugin. 3. Install the client plug-in from that file system update site location. Download and install the IBM Sametime Connect plug-in After you have set up an account, follow these steps to download and install the necessary toolkits for the client and server: 1. Go to the IBM Lotus downloads Web page: http://www.ibm.com/developerworks/lotus/downloads/toolkits.html 2. From the IBM Lotus downloads Web page, click Lotus Sametime Software Developer Kit (SDK), click on the SDK version that matches your Connect Client version, and then follow the instructions for downloading the software. 3. Unzip the Sametime SDK to some directory on a web server, and install the following Sametime Connect plug-ins: Extended Status Feature Telephony Status Feature The SDK contains an Eclipse update site in the following folder: client\connect\samples\com.ibm.collaboration.realtime.sample.telephonystatus.updatesite You can use the update site to pull the plug-ins to the client, or push them from the server. For information about configuring the Sametime server to push the plug-ins to the clients, see the corresponding Installation and Administration Guide that matches your Connect Client software release. AE Services Integration Guide for IBM Lotus Sametime December 2010 49

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime Setting up the Java Environment Before running the AES plug-in installation program, you must configure Java for the server on which you are planning to install the AES plug-in. To configure the Java environment for you server, perform the following steps: 1. On server, select Start > Control Panel. 2. In the Control Panel window, double-click the System icon. The System Properties dialog box appears. 3. Click the Advanced tab, and then click the Environment Variables button. The Environment Variables dialog box appears. 4. In the System variables area, click the New button. The New System Variable dialog box appears. 5. Perform one of the following steps: - For a Sametime 8.5.1 Community server: a. In the Variable name box, enter JAVA_HOME b. In the Variable value box, enter InstallDir\jvm where InstallDir is the Domino installation directory. The default on Microsoft Windows is C:\Program Files\IBM\Lotus\Domino. - For a Sametime 8.5.1 Media Manager server: a. In the Variable name box, enter JAVA_HOME b. In the Variable value box, enter InstallDir\java where InstallDir is the WebSphere AppServer installation directory. The default on Microsoft Windows is C:\Program Files\IBM\WebSphere\AppServer. 6. Click the OK button. 7. In the System variables list box, select Path, and then click the Edit button. The Edit System Variable dialog box appears. 8. At the end of the string displayed in the Variable value box, enter the following information: ;%JAVA_HOME%\bin This string makes the Java executable and associated tools available. 9. Click the OK button. 10. Click the OK button to close the Environment Variables dialog box. 50 AE Services Integration Guide for IBM Lotus Sametime December 2010

Setting up the Java Environment 11. Click the OK button to close the System Properties dialog box. You can verify the availability of Java by executing the following command in the Command window: java -version The system should provide a response similar to java version "1.6.0". AE Services Integration Guide for IBM Lotus Sametime December 2010 51

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime Setting up the Avaya Conference and Presence Services on the Sametime Server To set up the Conference and Presence services on the Sametime server, the Sametime administrator launches an installation program that installs the Avaya Conference and Presence Services into the proper Sametime server directory, and then performs a few configuration tasks, which are described in the following sections: Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server on page 53 Editing the AE Services property files on the Sametime Server on page 71 Administering the AE Services Security Database in the AE Services Management Console on page 84 Testing the Configuration on page 86 Choosing the Correct IBM Sametime Server for Installation With the release of IBM Sametime 8.5, a new component called the IBM Sametime Media Manager was introduced and changes how the AES TCSPI is installed. The IBM Sametime Media Manager runs on the WebSphere Application Server to provide audio visual services for chats and meetings. It requires an IBM Sametime Community Server, but when the Media Manager is installed, it becomes the target installation server for the AES TCSPI. When planning a Media Manager integration with the AES Conference Service, the AES TCSPI must be installed on the Media Manager server and not the Community Server. If you are adding a Media Manager to an existing AES integration, you must uninstall the AES TCSPI from the community server before installing the Media Manager. The Sametime Media Manager uses three components. In a small deployment, the Sametime Media Manager components can all be installed on one server, but in an enterprise deployment, you typically install each of the components on its own server. A Media Manager deployment consists of a Conference Manager, a SIP Proxy and Registrar, and a Packet Switcher, but each of these components can be installed on separate machines. The AES TCSPI must be installed on the Conference Manager. Note that while there is only one Media Manager in a Sametime Community you can still cluster the Conference Manager and therefore must be sure to install and configure the AES TCSPI on all Conference Managers in the cluster. If your environment does not include the Sametime Media Manager, you will install the AES TSCPI on the Community Server. 52 AE Services Integration Guide for IBM Lotus Sametime December 2010

Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server To install the AE Services Integration for IBM Lotus Sametime on an 8.5.1 Sametime Media Manager or Community server, follow these steps. 1. Stop the Avaya Telephony Presence Service (if running). 2. Shut down the Sametime Media Manager or Community server on which you want to install the AES plug-in. 3. Download the AES plug-in installation program, Avaya-AES-Sametime-Installer-<version>.exe, to the Sametime server, and save it to a convenient location. 4. Using Windows Explorer, go to the location where you saved Avaya-AES-Sametime-Installer-<version>.exe, and then double-click on that file. The Welcome dialog box appears. AE Services Integration Guide for IBM Lotus Sametime December 2010 53

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime Figure 10: Welcome Dialog Box 5. Click the Next button. The License dialog box appears. 54 AE Services Integration Guide for IBM Lotus Sametime December 2010

Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server Figure 11: License Dialog Box 6. Read the terms of the Avaya software license. If you agree to the terms of the license, click the I accept the terms of this agreement option button, and then click the Next button. The Sametime Server dialog box appears. AE Services Integration Guide for IBM Lotus Sametime December 2010 55

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime Figure 12: Sametime Server Dialog Box 7. Perform one of the following steps: If you have Sametime Community Server, click the IBM Sametime Community Server option button. If you have Sametime Media Manager, click the IBM Sametime Media Manager option button. 8. Click the Next button. The Packs to Install dialog box appears. Figure 13 shows a Packs to Install dialog box for a Sametime Community server installation. 56 AE Services Integration Guide for IBM Lotus Sametime December 2010

Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server Figure 13: Packs to Install Dialog Box 9. Click the Next button. If you are installing Sametime Community Server, the Installation Path dialog box appears. Go to Step 10. If you are installing Sametime Media Manager, the Custom Install Location dialog box appears. AE Services Integration Guide for IBM Lotus Sametime December 2010 57

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime Figure 14: Custom Install Location Dialog Box Perform one of the following steps: If you are not installing a Vertical Cluster Conference Manager, click the No button. The installer will try to automatically detect the install location and will display the Installation Path dialog box. Go to Step 10. If you are installing a Vertical Cluster Conference Manager, perform the following steps: a. Click the Yes button. The Select Installation Path dialog box appears. b. Using the Browse button, select the directory of the Conference Manager node where you would like to install the plug-in (for example, C:\Program Files\IBM\ WebSphere\AppServer\profiles\STMSPNProfile1\). If you have more than one Conference Manager on the machine, you can run the installer again after completing the steps in this section and select a new path. Figure 15 shows a sample Select Installation Path dialog box. 58 AE Services Integration Guide for IBM Lotus Sametime December 2010

Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server Figure 15: Select Installation Path Dialog Box c. Click the Next button. The Installation Path dialog box appears. Go to Step 10. Note: Note: If the following warning dialog box appears, click the Yes button and then go to Step 10. Figure 16: Warning Dialog Box AE Services Integration Guide for IBM Lotus Sametime December 2010 59

Chapter 4: Installing and Configuring the AE Services Integration for IBM Lotus Sametime 10. Write down the installation path that is displayed. You will need to know this path when you run the configuration later. 11. Click the Next button. The Installation Settings dialog box appears. Figure 17: Installation Settings Dialog Box 12. Click the Next button. The Installation Status dialog box appears, showing the status of the install. When the installation is complete, the Next button becomes enabled. 13. Click the Next button. The Installation Complete message box appears. 14. Click the Done button. 15. Perform one of the following steps: 60 AE Services Integration Guide for IBM Lotus Sametime December 2010