Citrix EasyCall Gateway Telephony System Integrator s Guide for ShoreTel Citrix EasyCall Gateway 3.0
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. Citrix makes no representations or warranties with respect to the contents of this document, and specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose. Further, Citrix, reserves the right to revise this document and to make changes to its content, at any time, without obligation to notify any person or entity of such revisions or changes. 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 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. 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. ShoreWare is a registered trademark of ShoreTel, Inc. in the United States and/or other countries. ShoreTel is a trademark of ShoreTel, Inc. in the United States and/or other countries. UNIX is a registered trademark of The Open Group. All other trademarks and registered trademarks are the property of their respective owners. Document Code: November 3, 2009 (KP)
CONTENTS Contents Chapter 1 ShoreTel SIP Trunk Integration Configuring the ShoreTel Telephony System............................... 2 Configuring the EasyCall Gateway....................................... 3
2 Telephony System Integrator s Guide
CHAPTER 1 ShoreTel SIP Trunk Integration This guide describes how to integrate the EasyCall Gateway with ShoreTel SIP trunks, version 9.1 Build 14.21.4905.0. To enable the EasyCall Gateway to work with ShoreTel systems, you must configure a SIP trunk between the EasyCall Gateway and the ShoreTel system. The following diagram shows the integrated components. EasyCall Gateway integrated with ShoreTel The integration described in this guide can be done in tandem with EasyCall Gateway installation and configuration, which includes defining the properties of the SIP trunk and defining any changes the EasyCall Gateway makes to telephone numbers before sending them to the telephony system for dialing. The EasyCall Gateway always listens on port 5060. By default, the EasyCall Gateway communicates with the SIP trunk over port 5060; that port is configurable. 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 determine the settings that are appropriate for the site. The following topics describe integration with ShoreTel telephony systems: Configuring the ShoreTel Telephony System on page 2 Configuring the EasyCall Gateway on page 3
2 EasyCall Gateway Telephony System Integrator s Guide Configuring the ShoreTel Telephony System The following screens show a sample trunk configuration. The default values required for the trunk to be active are included. To define a SIP Trunk Group 1. In ShoreWare Director, navigate to Switches > Primary. 2. In the Switches screen, select the voice switch to which you want to allocate SIP trunk ports. 3. For an available port, change the Port Type to 5 SIP Trunks. Create as many SIP trunks as needed. 4. In ShoreWare Director, navigate to Trunks > Trunk Groups. 5. In the Trunk Groups screen, select the site, choose SIP from the of type options, and click Go. 6. In the Edit SIP Trunk Group screen: A. Enter the Name for the new trunk group. B. Under Inbound, select the Tandem Trunking checkbox. C. Select the Outbound checkbox. D. Under Network Call Routing, enter the Access Code and Local Area Code. E. Under Trunk Services, leave all of the options unselected. No services are required since the call will be going over your PRI or analog lines, depending on the trunk groups the user can access. 7. Save the trunk group. 8. In ShoreWare Director, navigate to Trunks > Individual Trunks. 9. In the Trunks by Group screen, select the site and then select the trunk group you just created. Click Go.
Chapter 1 ShoreTel SIP Trunk Integration 3 10. In the Edit Trunk screen: A. Enter a Name for this trunk. B. Choose the Switch that contains the SIP trunk you just configured. C. In Use IP Address, enter the IP address of the EasyCall Gateway. D. In Number of Trunks, enter the number of trunks to be created. (Keep in mind that, when a call is made, 2 SIP and 2 PRI trunks are used. You will need to reserve the correct number of trunks on the switch.) Configuring the EasyCall Gateway Refer to the Getting Started section of the EasyCall Gateway Administration Guide for installation instructions. To define the properties of a trunk 1. In the EasyCall Gateway administration tool, click Cluster Configuration and then click Trunks. 2. Click Add Trunk. 3. In the Cluster Configuration - Add/Edit Trunk screen: A. Enter a descriptive Trunk Name. This name identifies this trunk in the list on the Trunks tab. B. In Trunk Capacity, enter the number of channels available to EasyCall. Your telephony system specialist can provide this value. C. Enter the SIP Switch Settings provided by your telephony specialist. Set PBX Port to 5060. D. In the Call Configuration section, configure call handling so that phone numbers will be dialed correctly from the locale of the gateway.
4 EasyCall Gateway Telephony System Integrator s Guide 4. Navigate to the Dashboard and verify that the trunk status is Active. If it is not, verify the IP address.