Citrix EasyCall Gateway Telephony System Integrator s Guide for Avaya S8300/S87xx-Series Citrix EasyCall Gateway 2.2.1
Copyright and Trademark Notice Use of the product documented in this guide is subject to your prior acceptance of the End User License Agreement. A printable copy of the End User License Agreement is included on your product media and in the documentation download page of the administration tool. Information in this document is subject to change without notice. Companies, names, and data used in examples herein are fictitious unless otherwise noted. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Citrix Systems, Inc. 2006-2009 Citrix Systems, Inc. All rights reserved. Xen, Citrix, Citrix Subscription Advantage, EasyCall, XenServer, XenCenter and logos are either registered trademarks or trademarks of Citrix Systems, Inc. in the United States and/or other countries. RSA Encryption 1996-1997 RSA Security Inc., All Rights Reserved. This product includes software developed by The Apache Software Foundation (http://www.apache.org/) Licensing: Portions of this documentation that relate to Globetrotter, Macrovision, and FLEXlm are copyright 2005 Macrovision Corporation. All rights reserved. This product includes open source Berkeley DB (BDB) software licensed from Oracle Corporation and PostgresSQL, released under the BSD license. Trademark Acknowledgements Adobe, Acrobat, and PostScript are trademarks or registered trademarks of Adobe Systems Incorporated in the U.S. and/or other countries. Asterisk is a registered trademark of Digium, Inc. FreePBX is a registered trademark of Atengo, LLC. Java, Sun, and SunOS are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. Solaris is a registered trademark of Sun Microsystems, Inc. Sun Microsystems, Inc has not tested or approved this product. Portions of this software are based in part on the work of the Independent JPEG Group. Microsoft, Windows, Windows Media, Windows Server, Windows NT, Win32, Outlook, ActiveX, Active Directory, and DirectShow are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. trixbox (www.trixbox.com) is a registered trademark of Fonality, Inc. UNIX is a registered trademark of The Open Group. All other trademarks and registered trademarks are the property of their respective owners. Document Code: January 30, 2009 (KP)
CONTENTS Contents Chapter 1 Chapter 2 Integration Overview Equipment Requirements.............................................. 2 Call Detail Records................................................... 2 Integrating with Avaya S8300/S87xx-Series through a SIP Trunk Prerequisites........................................................ 4 Configuring Avaya Communication Manager............................... 4 Configuring an IP Network Region..................................... 5 Configuring the IP Node Name....................................... 6 Configuring SIP Signaling........................................... 6 Configuring the SIP Trunk........................................... 8 Configuring Avaya SIP Enablement Services (SES).......................... 9 Verifying the SIP Domain for the SES Server............................ 9 Configuring the Media Server Interface................................ 10 Adding a Trusted Host to the SIP Domain.............................. 12 Verifying the Integration.............................................. 12 Index............................................................. 13
iv Telephony System Integrator s Guide
CHAPTER 1 Integration Overview The EasyCall Gateway has been tested for interoperability with Avaya S8300/S87xx- Series. The sample inter-switch configuration tested included the following Avaya telephony systems: Avaya S87xx-Series Server (Avaya Communication Manager 5.0) Avaya G650 Media Gateway Interfaces: IP Server Interface (TN2312BP) C-LAN Interface (TN799DP) IP Media Processor (TN2302AP) Avaya SIP Enablement Services (R4.1.31.2) Avaya S8300-Series Server (Avaya Communication Manager 5.0) Avaya G700 Media Gateway Avaya SIP Enablement Services (R4.1.31.2) To enable the EasyCall Gateway to work with those Avaya systems, you must configure the telephony system trunk between SIP Enablement Services and Avaya Communication Manager and the EasyCall Gateway. The configuration can be done in tandem with EasyCall Gateway installation and configuration, which includes defining the properties of the telephony system trunk and defining any changes the EasyCall Gateway makes to telephone numbers before sending them to the telephony system for dialing. For information about EasyCall Gateway configuration, refer to the EasyCall Gateway Administrator s Guide. Those responsible for configuring the telephone system must take the specific characteristics of a site into consideration to detemine the settings that are appropriate for the site. Configuration of the Avaya telephone system for integration with the EasyCall Gateway is similar to integration with a voicemail system. The following topics describe how to configure trunks for the supported Avaya systems. Equipment Requirements on page 2 Call Detail Records on page 2 Integrating with Avaya S8300/S87xx-Series through a SIP Trunk on page 3
2 EasyCall Gateway Telephony System Integrator s Guide Equipment Requirements Only the EasyCall Gateway appliance is required to integrate with the Avaya telephony system. The following diagram shows the integrated components. Call Detail Records Avaya telephony system integrated with the EasyCall Gateway As shown in the diagram, the SIP trunk makes telephone calls over an Internet connection. The use of SIP trunks does not require modification to your existing telephony system or Internet connections and does not require PRI hardware or telephony system upgrades. Only outbound SIP trunks are required; the number of trunk channels used can be scaled to your needs. For information on capacity planning, refer to the EasyCall Gateway Administrator s Guide. A Call Detail Record (CDR) is a file that contains information about calls placed through the EasyCall Gateway. Information provided in the CDRs can be used for billing calls to cost centers and for auditing potential abuse. Each call placed through EasyCall generates two outbound records.
CHAPTER 2 Integrating with Avaya S8300/S87xx- Series through a SIP Trunk This chapter describes an example configuration of Avaya S8300/S87xx-Series for integration with the EasyCall Gateway through a SIP trunk. A network diagram for the example configuration follows. Example network diagram The example configurations are performed through the Avaya Communication Manager administration software screens, also known as SAT (System Access Terminal) screens. In some instances, the information from the original screen has been edited for brevity and clarity in presentation.
4 EasyCall Gateway Telephony System Integrator s Guide Prerequisites The following topics describe a sample configuration of Avaya S8300/S87xx-Series: Prerequisites on page 4 Configuring Avaya Communication Manager on page 4 Configuring Avaya SIP Enablement Services (SES) on page 9 Verifying the Integration on page 12 It is assumed that the appropriate Avaya license files and authentication files have been installed, and that login and password credentials are available to those responsible for configuring the telephone system. Configuring Avaya Communication Manager The following topics describe the Avaya Communication Manager configuration required for integration with the EasyCall Gateway: Configuring an IP Network Region on page 5 Configuring the IP Node Name on page 6 Configuring SIP Signaling on page 6 Configuring the SIP Trunk on page 8
Chapter 2 Integrating with Avaya S8300/S87xx-Series through a SIP Trunk 5 Configuring an IP Network Region Use the following procedure to configure an IP network region needed for communication between Avaya Communication Manager and Avaya SIP Enablement Services. To configure an IP network region 1. Enter change ip-network-region n, where n is a number from 1 through 250. 2. Set Authoritative Domain to the same SIP Domain value configured on Avaya SIP Enablement Services (see Verifying the SIP Domain for the SES Server on page 9). In this example, the SIP Domain is testroom.com. 3. The Direct IP Feature (shuffle) must be turned off for Communication Manager operation with the EasyCall Gateway. Set Intra-region IP-IP Direct Audio and Inter-region IP-IP Direct Audio to no. Turning off shuffle denies direct IP-to-IP audio connectivity between endpoints registered to Avaya Communication Manager or Avaya SIP Enablement Services in the same IP network region or in different IP network regions. Thus, the audio path will always include the media processor board.
6 EasyCall Gateway Telephony System Integrator s Guide Configuring the IP Node Name To set the IP node name for Avaya SIP Enablement Services Enter change node-names ip SES, where SES is the name for the Avaya SIP Enablement Services node. In the following example, the Avaya SIP Enablement Services node is SIP. You will also need to enter the Avaya SIP Enablement Services IP address. Configuring SIP Signaling The following procedure describes the configuration of two signaling groups, one for Avaya Communication Manager and Avaya SIP Enablement Services and the other for Avaya Communication Manager and EasyCall Gateway. To configure the signaling groups 1. For the Avaya Communication Manager and Avaya SIP Enablement Services signaling group, enter add signaling-group s, where s is an available signaling group and configure the following settings: Group Type = sip Near-end Node Name = the node name (in the sample configuration, this node name is CLAN) Far-end Node Name = the SIP Enablement Services node name configured in Configuring the IP Node Name on page 6 (in the sample configuration, this node name is SIP) Far-end Network Region = the region configured in (in the sample configuration, this region is 1) Far-end Domain = the SIP Domain value (in the sample configuration, this domain is testroom.com). This setting comes from the domain specified in Configuring an IP Network Region on page 5.
Chapter 2 Integrating with Avaya S8300/S87xx-Series through a SIP Trunk 7 2. For the Avaya Communication Manager and EasyCall Gateway signaling group, enter add signaling-group s, where s is an available signaling group and configure the following settings: Note: These settings are the same as in step 1, except for the Far-end Domain field. Group Type = sip Near-end Node Name = the node name (in the sample configuration, this node name is CLAN) Far-end Node Name = the SIP Enablement Services node name configured in Configuring the IP Node Name on page 6 (in the sample configuration, this node name is SIP) Far-end Network Region = the region configured in (in the sample configuration, this region is 1) Far-end Domain = the IP address of EasyCall Gateway
8 EasyCall Gateway Telephony System Integrator s Guide Configuring the SIP Trunk The following procedure describes the configuration of two trunk groups, one for Avaya Communication Manager and Avaya SIP Enablement Services and the other for Avaya Communication Manager and EasyCall Gateway. To configure the trunk groups 1. For the Avaya Communication Manager and Avaya SIP Enablement Services trunk group, enter add trunk-group t, where t is an unallocated trunk group and configure the following settings: Group Type = the Group Type value set in Configuring SIP Signaling on page 6 Group Name = a descriptive name TAC (Trunk Access Code) = any available trunk access code Signaling Group = a Group Number added in Configuring SIP Signaling on page 6 Number of Members a value from 0 to 255. Set to a value large enough to accommodate the number of SIP telephone extensions being used. 2. For the Avaya Communication Manager and EasyCall Gateway trunk group, enter add trunk-group t, where t is an unallocated trunk group and configure the settings described in Step 1.
Chapter 2 Integrating with Avaya S8300/S87xx-Series through a SIP Trunk 9 Configuring Avaya SIP Enablement Services (SES) The following topics describe the Avaya SIP Enablement Services configuration required for integration with the EasyCall Gateway: Verifying the SIP Domain for the SES Server on page 9 Configuring the Media Server Interface on page 10 Adding a Trusted Host to the SIP Domain on page 12 Verifying the SIP Domain for the SES Server The SIP Domain for the Avaya SIP Enablement Services Server must match the Farend Domain value configured for the Avaya Communication Manager signaling group in Configuring SIP Signaling on page 6. To verify the SIP Domain 1. Open a Web browser and enter https://ses_ip/admin, where SES_IP is the IP address of the Avaya SIP Enablement Services Server. 2. Enter your login credentials. 3. Click Launch SES Administration Interface. 4. In the SIP Server Management page, navigate to the Server Configuration > System Properties page and verify that the SIP Domain matches the value configured in Configuring SIP Signaling on page 6. 5. If you need to change the SIP Domain, click Update when you are finished.
10 EasyCall Gateway Telephony System Integrator s Guide Configuring the Media Server Interface The following procedure describes how to add SIP-enabled media servers to the SIP domain. To add SIP-enabled media servers to the SIP domain 1. In the SIP Server Management page, navigate to Media Servers > Add. 2. Configure the following settings: Media Server Interface Name = a descriptive name for the media server interface Host = select the IP address of the SIP Enablement Services server that you want to associate with the Avaya Communication Manager Media server's SIP trunk SIP Trunk Link Type = select the protocol to be used for the SIP link between the media server and the specified host:
Chapter 2 Integrating with Avaya S8300/S87xx-Series through a SIP Trunk 11 TCP (Transport Control Protocol) TLS (Transport Link Security) This is the default protocol, which is selected for all servers. SIP Trunk IP Address = the IP address for the CLAN (or media server's procr) that terminates the SIP link from SIP Enablement Services. 3. Click Add when finished.
12 EasyCall Gateway Telephony System Integrator s Guide Adding a Trusted Host to the SIP Domain The following procedure describes how to add a trusted host to the SIP domain. To add a trusted host to the SIP domain 1. In the SIP Server Management page, navigate to Trusted Hosts > Add. 2. Configure the following settings: IP Address = the IP address of EasyCall Gateway Host = select the IP address of the SIP Enablement Services server 3. Click Add when finished. Verifying the Integration Install EasyCall on one or more user PCs and place different types of calls (domestic, international).
INDEX Index A Avaya Communication Manager prerequisites SIP 4 C commands for SIP configuration add signaling-group 6 add trunk-group 8 change ip-network-region 5 change node-names 6 I integration prerequisites SIP 4 IP network region configuration (SIP) 5 IP node name configuration (SIP) 6 S signaling group configuration SIP 6 SIP Enablement Services configuration Media Server interface 10 SIP Domain 9 trusted host 12 T trunk group configuration SIP 8
14 Telephony System Integrator s Guide