Home

BroadSoft Partner Configuration Guide

1. SBC ADDRESS IP address FQDN SBC SIP address SBC PORT Port SBC SIP port The port should be set if the defined SBC address is an IP address If the SBC address is an FQDN the SBC port should be left unset USE SBC BOOLEAN 0 1 Use SBC 1 yes 0 no BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 44 OF 75 Yealink Example System Default Tag Settings System Welcome Default Administrator Logout Options Profile Device Management Tag Sets Modify Display all the device management tags defined in the tag set Tags can be added to the set or deleted from Resources the set Services Communication Barring add _J Utilities Tag Set Syster Default Delete Tay Name a Tag Value APPLICATION DOONAN So as japi broadworks net KONS SERVER 1 199 19 193 12 DNS SERVER 2 199 19 193 39 DNS SERVER 199 19 193 12 SSAC ADDRESS skbc1l iop1 broadworks net 5BC PORT 5060 MHSNTP SERVER 1 time a nist gov ENTP SERVER 2 time b nist gov SEMTP SERVER time b nist gov USE SBC BOOLEAN 1 DI A A A D D A A A D Page 1 of 1 Figure 2 System Default Tag Settings 5 2 1 2 Create Device Type Specific Tags Browse to System Resources Device Management Tag Sets and click Add to add a new tag set Configure the tag set name using the device name appended by Tags Yealink SIP TxP Tags Add the device type specific tags in the following
2. vem Custom Option SES MEME Ne rag 9 Specify the DHCP Option that URL http Asp1 iop1 broadworks net 80 0 you want to use for provisioning Refer to Auto Account yeawh1 f Provision Manual for details about provisioning Password sa000 AES Key Common AES Key It is provided by ISP pr Click this button to auto PNP Config Enabled provision immediately Click this button to auto Check New Config Power on provision immediately Click this button to auto provision Export Import immediately Auto provision ConfigExport the configuraion files to backup Export Import Confi Browse the settings and could import ikal Aa 3 al the settings after reset Import Export System Log There are two methods to Export System Log Local export the system log Local or Server Export PCAP Trace Start Stor Confirm Cancel Figure 16 Upgrade Screen 5 3 Upgrading from Previous CPE Kits The configuration sections above are primarily structured around importing or manually configuring the Yealink device profile types for the first time Many of the steps are unnecessary when upgrading to a new firmware release or CPE kit version 5 3 1 General Recommendations for Upgrades Upgrades can be resource intensive if not managed properly Recommendations for a managed upgrade include BROADSOFT PARTNER CONFIGURATION GU
3. Call Park Enabled Remote Control Group Call Park Enabled Phone Lock Visual Alert for Parked Call Enabled ACD Audio Alert for Parked Call Enabled Action URL 4 5 Instant Message and Presence Configuration This section applies to SIP phones soft clients and other devices that provide a user interface Note Only the T38G customized version supports this feature so if you need this special feature please contact our support team by the email support yealink com Firstly Enabled the UC Active function by the follow autop statement features uc enable 1 1 Enabled 0 Disabled The other two autop configuration statements features uc username The uc username features uc password The uc password Secondly following the path of phone s webpage Phone Features Auto Call Distribution Settings filled in the associated parameter UC Username and UC Password BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 40 OF 75 Yealink Refer to the figure below Logout Yealink Features Always Features z Forward This feature allows you to Farget forward an incoming call to another phone number Status Account Network DSS Key Contacts Security Upgrade Busy Target The number to which the incoming calls will be forwarded Auto Provision Target Configuration No Answer On Code The code that will be sent to PBK when it is switch
4. Hybrid Key System emulation requires the phone to support assignment of multiple line keys to a single registering line on the phone It also requires the phone to limit each line key to a single call appearance or provide the configurability to roll a new call over to the next free line key Any of the locations can be used to originate or receive calls Firstly From the Shared Call Appearance configuration web page select Add to add a second appearance Options Profile Incoming Calls Outgoing Calls b Call Control Client Applications Messaging Service Scripts Utilities The host line BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Shared Call Appearance Help Home Welcome Admin2 Yealink Logout Shared Call Appearance allows administrators to allocate additional devices or lines to you These devices or lines also ring just like your primary phone Define the line policy on Device Policies page ne ETS EHE E v Alert all appearances for Click to Dial calls E Alert all appearances for Group Paging calls IM Allow Call Retrieve from another location Multiple Call Arrangement on off v Allow bridging between locations Enable Call Park notification Bridge Warning tone None 9 Barge in only Barge in and repeat every 30 seconds Device Policies Confiqure device policies Delete Identi ice Profile Type A El Yealink TxP_dm It DM Group
5. lt X X X gt rom Example 34 71 0 60 rom 31 lt x X X gt rom Example 31 71 0 15 rom T lt X X X gt rom Example 7 71 0 10 rom 6 lt X X X gt rom Example 6 71 0 10 rom 2 lt X X X gt rom Example 2 71 0 10 rom 32 lt X X X gt rom Example 32 0 0 40 rom 38 lt X X X gt rom Example 38 0 0 40 rom See Appendix B 0 1 String String String String String BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Description T21P FIRMWARE VERSION T19P FIRMWARE VERSION T22P FIRMWARE VERSION T26P FIRMWARE VERSION T28P FIRMWARE VERSION T32G FIRMWARE VERSION T38G FIRMWARE VERSION Defines the time zone name Enabled or Disabled the ACD function 0 Disabled 1 Enabled This tag is used for v71 or above Define the autoprovision server url Define the bw_phonebook enterprise displayname Define the bw_phonebook group displayname Enabled or Disabled the call waiting function 0 Disabled 1 Enabled Configure the direct pickup code that depends on the system defined such as 97 Configure the group pickup code that depends on the system defined such as 98 20 BD5265 00 PAGE 47 OF 75 Yealink Tag Name Valid Settings Description AUTO ANSWER BINAR 0 Enabled or Disabled the auto Y i answer function of each line 0 Disabled 1 Enabled The X ranged from 1 to 6 It depends on the specific line numbers of the sip
6. Address HTTP Download Using Xtended Services Platform FQDN HTTP Download Using Xtended Services Platform Cluster FQDN HTTP Download With Double Slash HTTPS Download Using Xtended Services Platform IP Address HTTPS Download Using Xtended Services Platform FQDN HTTPS Download Using Xtended Services Platform Cluster FQDN Inspect System Config File Inspect Device Specific Config File Inspect Other Config Files Inspect Static Files Inspect SIP Settings Inspect Line Settings Inspect Service Settings HTTP Upload Using Xtended Services Platform IP Address HTTP Upload Using Xtended Services Platform FQDN HTTP Upload Using Xtended Services Platform Cluster FQDN Register with Authentication Call Origination Call Termination Remote Restart Shared Line Origination Shared Line Termination Shared Line Status Busy Lamp Field Supported Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No Yes Yes Yes Yes Yes Yes Yes Yes Comments Except T19P 20 BD5265 00 PAGE 43 OF 75 Yealink BroadWorks Device Management Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments Network Based Conference Yes 5 2 Device Management Configuration This section identifies the steps required to enable the Yealink SIP TxP T3xG phones for device management For Device Management configuration details not covered here ref
7. BroadWorks release level that is the same as or prior to the release being imported to If the DTAF file is at a release level later than the release being imported to the import can fail Otherwise use the manual method 5 2 2 1 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 T3xG as a Device Management enabled device type The import method is available in BroadWorks Release 17 0 and later For previous releases use the manual configuration method described in the next section Download the Yealink SIP TxP T3xG CPE kit from BroadSoft Xchange at xchange broadsoft com Extract the DTAF file s from the CPE kit These are the import files Repeat the following steps for each model you want to import 1 Log into BroadWorks as an administrator 2 Browse to System Resources Identity Device Profile Types and select Import 3 Click Browse to find the extracted DTAF file for the model and click OK to start the import After the import finishes complete the following post import configuration 4 Browse to System Resources Identity Device Profile Types 5 Perform a search to find the imported Yealink device profile type Yealink SIP TxP T3xG 6 Browse to the Profile page and change the Device Management Device Access FQDN to your Xtended Services Platform or Xtended Services Platform clus
8. Hotline Number Hotline Delay O 10s Busy Tone Delay Seconds D Return Code When Refuse Return Code When DND Call Completion Feature Key Synchronization Time Out For Dial Now Rule 1 Features Network DSSKey Enabled Disabled 1 300s 10 10 Enabled 4 4 oMOODODSDSDDDSDSDDDSDSVD 486 Busy Here X 480 Temporarily Not Av w Disabled 4 Enabled 4 Log Out Directory Security Call Waiting This call feature allows your phone to accept other incoming calls during the conversation Settings Key As Send Select or as the send key Hotline Number When you pick up the phone it will dial out the hotline number automatically 20 BD5265 00 PAGE 33 OF 75 Yealink 4 3 4 Call Center Feature Configuration This section provides configuration instructions to configure the phone to enable integration with BroadWorks Call Center features including but not limited to call information hoteling status and disposition codes The call center feature is supported with firmware v71 or above 1 The Configuration of the server Group gt Users 2413333558 Call Centers Profile Call Centers displays your current ACD state and all the ACDs you belong to and whether you are currently joined in their call centers You can set your ACD state and join or remove yourself from that ACD s call center if permitted by your administrator Call Center Service Assigned Premium ACD State S
9. Synchronization Private Line Advanced Phone Services Feature Key Synchronization Shared Line Advanced Phone Services Missed Calls Display Synchronization Advanced Phone Services Shared Call Appearance using Call Info Advanced Phone Services Call Center Advanced Phone Services Call Park Test Plan Package Items Remote Restart Via Notify Busy Lamp Field Call Park Notification Do Not Disturb Do Not Disturb Ring Splash Call Forwarding Call Forwarding Always Ring Splash Call Forwarding Always Diversion Inhibitor Call Center Agent Logon or Logoff Call Center Agent Unavailable Code Do Not Disturb Do Not Disturb Ring Splash Call Forwarding Call Forwarding Always Ring Splash Call Forwarding Always Diversion Inhibitor Missed Calls Display Sync Line Seize Call Info or Lamp Management Public Hold Private Hold Hybrid Key System Multiple Call Arrangement Bridging Call Park Notification Hold Reminder Call Information Hoteling Event Status Event Disposition Code Emergency Escalation Customer Originated Trace Call Park Notification Supported Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Comments Except T19P 20 BD5265 00 PAGE 12 OF 75 Yealink BroadW
10. User ID LDAP Password 00000000 Network Directory Nebe Der om f ee we Multicast IP Setting Enabled v Group Enterprise Disabled Enterprise Group Common Disabled GroupCommon Enterprise Common Disabled EnterpriseCommon Personal Enabled Personal Custom Directory Enable Custom Directory Disabled Network Call Log Enabled v 4 4 1 BroadWorks User Service Configuration Integration with the BroadWorks Xtended Services Interface for User Service Configuration enables the phone to display and configure BroadWorks user services such as Remote Office BroadWorks Anywhere Call Forwarding and Simultaneous Ring To enable user service configuration follow the instructions below Step Command Purpose Step 1 account 1 xsi user Set the Xsi login user name and account 1 xsi password password for line 1 Example account 1 xsi user 2405551111 account 1 xsi password 123456 Set the IP address or domain Step 2 account 1 xsi host p name of the XSP server Example account 1 xsi host xsp1 iop1 broadworks net Step 3 account 1 xsi server_type Set the transport type for Xsi Example account 1 xsi server_type http Step 4 account 1 xsi port Set the transport port for Xsi Example account 1 xsi port 80 4 4 2 BroadWorks Directory Configuration Integration with the BroadWorks Xtended Services Interface for Directories enables the phone to download personal group and enterprise directories from B
11. Y ealink lt model gt properties DialNow xml Dialing xml File Type System level Device specific Static Time Zone Alias Device specific System level Static Static Static Static Static Time Zone Alias Static Static BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Description This file contains device specific parameters that the phone needs to load This file contains system level parameters that the phone needs to load Ringtone WAV format file Default language file This file contains the contact information in XML format T38xG contactData xml TxP contactData1 xml From the V71 version this parameter is unified as below TKP contact xml Specifies the dialing rules Rules set of the beginning and end of Day Light Savings Time The Time zone Alias file is a BroadWorks Device Management file used to map time zone identifiers between BroadWorks and Yealink phones A Time zone Alias file is required for each model This data file specifies the dial now rules for the phone This data file specifies the soft keys available on the phone in the call failed calling state 20 BD5265 00 PAGE 55 OF 75 Yealink File Name CallFailed xml Callln xml Connecting xml Ringback xml Talking xml wallpaper jpg ScreenSaver png WebltemsLevel cfg CPE Kit Template File Name CallFailed xml Callln xml Connecting xml Ring
12. called so it has Bob s authentication information Step Command Step 1 Configure line as shared Only for the firmware version lower than V71 ShareLine 1 Only for the V71 and higher version BC COUNU Ie Ga Ged elite Step 2 Set Register User ID Example Only for the firmware version lower than V71 UserName 24055951111 1 Only for the V71 and higher version account l user name ZOOS 33 IIE Step 3 Enable SIP Authentication Example Only for the firmware version lower than V71 AuthName bobsmith password bobs Only for the V71 and higher version Be COUME ae meme KND SE account 1 password bobs Step 4 Configure display name Example Only for the firmware version lower than V71 DisplayName Bob Smith Only for the V71 and higher version NEGO d a a a BDS Purpose 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 BROAD
13. called so it has Bob s authentication information Step Step 1 Step 2 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Command Configure line as shared Only for the firmware version lower than V71 Sharehine 1 Only for the V71 and higher version ECC UNE 2 akase Ta Il Set Register User ID Example Only for the firmware version lower than V71 UserName DAN 20092 Only for the V71 and higher Purpose Configure the line as shared as opposed to private The register user ID must correspond with the line port setting on BroadWorks 20 BD5265 00 PAGE 28 OF 75 Yealink Step 3 Step 4 version ACCOMM JUSS ZOIDS NNN Enable SIP Authentication Example Only for the firmware version lower than V71 AuthName bobsmith password bobs Only for the V71 and higher version A Coun ara ame Pon Sina ein account 2 password bobs Configure display name Example Only for the firmware version lower than V71 DisplayName Bob Smith Only for the V71 and higher version CO a a ae TEO a 4 3 1 3 Hybrid Key System Configuration 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
14. files provided that the template files are created with the correct Device Management tags BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 65 OF 75 Yealink The device profile created in the previous section should be assigned to the BroadWorks user Assigning the device profile to the user automatically causes the Device Management feature to generate the device configuration files for this user s device To assign the device profile to the user browse to the BroadWorks lt user gt Addresses page and set the parameters as described in the following table It is expected that parameters not identified in the following table are already set or are self explanatory Parameter Value Description Identity Device Profile lt device profile name gt From the drop down list select Name the device profile instance created Example yealink in the previous section Line Port lt SIP register address of record gt Supply the desired SIP register address of record Example 8881001099 as iop1 broadworks net Example User Addresses Settings Addresses Addresses allows you to view and maintain your phone number and other identities that are used to make and receive calls Phone Number atapi Ngka Activated Extension 1099 Wi Identity Device Profile Trunking None ldentity Device Profile Identity Device Profile Name yeslink Group Line Port 8881001099 asop broad
15. lower than V71 conf type 2 conf uri lt broadworks conference iia Example COs Wied conf as iopl broadworks net Only for the V71 and higher version ONE LO E Ns SZ account Conf uri conf as iopl broadworks net Configure Network Phonebook for a line Only for the firmware version lower than V71 DisplayName Broadsoft Phonebook Server mrt xspl iopl boroadl worksinet com broadsofk xs1 gt actions vl 0 user 24133336100as i opl broadworks net directories ca lllogs placed Port 8080 UserName 2413333601 as iopl broadworks net PassWord yealink V71 supports XSI format use the configuration below accounts NE Eee Phonebook account x xsi password yealink ale COMME Ko KIL NOST http xspl iopl broad works net ACCOUNT X XSL SERVER TYDS Sheep account xo ZSL POT 0080 4 3 Advanced SIP Features Configuration Purpose Select the Network Conference type and the conference uri from the Account Settings page The conference uri must match the BroadWorks configured conference uri setting x should be replaced with the line port number that is to be configured This configures the phone to use the BroadWorks Xsi interface to retrieve the group phone directory Server This is the identity of the BroadWorks Xsp server cluster address and relevant xsi actions parameters UserName This is the BroadWorks user s login name PassWord This is the Broad
16. table to the device tag set If the tag set already exists ensure the following tags are defined Tag Name Valid Settings Description BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 45 OF 75 Yealink Tag Name Valid Settings Description COUNTRY United States Identifies country for standard Australia ringtones Austria Brazil Belgium China Czech Denmark Finland France Germany Great Britain Greece Hungary Lithuania India Italy Japan Mexico New Zealand Netherlands Norway Portugal Spain Switzerland Sweden Russia Chile Czech ETSI LANGUAGE English Web management and phone LCD language Chinese guag The Chinese language is Simplified Chinese supported only on T19P Traditional French German ltalian Polish Portuguese Turkish Spanish T20_ FIRMWARE 9 lt x X X gt rom T20P FIRMWARE VERSION Example 9 71 0 10 rom BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 46 OF 75 Yealink Tag Name 121 FIRMWARE T19 FIRMWARE Yo T22 FIRMWARE 126 FIRMWARE 128 FIRMWARE 132 FIRMWARE 138 FIRMWARE TIMEZONENAME ACD SYNC BINARY http BWDEVICEACGES SFQDN BWDEVICEAC CESSPORT BWDMSC ONTEXT BWDEVICEA CCESSURI BWENTERPRISE 1 BWGROUP 1 CALL WAITING BINARY BWFAG DIRECTED CALL PICKUP 1 BWFAC CALL PICKUP 1 Valid Settings 34
17. version account Waslbsce rt be mwi TO ACCOUME 5 ILE SUlOS Ee oe ul e e 3600 Step 9 Enable negotiated DTMF type Set the SIP T2P T3xG series to nable inband or RFC 2 Only for the firmware version kan a cane DEE lower than V71 9 DTMFInbandTransfer 1 Only for the V71 and higher version features dtmf transfer Step 10 Select Transport Type Set the SIP transport Only for the firmware version Transport 0 UDP lower than V71 Transport 1 TCP Transport 0 Transport 2 TLS Transport 3 DNS SRV Only for the V71 and higher version x should be replaced with the line port number that is to be configured ACCOUNT x Eranspore 0 Step 11 Enable Feature Key Sync Enable Feature Key Sync Only for the firmware version 1 Enable lower than V71 0 Disable BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK 20 BD5265 00 PAGE 21 OF 75 Yealink Step Command System Configuration Items y0000000000 lt xx gt cfg 4 2 Subscriber Level Configuration Parameters Only for the firmware version lower than V71 BroadsoftFeatureKeySync I Only for the V71 and higher version bw feature key sync 1 Purpose 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 BroadW
18. 0 80 SIP T12P 5 51 0 10 SIP T20P 9 51 0 10 SIP T22P 7 51 0 10 SIP T26P 6 51 0 10 SIP T28P 2 51 0 10 SIP T80P 8 51 0 10 SIP T12P 5 0 0 9 SIP T20P 9 0 0 9 SIP T22P 7 0 0 9 SIP T26P 6 0 0 9 SIP T28P 2 0 0 9 SIP T80P 8 0 0 9 2 2 Interface Capabilities Supported SIP TxP T3xG Compatible Versions Any maintenance version of the verified version Any maintenance version of the verified versions Any maintenance version of the verified versions This section identifies interface capabilities that have been verified through testing as supported by Yealink SIP TxP T3xG The Supported column in the tables in this section identifies the Yealink SIP TxP T3xG s support for each of the items covered in the test plan with the following designations m Yes Test item is supported m No Test item is not supported m NA Test item is not applicable to the device type m NT Test item was not tested Caveats and clarifications are identified in the Comments column BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 9 OF 75 Yealink 2 2 1 Interface Capabilities Supported The Yealink SIP TxP T3xG has completed interoperability testing with BroadWorks using the BroadWorks SIP Access Device Interoperability Test Plan 4 The results are Summarized in the following table The BroadWorks test plan is composed of packages each covering distinct interoperability areas s
19. 1 and higher version account x expires 3600 Step 5 Enable reliable response Reliable provisional response Only for the firmware version PRACK should be enabled A then ve should be replaced with the line mase Tonsen 1 port number that is to be configured Only for the V71 and higher version Genie e a LOGEN Ene SU Step 6 Enable Session Timer Set the SIP TxP T3xG series to enable Session Timer Only for the firmware version lower than V71 Session Refresher EnableSessionTimer 1 0 uac SessionExpires 300 1 uas SessiomRefresher x should be replaced with the line Only bere 0 Fl mad Ba gha port number that is to be configured BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 20 OF 75 Yealink Step Command Purpose System Configuration Items y0000000000 lt xx gt cfg version ACCOUNT co soTOW ANNEN DE ONE 40 SES SILO HUS SPE 300 NEGEN TS LEN CMS a NB SG 1 Step 7 Enable Call Waiting Set the SIP TxP T3xG series to nabl Il Waiting an II Waitin Only for the firmware version bl lg elite Sa atng lower than V71 l Call Warring Only for the V71 and higher version call waiting enable 1 Step 8 Enable MWI MWI Solicited when setting ribeMWI 1 Only for the firmware version SUDECTIDE lower than V71 MWI Not solicited when setting EE SubscribeMWI 0 SubscribeMWIExpire 3600 Only for the V71 and higher
20. 13 YEALINK 20 BD5265 00 PAGE 4 OF 75 Yealink BT IN SS aaa aaa aaa a anaa a aaa A EE ajana aga aaa aana aa ee a aa aaa ete te ci aaa aa isin sich aa a aa aaa a aaa dang NGNE 75 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TKP T3KG SERIES 20 BD5265 00 2013 YEALINK PAGE 5 OF 75 Yealink Table of Figures Figure 1 Shared Call Appearance Configuration c cccscccsssecsssecssseeesseeessseeesseeeesseeesssaeeessaeesssaeeesees 25 Figure 2 System Default Tag SettinGS ccccccsssccssssecssseeesseessseeeesseeesssseessseeesseeeesseeeessseeeesseeesseseeeeees 45 Figure 3 Device Type Specific Tag Settings cccccccssccessecssseessseeesseeesseeeessneeesseeessseeessseeessseeeesseeeeeaes 49 Figure 4 Device Access 0 DN EEE EE 51 Figure 5 Enable Device Management Release 18 0 and Later rrnrrnnnnnrvennnnnvvnnnnnvvrnnnnvvrnnnnnvennnnnnn 52 Figure 6 Enable Device Management pre Release 18 0 ccsccccsssseecessseeesssseeeessseeeeesseeeessseeeessees 53 Figure 7 Device Management Options Settings rrrrrrnrrnnnvennnvennnvennnvennnvennnvennnvennnvennnvennnvennnvennvennnnenn 54 Figure b V0000000000 SI FIG svaie 58 Figure 9 MACADDRESS 610 FIG jasa aaa aaa aan anan anane EEEa aaa ae anja d a aaa E aaa aaa 60 Figure 10 Static File Setting cccccssccssssecssssecssseeessseecsseeeesensecsseeesseeeessseeessseeessseeecsseeessseeeessseeessseeesees 62 Figure 11 Device Profile Instance ccccscccc
21. 32 OF 75 Yealink bw directory_enable account X blf_list_code phone setting auto blf list enable phone setting blf list sequence type String 0 0 4 3 3 Feature Key Synchronization Configuration Enable BSFT feature 0 Disabled 1 Enable 98 For example Enable or disable auto blf list 0 Disabled 1 Enabled Default Configure the priority of auto blflist 0 linekey memory exp Default 1 Exp memory linekey Feature Key Synchronization provides synchronization of phone services such as Call Forwarding and Do Not Disturb with the settings on BroadWorks for the analogous services Configuration of the phone to enable Feature Key Synchronization is described as follows Step Step 1 Command Enable Feature Key Synchronization Example The configure path of the website bw feature_key_sync 1 Purpose Enable Feature Key Synchronization feature 0 Disabled 1 Enable Features General Information Features Key Synchronization Enabled Yealink 12 Forward amp DND Information Audio Intercom Transfer Call Pickup Remote Control Phone Lock ACD SMS Action URL BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Status Account General Information Call Waiting Call Waiting On Code Call Waiting Off Code Auto Redial Auto Redial Interval Auto Redial Times 1 300 Key As Send Reserve in User Name
22. Device Profile Modify View and modify device management tags used by the Identity Device Profile klan Profile Users Files Custom Tags Identity Device Profile Name yealink Identity Device Profile Type Yealink T25P Delete Tag Name a Tag Value Edit No Entries Present Page 1 of 1 Tag Name Find nc Sn Figure 12 Device Profile Instance Custom Tags Over ride Then click Add to add a custom tag with the following parameters Parameter Value Description Notes Tag Name XSIPASSWORD lt line number gt This tag provides the Xsi password of the user for the line which is Example XSIPPASSWORD 1 assigned to the phone Line number is an integer corresponding to the phone line in assignment Tag Value The user s Xsi password Example 123456 Example device profile custom tag setting Identity Device Profile Custom Tag Add Add a new custom device management tag to the Identity Device Profile mx p Identity Device Profile Name yealink Identity Device Profile Type Yealink T25P Tag Name XSIPASSWORD 1 Tag Value 123456 x Figure 13 Device Profile Instance Custom Tags Add Repeat the tag adding process for each of the lines provisioned on the device 5 2 4 Configure BroadWorks User Configure the user with the desired BroadWorks configuration and services Any services that require a specific configuration on the device are managed via Device Management and are defined in the device configuration
23. ES 20 BD5265 00 2013 YEALINK PAGE 72 OF 75 Spain Canary Islands Las Palmas Administrator s Guide for SIP T4X IP Phones oO United Kingdom London o Morocco s O Denmark Kopenhagen Luxembourg Luxembourg Israel Tel Aviv Georgia Tbilisi BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 73 OF 75 Yealink Thailand Bangkok China Beijing Singapore Singapore BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 74 OF 75 Yealink References 1 Yealink Inc 2013 Yealink TxP SIP Phone User Guide Release 71 Available from Yealink at http www yealink com index php Support 2 BroadSoft Inc 2013 BroadWorks Device Management Configuration Guide Release 19 0 Available from BroadSoft at broadsoft com xchange 3 BroadSoft Inc 2012 BroadWorks Redundancy Guide Release 19 0 Available from BroadSoft at broadsoft com xchange 4 BroadSoft Inc 2013 BroadWorks SIP Access Device Interoperability Test Plan Release 19 0 Available from BroadSoft at broadsoft com xchange 5 BroadSoft Inc 2013 BroadWorks Device Management Interoperability Test Plan Release 19 0 Available from BroadSoft at broadsoft com xchange BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 75 OF 75
24. Example shared line linekey 2 type 15 key type 15 line linekey 2 line 1 line ID Q line1 1 line1 2 line2 3 line3 4 line4 5 lined 6 line6 The following steps are used to assign multiple memory keys to Line for Joe s phone Step Command Purpose Step 1 Set DSS Key Set memory key to line and apply this key type line to the Example shared line linekey 1 type 15 key type 15 line linekey 1 line 1 line ID O line1 1 line1 2 line2 3 line3 4 line4 5 line5 6 line6 The linekey setting of the webpage refers to the figure below BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 31 OF 75 Yealink Yealink Log Out Status Account Network Features Settings Directory Security Memory Key Line Extension NOTE Line Key1 Line a Line1 Line Key2 Line Line 1 The free function key Types Speed Dial Key Event Intercom Programable Key Line Key3 Line Line 3 ee Key Event Ext Key Line Key4 Line Line 4 Key events are predefined shortcuts to phone and call Line Key5 Line Line 5 functions Line Key6 Line vi Line 6 Intercom Enable the Intercom mode and it is useful in an office environment Confirm as quick access to connect to the operator or the secretary 4 3 2 Busy Lamp Field Configuration The Busy Lamp Field implementation provides an attendant console function Co
25. File Custom Authentication Mode User Name and Password The phone specific file is authenticated with the user name and password Device Access HTTP Digest Authentication 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 Select the appropriate device specific file to upload based on the model as follows m TKP models BWMACADDRESS TXP cfg m T3xG models BWMACADDRESS T 3xG cfg Be sure to click Apply after uploading the file BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 59 OF 75 Yealink Example Device Specific File Settings Options Identity Device Profile Type File Modify gt Identity Device Profile Type Modify or delete a file type defined in an Identity Device Profile Type OK Appy Cancel Device Access File F t BWMACADDRESS cfg Repository File Format BWFQDEVICEID cfg http ksp1 iop1 broadworks net 80 dms mydevice_dm 25BWMACADDRESS 25 cfg Access File Note this URL has undefined content Validate it manually by replacing any content between with valid value s Repository File Error File Repository Not Found Template File Download File Category Static Dynamic Per Type Dynamic Per Device File Customization Administrator and User pvr Enable caching Assign File Manual amp Custom Upl
26. IDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 68 OF 75 Yealink m Perform the upgrade during a maintenance window m Keep the previous firmware on the system in case a downgrade is required Older versions can be deleted m Perform the upgrade at the group level rather than the system wide level To do so 1 Upload firmware at the system level 2 Select the group to upgrade 3 Select Utilities Device Configuration 4 Search for and select the Yealink model to upgrade 5 Select Files Upload the new or updated configuration files at the group level Refer to relevant upgrade section to identify new or modified configuration files 6 On the Files page select Rebuild the files This rebuilds all the configuration files associated with the selected Yealink device profile type in this group 7 On the Files page select Reset the phones This causes the phones to restart and pick up new firmware and configuration files 8 Repeat steps 2 through 7 for each Yealink model in the group to upgrade m After all groups have been upgraded complete the following steps to update the system device profile types and reset the group device profile types to default values 1 Browse to the System Resources Identity Device Profile Types page search for and select the Yealink model device type Upload the new or updated configuration files at the group level Refer to relevant upgrade section to identify new or m
27. IES 20 BD5265 00 2013 YEALINK PAGE 62 OF 75 Yealink must be converted to a in the file name A separate TimeZoneAlias file must be provided for each device profile type corresponding to each Yealink model The file must contain the mapping of BroadWorks time zones values to Yealink TxP T3xG time zone values The following is an example of the file contents US ALASKA 9 US HAWAII 10 CANADA PACIFIC TIME 8 US PACIFIC TIME 8 US ARIZONA 7 CANADA MOUNTAIN TIME 7 US MOUNTAIN TIME 7 CANADA CENTRAL TIME 6 US CENTRAL TIME 6 CANADA EASTERN TIME 5 US INDIANA 5 US EASTERN TIME 5 CANADA ALTANTIC TIME 4 CANADA NEWFOUNDLAND 3 5 This file should contain all the time zones supported by the service provider s BroadWorks system Restart the Application Server to load this file The CPE kit contains the time zone properties files defined for the continental U S and Canadian time zones For other time zone settings see the Yealink TxP SIP Phone User Manual ERIKA 2 5 AYR When using the DTAF import the TimeZoneAlias files are automatically copied onto the system Restart the Application Server for the TimeZoneAlias files to be picked up by the system 5 2 3 Create Device Profile Instance The previous sections defined the device profile type such that the system is ready to mass deploy device profiles device profile is an instance of the device profile type and defines the BroadWorks interface to a
28. Management Capabilities Supported rrrrnrrrnnrrnnnvvrnnvrrnnvrrnnvrnnnvrrnnvrrnnnnrnnnnrnnnnsnnnnnnn 42 5 2 Device Management Configuration rrrrrnnnvrnnnnvrnnnnvrrnnnvrrnnnvennnnvennnnvennnnvennnnnennnnnennnnnennnnnennnn 44 5 2 1 Configure BroadWorks Tags cccccsscsssecssseceseeeeseeceseeeessesseeeeseeeseesseeeeseeeeseeesseeeeeeens 44 5 2 2 Configure BroadWorks Device Profile Type rrrrnrrnnnnvrnnnnvennnnvennnnvrnnnnvennnnvennnnnennnvnennnnn 49 5 2 3 Create Device Profile Instance rrrnnrrrnnnrvrnnnvvrnnnvrrnnnvnrnnnvernnnvernnnnrnrnnnesnnnnennnnnensnnnennnnn 63 5 2 4 Configure BroadWorks USer mrarvrrsnvvernnvvrrnnvrrnnnvrrnnnvernnnvernnnvennnnvennnnvennnnnessnnnennnnnennnnn 65 5 2 5 Configure Edge DeVIGE asasi aaa ian AA aa naka ak a ANAN ENEH AGENG ge aga aging naa aga GAN Na SANE NANA 66 NE NNM PP 67 5 3 Upgrading from Previous CPE Kits rrrrnnnrrrnnnvrnnnnvrrnnnvrnnnnvennnnvrnnnnvesnnnvennnnnennnnnennnnnensnnnennnnnennnn 68 5 3 1 General Recommendations for Upgrades srrrrnnvrrnnnvrnnnnvennnnvennnnvrnnnnvennnnvennnnvennnnnennnnne 68 592 Upgrade OMX 10XX 10 X71 KK seen 70 Appendix A Sample TxP T3xG Configuration Files rrrxnsvennnvvrnnnnvennnnvennnnvennnnnnnnnnevnnnnevnnnnevnnnvennn 71 Appendix B TIMEZONENAME values rnnnrnnvnnnvnnvnnnnnnvnnnnnnvnnennnnnnennnennennnnnnennnnnnnnnennnnnnennnnnnennnennenn 72 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20
29. Management Interoperability Test Plan f WIK ARANE AYR The results are summarized in the following table The BroadWorks test plan is composed of packages each covering distinct interoperability areas 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 Device Management interface between the device and BroadWorks with the intent to ensure interoperability The Supported column in the following table identifies the Yealink SIP TxP T3xG s support for each of the items covered in the test plan packages with the following designations m Yes Test item is supported m No Test item is not supported m NA Test item is not applicable m NT Test item was not tested BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 42 OF 75 Yealink Caveats or clarifications are identified in the Comments column NOTE DUT in the following table refers to the Device Under Test which in this case is the Yealink SIP TXP T3xG BroadWorks Device Management Interoperability Test Plan Support Table Test Plan Package HTTP File Download HTTPS File Download File Inspection Device Inspection HTTP File Upload Call Processing Sanity Tests BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Test Plan Package Items HTTP Download Using Xtended Services Platform Xsp IP
30. Page 1 of 1 Identity Device Profile Type v Identi ice Profile Starts With vw e Line Port 241333361 7_1 as io Secondly on the website of the line registration must type in as below 20 BD5265 00 PAGE 29 OF 75 Yealink Yealink 155 Register Basic Codec Advanced Status Account Network Register Status Line Active Label Display Name Register Name User Name Password Enable Outbound Proxy Server Outbound Proxy Server Transport NAT STUN Server SIP Server1 Server Host Server Expires Server Retry Counts SIP Server 2 gt DSSKey Features Settings Disabled Enabled 0 3617 2 2413333617 2413333617 2413333617 B eocccece Q Enabled X 199 19 193 10 Port 5060 2 UDP Disabled v Port 3478 D as iop1 broadworks net Port 5060 3600 3 Log Out Directory Display Name SIP service subscriber s name which will be used for Caller ID display Security Register Name SIP service subscriber s ID used for authentication User Name User account provided by VoIP service provider NAT Traversal Defines the STUN server will be active or not The second appearance line Yealink 12 Register Basic Codec Advanced Status Account Network Register Status Line Active Label Display Name Register Name User Name Password Enable Outbound Proxy Server Outbound Proxy Server Transport NAT STUN
31. RIES 20 BD5265 00 2013 YEALINK PAGE 14 OF 75 Yealink Directories Xsi Features Call Logs XMPP Features Contact Buddy List XMPP Features Presence Enterprise Common Phone List Group Directory Group Common Phone List Personal Phone List Search All Directories Placed Calls Received Calls Missed Calls All Calls Sort by Name Contacts Favorites Groups Non XMPP Contacts Conferences Login Invisible Presence State Presence Status Contact s Presence State 2 3 Known Issues Yes Yes Yes Yes Yes Yes Yes Yes Yes No No No No No No No No No No 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 and are typically not BroadWorks release dependent If the testing was performed by BroadSoft then the Issue Number is a BroadSoft ExtraView partner issue number If the testing was performed by the partner or a third party then the partner may or may not supply a tracking number For more information on any issues related to the particular partner device relea
32. SOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK 20 BD5265 00 PAGE 26 OF 75 Yealink Step Command Step 1 Configure line as shared Only for the firmware version lower than V71 ShareLine 1 Only for the V71 and higher version Sea e a e Linne I Step 2 Set Register User ID Example Only for the firmware version lower than V71 WS am 20555 227 Only for the V71 and higher version EGGE VEE mame 220555 111192 Step 3 Enable SIP Authentication Example Only for the firmware version lower than V71 AuthName joebrown password joeb Only for the V71 and higher version ON E mene oslo account 2 password joeb Step 4 Configure display name Example Only for the firmware version lower than V71 DisplayName Joe Brown Only for the V71 and higher version acCeOunt 2 die play name oe Bronn 4 3 1 2 Joes Phone Configuration MAC cfg Purpose 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 1 for J
33. Server SIP Server 1 Server Host Server Expires Server Retry Counts DSSKey Features Disabled Settings Enabled 3617 1 2413333617 1 2413333617 2413333617 1 0000000 Enabled 199 19 193 10 Port 5060 TA UDP 0 Disabled Q Port 3478 amp Port 5060 3 3600 E 3 2 as iop1 broadworks net Log Out Directory Security Display Name SIP service subscriber s name which will be used for Caller ID display Register Name SIP service subscriber s ID used for authentication User Name User account provided by VoIP service provider NAT Traversal Defines the STUN server will be active or not Thirdly all of the advanced setting of the host and the other appearance line must enable the Broadsoft SCA feature refer to the figure below The path of line setting Account Advanced Shared Line Shared Line Broadsoft SCA The following steps are used to assign multiple line keys to Line for Bob s phone Step Command Purpose BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK 20 BD5265 00 PAGE 30 OF 75 Yealink Step 1 Set DSS Key Set memory key to line and l apply this key type line to the Example shared line linekey 1 type 15 key type 15 line linekey 1 line 1 line ID O line1 1 line1 2 line2 3 line3 4 line4 5 lined 6 line6 Step 2 Set DSS Key Set memory key to line and apply this key type line to the
34. Works device profile type file to the Yealink TxP T3xG device profile for each of the static files using the settings described in the following table Parameters not identified in the following table can usually be left at the default values Parameter Device Access File Format Repository File Format File Category File Customization Enable Caching Assign File Authentication Mode Value lt file name gt Examples Ring wav Talking xm lt file name gt Examples Ring wav Talking xml Static Disallow Selected Custom Not set Description This is the file name the phone uses to request the file This is the file name as stored in the Device Management repository Use the same name as the actual file name This is a static file There are no dynamic tags in the file This file must not be modified Caching is recommended for static files The static files are not authenticated Do not select either of these options After defining the static file types upload the corresponding static files Firmware must be obtained from Yealink Use the Browse button on the file definition screen Be sure to click Apply after uploading the file BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK 20 BD5265 00 PAGE 61 OF 75 Yealink Example Static File Settings Device Access File Format Ring wayv Repository File Format Ring wavw Aooess File htt nxp ko
35. Works user s login password x should be replaced with the line port number that is to be configured This section provides configuration instructions for advanced SIP features supported by the phone including but not limited to Shared Call Appearance Busy Lamp Field Feature Key Synchronization Call Center and Emergency Call BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK 20 BD5265 00 PAGE 24 OF 75 Yealink 4 3 1 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 lt phoneNumber gt _ lt index gt is used when provisioning the unique address of record AoR for each shared line For example 2405551111 2 If a phone number does not exist the MAC address plus an index could be used lt macAddress gt lt index gt Subscriber Bob s Profile Subscriber Joe s Profile Configuration Confi
36. Yealink BroadWorks BroadSoft Partner Configuration Guide Yealink SIP TxP T3xG Series September 2013 Document Version 2 10 4th 5th Floor No 63 Wanghai Road 2 Software Park Xiamen Fujian China 361008 Tel 86 592 5702 000 Fax 86 592 5702 455 WWW YEALINK COM Yealink BroadWorks Guide Copyright Notice Copyright 2008 2018 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 do
37. Yealink and provides instructions for defining the files and uploading for Device Management The TxP T3xG downloads a system file named as follows m T19P y000000000031 cfg T20P y000000000007 cfg T21P y000000000034 cfg T22P y000000000005 cfg T26P y000000000004 cfg T28P y000000000000 cfg BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TKP T3KG SERIES 2013 YEALINK 20 BD5265 00 PAGE 56 OF 75 Yealink m 132G y000000000032 cfg T38G y000000000038 cfg Add a BroadWorks device profile type file to the Yealink TxP T3xG device profile for the system file using the settings described in the following table Parameters not identified in the following table can usually be left at the default values Parameter Value Description Notes Device Access File lt system file name gt This is the file name the phone uses to Format Example request the file y000000000008 cfg Repository File Format lt system file name gt This is the file name as stored on the Example y000000000008 Device Management repository BWTIMESTAMP cfg 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 User Name and Password This system file is authenticated with the user name and password Device Access HTTP Digest Authentication After defining the system
38. Yealink phone deployed at a user s desk This section describes how to create a BroadWorks device profile instance for an individual Yealink SIP TxP T3xG phone Device profile instances are usually created at the BroadWorks Group level and assigned to users When you create the device profile you must define the authentication data The authentication data is used by Device Management to challenge a request from a phone to download a configuration file The device must send credentials that match the credentials stored in the device profile Browse to the BroadWorks lt group gt Resources Identity Device Profiles page and select Add to add a new Yealink SIP TxP T3xG device profile Define the device profile instance using the settings described in the following table Parameters not identified in the following table can usually be left at the default values Parameter Value Description Identity Device Profile lt device profile name gt The device profile name is a Name unique identifier for the device Example Yealink T28 01 profile instance BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 63 OF 75 Yealink Parameter Value Identity Device Profile lt yealink txp device profile type gt Type yP Example Yealink T28P Authentication Use Custom Credentials Device Access User lt phone login name gt Name Example Ismith Device Access lt phone login password gt P
39. all center queue status notification feature 0 Disabled default 1 Enabled Enable or disable the power indicator LED to indicate the queue status 0 Disabled default 1 Enabled Enable or disable the call center disposition code feature 0 Disabled default 1 Enabled Specify the call center disposition code for account X Y must be continuous and ranges from 1 to 100 Specify the disposition name for account X Enable or disable the call center customer originated trace feature 0 Disabled default 1 Enabled Enable or disable the call center emergency escalation feature 0 Disabled default 1 Enabled Specify the call center supervisor code for account X The maximum length of the value is 30 characters Specify the supervisor name for account X The maximum length of the value is 99 characters Enable or disable the call center Unavailable reason code feature 0 Disabled default 1 Enabled 20 BD5265 00 PAGE 35 OF 75 Yealink account X reason code Y String account X reason code String name Y account X hoteling enabl 0 a 1 1 Specify the call center unavailable code for account X The maximum length of the value is 10 characters Specify the call center unavailable reason for account X The maximum length of the value is 40 characters Enable or disable the hoteling feature for account X 0 Disabled default 1 Enabled 4 4 Xtended Services Interface Xsi Feature Configuratio
40. all log history missed placed and received calls from BroadWorks and make them available to a user via the phone menus Step BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Command Purpose 20 BD5265 00 PAGE 38 OF 75 Yealink Step 1 Enable the BroadSoft call log feature Enable BroadWorks call log Example feature 0 Disable bw phonebook call log enable 1 1 Enable Configuration on the phone webpage following the figure below Log Out Yealink 12 n sg E Status Account Network DSSKey Features Settings Security Host Server Remote Phone Network Directory Book Port The network directory parameters for administrator Phone Call Info ETE User ID LDAP Password 00000000 Network Directory Network Directory Multicast IP Setting Group Enabled Group Enterprise Disabled Enterprise Group Common Disabled GroupCommon Enterprise Common Disabled EnterpriseCommon Personal Enabled Personal Custom Directory Enable Custom Directory Disabled Network Call Log Enabled X 4 4 4 BroadWorks Call Park Configuration Integration with the BroadWorks Xtended Services Interface for Call Park makes call park available to a user via the phone menus To enable this feature use the following instructions Step Command Purpose Step 1 Enable call park feature for the line Enable call park feature Example 0 Disable account 1 callpark_enable 1 1 Enable Step 2 Ena
41. asic Digest Allowed Access Protocols V http V https v tftp OK H Delete fl Cance Figure 8 y0000000000 cfg File 5 2 2 2 2 2 Device Specific Files BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK This section identifies the device specific files used by Yealink and provides instructions for defining and uploading the files for Device Management Each TxP T3xG phone downloads a device specific file based on the MAC address using the following file name format lt MAC address gt cfg Add a BroadWorks device profile type file to the Yealink TxP T3xG device profile for the device specific file using the settings described in the following table Parameters not identified in the following table can usually be left at the default values Parameter Value Description Device Access File lt device specific file format gt This is the file name format the Format phone uses to request the file Example BWMACADDRESS cfg 20 BD5265 00 PAGE 58 OF 75 Yealink Parameter Value Description Repository File Format SBWFQDEVICEID cfg This is the file name format as stored in the Device Management repository File Category Dynamic Per Device This file is unique per device File Customization Administrator and User This identifies who can customize this file template Enable Caching Not set Caching should not be enabled for device specific files Assign
42. assword i Example 654321 Example Identity Device Profile Add Settings Identity Device Profile Add Add a new group identity device profile Group Interoperability BroadSof Identity Device Profile Name Yealink T28F 01 Identity Device Profile Type Yealink T28P Protocol SIP 2 0 ri Host Name IP Address Transport Unspecified MAC Address Serial Number Description Outbound Proxy Server STUN Server Physical Location Authentication Use Identity Device Profile Type Credentials Use Custom Credentials Device Access User Name smith Device Access Password Re type Device Access Password Figure 11 Device Profile Instance Description From the drop down list select the Yealink device profile type created in the previous section Use the unique login name and password for each phone User name used to log in from the phone The phone login user naming convention must be determined by the service provider Password used to log in from the phone For the Xsi Services Interface feature to be authenticated it is necessary to override the Xtended Services Interface password for each of the lines at the device profile instance level To override custom tags at the device profile instance level click on the Custom Tags tab BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK 20 BD5265 00 PAGE 64 OF 75 Yealink Identity
43. back xml Talking xml wallpaper jpg ScreenSaver png WebltemsLevel cfg File Type Static Static Static Static Static Static Static Static Description This data file specifies the soft keys available on the phone in the call failed calling state This data file specifies the soft keys available on the phone in the call alerting calling state This data file specifies the soft keys available on the phone in the call connecting state This data file specifies the soft keys available on the phone in the ring back state This data file specifies the soft keys available on the phone in each of the in session calling state Required for T38G and T32G Picture in JPG format used for wall paper purpose Required for T38G and T32G Picture in PNG format used for screen saver purpose This data file defines the permission of the configuration items on the web user interface and phone user interface The following table identifies other files that the Yealink TxP T3xG downloads from the server or uploads to the server These files are not provided in the CPE kit and must be obtained from Yealink File Name File Type Description X X X X rom Static Device firmware file Browse to System Resources Identity Device Profile Types Files and Authentication to add the files as described in the following subsections System Files This section identifies the system level files used by
44. ble the phone to display the Park soft key The Park soft key appears on during a call the LCD screen during a call Example 0 Disable call_park enable 1 1 Enable Step 3 Enable the phone to display the GPark soft key The GPark soft key appears on during a call the LCD screen during a call Example 0 Disable call_park group_enable 1 1 Enable Step 4 Enable the phone to play a warning tone when a Enable the phone to play a call is parked against its line warning tone when a call is Example parked against its line call park park ring 1 DEAE 1 Enable BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 39 OF 75 Yealink Step 5 Enable the phone to display a parked indicator Enable the phone to display a when a Call is parked against its line parked indicator when a call is parked against its line Example 0 Disable call park park visual notify enable 1 1 Enable Configuration on the phone webpage following the figure below Ta Log Out Yealink ms Status Account Network DSSKey Settings Directory Security Forward amp DND Call Pickup NOTE Directed Call Pickup Disabled Call Pickup The call pickup parameters for administrator General Information Directed Call Pickup Code Group Call Pickup Disabled Audio Group Call Pickup Code Intercom Visual Alert for BLF Pickup Disabled Transfer Audio Alert for BLF Pickup Disabled Call Pickup Call Park
45. ce Access Password MAC Address In HTTP Request URI HTTP Header with Following Format Device Access HTTP Authentication Basic Digest Figure 7 Device Management Options Settings BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 54 OF 75 Yealink 5 2 2 2 2 Define Device Profile Type Files This section describes the BroadWorks Device Management configuration necessary to identify the configuration files and other files that the Yealink TxP T3xG downloads Configuration templates firmware and other files the Yealink TxP T3xG uses must be uploaded to BroadWorks Download the Yealink TxP T3xG CPE kit from BroadSoft Xchange at broadsoft com xchange Extract the configuration files from the Configuration Files folder of CPE kit Obtain the firmware files directly from Yealink The following table identifies the Yealink configuration files distributed with the CPE kit File Name Examples BWMACADDRESS cfg y0000000000xx cfg Ring wav lang English txt contactData xml contactData1 xml contact xml DialPlan xml AutoDST xml TimeZoneAliasLab els Yealink lt mode gt properties DialNow xml Dialing xml CPE Kit Template File Name BWMACADDRESS T3xG cfg template BWMACADDRESS TxP cfg template y0000000000xx cfg Ring wav lang English txt contactData xml contactData1 xml DialPlan xml AutoDST xml TimeZoneAliasLabels
46. cument may be trademarks or registered trademarks of their respective companies and are hereby acknowledged This document is printed in the United States of America BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 2 OF 75 Yealink Document Revision History Version Reason for Change Ti Introduced document for Yealink SIP T28 version 2 0 0 9 1 2 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 2 51 0 1 test with BroadWorks Release 17 0 Updated the document for Device Management 1 6 Edited and published document 1 7 Updates to Device Management configuration requirements 1 8 Edited and published document 1 9 Added T2xP configuration instructions 2 0 Edited and published document 2 1 Modified to incorporate the T18P model and to update the Device Management section 2 2 Edited and published document 2 3 Modified manual instructions for device management file parameters 2 4 Updated document for Yealink SIP T2xP version X 60 0 110 test with BroadWorks Release 17 0 Modified to incorporate the T38G and T32G model and to update the Device Management configuration instructions 2 5 Edited changes and published document 2 6 Updated document to incorporate T21P as a supported device model 2 7 Edited changes and published document 2 8 Updated the documen
47. dWorks Device Profile Type Configuration If there are differences perform an update to match the settings in section 3 7 BroadWorks Device Profile Type Configuration The following subsections identify the required settings specific to Device Management Configure Device Configuration Options If Device Management has been enabled previously for the device profile type s proceed to the next section Device Configuration is enabled differently depending on the deployed BroadWorks release For BroadWorks Release 18 0 and later configure as described in the following table Parameter Value Description Device Configuration Options Device Management Use BroadWorks Device Management The following figure shows Device Management enablement for BroadWorks Release 18 0 and later Device Configuration Options Not Supported 2 Device Management Legacy Figure 5 Enable Device Management Release 18 0 and Later For BroadWorks releases prior to Release 18 0 configure as described in the following table NOTE These settings serve only to enable Device Management and are otherwise not meaningful in this context Parameter Value Description BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 52 OF 75 Yealink Parameter Value Description Auto Configuration Type 2 Config File Not meaningful other than it must be selected CPE System File Name not_used This parameter mu
48. e of all configuration items on the SIP TxP T3xG series For more information see the Yealink TxP SIP Phone User Manual 1 supplied by Yealink BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK 20 BD5265 00 PAGE 7 OF 75 Yealink 2 Interoperability Status This section provides the known interoperability status of the Yealink SIP TxP T3xG 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 T3xG 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 identifies specific SIP TxP T3xG 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 Co
49. eAlias files 5 2 2 2 Configuration Method 2 Manual This section identifies the manual steps necessary to configure BroadWorks to add the Yealink SIP TxP T3xG as a Device Management enabled device type BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 51 OF 75 Yealink 5 2 2 2 1 5 2 2 2 1 1 The manual method must be used for BroadWorks releases prior to Release 17 0 It is an optional method in Release 17 0 and later To determine when to use the manual method see section 5 2 2 Configure BroadWorks Device Profile Type The steps in this section can also be followed to update previously imported or configured device profile type s with new configuration files and firmware The steps in this section must be completed for the device profile type for each Yealink SIP TxP T3xG model Modify Device Profile Type This section identifies the BroadWorks device profile type settings relevant to Device Management for the Yealink SIP TxP T3xG Browse to System Resources Identity Device Profile Types and perform a search to find the Yealink device profile type s created in section 3 7 BroadWorks Device Profile Type Configuration or add the device profile type for each model using the settings from section 3 7 BroadWorks Device Profile Type Configuration if they do not exist The Standard Options and Advanced Options should already be configured as specified in section 3 1 Broa
50. ed On Dial Plan After Ring Time seconds Target Voice Off Code Do Not Disturb The code that will be sent to Ring PBX when it is switched Off General Information Call Waiting Tones Audio Settings This call feature allows your phone to accept other incoming SMS Intercom Settings calls during the conversation Transfer Settings Key As Send Action URL Select or as the send key Call Pickup Softkey Layout Hotline Number Remote Control Security When you pick up the phone it will dial out the hotline number Phone Lock automatically Auto Call Distribution Settings UC Username UC Password ouceasas BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 41 OF 75 Yealink 5 Device Management The BroadWorks Device Management feature provides the capability to automate generation of device configuration files to support mass deployment of devices This section identifies the device management capabilities supported by the Yealink SIP TxP T3xG and the configuration steps required For Device Management configuration details not covered here refer to the BroadWorks Device Management Configuration Guide R RRAJI AVR The basic steps to integrate a device with Device Management are as follows 1 Create device template files for the device with the appropriate BroadWorks Device Management tags 2 Define custom and system tags and add them to the de
51. er to the BroadWorks Device Management Configuration Guide 2 5 2 1 Configure BroadWorks Tags The template files in Device Management use tags to represent the data stored on BroadWorks When a configuration changes for a user Device Management parses the template files and replaces the Device Management tags with the associated data stored on BroadWorks There are default tags defined in the Device Management software and there are custom tags that the service provider can create define via the web portal for use by Device Management There are two types of custom tags that can be defined system default tags are common to all phones on the system device type specific tags are common to Yealink phone models only The Yealink SIP TxP T3xG 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 5 2 1 1 Create System Default Tags Browse to System Resources Device Management Tag Sets and select the System Default tag set Yealink configuration templates make use of the tags in the following table Add the tags if they do not already exist Tag Name Valid Settings Description SNTP_SERVER_1 IP address FQDN Network Time Protocol 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
52. ersion v71 or above have implemented support for the following e BroadWorks Xsi Interface Refer to the configuration of the below figure type in the related parameters and confirm it Log Out Yealink 155 Status Account Network DSSKey Features Settings Security Local Directory ks NOTE Host Server Remote Phone Network Directory Book Port The network directory parameters for administrator Phone Call Info XSI Server Type User ID LDAP Password Network Directory Network Directory Multicast IP Type Enable RNA Group Enabled Group Setting Enterprise Disabled Enterprise Group Common Disabled w GroupCommon Enterprise Common Disabled v EnterpriseCommon Personal Enabled v Personal Custom Directory Enable Custom Directory Disabled Call Log Network Call Log Enabled X conten e XMPP BroadCloud IM amp P Support for these interfaces is demonstrated by completing the BroadWorks SIP Phone Functional Test Plan 4 Support for these interfaces is summarized in the following table BroadWorks Xsi and BroadCloud IM amp P Support Table Interface Feature Supported Comments Xsi Features User Remote Office Yes Service Configuration BroadWorks Anywhere Yes Simultaneous Ring Yes Caller ID Blocking Yes Call Forward Always Yes Call Forward Busy Yes Call Forward No Answer Yes Do Not Disturb Yes Xsi Features Enterprise Directory Yes BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SE
53. f using an Xtended Services Platform farm Otherwise set to the individual Xtended Services Platform FQDN or Example xsp iop1 broadworks net IP address Device Access Port lt BroadWorks XSP Port gt This should be set to 80 Example 80 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 53 OF 75 Yealink Parameter Value Description Device Access dms This does not need to be defined Context Name BroadWorks defaults to the system defined value Device Access URI lt device model name gt This defines the directory the Example YealinkT28P Xtended Services Platform uses to access the configuration files Example Device Management Options Settings Device Management Device Type URL httpvxsp1 iop1 broadworks net 0 dms YealinkT2eP No Tags Device Configuration Tags Use Default System Tag Set Only Use Default System Tag Set and Tag Set Yealink TxP Tags W Allow Identity Device Profiles to Configure Custom Tags W Allow Groups to Configure Custom Tags E Send Email Notification to User upon Device Reset Failure Device Access Protocol http Device Access FQDN xsp1 iop1 broadworks net Device Access Port 80 Device Access Context Name dms Device Access URI YealinkT26P Default Device Language Default Device Encoding Authentication Mode C MAC Based User Name and Password Device Access Username Device Access Password Retype Devi
54. file Type Configuration This section identifies the device profile to use when deploying the Yealink SIP TxP T3xG with BroadWorks The following table identifies the required BroadWorks device identity profile settings for interoperability between the SIP TxP T3xG and BroadWorks For an explanation of the profile parameters see the BroadWorks Device Management Configuration Guide 2 For most of the following parameters an X indicates that 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 to add or to modify a device profile type Yealink SIP TxP T3xG Identity Device Profile Type Signaling Address Type Intelligent Proxy Addressing Standard Options Number of Ports T19P 1 T20P 2 T21P 2 T22P 3 T26P 3 T28P 6 T32P 3 T38P 6 Ringback Tone or Early Media Local Ringback No Early Media Support Authentication Enabled Hold Normalization Inactive Registration Capable X Static Registration Capable E 164 Capable Trusted Authenticate REFER Video Capable Use History Info Header Route Advance Wireless Integration PBX Integration Advanced Options BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 PAGE 17 OF 75 Yealink Yealink SIP TxP T3xG Identity Device Profile Type Add P Called Party ID Auto Configuration Soft Client Requires BroadWor
55. file type upload the corresponding system file template downloaded from BroadSoft Xchange Use the Browse button on the file definition screen Be sure to click Apply after uploading the file BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 57 OF 75 Yealink Example System File Settings Options Bb identity Device Profile Type Identity Device Profile Type File Modify Modify or delete a file type defined in an Identity Device Profile Type OK Apply Cancel Device Access File Format yOOO000000000 cfg Repository File Format y000000000000 BWTIMESTAMP cfg Access File http xsp1 iop1 broadworks net80 dms mydevice dm 000000000000 cfq Repository File Error File Repository Not Found Template File Download File Category Static Dynamic Per Type Dynamic Per Device File Customization Administrator Enable caching Assign File Manual amp Custom Upload File Choose File No file chosen Currently using gg Nar broadworksilpDeviceConfig typelmydevice dm y000000000000 cfg template File Created S BNTIMESTAMPS autop mode path config Setting autop cfg mode 1 schedule min schedule time schedule time end schedule dayofweek File Authentication Authentication Mode MAC Based V User Name and Password MAC Address In HTTP Request URI HTTP Header with Following Format Device Access HTTP Authentication B
56. guration Line Port AoR 2405551111_1 Line Port AoR 2405552222 1 Auth UserID bobsmith Auth UserID joebrown Auth Password bobs Auth Password joeb Shared Call Appearance aie Shared Call Appearance Configuration Application Configuration Server Joe s 2nd Line Bob s 2nd Line Line Port AoR 2405552222 2 Line Port AoR 2405551111 2 Bob s Phone Joe s Phone 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 2405551111 is called Bob s first line and Joe s second line will ring When Joe 2405552222 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 For configurations of SCA for the device refer to the following example BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 25 OF 75 Yealink 4 3 1 1 Bob s Phone Configuration MAC cfg This is the SCA configurations as specified in MAC cfg that is 0015651130dc cfg where 0015651130dc 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
57. ign Out Welcome Logout Incoming Calls Outgoing Calls gt Calling Plans Client Applications Meet Me Conferencing Messaging Serice Scripts Utilities Use Guard Timer Setting Default User Make outgoing calls as None v Enable guardtimerfor 5 v seconds Use Agent Unavailable Settings Default User Force agent to unavailable on Do Not Disturb activation F Force agent to unavailable on personal calls E Force agent to unavailable after 3 v consecutive bounced calls Call Center ID 2413333550 2413333561 Phone Number 44 2413333561 Co Jr Joe 2 Register the call center line on the website Yealink DSSKey I Features I Settings Directory Register Status Registered Basic Display Name Status Network Security Register Codec Advanced Line Active Label Display Name Register Name User Name Password Enable Outbound Proxy Server Outbound Proxy Server Transport NAT STUN Server SIP Server1 Server Host Server Expires Server Retry Counts SIP Server2 Enabled 3558 2413333558 2413333558 2413333558 000 Enabled 192 168 1 225 UDP Disabled as yealink com 3600 3 v Port 5060 2 a SIP service subscriber s name which will be used for Caller ID display Register Name SIP service subscriber s ID used for authentication User Name User account provided by VoIP
58. ks Call Waiting Tone Advice of Charge Capable Support Emergency Disconnect Control Enable Monitoring Static Line Port Ordering Forwarding Override Conference Device Music On Hold Device Requires BroadWorks Digit Collection Requires MWI Subscription Support Call Center MIME Type Support Identity in UPDATE and Re INVITE Support RFC 3398 Reset Event checkSync Trunk Mode User Hold Announcement Method Inactive Unscreened Presentation Identity Profile Policy Web Based Configuration URL Extension Device Configuration Options Device Configuration Options Device Management 3 2 BroadWorks Configuration Steps No other steps are needed on BroadWorks for setting up the device BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 18 OF 75 Yealink 4 SIP TxP T3xG Configuration The SIP TxP T3xG 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 T3xG uses the Dynamic Host Configuration Protocol DHCP to obtain an IP address TFTP server and other network settings The SIP TxP T3xG 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 Man
59. n This section applies to SIP phones soft clients and other devices that provide a user interface The configuration path of the website Directory Network Directory XSI Type in the related parameters and confirm it Yealink 155 Status Account Network Local Directory sst Host Server Remote Phone Book Port Phone Call Info sol See VpS User ID LDAP Password Network Directory Network Directory Multicast IP Group Enabled Setting Enterprise Disabled Group Common Disabled Enterprise Common Disabled Personal Enabled Custom Directory Enable Custom Directory Call Log Network Call Log Log Out DSSKey Features Settings Security NOTE Network Directory The network directory parameters for administrator Group Enterprise GroupCommon EnterpriseCommon Personal Disabled Enabled v Cancel This section provides configuration instructions for configuration of Xtended Services Interface features supported by the phone including but not limited to BroadWorks Directory and BroadWorks Call Logs Call Logs configuration BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 36 OF 75 Yealink Log Out Yealink 12 jg te Status Account Network DSSKey Features Settings Host Server Remote Phone Network Directory Book Port The network directory parameters for administrator Phone Call Info ee
60. nfiguration of the phone to enable Busy Lamp Field is described as follows Step Command Purpose Step 1 Set the BLF List URI for the line The BLF List URI must be configured to match the Example BroadWorks settings account 1 blf blf_list_uri MyBLFList BroadWorks com On the Broadworks server configure as below wonen Group Users 2413333617 Welcome Admin2 Yealink Logout ieee Busy Lamp Field ANGGANG E Busy Lamp Field allows you to create a list of users to monitor via your SIP Attendant Console Phone and assign a SIP URI to the list Incoming Calls Call Control b Client Applications Messaging List URI sip BLF_3617 Service Scripts Enable Call Park notification Utilities Enter search criteria below Monitored Users 3612 3612 2413333612 3613 3613 2413333613 3614 3614 2413333614 3615 3615 2413333615 3616 3616 2413333616 3618 3618 2413333618 3610 3610 2413333610 3611 3611 2413333611 TR yealink 3619 2413333619 Move Up Move Down EJS ES mS The configure path of the website Account Advanced BLF List URI BLF List Code BLF List Barge In Code Refer to the figure below BLF List URI BLF_3617 as ipol broadwc g Blf List Code KA Blf List Barge In Code Other retated autop parameters Parameter Value Purpose BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE
61. ntact 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 BroadWorks SIP TxP T3xG Verified SIP TxP T3xG Compatible mm yyyy Release Version Versions 08 2013 Release 19 sp1 SIP T19P 31 71 0 15 Any maintenance version of the SIP T21P 34 71 0 60 veiled Nets lone SIP T20P 9 71 0 110 SIP T22P 7 71 0 110 SIP T26P 6 71 0 110 SIP T28P 2 71 0 110 11 2012 Release 18 sp1 SIP T28P 2 70 0 60 Any maintenance version of the erified versions SIP T38G 38 70 0 50 plea data BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 8 OF 75 Yealink Verified Versions Table Date BroadWorks mm yyyy Release 05 2011 Release 17 0 03 2011 Release 17 0 10 2010 Release 17 0 09 2009 Release 14 sp5 SIP TxP T3xG Verified Version SIP T12P 5 60 0 110 SIP T20P 9 60 0 110 SIP T21P 21 61 0 10 SIP T22P 7 60 0 110 SIP T26P 6 60 0 110 SIP T28P 2 60 0 110 SIP T32G 32 0 0 20 SIP T38G 38 0 0 50 SIP T80P 8 60 0 110 SIP T18P 18 0
62. oad File No file chosen Currently using z configuration file Ivar broadworksiIpDeviceConfig type mydevice dm BVWMACADDRES S cfg template File Created tBWIIMESTAMPS kuk configure for line 1 Ek account path config voip sipAccount0 cfg Enable tBWLINE BINARY 1 Label BWEXTENSION 1 DisplayName tBWCLID 1 File Authentication Authentication Mode MAC Based V User Name and Password MAC Address In HTTP Request URI HTTP Header with Following Format Device Access HTTP Authentication Basic Digest Allowed Access Protocols V http V https V tftp Figure 9 MACADDRESS cfg File 5 2 2 2 2 3 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 T3xG requires the following static files m lt firmware version gt rom m Ring wav m lang English txt or other default language file m contactDatai xml contactData xml for Yealink T38G and T32G m AutoDST xml CallData xml m DialPlan xml m DialNow xml m Dialing xml BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 60 OF 75 Yealink CallFailed xml Callln xml Connecting xml Ringback xml Talking xml WebltemsLevel cfg wallpaper jpg for Yealink T38G only ScreenSaver png for Yealink T38G only Add a Broad
63. odified configuration files Repeat for each Yealink model 2 For each group browse to the Utilities Device Configuration page Search for and select the upgraded Yealink model Select Files and set each updated file back to Default Repeat for each Yealink model BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 69 OF 75 Yealink 5 3 2 Upgrade from x 70 x x to x 71 x x The firmware files can be uploaded at any time but loading configuration files should be done during a maintenance window Perform the following steps to upgrade the Yealink Device Type to support version x 71 x x Obtain x 71 x x firmware from Yealink 2 Upload the new Yealink firmware version x 70 x x for each Yealink phone model as described in section 5 2 2 2 2 3 Static Files 3 Import DTAF files for any new or not previously imported Yealink models in use by service provider customers The remaining steps are done during the maintenance window The following configuration template files have been modified in version x 71 x x and need to be uploaded for each Yealink model device profile type lt MAC Address gt cfg y0000000000xx cfg 4 Firmware version tags described in section 5 2 7 2 Create Device Type Specific Tags need to be altered to reflect the new version 5 New custom device tags need to be added per instructions in section 5 2 1 2 Create Device Type Specific Tags 6 Xsi creden
64. oe s phone This line rings when Joe is called so it has Joe s authentication information Step Step 1 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Command Purpose Configure line as shared Configure the line as shared as opposed to private Only for the firmware version PP p lower than V71 20 BD5265 00 PAGE 27 OF 75 Yealink Step 2 Step 3 Step 4 ShareLine 1 Only for the V71 and higher version GOE Reire Ne S Set Register User ID Example Only for the firmware version lower than V71 UserName 22055522 22 Only for the V71 and higher version account i user name 240555222 2 11 Enable SIP Authentication Example Only for the firmware version lower than V71 AuthName joebrown password joeb Only for the V71 and higher version account Le aa name KOS town account l password joeb Configure display name Example DisplayName Joe Brown 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
65. ok personal enable 1 Configure the personal directory name displayed on the IP phone bw phonebook personal displayname Personal Enable the custom directory feature Example bw_phonebook custom 1 4 4 3 BroadWorks Call Logs Configuration Enable the group directory to be displayed on the IP phone 0 Disable 1 Enable Configure Group as the group directory name displayed on the IP phone The default value is Group Enable the group common directory to be displayed on the IP phone 0 Disable 1 Enable Configure GroupCommon as the group common directory name displayed on the IP phone The default value is GroupCommon Enable the enterprise directory to be displayed on the IP phone 0 Disabled 1 Enabled Configure Enterprise as the enterprise directory name displayed on the IP phone The default value is Enterprise Enable the enterprise common directory to be displayed on the IP phone 0 Disabled 1 Enabled Configure EnterpriseCommon as the enterprise common directory name displayed on the IP phone The default value is EnterpriseCommon Enable the personal directory to be displayed on the IP phone 0 Disable 1 Enable Configure Personal as the personal directory name displayed on the IP phone The default value is Personal Enable the custom directory feature 0 Disable 1 Enable Integration with the BroadWorks Xtended Services Interface for Call Logs enables the phone to get c
66. orks SIP Access Device Interoperability Test Plan Support Table Test Plan Package Notification Redundancy Session Border Controller SBC Application Layer Gateway ALG Video Basic Video Calls Video BroadWorks Video Services TCP IPV6 Test Plan Package Items Domain Name System DNS SRV Lookup Register Failover or Failback Invite Failover or Failback Bye Failover Register Outgoing Invite Incoming Invite Call Origination Call Termination Call Hold Call Waiting Call Transfer Auto Attendant Auto Attendant HD Voice Messaging Voice Messaging HD Custom Ringback Register Outgoing Invite Incoming Invite Call Origination Call Termination Session Audit Ringback Codec Negotiation or Renegotiation Voice Message Deposit or Retrieval Call Control Registration with Authentication T38 Fax Messaging Busy Lamp Field Redundancy SBC Video Supported Yes Yes Yes Yes Yes Yes Yes NA NA NA NA NA NA NA NA NA NA Yes Yes Yes NT NT NT NT NT NT NT NT NT NT NT NT NT BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Comments 20 BD5265 00 PAGE 13 OF 75 Yealink BroadWorks SIP Access Device Interoperability Test Plan Support Table Test Plan Package Test Plan Package Items Supported Comments Dual Stack with Alternate NT Connectivity 2 2 2 Other Interface Capabilities The Yealink SIP TxP T3xG firmware v
67. orks 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 Subscriber parameters for the lt MACADDRESS gt cfg Step 1 Step 2 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Enable a line to be used Example Only for the firmware version lower than V71 Enable 1 Only for the V71 and higher version account x enable 1 Configure display name for a line Example Only for the firmware version lower than V71 DisplayName Joe Only for the V71 and higher version account x display name Joe Purpose Enable a line of the SIP TxP T3xG series to be used x should be replaced with the line port number that is to be configured For the line configure the name to be displayed on the device x should be replaced with the line port number that is to be configured 20 BD5265 00 PAGE 22 OF 75 Yealink Step Command Subscriber parameters for the lt MACADDRESS gt cfg Step 3 Set Register User ID for a line Example Only for the firmware version lower than V71 UserName 2405551111 Only for the V71 and higher version AEG Ove Us ete neme Z4AOSSSLLLI Step 4 Enable SIP Au
68. phone model Same as below related X parameter REJECT ANONYMOUS _ 0 Enabled or Disabled the reject CALL_BINARY anonymous incoming calls 1 function of each line 0 Disabled 1 Enabled TRANSPORT_TYPE 0 Defines the SIP transport 1 0 UDP 2 1 TCP 3 2a TLS 3 DNS NAPTR XSP ADDRESS XSI AC String Defines the Xsi host URL for TIONS performing Xsi Actions BWLOGIN ID 1 String Defines the xsi host username XSIPASSWORD 1 String Defines the xsi host password DNS SERVER 1 String Setting the primary DNS server address when configure the static IP address DNS SERVER 2 String Setting the secondary DNS server address when configure the static IP address Example Device Type Specific Tag Settings BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 48 OF 75 Yealink Device Management Tag Sets Modify Display all the device management tags defined in the tag set Tags can be added to the set or deleted from the set Tag Set Name yealink TxP Tags k Delete Tag Name Tag Value Edit O COUNTRY United States Edit O LANGUAGE English Edit O T12 FIRMWARE 5 51 0 11 rom Edit O T20 FIRMWARE 9 71 0 110 rom Edit O T21 FIRMWARE 21 61 0 10 rom Edit O T22 FIRMWARE 7 71 0 110 rom Edit O T26 FIRMWARE 6 71 0 110 rom Edit O T28 FIRMWARE 2 71 0 110 rom Edit O T32 FIRMWARE 32 0 0 20 rom Edit O T38 FIRMWARE 38 70 0 60 rom Edit C T60 FIRMWARE 60 61 0 60 rom Edi
69. pi broadworks net 0 dms YealinkT 1P Ring wavw File Category 8i Static Dynamic Per Type Dynamic Per Device File Customization Disallow Y 7 Enable caching Assign File C2 Manual Custom Upload File 3 a a fe Var broadworks pDeviceConfig type Yealink_T21P Ring wav template gk File Authentication Authentication Mode MAC Based User Name and Password MAC Address In ig HTTP Request URI HTTP Header with Following Format Device Access HTTP Authentication Basic Digest Allowed Access Protocols wW http W https v tftp Figure 10 Static File Setting 5 2 2 2 2 4 Time Zone Alias File In order to properly map the BroadWorks configured user time zone to the Yealink TxP T3xG phone setting a mapping file must be created on the BroadWorks system This file maps the BroadWorks user time zone settings to the phone s time zone settings For more information about time zone mapping for the device profile type see the BroadWorks Device Management Configuration Guide 2 This time zone mapping file must be added to the usr local broadworks bw base conf dms directory on the Application Server using the following file name format TimeZoneAliasLabels lt Device Type Name gt properties For example if the device type name is Yealink T28P the time zone mapping file name must be TimeZoneAliasLabels Yealink 128P properties A space in the device name BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SER
70. r port 5060 Step 2 Set Outbound Proxy Set the Outbound Proxy to the session border controller SBC if one is deployed between the SIP re TxP T3xG series and BroadWorks UseOutboundProxy 1 Only for the firmware version If there are redundant SBCs set it to BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 19 OF 75 Yealink Step Command Purpose System Configuration Items y0000000000 lt xx gt cfg OutboundHost sbc broadworks net the FQDN for the SBC cluster OutboundPort 5060 x should be replaced with the line port number that is to be configured Only for the V71 and higher version account x outbound_proxy_enable 1 account x outbound_host sbc broadworks net account x outbound_port 5060 Step 3 Set SIP Timers The SIP timers should be set to levels short enough to support a timely failover when there is no server response Only for the firmware version lower than V71 dere should be replaced with the line default t2 4 port number that is to be configured dere 5 Only for the V71 and higher version ele NGNE I GS Ga cance ell 1015 5 NGGONE adyan ced se tiem NT ACCNT x ACdVanceSC timer t4 5 Step 4 Set Register Expire Timer Set the registration period Only for the firmware version lower than V71 x should be replaced with the line port number that is to be configured Expire 3600 Only for the V7
71. rameters rrnrrrrnnvrrnnnvvrnnnvrnnnnvrrnnnvennnnvennnnvennnnvennnnnennnnnennnn 22 4 3 Advanced SIP Features Configuration rrnrvrrnnvvrnnnvvrnnnvvrnnnvrrnnnvrrnnnvrrnnnvennnnvenrnnnennnnnennnnnennnn 24 4 3 1 Shared Call Appearance Configuration rrrrnrvrnrnvvrnnnvvrnnnvvrnnnnvennnnvennnvnennnnvennnnnennnnnennnn 25 4 3 2 Hybrid Key System Configuration r arrrrnnvennnvvennnnvennnnvennnvvrnnnnvennnnnennnnnennnnnennnnnennnnnennnn 29 4 3 3 Busy Lamp Field Configuration rrrrnvvrnnnnvennnnvennnvvennnnvrnnnnvennnnvennnnnennnnnennnnnennnnnennnnnennnn 32 4 3 4 Feature Key Synchronization Configuration rrnrrrnnnvvennnvvrnnnrvennnvvennnvvennnnvennnvnennnnnennnn 33 4 3 5 Call Center Feature Configuration rrrrnnvrnnnnvrnnnnvrnnnnvrnnnvvrnnnnvrrnnnvernnnnennnnnennnnnennnnnennnn 34 4 4 Xtended Services Interface Xsi Feature Configuration mrsrrrnvvrrnvvrrnvvrrnvvrrnvvrrnverrnnnrrnneenn 36 4 4 1 BroadWorks User Service Configuration rrnrrrrrnvvrnvnvvrnvnvvenennvrnrnnnenrnvnerrnnnerrnnnerrnneeennn 37 4 4 2 BroadWorks Directory Configuration rrarrrnrnrvrnnnvvrnnnvvrnnnvvennnnvennnnnennnnnennnnnernnnnernnnnennnn 37 4 4 3 BroadWorks Call Logs Configuration rrnrrrnrnvvennnvvrnnnrvennnvvennnnvennnnvennnnnennnnvennnnnennnnnennnn 38 4 5 Instant Message and Presence Configuration rrsvrrnvvrrnvvrrnvvrrnvvnrnvnrnnnnrrnnnrrnnnrrnnnrrnnerrnnnennn 40 Sr Device MANN 42 5 1 Device
72. roadWorks and make them available to a user via the phone menus To enable this feature follow the instructions below Step Command Purpose BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 37 OF 75 Yealink Step 1 Step 2 Step 3 Step 4 Step 5 Step 6 Step 7 Step 8 Step 9 Step 10 Step 11 Enable the group directory to be displayed on the IP phone Example bw_phonebook group_enable 1 Configure the group directory name displayed on the IP phone Example bw phonebook group displayname Group Configure the group common directory to be displayed on the IP phone Example bw phonebook group common enable 1 Configure the group common directory name displayed on the IP phone Example bw phonebook group common displayname GroupCommon Configure the enterprise directory to be displayed on the IP phone Example bw phonebook enterprise enable 1 Configure the enterprise directory name displayed on the IP phone Example bw phonebook enterprise displayname Enterprise Enable the enterprise common directory to be displayed on the IP phone Example bw phonebook enterprise common enable 1 Configure the enterprise common directory name displayed on the IP phone Example bw phonebook enterprise common displayname EnterpriseCommon Enable the personal directory to be displayed on the IP phone Example bw phonebo
73. se see the partner release notes Issue Number Issue Description Device Management file download fails if Xtended BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Partner Version 60024 OL 0O1GK gt x lt X X 0Z X KULUK 20 BD5265 00 PAGE 15 OF 75 Yealink BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Services Platform generates HTTP 302 The T2xP fails to download configuration files and firmware via the Xtended Services Platform if the Xtended Services Platform responds to the http get with a 302 redirect This occurs in Xtended Services Platform farm scenarios and other scenarios in which the URL changes Workaround No workaround This issue is resolved in T2xP version x 51 0 17 Device Management file download fails if T2xP upgrade URL is configured as an FQDN The T2xP fails to download configuration files and firmware via the Xtended Services Platform if the phone s upgrade URL is configured as an FQDN Workaround Ensure the upgrade URL is configured as an IP address This issue is resolved in T2xP version x 51 0 21 20 BD5265 00 PAGE 16 OF 75 Yealink 3 BroadWorks Configuration This section identifies the required BroadWorks device profile type for the Yealink SIP TxP T3xG as well as any other unique BroadWorks configuration required for interoperability with the SIP TxP T3xG 3 1 BroadWorks Device Pro
74. service provider NAT Traversal Defines the STUN server will be active or not 3 Choose the SIP Server Type as Broadsoft on the advanced path of the accout page 4 Refer to the related autop parameters to config the call center features listed below Description Notes Parameter Value account X acd enable 1 0 4 Enable or disable ACD feature for Account X 0 Disabled default 1 Enabled BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK 20 BD5265 00 PAGE 34 OF 75 Yealink account X call center call info enable 1 account X call center sho w call info time account X call center qu eue status enable 1 account X call center qu eue status light enable account X call_center dis p_code_enable 1 account X bw disp code y2 account X bw disp code name Y account X call center trac e enable 1 account X call center em ergency enable 1 account X supervisor info _code Y account X supervisor_info _code_name Y account X acd unavailabl e reason enable 1 Number Number String String String 0 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES Enable or disable the call center call information feature 0 Disabled default 1 Enabled Specify the duration in seconds that the phone displays the call center call information The default value is 30 seconds Enable or disable the c
75. sssseecsssseecssseeeeesseseessseseesesseeeseseeeesesseseussseeeesesensesessneeeesass 64 Figure 12 Device Profile Instance Custom Tags Over ride rrrrrrrnrvnnvnvvrrvnvvervnvvenvnvverrnnverrnvrerenneerenne 65 Figure 13 Device Profile Instance Custom Tags Add rrnnnnvvvnnnnnvvnnnnnvvrnnnnvvennnnnvnnnnnnnnensnnvnernnnnvennnnnnn 65 Figure 14 Assign Device Profile to USer rrrrrrrrnnvrnnnvvennnnvrnnnvvrnnnnvrnnnnvrnnnnnrrnnnnernnnnennnnnennnnnernnnnennnnnennnnne 66 Figure 15 LON STEN een 68 Figure 16 Upgrade Screen cccccscccsssccsssecsseecsseecsseecseecseeecseseceaeecseeecsaeecessecsseaceaeacsaeeseaeassaeasseeeseeeeaeas 68 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 6 OF 75 Yealink 1 Overview This document describes the configuration procedures required for a Yealink SIP TxP T3xG series to make full use of the capabilities of BroadWorks This includes the following models SIP T19P SIP T20P SIP T21P SIP T22P SIP T26P SIP T28P SIP T32G SIP T38G The SIP TxP T3xG is one of the many desk phones that interoperate with BroadWorks The SIP TxP T3xG 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 us
76. st not be blank so set it to not used Device File Format not_used This parameter must not be blank so set it to not used The following figure shows Device Management enablement for BroadWorks release prior to Release 18 0 Auto Configuration Options Web Based Configuration URL Extension Auto Configuration Type 2 Config File 3 Config File Not Supported Enable Monitoring CPE System File Name not used Device File Format not used Figure 6 Enable Device Management pre Release 18 0 5 2 2 2 1 2 Configure Device Management Options Modify the device profile type Device Management Options as directed in the following table These are common settings that apply to all devices enabled for Device Management If Device Management has been enabled previously for the device profile type s ensure the existing settings match the settings described in this section Parameters not identified in the following table can usually be left at the default values Parameter Value Description Device Configuration Use Default System Tag Set and Tags Tag Set Select the device tag set created in section 5 2 1 2 Create Device Type Specific Tags Allow Identity Device checked Optional Profiles to Configure Custom Tags Allow Groups to checked Optional Configure Custom Tags Device Access http Protocol Device Access FQDN lt BroadWorks XSP Cluster Set to the Xtended Services Address gt Platform cluster FQDN i
77. t O T65 FIRMWARE 65 61 0 60 rom Edit O T80 FIRMWARE 8 51 0 10 rom Edit Page 1 of 1 TT Fina i Figure 3 Device Type Specific Tag Settings 5 2 2 Configure BroadWorks Device Profile Type The device profile type is a system level structure that defines how the device interfaces with BroadWorks It also identifies the default configuration files and other files such as firmware which are required for the phone to operate correctly The device profile type is created by the system administrator Group administrators use the device profile type to create a device profile The device profile is an instance of the device profile type that is associated with a physical device or IP phone There are two BroadWorks device profile configuration methods described import and manual The import method takes a DTAF as input and builds the BroadWorks device profile type s automatically The manual method walks the administrator through the steps to manual add and configure the device profile type s The import method should be used if all of the prerequisites are met m The BroadWorks Release is 17 0 or later m The device profile type s being imported do not already exist on the system If either a previous import or manual configuration was done the import fails BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 49 OF 75 Yealink m There is a DTAF file available for import with a
78. t for Yealink T2xP T3xG version x 70 0 x test with BroadWorks Release 18 sp1 2 9 Edited changes and published document 2 10 Updated the document for Yealink TxP T3xG version x 71 0 x test with BroadWorks Release 19 sp1 BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 3 OF 75 Yealink Table of Contents LL DEM 7 Z neroperabll SAUS ass 8 2 1 Verified Versions anakan ine aana dee EE adah naanin e dead ahi aan anama pa a a aenak 8 2 2 Interface Capabilities Supported aaaaaaa aana anana anaa anaa nana aaa anana anaa naen anana naen nana e nee 9 2 2 1 Interface Capabilities Supported aaaaaa anana aaa anana anaa a naen naen aana nana nana a anane e nee 10 FREE RONNIE UGG aior saa kana ea apana ga a baen a aa Aa Na e a KK ah a a eaaa AE ME 15 3 BroadWorks Configuration viscid occ aah senen anan nean anan eda nnan nnan 17 3 1 BroadWorks Device Profile Type Configuration 0sasaeaene rana aaa aana naa an nana a naen nenen 17 3 2 BroadWorks Configuration Steps ccccccccssecsssecssseceseeesseeesseeseseeeseeesseeeseeeseeesseeesseeesseeess 18 4 SIP TxP T3XG Configuration oases css seectsctc cc ncct swe sesistcvessetietsivinntscincnsatsetvenstevesessesseve atectkeneessbsoustee 19 4 1 System Level Configuration cccccccscccssscecssseessseeecsseeecsseecsseeesseeesseessseeessseeeesseessseesssseeess 19 4 2 Subscriber Level Configuration Pa
79. ter address BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 50 OF 75 Yealink Device Management Device Type URL httplespl japi broadworks netedfdmsYealink TR O No Tags Device Configuration Tags O Use Default System Tag Set Only Use Default System Tag Set and Tag Set vealink TxF Tags v Allow IdentityQevice Profiles to Configure Custom Tags Allow Groups to Configure Custom Tags Send Email Notification to User upon Device Reset Failure Device Access Protocol http Device Access FQDN Access F DN xspl i0p broacdworks net ws Device Access Port Device Access Contest Namerdms sd Device Access URI Default Device Language Default Device Encoding Authentication Mode MAC Based User Name and Password Device Access Username Device Access Password am Password MAC Address In HTTP Request URI HTTP Header with Following Format Device Access HTTP Authentication Basic Digest Figure 4 Device Access FQDN 7 Click the Files and Authentication link and select the option to rebuild all the system files Firmware files must be obtained from Yealink These files are not included in the firmware files and to upload the firmware NOTE The non firmware static files in section 5 2 2 2 2 3 Static Files are included in the import After importing the DTAFs restart the Application Server to load the TimeZon
80. the group 5 2 6 Configure Yealink TxP This section describes the steps necessary to configure the Yealink TxP T3xG to integrate with BroadWorks Device Management Log in to the web user interface for the TKP phone https lt phone ip address gt Go to the Upgrade web page and set the following Check New Config Power On URL Device Management server Xtended Services Platform device address URL Example htto s xsp1 broadworks net 80 dms Yealink_T28P Account BroadWorks Device Access User Name Example Ismith Password BroadWorks Device Access Password Example 123456 Restart the phone to force the phone to download the Device Management configuration files and firmware BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 67 OF 75 Yealink Example Login Default User Name Password is admin admin Version NOTE Authentication Required x Version It shows the version of vw A username and password are being requested by http 10 1 3 129 The site says Enterprise firmware IP phone SIP T28P User Name admin Network Password Jol It shows the information about WAN port and LAN Cancel port MAC Address 00 15 65 11 6c 54 Link Status Connected PC IP Address 0 0 0 0 Device Type Bridge DHCP Server Status PC Disabled Figure 15 Login Screen Example Upgrade screen Basic Advanced Custom Option 128 254 Q EJ NOTE
81. thentication for a line Example Only for the firmware version lower than V71 AuthName 2405551111 password 123456 Only for the V71 and higher version account x auth name 220555 accoune xx 1 P SSvV ord 123456 Step 5 Configure eventlist BLF for a line BEETS ETU gt lt oroedkerks o le es be Example Only for the firmware version lower than V71 Bk I NEK myblflist as iopl broadworks net Only for the V71 and higher version Ace une bln ibn liet ba nvyoltitet as 10p Wproaedworks net Purpose The register user ID must correspond with the line port setting on BroadWorks x should be replaced with the line port number that is to be configured If the Authentication service is configured on BroadWorks these parameters must be configured to match the BroadWorks settings x should be replaced with the line port number that is to be configured Configure the eventlist busy line field BLF on the Account Settings page to match the BroadWorks busy lamp field list URI setting for the user x should be replaced with the line port number that is to be configured BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 23 OF 75 Yealink Step Command Subscriber parameters for the lt MACADDRESS gt cfg Step 6 Step 7 Configure Network Conference for a line Only for the firmware version
82. tials need to be defined at each device profile as described in section 5 2 3 Create Device Profile Instance 7 Perform the upgrade by group following the steps in section 5 3 7 General Recommendations for Upgrades Alternatively omit the group steps and perform the upgrade at the system level BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 70 OF 75 Yealink Appendix A Sample TxP T3xG 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 y0000000000xx cfg NOTE This is an example file and should be used for reference only SIP Default Generic Configuration File Phone Specific File lt MAC Address gt cfg NOTE This is an example file and should be used for reference only SIP Device specific Configuration File BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 71 OF 75 Yealink Appendix B TIMEZONENAME values Mexico Mazatlan Chihuahua Mexico Mexico City Acapulco 0 JM O o Greenland i O 0 Denmark Faroe Islands Torshavn S o irelandfDublin s 0 Portugal Lisboa Porto Funchal S BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERI
83. trol Services DUT Services Registration and Authentication DUT Services Fax DUT Services Emergency Call DUT Services Miscellaneous BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Test Plan Package Items Calling Line ID Calling Line ID with Unicode Characters Connected Line ID Connected Line ID with Unicode Characters Connected Line ID on UPDATE Connected Line ID on Re INVITE Diversion Header History Info Header Advice of Charge Meet Me Conferencing Call Waiting Call Hold Call Transfer Three Way Calling Network Based Conference Register Authentication Maximum Registration Minimum Registration Invite Authentication Re Invite or Update Authentication Refer Authentication Device Authenticating BroadWorks G711 Fax Passthrough G711 Fax Fallback T38 Fax Messaging Emergency Call Emergency Call with Ringback Do Not Disturb Call Forwarding Always Call Forwarding Always Diversion Inhibitor Anonymous Call Anonymous Call Block Supported Yes Yes Yes Yes Yes Yes Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No NA NA NA No No Yes Yes Yes Yes Yes Comments 20 BD5265 00 PAGE 11 OF 75 Yealink BroadWorks SIP Access Device Interoperability Test Plan Support Table Test Plan Package Advanced Phone Services Busy Lamp Field Advanced Phone Services Feature Key
84. ual 1 The capabilities of the SIP TxP T3xG 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 y0000000000 lt xx gt cfg system configuration file y0000000000xx cfg where xx associated with the hardware version of Yealink Device that is y000000000000 cfg for Yealink SIPT28P lt MACADDRESS gt cfg device specific configuration file 4 1 System Level Configuration This section describes system wide configuration items that are generally required for each SIP TxP T3xG to work with BroadWorks Subscriber specific settings are described in the next section Step Command Purpose System Configuration Items y0000000000 lt xx gt cfg Step 1 Set SIP Proxy Domain Set the SIP TxP T3xG series SIP EE server to the Fully Qualified Domain Ci E BIG UNE MESSER Name FQDN for the BroadWorks lower than V71 Application Server cluster SIPServerHost as broadworks net The domain must match the domain SIPServerPort 5060 configured for the BroadWorks subscriber s line port domain x should be replaced with the line Only for the V71 and higher port number that is to be configured version account x sip server host as broadworks net account x sip serve
85. uch 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 NOTE DUT in the following table refers to the Device Under Test which in this case is the Yealink SIP TxP T3xG BroadWorks SIP Access Device Interoperability Test Plan Support Table Test Plan Package Basic BroadWorks Services BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 2013 YEALINK Test Plan Package Items Call Origination Call Termination Session Audit Session Timer Ringback Forked Dialog Early UPDATE Early Session 181 Call Being Forwarded Dial Plan Dual Tone Multi Frequency 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 or Retrieval Message Waiting Indicator Voice Portal Outcall Advanced Alerting Supported Yes Yes Yes Yes Yes Yes No No Yes Yes Yes Yes Yes Yes Yes NA Yes Yes Yes Yes Yes Comments 20 BD5265 00 PAGE 10 OF 75 Yealink BroadWorks SIP Access Device Interoperability Test Plan Support Table Test Plan Package DUT Services Call Con
86. vice template files Note that these custom and system tags must also be defined on BroadWorks 3 Create a device profile tyoe on BroadWorks for each device model to be integrated with Device Management 4 Add the device template files and other associated files to the device profile type 5 Create a device profile instance of the device profile type and assign it to a user A user name and password are assigned to this device profile 6 The end device is configured with the Device Management URL for device files as well as the user name password access credentials This section describes the steps to integrate the Yealink SIP TxP T3xG phones As part of the Yealink SIP TxP T3xG CPE kit BroadSoft has defined a standard device configuration in the device template files that service providers can use on their systems These files can be uploaded directly to Device Management without modification However the service provider also has the option to modify these template files as required to fit their deployment needs The CPE kit also includes tools to help automate the integration effort For releases after Release 17 0 there is a Device Management import export utility The CPE kit contains DTAF files that can be used to import the device type and template files 5 1 Device Management Capabilities Supported The Yealink SIP TxP T3xG has completed Device Management interoperability testing with BroadWorks using the BroadWorks Device
87. works net Aliases sip dmtestolient as iop1 brosdworks net 2500p broadworks net as iop broadworks net as iop broadworks net Figure 14 Assign Device Profile to User NOTE Please consider the provisioned Xsi credentials at the device profile level when defining new users or assigning existing device profiles to other users 5 2 5 Configure Edge Device In many deployments an edge device is deployed on the enterprise edge Configure the edge device SIP server setting with the service provider s session border controller IP address or FQDN To integrate the edge device with Device Management the SBC address tag SBC ADDRESS defined in section 5 2 1 1 Create System Default Tags must be overridden at the group level with the LAN address of the edge device At the Group BROADSOFT PARTNER CONFIGURATION GUIDE YEALINK SIP TXP T3XG SERIES 20 BD5265 00 2013 YEALINK PAGE 66 OF 75 Yealink Utilities Configure Device page select the Yealink device profile example Yealink T28P Perform the following steps 4 Q N 4 5 6 Click on the Custom Tags tab Click Add Add the SBC tag For the tag enter SBC ADDRESS For the value enter the IP address that is the edge device LAN IP address To save the tag data click OK This Tag Value is applied to all Yealink model phones in the group using the modified Device Profile Type Repeat for each Yealink model provisioned in

BroadSoft Partner Configuration Guide

Contents

Download Pdf Manuals

Related Search

Related Contents