BroadSoft Partner Configuration Guide Toshiba Strata CIX July 2011 Document Version 1.8 9740 Irvine Boulevard Irvine, California, 92618 949-583-3500 www.toshiba.com
BroadWorks Guide Copyright tice Trademarks Copyright 2006-2008. Toshiba America Information Systems, Inc. Telecommunication Systems Division. All rights reserved. part of this manual, covered by the copyrights hereon, may be reproduced in any form or by any means, graphic, electronic, or mechanical, including recording, taping, photocopying, or information retrieval systems, without the express written permission of the publisher of this material. Strata is a registered trademark of Toshiba Corporation. Strategy is a registered trademark of Toshiba America Information Systems, Inc. BroadWorks and BroadWorks Assistant Enterprise, BroadWorks Call Center, BroadWorks Communicator, BroadWorks Receptionist, and BroadWorks Deployment Studio are trademarks of BroadSoft, Inc. Microsoft, MSN, Windows, and the Windows logo are registered trademarks of Microsoft Corporation. Other product names mentioned in this document may be trademarks or registered trademarks of their respective companies and are hereby acknowledged. This document is printed in the United States of America. 2011 TOSHIBA. PAGE 2 OF 16
Document Revision History Version Reason for Change 1.1 Introduced document for Toshiba Strata CIX 5.0 validation with BroadWorks Release 14.0. 1.2 Edited and published document. 1.3 Added solution configuration section. 1.4 Edited changes and published document. 1.5 Updated the BroadWorks device type. 1.6 Edited changes and published document. 1.7 Updated document format. 1.8 Edited changes and published document. 2011 TOSHIBA. PAGE 3 OF 16
Table of Contents 1 Overview...5 2 Interoperability Status...6 2.1 Verified Versions... 6 2.2 Interface Capabilities Supported... 6 2.3 Known Issues... 8 3 Solution Configuration... 10 4 BroadWorks Configuration... 11 4.1 BroadWorks Device Profile Configuration... 11 4.2 BroadWorks Configuration Steps... 12 5 CIX Configuration... 13 5.1 System Level Configuration... 14 5.2 Subscriber Level Configuration Parameters... 15 References... 16 2011 TOSHIBA. PAGE 4 OF 16
1 Overview This document describes the configuration procedures required for a Toshiba CIX with MIPU to make full use of the capabilities of BroadWorks. The Toshiba CIX with MIPU is an access device that uses the Session Initiation Protocol (SIP) to communicate with BroadWorks for call control. This guide describes the specific configuration items that are important for use with BroadWorks. It does not describe the purpose and use of all configuration items on the Toshiba CIX with MIPU. For those details, see the Programming and Installation Manual supplied by Toshiba in Toshiba s F.Y.I website [1]. 2011 TOSHIBA. PAGE 5 OF 16
2 Interoperability Status This section provides the known interoperability status of the Toshiba CIX with BroadWorks. This includes the version(s) tested, capabilities supported and known issues. Interoperability testing validates that the device interfaces properly with BroadWorks via the SIP interface. Qualitative aspects of the device or device capabilities not affecting the SIP interface such as display features, performance, and audio qualities are not covered by interoperability testing. Requests for information and/or issues regarding these aspects should be directed to Toshiba. 2.1 Verified Versions The following table identifies the verified Toshiba CIX and BroadWorks versions and the month/year the testing occurred. If the device has undergone more than one test cycle, versions for each test cycle are listed, with the most recent listed first. Compatible Versions in the following table identify specific CIX versions which the partner has identified as compatible and should interface properly with BroadWorks. Generally, maintenance releases of the validated version are considered compatible and may not be specifically listed here. Contact Toshiba for any questions concerning maintenance and compatible releases. NOTE: Interoperability testing is normally performed with the latest generally available (GA) device firmware/software and the latest GA BroadWorks release and service pack at the time the testing occurs. If there is a need to use a non-verified mix of BroadWorks and device software versions, customers can mitigate their risk by self-testing the combination using the BroadWorks IP-PBX/PBX Trunking Interoperability Test Plan [7]. Verified Versions Table Date (mm/yyyy) BroadWorks Release CIX Verified Version CIX Compatible Versions 08/2008 14.SP1 5.0 MR020 Any maintenance version of the verified version. 2.2 Interface Capabilities Supported The Toshiba CIX has completed interoperability testing with BroadWorks using the BroadWorks SIP IP-PBX/PBX Trunking Interoperability Test Plan [7]. The results are summarized in the following table. The BroadWorks test plan is composed of packages, each covering distinct interoperability areas, such as Basic call scenarios and Redundancy scenarios. Each package is composed of one or more test items which in turn are composed of one or more test cases. The test plan exercises the SIP interface between the device and BroadWorks with the intent to ensure interoperability sufficient to support the BroadWorks feature set. 2011 TOSHIBA. PAGE 6 OF 16
The Supported column in the following table identifies the Toshiba CIX s support for each of the items covered in the test plan packages, with the following designations: Test item is supported. Test item is not supported. NA Test item is not applicable to the device type. Test item was not tested. Caveats or clarifications are identified in the Comments column. te that DUT in the following table refers to the Device Under Test which in this case is the Toshiba CIX. BroadWorks IP-PBX/PBX Trunking Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments Basic Call Origination Call Termination Session Audit Session Timer Ringback Forked Dialog Early UPDATE Early-Session 181 Call Being Forwarded Dial Plan DTMF Inband DTMF RFC 2833 DTMF DTMF Relay Codec Negotiation Codec Renegotiation SIP Connect Trunk Registration PBX Redirect Calling Line ID and Privacy E.164 Numbering BroadWorks Services Voice Message Deposit/Retrieval Message Waiting Indicator Diversion Header History-Info Header Enterprise Trunking - OTG Enterprise Trunking - DTG Enterprise Trunking - TGRP 2011 TOSHIBA. PAGE 7 OF 16
BroadWorks IP-PBX/PBX Trunking Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments DUT Services Call Control Services Advice of Charge Meet-Me Conferencing Call Waiting Call Hold Call Transfer Does not support Blind Transfer DUT Services Registration and Authentication Three-Way Call Register Authentication Maximum Registration Minimum Registration Invite Authentication Re-Invite/Update Authentication Refer Authentication Device Authenticating BroadWorks DUT Services Fax G711 Fax Passthrough G711 Fax Fallback T38 Fax Messaging SBC/ALG Register Outgoing Invite Incoming Invite TCP Register Outgoing Invite Incoming Invite 2.3 Known Issues This section lists the known interoperability issues between BroadWorks and specific partner release(s). Issues identified during interoperability testing and known issues identified in the field are listed. The following table provides a description of each issue and, where possible, identifies a workaround. The verified partner device versions are listed with an X indicating that the issue occurs in the specific release. The issues identified are device deficiencies or bugs, so typically not BroadWorks release dependent. The Issue Number is a BroadSoft ExtraView partner issue number if the testing was performed by BroadSoft. If the testing was performed by the partner or a third party, the partner may or may not supply a tracking number. 2011 TOSHIBA. PAGE 8 OF 16
For more information on any issues related to the particular partner device release, see the partner release notes. Issue Number Issue Description Partner Version 5.0 MR020 Strata CIX does not failback to primary Application Server for REGISTER requests X To support the BroadWorks redundancy implementation the access device must failback to the primary Application Server. The CIX sticks with the server it registered with until reboot, citing RFC 3261, section 10.2.4. This is not a significant issue unless the CIX always sends INVITEs to the server it is registered with. Workaround: ne. Strata CIX does not respond to OPTIONS message from BroadWorks X The CIX sends no response to OPTIONS message because the host part of SIP URI of To header is DUT s IP address so that DUT regards it as different from registered URI. This is a problem for BroadWorks redundancy scenarios, as BroadWorks uses the response to the OPTIONS message to determine if the BroadWorks user can be migrated. Any response to the OPTIONs message is acceptable. Does not need to be a 200 OK. Workaround: ne. 2011 TOSHIBA. PAGE 9 OF 16
3 Solution Configuration The following diagram shows an example of a typical deployment configuration with the Toshiba CIX. Typically, the Toshiba CIX is placed at the customer premise with SIP phones registered to it and is on a private network, necessitating an edge device or SBC. The Toshiba CIX registers each PBX user with BroadWorks via a Session Border Controller (SBC). te in the diagram following that the authentication username and password is the same for each PBX user that the Toshiba CIX registers. Toshiba CIX is identified as a BroadWorks PBX Classification Type F, subscriber registering. Refer to the BroadWorks Business Trunking Configuration Guide [5] for PBX classification descriptions. Refer to the SIP Trunking configuration table in Partner Configuration Guide Acme Packet Session Director [7] to determine how to configure Acme Packet for this PBX classification type. Figure 1 Toshiba Strata CIX Configuration Setup 2011 TOSHIBA. PAGE 10 OF 16
4 BroadWorks Configuration This section identifies the required BroadWorks device profile for the Toshiba CIX as well as any other unique BroadWorks configuration required for interoperability with the CIX. 4.1 BroadWorks Device Profile Configuration This section identifies the device profile to use when deploying the Toshiba CIX with BroadWorks. The following table identifies the required BroadWorks device identity/profile settings for interoperability between the CIX and BroadWorks. For an explanation of the profile parameters, refer to the BroadWorks Device Management Configuration Guide [3]. For most of the following parameters, an X indicates the parameter function is supported and/or required. If the item is blank, it is not supported. For items where text is supplied, the text content maps directly to the web page for adding or modifying a device profile. Toshiba CIX Identity/Device Profile Signaling Address Type Number of Ports Ringback Tone/ Early Media Support Authentication Registration Capable Intelligent Proxy Addressing Standard Options Unlimited RTP - Session Enabled X Static Registration Capable E.164 Capable Trusted Authenticate REFER RFC3264 Hold X X Video Capable Use History-Info Header Advanced Options Route Advance Wireless Integration PBX Integration X Add P-Called-Party-ID Auto Configuration Soft Client Requires BroadWorks Call Waiting Tone Advice of Charge Capable Forwarding Override Conference Device 2011 TOSHIBA. PAGE 11 OF 16
Toshiba CIX Identity/Device Profile Music On Hold Device Requires BroadWorks Digit Collection Requires MWI Subscription Support Call Center MIME Type Reset Event Trunk Mode t Supported User Web Based Configuration URL Extension Auto Configuration Options Auto Configuration Type t Supported Enable Monitoring CPE System File Name Device File Format 4.2 BroadWorks Configuration Steps There is no additional BroadWorks configuration steps required. 2011 TOSHIBA. PAGE 12 OF 16
5 CIX Configuration The Toshiba CIX with MIPU can be configured with Toshiba s Admin tool called emanager. The emanager utility can be run on a standalone PC or can be installed on a server and be accessed using HTTP. For more information regarding Programming and Configuration, visit Toshiba s F.Y.I website and download the Toshiba CIX Programming and Installation manual. The capabilities of the Toshiba CIX with MIPU have been verified for use with BroadWorks based on the settings described in the following table. For more information on the meaning, purpose, and applicability of the individual configuration items see the CIX Toshiba Programming and Installation manual. Configuration Files Files Provided by Partner Level Description CIX R500 MR020 MIPU01_03 The Toshiba CIX is configured using Toshiba s admin utility called, emanager. emanager VR500 A14 The Toshiba CIX is configured using Toshiba s admin utility called, emanager. emanager VR500 A14 The Toshiba CIX is configured using Toshiba s admin utility called, emanager. emanager VR500 A14 System System Subscriber System or Subscriber Contains the device firmware load. Contains configurable parameters that apply to all devices in a given deployment. Contains configurable parameters that apply to an individual device in a deployment. Any additional files that contain configurable parameters. 2011 TOSHIBA. PAGE 13 OF 16
5.1 System Level Configuration This section describes system-wide configuration items that are generally required for each Toshiba CIX with MIPU to work with BroadWorks. Subscriber-specific settings are described in the next section. Step Command Purpose System Configuration Step 1 In Program 100: Set the card type for the slot holding the MIPU The number of channels must match the number on the card Step 2 In Program 304: Assign an ILG number Set FK[01] = SIP Set FK [03] = DID Set FK [11] Number of DID digits The rest is default Step 3 In Program 306: Assign an OLG number Set FK[01] = SIP The rest is default Step 4 In Program 326 Assign a Channel Group number Set FK [01] = Equipment number Set FK [02] = LAN Interface number Set FK [03] = Total number of ports on this card Set FK[04] to match your ITSP Defines the MIPU card in the Toshiba CIX system. Defines the incoming line group for which to receive SIP calls. Defines an outgoing line group for which to send SIP calls. Defines the channel Group for the SIP Trunk. 2011 TOSHIBA. PAGE 14 OF 16
5.2 Subscriber Level Configuration Parameters This section identifies the device-specific parameters, including registration and authentication. These settings must be unique across devices to be matched with the settings for a BroadWorks subscriber. Provisioning a subscriber to register with BroadWorks allows calls to terminate to the subscriber s line. Registration requires that a unique address of record (AoR) is provisioned on BroadWorks and the phone; provisioning an AoR on BroadWorks consists of setting the line/port parameter to a unique value within the Application Server cluster. Step Command Purpose Subscriber parameters Step 1 In Program 327 Set the Service Definition Set FK[01] = Client Set FK[02] = ILG previously created Set FK[03] = OLG previously created Set FK[04] # of SIP trunks provided by ITSP Set FK[05] = FQDN Set FK[06] = IP Address of ISP Step 2 In Program 328 Set the Service Assignment Set FK[01] = Channel Group previously created Set FK[02] = Service number then select the ITSP to which the URIs belong to Step 3 In Program 328 FK[00] - Define the URI Service index FK[02] DN for URI FK[03] SIP URI Name FK[04] SIP URI password FK[05] Channel Group # Defines the Service Definition for the SIP Trunk. Defines the Service Assignment for the SIP Trunk. Defines the URI definitions. 2011 TOSHIBA. PAGE 15 OF 16
References [1] Toshiba, Inc. 2007. Installation and Maintenance Manual, Release 4.2. Available from Toshiba at http://fyi.tsd.toshiba.com. [2] Toshiba, Inc. 2007. Strata CIX General Description. Available from Toshiba at http://fyi.tsd.toshiba.com. [3] BroadSoft, Inc. 2010. BroadWorks Device Management Configuration Guide, Release 17.0. Available from BroadSoft at xchange.broadsoft.com. [4] BroadSoft, Inc. 2011. BroadWorks Redundancy Guide, Release 17.0. Available from BroadSoft at xchange.broadsoft.com. [5] BroadSoft, Inc. 2010. BroadWorks Business Trunking Configuration Guide, Release 17.0. Available from BroadSoft at xchange.broadsoft.com. [6] BroadSoft, Inc. 2010. BroadSoft Partner Configuration Guide Acme Packet Net- Net 3000/4000 series, Available from BroadSoft at xchange.broadsoft.com. [7] BroadSoft, Inc. 2011. BroadWorks IP-PBX/PBX Trunking Device Interoperability Test Plan, Release 17.0. Available from BroadSoft at xchange.broadsoft.com. 2011 TOSHIBA. PAGE 16 OF 16