02-602818_i1

Avaya Application Enablement ServicesRelease 4.2Integration Guide for IBM Lotus Sametime

02-6028184.2

May 2008Issue 1

© 2008 Avaya Inc. All Rights Reserved.

NoticeWhile 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 disclaimerAvaya 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 disclaimerAvaya 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.

WarrantyAvaya 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

LicenseUSE 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.

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 componentsCertain 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 interventionIf 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

TrademarksAvaya, the Avaya logo, and MultiVantage are either registered trademarks or trademarks of Avaya Inc. in the United States of America and/or other jurisdictions. IBM is a registered trademark of International Business Machines Corporation. Lotus is a registered trademark of International Business Machines Corporation.Microsoft is a registered trademark of Microsoft Corporation.Sametime is a registered trademark of International Business Machines Corporation.All other trademarks are the property of their respective owners.

Downloading documentsFor the most current versions of documentation, see the Avaya Support Web site:http://www.avaya.com/support

Avaya supportAvaya 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

http://www.avaya.com/support


http://www.avaya.com/support/

http://support.avaya.com/LicenseInfo/

http://support.avaya.com/ThirdPartyLicense/

http://www.avaya.com/support/

AE Services Integration for IBM Lotus Sametime May 2008 3

About this document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7About the AE Services Integration for IBM Lotus Sametime . . . . . . . . . . . . 7Intended audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Related documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Avaya Application Enablement Services documents . . . . . . . . . . . . 8IBM Lotus Sametime documents . . . . . . . . . . . . . . . . . . . . . . . 8

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10Contacting Avaya . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 1: System Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13Overview of the AE Services Integration for IBM Lotus Sametime. . . . . . . . . 13

Features of the AE Services Integration for IBM Lotus Sametime . . . . . . . 15IBM Lotus Sametime -- a quick summary . . . . . . . . . . . . . . . . . . . . 17

Architectural Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18Making a simple phone call . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Setting up the dial plan -- converting E.164 numbers to dial strings . . . . . 20

Known Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Performance and capacities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Chapter 2: Planning your installation . . . . . . . . . . . . . . . . . . . . . . . . . . 23Preparing for the AE Services Integration for IBM Lotus Sametime . . . . . . . . 23

Configuring Sametime directories and setting up the LDAP properties in the Avaya configuration properties file. . . . . . . . . . 25

Sametime configurations with the Domino directory . . . . . . . . . . . . 25Sametime configurations with an LDAP directory. . . . . . . . . . . . . . 27

DN entries and scope of search . . . . . . . . . . . . . . . . . . . . . . . . . 28Avoid making the Base Search DN too specific . . . . . . . . . . . . . . . 28

Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Software platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29Sametime Server Operating Systems supported by AE Services . . . . . 29Requirements for SDK downloads . . . . . . . . . . . . . . . . . . . . . . 30

Hardware Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31IBM Lotus Sametime 7.5.1 and 8.0 servers . . . . . . . . . . . . . . . . . . . 31AE Services requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

AE Services bundled server requirements. . . . . . . . . . . . . . . . . . 32Requirements for the AE Services software only server . . . . . . . . . . 33

Communication Manager and media servers . . . . . . . . . . . . . . . . . . 33Licensing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Phone number requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Additional Requirements - SDK downloads . . . . . . . . . . . . . . . . . . . 34

Contents

Contents

4 AE Services Integration for IBM Lotus Sametime May 2008

Chapter 3: Installing and Configuring the AE Services Integration forIBM Lotus Sametime. . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Testing Sametime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37AE Services Integration for IBM Sametime - checklist . . . . . . . . . . . . . . . 38Setting up the IBM Sametime Connect clients. . . . . . . . . . . . . . . . . . . . 41Setting up the Avaya Conference and Presence Services on the Sametime Server 42Installing the AE Services Integration for IBM LotusSametime on the Sametime Server . . . . . . . . . . . . . . . . . . . . . . . . . 43

Setting up the IBM Lotus Sametime Server . . . . . . . . . . . . . . . . . . . . . 46Increasing memory available to the JVM for IBM Lotus Sametime . . . . . . 46Executing AE Services integration utility for IBM Sametime 7.5.1 . . . . . . . 47Setting up a keystore and importing a trusted certificate . . . . . . . . . . . 48

Importing a trusted certificate into the Java keystore. . . . . . . . . . . . 48Administering certificates on the AE Server or the LDAPS server . . . . . 48

Editing the AE Services property files on the Sametime Server . . . . . . . . . . 49Tips for editing the property files. . . . . . . . . . . . . . . . . . . . . . . . . 49Editing the st.telephony.adapter.properties file . . . . . . . . . . . . . . . . . 50About the ConferenceManager.properties file . . . . . . . . . . . . . . . . . . 50Editing the avaya-aes-sametime.properties file . . . . . . . . . . . . . . . . . 51Administering the Security Database in AE Services OAM. . . . . . . . . . . 60Sametime Application Account . . . . . . . . . . . . . . . . . . . . . . . . . . 61Setting up the dial plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Configuring the Sametime client . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Testing the Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Serviceability Considerations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Authentication of moderator and participants phone numbers . . . . . . . . . . 64"How it works"-- using the Lotus Sametime Connect client . . . . . . . . . . . . 65

About conferencing and Sametime client configuration . . . . . . . . . . 66User name and call window states . . . . . . . . . . . . . . . . . . . . . . 67

Chapter 4: Administering Dial Plan Settings . . . . . . . . . . . . . . . . . . . . . . 69Administering Dial Plan Settings in AE Services OAM . . . . . . . . . . . . . . . 69

Before you begin. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69About Tel URI formats and device IDs . . . . . . . . . . . . . . . . . . . . . . 70About the From TelURI rules . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

From TelURI operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Valid dial string characters and using the asterisk . . . . . . . . . . . . . 71The From Tel URI table . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72From TelURI settings for fixed-length extensions . . . . . . . . . . . . . . 73From TelURI settings for variable-length extensions . . . . . . . . . . . . 75

Contents


Pattern matching -- using Pattern and RegEx (regular expressions) . . . 77Methods for administering dial plan settings . . . . . . . . . . . . . . . . . . . . 79

Administering dial plan settings on a per-switch basis . . . . . . . . . . . 80Administering default dial plan settings . . . . . . . . . . . . . . . . . . . 81

Chapter 5: Troubleshooting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Sametime. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Configuration Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Presence Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Conference Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Presence Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87LDAP or AE Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87AE Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Conference Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Presence Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

AE Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Logging. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Logging Levels. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Appendix A: Installing and Configuring Lotus Domino and Sametime . . . . . . . . 97About this appendix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97Before you begin -- preinstallation checklist . . . . . . . . . . . . . . . . . . . . 98Installing Lotus Domino . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99Setting up the Domino server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100Installing the Domino Admin client files . . . . . . . . . . . . . . . . . . . . . . . 111Setting up the Domino Admin account. . . . . . . . . . . . . . . . . . . . . . . . 114Installing the Sametime Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118Administering the server ID certificate . . . . . . . . . . . . . . . . . . . . . . . . 121Enabling Telephony Conferencing . . . . . . . . . . . . . . . . . . . . . . . . . . 127Determining if the Sametime Server can find the JRE . . . . . . . . . . . . . . . 127Testing Sametime . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Contents


Appendix B: LDAP tester - sample output . . . . . . . . . . . . . . . . . . . . . . . . 129

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131

About the AE Services Integration for IBM Lotus Sametime


About this document

About the AE Services Integration for IBM Lotus SametimeThe 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 audienceThis guide is written for technical support representatives and IT administrators who install and configure the AE Services Integration for IBM Sametime.

About this document


Related documentsThis 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 4.2, see the following documents.

● Avaya MultiVantage Application Enablement Services Installation and Upgrade Guide for Bundled Server, 02-300356

● Avaya MultiVantage Application Enablement Services Installation Guide Software-Only Offer, 02-300355

● Avaya MultiVantage Application Enablement Services Administration and Maintenance Guide, 02-300357

● Application Enablement Services Operations, Administration, and Maintenance (OAM) Help (which is included with the AE Services server software)

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 7.5.1 and 8.0 configurations. For information about IBM Sametime, see the following documents.

IBM Lotus Sametime 7.5.1 documents:

For information about setting up IBM Lotus Sametime 7.5.1, see the following documents.

● IBM Lotus Sametime 7.5.1 Release Notes

● IBM Lotus Sametime 7.5.1 Server Installation Guide

● IBM Lotus Sametime 7.5.1 Server Administration Guide

IBM Lotus Sametime 7.5.1 documents are available at http://www.ibm.com/developerworks/lotus/documentation/sametime/75x.html

http://www.ibm.com/developerworks/lotus/documentation/sametime/75x.html


Related documents


IBM Lotus Sametime 8.0 documents:

For information about setting up IBM Lotus Sametime 8.0, see the following documents.

● IBM Lotus Sametime 8.0 Release Notes

● IBM Lotus Sametime 8.0 Standard Installation and Administration Guide

● IBM Lotus Sametime 8.0 Connect Client User Guide

IBM Lotus Sametime 8.0 documents are available at http://www.ibm.com/developerworks/lotus/documentation/sametime/index.html

http://www.ibm.com/developerworks/lotus/documentation/sametime/index.html

About this document


ConventionsThe 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


Contacting Avaya

For information about Application Enablement Services

Technical Support +1-800-344-9670

Avaya Support Web site www.avaya.com/supportFor the latest information about this product and accompanying documentation, see the product link for Application Enablement Services.


About this document


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.


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 14 summarizes the tasks for AE Services.

For complete descriptions of the of tasks see, Chapter 3: Installing and Configuring the AE Services Integration for IBM Lotus Sametime on page 35.

Table 1: IBM Sametime tasks

Install and configure the Domino Server.

Install and configure Lotus Notes (Admin).

Install and administer the Sametime Server.

Test Sametime.

Install the Sametime SDK.

Install AE Services Integration for IBM Sametime.



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.

Table 2: AE Services tasks

Install AE Services 4.2 or upgrade to AE Services 4.2 (on the AE Server).

Install the AE Services 4.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.



Features of the AE Services Integration for IBM Lotus SametimeThe 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

You can use click-to-call in Sametime ConnectYou can escalate an instant message

Presence is shared

Avaya Provides the telephony connection

The solution is endpoint-neutral

to a call

Live NamesDial an outside line



Figure 2: System-level view of the AE Services Integration for IBM Lotus Sametime

VPN Remote

one-X PortalCell Phone:extension tocellular /one-XMobile

IP Softphone

TDM/Analog

SIP H.323

Sametime Virtual Places (VP)

Avaya CTI

AE Services 4.2

IBM Lotus

Server

Avaya Communication Manager

SametimeEndpoints

Protocol

Computer running IBM Sametime Connect or Lotus Notes



IBM Lotus Sametime -- a quick summaryIf 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, Mac OS X, 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 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).



Architectural SummaryThe 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 TSCPI component (or plug-in) is a DMCC Java client application (as illustrated in Figure 3). The TSCPI plug-in is the integration point for AE Services and IBM Lotus Sametime -- it manages click-to-call and conferencing.

In simplest terms, setting up the AE Services Integration for IBM Lotus Sametime is primarily a matter of installing and configuring the plug-in, which is described in the following sections of this document.

● Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server on page 43

● Configuring the Sametime client on page 62

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 35.

Figure 3: AE Services Integration with IBM Lotus Sametime architecture

AvayaPresenceService

PCs are running IBM Sametime Connect,Lotus Notes, or Microsoft Office

IP

IBM Lotus Sametime ServerAvaya

AE Services

AvayaCommunication

Manager

CTI Link

AvayaConferenceService

AE ServicesDMCC JavaSDK/Client

AE ServicesDMCC JavaSDK/Client Call Control

Service

TSAPIService

3.x, 4.x, or 5.0

TSCPI plug-in

Architectural Summary


Making a simple phone callRecall 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

H.323

TDM/Analog Cell (EC500)

AE Services 4.2

Connectregisters with

IP Softphone

+13035551235

51235 51236 51237

51235

+13035551235

+13035551234 on login

Connect clientcalls

AE Services converts the dialed number

Communication Manager

Connect CTI link51234

51235

to

SIP

IBM Sametime Server

51234



Setting up the dial plan -- converting E.164 numbers to dial stringsPhone 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 AE Services OAM is used for converting E.164 numbers to dial strings. For more information, see Chapter 4: Administering Dial Plan Settings on page 69.

Figure 5: AE Services Integration for IBM Lotus Sametime - dial plan

IBM Sametime Communication

IBM SametimeConnect client

3.x , 4.x, or 5.x

+130

3538

1234

E.16

4 nu

mbe

r

+130355512345551234

From TelURI

AE Services Server 4.2

Use AE Services OAM to configure dial plan settings

Server

Administer Dial Plan settings (From TelURI) in OAM

E.164 numberManager

Enter conversion rules into the From TelURI table so AE Services can convertE.164 numbers into dial strings.

Known Issues


Known IssuesThis topic describes the currently-known issues for the AE Services Integration for IBM Lotus Sametime.

Sametime 8.0 and 7.5.1

● 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.

● If you are using Active Directory (AD) and you have more than 1000 entries in AD, the MaxPageSize parameter must be adjusted from the default value of 1000 to a value greater than the actual number of entries configured in AD. The Presence service currently performs a generic LDAP search of a LDAP server in order to receive all the administered users. If you have more than 1000 entries in AD, and the MaxPageSize parameter is set to the default (1000) you will get incomplete results from the generic LDAP search. You would get presence status for the first 1000 entries, but you would not get status for entries 1001 and greater.

● 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.

Sametime 7.5.1 only

● Due to a limitation in Sametime Connect 7.5.1, Sametime Connect 7.5.1 does not display the telephone icon when the plug-ins are installed, and changes in telephony presence do not appear in the client. Note, however, that if you use Sametime 7.5.1 and a Sametime Connect Client 8.0 (or later) client, the presence service works.

● For AE Services integrations with IBM Lotus Sametime 7.5.1, you must install the AE Services integration utility for IBM Sametime 7.5.1. For more information, see Executing AE Services integration utility for IBM Sametime 7.5.1 on page 47.

● For Sametime 7.5.1, the status of offline users is not displayed. If you are deploying the AE Services Integration for IBM Lotus Sametime in a Sametime 7.5.1 configuration, you must edit the st.telephony.adapter.properties file, and set the value for passive.users.supported property to false. For more information see, Editing the st.telephony.adapter.properties file on page 50.

Performance and capacities● Number of Concurrent Sametime Users -The AE Services Integration for IBM Lotus

Sametime supports 10,000 concurrent Sametime users.

● Maximum BHCC - The AE Services Integration for IBM Lotus Sametime integration supports a maximum Busy Hour Call Completion (BHCC) rate of 12,000 calls per hour. This rate is 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.

Preparing for the AE Services Integration for IBM Lotus Sametime


Chapter 2: Planning your installation

Read through this chapter to make sure you are prepared to install 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 a contained in

zip file avaya-aes-sametime-<version.n>.<build>.zip. An example of an actual file name would be: avaya-aes-sametime-1.0.29.zip.

The AE Services Integration for IBM Lotus Sametime software can be downloaded from the following Web Site: http://devconnect.avaya.com/AEServices_LotusSametime

● 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 54

● LDAP Properties -- Queries on page 55

● LDAP Properties -- Updating E.164 phone numbers in your directory on page 57

http://devconnect.avaya.com/AEServices_LotusSametime

http://devconnect.avaya.com/AEServices_LotusSametime



Note:Note: When you are setting LDAP properties in the avaya-aes-sametime.properties file,

be sure to use the ldap-tester file ( \telephony_ext\bin\ldap-tester.bat) to verify your configuration settings.

● AE Services information:

- the user name and password for the account that logs in to the AE Server- the DNS name or IP address of the AE Server

For more information, see AE Services properties on page 52.

Note:Note: When you are setting AE Services properties in the

avaya-aes-sametime.properties file, be sure to use the aes-tester file (\telephony_ext\bin\aes-tester.bat) to verify your configuration settings. The command should be run from within cmd.exe.



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 6). For more information, see Sametime configurations with an LDAP directory on page 27

Figure 6: 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



For the following LDAP query attributes in the avaya-aes-sametime.properties file, you can use the default values listed in Table 3.

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 48 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 Editing the avaya-aes-sametime.properties file on page 51.

Table 3: Domino Directory - default LDAP query settings in the avaya-aes-sametime.properties file

Property Sametime 7.5.1 default Sametime 8.0 default

avaya.aes.sametime.ldap.telephone_number_attr telephonenumber telephonenumber

avaya.aes.sametime.ldap.conference.user_attr dn dn

avaya.aes.sametime.ldap.presence.user_attr uid uid or displayname(Use uid or displayname; the value must be unique)



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 6: Sametime directory configuration options on page 25, 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.

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 Editing the avaya-aes-sametime.properties file on page 51.

Table 4: LDAP Directory - default LDAP settings in the avaya-aes-sametime.properties file

Property Sametime 7.5.1 default Sametime 8.0 default

avaya.aes.sametime.ldap.telephone_number_attr telephonenumber telephonenumber

avaya.aes.sametime.ldap.conference.user_attr dn dn

avaya.aes.sametime.ldap.presence.user_attr dn dn



DN entries and scope of searchThe 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 7: DN entries and scope of search on page 28:

● 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 7: DN entries and scope of search

com (dc=com)

example (dc=example)

users (cn=users)

sales (cn=sales) services (cn=services)

devtechs (cn=devtechs)sertechs (cn=sertechs)saltech (cn=saltechs)

Green, Sam (cn=Green, Sam) Pat Brown (cn=Pat Brown) Al Grey (cn=Grey, Al)

base search DN (includes everything below)

development (cn=development)

Software Requirements


Software Requirements

Software platform

● Avaya Application Enablement Services, Release 4.2 (either the AE Services Bundled or Software-Only Server)

● Avaya Communication Manager, Release 3.0, or later

● IBM Lotus Sametime Server 7.5.1 or IBM Lotus Sametime Standard Server 8.0 (or later)

● IBM Lotus Sametime Connect 7.5.1, or later

Sametime Server Operating Systems supported by AE Services

The AE Services Integration for Sametime is supported with Sametime server only on the following operating systems.

● Microsoft Windows™ 2000 Server (Service Pack 4)

● Microsoft Windows™ Advanced Server (Service Pack 3)

● Microsoft Windows 2003 Standard or Enterprise Edition (Service Pack 1), or later

Note:Note: These are the versions of Windows™ that IBM supports for Sametime server

7.5.1 and 8.0.

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.



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 4.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.

Hardware Requirements


Hardware RequirementsThis topic describes the hardware requirements for IBM Lotus Sametime and Avaya Application Enablement Services.

IBM Lotus Sametime 7.5.1 and 8.0 serversSee Table 5 for a listing of minimum and recommended requirements. The data in the recommended column are for a maximal configuration supporting up to 30,000 IM connections (taking into account that users can have multiple simultaneous IM sessions) or 1,000 concurrent meeting users.

Table 5: IBM Lotus Sametime hardware requirements - minimum and recommended

Minimum Recommended

CPU Intel Pentium III 800 MHz 4 2 GHz processors (if single core) or cores (if multicore)

Memory 1 GB 4 GB

Disk space 2 GB free 10 GB free

Swap space 1 GB 5 GB



AE Services requirementsThis sections lists requirements for the AE Services bundled server and the software-only server.

AE Services bundled server requirements

For a new AE Services Bundled Server offer, Avaya ships all of the required components to the customer location before the installation is scheduled to start. Verify with the customer that all of the following items are on site before you start the installation:

● A Dell PowerEdge 1950 server. This model of server is equipped with:

- 2.33 GHz quad-core processor

- 2 GB system memory

- 670 watt hot-plug power supply

- Two SATA 7200 rpm, hot-plug, 250 GB hard disk drives with a RAID 1 controller

Note:Note: The disk drive for a new server is blank. If the server is in use, you must have

permission to wipe the disk clean before the installation starts.

- DVD/CD read-only disk drive

- 4 10/100/1000Base-T Ethernet Controllers, two on the onboard Network Interface Card (NIC) and two on the additional NIC

- 2 64-bit, 66/100 MHz PCI half-length slots

Note:Note: The SAMP card that was included with earlier versions of the AE Services

Bundled Server is not included with the AE Services 4.2 Bundled Server. An additional NIC in the Dell server provides the additional Ethernet interface. The AE Services 4.2 software is, however, backward-compatible with the x306 and x306m SAMP-equipped servers used in previous AE Services Bundled Server installations.

- Standard BIOS with Avaya splash screen and custom defaults

- Avaya-branded bezel and packaging

- 4-post sliding rail kit

● USB modem, required for remote technical support

● The Application Enablement Services installation DVD for the Bundled Server

Hardware Requirements


Requirements for the AE Services software only server

AE Services software only offer requires a customer-provided server with the following minimum requirements:

● 3.0 GHz single-processor Pentium IV class processor with hyperthreading enabled

● 1GB RAM (system memory)

Note:Note: Customers who require 10,000 simultaneous Sametime users or a sustained

processing rate of 720 TSAPI messages per second require 2 GB of RAM.

● 10 GB free disk space, after installing Linux

Note:Note: If you choose to set up the /var directory as a separate file system to improve

reliability, Avaya recommends that you use at least 10 GB for the /var partition.

● Hard disk drive with at least 7200 rpm rating

● 512 KB L2 cache

● 100 BaseT Ethernet dual NIC, must be set to full duplex

Communication Manager and media serversTo use AE Services Release 4.2, you must have the official Avaya Communication Manager Release 3.x, 4.x, or 5.x software running on an IP-enabled media server.



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 4.2 RFA license file.

● You must obtain IBM licenses from IBM.

Phone number requirementsPhone 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 downloadsYou 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.


Chapter 3: Installing and Configuring the AE Services Integration forIBM 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 Installing and Configuring Lotus Domino and Sametime on page 97. (Table 6 summarizes the tasks in Appendix A). After you have completed these tasks, proceed with Testing Sametime on page 37

● If you already have these components in place, proceed with Testing Sametime on page 37.

● After you have completed Testing Sametime on page 37, continue with the tasks in Table 7: Checklist for integrating AE Services with IBM Sametime on page 38.

Table 6: 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 Installing Lotus Domino on page 99.

2 Set up the IBM Lotus Domino server

Sametime Server See Setting up the Domino server on page 100.

3 Install Lotus Notes with the Domino Admin client feature.

Sametime Server See Installing the Domino Admin client files on page 111.

4 Set up the Domino Admin account.

Sametime Server See Setting up the Domino Admin account on page 114.

5 Install the Sametime server.

Sametime Server See Installing the Sametime Server on page 118.

Chapter 3: Installing and Configuring the AE Services Integration for IBM Lotus Sametime


6 Enable Telephony Conferencing.

Sametime Server See Enabling Telephony Conferencing on page 127.

7 Configure the classpath for the Sametime server.

Sametime Server See Determining if the Sametime Server can find the JRE on page 127.

Table 6: 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

Testing Sametime


Testing SametimeUse 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 services application.

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.

http://www.java.com



AE Services Integration for IBM Sametime - checklistUse the checklist in Table 7 for integrating AE Services with IBM Lotus Sametime.

Table 7: Checklist for integrating AE Services with IBM Sametime

Task Admin domain Document or location in this document

1 Install Sametime Connect Client.

Sametime Server See Setting up the IBM Sametime Connect clients on page 41.

2 Install Extended Status Feature and Telephony Status Feature Plug-ins.

Sametime Server See Setting up the IBM Sametime Connect clients on page 41.

3 Administer the Sametime Server for integration with AE Services.

Sametime Server See Editing the avaya-aes-sametime.properties file on page 51.

4 Administer a CTI link (ADJ-IP).


See "Administering a CTI Link for TSAPI, JTAPI, Telephony Web Service, and Device, Media, and Call Control " in Chapter 1 of the AE Services Administration and Maintenance Guide, 02-300357.

5 Check the status of the switch connection (from Communication Manger to AE Services).


See "Checking the status of a Switch Connection -- from Communication Manager" in Chapter 1 of the AE Services Administration and Maintenance Guide, 02-300357.

6 Administer a switch connection from AE Services to Communication Manager.

AE Services See "Administering the Local IP for all AE Services" in Chapter 2 of the AE Services Administration and Maintenance Guide, 02-300357.

7 Check the status of the switch connection (from AE Services to Communication Manager).

AE Services See "Checking the status of a switch connection -- from the AE Server" in Chapter 2 of the AE Services Administration and Maintenance Guide, 02-300357.

1 of 3

AE Services Integration for IBM Sametime - checklist


8 Administer an encrypted TSAPI Link.

AE Services See "Administering TSAPI Links in AE Services OAM" in Chapter 2 of the AE 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.

9 Verify that DMCC Server port 4722 is enabled (the default setting). This port is used for secure communication.

AE Services In AE Services OAM, on the Ports page, make sure the setting for DMCC Server Ports, Encrypted Port is enabled (Administration > Network Configuration > Ports).

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.

AE Services (User Management)

See Administering the Security Database in AE Services OAM on page 60.

11 Administer settings for the dial plan.

AE Services (CTI OAM Administration)

See Chapter 4: Administering Dial Plan Settings on page 69.

Table 7: Checklist for integrating AE Services with IBM Sametime (continued)


2 of 3



12 Configure the Sametime Connect Client.

IBM Sametime Connect Client

See Lotus Sametime 8.0 Connect Client User Guide.

13 Test the configuration. IBM Sametime Connect Client

See Testing the Configuration on page 63.

Table 7: Checklist for integrating AE Services with IBM Sametime (continued)


3 of 3

Setting up the IBM Sametime Connect clients


Setting up the IBM Sametime Connect clientsFollow 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.

Download and install IBM Sametime Connect

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 Sametime V8.0 Software Development Kit (SDK), and 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 (com.ibm.collaboration.realtime.status.ext_8.0.0)

● Telephony Status Feature (com.ibm.collaboration.realtime.telephony.status_8.0.0)

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 "Adding optional features to the client after install" in Chapter 8 of the Sametime Entry Version 8.0 Installation and Administration Guide.

http://www.ibm.com/developerworks/lotus/downloads/toolkits.html

http://www.ibm.com/us/



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 extracts a zip file containing the Avaya Conference and Presence Services into the Domino 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 43

● Editing the AE Services property files on the Sametime Server on page 49

● Administering the Security Database in AE Services OAM on page 60

● Testing the Configuration on page 63

Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server


Installing the AE Services Integration for IBM LotusSametime on the Sametime Server

! WARNING:!

WARNING: The AE Services Integration for IBM Lotus Sametime, Version 1.0 is not compatible with the Avaya Meeting Exchange for IBM Lotus Notes and Sametime. If you are already using the Meeting Exchange integration, discontinue this installation.

For its initial release, the AE Services Integration for IBM Lotus Sametime does not provide an installation program. To install the AE Services Integration for IBM Lotus Sametime on the Sametime Server, follow these steps.

1. Stop the Sametime Server.

2. Determine if you have an existing telephony extensions folder (telephony_ext). If you do, then back up the folder by moving and renaming it.

For example, go to the C:\Program Files\IBM\Lotus\Domino directory, and check for the telephony_ext folder. If you find the folder, then move and rename it:

● move telephony_ext telephony_ext_orig3. Determine if you have existing conference manager and diagnostic properties files:

(ConferenceManager.properties and SametimeDiagnostics_Telephony.properties). If you do, then back up the properties files by moving them to the backup directory you just created (telephony_ext_orig).

For example, go to the C:\Program Files\IBM\Lotus\Domino directory, and check for ConferenceManager.properties and SametimeDiagnostics_Telephony.properties). If you find the files, then move them to the telephony_ext_orig directory:

● move ConferenceManager.properties telephony_ext_orig● move SametimeDiagnostics_Telephony.properties telephony_ext_orig

4. Download the integration file, avaya-aes-sametime-x.y.z.zip, file to the Sametime server, and save it to the top-level Domino directory. Note that avaya-aes-sametime-x.y.z.zip refers to the file naming convention (where avaya-aes-sametime is a literal; and x is the major version, y is the minor version, and z is the build number). For example: avaya-aes-sametime-1.0.0.zip.

5. Right-click the zip file, and select WinZip > Extract to here (the Domino directory).

6. Winzip extracts the contents of the zip file in to the Domino directory and a subdirectory named "telephony_ext."



7. After extracting the integration package into the Domino folder, move the ConferenceManager.properties file and the SametimeDiagnostics_Telephony.properties file from the telephony_ext folder to the Domino folder. If there are existing copies of those two files in the Domino folder, make back-up copies of them before you overwrite them with the ConferenceManager.properties and the SametimeDiagnostics_Telephony.properties file from the telephony_ext folder.

8. Change to the telephony_ext\presence\bin directory and execute install-service.bat. This installs the Presence Service as a Windows service.

9. To verify that the Presence Service was successfully installed, select Administrative Tools > Services and confirm that Avaya Telephony Presence Service appears in the list of services.

Note:Note: The installation technician (administrator) must ensure that the Presence Service

has permission to write to telephony_ext\presence\logs in the Domino directory. If the Local System account does not have permission to write to that directory, the installation technician can correct that by going to Start > Administrative Tools > Services. Then select Avaya Telephony Presence Service > Properties > Log On and enter the name and password of an account that has permission to write to telephony_ext\presence\logs.

Installing the AE Services Integration for IBM Lotus Sametime on the Sametime Server


Figure 8: Installing and configuring AE Services on the Sametime server

If these property files exist from an

Extract the avaya-aes-sametime-x.y.z.zip file,which creates telephony_ext.

installation of Avaya Meeting Exchange make backup copies of them(They will be overwritten when youmove the AE Services versions of these configuration files to theDomino Directory.)

avaya-aes-sametime.zipDomino Directory

Move ConferenceManager.properties andSametimeDiagnostics_Telephony.properties to the Domino directory.

Sametime Server

telephony_ext

avaya-aes-sametime.jar

ConferenceManager.properties

LICENSE.txt

SametimeDiagnostics_Telephony.properties

TelephonyService.jar

bin

lib

presence

aes-tester.batsametime-751-registry-configure.exeldap-tester.bat

bininstall-service.batpause-service.batresume-service.batstart-service.batstop-service.batuninstall-service.batwrapper.confwrapper.exe

ConferenceManager.propertiesSametimeDiagnostics_Telephony.properties

logsresourcesavaya.jksavaya-aes-sametime.propertieslogging.propertiesst.telephony.adapter.properties

avaya-aes-sametime.zip

telephony_ext

avaya-aes-sametime.jar

ConferenceManager.properties

LICENSE.txt

SametimeDiagnostics_Telephony.properties

TelephonyService.jar

bin

lib

presence

aes-tester.batsametime-751-registry-configure.exeldap-tester.bat

bininstall-service.batpause-service.batresume-service.batstart-service.batstop-service.batuninstall-service.batwrapper.confwrapper.exe

ConferenceManager.propertiesSametimeDiagnostics_Telephony.properties

logsresourcesavaya.jksavaya-aes-sametime.propertieslogging.propertiesst.telephony.adapter.properties

Edit the

Domino Directory

\telephony_ext\resources\avaya-aes-sametime.properties file.



Setting up the IBM Lotus Sametime ServerRead through this lists of tasks to determine the tasks that you need complete.

● (Optional) If your enterprise has a large number of users, see Increasing memory available to the JVM for IBM Lotus Sametime on page 46

● (Optional) If you are integrating AE Services with IBM Lotus Sametime 7.5.1, see Executing AE Services integration utility for IBM Sametime 7.5.1 on page 47

● (Optional) if you are using secure LDAP (LDAPS), see Setting up a keystore and importing a trusted certificate on page 48

● (Required) For information about which property files you need to edit, see Editing the AE Services property files on the Sametime Server on page 49.

Increasing memory available to the JVM for IBM Lotus Sametime If your enterprise has a large number of users (for example if you anticipate up to 10,00 Domino users, or a BHCC of 12,000), its is likely that the Java Virtual Machine (JVM) will consume more memory than it has available. To avoid this condition, set the memory for the JVM at I GB (1024M) on the IBM Lotus Sametime Server.

Follow these steps to set the memory for the JVM to 1 GB.

1. On the IBM Lotus Sametime Server, click Start > Run > Regedit and press Enter.2. From My Computer, select HKEY_LOCAL_MACHINE > SOFTWARE > Lotus >

Sametime > Meeting Server > Services. In the right pane double-click VMArguments.

3. From the Edit String window, under Value data, move your cursor to the beginning of the string. The string in the Value data box will appear similar to this example:

./ibm-jre/bin/classic/jvm.dll -Xmx 1024MThe value in this example, 1024, is equivalent to 1 GB. If you see a value less than 1024, for example 512M, change the setting to 1024M.

Setting up the IBM Lotus Sametime Server


Executing AE Services integration utility for IBM Sametime 7.5.1For AE Services integrations with IBM Lotus Sametime 7.5.1, you must install the AE Services integration utility for IBM Sametime 7.5.1 (sametime-751-registry-configure.exe), which is located in telephony_ext\resources\properties.

Requirements for running this utility

The following software must be installed on your Sametime Server:

● The .NET Framework (2.0)

● A 1.5.x JDK (JDK, not JRE)

Running the AE Services integration utility

When you run this utility, it updates the registry on the server so that sttelephonyservice.exe (but no other programs) run using the 1.5.x JDK.

Also, the %PATH% for the Telephony Service will have to contain the path to the 1.5.x java.exe, not to the IBM 1.4.2 java.exe.



Setting up a keystore and importing a trusted certificate If you are using secure LDAP (LDAPS) you must carry out the following tasks:

● Import a trusted certificate to the keystore on the Sametime Server - see Importing a trusted certificate into the Java keystore on page 48

● Administer the certificate on the AE Server or the LDAPS server - see Administering certificates on the AE Server or the LDAPS server on page 48

You can use the keystore that is provided by AE Services when you install the AE Services integration software (avaya-aes-sametime-x.y.z.zip) or you can create your own keystore (also referred to as trust store).

If you are using the default AE Services keystore the password is "password," and the location of the keystore is in telephony_ext/resources/avaya.jks.

! SECURITY ALERT:!

SECURITY ALERT: Be sure to change the default password immediately after using it.

Importing a trusted certificate into the Java keystore

To import the trusted CA certificate into your keystore (Sametime Avaya client keystore), use the keytool utility with the -import and -trustcacerts commands (you will need to specify your keystore password). For example:

keytool -import -trustcacerts -keystore <myKeystore>.jks -file CACert.crtThe filename you specify with the -keystore flag will be the file used as the keystore. If the file exists, keytool will attempt to add the certificate to the store. If the file does not exist a new keystore will be created with the file name specified by the -keystore flag.

Administering certificates on the AE Server or the LDAPS server

After you import a trusted certificate into the Java keystore, you must carry out the following tasks on the AE Server or the LDAPS server, depending on your configuration.

● Import the CA certificate

● Create a server certificate

If you are using the AE Server, see Chapter 9: Certificate Management in the AE Services Administration and Maintenance Guide, 02-300357, for information about importing and creating certificates.

If you are using an LDAPS Server see the documentation for your LDAPS server for information about importing and creating certificates.

Editing the AE Services property files on the Sametime Server



Setting up the AE Services Integration for IBM Sametime involves editing the property files that AE Services installs on the Sametime server. Read through the following list to determine which tasks you need to carry out.

● (Optional) If you are not familiar with editing property files, see Tips for editing the property files on page 49

● (Optional) If your configuration includes a Sametime server at Release 7.5.1, see Editing the st.telephony.adapter.properties file on page 50

● (Optional) You can accept the default conference size limit. For more information, see About the ConferenceManager.properties file on page 50

● (Required) To effect the integration you must edit the avaya-aes-sametime.properties file. For information about editing this file, see Editing the avaya-aes-sametime.properties file on page 51

Tips for editing the property filesEditing property files is relatively simple and straightforward (all property files end with the extension .properties). You can edit these files with a text editor such as Wordpad.

All property files are text files that contain properties (or settings). Additionally these property files contain usage tips and examples to help you edit the property settings in the files.

Notice that the pound or sharp sign (#) is used as a comment tag. Lines that begin with the comment tag are not processed as coding statements.

● All usage tips are preceded by the comment tag. For example:

● Optional coding statements are preceded by a comment tag, for example:

- Do not make any changes to commented-out properties unless you plan to use them.

#The name of the Sametime user account on AE Services.

#avaya.aes.sametime.cmapi.server_port=4722

#avaya.aes.sametime.cmapi.trust_store_password=



- When you want to use an optional properties statement, you will need to delete the comment tag, and, in most cases, enter a value for the property. For example:

Editing the st.telephony.adapter.properties file If your configuration includes a Sametime server at Release 7.5.1 you will need to edit the st.telephony.adapter.properties file by removing the comment tag and changing the value of the passive.users.supported property from true to false, as indicated in the following example.

If all of the Sametime Servers in your community are 8.0, or later, you do not need to make this change. Use the default setting (passive.users.supported = true).

About the ConferenceManager.properties fileYou do not need to change any of the settings in the ConferenceManager.properties file. By default the conference size limit is set to 6, which is the maximum value. If you want to change the value of the MaximumConferenceUser property, you must use the range of values from 2 to 6.

avaya.aes.sametime.cmapi.trust_store_password=Tspassw0rd

################################ description - Does the connected Sametime server support passive users # (attribute for offline users), should be true for Sametime server version 8.0 and above # value - true or false# default - true###############################passive.users.supported = false

ConferenceServiceClass=com.avaya.sametime.click2call.tcspi.ConferenceServiceMaximumConferenceUsers=6ClientIdEnabled=falseClientIdRequired=falseClientIdMutable=falseClientPasswordEnabled=falseClientPasswordRequired=falseClientPasswordMutable=trueDynamicConferencesEnabled=trueStaticConferenceEnabled=false



Editing the avaya-aes-sametime.properties fileYou will need to edit the avaya-aes-sametime.properties file to set the AE Server and LDAP configuration properties and to enable LDAP for Domino.

The avaya-aes-sametime.properties file is a relatively large file, but it can be broken down into the following groups of properties.

● AE Services Properties (Settings used to connect to the AE Server). For information about editing these properties, see AE Services properties on page 52.

● LDAP Properties, which can be broken down into the following groups:

- Connectivity -- For information about editing these properties, see LDAP Properties -- Connectivity on page 54.

- Queries -- For information about editing these properties, see LDAP Properties -- Queries on page 55.

● Shared Properties - For information about editing these properties, see Properties used by both AE Services and LDAP on page 53.

Note:Note: If you are not familiar with editing property files, see Tips for editing the property

files on page 49.

To view the contents of the avaya-aes-sametime.properties file, see Example 1: avaya-aes-sametime.properties file.



AE Services properties

● avaya.aes.sametime.cmapi.username

The value of this property is the name of the user account that logs on the AE Server. The user will have been added using the User Management OAM page on the AE Server.

Example and usage tip: Username is also referred to as account name, user ID, or login ID. For example: aesametime1. See Administering the Security Database in AE Services OAM on page 60.

● avaya.aes.sametime.cmapi.password

The value of this property is the password for logging in to the AE Server.

Example and usage tip: Create a password. The default User Management password policy, which is based on a US standard keyboard, calls for a minimum of 8 characters, including a minimum of 1 upper case, 1 lower case, 1 alphanumeric, and 1 special character. The following characters are not permitted: $ (dollar sign), ’ (apostrophe), " (quotation mark), \ (backslash), the space character, and any ASCII control-character.

● avaya.aes.sametime.cmapi.server_ip

The value of this property is the DNS name or IP address of the AE Server.

Example and usage tip: Use nslookup to make sure that the IP address resolves to the DNS name (or that the DNS name resolves to the IP address).

● avaya.aes.sametime.cmapi.server_port

The value of this property is the port number on the AE Server that is used for IBM Lotus Sametime connections. The default value is 4722. Only change this property if you have changed the port on which the AE Server listens for SSL connections.

Example and usage tip: If you need to change this setting, use the Ports page in AE Services OAM (Administration > Network Configuration > Ports).



Properties used by both AE Services and LDAP

● avaya.aes.sametime.trust_store_location

The value of this property is the name of a Java keystore in the resources directory to be used to authenticate the AE Server's certificate. It has no default value and is commented out by default. Set this property only if you have installed your own certificate on the AE Server. If you have installed your own certificate on the AE Server, the file specified by this property must contain a trusted Entry for the Certificate Authority (CA) that signed the AE Server’s certificate. Use this property only if you are using your own public key infrastructure system.

Usage tip: Change this field only if you are using your own PKI or are using LDAPS. See Setting up a keystore and importing a trusted certificate on page 48.

● avaya.aes.sametime.trust_store_password

The value of this property is the password of the Java keystore specified by the preceding property. If the preceding property is set, this property is mandatory, and you will need to create a Java keystore password. Otherwise, it is unnecessary.

Usage tip: This password can be any password you choose to create. It does not need to conform to the User Management password rules.

Running aes-tester

After you have entered your AE Services settings in the avaya-aes-sametime.properties file, you can verify them by running the aes-tester, which is located as follows: telephony_ext\bin\aes-tester.bat. Run aesteter.bat in cmd.exe.



LDAP Properties -- Connectivity

See Configuring Sametime directories and setting up the LDAP properties in the Avaya configuration properties file on page 25, for more information about specifying the LDAP connectivity properties.

● avaya.aes.sametime.ldap.url

The value of this property is the URL of the LDAP server, which consists of the host name of the server, the port number on which the server listens, and whether to use SSL. Example values follow.

- No SSL, default port number

ldap://ldap.example.com

- No SSL, non-default port number

ldap://ldap.example.org:7780

- SSL, default port number

ldaps://ldap.example.net

● avaya.aes.sametime.ldap.admin_dn

The value of this property is the distinguished name (DN) of the user that logs into the LDAP server in order to execute the queries necessary to (1) discover the telephone number of a user or (2) discover the set of users whose telephones will provide telephony presence information (e.g., on a call, not on a call) to the Sametime server. Example values follow.

- A distinguished name with common name "Manager" and domain components "example" and "org."

cn=Manager,dc=example,dc=org

- A distinguished name with common names "Administrator" and "emea" and domain components "example" and "com."

cn=Admin,cn=emea,dc=example,dc=com

● avaya.aes.sametime.ldap.admin_password

The value of this property is the password with which to login to the LDAP server in order to execute queries. No examples are provided.



LDAP Properties -- Queries

● avaya.aes.sametime.ldap.base_search_dn

The value of this property is the base distinguished name with which to perform LDAP queries (such as a query for the telephone number of a particular user or for the names of users whose telephones will provide telephony presence to the Sametime server). See DN entries and scope of search on page 28 for more information about the significance of this property. This property is used by both the Conference Service and the Presence Service. Example values follow.

- The base distinguished name for queries is the common name "emea" and the domain components "example" and "org."

cn=emea,dc=example, dc=org

- The base distinguished name for queries is the common names "fr" and "emea" and the domain components "example" and "com."

cn=fr,cn=emea,dc=example,dc=com

● avaya.aes.sametime.ldap.telephone_number_attr

The value of this property is the name of the attribute for a person's office telephone number in the directory. This property is used by both the Conference Service and the Presence Service. An example value follows.

- The attribute of a person's office telephone number in the directory is "telephonenumber."

telephonenumber

● avaya.aes.sametime.ldap.user_attr

The value of this property is the name of the attribute for a person's name in the directory. This property is used by both the Conference Service and the Presence Service. An example value follows.

- The attribute of a person's name is "cn."

cn



LDAP Properties -- Queries, continued

● avaya.aes.sametime.ldap.users_attr_value

The values of these properties are the names of an attribute and a value to be used in a query for discovering the names of all users whose telephones will provide telephony presence to the Sametime server. They are used to build an expression of the form attribute=value. This property is used only by the Presence Service. Without this query, the Presence Service will not be able to discover the names of the users whose telephones provide telephony presence to the Sametime server. Example values follow.

- The name of the attribute is "objectclass" and the value is "person." When qualified with the base distinguished name of the base_search_dn property, the expression "objectclass=person" denotes all persons who fall under that distinguished name. If this category encompasses more than just the users whose telephones will provide telephony presence, then you must use a more refined pair of attribute and value for this query.

● objectclass

● person

- The name of the attribute is "sametimePresence" and the value is "true." Unlike the previous example, this example would likely require that you modify your directory's schema.

● sametimePresence

● true

- The name of the attribute is "sametimeServer" and the value is "stserver1.example.org." This example would also likely require that you modify your directory's schema. In an environment with multiple Sametime servers, this use of this attribute/value pair would allow you to identify exactly which instances of the Presence Service would be responsible for publishing telephony presence for which users.

● sametimeServer

● stserver1.example.org



LDAP Properties -- Updating E.164 phone numbers in your directory

Customers whose phone numbers are not already stored in E.164 format in their directory may have a large number of users, making it tedious and inefficient to update the phone numbers manually. Most LDAP servers have tools for performing batch modifications, usually using the LDAP Interchange Format (LDIF). For example, you can modify the contents of an Active Directory server using the Microsoft ldifde program. As another example, if the server is IBM Lotus Domino, you can either use a tool such as the OpenLDAP ldapmodify command or write an agent in LotusScript and execute it using Domino Designer.

Running ldap-tester

After you have entered your LDAP settings in the avaya-aes-sametime.properties file, you can verify them by running the ldap tester, which is located as follows: telephony_ext\bin\ldap-tester.bat. Run ldap-tester.bat in cmd.exe.

Adding users to your LDAP store and restarting the Conference Service and Presence Service

If a user is added to the LDAP store after the Presence Service is started, the Presence Service will become aware of that user the next time the Presence Service is restarted. (The Conference Service will automatically discover new users.) Also, if a user's phone number in the LDAP store changes, the Presence Service will become aware of the change after it is restarted; the Conference Service will automatically discover the changed telephone number.



Example 1: avaya-aes-sametime.properties file

################################################################################ The name of the Sametime user account on AE Services.###############################################################################avaya.aes.sametime.cmapi.username=

################################################################################ The password of the Sametime user account on AE Services.###############################################################################avaya.aes.sametime.cmapi.password=

################################################################################ The FQDN of the AE Services server.###############################################################################avaya.aes.sametime.cmapi.server_ip=

################################################################################ The TLS port on AE Services.################################################################################avaya.aes.sametime.cmapi.server_port=4722

################################################################################ The path to the Java Key Store used to establish trust with AE Services and # for LDAP-S. The file should be placed in the resource directory (i.e. the # same directory as this properties file).################################################################################avaya.aes.sametime.trust_store_location=avaya.jks

################################################################################ The password of the Java Key Store used to establish trust with AE Services# and for LDAP-S ################################################################################avaya.aes.sametime.trust_store_password=

################################################################################ The URL of the LDAP server. Examples: ldap://hostname.example.com,# ldaps://hostname.example.com###############################################################################avaya.aes.sametime.ldap.url=



Example 1, continued : avaya-aes-sametime.properties file

################################################################################ The name of the user to login as on the LDAP server.# Example: cn=sametime admin,dc=example,dc=com###############################################################################avaya.aes.sametime.ldap.admin_dn=

################################################################################ The password with which to login on the LDAP server.###############################################################################avaya.aes.sametime.ldap.admin_password=

################################################################################ The base Distinguished Name (dn) to use for directory searches.# Example: dc=example,dc=com###############################################################################avaya.aes.sametime.ldap.base_search_dn=

################################################################################ The attribute of a user's office phone in directory.# Example: telephonenumber###############################################################################avaya.aes.sametime.ldap.telephone_number_attr=telephonenumber

################################################################################ The attribute of a user's name in directory. Used by the Conference Service.# Examples:# For domino: dn# For Active Directory: dn###############################################################################avaya.aes.sametime.ldap.conference.user_attr=dn

################################################################################ The attribute of a user's name in directory. Used by the Presence Service.# Examples:# For domino: uid# For Active Directory: dn###############################################################################avaya.aes.sametime.ldap.presence.user_attr=dn

################################################################################ The attribute used for retrieving all Sametime users from directory. Used# by the Presence Service.# Example: objectclass###############################################################################avaya.aes.sametime.ldap.users_attr=objectclass

################################################################################ The attribute value used for retrieving all Sametime users from directory.# Used by the Presence Service.# Example: person###############################################################################avaya.aes.sametime.ldap.users_attr_value=person



Administering the Security Database in AE Services OAMIf the AE Services Security Database (SDB) is enabled, the AE Services administrator will need to set up a CTI user for the Sametime account and grant that user unrestricted privileges.

Note:Note: This is the account that will be added to the avaya-aes-sametime.properties file

on the Sametime server. Make sure that the user denoted by the property avaya.aes.sametime.cmapi_username can be authenticated by AE Services.

Follow this procedure to set up a CTI user for the Sametime account:

1. Log in to AE Services OAM

2. From the OAM main menu, select User Management > Add User.OAM displays the Add User page.

3. Complete following fields (the required fields are marked with an asterisk) for the user you are adding.

a. In the User id field, type the user_id you are assigning to the user (aesametime1, for example).

A user ID (also referred to as a or login id, a user name, or an account name) is a sequence of valid characters. The maximum number of characters is 32. Valid characters are as follows: lowercase a through z, uppercase A through Z, numbers 0 through 9, dash (-), and underscore (_). No other characters are permitted, including the space character or any ASCII control-character.

b. In the Common Name field, enter a common name for the application, for example aesametime1.

c. In the Surname field, type a surname (aesametime1, for example).

d. In the User Password field type the password you are assigning to application.

The default User Management password policy, which is based on a US standard keyboard, calls for a minimum of 8 characters, including a minimum of 1 upper case, 1 lower case, 1 alphanumeric, and 1 special character. The following characters are not permitted: $ (dollar sign), ’ (apostrophe), " (quotation mark), \ (backslash), the space character, and any ASCII control-character.

e. In the Confirm Password field, re-type the assigned password.

f. In the CT User field select yes.

4. Click Apply.

OAM displays the Add User Results page with the following message: User created successfully!



5. From the CTI OAM main menu, select Administration > Security Database > CTI Users > List All Users.

OAM displays the CTI Users page.

6. From the CTI Users page select aesametime1, and click Edit.OAM displays the Edit CTI User page.

7. On the Edit CTI User page, click Enable, to enable unrestricted access.

AE Services OAM displays the Apply Changes to CTI User Properties page, which prompts you to confirm that you want to apply the changes.

8. Click Apply .AE Services OAM puts applies the change to the aesametime1 account.

Sametime Application AccountAn administrator must ensure that the user denoted by the property avaya.aes.sametime.cmapi_username can be authenticated by AE Services.

Setting up the dial planThe AE Services administrator needs to set up the dial plan with conversion rules for each switch in the environment. When setting up the dial plan for the AE Services Integration for IBM Lotus Sametime, you administer From TelURI settings only, you do not administer To TelURI settings.

For information about setting up a dial plan, see Chapter 4: Administering Dial Plan Settings on page 69.



Configuring the Sametime client Configuring the Sametime client refers to making sure that all phone numbers are in E.164 format and setting the preferred device (Setting your geographic location).

Make sure all phone numbers are in E.164 format:

1. Go to File > Preferences > Telephony, Audio, and Video > Preferred Numbers to change your phone numbers.

2. Set your Geographic Location (File > Preferences > Telephony, Audio, and Video > Routing Rules) so that your preferred device does not switch back to Computer, which will prevent you from being able to make calls via Application Enablement Services.

Note:Note: Because Sametime Connect 7.5.1 strips the leading plus sign from an E.164

number, the Conference Service compensates by adding a plus sign if it is missing. The number or numbers that users enter into the Preferred Numbers in Sametime Connect, however, should still be valid E.164 numbers, even if they do not have the leading plus sign. This also applies to numbers entered manually in the "Type a name or phone number" input field in Sametime Connect. The numbers entered there must be valid E.164 numbers, even if they are missing the leading plus sign.

Testing the Configuration


Testing the ConfigurationFollow these steps to test a configuration of the AE Services Integration for IBM Lotus Sametime.

1. Start the Sametime server.

2. Start Sametime Connect on two computers (referred to as C1 and C2 in this example).

3. If you do not see phone icons next to the users in your contact list, then installing the telephony presence Eclipse plug-ins was not successful. If there was an error installing the plug-ins, you may have to go to Tools > Plug-ins > Manage Plug-ins, uninstall the Extended Status Feature and Telephony Status Feature plug-ins, then restart Sametime Connect and reinstall the plug-ins.

4. Open a terminal and, in telephony_ext\presence\bin, run wrapper.exe wrapper.conf. This will run the Telephony Presence Service in the foreground. The log level can be controlled via logging.properties in telephony_ext\resources. (Note: if you rebooted the Domino server after installing the Telephony Presence Service, it will already be running as a service. Go to the Windows Service Controller and stop the service before performing this step.)

5. Make a manual call (using the keypad on a phone, not Sametime Connect) from the device that belongs to the Sametime user logged in on computer C1.

● If you do not see that user's phone icon go "off hook" after placing the call, then the Telephony Presence Service is not functioning correctly. Increase the logging level if there are not any obvious errors in telephony_ext\presence\logs\presence.log.0. (Note: ignore the exceptions about not finding the files in the mapping directory.) When the Telephony Presence Service is initialized successfully, you will see the message "The presence service is starting" followed some lines later by "The presence service started" in presence.log. Otherwise you will see the message "The presence service failed to start."

● If you do see that user's phone icon go "off hook," the configuration for the Telephony Presence Service is correct. Stop the service in your console using Ctrl-C. Then go to the Windows Service Controller, and start the Presence service.

6. Using Sametime Connect, make a call from the user on C1 to the user on C2.

● If the call does not succeed, there may be a configuration problem with the Conference Service or the LDAP store. Look at Trace\telephony_0.log for errors. The logging level for click-to-call is controlled via SametimeDiagnostics_Telephony.properties in the Domino directory. When the Conference Service is initialized successfully, you will see the message "The conference service is starting" followed some lines later by "The conference service started" in telephony_0.log. Otherwise you will see the message "The conference service failed to start."



Serviceability ConsiderationsFollow these instructions for setting up the SametimeDiagnostics_Telephony.properties file.

● Configuring Logging for the Avaya Conference ServiceUse the SametimeDiagnostics_Telephony.properties file in the Domino base directory to configure logging for the Conference Service.

● Configuring Logging for the Avaya Presence ServiceUse the logging.properties file in the telephony_ext\resources directory to configure logging for the Avaya Presence Service.

Authentication of moderator and participants phone numbers

This section describes how AE Services handles discrepancies between device numbers in the Sametime Connect Location profile and the E.164 number in the directory.

Authentication of Moderator's E.164 Number

If the phone number of the moderator's currently-selected device in the Sametime Connect Location Profile is not the same as their E.164 number in the Directory, no calls will be made and the moderator will see a pop-up message: "Cannot control the phone [ non-directory number ], so no calls were made."

Note:Note: This is done to ensure that it is possible to control the device (e.g., use as the

source device for a MakeCall operation) and that the moderator is authorized to control it.

Authentication of Participant's E.164 Number

If the phone number of a participant's currently-selected device in the Sametime Connect Location Profile is not the same as their E.164 number in the Directory, no call is made to either number, and the participant will see a pop-up message:

"Cannot complete the request. Your currently-selected device is [ on-switch non-directory number ] but you are only authorized to control [ directory number ]."

"How it works"-- using the Lotus Sametime Connect client


"How it works"-- using the Lotus Sametime Connect clientWith Sametime Connect you can use the following methods to perform click-to-call or click-to-conference.

● Scenario 1: Using a user name: Right-click on a user name, Jan Green, for example and select Call from the right-click menu.

Result: If the other user is online and using Lotus Sametime Connect 7.5.1, or later, and their client is configured to display a notification for an incoming call (File > Preferences > Notifications > Display incoming notification), they will receive an Invite to Call dialog, which asks them to join the call. If the user is offline, or they are using an older client, their phone will ring (they will not receive an alert dialog).

In terms of the AE Services Integration for IBM Lotus Sametime, user names are "tagged or sensitized" for presence (they are LiveNames in the Lotus lexicon). When you right-click a user name, you have the ability to start a call, open a chat session, start a meeting, or send them email. Live Names are common to other Lotus products, such as Lotus Notes. The presence of a "live" user name in other Lotus products gives users access to the click-to-call and telephony presence features of the AE Services Integration for IBM Lotus Sametime.

● Scenario 2: Using the contact list: Select a user name, or a group name, and then continue with any of the following methods:

- Right-click your mouse. From the right-click menu, select Call - Click the telephone icon in the toolbar - Select Tools > Invite to Call

The other people will be invited to the call as described in the results of scenario 1.

● If you use Tools > Invite to Call, the Invite to Call dialog will appear before anyone is invited to the call.

● If you use the right-click or the telephone icon, the Invite to Call dialog will not appear unless you need to specify a telephone number for one or more people you wish to call.

● Scenario 3: Using a 2-way or an "n-way" chat window: Either click on the telephone icon in the toolbar, or select Tools > Invite to Call (for telephone calls only). This will start a call between everyone who is already in the chat.

● Scenario 4: From the QuickFind field … : Type a telephone number or contact name to quickly start a telephone call to that number or person. This feature is new for Lotus Sametime Connect 8.0.



Initiating a Call or Conference from Contact List

When a user selects a user or users (up to 6), in their contact list and then does one of the following, a call or conference is initiated:

● Right-clicks and selects Call. ● Clicks the phone icon above the contact list.

● Uses the Tools > Invite to Call menu.

Initiating a Call or Conference from Chat Window

When a user does one of the following in a chat window, a call or conference is initiated:

● Clicks the phone icon● Uses the Tools > Invite to Call menu

Restarting a Two-Party Call

After either party (moderator or participant) of a two-party call hangs up, if either party clicks the Join Call button in the call window, the call will be initiated again from the moderator's device to the participant's device.

About conferencing and Sametime client configuration

The Sametime Connect client can be configured to do either of the following:

● accept an invitation to a call or to conference automatically at the currently-selected device

● prompt the user whether to accept the call and, if so, at which device

Note:Note: The Sametime Connect interface does not provide a mechanism for answering a

call. Accepting an invitation to a call or accepting a conference at some device simply causes that device to be called.

Once the invitation has been accepted, a call window will pop up on the user's desktop. Each participant is listed in the call window, along with the participant's status. The moderator's call window provides the ability to disconnect and reconnect users. The participant's window does not provide that capability.

"How it works"-- using the Lotus Sametime Connect client


User name and call window states

A user in a call window will appear in one of the following states:

● Waiting for Response

● Connecting

● Connected

● Disconnected

● Call Window Closed (Connected)

● Call Window Closed (Disconnected)



Administering Dial Plan Settings in AE Services OAM


Chapter 4: Administering Dial Plan Settings

Administering Dial Plan Settings in AE Services OAMAE Services uses the information on the AE Services Operation, Administration, and Maintenance (OAM) Dial Plan pages to process phone numbers. AE Services OAM is the Web-based administrative interface for AE Services.

Before you begin Before you start the procedures to administer dial plan settings, make sure you are familiar with Tel URI formats and the dial plan conversion pages in OAM. Tel URI is an abbreviation for Telephony Uniform Resource Identifier, sometimes it is expressed as "TelURI."

● To familiarize yourself with Tel URI formats, see About Tel URI formats and device IDs on page 70.

● For information about using the OAM pages to create dial plan conversion rules for converting E.164 phone numbers to switch extensions and switch extensions to E.164 phone numbers, see About the From TelURI rules on page 70.

To complete the dial plan settings in AE Services OAM, you need to know how the dial plan is administered on Communication Manager. If you do not know what the dial plan settings are for a particular switch or set of switches, contact the Communication Manager administrator.



About Tel URI formats and device IDsAE Services supports E.164 numbers for device IDs. For an example of the E.164 format, see Table 8.

● Calling device and monitored device IDAE Services expects the calling device and monitored devices to be E.164 format.

● Called device IDCalled device IDs will be in E.164 format.

About the From TelURI rules The dial plan conversion pages ("Dial Plan Settings - Conversion Rules for Default" and "Dial Plan Settings - Conversion Rules - switchname") in AE Services OAM are used for setting up conversion rules for a switch connection.

For the AE Services Integration for IBM Lotus Sametime, To TelURI settings are not applicable. You administer the From TelURI settings only. The From TelURI settings enable AE Services to convert from a normalized TelURI number to an extension or dial string.

From TelURI operations

From TelURI: From TelURI settings are used to convert normalized TelURI numbers, arriving from the IBM Sametime Connect client, into dial strings. AE Services hands off the dial strings to the switch (Communication Manager).

Table 8: Tel URI formats supported by AE Services

Format Example

E.164 +13031234567

IBM SametimeConnect

AE Server CommunicationManagernormalized TelURI number

extension or dial string+13035381234

5381234

FromTelURI



Valid dial string characters and using the asterisk

For AE Services dial plan settings, valid dial string characters are: all digits (0-9), the number sign (#), and the asterisk (*).

The asterisk as a literal

If your dial plan uses the asterisk, and you need to configure a dial plan rule that detects the asterisk character, you must precede the asterisk with a backslash (\*). For example, if you need to have the asterisk interpreted as a literal asterisk in either the Matching Pattern field or the Replacement String Field of a From TelURI table, you must precede the asterisk with a backslash. If you do not precede the asterisk with a backslash, it will be interpreted as a wildcard value for any valid character.

The asterisk as a wildcard

When you want to use the asterisk as a wildcard for any character, you must use it as a single character (by itself). That is, when used as a wildcard, the asterisk can not be preceded or followed by any other character.



The From Tel URI table

The From TelURI table in OAM determines the way that AE Services processes inbound E.164 numbers. Generally speaking, AE Services applies matching criteria to the incoming number. When the number satisfies the matching criteria, AE Services manipulates the digits and provides the results to the requester (only one rule is applied for each number). When setting up the From TelURI settings, you can specify up to 200 rules. Each row in the table represents a rule. The rules are processed in order from top to bottom. If you have a rule that contains a wildcard (* - asterisk) for the Minimum Length, Maximum Length, and Pattern match, it always must be the last rule in the list, and it must be a single asterisk (by itself). If you need to treat the asterisk as a literal in either the Pattern Match or the Replacement fields, you must precede it with a backslash, for example: \* . Also, if your dial plan uses a number sign and you need to treat it as a literal in the Pattern Match field, you must precede it with a backslash.

Minimum Length Maximum Length Pattern Match Delete Length Replacement

11 11 1303538 4 (blank)1

1. Blank means the replacement field is empty.

11 11 1303 1 9

* * * 0 9011



From TelURI settings for fixed-length extensions

The following example demonstrates how to administer the From TelURI settings in OAM to support a dial plan for a switch using fixed-length-extensions. This switch supports three different extension prefixes: 538, 852, and 444. The 538 prefix is used for extensions hosted on that switch, and the other two prefixes are used for switches connected via QSIG.

Example - From TelURI rules for fixed-length extensions

The following table contains sample conversion rules.

How the From TelURI rules process numbers for fixed-length extensions


A 11 11 1303538 4 (blank)1


B 11 11 1732852 4 (blank)

C 11 11 1720444 4 (blank)

D 11 11 1303 1 9

E 11 11 1720 1 9

F 11 11 1 0 9

G * * * 0 9011

A AE Services receives +13035381234, an 11-digit number. Because the number is within the minimum and maximum length requirements, and the first 7 digits (1303538) are a pattern match, AE Services deletes the first 4 digits (1303) and does not prepend any digits.The resulting number is 5381234.

B AE Services receives +17328521234, an 11-digit number. Because the number is within the minimum and maximum length requirements, and the first 7 digits (1732852) are a pattern match, AE Services deletes the first 4 digits (1732) and does not prepend any digits. The resulting number is 8521234.

C AE Services receives +17204441234,an 11-digit number. Because the number is within the minimum and maximum length requirements, and the first 7 digits (1720444) are a pattern match, AE Services deletes the first 4 digits (1720) and does not prepend any digits. The resulting number is 4441234 to the switch.

D AE Services receives +13036791234, an 11-digit number. Because the number is within the minimum and maximum length requirements, and the first 4 digits (1303) are a pattern match, AE Services deletes the first digit (1), and prepends 9 to the number. The resulting number is 93036791234.



E AE Services receives +17202891234, an 11-digit number. Because the number is within the minimum and maximum length requirements, and the first 4 digits (1720) are a pattern match, AE Services deletes the first digit (1), replaces it with a 9. The resulting number is 97202891234.

F AE Services receives +18183891234, an 11-digit number. Because the number is within the minimum and maximum length requirements, and the first digit (1) is a pattern match, AE Services deletes no digits and prepends a 9 to the number. The resulting number is 918183891234.

G AE Services receives +4926892771234, a 13-digit number. Because the minimum length, maximum length, and pattern match are set up with the wild card, any number is permitted. AE Services deletes no digits and prepends 9011 to the number. The resulting number is 90114926892771234.



From TelURI settings for variable-length extensions

The following example demonstrates how to administer the From TelURI settings in AE Services OAM to support a dial plan that uses variable-length extensions. This example assumes the following:

● The customer owns numbers +49697100 through +49697105 in the dial plan, but does not own +49697106 and higher.

● The dial plan accommodates 1- to 4-digit extensions.● The ARS code is 0, the inter-region code is 0, and the international dial code is 00. The

ARS code, which in this case is 0, is always included before the inter-region code and international dial code.

Example - From TelURI rules for variable-length extensions

The following table contains sample conversion rules.


A 8 11 49697100 7 (blank)1


B 8 11 49697101 7 (blank)

C 8 11 49697102 7 (blank)

D 8 11 49697103 7 (blank)

E 8 11 49697104 7 (blank)

F 8 11 49697105 7 (blank)

G * * 4969 4 0

H * * 49 2 00

I 9 10 46357 6 \*8

J * * * 0 000



How the From TelURI rules process numbers for variable-length extensions

A AE Services receives +49697100, an 8-digit number. Because the number is within the minimum and maximum length requirements, and the number is an exact pattern match, AE Services deletes the first 7 digits (4969710) and does not prepend any digits to the number. The resulting number is 0.

B AE Services receives +49697101988, an 11-digit number. Because the number is within the minimum and maximum length requirements, and the first 8 digits (49697101) are a pattern match, AE Services deletes the first 7 digits and does not prepend any digits to the number. The resulting number is 1988.

C AE Services receives +4969710211, a 9-digit number. Because the number is within the minimum and maximum length requirements, and the first 8 digits (49697102) are a pattern match, AE Services deletes 7 digits and does not prepend any digits to the number. The resulting number is 211.

D AE Services receives +496971034, a 9-digit number. Because the number is within the minimum and maximum length requirements, and the first 8 digits (49697103) are a pattern match, AE Services deletes 7 digits and does not prepend any digits to the number. The resulting number is 34.

E AE Services receives +4969710494, a 10-digit number. Because the number is within the minimum and maximum length requirements, and the first 8 digits (49697104) are a pattern match, AE Services deletes 7 digits and does not prepend any digits to the number. The resulting number is 494.

F AE Services receives +4969710598, a 10-digit number. Because the number is within the minimum and maximum length requirements, and the first 8 digits (49697105) are a pattern match, AE Services deletes 7 digits and does not prepend any digits to the number. The resulting number is 598.

G AE Services receives +496971060, a 9-digit number. Because the wild card (*) permits a number of any length, and the first 4 digits (4969) are a pattern match, AE Services deletes the first 4 digits and prepends 0 to the number. The resulting number is 071060.

H AE Services receives +49306441234, an 11-digit number. Because the wild card (*) permits a number of any length, and the first 2 digits (49) are a pattern match, AE Services deletes the first 2 digits and prepends 00 to the number. The resulting number is 00306441234.

I AE Services receives +4635746262, a 10-digit number. Because the first 6 digits are a pattern match, AE Services deletes the first 6 digits and prepends *8 to the number.

J AE Services receives +17328521234, an 11 digit number. Because the minimum length, maximum length, and pattern match are set up with the wild card, any number is permitted. AE Services deletes no digits and prepends 000. The resulting number is 00017328521234.



Pattern matching -- using Pattern and RegEx (regular expressions)

You can use either of the following two methods of "analyzing" or "matching" dial plan strings.

Pattern

Use Pattern when you want to use a digit string as a way of detecting the presence of a specific sequence of digits in an incoming dial string. When you select Pattern you can create a matching string based on literal digits (0 through 9), one character literal (the #), and one special character, the asterisk (*) which will match any digit or sequence of digits. If you select Pattern, valid dial string characters are: all digits (0-9), the number sign (#), and the asterisk (*).

RegEx

RegEx - Use RegEx (regular expression) when you want to use a Java regular expression to analyze an incoming dial string. Regular expressions rely on symbolic notation - grouping of digits and special characters for analyzing incoming dial strings. For example, ([0-5]\\d{0,3}) is a regular expression which matches extensions that start with digits 0 - 5, and are 1 to 4 digits in length.

You can mix rule types : A From the TelURI table in AE Services OAM can consist of rules based on the Pattern setting and rules based on the RegEx setting. That is, you can create a From TelURI table that uses rules based on Pattern and rules based on RegEx.



Example - Incoming conversion rules that use RegEx

The following table contains sample conversion rules that include regular expression rules and simple pattern match rules.

Min length

Max length

Pattern Delete Length

Replacement

A 4969710([0-5]\\d{0,3}) $1

B 4969(\\d{1,}) 0$1

C * * 49 2 00

D * * * 1 000

A This rule uses a RegEx pattern to specify that AE Services is to look for a string starting with 4969710, matching an extension that starts with 0 through 5 and is 1 to 4 digits in length. The parentheses around the extension indicate a group, which is correlated with the $1 in the replacement string. The $1 says to replace the matching string (the entire E.164 number) with the group designated by the parentheses (the extension). For example, the incoming string 496971001234 would be converted to 01234. As another example, the incoming string 49697102123 would be converted to 2123.

B This rule uses a RegEx pattern to specify that AE Services is to look for a string starting with 4969, followed by 1 or more digits. The parentheses again correlate with the $1 in the replacement string, which says to take the group (the E.164 number without country code or city code) and to add a 0 in front of it (the ARS code). For example, the incoming string 49695671234 would be converted to 05671234.

C This rule uses a simple pattern match. The asterisk in the Min and Max length permits a number of any length. The pattern indicates that AE Services is to look for a string starting with 49. When it detects 49, it deletes the first 2 digits, and replaces them with 00. For example, the incoming string 49891234567 would be converted to 00891234567.

D This rule uses a wildcard pattern match. The asterisk in the Min and Max length permits a number of any length, and the asterisk in the pattern permits pattern of digits. When any number that does not satisfy the first 3 rules (A,B, and C) is detected, AE Services deletes the first digit and0003035391234 replaces it with 000. For example, the incoming string 13035391234 would be converted to 0003035391234.

Methods for administering dial plan settings


Methods for administering dial plan settingsIn AE Services you can use either of the following methods to administer dial plan settings.

● You can administer the dial plan settings for one switch at a time. For more information, see Administering dial plan settings on a per-switch basis on page 80.

● You can administer default dial plan settings that are used for all switches. For more information, see Administering default dial plan settings on page 81.

! Important:Important: In configurations with one AE Server supporting multiple switches, AE Services

does not support IBM Sametime Connect control of the same extension on more than one switch.



Administering dial plan settings on a per-switch basis

Follow this procedure to administer the dial plan settings for a switch connection you have already administered in AE Services (CTI OAM > Administration > Switch Connections). AE Services uses the dial plan information to convert E.164 phone numbers to switch extensions (From TelURI).

Note:Note: If your AE Services and IBM Sametime configuration uses a number of switches

that all have the same dial plan, use the procedure described in Administering default dial plan settings on page 81. By using the default settings, you enter the dial plan settings only once.

1. From your browser, log in to AE Services OAM.

2. Select CTI OAM Administration > Administration > Dial Plan > Switch Administration.

3. From the Switch Dial Plan Administration page, select the connection name for the switch you want to administer, for example aeslcswitch, and click Detail.AE Services OAM displays the Dial Plan Settings - Conversion Rules for aeslcswitch page. This OAM page provides you with a way to Add, Edit, Delete and Reorder "From TelURI" conversion rules and "To TelURI" conversion rules. The Edit, Delete, and Reorder functions apply to existing rules. This example assumes the initial state of the page -- no conversion rules exist -- and it describes how to add one From TelURI conversion rule.

Note:Note: Keep in mind that To TelURI rules are not applicable to the AE Services

Integration for IBM Lotus Sametime.

4. In the From TelURI section of the page, under the blank display area, click Add.

5. From the Add Dial Plan - aeslcswitch page, complete the fields for the From TelURI settings, based on your dial plan.

6. Click Apply Changes. OAM displays the Add Dial Plan page, which asks you to confirm your dial plan changes. From the Add Dial Plan page, click Apply.

At this point you have added one From TelURI conversion rule. If you want to add another From TelURI conversion rule, you must repeat Steps 4,5, and 6.

When you click Apply, AE Services puts the changes you made to your dial plan settings into effect. You do not have to restart the AE Server.

Methods for administering dial plan settings


Administering default dial plan settings

If you use more than one switch in your AE Services and IBM Sametime configuration, and all the switches have the same dial plan settings, you can use the Default Dial Settings page as a template.When you add a switch connection, the dial plan settings that you have administered on the Default Dial Plan settings page are applied to that switch connection. The following section describes two ways of using the default dial plan settings in AE Services OAM.

Setting up default dial plan settings

Use this procedure to set up the Default Dial Settings page.


2. Select CTI OAM Administration > Administration > Dial Plan > Default Settings.

AE Services OAM displays the Dial Plan Settings - Conversion Rules for default page. This OAM page provides you with a way to Add, Edit, Delete and Reorder "From TelURI" conversion rules. The Edit, Delete, and Reorder functions apply to existing rules. This example assumes the initial state of the page (no conversion rules exist) and describes how to add one From TelURI rule.

3. In the From TelURI section of the page, under the blank display area, click Add.

4. From the Add Dial Plan - default page, complete the fields for the From TelURI settings, based on your dial plan.

5. Click Apply Changes. OAM displays the Add Dial Plan page, which asks you to confirm your dial plan changes." From the Add Dial Plan page, click Apply.

At this point you have added one From TelURI conversion rule. If you want to add another From TelURI conversion rule, you must repeat Steps 3, 4, and 5.

When you click Apply, AE Services puts the changes you made to your dial plan settings into effect. You do not have to restart the AE Server.

Applying default dial plan settings to an existing switch connection

If a switch connection currently exists, you can apply the default settings to the existing switch.

Follow this procedure to apply the default settings to an existing switch.


2. Select CTI OAM Administration > Administration > Dial Plan > Switch Administration.

3. From the Switch Dial Plan Administration page, select an administered switch and click Apply Defaults.



Sametime


Chapter 5: Troubleshooting

This chapter provides basic troubleshooting for the AE Services Integration for IBM Lotus Sametime.

SametimeThis section provides basic troubleshooting information for IBM Lotus Sametime.

ClientThis section describes basic troubleshooting for the Sametime Connect client.

Logging

The Sametime Connect logs are stored in the following places:

It is unlikely that you will have to examine the following logs, but they might come in handy if you are trying to determine whether a problem is due to a defect in the IBM client software.

Operating System Path

Windows C:\Documents and Settings\[username]\Application Data\Lotus\Sametime\logs

Linux $HOME/Lotus/Sametime/logs

Mac OS X (ST 7.x) $HOME/Library/Preferences/Sametime/logs

Mac OS X (ST 8.x) $HOME/Lotus/Sametime/logs



ServerThis section describes basic troubleshooting for the IBM Sametime Server in the context of the AE Services Integration for IBM Lotus Sametime.

Configuration Issues

Presence ServiceIf the %PATH% does not include the path to the java.exe, the Presence Service will not start. You will see a message like "java - file not found" in the log. For Sametime 7.5.1, the given java.exe should be the one from the 1.5 JDK that the customer installed. For Sametime 8.0, it should be the java.exe from the IBM JRE.

If the Presence Service does not have permission to write to the log files in telephony_ext\presence\logs, you may have to change the user as which the service runs. Go to Service Controller -> Avaya Telephony Presence Service -> Properties -> Log On As, and change the user that the Presence Service logs on as to a user that has permission to write to files in telephony_ext\presence\logs.

LoggingBoth the Conference Service and Presence Service use Java logging, although each service's logging is configured in a different file. In the sections below we list a number of classes. The logging level of any of those classes can be configured by adding a line to the bottom of the service's logging configuration file with the form:

For example:

See Logging Levels on page 95 for information about the meaning of logging levels (FINEST, in the previous example). For both services, initialization messages are logged at the INFO level and initialization failure messages are logged at the SEVERE level. After initialization, messages are logged at levels between INFO and FINEST.

com.avaya.package.name.ClassName.level=LEVEL

com.avaya.sametime.click2call.impl.ModeratorImpl.level=FINEST

Server


Conference Service

Conference Service logging is configured in SametimeDiagnostics_Telephony.properties in the Domino directory. To get more information about what is happening inside the Conference Service, configuring the logging level of any of the classes listed below by adding a line at bottom of SametimeDiagnostics_Telephony.properties. The log file is Domino\Trace\telephony_0.log. Please note that you can change the logging level of any class in the Conference Service without restarting the Sametime server. The Sametime process that the Conference Service runs within will re-read SametimeDiagnostics_Telephony.properties and rotate the log file for you. (It might take a few minutes for it to do so.) Almost all of the (Avaya) entries in a Conference Service log file will begin with the conference ID, which looks like "CONF-#N" (where N is the conference number). You can use this identifier to trace the activity associated with the given conference.

● The classes in the tcspi package are the highest-level classes in the Conference Service. In fact, the ConferenceService class itself is the class to which the Sametime Server issues its telephony instructions (e.g. make phone A call phone B). Increasing the logging level of these two classes to FINEST will cause those instructions to be logged.

● Below the tcspi package, there are four fundamental classes, one each for the notions of conference (or call), moderator, participant, and cache. PBXConferenceImpl knows the state of the conference (i.e. who's connecting, connected, or disconnected) and moves participants (including the moderator) from one state to the next. ModeratorImpl is responsible for making calls and setting up conferences using the moderator's device. ParticipantImpl's job is rather minimal. CacheImpl and Click2CallCacheImpl gets phone numbers from the LDAP server, converts E.164 numbers to diallable numbers, and keeps a cache of this information.

● Next on the list are the requests that the Conference Service sends to AE Services. Each request is represented by a class which is responsible for building the request. The request is built immediately before being sent to AE Services by the SendRequest class.

com.avaya.sametime.click2call.tcspi.ConferenceServicecom.avaya.sametime.click2call.tcspi.ConferenceController

com.avaya.sametime.click2call.impl.PBXConferenceImplcom.avaya.sametime.click2call.impl.ModeratorImplcom.avaya.sametime.click2call.impl.ParticipantImplcom.avaya.sametime.common.impl.Click2CallCacheImplcom.avaya.sametime.common.impl.CacheImpl

com.avaya.sametime.click2call.impl.SendRequestcom.avaya.sametime.click2call.impl.ClearConnectionBuildercom.avaya.sametime.click2call.impl.ConsultationCallBuildercom.avaya.sametime.click2call.impl.ConferenceCallBuildercom.avaya.sametime.click2call.impl.MakeCallBuildercom.avaya.sametime.click2call.impl.ReconnectCallBuilder



● Similarly, each response from AE Services -- whether successful or failed -- is handled by a class.

● Finally, the call control listener classes respond to the events that AE Services sends to the Conference Service. CallControlListenerDelegateImpl logs at the FINEST level the fact that it has received an event, then forwards the event to either the moderator or the participant (or, in special cases, both). The moderator and participant listener classes log exactly how they respond to the event.

Presence Service

Presence Service logging is configured in logging.properties in the Domino\telephony_ext\resources directory. To get more information about what is happening inside the Presence Service, increase the logging level of any of the classes listed below by adding a line at the bottom of logging.properties.

● The main program of the Presence Service is responsible for creating connections to the LDAP, AE Services, and Sametime servers.

● Once those connections have been established, two other classes do the work. The SametimeListener class is notified of Sametime user status changes. The AvayaListener class is notified of changes in telephone status. CallControlListenerDelegateImpl logs at the FINEST level the fact that it has received an event, then forwards the event to AvayaListener. The events that AvayaListener pays attention to are Originated, Established, ConnectionCleared, Transferred, and Conferenced.

com.avaya.sametime.click2call.impl.ClearConnectionCallbackcom.avaya.sametime.click2call.impl.ConsultationCallCallbackcom.avaya.sametime.click2call.impl.ConferenceCallCallbackcom.avaya.sametime.click2call.impl.ConsultationCallCallbackcom.avaya.sametime.click2call.impl.MakeCallCallbackcom.avaya.sametime.click2call.impl.ReconnectCallCallback

com.avaya.sametime.click2call.impl.ModeratorCallControlListenercom.avaya.sametime.click2call.impl.ParticipantCallControlListenercom.avaya.sametime.common.impl.CallControlListenerDelegateImpl (called DefaultCallControlListenerDelegate in beta release)

com.avaya.sametime.presence.PresenceService

com.avaya.sametime.presence.listeners.SametimeListenercom.avaya.sametime.presence.listeners.AvayaListenercom.avaya.sametime.common.impl.CallControlListenerDelegateImpl (called DefaultCallControlListenerDelegate in beta release)

Server


Exceptions

The Conference Service and Presence Service both communicate with an LDAP server and an AE Services server. This section describes exceptions that can occur for either service because of a problem with either LDAP or AE Services.

LDAP or AE Services

● SSLException, SSLHandshakeException: Indicates that the service is unable to establish an SSL session with the LDAP or AE Services server. (It can only occur against an LDAP server if the LDAP URL begins with "ldaps".) The problem usually has to do with the local trust store or the remote server's certificate.

● Verify that the following properties in avaya-aes-sametime.properties are appropriate for the environment:

LDAP

● NamingException: Indicates that a problem has occurred with the LDAP server.

● CommunicationException: Indicates that the service cannot establish a connection to the LDAP server or lost an existing connection to the LDAP server.

● NoSuchAttributeException: Indicates that service cannot process a response received from the LDAP server.

● Any direct known subclasses of NamingException also indicate an LDAP-related error.

● If one of the above four exceptions occurs in the Conference Service, verify that the following properties in avaya-aes-sametime.properties are correct for the given environment:

avaya.aes.sametime.ldap.trust_store_locationavaya.aes.sametime.ldap.trust_store_password

avaya.aes.sametime.ldap.urlavaya.aes.sametime.ldap.admin_dnavaya.aes.sametime.ldap.admin_passwordavaya.aes.sametime.ldap.base_search_dnavaya.aes.sametime.ldap.telephone_number_attravaya.aes.sametime.ldap.user_attr



● If one of these exceptions occurs in the Presence Service, verify that the following properties in avaya-aes-sametime.properties are correct for the given environment:

● IllegalArgumentException: This exception will be accompanied by a message indicating what is illegal about the "argument." The messages include:

- All numbers must be in E.164 format (e.g. "+13629812002"): Indicates that a phone number in either in LDAP or provided by a Sametime user (either the phone number they have set in their Sametime Connect Location Profile or a number they typed in the "Type a name or number" input field when they tried to call an external number) is not in E.164 format.

- No phone number is stored in the directory for [username]: Indicates that the given user's entry in the LDAP server does not have a telephone number. If the user's entry in the LDAP server does have a telephone number, verify that the value of the avaya.aes.sametime.ldap.telephone_number_attr property is correct for the environment by comparing it to the name of the telephone number attribute on the LDAP server.

- The E164 dialstring [E.164 number] was not converted. Reason = NO MATCH. Verify dialplan rules.: The known causes for this are as follows:

● The dial plan is correct but the converted external number is the same as the E.164 number. Identification: You will see the message FINE: Resolved switch name = [some switch name] in mvap-trace.log.0. Resolution: if the customer is using CM's Extended Dial Plan so that internal extensions are the same length as their corresponding E.164 numbers, they must install the AE Services patch from the Sametime download page. This patch only applies to AE Services 4.2.

● The dial plan is correct, but the E.164 number does not fit the dial plan.

● The dial plan is incorrect. Identification: Examine mvap-trace.log.0 on the AE Server Look for "FINE: Resolved switch name =" in mvap-trace.log.0. Resolution: correct the dial plan.

● AE Services is not getting a response (from CM) to the SnapshotDevice request that AE Services sends while trying convert the E.164 number to a dial string. The purpose of the SnapshotDevice request is to discover which switch "owns" the device, so we know where to route requests. Identification: Look for the message FINE: Resolved switch name = in mvap-trace.log.0; the message will not

avaya.aes.sametime.ldap.urlavaya.aes.sametime.ldap.admin_dnavaya.aes.sametime.ldap.admin_passwordavaya.aes.sametime.ldap.base_search_dnavaya.aes.sametime.ldap.telephone_number_attravaya.aes.sametime.ldap.users_attravaya.aes.sametime.ldap.users_attr_value

Server


include a switch name. (This could indicate that the problem is that the dial plan is incorrect, as well, particularly if the existing rules do not convert the E.164 number to an extension that the switch recognizes as an extension it owns.) Resolution: requires further investigation. The primary issue is: "what is causing DMCC not to receive a response to the SnapshotDevice request. "

AE Services

● If AE Services goes down, the Conference Service and the Presence Service will attempt to reconnect to it every minute, which will generate messages similar to the following:

● When AE Services is back online, the following messages will appear in the log file:

jvm 1 | SEVERE: Not able to establish a new session with the server: java.lang.RuntimeException: java.io.IOException: java.net.ConnectException: Connectionrefused: connectjvm 1 | Mar 26, 2008 12:34:37 PM com.avaya.sametime.common.api.ServiceProviderListener$Reconnector runjvm 1 | SEVERE: Reconnecting failed. An exception occurred: java.lang.NullPointerException: The connection to the Avaya server has been lost.jvm 1 | Mar 26, 2008 12:34:37 PM com.avaya.sametime.common.api.ServiceProviderListener$Reconnector runjvm 1 | SEVERE: Attempting to start a new session.jvm 1 | Mar 26, 2008 12:34:37 PM com.avaya.mvap.svcproxy.prov.RemoteServiceProviderinitServiceProviderImpljvm 1 | INFO: CMAPI SERVER IP=loki2.dr.avaya.com: CMAPI SERVER PORT=4722jvm 1 | Mar 26, 2008 12:34:38 PM com.avaya.mvcs.proxy.ClientProxy connectjvm 1 | WARNING:jvm 1 | java.net.ConnectException: Connection refused: connect

jvm 1 | Mar 26, 2008 12:36:38 PM com.avaya.mvap.svcproxy.prov.ServiceProviderBuildergetCmapiServiceProviderjvm 1 | INFO: SERVICE PROVIDER = com.avaya.mvap.svcproxy.prov.RemoteServiceProviderjvm 1 | Mar 26, 2008 12:36:39 PM com.avaya.sametime.common.api.ServiceProviderListener$Reconnector runjvm 1 | INFO: Reconnected to the server. Resuming normal operation.



Conference Service

The following exceptions may occur in the Conference Service.

● IllegalStateException: This exception will be accompanied by a message indicating what is illegal about the state. The messages include:

- The moderator may not reconnect to conferences: Indicates that the moderator of a conference has disconnected and is attempting to reconnect, which is disallowed.

- This call has ended. Please create a new call: Indicates that the participant in a two-party call that has ended is attempting to reconnect, which is disallowed.

- Cannot add participants after moderator has disconnected: Indicates that the moderator of a conference has disconnected and additional users are being invited to the conference, which is disallowed.

- The moderator's switch was not found. Cannot make this call: Indicates a likely configuration error that resulted in the Conference Service's cache not being able to discover which switch controls the phone belonging to a Sametime user who attempted to initiate a call.

● NullPointerException

- The extension is null or empty: This is most likely caused by a user having their current device in Sametime Connect set to "Computer." They must set their current device to an actual phone number, not a soft phone. (If Sametime Connect is configured to prompt the user with call invitations, then the user must select an actual phone number, not a soft phone, when someone calls them from an actual phone number.)

● SecurityException: This exception will be accompanied by a message indicating the nature of the security exception. The messages include:

- Cannot control the phone [telephone number], so no calls were made: Indicates that a Sametime user attempted to make a call using a device that cannot be controlled by Communication Manager, such as a mobile or home phone.

Server


Presence Service

The following exceptions may occur in the Presence Service.

● During initialization, if the Sametime server is not running, the Presence Service will continue to attempt to connect to the Sametime server until it becomes available.

jvm 1 | INFO: The presence service started.jvm 1 | Mar 26, 2008 10:28:11 AM com.lotus.sametime.telephonymanager.config.STConfigurationReader loggedOutjvm 1 | WARNING: warn.disconnect.sametime 80000207 ST_CONNECT_HOST_UNREACHABLEjvm 1 | Mar 26, 2008 10:29:12 AM com.lotus.sametime.telephonymanager.config.STConfigurationReader loggedOutjvm 1 | WARNING: warn.disconnect.sametime 80000207 ST_CONNECT_HOST_UNREACHABLEjvm 1 | Mar 26, 2008 10:30:13 AM com.lotus.sametime.telephonymanager.config.STConfigurationReader loggedOutjvm 1 | WARNING: warn.disconnect.sametime 80000207 ST_CONNECT_HOST_UNREACHABLEjvm 1 | Mar 26, 2008 10:31:14 AM com.lotus.sametime.telephonymanager.config.STConfigurationReader loggedOutjvm 1 | WARNING: warn.disconnect.sametime 80000207 ST_CONNECT_HOST_UNREACHABLEjvm 1 | Mar 26, 2008 10:32:15 AM com.lotus.sametime.telephonymanager.config.STConfigurationReader loggedOutjvm 1 | WARNING: warn.disconnect.sametime 80000207 ST_CONNECT_HOST_UNREACHABLEjvm 1 | Mar 26, 2008 10:33:16 AM com.lotus.sametime.telephonymanager.config.STConfigurationReader loggedOutjvm 1 | WARNING: warn.disconnect.sametime 80000207 ST_CONNECT_HOST_UNREACHABLEjvm 1 | Mar 26, 2008 10:34:16 AM com.lotus.sametime.telephonymanager.config.STConfigurationReader onConfigChangedjvm 1 | INFO: number of servers in the community is 1jvm 1 | Mar 26, 2008 10:34:16 AM com.lotus.sametime.telephonymanager.config.STConfigurationReader readServerDetailsjvm 1 | INFO: name: CN=stdev/O=aes, URL: stdevel.dr.avaya.comjvm 1 | Mar 26, 2008 10:34:16 AM com.lotus.sametime.telephonymanager.TelephonyAdapterImpl resolverIsReadyjvm 1 | INFO: Community connectedjvm 1 | Mar 26, 2008 10:34:16 AM com.avaya.sametime.presence.listeners.SametimeListener communityAvailablejvm 1 | INFO: Sametime community is available. Adding monitors.



● After initialization, if the Sametime server becomes unavailable, the Presence Service will continue to attempt to reconnect until it becomes available.

jvm 1 | Mar 26, 2008 10:42:26 AM com.avaya.sametime.presence.listeners.SametimeListener communityNotAvailablejvm 1 | INFO: Sametime community is unavailable.jvm 1 | Mar 26, 2008 10:42:26 AM com.lotus.sametime.telephonymanager.cluster.ClusterManager serverLoggedOutjvm 1 | WARNING: warn.server.disconnectedjvm 1 | Mar 26, 2008 10:42:26 AM com.lotus.sametime.telephonymanager.TelephonyAdapterImpl serverLoggedOutjvm 1 | INFO: Server stdevel.dr.avaya.comloggedout. handling datajvm 1 | Mar 26, 2008 10:42:26 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483623jvm 1 | Mar 26, 2008 10:43:27 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:44:28 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:45:29 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:46:29 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:47:31 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:48:31 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:49:32 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:50:33 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:51:34 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:57:40 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING: reason = -2147483129jvm 1 | Mar 26, 2008 10:58:41 AM com.lotus.sametime.telephonymanager.cluster.ServerManager loggedOutjvm 1 | WARNING

Server


● During initialization, when the Presence Service is telling the Sametime server that it wants to be notified of status changes for particular users, the following error may be logged. It indicates that there are duplicate users in the customer's enterprise directory. Domino (the container in which the Sametime server runs) may do case insensitive comparisons of names, so if you have two LDAP connections and the DN "cn=john doe,o=aes" exists in one LDAP store and the DN "cn=John Doe,o=aes" exists in the other LDAP store, you will see this error. The reason the error occurs is that the Sametime server does not have a way of distinguishing one user from the other. The solution to this is to ensure that the names in the enterprise directory are unique.

jvm 1 | WARNING: An error occurred on object{com.lotus.sametime.telephonymanager.TelephonyComp(part), STSession =STSession {_STSession0}}: Resolving a username failed due to an internalerror. Failing user: John Doe



AE ServicesThis section describes AE Services logging issues.

LoggingFor the Sametime integration, E164ConversionServices was enhanced to automatically discover the name of the switch that controls a given extension. It does so by sending a SnapshotDevice to each of the administered switches. The first switch that successfully responds to SnapshotDevice is the switch for the device.

The Sametime-related messages for this feature are logged at FINE, FINER, and FINEST levels in the following class:

Example: Assume that the E.164 number for some Sametime user is +13035551212 and that the switch Saturn controls that device. Before SnapshotDevice is sent to a switch, you will see the following message logged at FINER:

com.avaya.cs.callcontrol.CallControlSnapshotImpl

Converted ~tel:+13035386710~ to ~5386710~ using rules for saturn

Logging Levels


Logging LevelsThe Level class defines a set of standard logging levels that can be used to control logging output. The logging Level objects are ordered and are specified by ordered integers. Enabling logging at a given level also enables logging at all higher levels.

Clients should normally use the predefined Level constants such as Level.SEVERE.

● OFF (higher than highest)OFF is a special level that can be used to turn off logging. This level is initialized to Integer.MAX_VALUE.

● SEVERE (highest value)SEVERE is a message level indicating a serious failure. In general SEVERE messages should describe events that are of considerable importance and which will prevent normal program execution. They should be reasonably intelligible to end users and to system administrators. This level is initialized to 1000.

● WARNINGWARNING is a message level indicating a potential problem. In general WARNING messages should describe events that will be of interest to end users or system managers, or which indicate potential problems. This level is initialized to 900.

● INFOINFO is a message level for informational messages. Typically INFO messages will be written to the console or its equivalent. So the INFO level should only be used for reasonably significant messages that will make sense to end users and system admins. This level is initialized to 800.

● CONFIGCONFIG is a message level for static configuration messages. CONFIG messages are intended to provide a variety of static configuration information, to assist in debugging problems that may be associated with particular configurations. For example, CONFIG message might include the CPU type, the graphics depth, the GUI look-and-feel, etc. This level is initialized to 700.

● FINEFINE is a message level providing tracing information. All of FINE, FINER, and FINEST are intended for relatively detailed tracing. The exact meaning of the three levels will vary between subsystems, but in general, FINEST should be used for the most voluminous detailed output, FINER for somewhat less detailed output, and FINE for the lowest volume (and most important) messages.

In general the FINE level should be used for information that will be broadly interesting to developers who do not have a specialized interest in the specific subsystem.



- FINE messages might include things like minor (recoverable) failures. Issues indicating potential performance problems are also worth logging as FINE. This level is initialized to 500.

● FINERFINER indicates a fairly detailed tracing message. By default logging calls for entering, returning, or throwing an exception are traced at this level. This level is initialized to 400.

● FINEST (lowest value)FINEST indicates a highly detailed tracing message. This level is initialized to 300.

- ALL (lower than lowest)- ALL indicates that all messages should be logged. This level is initialized to

Integer.MIN_VALUE.

About this appendix


Appendix A: Installing and Configuring Lotus Domino and Sametime

About this appendixThe AE Services Integration for IBM Lotus Sametime assumes that you are deploying AE Services in an existing Windows-based IBM Sametime environment. This appendix provides an example for installing and configuring Lotus Domino and Sametime on a server running the Windows Server operating system.

If you do not already have IBM Lotus Sametime, it serves an example of how to set up a new environment – it is ideally suited for a developer who would be for setting up an integration in a lab environment. It would also be suitable for a customer who has never used IBM Lotus Sametime. It describes the following tasks:

● Installing Lotus Domino on page 99

● Setting up the Domino server on page 100

● Installing the Domino Admin client files on page 111

● Setting up the Domino Admin account on page 114

● Installing the Sametime Server on page 118

● Administering the server ID certificate on page 121

● Enabling Telephony Conferencing on page 127

● Determining if the Sametime Server can find the JRE on page 127

● Testing Sametime on page 128



Before you begin -- preinstallation checklistBefore you install Domino and Sametime on a server, make sure you have the following:

● a server running the Windows Server 2003 operating system (you will be performing the installation on this server)

● the IP address of the server (for example, 135.8.17.233)

● the fully qualified domain name of the server (for example, ctisametime.lzt4aes.com)

● the Domino installation file (for example, c13ngen.exe). This appendix assumes that you have downloaded this file from the IBM download site to your server.

Installing Lotus Domino


Installing Lotus DominoTo install Lotus Domino:

1. From the command line, run nslookup to make sure the server name resolves to its IP address. For example, nslookup ctisametime.lzt4aes.com.

2. From the directory where you downloaded the Domino installation file, double-click c13ngen.exe.

The Install Wizard displays a welcome screen.

3. Click Next. The Install Wizard displays the License Agreement.

4. Select I accept the terms in the license agreement, and click Next. InstallShield prompts you for the installation directory (Program Files Directory).

5. From the next Lotus Domino Installer screen accept the defaults, and click Next. For example, the Program Files Directory Name is C:\Program Files\Lotus\Domino and the check box is not selected for Install Domino Partitioned servers.

6. From the Lotus Domino Installer screen that prompts you for the Data Files directory, accept the default (C:\Program Files\Lotus\Domino\data), and click Next.

7. From the Lotus Domino Installer screen that prompts you for the setup type, select the check box for Enterprise Server (it should be checked), and click Next.

8. From the Lotus Domino Installer screen that lists the installation (files, locations and features), review the settings and click Next.The installation continues. When the InstallShield Wizard has completed, it will display a message indicating that it has successfully completed.

9. When you see the message that the InstallShield Wizard has completed, click Finish to exit the installation wizard.

10. Restart the server.



Setting up the Domino serverAfter installing the Lotus Domino software, set up the Domino Server.

1. From the desktop double click Lotus Domino Server to Start the Domino Server. Lotus Domino Server initially displays the dialog box for startup settings.

2. Accept the default startup settings, and click OK. The default settings are as follows:

● Start Domino as a Windows Service.● Always start Domino as a service at system startup.● Don't ask me again.

3. From the Domino Server setup welcome screen, click Next.

Setting up the Domino server


The Server setup program prompts you to specify if this is the first or an additional server.

4. Accept the default selection, Set up the first server or a stand-alone server (the default), and click Next. The Server setup program prompts you for a server name and title.

5. Provide a Server name and a server title, and click Next. For example:

● Server name: ctisametime● Server title: Sametime Server ● I want to use an existing server ID file: not checked



The Setup program prompts you for your organizational information.

6. Provide an organization name and password, and then click Next. For example.

● Organization name: lzt4aes● Organization Certifier password: cti123● Confirm password: cti123● I want to use an existing certifier ID file: not checked



The Setup program prompts you for a Domino domain name.

7. Enter a Domino domain name, for example, lzt4aes, and click Next.

Note:Note: The Domino domain is a collection of Domino servers and users that share the

same Domino directory. The domain name can be the same as the organization name.



The Setup program prompts you for an administrator name and password.

8. Complete the dialog box for the administrator name and password, and click Next. For example:

● First name: sametime● Middle: blank (default)

● Last name: admin● Administrator password: cti123

● Confirm password: cti123● Also save local copy of admin file: checked



The Setup program prompts you for Internet services.

9. Complete the dialog box for the administrator name and password, and click Next. For example:

● Web Browsers (HTTP services): checked● Leave the Internet Mail Clients: not checked● Directory services (LDAP services): checked



The Setup program displays the Domino network settings dialog box.

10. Select Customize.



The Setup program displays the Advanced Network Settings dialog box.

11. Complete the Advanced Network Settings dialog box, and click OK. For example:

● In the Host Name column for the TCP/IP Notes Port Driver, enter ctisametime● Port driver will be enabled: checked ● Type the fully qualified internet host name for this Domino server:

ctisametime.lzt4aes.com



12. When you click OK in Step 11, the Advanced Network Settings dialog box exits, and the Setup program displays the Domino network settings dialog. Click Next.The Setup program displays the Secure your Domino Server dialog box.

13. Accept the defaults on the Secure your Domino Server dialog box, and click Next.



The Setup program displays a dialog box that prompts you to review and confirm your server setup options.

14. Review the server setup options that you selected. If the settings are correct, click Setup.



The Server Setup program continues to completion, and displays the Setup summary dialog, indicating that the Domino Server Setup is complete.

15. Click Finish.

16. Double-click the Lotus Domino Server icon on the Windows desktop to start Domino. When you have verified that Domino has started up successfully, use the quit command to exit Domino.

17. Reboot the server.

18. Start Domino as a service, and make sure the server comes up with no errors, before you continue with the next procedure, Installing the Domino Admin client files on page 111.

Installing the Domino Admin client files


Installing the Domino Admin client filesFollow this procedure to install Lotus Notes with the Domino Admin client feature

1. Change to C:\temp\domino Directory and double click domino_admin_install.exe.

The Lotus Notes Install Wizard prompts you to select an installation type.

2. Select Installation Extraction.

The Install Wizard displays the Welcome screen for the Lotus Notes Install Wizard.

3. Click Next.The Lotus Notes Install Wizard displays the License Agreement.

4. Select I accept the terms in the license agreement, and click Next. The Install Wizard displays the Customer Information dialog box.

5. For the User Name and Organization, accept the default (none), and click Next.The Lotus Notes Install Wizard prompts you for where you want to install the program files and data files.

6. Accept the default locations, and click Next.



The Lotus Notes Install Wizard displays the Custom Setup screen.

7. From the Custom Setup screen select Domino Administrator. Then select This feature will be installed on the Local hard drive, and click Next.

Installing the Domino Admin client files


The Lotus Notes Install Wizard displays the screen with the banner that reads, "Ready to Install the Program."

8. From the "Ready to Install the Program" screen, click the checkbox to clear the selection for Make Notes my default email program, and click Install.

Note:Note: Lotus Notes email is not required for the AE Services Integration for IBM Lotus

Sametime. You can use Notes or you can use Microsoft Outlook. If you elect to use Lotus Notes for email, you will need to configure and administer Lotus Notes email.

The Lotus Notes Install Wizard installs the Domino Admin client. When the installation is complete, the Lotus Notes Install Wizard displays the screen with the banner that reads, "Install Wizard Completed."

9. From the "Install Wizard Completed" screen, click Finish.



Setting up the Domino Admin accountBefore you begin the procedure to set up the Domino Admin account, start the Domino Server by double-clicking the Domino Server icon on the desktop.

Follow these steps to set up the Domino Admin account. This is the Domino Administrator for the AE Services Integration for IBM Sametime.

1. From the desktop, double click the Domino Admin 7 icon on the desktop.

The Lotus Notes Client Configuration program displays the Welcome Screen.

2. Click Next.

Setting up the Domino Admin account


The Client Configuration program displays the User Information screen.

3. Complete the User Information screen as follows.

● Your Name: For the AE Services Integration for IBM Sametime, this field refers to the Domino Administrator for the AE Services - Sametime integration. Enter sametime admin.

● Domino Server: For the AE Services Integration for IBM Sametime, this field refers to the AE Services Integration for IBM host (ctisametime) in the Domino Domain (lzt4aes). Enter ctisametime/lzt4aes.

● Checkbox selected for "I want to connect to a Domino Server."

● Click Next.The Client Configuration program prompts you for an administrator password.

4. Enter the password the Domino Administrator for the AE Services - Sametime integration, which is cti123, and click OK.



The Client Configuration Program displays the Instant Messaging Setup screen.

5. Accept the defaults (the Setup instant messaging check box is not checked), and click Next.The Notes setup for administration completes and displays this message: Notes setup is complete!.

6. Click OK. The Domino Administrator program starts and displays the Administration console.

7. Click on the <LZT4AES> Domain tab to configure the account.

8. From the Tools drop-down, click People. The account name admin, sametime displays in the main panel.

Setting up the Domino Admin account


9. From the task panel, click Edit Person.

The system prompts you for an HTTP Password.

10. Enter a password (for example use the same password that you used for the administrator’s password -- cti123), and click OK.

11. From the taskbar, click Save & Close.

This completes the set up of the Domino administrator on the Domino Server.

12. From the top menu, select File > Exit Administrator, and at the prompt click Yes to exit Domino Administration.

13. You are now ready to install the Sametime Server.



Installing the Sametime ServerBefore you start the installer, make sure that Lotus Domino server is not running. Click on the Domino command prompt, and type quit. When the screen for the Domino command prompt closes you are ready to install the Sametime Server.

Follow these steps to install the Sametime Server.

1. Run the Sametime Server installation program, for example Sametime8.0GAServer.exe.

2. Accept Installation Extraction.

3. When the Sametime Server installation program prompts you for the language, click English.

4. When the Sametime Server installation program prompts you to install the Sametime Server, click Install the Sametime Server.

5. The Sametime Server installation program prompts you for the language to use for the installation wizard. Select English, and click OK.

The Sametime Server installation program displays the Welcome screen.

6. Click Next.The Sametime Server installation program displays the license agreement.

7. Click Next to accept the license agreement (default).

Installing the Sametime Server


The Sametime Server installation program displays the screen that prompts you to specify the server to use for slide conversion.

8. Accept the default (Use this Sametime Server) and click Next.



The Sametime Server installation program displays a screen prompting you to select the directory to use for collaboration.

9. Select LDAP Directory, and in the LDAP Server name field, enter the fully qualified domain name of your Sametime server (for this example configuration, enter ctisametime.lzt4aes.com). Accept the default Port Number for LDAP (389). Leave the check box for cleared for Advanced LDAP Configuration, and click Next.The Sametime Server installation program displays a screen prompting you to Enable HTTP tunneling. This enables the Sametime server to listen on Port 80 and the Domino Server to listen on port 8088.

The Sametime Installation program prompts you to read the summary information screen.

10. Read the summary information, and select Install.The Sametime Installation program completes the installation. This process can take several minutes. When it is complete, the Sametime Installation program displays a message indicating that you have successfully installed IBM Lotus Sametime.

11. Click Finish, to complete the installation.

Administering the server ID certificate


Administering the server ID certificate Follow these steps to administer the Sametime Server ID certificate and password.

1. Start the Domino Admin by double clicking on Domino Admin 7 icon on the desktop.

2. Enter the Sametime admin password when prompted. For this sample configuration, the password is cti123.

3. Click on <LZT4AES> Domain tab to configure the account.

4. From the main menu , select People > Register. The Register window displays in the left panel.



5. In the Choose a Certifier window, click Certifier ID.

The configuration program then prompts you to Choose a Certifier ID.

6. Locate the file in C:\program files\IBM\ lotus\domino\data\cert.id, and click Open. Then click OK to close the Choose Certifier ID dialog box.



The configuration program prompts you for a password.

7. For this sample configuration, enter cti123 as the Certifier password, and click OK.

The configuration program displays a Certifier Recovery Information Warning dialog.

8. Select the check box for "Do not show this warning for this certifier ID in the future." and click OK.

The configuration program displays the Register Person -- New Entry dialog box.

9. Click Password Options.



The configuration program displays the Password Options dialog box.

10. From the Password Options dialog, move the slider to the left to lower the Password Quality Scale to Allow Any Password [1], and click OK.

Note:Note: For this sample configuration, the password scale is lowered to Allow Any

Password [1] to eliminate the need to administer Access Control Lists.



The Register Person -- New Entry dialog continues to display.

11. From the Register Person -- New Entry dialog, click the Mail system drop down box and select None. Then select the green check mark, which adds the user to the registration queue. Next, click Register and then click OK.

12. From the Domino Administrator main screen, with the LZT4AES Domain tab displaying, click Add Person from the toolbar.

Select thegreen checkbox.



The Sametime Server configuration program displays the New Person tab, with additional tabs. Select the tab for Basics.

13. Complete the following fields on the Basics tab:

● First Name

● Last Name● Internet Password● User Name

If you add users through the “Add Person” interface, you must also specify the User Name for the person, using two lines, in the following format:

<Firstname>space<Lastname>/<Domain>

<Firstname>space<Lastname>

For example (using the example domain name in this appendix):

Jan Green/lzt4aesJan Green

● Mail System (none)14. Select the Work/Home tab.

15. In the Work/Home tab, enter the user’s Telephony number in E164 format, for example: +17325552525. Click Save & Close from the taskbar.

Enabling Telephony Conferencing


This completes procedure to Administer the server ID certificate.

16. From the main menu, select File > Exit Administrator. Then at the prompt, click Yes to exit the Domino Administration

Enabling Telephony ConferencingFollow these steps to enable Telephony Conferencing.

1. From your browser, open http://ctisametime.lzt4aes.com/stcenter.nsf

2. Click Administer the Server on the bottom right of the page.

3. Log on by entering the name sametime admin and the password cti123.

4. In the Administer the server page, select Configuration > Meeting Services and click the checkbox for Allow people to schedule a telephone conference call for a web conference. A telephony service provider is required.

5. Select Policies > Sametime Default Policy > Community Services and click the checkbox for Allow telephony for contact list, instant messaging, and instant meetings.

6. Reboot the Sametime Server.

Determining if the Sametime Server can find the JREFollow this procedure to ensure that the Telephony Presence service can find the Java Runtime Environment (JRE).

1. Determine if the JRE is already in the path :

● Start the command prompt: (Click Start > Run. In the Run dialog type cmd and click OK.)

● Type java -version. If the program is not found, continue with Step 2 to update the PATH. If the program is found, you can skip Step 2.

2. Select My Computer > Properties > Advanced > Environment Variables > System variables and add: C:\Program Files\IBM\Lotus\Domino\ibm-jre\jre\bin to the path. .



Testing SametimeUse this procedure to test the Sametime.

1. Start domino (which, should auto start Sametime).

2. Use the services application to verify that all sametime services have started services application)

3. Test the Sametime Installation as follows:

a. From your browser, open http://ctisametime.lzt4aes.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.

http://www.java.com


Appendix B: LDAP tester - sample output

Sample output form ldap-tester.bat$ ./ldap-tester.batCurrent directory is c:\Program Files\IBM\Lotus\Domino\telephony_ext\bin\.Attempting to load the file ..\resources\avaya-aes-sametime.propertiesApr 13, 2008 10:35:31 AM com.avaya.sametime.common.impl.ContextDelegateImpl <init>INFO: Set security principal to ~cn=sametime admin,o=aes~ Apr 13, 2008 10:35:31 AM com.avaya.sametime.common.impl.ContextDelegateImpl <init>INFO: Set LDAP URL to ~ldap://localhost:389~ Apr 13, 2008 10:35:31 AM com.avaya.sametime.common.impl.LDAPConnectionImpl <init>INFO: Set base search DN to ~o=aes~Apr 13, 2008 10:35:32 AM com.avaya.sametime.common.impl.LDAPConnectionImpl <init>INFO: Set user attribute to ~cn~Apr 13, 2008 10:35:32 AM com.avaya.sametime.common.impl.LDAPConnectionImpl <init>INFO: Set telephone attribute to ~telephonenumber~ Apr 13, 2008 10:35:32 AM com.avaya.sametime.common.impl.LDAPConnectionImpl <init>INFO: Set users attribute to ~objectclass~ Apr 13, 2008 10:35:32 AM com.avaya.sametime.common.impl.LDAPConnectionImpl <init>INFO: Set users attribute value to ~person~

Connecting to LDAP server

Searching LDAP for telephony presence users

LDAP search returned 8 telephony presence users

With 8 telephony presence users, you will need 8 licenses.

Getting phone number from LDAP server for each user

If the phone number of a user is not in E.164 format (e.g. +15551212), their phone will not be able to provide telephony presence or participate in calls started via Sametime.

If the set of users displayed is not exactly the set of users whose phones will provide telephony presence, then refine the following properties in avaya-aes-sametime.properties: avaya.aes.sametime.ldap.users_attr avaya.aes.sametime.ldap.users_attr_value

User: Charles M. BrownTelephone number: +13035383050

User: Edna GreenTelephone number: +13035383052

User: Pat GreyTelephone number: +5383054

Appendix B: LDAP tester - sample output



Index

Index

AAE Services administrative workstation, requirement . 29AE Services Bundled Server requirements . . . . . 32Asterisk

when interpreted as a literal . . . . . . . . . . . 71Asterisk, when treated as a wildcard . . . . . . . . 72

Bbundled server, see AES server

DDell PowerEdge 1950 server

specifications . . . . . . . . . . . . . . . . . . 32Dial plan administration in AE Services

summary . . . . . . . . . . . . . . . . . . . . 69Dial string characters. . . . . . . . . . . . . . . . 71Distinguished Name (DN) entries and scope of search 28DVD

new installation . . . . . . . . . . . . . . . . . 32

EEthernet interfaces

on server. . . . . . . . . . . . . . . . . . . . 32

FFrom TelURI and To TelURI rules. . . . . . . . . . 70From TelURI settings. . . . . . . . . . . . . . .71, 75

Mmodem

requirements . . . . . . . . . . . . . . . . . . 32

Nnetwork

interfaces on bundled server. . . . . . . . . . . 32NIC

Ethernet interfaces . . . . . . . . . . . . . . . 32

SSAMP card. . . . . . . . . . . . . . . . . . . . . 32SIP requirements . . . . . . . . . . . . . . . . . . 30

TTel URI formats and device IDs . . . . . . . . . . . 70

Xx306(m) bundled server

SAMP card . . . . . . . . . . . . . . . . . . . 32


Index

02-602818_i1

Documents

program filesibmlotusdomino

tel uri formats

ae services

ae services

integrating

setup program

ae services

ae services