BroadSoft Partner Configuration Guide

Transcription

1 BroadSoft Partner Configuration Guide Yealink SIP-TxP October 2010 Document Version th -5 th Floor,.63 Wanghai Road,2 nd Software Park Xiamen, Fujian, China tel: fax:

2 BroadWorks Guide Copyright tice Copyright YEALINK NETWORK TECHNOLOGY Copyright Yealink Network Technology Co.,LTD. All rights reserved. While reasonable efforts have been made to ensure the accuracy of this document, Yealink assumes no liability resulting from any omission or inaccuracies in this document or from use of the information obtained herein. Yealink reserves the right to make changes to any products described herein to improve reliability, function, or design, and reserves the right to revise this document and to make changes from time to time in content hereof with no obligation to notify any person of revisions or changes. Yealink does not assume any liability arising out of the application or use of any product described herein; neither does it convey license under its patent rights or the rights of others. Trademarks 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.

3 Document Revision History Version Reason for Change 1.1 Introduced document for Yealink SIP-T28 version Edited and published document. 1.3 Updated document for additional models. 1.4 Edited and published document. 1.5 Updated document for Yealink SIP-T28 version test with BroadWorks Release Update the document for Device Management 2010 YEALINK PAGE 3 OF 39

4 Table of Contents 1 Overview Interoperability Status Verified Versions Interface Capabilities Supported Known Issues BroadWorks Configuration BroadWorks Device Profile Configuration BroadWorks Configuration Steps SIP-TxP Configuration System Level Configuration Subscriber Level Configuration Parameters Shared Call Appearance Configuration Bob s Phone Configuration MAC.cfg Joe s Phone Configuration MAC.cfg Device Management Configuration Configure BroadWorks Tags Create System Default Tags Create Device Type Specific Tags Configure BroadWorks Device Profile Configuration Method 1: Import Configuration Method 2: Manual Create Device Profile Instance Configure Yealink TxP...31 Appendix A: Sample SIP-TxP Configuration Files References YEALINK PAGE 4 OF 39

5 Table of Figures Figure 1 Shared Call Appearance Configuration YEALINK PAGE 5 OF 39

6 1 Overview This document describes the configuration procedures required for a Yealink SIP-TxP series to make full use of the capabilities of BroadWorks. This includes the following models: SIP-T12P SIP-T20P SIP-T22P SIP-T26P SIP-T28P SIP-T80P The SIP-TxP is one of the many access devices that interoperate with BroadWorks. The SIP-TxP uses the Session Initiation Protocol (SIP) to communicate with BroadWorks for call control. It also translates voice to audio packets for transmission across a packet network. 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 SIP-TxP series. For more information, see the Yealink TxP SIP Phone User Manual [1] supplied by Yealink YEALINK PAGE 6 OF 39

7 2 Interoperability Status This section provides the known interoperability status of the Yealink SIP-TxP 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 Yealink. 2.1 Verified Versions The following table identifies the verified Yealink SIP-TxP 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 table below identify specific SIP-TxP 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 Yealink 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 SIP Access Device Interoperability Test Plan [4]. Verified Versions Table Date (mm/yyyy) BroadWorks Release SIP-TxP Verified Version SIP-TxP Compatible Versions 10/ SIP-T SIP-T SIP-T SIP-T SIP-T SIP-T / SP5 SIP-T SIP-T SIP-T SIP-T SIP-T SIP-T Any maintenance version of the verified versions. Any maintenance version of the verified versions YEALINK PAGE 7 OF 39

8 2.2 Interface Capabilities Supported The Yealink SIP-TxP has completed interoperability testing with BroadWorks using the BroadWorks SIP Access Device Interoperability Test Plan [4]. The results are summarized in the table below. 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. The Supported column in the table below identifies the Yealink SIP-TxP 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. NT test item was not tested. Caveats or clarifications are identified in the Comments column. te: DUT in the table below refers to the Device Under Test which in this case is the Yealink SIP-TxP. BroadWorks SIP Access Device 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 BroadWorks Services Dial Plan DTMF - Inband DTMF RFC 2833 DTMF DTMF Relay Codec Negotiation Codec Renegotiation Third-Party Call Control Basic Third-Party Call Control Advanced Voice Message Deposit/Retrieval Message Waiting Indicator NA 2010 YEALINK PAGE 8 OF 39

9 DUT Services Call Control Services DUT Services Registration and Authentication DUT Services Fax DUT Services Miscellaneous Advanced Phone Services Busy Lamp Field Advanced Phone Services Feature Key Synchronization Voice Portal Outcall Advanced Alerting Calling Line ID Connected Line ID Diversion Header History-Info Header Advice of Charge Call Waiting Call Hold Call Transfer Three-Way Call Network-Based Conference Register Authentication Maximum Registration Minimum Registration Invite Authentication Re-Invite/Update Authentication Refer Authentication Device Authenticating BroadWorks G711 Fax Passthrough G711 Fax Fallback T38 Fax Messaging Do t Disturb Call Forward Always Call Forward Always Diversion Inhibitor Anonymous Call Anonymous Call Block Remote Restart Via tify Busy Lamp Field Do t Disturb Do t Disturb Ring Splash Call Forward Call Forward Always Ring Splash Call Forward Always Diversion Inhibitor Call Center Agent Logon/Logoff 2010 YEALINK PAGE 9 OF 39

10 Advanced Phone Services Missed Calls Display Synchronization Advanced Phone Services Shared Call Appearance using Call Info Advanced Phone Services Shared Call Appearance using Dialog Event Advanced Phone Services Call Center Redundancy SBC/ALG Video Basic Video Calls Video BroadWorks Video Services Call Center Agent Unavailable Code Missed Calls Display Sync Line-Seize Call-Info / Lamp Management Public Hold Private Hold Multiple Call Arrangement Bridging Dialog Event Hold/Retrieve Multiple Call Arrangement Bridging Hold Reminder Call Information Hoteling Event Status Event Disposition Code Emergency Escalation Customer Originated Trace DNS SRV Lookup Register Failover/Failback Invite Failover/Failback Bye Failover Register Outgoing Invite Incoming Invite Call Origination Call Termination Call Hold Call Waiting Call Transfer Auto Attendant Voice Messaging Custom Ringback TCP Register 2010 YEALINK PAGE 10 OF 39

11 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 table below 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. For more information on any issues related to the particular partner device release, see the partner release notes. Issue Number Issue Description Partner Version issues identified YEALINK PAGE 11 OF 39

12 3 BroadWorks Configuration This section identifies the required BroadWorks device profile for the Yealink SIP-TxP as well as any other unique BroadWorks configuration required for interoperability with the SIP-TxP. 3.1 BroadWorks Device Profile Configuration This section identifies the device profile to use when deploying the Yealink SIP-TxP with BroadWorks. The following table identifies the required BroadWorks device identity/profile settings for interoperability between the SIP-TxP and BroadWorks. For an explanation of the profile parameters, refer to the BroadWorks Device Management Configuration Guide Fehler! Verweisquelle konnte nicht gefunden werden.. For most of the parameters below, 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. Yealink SIP-TxP Identity/Device Profile Signaling Address Type Intelligent Proxy Addressing Standard Options Number of Ports T12: 2 Ringback Tone/ Early Media Support T20: 2 T22: 3 T26: 3 T28: 6 T80: 6 Local Ringback Early Media Authentication Registration Capable Enabled X Static Registration Capable E.164 Capable Trusted Authenticate REFER RFC3264 Hold X Video Capable Use History-Info Header Advanced Options Route Advance Wireless Integration PBX Integration Add P-Called-Party-ID 2010 YEALINK PAGE 12 OF 39

13 Auto Configuration Soft Client Requires BroadWorks Call Waiting Tone Advice of Charge Capable Forwarding Override Conference Device Mobility Manager Device Music On Hold Device Requires BroadWorks Digit Collection Requires MWI Subscription Support Call Center MIME Type Reset Event Trunk Mode checksync User Web Based Configuration URL Extension Auto Configuration Options Auto Configuration Type 2 Config File Enable Monitoring CPE System File Name Device File Format 3.2 BroadWorks Configuration Steps other steps are needed on BroadWorks for setting up the device YEALINK PAGE 13 OF 39

14 4 SIP-TxP Configuration The SIP-TxP can be configured with a configuration file using the Trivial File Transfer Protocol (TFTP) or through its embedded web server. The following examples describe how to set the parameters using a configuration file. This configuration description assumes the SIP-TxP will use the Dynamic Host Configuration Protocol (DHCP) to obtain an IP address, TFTP server, and other network settings. The SIP-TxP should be configured to load the configuration file each time it resets or re-synchronizes. For detailed information on automated provisioning, see the Yealink TxP SIP Phone User Manual [1]. The capabilities of the SIP-TxP 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 Yealink TxP SIP Phone User Manual[1]. Configuration Files Files Provided by Partner Level Description y x.cfg system configuration file y x.cfg, where x associated with the hardware version of Yealink Device, i.e., y cfg for Yealink SIPT28P %BWMACADDRESS%.cfg device-specific configuration file 2010 YEALINK PAGE 14 OF 39

15 4.1 System Level Configuration This section describes system-wide configuration items that are generally required for each SIP-TxP to work with BroadWorks. Subscriber-specific settings are described in the next section. Step Command Purpose System Configuration File < y x.cfg > Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Set SIP Proxy/Domain. [ account ] path = /config/voip/sipaccount0.cfg SIPServerHost = as.broadworks.net SIPServerPort = 5060 Set Outbound Proxy. [ account ] path = /config/voip/sipaccount0.cfg UseOutboundProxy = 1 OutboundHost = sbc.broadworks.net OutboundPort =5060 Set SIP Timers. [ ADVANCED ] path = /config/voip/sipaccount0.cfg default_t1 = 0.5 default_t2 = 4 Set Register Expire Timer. [ account ] path = /config/voip/sipaccount0.cfg Expire = 3600 Enable reliable response. [ account ] path = /config/voip/sipaccount0.cfg Enable 100Rel = 1 Enable negotiated DTMF type. [ DTMF ] path = /config/voip/sipaccount0.cfg DTMFInbandTransfer = 1 Set the SIP-TxP series SIP server to the Fully Qualified Domain Name (FQDN) for the BroadWorks Application Server cluster. The domain must match the domain configured for the BroadWorks subscriber s line/port domain. Set the Outbound Proxy to the Session Border Controller (SBC) if one is deployed between the SIP-TxP series and BroadWorks. If there are redundant SBCs, set it to the FQDN for the SBC cluster. The SIP timers should be set to levels short enough to support a timely failover when there is no server response. Set the registration period. Reliable provisional response (PRACK) should be enabled. Set the SIP-TxP series to enable inband or RFC 2833 negotiated DTMF YEALINK PAGE 15 OF 39

16 4.2 Subscriber Level Configuration Parameters This section identifies the device-specific parameters, including registration and authentication. These settings must be unique across devices in order 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 for the <%BWMACADDRESS%.cfg > Step 1 Step 2 Step 3 Step 4 Enable a line to be used. [ account ] path = /config/voip/sipaccount0.cfg Enable = 1 Configure display name for a line. [ account ] path = /config/voip/sipaccount0.cfg DisplayName =Joe Set Register User ID for a line. [ account ] path = /config/voip/sipaccount0.cfg UserName = Enable SIP Authentication for a line. [ account ] path = /config/voip/sipaccount0.cfg AuthName = password = Enable a line of SIP-TxP series in use. For a line, configure the name to be displayed on the device. The register user ID must correspond with the line/port setting on BroadWorks. If the Authentication service is configured on BroadWorks, these parameters must be configured to match the BroadWorks settings YEALINK PAGE 16 OF 39

17 4.3 Shared Call Appearance Configuration The Shared Call Appearance (SCA) feature allows the administrator to add multiple locations to a given line. Any of the locations can be used to originate or receive calls. When a call comes in to an idle line, all the provisioned locations for that line are alerted. The first location to answer the call is connected to the originator. If the line is already active in a call, only the active location is alerted. A subscriber can originate calls from any of the configured locations. All other locations are unable to originate calls until all calls are released. It is recommended that the phone number plus an index (<phonenumber>_<index>) is used when provisioning the unique address of record (AoR) for each shared line. For example: _2. If a phone number does not exist, the MAC address plus an index could be used (<macaddress>_<index>). Figure 1 Shared Call Appearance Configuration Figure 1 Shared Call Appearance Configuration shows that Bob and Joe each have two lines and that Bob shares a line with Joe and Joe shares a line with Bob. The figure also shows the applicable Subscriber Profile and Shared Call Appearance Configuration data for subscribers Bob and Joe. When Bob ( ) is called, Bob s first line and Joe s second line will ring. When Joe ( ) is called, Joe s first line and Bob s second line will ring. The following steps show how to configure both phones for this Shared Call Appearance configuration. Configurations of SCA for the device, please refer to the example below: 2010 YEALINK PAGE 17 OF 39

18 4.3.1 Bob s Phone Configuration MAC.cfg SCA configurations specified in MAC.cfg. I.E, dc.cfg. where dc is the MAC Address of the SIP phone. The following steps are used to configure line 1 for Bob s phone. This line rings when Bob is called, so it has Bob s authentication information. Step Command Purpose Step 1 Step 2 Step 3 Step 4 Configure line as shared. ShareLine = 1; Set Register User ID. Example: UserName = _1; Enable SIP Authentication. Example: AuthName = bobsmith; password = bobs; Configure display name. Example: DisplayName = Bob Smith; Configure the line as shared (as opposed to private ). The register user ID must correspond with the line/port setting on BroadWorks. If the Authentication service is configured on BroadWorks, these parameters must be configured to match the BroadWorks settings. This line rings when Bob is called, so it has Bob s authentication information. Configure the name to be displayed on the device for this line. The following steps are used to configure line 2 for Bob s phone. This line rings when Joe is called, so it has Joe s authentication information. Step Command Purpose Step 1 Step 2 Step 3 Step 4 Configure line as shared. ShareLine = 1; Set Register User ID. Example: UserName = _2 ; Enable SIP Authentication. Example: AuthName = joebrown ; password = joeb ; Configure display name. Example: DisplayName = Joe Brown ; Configure the line as shared (as opposed to private ). The register user ID must correspond with the line/port setting on BroadWorks. If the Authentication service is configured on BroadWorks, these parameters must be configured to match the BroadWorks settings. This line rings when Joe is called, so it has Joe s authentication information. Configure the name to be displayed on the device for this line YEALINK PAGE 18 OF 39

19 4.3.2 Joe s Phone Configuration MAC.cfg The following steps are used to configure line 1 for Joe s phone. This line rings when Joe is called, so it has Joe s authentication information. Step Command Purpose Step 1 Step 2 Step 3 Step 4 Configure line as shared. ShareLine = 1 ; Set Register User ID. Example: UserName = _1 ; Enable SIP Authentication. Example: AuthName = joebrown ; password = joeb ; Configure display name. Example: DisplayName = Joe Brown ; Configure the line as shared (as opposed to private ). The register user ID must correspond with the line/port setting on BroadWorks. If the Authentication service is configured on BroadWorks, these parameters must be configured to match the BroadWorks settings. This line rings when Joe is called, so it has Joe s authentication information. Configure the name to be displayed on the device for this line. The following steps are used to configure line 2 for Joe s phone. This line rings when Bob is called, so it has Bob s authentication information. Step Command Purpose Step 1 Step 2 Step 3 Step 4 Configure line as shared. ShareLine = 1 ; Set Register User ID. Example: UserName = _2 ; Enable SIP Authentication. Example: AuthName = bobsmith ; password = bobs ; Configure display name. Example: DisplayName = Bob Smith ; Configure the line as shared (as opposed to private ). The register user ID must correspond with the line/port setting on BroadWorks. If the Authentication service is configured on BroadWorks, these parameters must be configured to match the BroadWorks settings. This line rings when Bob is called, so it has Bob s authentication information. Configure the name to be displayed on the device for this line YEALINK PAGE 19 OF 39

20 5 Device Management Configuration The BroadWorks Device Management feature provides the capability to automate generation of device configuration files. This section identifies the steps required to enable the Yealink SIP-TxP phones for device management. For Device Management configuration details not covered here, refer to the BroadWorks Device Management Configuration Guide [2]. 5.1 Configure BroadWorks Tags The Yealink SIP-TxP makes use of dynamic tags which may be configured by a BroadWorks administrator as either system default or device type specific tags. This section identifies the required tags Create System Default Tags Browse to System Resources Device Management Tag Sets and select the System Default tag set. Add the system default tags in the table below if they do not already exist. Tag Name Valid Settings Description %SNTP_SERVER_1% IP address / FQDN NTP server address %SNTP_SERVER_2% IP address / FQDN NTP server address alternate %DNS_SERVER_1% IP address DNS server address %DNS_SERVER_2% IP address DNS server address alternate %SBC_ADDRESS% IP address / FQDN SBC SIP address %SBC_PORT% Port SBC SIP port %USE_SBC_BOOLEAN% 0/1 Use SBC: 1=yes, 0=no Example system default tag settings: 2010 YEALINK PAGE 20 OF 39

21 5.1.2 Create Device Type Specific Tags Browse to System Resources Device Management Tag Sets and select Add to add a new tag set. Configure the tag set name using the device name Yealink TxP Tags. Add the device type specific tags in the following table to the device tag set. Tag Name Valid Settings Description %COUNTRY% %LANGUAGE% United States Australia Austria Brazil Belgium China Czech Denmark Finland France Germany Great Britain Greece Hungary Lithuania India Italy Japan Mexico New Zealand Netherlands rway Portugal Spain Switzerland Sweden Russia Chile Czech ETSI English Chinese Simplified Chinese Traditional French German Italian Polish Portuguese Turkish Spanish Identifies country for standard ringtones Web management and phone LCD language 2010 YEALINK PAGE 21 OF 39

22 Example device type specific tag settings:. 5.2 Configure BroadWorks Device Profile There are two BroadWorks device profile configuration methods described: import and manual. It is necessary to perform only one of the BroadWorks configuration methods. The import method is quick and easy. The manual method walks the administrator through each step Configuration Method 1: Import This section identifies the steps necessary to make use of the Device Management import feature to configure BroadWorks to add the Yealink SIP-TxP as a Device Managementenabled device type. The import method is available in BroadWorks Release 17.0 and later. For previous release, use the manual configuration method described in the next section. Download the Yealink TxP CPE kit from BroadSoft Xchange ( Extract the DTAF file from the CPE kit. This is the import file. Login to BroadWorks as an administrator. Browse to System Resources Identity/Device Profile Types and select Import. Select Browse to find the extracted DTAF file and select OK to start the import. After the import finishes, the following post-import configuration steps must be completed. Browse to System Resources Identity/Device Profile Types and perform a search to find the imported Yealink device profile type, Yealink TxP. Browse to the Profile page and change the Device Management Device Access FQDN to your XSP or XSP cluster address. Example: 2010 YEALINK PAGE 22 OF 39

23 Firmware files must be obtained from Yealink. These files are not included in the import. Complete the steps in section Static Files to define the static firmware files and to upload the firmware. te: the non-firmware static files in section are included in the import Configuration Method 2: Manual This section identifies the manual steps necessary to configure BroadWorks to add the Yealink SIP-TxP as a Device Management-enabled device type. The manual method must be used for BroadWorks release prior to Release The manual method is an optional method in Release 17.0 and later Modify Device Profile Type This section identifies the BroadWorks device profile type settings relevant to Device Management for the Yealink TxP. Browse to System Resources Identity/Device Profile Types and perform a search to find the Yealink device profile type created in section YEALINK PAGE 23 OF 39

24 The Standard Options and Advanced Options should already be configured as specified in section 3.1. This section identifies the required settings for Auto Configuration Options and Device Management Configure Auto Configuration Options Modify the device profile type Auto Configuration Options as directed in the table below. te: these are common settings that apply to all devices enabled for Device Management. Parameter Value Description / tes Auto Configuration Type 2 Config File This setting activates the Device Management configuration items. The 2 Config File button has no relevance to Device Management, but only activates the setting field, CPE System File Name not_used This field is not used by Device Management and should be set to not_used. Device File Format not_used This field is not used by Device Management and should be set to not_used. Example Auto Configuration Options settings: Configure Device Management Options Modify the device profile type Device Management Options as directed in the table below. te: these are common settings that apply to all devices enabled for Device Management. Parameters not identified in the table below can normally be left as defaults. Parameter Value Description / tes Device Configuration Tags Allow Identity/Device Profiles to Configure Custom Tags Allow Groups to Configure Custom Tags Device Access Protocol Use Default System Tag Set and Tag Set Select the device tag set created in section Fehler! Verweisquelle konnte nicht gefunden werden.. checked checked http Optional Optional 2010 YEALINK PAGE 24 OF 39

25 Device Access FQDN Device Access Port Device Access Context Name Device Access URI <BroadWorks-XSP-Cluster- Address> Example: xsp.iop1.broadworks.net <BroadWorks-XSP-Port> Example: 80 dms <device-name> Example: Yealink-TxP Set to the XSP cluster FQDN if using an XSP farm. Otherwise, set to the individual XSP FQDN or IP address. Should be set to 80. This does not need to be defined. BroadWorks defaults to the systemdefined value. This defines the directory the XSP uses to access the configuration files. Example Device Management Options settings: Define Device Profile Type Files This section describes the BroadWorks Device Management configuration necessary to identify the config files and other files that the Yealink TxP downloads. In order to define the files, configuration templates, firmware and other files the TxP uses must be uploaded to BroadWorks. Download the Yealink TxP CPE kit from BroadSoft Xchange ( Extract the config files from the CPE kit. Obtain the firmware files directly from Yealink. Browse to System Resources Identity/Device Profile Types Files and Authentication to add the files YEALINK PAGE 25 OF 39

26 System File Each TxP model downloads a model-specific system file, named as follows: y cfg y cfg y cfg y cfg y cfg Add a BroadWorks device profile type file to the Yealink TxP device profile for each of the system files using the settings described in the table below. Parameters not identified in the table below can normally be left as defaults. Parameter Value Description / tes Device Access File Format Repository File Format <system-file-name> Example: y cfg <system-file-name> Example: y cfg This is the filename the phone uses to request the file. This is the filename as stored on the Device Management repository. File Category Dynamic Per-Type Only one system file is generated for the profile type. File Customization Administrator This identifies who can customize the system file template. Assign File Custom Authentication Mode t set The system file is not authenticated so do not select either of the options. After defining the system file type, upload the corresponding system file template downloaded from BroadSoft Xchange. Use the Browse button on the file definition screen. Be sure to select Apply after uploading the file. Reminder: repeat these steps for each of the system files identified above. Example System File settings: 2010 YEALINK PAGE 26 OF 39

27 Device-Specific File Each TxP phone downloads a phone-specific file based on the phone s MAC address using the filename format below: <mac-address>.cfg Add a BroadWorks device profile type file to the Yealink TxP device profile for the device specific file using the settings described in the table below. Parameters not identified in the table below can normally be left as defaults. Parameter Value Description / tes Device Access File Format %BWMACADDRESS%.cfg This is the filename format the phone uses to request the file. Repository File Format %BWDEVICEID%.txt This is the filename format as stored on the Device Management repository. File Category Dynamic Per-Type Only one system file is generated for the profile type. File Customization Administrator and User This identifies who can customize the system file template. Assign File Custom Authentication Mode User Name and Password The phone-specific file is authenticated with user name and 2010 YEALINK PAGE 27 OF 39

28 Device Access HTTP Authentication Digest password.. After defining the device-specific file type, upload the corresponding device-specific file template downloaded from BroadSoft Xchange. Use the Browse button on the file definition screen. Be sure to select Apply after uploading the file. Example Device-Specific File settings: Static Files Static files are files such as firmware and media files that are not configurable and/or do not make use of the dynamic BroadWorks Device Management tags. The Yealink TxP requires the following static files: <firmware-version>.rom zhongguo.wav lang+english.txt contactdate.xml AutoDST.xml 2010 YEALINK PAGE 28 OF 39

29 Each TxP model requires a different firmware file. Static files must be created for each firmware file. Add a BroadWorks device profile type file to the Yealink TxP device profile for each of the static files using the settings described in the table below. Parameters not identified in the table below can normally be left as defaults. Parameter Value Description / tes Device Access File Format Repository File Format <file-name> Examples: rom zhongguo.wav <file-name> Examples: rom zhongguo.wav This is the filename the phone uses to request the file. This is the filename as stored on the Device Management repository. Use the same name as the actual file name. File Category Static This is a static file. There are no dynamic tags in the file. File Customization Disallow This file must not be modified. Assign File Custom Authentication Mode t set The static files are not authenticated so do not select either of the options. After defining the static file types, upload the corresponding static files. Firmware must be obtained from Yealink. The other files are available on BroadSoft Xchange. Use the Browse button on the file definition screen. Be sure to select Apply after uploading the file. Reminder: repeat these steps for the firmware file for each Yealink model as well as the other files listed above. Example Static File settings: 2010 YEALINK PAGE 29 OF 39

30 5.3 Create Device Profile Instance This section describes how to create a BroadWorks device profile instance for an individual Yealink TxP phone. Device profile instances are normally created at the BroadWorks Group level and assigned to users. Browse to the BroadWorks <group> Resources Identity/Device Profiles and select Add to add a new Yealink TxP device profile. Define the device profile instance using the settings described in the table below. Parameters not identified in the table below can normally be left as defaults. Parameter Value Description / tes Identity/Device Profile Name Idenity/Device Profile Type <device-profile-name> Example: Yealink T12-01 <yealink-txp-device-profile-type> Example: Yealink TxP The device profile name is a unique identifier for the device profile instance. Select from the dropdown the Yealink device profile type created in the previous secitons. Authentication Use Custom Credentials Use unique login and password for each phone. Device Access User Name <phone-login-name> Example: bsmith The phone login user naming convention must be determined by the service provider YEALINK PAGE 30 OF 39

31 Device Access Password <phone-login-password> Example: bsmith456 Example Identity/Device Profile Add settings: 5.4 Configure Yealink TxP This section describes the steps necessary to configure the Yealink TxP for integrating with BroadWorks Device Management. Login to the WEB UI for the TxP phone. Browse to the Upgrade web page. Set the Check New Config to Power On and fill in the Device Management server address URL. Restart the phone and supply the BroadWorks device access user username and password when prompted during boot up. Example login screen (default Username/Password: admin/admin): 2010 YEALINK PAGE 31 OF 39

32 Example Upgrade screen: YEALINK PAGE 32 OF 39

33 Appendix A: Sample SIP-TxP Configuration Files NOTE: The following samples are examples and should be used as a reference only. DO NOT CUT AND PASTE THESE EXAMPLES TO GENERATE YOUR CONFIGURATION FILES. Use the configuration files obtained from Yealink with the specific release to generate your configuration files. System Default File: y x.cfg NOTE: This is an example file and should be used for reference only. # #Network Settings [ WAN ] path = /config/network/network.cfg WANType = 0 [ LAN ] path = /config/network/network.cfg LANTYPE = 1 RouterIP = LANSubnetMask = EnableDHCP = 1 DHCPStartIP = DHCPEndIP = [ VLAN ] path = /config/network/network.cfg #ISVLAN,VID and USRPRIORITY are used for VLAN on LAN port #PC_PORT_VLAN_ENABLE,PC_PORT_VID and PC_PORT_PRIORITY are used for PC port ISVLAN = 0 VID = USRPRIORITY = PC_PORT_VLAN_ENABLE = 0 PC_PORT_VID = 0 PC_PORT_PRIORITY = 0 [ QOS ] path = /config/network/network.cfg SIGNALTOS = 40 RTPTOS = 40 # #Time Settings [ Time ] path = /config/setting/setting.cfg TimeZone = +8 TimeZoneName = China(Beijing) TimeServer1 = cn.pool.ntp.org TimeServer2 = cn.pool.ntp.org 2010 YEALINK PAGE 33 OF 39

34 Interval = 1000 SummerTime = 2 DSTTimeType = 0 TimeZoneInstead = 8 StartTime = 1/1/0 EndTime = 12/31/23 TimeFormat = 1 DateFormat = 0 OffSetTime = 60 # #Feature Settings [ Features ] path = /config/features/phone.cfg Call_Waiting = 1 Hotlinenumber = BusyToneDelay = 3 LCD_Logo = 1 DND_Code = 480 Refuse_Code = 486 DND_On_Code = %BWFAC-DND-ACTIVATE-1% DND_Off_Code = %BWFAC-DND-DEACTIVATE-1% ButtonSoundOn = 1 CallCompletion = 0 AllowIntercom = 1 IntercomMute = 0 IntercomTone = 1 IntercomBarge = 1 Call_WaitingTone = 1 Hotlinedelay = 4 BroadsoftFeatureKeySync = 1 # #Updating firmware Settings [ firmware ] path = /tmp/download.cfg server_type = http server_ip = server_port = 80 login_name = yealink login_pswd = http_url = firmware_name = rom ## Firmware Version for Yealink T28 # #Updating File Settings [ ringtone ] path = /tmp/download.cfg server_address = TxP_dm/zhongguo.wav [ Lang ] path = /tmp/download.cfg 2010 YEALINK PAGE 34 OF 39

35 server_address = TxP_dm/lang+English.txt [ ContactList ] path = /tmp/download.cfg server_address = TxP_dm/contactData1.xml # #Autoprovision Settings [ autoprovision ] path = /config/setting/autop.cfg mode = 1 server_address = user = yealink password = [ PNP ] path = /config/setting/autop.cfg Pnp = 1 # #Other Settings [ Trans ] path = /config/features/phone.cfg IsOnHookTrans = 1 [ AutoRedial ] path = /config/features/phone.cfg EnableRedial = 0 RedialInterval = 10 RedialTimes = 10 [ PoundSend ] path = /config/features/phone.cfg Enable = 1 ###### # key as send: 1, * key as send:2 [ ReplaceRule ] path = /config/setting/advsetting.cfg ReplaceAll = 1 Phone-Specific File: %BWMACADDRESS%.cfg NOTE: This is an example file and should be used for reference only. # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # ## Account Registration Settings [ account ] path = /config/voip/sipaccount0.cfg 2010 YEALINK PAGE 35 OF 39

36 Enable = %BWLINE-BINARY-1% Label = %BWEXTENSION-1% DisplayName = %BWCLID-1% AuthName = %BWAUTHUSER-1% UserName = %BWLINEPORT-1% password = %BWAUTHPASSWORD-1% SIPServerHost = %BWHOST-1% SIPServerPort = 5060 UseOutboundProxy = 1 OutboundHost = OutboundPort = 5060 Transport = 0 AnonymousCall = 0 RejectAnonymousCall = 0 MissedCallLog = 1 AutoAnswer = 0 # #Account Function Settings [ account ] path = /config/voip/sipaccount0.cfg ShareLine = %BWSHAREDLINE-1% conf-type = 2 conf-uri =%BWNETWORK-CONFERENCE-SIPURI-1% [ blf ] path = /config/voip/sipaccount0.cfg SubscribePeriod = 1800 BLFList_URI = %BWBLF-USER-1% # #Account Feature Settings [ AlwaysFWD ] path = /config/features/forward.cfg Enable = %BWCFA-BINARY-1% Target = On_Code = %BWFAC-CFA-ACTIVATE-1% Off_Code = %BWFAC-CFA-DEACTIVATE-1% [ BusyFWD ] path = /config/features/forward.cfg Enable = Target = On_Code = %BWFAC-CFB-ACTIVATE-1% Off_Code = %BWFAC-CFB-DEACTIVATE-1% [ TimeoutFWD ] path = /config/features/forward.cfg Enable = Target = Timeout = On_Code = %BWFAC-CFNA-ACTIVATE-1% Off_Code = %BWFAC-CFNA-ACTIVATE-1% # #Programmable Key Settings 2010 YEALINK PAGE 36 OF 39

37 [ memory1 ] path = /config/vpphone/vpphone.ini Line = 0 Value = %BWEXTENSION-1% PickupValue = DKtype = 21 [ memory2 ] path = /config/vpphone/vpphone.ini Line =0 Value = PickupValue = DKtype = 39 [ memory3 ] path = /config/vpphone/vpphone.ini Line = 0 Value = PickupValue = DKtype = 39 [ memory4 ] path = /config/vpphone/vpphone.ini Line = 0 Value = PickupValue = DKtype = 39 [ memory5 ] path = /config/vpphone/vpphone.ini Line = 1 Value = %BWFAC-CALL-PARK-1% PickupValue = DKtype = 10 [ memory6 ] path = /config/vpphone/vpphone.ini Line = 1 Value = %BWFAC-CALL-PARK-RETRIEVE-1% PickupValue = DKtype = 13 [ memory7 ] path = /config/vpphone/vpphone.ini #Set Memory key7 Line = 1 Value = %BWFAC-CALL-PICKUP-1% PickupValue = DKtype = 9 [ memory8 ] path = /config/vpphone/vpphone.ini #Set Memory key8 Line = 1 Value = %BWFAC-DIRECTED-CALL-PICKUP-1% PickupValue = DKtype = 9 [ memory9 ] path = /config/vpphone/vpphone.ini #Set Memory key9 Line = 1 Value = %BWFAC-CLEAR-MWI-1% PickupValue = DKtype = 13 [ memory10 ] 2010 YEALINK PAGE 37 OF 39

38 path = /config/vpphone/vpphone.ini #Set Memory key10 Line = 1 Value = PickupValue = %BWFAC-VOICE-PORTAL-ACCESS-1% DKtype = 13 #Take Yealink SIP T28P as example, There is 10 DSS Key,6 Line Key and 14 Softkey you #can defined just refer to the above settings. ##Other Settings (I.E., User Language,Communication Codecs user support ##and so on [ Lang ] path = /config/setting/setting.cfg #WebLanguage is the setting of language on web management ActiveWebLanguage = %LANGUAGE% WebLanguage = %LANGUAGE% [ audio1 ] path = /config/voip/sipaccount0.cfg enable = 1 PayloadType = PCMA priority = 2 rtpmap = 8 [ audio2 ] path = /config/voip/sipaccount0.cfg enable = 0 PayloadType = G723_53 priority = 0 rtpmap = 4 [ audio3 ] path = /config/voip/sipaccount0.cfg enable = 0 PayloadType = G723_63 priority = 0 rtpmap = YEALINK PAGE 38 OF 39

39 References [1] Yealink, Inc Yealink TxP SIP Phone User Manual, Release Available from Yealink at Phone [2] BroadSoft, Inc BroadWorks Device Management Configuration Guide, Release Available from BroadSoft at [3] BroadSoft, Inc BroadWorks Redundancy Guide, Release Available from BroadSoft at [4] BroadSoft, Inc BroadWorks SIP Access Device Interop Test Plan, Release Available from BroadSoft at YEALINK PAGE 39 OF 39