Spectralink Configuration Management Server. Administration Guide. For PIVOT Smartphones and 84 -Series Handsets. Release 2.4.x

Transcription

1 Spectralink Configuration Management Server Administration Guide For PIVOT Smartphones and 84 -Series Handsets Release 2.4.x Rev F v2 February 2018

2 Copyright Notice Spectralink Corporation All rights reserved. Spectralink TM, the Spectralink logo and the names and marks associated with Spectralink s products are trademarks and/or service marks of Spectralink Corporation and are common law marks in the United States and various other countries. All other trademarks are property of their respective owners. No portion hereof may be reproduced or transmitted in any form or by any means, for any purpose other than the recipient s personal use, without the express written permission of Spectralink. All rights reserved under the International and pan-american Copyright Conventions. No part of this manual, or the software described herein, may be reproduced or transmitted in any form or by any means, or translated into another language or format, in whole or in part, without the express written permission of Spectralink Corporation. Do not remove (or allow any third party to remove) any product identification, copyright or other notices. Notice Spectralink Corporation has prepared this document for use by Spectralink personnel and customers. The drawings and specifications contained herein are the property of Spectralink and shall be neither reproduced in whole or in part without the prior written approval of Spectralink, nor be implied to grant any license to make, use, or sell equipment manufactured in accordance herewith. Spectralink reserves the right to make changes in specifications and other information contained in this document without prior notice, and the reader should in all cases consult Spectralink to determine whether any such changes have been made. NO REPRESENTATION OR OTHER AFFIRMATION OF FACT CONTAINED IN THIS DOCUMENT INCLUDING BUT NOT LIMITED TO STATEMENTS REGARDING CAPACITY, RESPONSE-TIME PERFORMANCE, SUITABILITY FOR USE, OR PERFORMANCE OF PRODUCTS DESCRIBED HEREIN SHALL BE DEEMED TO BE A WARRANTY BY SPECTRALINK FOR ANY PURPOSE, OR GIVE RISE TO ANY LIABILITY OF SPECTRALINK WHATSOEVER. Warranty The Product Warranty and Software License and Warranty and other support documents are available at Contact Information US Location Denmark Location UK Location (0) Spectralink Corporation th Street Boulder, CO Spectralink Europe ApS Bygholm Soepark 21 E Stuen 8700 Horsens Spectralink Europe UK 329 Bracknell, Doncastle Road Bracknell, Berkshire, RG12 8PE USA Denmark United Kingdom info@spectralink.com infoemea@spectralink.com infoemea@spectralink.com February

3 Contents About This Guide Deployment process What is QNC? What is CMS? What is MDM/EMM? What is Manual Configuration? Product Support Spectralink References Specific Documents Spectralink PIVOT smartphones Specific Documents Spectralink 84-Series handsets White Papers Conventions Used In This Document Icons Typography Part I: Getting Started with CMS How Secure is CMS? Setting HTTPS Chapter 1: CMS 2.x Server Requirements Minimum Requirements Capacity Guidelines Chapter 2: Installing the CMS VM ESXi 5.x Server Installation Overview CMS 2.0 Infrastructure Installation Instructions Creating your CMS Account and Logging in Logging in to CMS Part II: Shared CMS Features Chapter 3: About Us What is the Account Key? What is the CMS Certificate? February

4 Chapter 4: Licenses CMS License Chapter 5: Wireless Profiles Wireless Profile Security Open Network WEP WPA/WPA2 PSK x EAP (WPA2 Enterprise) Set up Managing Wireless Profiles Part III: PIVOT Configuration Management Navigation Banner Navigation pane Deployment Sequence Chapter 6: PIVOT Batch Configuration MAC address Owner info Group name SIP extension number SIP username SIP password Upload.csv to CMS Generate.csv from Legacy CMS Chapter 7: PIVOT Devices Approving Devices via Holding Area Device List Device List actions Re-Deploying Devices Chapter 8: Updating PIVOT Code Upload files Manage files Updating Legacy Code Chapter 9: PIVOT Groups February

5 Chapter 10: PIVOT Configuration Understanding Enterprise, Group and Device Levels Enterprise settings Group settings Device settings Understanding Default Settings Deleting Default Settings Config Manager Wireless / Networking Wireless profiles IPv Unsecured wireless networks available notification n Wi-Fi frequency band Standby roaming threshold Device Security Allow user to change lock screen password, Make passwords visible Display Owner info on lock screen Allow unknown application sources Enable Admin password prompt Lock screen after Owner info Non Wi-Fi Certificates Admin password Emergency Contacts Contact name, contact number General Settings LDAP LDAP server address LDAP server port Communication security type LDAP bind DN LDAP bind PW LDAP base DN Primary attribute Alternate attribute Push to talk Enable settings Channel settings SAFE / Panic SIP Telephony February

6 Enable SIP Registration 1 and Server address Server Port Transport Extension Username Password Voic retrieval address Use SIP standard hold signaling Force subscription to message waiting notifications Common settings Audio codec priority System Log Web API Enable API Calls Web API Format Type Polling Username, Polling Password Polling Respond Method Push Username / Push Password Allow message priority Push ringtone Server root URL Web API Event URLs Label URL Settings Web Applications Label, URL Barcode Scanner Enable Camera as a Scanner Symbology Settings Quick Barcode Connect Encryption Connection timeout Response timeout Keep-alive timeout Inactivity timeout Operation Mode Server Address Server Port Passphrase Barcode Ringtone February

7 Chapter 11: Add Wireless Profiles to PIVOT Open Network WEP WPA/WPA2 PSK x EAP (WPA2 Enterprise) Set up Managing Wireless Profiles Chapter 12: PIVOT Certificate Manager Installing generic CA certificates or PAC files Managing certificates Chapter 13: Replace a PIVOT Device Chapter 14: PIVOT Feature / Device Licenses CMS license Feature license Part IV: Spectralink 84-Series Configuration Management Logging in to CMS Navigation Banner Navigation pane Logout Switch to PIVOT Deployment Sequence Basic Configuration Advanced Configuration Chapter 15: Spectralink 84-Series Batch Configuration SIP setup User or Mac Type Server address Server Port Extension UserID Display name Line Label February

8 Upload.csv to CMS Chapter 16: Spectralink 84-Series Devices Device Holding Area Approving Devices via Holding Area Device List Device List actions Re-Deploying Devices Chapter 17: Spectralink 84-Series Groups Group Name Associate Devices Manage Groups Chapter 18: Spectralink 84-Series Configuration Understanding Enterprise, Group and Device Levels Enterprise settings Group settings Device settings Understanding Default Settings Config Manager Logging Global Log settings Module Log Level Limits SIP Registration Base Profile Skype for Business (not available in R2.4) Open SIP Lines Server Settings Web App APP URL(s) Web Browser Phone State Polling Push Request Telephony Notification Open Application Interface Call Features Call Handling Phone Lock Tones Ring Type Mapper February

9 Alert Type Mapper Personal Alarms Motion events Alarms and Warnings Duress Settings Enhanced Feature Keys Push to Talk General Settings PTT Channels Wireless Configuring radio frequency settings Chapter 19: Spectralink 84-Series Custom Settings Import Configuration Create Configuration Download and Edit Custom Settings Files Apply Custom Settings File(s) Apply Custom Setting to a Device Apply Custom Setting to a Group Apply Custom Settings to the Enterprise Chapter 20: Spectralink 84-Series Resource File Chapter 21: Spectralink 84-Series OTA Files Updating Spectralink 84xx Code Upload files Manage files Chapter 22: Spectralink 84-Series RMA--Replace Device Part V: Appendices Appendix A: Open Source Information OFFER for Source for GPL and LGPL Software Contact Information for Requesting Source Code Appendix B: Products Mentioned in this Document February

10 About This Guide The primary tool for administering a volume of Spectralink devices is CMS, the Configuration Management System. CMS provides a GUI program that is opened in a browser and provides an easy and intuitive way to configure and manage the deployment of many devices. Spectralink 84-Series handsets and Spectralink PIVOT smartphones can be administered with CMS. An administrator can configure any handset or smartphone s administrative settings in CMS. These settings can be configured at the Device level for a single device, at a Group level for a subset of devices or at an Enterprise level for every device deployed within a facility. These settings are picked up by all registered devices when they heartbeat into CMS. An administrator can see devices in the Device list. Each device provides information as part of its heartbeat and this information enables an administrator to check on activity and usage information. CMS is designed to be the exclusive configuration method for Admin menu options. If devices are configured manually through their Admin menus, CMS will not know about these changes. Existing CMS configuration settings will overwrite any manual changes at the next heartbeat. Deployment process What is QNC? Quick Network Connect utilizes a customized version of a commercially available Raspberry Pi to simplify the wireless provisioning of your Spectralink devices. When connected to a PC, QNC provides a browser-based GUI that provides you with the wireless configuration parameters you need to set in order for PIVOT to associate with the wireless LAN. Once the configuration is completed, a connection between QNC and an device loads the wireless parameters into the smartphone. See Quick Network Connect Administration Guide for complete information. February

11 What is CMS? The primary tool for administering a volume of Spectralink devices is the CMS, the Configuration Management System. It is a GUI program that is opened in a browser and provides an easy and intuitive way to configure the devices and manage the deployment of many devices at once. What is MDM/EMM? EMM is Enterprise Mobile Management, a term used to describe the management of mobile devices in a business context. EMM software is an offshoot of MDM or Mobile Device Management. EMM is the preferred approach as it is specifically designed for enterprise applications and devices. MDM/EMM programs are used to manage applications. Applications need to be managed on PIVOT so that enterprise devices remain secure. The degree of control is a matter of enterprise policy. Certain facilities use these management tools in conjunction with CMS to manage PIVOT devices. What is Manual Configuration? Like any device powered by Android, Spectralink devices provide menus for configuring options that provide functionality and features. Two types of menus are available, the familiar user-level menus used by all devices and administrator menus that are behind a password. Manual configuration refers to using these menus to set up each device individually. Practically any deployment will require some manual adjustments so this step is included to put the final polish on your deployment. Product Support Spectralink wants you to have a successful installation. If you have questions please contact the Customer Support Hotline at The hotline is open Monday through Friday, 6 a.m. to 6 p.m. Mountain time. For Technical Support: mailto:technicalsupport@spectralink.com For Knowledge Base: For Return Material Authorization: mailto:nalarma@spectralink.com Spectralink References All Spectralink documents are available at February

12 To go to a specific product page: Select the Product Category and Product Type from the dropdown lists and then select the product from the next page. All resources for that particular product are displayed by default under the All tab. Documents, downloads and other resources are sorted by the date they were created so the most recently created resource is at the top of the list. You can further sort the list by the tabs across the top of the list to find exactly what you are looking for. Click the title to open the link. Specific Documents Spectralink PIVOT smartphones PIVOT documents are available on the Spectralink support site at AP Configuration Guides show you how to correctly configure access points and WLAN controllers (if applicable) and identify the optimal settings that support Spectralink devices. The guides are available on the View Certified page on the Spectralink support site at Quick Network Connect Administration Guide QNC provides step-by-step instructions for configuring wireless settings required for the smartphones to associate with the wireless LAN. QNC software and documents are available on the Spectralink support site at Spectralink Configuration Management System Administration Guide The CMS Administration Guide provides information about every setting and option available to the administrator on PIVOT and CMS. Time-saving shortcuts, troubleshooting tips and other important maintenance instructions are also found in this document. CMS software and documents are available on the Spectralink support site at PIVOT by Spectralink Deployment Guide The Deployment Guide provides sequential information for provisioning and deploying the smartphones. It covers deployment using QNC and CMS as well as manual deployment. PIVOT by Spectralink Configuration Guide The PIVOT Configuration Guide provides detailed information about PIVOT menu items that have been developed specifically for the PIVOT smartphone. February

13 PIVOT by Spectralink Wi-Fi Security Implementation Guide Wi-Fi security prevents unauthorized over-the-air access to network components and the sensitive data that resides there. This Guide discusses the various method and explains how to implement each of them. PIVOT 8744 Barcode Administration Guide This Administration Guide supports the PIVOT 8744 model which includes the onboard camera which can be configured to function as a barcode scanner. It provides information about supported symbologies for this model. PIVOT 8753 Barcode Administration Guide This Administration Guide supports the PIVOT 8753 model which incorporates a barcode reader. It provides detailed information about supported symbologies for this model. PIVOT by Spectralink QBC Administration Guide Provides instruction for implementation of the Quick Barcode Connector application. The PIVOT by Spectralink User Guide contains information about using with the smartphone feature. PIVOT by Spectralink Application Installation Guide The Applications Installation Guide provides detailed information about deploying any type of application, using an app store or MDM and manual processes for loading applications on the Spectralink 87-Series smartphone. PIVOT by Spectralink User Guide The User Guide provides detailed information about using the features of the 87-Series smartphones. PIVOT by Spectralink Web Developer s Guide The Web Developer s Guide provides Web application creators with information for developing and deploying Web applications that interface with Spectralink smartphones. Best Practices for Deploying Spectralink 87-Series PIVOT Handsets provides detailed information on wireless LAN layout, network infrastructure, QoS, security and subnets. For information on IP PBX and softswitch vendors, see PIVOT by Spectralink Call Server Interoperability Guide. Specific Documents Spectralink 84-Series handsets The Spectralink 84-Series Wireless Telephone Administration Guide provides a comprehensive list of every parameter available on Spectralink 84-Series Wireless Telephones. Spectralink 84 Series Wireless Telephone Deployment Guide Using Spectralink CMS This document introduces deployment concepts and the methods of provisioning the 84-Series handsets when using CMS as your provisioning server. Spectralink Configuration Management System Administration Guide The CMS Administration Guide provides information about every setting and option available to the administrator on Spectralink 84-Series handsets and CMS. Time-saving shortcuts, troubleshooting tips and other important maintenance instructions are also found in this document. CMS software and documents are available on the Spectralink support site at February

14 Spectralink 84-Series Wireless Telephone Deployment Guide This document introduces deployment concepts and the methods of provisioning the 84-Series handsets in any type of facility when not using CMS as a provisioning server. Barcode Administration Guide Provides information about barcode symbologies and how to configure and implement the barcode feature on the handset. The Spectralink 84-Series User Guide also contains information about using the barcode feature. Quick Barcode Connector Administration Guide Provides instruction for implementation of the barcode application. The Spectralink 84-Series User Guide contains information about using the barcode feature. The Spectralink 84-Series User Guide offers comprehensive instructions on using each of the features deployed on the handsets. The Web Configuration Utility User Guide is used for troubleshooting in certain isolated cases as explained in the text. For information on IP PBX and softswitch vendors, see the Spectralink 84-Series Call Server Interoperability Guide. For information about combining Polycom desksets and Spectralink 84-Series handsets in the same facility, see the Interoperability Guide: Spectralink 84-Series Wireless Telephones and Polycom Desksets. AP Configuration Guides explain how to correctly configure access points and WLAN controllers (if applicable) and identify the optimal settings that support Spectralink 84-Series handsets. Technical Bulletins and Feature Descriptions explain workarounds to existing issues and provides expanded descriptions and examples. Release Notes describe the new and changed features, and resolved issues in the latest version of the software. Find them in the Downloads section of the support site. White Papers Spectralink White Papers are available at For the Spectralink 84-Series Wireless Telephones, please refer to Best Practices Guide for Deploying Spectralink 84-Series Handsets for detailed information on wireless LAN layout, network infrastructure, QoS, security and subnets. For additional details on RF deployment please see The challenges of ensuring excellent voice quality in a Wi-Fi workplace and Deploying Enterprise-Grade Wi-Fi Telephony. These White Papers identify issues and solutions based on Spectralink s extensive experience in enterprise-class Wi-Fi telephony. It provides recommendations for ensuring that a network environment is adequately optimized for use with Spectralink Wireless Telephones. February

15 Conventions Used In This Document Icons Icons indicate extra information about nearby text. Warning The Warning icon highlights an action you must perform (or avoid) to avoid exposing yourself or others to hazardous conditions. Caution The Caution icon highlights information you need to know to avoid a hazard that could potentially impact device performance, application functionality, successful feature configuration and/or affect smartphone or network performance. Spectralink recommends A recommendation from the experts at Spectralink. Note The Note icon highlights information of interest or important information that will help you be successful in accomplishing a procedure or understanding a concept. Tip The Tip icon highlights information that may be valuable or helpful for users to know, such as special techniques, shortcut methods, or information that will make user tasks easier to perform. Web The Web Info icon highlights supplementary information available online such as documents or downloads on support.spectralink.com or other locations. Timesaver A time-saving tip is typically used to mention or highlight a faster or alternative method for users who may already be familiar with the operation or method being discussed. Admin Tip This tip advises the administrator of a smarter, more productive or alternative method of performing an administrator-level task or procedure. February

16 Power User A Power User Tip is typically reserved for information directed specifically at highlevel users who are familiar with the information or procedure being discussed and are looking for better or more efficient ways of performing the task. For example, this might highlight customization of a feature for a specific purpose. Troubleshooting This element can be used in any type of document and is typically used to highlight information to help you solve a relevant problem you may encounter, or to point to other relevant troubleshooting reference information. Settings The Settings icon highlights information to help you zero in on settings you need to choose for a specific behavior, to enable a specific feature, or access customization options. Typography A few typographic conventions, listed next, are used in this guide to distinguish types of in-text information. Convention Bold Italics Underlined blue Bright orange text Fixed-width-font Description Highlights interface items such as menus, soft keys, file names, and directories. Also used to represent menu selections and text entry to the smartphone. Used to emphasize text, to show example values or inputs, and to show titles of reference documents available from the Spectralink Support Web site and other reference sites. Used for URL links to external Web pages or documents. If you click on text in this style, you will be linked to an external document or Web page. Used for cross references to other sections within this document. If you click on text in this style, you will be taken to another part of this document. Used for code fragments and parameter names. This guide also uses a few writing conventions to distinguish conditional information. Convention <MACaddress> Description Indicates that you must enter information specific to your installation, smartphone, or network. For example, when you see <MACaddress>, February

17 Convention Description enter your smartphone s 12-digit MAC address. If you see <installeddirectory>, enter the path to your installation directory. > Indicates that you need to select an item from a menu. For example, Settings> Basic indicates that you need to select Basic from the Settings menu. February

18 Part I: Getting Started with CMS CMS is a powerful interface for configuring and managing Spectralink devices. Let s take a moment to look at some big questions. Caution: CMS 2.4 and above compatibility Spectralink 84-Series must use R5.4.4 and above to operate with CMS 2.4. CMS 2.4 was tested with PIVOT R2.5. However, CMS 2.4 should work with any PIVOT smartphone software version. Settings: Is CMS necessary? The question will arise if CMS is strictly necessary for configuring and managing the smartphones. The short answer is No, not if you are deploying only a few smartphones. The smartphones Settings app includes an Admin menu behind a password. This menu can be used to manually set parameters and view smartphone usage data. This document covers nearly all the settings you will find in the Admin menu. The longer answer is Yes; if you are deploying many devices, have complex settings such as security certificates, device groups, etc., or if the devices cannot be easily retrieved for user support functions. The CMS is a boon to Wi-Fi and IT administrators as it can keep track of and manage any number of devices remotely. Admin Tip: How does the Android platform affect CMS? PIVOT smartphone code and CMS code must remain in sync for the configurable options to remain the same. You can expect new releases of CMS whenever options in the smartphone code change. Releases are synchronized quarterly. Always use the parallel or most recent CMS code with PIVOT smartphones. CMS is designed to be backwards compatible with earlier smartphone code versions so you do not need to use a downrev version of CMS. Options that are not su-ported by a device model or release version will be ignored by the device. Settings: Not using CMS? If you are not deploying a CMS, please refer to deployment documents for the sequence of steps to take when manually configuring the devices. February

19 How Secure is CMS? CMS transfers configuration information to the devices over the air which could expose the data to unauthorized parties. CMS uses both HTTP and HTTPS protocols but the default is HTTPS. If your facility uses the HTTPS protocol, you can take advantage of the mutual authentication feature built into CMS. Mutual authentication is implemented by generating a public key on the CMS and loading it into the device using QNC. This is the server key that ensures the device recognizes the CMS as genuine. The device contains a device certificate that is loaded during manufacturing. The CMS can recognize this key and therefore knows that the device is genuine. Once this authentication handshake is complete, the device and the CMS exchange information over a secure connection. This secure connection is not possible using HTTP. Setting HTTPS The following settings are required when using HTTPS to establish the secure tunnel. 1 Setting address] for CMS in the device and 2 Using QNC to install the CMS certificate. February

20 Chapter 1: CMS 2.x Server Requirements Minimum Requirements VMWare ESXi server 5.0 (or later) host machine capable of running 64-bit guest OS Virtual Machines (VM) (see this knowledge base article on VMWare's site: externalid= &sliceid=1&doctypeid=dt_kb_1_1 ESXi VM is a OS and will take over the HW Utility - Processor Check for 64-Bit Compatibility. 100GB free on ESXi server datastore CMS Virtual Machine requires the following resources from the ESXi host server: 4 virtual CPU 4GB RAM 50GB Hard drive (Thick provisioned) 1 NIC CMS VM is Ubuntu LTS server 64-bit Administrator needs to be knowledgeable about using VMWare vsphere Capacity Guidelines Estimated guidelines for larger installations are outlined below. Admin Tip: Testing environment Testing for capacity was conducted on a Vsphere host with an Intel Xeon x5670 processor running at 2.93 GHz. This is a mid-grade host machine. Performance will certainly vary if the administrator loads CMS on a laptop or a less powerful host. Conversely, an administrator might expect slightly better performance from a host with a more robust processor. General guidelines for larger installations: Number of handsets Up to 1000 handsets Between 1000 and 2000 handsets Heartbeat interval No more frequent than every 1 minute. No more frequent than every 2 minutes. February

21 Number of handsets Between 2000 and 3000 handsets, Between 3000 and 4000 handsets More than 5000 handsets Heartbeat interval No more frequent than every 3 minutes. No more frequent than every 4 minutes. No more frequent than every 5 minutes. Caution: Capacity guidelines The R2.4 OVF requires 4 processors and 4GB. This configuration will handle up to 5000 devices based on our testing. Start with 500 devices and test. As you add each 100 devices beyond 500, add 10 seconds to the heartbeat interval up to a 5 minute interval for 5000 devices. Never try to accept more than 250 devices at a time. February

22 Chapter 2: Installing the CMS VM ESXi 5.x Server Installation Overview For assistance on the installation of VM ESXi 5.x, please refer to VMWare installation video: rnalid= Install vsphere to connect & manage your ESXi VM CMS 2.0 Infrastructure Installation Instructions Note These instructions require the reader to be knowledgeable about using VMWare vsphere. See VMWare s website for more information. CMS code is available from Spectralink. 1 Download the CMS zip file from the Spectralink support representative. 2 Unzip VM files onto a machine that can talk to your ESXi host server and that has a compatible version of VMWare vsphere Client installed. 3 Connect to your ESXi host server using vsphere. 4 Select File> Deploy OVF Template from VSphere. 5 Browse to the OVF file inside the unzipped folder from step 2. Select Next. February

23 6 Select Next again. Name the new machine something like "Spectralink CMS". Select Next. February

24 7 Select the resource pool you want to run this VM on. (You may only have one ESXi server to choose from). 8 Select the datastore that you want to deploy this VM onto. You may only have one datastore. Click Next. 9 Select Thick Provision Lazy Zeroed for the disk format. Select Next. 10 Change the Network Mapping to a network that your devices have access to. Select Next. 11 Leave Power on after deployment unchecked. Click Finish. You will see the OVF being deployed to your server. When it is finished, go to the next step. 12 Right-click the new machine in the tree on the left of vsphere and select Power> Power On. 13 Go to the console (in vsphere) for the CMS VM and wait for the login prompt at which you will login as cms2, password=cms2 (You will want to change this at some time later). Caution: Keep track of passwords! If you change the root password and forget what it is, you cannot reset the system and you will need to reinstall from the original VM image. 14 Switch to bash shell (optional but recommended) bash 15 Run the command cd bin 16 Run the command sudo python network_init.py and follow the prompts to configure your network interfaces: DHCP Caution: Dynamic DHCP not supported The IP address must remain static. Use reserved DHCP instead if supported by your system. February

25 address {your static IP address here or DNS which should be a fully qualified domain name} netmask {your static network mask here} gateway {your default gateway here} DNS nameserver 17 Run the command sudo python application_init.py and follow the prompts. address {your static IP address here or DNS which should be a fully qualified domain name that was entered above} Admin Tip: HTTPS and IP addressing When configuring the device to connect to CMS using https, the URL must match what is entered here (IP, short hostname, or fully qualified hostname). i.e. If CMS is at , and the hostname my-cms is entered into this field, only will work for the device's CMS setting. and will not work. DNS or Hostname {your hostname here} Administrator Name {your administrator name here} Administrator {your administrator here} Country Code {your 2 digit country code} State {your 2 digit state code} City {your city} Company {your company name} Organization {your organization} 18 Your CMS should now be initialized. This step installs the certificate. Caution For the CMS update feature to work, a DNS server must be defined in step 19 that can resolve to Internet domain names and the CMS must have access to the Internet. At this point, you can browse to the CMS. Or (e.g.) ========= February

26 Further customization steps (like changing server root login and web interface default admin login) are covered in the relevant configuration guide for the device. Creating your CMS Account and Logging in Caution: CMS is limited to one password CMS permits only one username and password. Only one active user may access CMS at any given time. Attempting multiple users may render CMS inoperable. 1 Enter the IP address that you set up in your CMS in your browser. Only use the Google Chrome browser. Use this format: [IP address or server name]/cms/. If security warnings appear, click the Advanced link and proceed to the CMS page. 2 Create a user account: Caution: Password parameters Passwords must contain: between characters, at least 1 capital letter, at least 1 special character. 3 Log in with your new credentials. Logging in to CMS Once you have set up the CMS server with an IP address username and password, you are ready to use it to manage your Spectralink devices. February

27 Enter the IP address that you set up in your CMS in a Google Chrome browser window. Only use the Google Chrome browser. Use this format: [IP address or server name]/cms/. If security warnings appear, click the Advanced link and proceed to the CMS page. February

28 Part II: Shared CMS Features Your version of CMS supports management and configuration of both Spectralink PIVOT devices and Spectralink 84-Series devices. You can switch between models but several pages are identical for both models. These are described in Part II. About Us: Provides information about the CMS version and the security certificate Licenses: Provides a way to install licenses, including the CMS license on devices. Wireless Profiles: Allows you to configure additional wireless profiles (SSIDs) that can be loaded on the device in your configuration procedures. February

29 Chapter 3: About Us The About Us page gives you information about the CMS version, your unique account key, and the CMS certificate for https security. It also has a button for updating the CMS software. Admin Tip: Updating CMS software For beta deployment, CMS will require a new installation with a completely new version of software. Admin Tip: Where does the CMS certificate come from? The certificate is generated by the application_init.py script during initial configuration of the CMS and can be copied by clicking the Copy to clipboard button. Use the Paste method to paste the full certificate to QNC, a text file or other document. When using HTTPS, the certificate must be pasted into QNC. Updating CMS Installing CMS patches are a three-step procedure. Step 1: In the CMS browser 1 Download the patch from the Spectralink support site. February

30 2 Open CMS and browse to About Us.. 3 Click the Browse file button. 4 Find and select the patch zip file. A progress bar is shown as the file is uploaded. At the end, a validation message lets you know that the upgrade is done. Another message tells you to: Please run the upgrade script on your server, whenever you are ready. 5 Leave the browser open. Step 2: On the host machine You must install or already have installed the vsphere app that enables you to reach the console of the VM hosting the CMS. This step is covered in the initial installation instructions, earlier in this document. 1 Open vsphere and log into the host. 2 Enter the credentials for this CMS and click Login. February

31 3 Expand the IP address to view the virtual machines that are present on the host. For example: 4 Right-click the CMS and select Open Console from the dropdown. 5 Login to the console with the username of cms2 and the password of cms2. February

32 Type cd bin. Type upgrade.sh. The upgrade script issues messages as it is upgrading. No error messages are displayed. Step 3: Verify in the CMS browser 1 Close and reopen the browser to the CMS being upgraded. 2 View the version in the CMS header. It should be the patch version. February

33 What is the Account Key? The account key is used by QNC to authorize your use of CMS with 10 devices. Additional device licenses must be purchased and those licenses are entered in the Licenses chapter. What is the CMS Certificate? Note: Use QNC to install the CMS certificate A certificate cannot easily be installed on the device by typing it in. We recommend using QNC for this purpose Spectralink 84-Series deployments require HTTPS for device-to-cms server authentication. With this type of deployment, the device uses a certificate to authenticate the CMS server. The certificate has two elements the private key that resides on the CMS and the public or server key that must be loaded on every device, usually using QNC. The certificate is generated within the CMS during setup at which point it is available in the About Us page. The public or server certificate is loaded into the device using QNC. When the device gets the CMS address which is prefaced with and the certificate along with the SSID and wireless security settings through QNC configuration, it is able to associate with the wireless LAN and locate the CMS server using the IP address and then authenticates the CMS server using the certificate. The CMS server authenticates the device through the Spectralink device certificate loaded on the device at manufacturing. With both the device and the CMS able to authenticate each other, a secure tunnel is established for information exchange. Spectralink recommends: Learning about Wi-Fi security methods Refer to the relevant configuration guide for the device for additional information about understanding and deploying Wi-Fi security methods. Caution: Certificate expiration The self-signed certificate that is generated by the application_init.py script during initial configuration of the CMS is a 3-year certificate measured from the initial installation of the CMS. A new certificate must be created and pushed to the devices before this 3-year certificate expires. February

34 Chapter 4: Licenses Certain Spectralink products, including CMS, require a license to operate. When you purchase a license, you receive a serial number and a key for each license. Enter this information in the appropriate feature license fields. CMS License For CMS, if you need to approve more than 10 devices in the Device List, you will be required to purchase a license to continue using CMS for additional devices. Contact your support representative for further information. Once you enter the Serial Number and Key, navigate to the Device Holding Area and CMS will now allow you to approve additional devices. They will then display in the Device List. February

35 Chapter 5: Wireless Profiles You will only use the CMS configuration when the device is already associated and you need to change the Wi-Fi profile or add a new one. A device may be required to associate to several SSIDs. One SSID is configured during initial deployment with QNC and one proxy server can be configured as well. Use the Wireless Profiles page to configure additional SSIDs with or without proxy servers. Wireless profiles are added to the device on the Configuration page, Wireless or Wireless / Networking section. Any SSIDs entered here will appear on the Wireless Profiles list on that page. Wireless Profiles can be assigned at the Enterprise, Group or Device level. Wi-Fi profile configuration is usually done on an enterprise-wide level. If required, individual identities must be configured at the device level. Admin Tip: Roaming between SSIDs? The device is not designed to roam between different networks. A different SSID usually means that the device will need a new IP address with different network conditions. The device may need to be rebooted to change SSIDs. Do not expect continuous connectivity. Installing multiple wireless profiles allows the device to associate to a new SSID when the device is turned on at a new site. For a full discussion of various security methods, see the Spectralink White Papers at Settings: Activating a Wi-Fi Profile These instructions are for configuring a Wi-Fi profile. To add it to a device at the enterprise, group or device level, select your device model and navigate to Configuration> Wireless and select the new profile from the list. Wireless Profile Security Wi-Fi security prevents unauthorized over-the-air access to network components and the sensitive data that resides there. For a full discussion of various security methods, see the Spectralink White Papers at February

36 Open Network No security method is deployed when you select Open Network. WEP The WEP option uses a single password for the entire facility which is set in the AP. Spectralink devices use only the first index key which is called either Key 1 or Key 0, depending on the environment. The passphrase can be 10 or 26 hexidecimal characters or up to 63 ASCII characters. Admin Tip Hex characters are 0-9 and a-f. Note Key rotation is not supported. The device will accept either open or shared key. Set up the password in the APs and enter it in CMS. Entry criteria Type Default Unique? Required? Level Notes: Radio button Disabled No Yes for WEP security Enterprise, usually but may be set at any level See above February

37 Also configure: WEP password: Enter 10 or 26 character key in the Password field. (Required) WPA/WPA2 PSK When you configure WPA/WPA2 PSK in the AP, you will determine the encryption algorithm to be used and that determines if you are using WPA (TKIP) or WPA2 (AES). Entry criteria Type Default Unique? Required? Level Notes: Radio button Disabled No Yes for WPA-PSK or WPA2-PSA security Enterprise, usually but may be set at any level See above Also configure: WPA(2)-PSK: Select Passphrase or Hex key. (Required) Passphrase / Hex key: Enter Password field. (Required) The Passphrase is 8-63 characters The Hex Key option is 64 hex characters EAP (WPA2 Enterprise) Set up Three 802.1X EAP options are supported: PEAP, EAP-TLS and EAP-FAST (two methods). Each method uses certificates in slightly different ways. PEAP and EAP-FAST validate user credentials by using the username and password from the RADIUS server. EAP-TLS validates the user through a user/device certificate. Note MSCHAPv2 is supported for PEAP and TLS when enabled on your infrastructure. When using a RADIUS server for 84-Series devices, you will need to configure a fast handoff method in the AP in order to assure audio quality. Spectralink devices use either of two fasthandoff techniques as they roam among APs: CCKM or OKC. CCKM is used exclusively by Cisco APs. OKC is used by most non-cisco APs. Consult the VIEW guide for your AP model for more information. CMS provides a configuration parameter for the Fast Roaming option: February

38 PEAP PEAP requires a username and password. Wi-Fi profile configuration is done on an enterprisewide level and therefore unique passwords and user certificates are not supported for PEAP. All PEAP identities and passwords must be generic. PEAP can use a CA (Certifying Authority) certificate but does not require it. Be aware that not using a certificate for server authentication is much less secure. Also configure: Certificate: From the Certificate Manager. Username: (Required) Password: (Required) EAP-FAST EAP-FAST is used by products of Cisco, its creator, and by a growing number of other WLAN vendors. It uses a PAC file, which is similar to a certificate. The PAC file is provided during configuration (provided) or it is automatically loaded from the network (in-band provisioning). EAP-FAST with inband provisioning EAP-FAST with provided PAC file Also configure: Username: (Required) Password: (Required) EAP-TLS EAP-TLS uses two types of certificates. A CA certificate initially validates the RADIUS server to the device. A user/device certificate validates the device to the RADIUS server. In order to deploy x EAP, you must provision a RADIUS server to provide the username/password security handshake. The RADIUS server maintains the username and password for each device or acquires this information from the LDAP server. The EAP Identity field should be left blank when the device certificate provided with the devices is used. This field will be populated by the MAC address of the device when the configuration is downloaded to the device by CMS. Also configure: EAP Identity Certificate February

39 Caution: Insecure setting Using a generic identity for EAP-TLS is considerably less secure than accepting and using the default MAC address as the identity. EAP-TLS is the most secure Wi- Fi method when device authentication depends upon unique certificates and identities for each device. Managing Wireless Profiles You can delete and edit wireless profiles from the Select actions dropdown. February

40 Part III: PIVOT Configuration Management The PIVOT by Spectralink Configuration Guide is your central reference for all configuration options. Please refer to it for detailed information about each configuration option available to you through CMS. Navigation Once logged in, the banner displays the CMS username with a dropdown for Preferences and Logging out. The navigation pane helps you find the page you need. Banner The right side of the banner displays the user name and a settings icon where you can reset the password, set the number of devices per page and logout. Navigation pane The navigation pane provides intuitive icons to direct you to administrative pages. February

41 Condensed Expanded February

42 Deployment Sequence The following steps form the foundation for the recommended deployment procedure when using CMS. See PIVOT by Spectralink Deployment Guide for additional information. This Sequence assumes that this is a new installation and all the smartphones are physically in the possession of the administrator. 1 Infrastructure. Plan and deploy the infrastructure requirements. See PIVOT by Spectralink Deployment Guide for infrastructure information. Also see the VIEW document for your access points for configuration information. 2 Install the Configuration Management Server. 3 Create the Batch.csv file for bulk configuration of basic smartphone parameters. Bring up the CMS and load the.csv file. 4 In CMS, configure essential Enterprise settings. 5 Check the software version running on the handsets (Settings> About phone> Build number) against the current version offered on the Spectralink Support website ( 6 Conditional: If needed, update PIVOT software. 7 Use QNC to configure smartphones to associate with the wireless LAN. See Quick Network Connect Administration Guide for complete information. Obtain needed information from CMS: You will need to enter the URL of the CMS server. If using HTTPS as your network protocol, you will need to enter the SSL certificate from the CMS server. If you are using CMS 2.0 or above, you will need to enter the account key that CMS generates. 8 Conditional: Install the MDM/EMM client using QNC. 9 Use QNC to download wireless parameters to the smartphones. See Quick Network Connect Administration Guide for complete information. 10 Phones will associate with CMS and display in the Device Holding Area. Navigate to the Device Holding Area and accept the smartphones. Smartphones are now listed in the Device List. 11 Conditional: If you are deploying more than 10 PIVOTs, you will need to purchase a CMS license for each smartphone over the first 10. Contact your service representative for complete information. Once the needed number of licenses are loaded, approve the rest of the smartphones. February

43 12 Once PIVOTs are listed in the Device List, they will download their unique configuration at the next heartbeat. Wait for this to conclude. 13 Test smartphones for basic telephony functionality and correct any problems. 14 Advanced configuration. Once you have determined that the handsets are functioning, you can continue configuration with advanced functionality. You may want to enter Feature Licenses, set up Groups or perform other administrative tasks. 15 Conditional: Configure Install and configure apps on the MDM. a Enroll the handsets on the MDM b Push apps to the handsets c Secure the smartphone appropriately by using a secure launch mechanism d Test smartphones 16 Use manual configuration to finish configuring any parameters that are unavailable in the programs mentioned. 17 Perform a final test of the handsets. 18 Deploy. February

44 Chapter 6: PIVOT Batch Configuration The Batch configuration tool is used by CMS to bulk provision SIP service requirements. Settings loaded through the.csv file will override any enterprise/group level settings. The.csv template is available online at the PIVOT support site. The.csv file is designed to be used when deploying a number of new smartphones in a new installation or when expanding an existing installation. The CSV parser expects the format as presented in the csv file template with the following rules: Field names may not be changed or altered. The Mac address field is mandatory. You can optionally set the Owner info which is the user name that displays at startup. The devices can be associated to existing or new groups by setting a Group name. If an optional field has no value, leave it blank. SIP extension fields must be used or deleted if not used. SIP extension fields must be populated for every smartphone, if used. This applies to both SIP extension number and SIP secondary extension number. If a secondary registration is not being configured, delete the three fields entirely, including the header. Any values supplied in this file will take precedence over values you've already entered in CMS and on the smartphone. These values are set at the Device level. The following settings may be configured. The MAC address and one other field are required, at a minimum. Mac address Owner info Group name SIP extension number SIP username SIP password SIP secondary extension number SIP secondary username SIP secondary password February

45 Example 1 All fields are used. All phones are assigned a SIP and Secondary SIP extension, username and password. Example 2: Only Mac Address and one other field is used: Example 3 SIP fields are not used and are deleted. Example 4 All phones are assigned a SIP extension, username and password. Secondary SIP fields are not used and are deleted. MAC address List the MAC address of each PIVOT you will be deploying. The MAC address may be found on the label in the battery compartment or by going to Settings> About phone> Status after deployment. Entry criteria Type Default Unique? Required? Level Notes: Text field. MAC addresses contain letters and numbers separated by colons. Case insensitive. E.g. 00:90:a3:c6:ef:ab or 00:90:AB:cd:DD:12 none Yes. Every smartphone has a different MAC address Yes Device See above February

46 Owner info The owner info is the name that displays on the lock screen. Entry criteria Type Default Unique? Required? Level Notes: Text field none Not necessarily No Device See above Group name You may assign each smartphone to a Group. By naming a Group here, CMS will create a Group by that name. Entry criteria Type Default Unique? Required? Level Notes: Text field none No No Device See above SIP extension number This is the unique number assigned to each smartphone. The user part of the SIP Address of Record (for example, 1002) or the user and the host part of the registration SIP URI. (for example, 1002@Spectralink.com). This field is required and must be populated in order to achieve successful SIP registration. Admin Tip: Using the secondary SIP fields The secondary fields are for use with Registration 2. They are optional. If not using the secondary fields, delete the secondary columns from the csv file. Entry criteria Type Default Unique? Required? Level Notes: Text field. none Yes. Every smartphone has a different extension. Yes Device See above February

47 SIP username SIP digest authentication User ID to be used for SIP registration. For many call servers this will be the same as the Extension Number, though some call servers offer the ability to have a Username that is unique from the Extension Number. Entry criteria Type Default Unique? Required? Level Notes: Text field. none Yes. Every smartphone has a different SIP username. No Device See above SIP password The SIP digest authentication password to be used for SIP registration. Entry criteria Type Default Unique? Required? Level Notes: Text field none Yes No Device See above Steps for setting up the.csv file 1 In Excel, create a spreadsheet following the guidelines and examples above. 2 Complete the rows per above for each smartphone. 3 Save as a.csv file. 4 Verify in the.csv file that the correct columns are present and properly populated. They will appear as separated by commas in a text editor. Upload.csv to CMS 1 Use Excel to open the.csv file and ensure the format is correct. Save the file as a.csv file to a location where you can easily find it from the CMS. 2 Open CMS and navigate to > Batch configuration. 3 Click Browse Batch Files and browse to and open the.csv file you have created. 4 Click Submit. February

48 5 Once you upload the.csv file to the CMS, when the smartphone first associates with the wireless LAN and finds the CMS, the CMS will identify it by its MAC address and list it in the Device Holding Area where it can be accepted or rejected. Once it is accepted, it will be listed in the Device list and download the configuration options in the.csv file at its next heartbeat. 6 The settings are pushed to smartphones the next time the smartphone heartbeats to the system. This could occur on normal heartbeat interval, when an inactive smartphone becomes active, or when a smartphone boots up. Generate.csv from Legacy CMS You can export your smartphone list from earlier versions of CMS and import it into CMS 2.0 as a.csv file. To generate a.csv file in CMS from a Legacy CMS 1 Export the file from your legacy CMS system. This produces the CMSExport.ZIP file. 2 You may edit this file as needed. 3 In CMS 2.0, click Browse Files, and select the CMSExport.ZIP file. A csv file in the current CMS format is generated. 4 Check over the file to ensure it is accurate, editing as needed. 5 Follow the steps in the Upload.csv to CMS section above, to import the generated.csv file to CMS. February

49 Chapter 7: PIVOT Devices The Device page has two options the Device Holding Area and the Device List. The Device Holding Area lists devices that have associated with CMS but have not yet been approved for inclusion in the Device List. Devices that have been manually configured or configured with QNC appear here. Any device listed here must have the correct Account Key. If you think a device should be listed but it is not, the first thing to check is the account key. On the PIVOT device, navigate to Settings> Admin settings> System> Config management> Account key. It may be incorrect or not entered. A CMS License required for a more than 10 smartphone deployment. If you do not have a license for additional devices, when you approve an additional device, you will see a message to contact your service provider. Approving Devices via Holding Area When PIVOT first finds CMS, it is listed in the Holding area To approve or reject devices 1 Select the PIVOT(s) you want to approve (reject). 2 Select the action in the dropdown Select actions list. 3 Approved devices appear in the Approved list and in the Device list. Rejected devices appear in the Rejected list. February

50 Device List The Device List is a list of all devices that have been Approved by CMS. Once devices appear in the device list, they can be configured/managed with CMS. The displayed columns can be moved by clicking and dragging them. Columns can be hidden or displayed by clicking the Change columns button: February

51 Device List actions Three management actions are provided for remote management of individual devices. Select the device(s) you wish to manage and then click the Select actions dropdown. Click the desired action: Reboot Devices: Remotely reboot a device or devices. You will need to do this when you want to activate an application that requires a reboot of the device after it has been installed. Change config: Typically used when a single device needs unique configuration parameters. This action will open the Configuration page. Apply OTA: Used to apply a software update to one or more smartphones. This action will open the OTA page. February

52 Re-Deploying Devices CMS is designed to be the exclusive configuration method for Admin menu options. If the Restore defaults option has been used on the Admin menu, Spectralink recommends reprovisioning the smartphone per the steps below. Admin Tip: Reconfiguring smartphones This re-deploying technique is a good way to remove Device or Group Settings from a smartphone and reset it to the Enterprise settings. To re-configure a device after restore defaults 1 Go to the Approved list in the Device Holding Area, select the smartphone and use Select actions to move it to the Rejected list. 2 In the Rejected list, use Select action to delete the device. 3 Restore the smartphone to defaults. 4 Get the smartphone back onto the WLAN by using QNC to reconfigure it. The smartphone will associate with CMS and show up in the Pending list. 5 Approve the smartphone. When it is re-approved, it will receive the Enterprise settings. It now shows up in the Device list and can be configured. February

53 Chapter 8: Updating PIVOT Code OTA provisioning allows PIVOT to obtain software updates over-the-air by using CMS as your update server. Software releases are periodically available for the devices. Software releases are available at Updating PIVOT smartphones is a simple process: 1 Download the code from the Spectralink Support website. 2 Load the code into CMS. 3 Open the Device List and select the device(s) to be updated. 4 Click the Apply OTA action from the Select actions dropdown. This opens the OTA Files page. 5 Select the OTA file to apply to the selected smartphone(s). 6 Click OK. Caution: Updating smartphone code CMS and smartphone code are designed to work together. Do not update smartphone code to a code version that does not align with the version of code being used by CMS. Consult the Release Notes that accompany the software for compatible code versions. Caution: Updating smartphones that are more than one revision out of date The directions provided here are for a simple update within the Lollipop code family (R2.1 and above). Please see the Migration Guide Technical Bulletin for details on updating code. Please call Spectralink Support if you have any questions about your particular installation. Upload files Up to three update files can be loaded and stored. Two versions of each release are provided: ota-update.bin All PIVOT Models except 8744 ota-update-camera.bin 8744 (Camera) The green browse button allows you to search for the.bin files you need. You may select one, two or three files to upload. A progress bar indicates upload progress. February

54 Manage files The only management action available from this page is to delete any files that are no longer needed. Updating smartphone code is done through the Device List page. February

55 Updating Legacy Code PIVOT R1.8 (KitKat) and PIVOT R2.0 and R2.1 (Lollipop) contain a CMS Client that allows PIVOT to connect to CMS 2.x. PIVOT R1.7 and previous software versions do not contain this Client and therefore CMS 2.x will not recognize the smartphone. Please see the Migration Guide Technical Bulletin for details on updating code. Please call Spectralink Support if you have any questions about your particular installation. February

56 Chapter 9: PIVOT Groups Being able to group devices and customize configurations for device groups gives you tremendous flexibility in your deployment options. Use the Device Groups page to set up and manage your groups. On this page, you can set up groups, add devices to a group, edit groups and change a group s configuration. Admin Tip: A device can belong to only one group Note that any device can belong to only one group. When a device is added to a group, the Group settings are applied to it, overriding any conflicting Enterprise settings. February

57 Chapter 10: PIVOT Configuration The Configuration pages contain PIVOT configuration settings for successful deployment. Understanding Enterprise, Group and Device Levels There are three ways to get to this page and each different way allows you to configure the smartphone at the three different levels: Enterprise, Group, and Device. Enterprise settings Enterprise level settings are available when you browse directly to the Configuration page, i.e. not going through the Group page or the Device List. The banner displays the Enterprise tab: Enterprise settings are the most generic. They apply to every smartphone. At the enterprise level you would typically set everything except for the device specific SIP settings ext number/username/password. At the enterprise level individual extension settings do not display in the SIP page. Barcode settings are visible and configurable at the Enterprise level but barcode settings will have no effect on devices that are not barcode-enabled. Group settings Group level settings are available when you browse to the Group page, select a Group and select Edit config from the dropdown. The banner displays the Group tab. Group settings override Enterprise settings. They apply only to the smartphones that have been assigned to that group. Typically, group settings are used for barcode groups, security groups, Push-to-talk, SAFE, Web API and Web Apps. They are also used for Feature deployment such as Barcode Scanner. A smartphone can belong to only one group. February

58 Device settings Device level settings are available when you browse to the Device list, select a device or devices and select Change config from the Select actions dropdown. The banner displays the Device tab. Some Device settings are best configured through the batch configuration option. Device settings override both Group and Enterprise settings. They apply only to the specific smartphone(s) that has been selected from the Device List. Therefore, only those settings that pertain to specific smartphones should be configured at the device level. Typically, the only settings that are configured at the device level would be SIP extension settings. When a device is selected in the Device List and the Change config option is chosen, each configured (non-default) setting displays an icon on the right side of the page to indicate the level where the value has been set -- Enterprise, Group or Device. Note that some settings do not support the level icons. Level icons Enterprise: This setting is configured at the Enterprise level. Click the checkbox to clear the setting. Group: This setting is configured at the Group level. Click the checkbox to clear the setting. An Enterprise or Group setting has been cleared; Use the redo button to restore the cleared value. Device: This setting is configured at the Device level. If cleared, the setting will revert to the Group level if it has been set, to the Enterprise level if no Group level exists. If no Enterprise level has been set, it will revert to the default. Example Let s say you want to zero in on a particular smartphone that is behaving strangely. You can set that smartphone to log at an Info level with an appropriate filter while all the other smartphones remain at a Warning level. This gives you a close-up of just one device without the unnecessary syslog traffic that would occur if all devices were set to the Info level. Understanding Default Settings Right out of the box, PIVOT smartphones are preconfigured with default settings. These defaults are designed to be overridden when the smartphone is initially configured to associate with the wireless infrastructure using QNC. Then when batch configuration is used, additional February

59 settings are loaded and additional defaults are overridden. After that, the remaining parameters are configured using the Enterprise/Group/Device levels. A default setting is indicated by DEFAULT next to the parameter like this: Certain settings are set in QNC and do not have an indicated default. IPv6 and n are examples of settings managed by QNC. Extension, Username and Password fields override the default when they are entered through Batch Configuration. Other settings not part of the batch configuration file do not change. Deleting Default Settings When a default setting is deleted, CMS looks to replace it with a setting that is already programmed for that PIVOT. It will first look to see if it should use an Enterprise setting, then for a Group setting and finally for a Device setting. Finding none of these, CMS will allow the field to be blank. February

60 Config Manager The Config Manager page allows you to enable CMS, enter the CMS server URL and set the heartbeat interval. February

61 Wireless / Networking Several options can be set to adjust the wireless network. Wireless profiles A list of wireless profiles is displayed. These profiles are added in Wireless Profiles Configuration. Select one or more profiles in this screen to push to the device(s). IPv6 You may enable IPv6 awareness to improve compatibility with IPv6 aware applications. However, IPv6 wireless networks are still NOT supported, and this setting should be set to off if networking problems are observed. Entry criteria Type Radio buttons February

62 Default Unique? Required? Level Notes: QNC No No. Default will be used if left blank. Enterprise,usually but may be set at any level See above Unsecured wireless networks available notification If enabled, the smartphone will notify users of the availability of unsecured wireless networks if the smartphone is out of range of all known profiles. You may disable this option so these notifications will not occur. Entry criteria Type Default Unique? Required? Level Notes: Radio buttons Enabled No No. Default will be used if left blank. Enterprise, usually but may be set at any level See above n n support can be disabled. It is enabled by default. Entry criteria Type Default Unique? Required? Level Notes: Radio buttons Enabled No No. Default will be used if left blank. Enterprise, usually but may be set at any level See above Wi-Fi frequency band Wi-Fi frequency band options allow you to specify which band(s) you want to use: 2.4GHz, 5GHz or Auto. If Auto is selected, the smartphone scans both bands when it is trying to find the best AP. Wi-Fi frequency band is available under the Advanced option when you tap the overflow icon at the bottom right. Entry criteria Type Default Unique? Dropdown list Auto No February

63 Required? Level Notes: No. Default will be used if left blank. Enterprise, usually but may be set at any level See above Standby roaming threshold Standby roaming threshold an advanced tuning parameter to increase roaming aggressiveness in certain environments. This setting should be left at its default unless advised by Spectralink support personnel. Improper setting of this parameter can negatively impact battery life of the smartphone. Entry criteria Type Slider Default -75 Unique? No Required? No. Default will be used if left blank. Level Enterprise, usually but may be set at any level Notes: See above February

64 Device Security The Device Security settings allow you to implement and control several security functions. Allow user to change lock screen password, Make passwords visible This is an enable/disable option. When turned on, the user can change the type of screen lock. If you enforce screen security by requiring a PIN/Password/Pattern, this option should be off. Entry criteria Type Default Unique? Required? Level Notes: Enable or disable Enabled No No Enterprise, usually but may be set at any level. See above. February

65 Display Owner info on lock screen You may want to display user information on the lock screen so that the smartphone can be identified without being unlocked. Entry criteria Type Default Unique? Required? Level Notes: Enable or disable, text box for owner info if enabled Disabled Can be unique for each device and set by the csv file. May also be set at enterprise or group level No Device, usually but may be set at any level. See above. Allow unknown application sources This is an enable/disable option. Note that Android only considers Google Play Store to be a known source. This option must be enabled if your users will be downloading applications from an in-house applications server. Entry criteria Type Default Unique? Required? Level Notes: Enable or disable Disabled No No Enterprise, usually but may be set at any level. See above. Enable Admin password prompt This is an enable/disable option. The Admin settings area password prompt can be disabled. If disabled, the Admin menu can be accessed freely. In most facilities, this option should be enabled. Entry criteria Type Default Unique? Required? Level Notes: Enable or disable QNC No No. Will use default if left blank Enterprise, usually but may be set at any level. See above. February

66 Lock screen after This allows you to set the delay for locking the screen. Entry criteria Type Default Unique? Required? Level Notes: Dropdown list 5 seconds No If lockscreen is set, this will also be set. If blank, the default will be used. Enterprise, usually but may be set at any level. See above. Owner info Enter the Owner info that should appear on the lock screen. Non Wi-Fi Certificates Provides a list of non-wi-fi certificates that have been loaded on the Manage Certificates page. Entry criteria Type Default Unique? Required? Level Notes: No entry permitted. This is a list of certificates already loaded None No No na See above. Admin password This is where you set a more secure password for the Admin Settings menu in the smartphone than the default of admin to prevent unauthorized changes to the administrative parameters. Entry criteria Type Default Unique? Required? Level Notes: Text field QNC No No. Will use default if left blank Enterprise, usually but may be set at any level. See above. February

67 Emergency Contacts When a smartphone is locked, it cannot be used for calls if there is an emergency need unless emergency contact numbers are configured here. This is a safety feature that many facilities deploy to protect their employees. Up to 5 numbers can be configured. February

68 Warning: Power failure may prevent call functionality The PIVOT smartphone may not function in the event of a power failure as it relies on the greater computer network to transmit calls. You will have a registration failure icon if the smartphone cannot make or receive calls, but there may be a time delay between the system failure and the appearance of the registration failure icon. Contact name, contact number Up to five emergency contacts can be configured with both a name and a number. Ensure you follow any dial plan rules when entering the number. Entry criteria Type Default Unique? Required? Level Notes: Text fields None No No Enterprise, usually but may be set at any level. See above. February

69 General Settings February

70 LDAP Caution: LDAP settings are highly specialized Prior to configuring the settings listed here, ensure you consult with your LDAP administrator and obtain accurate information for populating these settings correctly. You can connect your smartphone to a corporate directory server that supports the Lightweight Directory Access Protocol (LDAP) version 3. Once configured, the corporate directory can be used by the smartphone. Spectralink 87-Series smartphones currently support the following LDAP servers: Microsoft Active Directory 2003 SP2 Open LDAP Directory Server Spectralink smartphones support corporate directories that support server-side sorting and those that do not. For servers that do not support server-side sorting, sorting is performed on the smartphone. Tip: Better performance with server-side sorting Spectralink recommends using corporate directories that have server-side sorting for better performance. Consult your LDAP Administrator when making any configuration changes for the corporate directory. For more information on LDAP attributes, see RFC Lightweight Directory Access Protocol (LDAP): Technical Specification Road Map. Web Info: Supported LDAP directories Configuration of a corporate directory depends on the LDAP server you use. For detailed explanations and examples of all currently supported LDAP directories, see Technical Bulletin 41137: Best Practices When Using Corporate Directory on Spectralink handsets. February

71 LDAP server address The IP address or hostname of the LDAP server interface to the corporate directory. For example, host.domain.com. Entry criteria Type Default Unique? Required? Level Notes: Text fields accepts: dotted-decimal IP address or hostname or FQDN None No Yes Enterprise, usually but may be set at any level. See above. LDAP server port The port that connects to the server if a full URL is not provided. Common LDAP ports are 389 and 636 for encrypted (TLS). February

72 Entry criteria Type Text field. Accepts 0, Null, 1 to Default 389 Unique? Required? Level Notes: No No Enterprise, usually but may be set at any level. See above. Communication security type If you are using encryption, select the type: SSL, None, Start TLS Entry criteria Type Default Unique? Required? Level Notes: Dropdown list None No See above Enterprise, usually but may be set at any level. See above LDAP bind DN Distinguished name for the site. An LDAP representation of the name of your domain. Entry criteria Type Default Unique? Required? Level Notes: Text field None [blank] (leave empty for entire site) No No Enterprise, usually but may be set at any level. See above. LDAP bind PW For open LDAP, a password is used to access the directory. Entry criteria Type Default Unique? Required? Level Notes: Text field None [blank] (leave empty for anonymous) No No Enterprise, usually but may be set at any level. See above. February

73 LDAP base DN Use the same value as the Bind DN. However, if you have a space or other special characters in the Bind DN name use encoded characters here. Entry criteria Type Default Unique? Required? Level Notes: Text field None [blank] (leave empty for entire site) No No Enterprise, usually but may be set at any level. See above. Primary attribute In your implementation of LDAP, what attribute are you using for the primary addresses of your contacts? E.g. mail or msexchxxx. Caution: The mail attribute should be validated against an server The mail attribute may be a text field on the LDAP server and might not contain a valid address. Be sure to verify addresses against an server in order to ensure that valid addresses are being provided to smartphones. Caution: Use attributes that are populated by a single address only Certain LDAP attributes may contain multiple s such as a primary address and a number of alias addresses. Use an attribute that provides only a single address. Entry criteria Type Default Unique? Required? Level Notes: Text field none No Yes if you are using LDAP Enterprise, usually but may be set at any level. See above. Alternate attribute A different field used for addresses. For instance you might have multiple mail servers or some contacts may use some other address. February

74 Entry criteria Type Default Unique? Required? Level Notes: Text field none No Yes if you are using LDAP Enterprise, usually but may be set at any level. See above. Push to talk Please refer to the PIVOT by Spectralink Configuration Guide for PTT settings. Enable settings February

75 Channel settings February

76 SAFE / Panic Please refer to the PIVOT by Spectralink Configuration Guide for SAFE and Panic settings. Admin Tip: Panic tones in a combined environment If you have a combined deployment with both R1.8 and R2.1 or above releases, you must group them separately as CMS cannot send warning or alarm tones to R1.8 smartphones but it can send these tones to R2.1 or above smartphones. Admin Tip: Reboot PIVOT after enabling SAFE and Panic Button The smartphones must be rebooted after SAFE monitoring is turned on and Panic button is enabled. February

77 February

78 SIP Telephony Please refer to the PIVOT by Spectralink Configuration Guide for SIP settings. Enable SIP Enables/disables the Spectralink SIP application used for call routing, dial plan, DTMF, and URL dialing. If enabled, the Spectralink SIP application is used for smartphone calls and other telephony services. Entry criteria Type Default Unique? Required? Level Notes: Checkbox Disable No Yes, for telephony function Enterprise Must be enabled manually at the Enterprise level for facility-wide telephony functioning February

79 Registration 1 and 2 February

80 Server address All smartphones using the same SIP server use the same entry in this field. Two formats are recognized by the smartphone: Format A: domain Accepts: IP address, DNS A-name record using a FQDN, or a DNS SRV record that can be resolved to an IP address. The [domain] value should be resolvable to a server that accepts SIP registrations. Default value: none Registration requests, SIP Invites, and other SIP requests will be composed in the form of [extension]@[domain] and will be delivered to the IP address of [domain], whether obtained through DNS lookup or provided by an IP address. If the SIP server requires requests in the form of Extension@SIP_Domain_Name, and you wish to use this format, then you should create a DNS SRV record with the SIP_Domain_Name pointing to the server s address. Format B: [domain]; [serverspec1] Accepts: domain = SIP Domain Name; serverspec1 = a dotted-decimal IP address, a hostname, or a SRV record that can be resolved to an IP address. Registration requests, SIP Invites, and SIP messages will be sent in the form of [extension]@[domain], and will be delivered to the IP address specified after the semicolon, whether obtained through DNS lookup or provided by an IP address. If the SIP server requires requests in the form of [extension]@[sip_domain_name] and you wish to use this format, you should specify the [SIP_Domain_Name], followed by a semicolon, and then the address, hostname, or SRV record that can be resolved to the address to which you want SIP messages delivered. Entry criteria Type Default Unique? Required? Level Notes: See above for format type None No Yes, for telephony function Enterprise Must be set manually at the Enterprise level for facility-wide telephony functioning Server Port The port value entered here must match the port used in the SIP server to accept connection requests. Entry criteria Type Numeric value. Accepts 0, 1 to Default Leaving this value blank will enter the default value. Unique? No February

81 Required? Level Notes: Yes, for telephony function Enterprise Must be enabled manually at the Enterprise level for facility-wide telephony functioning If utilizing a DNS SRV record, the SIP Server Port should be specified through the SRV record and left blank in this field. If you specify a port number here, then the Spectralink 87-Series smartphone will not attempt to use SRV records at all to discover the SIP Server address and instead will only query for a DNS A record. Transport The network transport protocol. Admin Tip: Which network transport protocol to use? Certain call servers drop calls when coming back into Wi-Fi coverage after walking out of range. This issue only occurs when using TCP for SIP. A potential work around for the issue is to switch to using UDP for SIP. Entry criteria Type Default Unique? Required? Level Notes: Dropdown selectable: UDP, TCP UDP Yes Yes, for telephony functioning. Device Must be set at the Device level for smartphone telephony functioning. Extension Enter the extension number for the device. This entry should be different for each smartphone. This field is required and must be populated in order to achieve successful SIP registration. It is the user part of the SIP Address of Record. Entry criteria Type Default Unique? Required? Level Notes: Text entry. Configurable through.csv. None Yes Yes, for telephony functioning. Device Must be set at the Device level for smartphone telephony functioning. Example If the extension is 1002, the Address of Record would become 1002@Spectralink.com where 1002 is the extension number and Spectralink.com is the server value set above. February

82 Username SIP digest authentication User ID to be used for SIP registration. For many call servers this will be the same as the Extension Number, though some call servers offer the ability to have a Username that is unique from the Extension Number. Entry criteria Type Default Unique? Required? Level Notes: Text entry. Configurable through.csv. None Yes Yes, for telephony functioning. Device Must be set at the Device level for smartphone telephony functioning. Password The SIP digest authentication password to be used for SIP registration. Check the Show Password checkbox to see the entry. Entry criteria Type Default Unique? Required? Level Notes: Text entry. Configurable through.csv. None Yes Yes, for telephony functioning. Device Must be set at the Device level for smartphone telephony functioning. Voic retrieval address The number to dial to retrieve voic messages. Admin Tip Many call servers will send this information in the Message-Account field of the SIP Notify messages to the Spectralink 87-Series smartphone automatically when the smartphone initially registers. Leave this field blank to allow the smartphone to attempt auto-discovery of this parameter using the call server provided message-account field address. If long-pressing the #1 key in the dialer does not initiate a successful call to the voic system, then populate this field with the number to dial to retrieve a voic message (the Voice Mail system s pilot number.). Invites will be sent to: voic _retrieval_address@server February

83 Entry criteria Type Default Unique? Required? Level Notes: Text entry. ASCII encoded string containing digits (the user part of a SIP URL) or a string that constitutes a valid SIP URL (6416 or 6416@spectralink.com) None No Maybe, see Admin Tip Enterprise Must be set manually at the Enterprise level for facility-wide voic functioning. Example 1: if Server is defined as and Voic retrieval address is defined as 6416, Invites to voic will be sent to 6416@ Example 2: If Server is defined as a DNS SRV record that resolves to an IP address (e.g ), and Voic retrieval address is set to 6416@spectralink.com, then Invites to voic will be sent to the IP address with a To: address of 6416@spectralink.com Use SIP standard hold signaling When enabled: Uses SDP media direction parameters (such as a=sendonly) per RFC 3264 when initiating a call. When disabled: Reverts to RFC2543 hold mechanisms (redirects media to when initiating hold) Entry criteria Type Default Unique? Required? Level Notes: Checkbox Enabled No Yes, for telephony function Enterprise Must be enabled manually at the Enterprise level for facility-wide telephony functioning Spectralink recommends: When to disable SIP standard hold signaling Spectralink recommends leaving this setting enabled unless hold / resume is not functioning correctly on the call server you are attempting to interoperate against. Force subscription to message waiting notifications Most call servers will subscribe a smartphone to message waiting indicator (MWI) notifications automatically when they register. Some call servers may require that a smartphone send a separate SIP Subscribe message in order to receive message waiting notifications. Spectralink recommends that customers leave this setting disabled unless the 87-Series smartphone is not receiving message waiting indicators. Enabled: Causes the smartphone to send a separate SIP Subscribe message to the Server address for Message Waiting Notifications February

84 Disabled: The smartphone will not send a separate SIP Subscribe notification to the Server address for message waiting Notifications Entry criteria Type Default Unique? Required? Level Notes: Checkbox Disabled No See above Enterprise See above Allow contact header updates Allows updates of the call control Contact address using the topmost SIP Via. Enabled: Will replace the Contact Header with the received ip address and rport values contained in the Via of the 200 OK response to SIP Registration. PIVOT will then renew the SIP Registration using the updated Contact information, and subsequent Invites and Registration requests will be made using the updated Contact information for call control messaging. Disabled: SIP Message Headers will use the smartphone's local ip address in the Contact field for all call control messaging Entry criteria Type Default Unique? Required? Level Notes: Checkbox Disabled No See above Enterprise See above February

85 Common settings Audio DSCP Specify the DSCP of packets. Entry criteria Type Default Unique? Required? Level Notes Enter either decimal (no leading characters) or hex number (0x) Accepts: 0 to 63 decimal or 0x0 to 0x3F hexadecimal (include the 0x if specifying values using hexadecimal notation) or 0x2e No Yes, for telephony function Enterprise Must be set manually at the Enterprise level for facility-wide telephony functioning Call Control DSCP Specify the DSCP of packets. Caution: Changing Call Control DSCP values requires a smartphone reboot Call Control DSCP values do not take effect until the smartphone reboots or SIP service is restarted. February

86 Entry criteria Type Default Unique? Required? Level Notes Enter either decimal (no leading characters) or hex number (0x) Accepts: 0 to 63 decimal or 0x0 to 0x3F hexadecimal (include the 0x if specifying values using hexadecimal notation) 0x2e No Yes, for telephony functioning. Enterprise Must be set manually at the Enterprise level for facility-wide telephony functioning Audio codec priority Codecs settings are prioritized by assigning a number to each with 1 being the highest. A setting of 0 (zero) means the codec is disabled. Codecs do not have to be set identically for each smartphone. Entry criteria Type Default Unique? Required? Level Notes: Checkbox to select and arrows for re-prioritization G.711u = 1 and G.711a = 2. The other two codecs are disabled by default. No Yes, for telephony function Enterprise Must be enabled manually at the Enterprise level for facility-wide telephony functioning February

87 System Log A syslog server provides valuable logging information about the smartphone s operation. Spectralink recommends: Setting up a syslog server We recommend that you set up a syslog server as part of your initial deployment. Log messages provide a window into the smartphone s operation. These messages can assist you in troubleshooting issues and understanding how the smartphone executes. Spectralink s log structure enables message filtering by severity. Messages may be further filtered on a tag field provided by the software. Syslog settings can be set at a Enterprise, Group, or Device level. Messages are buffered in the smartphone and can be retrieved through a USB download. February

88 Enable syslog Entry criteria Type Default Unique? Required? Level Notes: Checkbox Off No No. Default will be used if left blank. Enterprise, usually but may be set at any level See above Server address IP address of the syslog server February

89 Entry criteria Type Default Unique? Required? Level Notes: Text field None No No Enterprise, usually but may be set at any level See above Transport protocol Selects the method used to transport information. Entry criteria Type Default Unique? Required? Level Notes: Dropdown UDP No Yes, if using a syslog server Enterprise, usually but may be set at any level See above Always write Syslog must be enabled for this setting to be effective. This option is designed for troubleshooting of network connections on specific smartphones. The Always write option refers to whether or not the smartphone should write syslog messages to an internal file (syslog.txt) continuously, whether or not it is connected to Wi-Fi. When enabled, the smartphone will log messages to syslog.txt continuously, even when there is a Wi-Fi connection and the smartphone is also (presumably) sending messages to a Syslog server. When disabled, the smartphone will log messages to the internal file (syslog.txt) only when Wi- Fi is down. When the Wi-Fi connection is re-established, the smartphone will stop logging messages to syslog.txt. The resulting file will show gaps in time due to gaps in Wi-Fi connectivity. The syslog.txt file records any overwriting of older records and time of gaps so that you have a full record of its activities. The syslog.txt file has a 1Mb capacity. When the capacity is reached, the file will be replaced with a new blank one and logging will continue. Entry criteria Type Default Unique? Required? Dropdown Disable No Yes, if using a syslog server. February

90 Level Notes: Enterprise, usually but may be set at any level. See above. Logging level Spectralink s log structure enables message filtering by severity. The logging level setting sets the default logging level. More specific logging that matches filters set in the filter fields will be included in the log. The levels by descending degree of severity are: 1 Verbose filter 2 Debug filter 3 Info filter 4 Warning filter 5 Error filter 6 Fatal filter Entry criteria Type Default Unique? Required? Level Notes: Dropdown Warning No Yes, if using a syslog server. Enterprise, usually but may be set at any level. See above. Logging filters Specific logging criteria can be selected by logging level. Therefore, you can have a less severe default logging level but specify more precise logging info for areas of concern by filtering messages on a tag field provided by the software. See the PIVOT Configuration Guide for information about these tag fields. Entry criteria Type Default Unique? Required? Level Notes: Text field None No No Enterprise, usually but may be set at any level. See above. February

91 Web API Web API allows you to configure the smartphones to integrate with an XML application. Enable API Calls You can control which smartphones use the application by enabling or disabling by individual smartphone, group or enterprise. Entry criteria Type Default Unique? Required? Level Checkbox Disabled No See above Enterprise, usually but may be set at any level. February

92 Notes: See above Web API Format Type XML and JSON are the supported formats. Entry criteria Type Default Unique? Required? Level Notes: Dropdown list XML No See above Enterprise, usually but may be set at any level. See above Polling Username, Polling Password Enter the username that the smartphone requires to authenticate polling. Enter the password that the smartphone requires to authenticate polling. Entry criteria Type Default Unique? Required? Level Notes: Text fields None No No Enterprise, usually but may be set at any level. See above. Polling Respond Method Select the method for sending the requested polling data. Either URL or Requester. If the response method is requester, the response will be sent to the HTTP server running at the address where the request was made. If the response method is URL, you must enter the URL of a valid HTTP server that will get the response. This can be at a different address than the requester. Entry criteria Type Default Unique? Required? Level Notes: Dropdown list Requester No See above Enterprise, usually but may be set at any level. See above February

93 URL to receive polling response The URL to which the smartphone sends call processing state/device/network information. This field appears when the selected Polling Respond Method is URL. Push Username / Push Password These credentials are for the Web API and are needed in order to do any kind of push. Entry criteria Type Default Unique? Required? Level Notes: Text fields None No Yes, for a push Enterprise, usually but may be set at any level. See above. Allow message priority Select the priority desired for messages from the App. Messages pushed that are below this level of priority will not be displayed on the configured smartphones. Entry criteria Type Default Unique? Required? Level Notes: Dropdown list All No See above Enterprise, usually but may be set at any level. See above Push ringtone This setting determines whether or not a ringtone will play when a push message is received. Which ringtone plays is set by the user in the smartphone Settings> Sound & notifications> Phone ringtone. The volume of the push ringtone is set by the user in the smartphone Settings> Sound & notifications> Volumes> Web API volume. Entry criteria Type Default Unique? Required? Level Radio buttons Enabled No No. Default will be used if left blank. Enterprise, usually but may be set at any level February

94 Notes: See above Server root URL The URL of the application server you enter here is combined with the smartphone address and sent to the smartphone s browser. For example, if the application server root URL is and the relative URL is /examples/sample.html, the URL that is sent to the web browser on the smartphone is Can be either HTTP or HTTPS. Entry criteria Type Default Unique? Required? Level Notes: Text field None No Yes Enterprise, usually but may be set at any level. See above. Web API Event URLs The URL to which the smartphone sends notifications of specified events. This offers the ability for the smartphone to send notifications based on various smartphone events such as incoming, Registration, etc. There can be one or more notification events defined, each with a name, URL, and the smartphone events that will cause the event notification to be set. Enter the URL and the Event Label and check the Event type. Use the + (Add) button to repeat for every type of event the App monitors. Note: Changing event URLs If you need to edit an event URL, remove it and re-enter the information with the new URL label or address. February

95 Label Enter a descriptive label. Entry criteria Type Default Unique? Required? Level Notes: Text field None No No Enterprise, usually but may be set at any level. See above. URL Enter the URL for this Event Entry criteria Type Default Unique? Required? Text field None No No February

96 Level Notes: Enterprise, usually but may be set at any level. See above. Settings Check the setting that apply to this event. Entry criteria Type Default Unique? Required? Level Notes: Checkboxes Disabled No Yes Enterprise See above February

97 Web Applications Web API allows you to configure the smartphones to integrate with an XML application. Web applications listed here are Web applications whose shortcuts are displayed in a widget box on one of the home pages of the smartphone. They are opened in the Spectralink Webview browser. Any URL available to the smartphones can be entered. Twelve applications can be configured. Label, URL Enter the Application shortcut label and URL. The label displays in the widget box on the smartphone after the smartphone is rebooted. Entry criteria Type Default Unique? Required? Level Notes: Text fields None No No Enterprise, usually but may be set at any level. See above. February

98 Barcode Scanner The Barcode Scanner is a licensed feature available on the PIVOT:SC 8744 model with a builtin camera. It enables the camera to function as a barcode scanner. On this page, you can enable the camera as a scanner and set the symbologies you will be using. See the PIVOT by Spectralink Barcode Administration Guide for complete information about the options that can be set on this page. Barcode Scanner settings can be configured at a Device or Group level. Enable Camera as a Scanner Entry criteria Type Default Unique? Required? Level Notes: Checkbox Disabled No Yes for barcode scanning Enterprise See above February

99 Symbology Settings The symbologies listed in the lower part of the page have sub-options, indicated by the diagonal arrow. Click the arrow to display the sub-option window and configure the sub-options. February

100 Example of sub-option menu February

101 Quick Barcode Connect See PIVOT by Spectralink QBC Administration Guide for full information on the QBC settings offered here. These setting will be ignored by non-camera smartphones. Encryption Entry criteria Type Default Unique? Required? Level Notes: Radio button Enabled No No Enterprise, usually but may be set at any level See above February

102 Connection timeout Enter a value in seconds to set the time that the application will wait for a resent message from the handset before closing the connection Entry criteria Type Default Unique? Required? Level Notes: Text fields 60 seconds No No Enterprise, usually but may be set at any level. See above. Response timeout Entry criteria Type Default Unique? Required? Level Notes: Text fields 10 seconds No No Enterprise, usually but may be set at any level. See above. Keep-alive timeout Enter a value in seconds to specify the time that the application will wait for a connection message from a handset before closing the connection. Entry criteria Type Default Unique? Required? Level Notes: Text fields 5 seconds No No Enterprise, usually but may be set at any level. See above. Inactivity timeout Entry criteria Type Default Unique? Required? Text fields 300 seconds No No February

103 Level Notes: Enterprise, usually but may be set at any level. See above. Operation Mode Entry criteria Type Default Unique? Required? Level Notes: Dropdown Disabled No Yes if barcode scanning is desired. Enterprise, usually but may be set at any level See above Server Address Entry criteria Type Default Unique? Required? Level Notes: Text fields No No Enterprise, usually but may be set at any level. See above. Server Port Enter the port number used by the Spectralink QBC to monitor incoming connections from your handset. The default port number is Spectralink recommends that you don t change the default port number. Entry criteria Type Text fields Default Unique? No Required? No Level Enterprise, usually but may be set at any level. Notes: See above. Passphrase Entry criteria Type Text fields Default ************************ February

104 Unique? Required? Level Notes: No No Enterprise, usually but may be set at any level. See above. Barcode Ringtone Entry criteria Type Default Unique? Required? Level Notes: Dropdown Barcode High No Yes if barcode scanning is desired. Enterprise, usually but may be set at any level See above February

105 Chapter 11: Add Wireless Profiles to PIVOT A smartphone may be required to associate to several SSIDs. One SSID is configured during initial deployment with QNC and one proxy server can be configured as well. Use the Wireless Profiles page to configure additional SSIDs with or without proxy servers. Wireless profiles are added to the smartphone on the Configuration page, Wireless / Networking section. Any SSIDs entered here will appear on the Wireless Profiles list on that page. Wireless Profiles can be assigned at the Enterprise, Group or Device level. Admin Tip: Roaming between SSIDs? The smartphone is not designed to roam between different networks. A different SSID usually means that the smartphone will need a new IP address with different network conditions. The smartphone may need to be rebooted to change SSIDs. Do not expect continuous connectivity. Installing multiple wireless profiles allows the smartphone to associate to a new SSID when the smartphone is turned on at a new site. Wireless profiles ask for the security type used by the SSID. For a full discussion of the various security methods, see Spectralink 87-Series Wireless Security Implementation Guide. Settings: Activating a Wi-Fi Profile These instructions are for configuring a Wi-Fi profile. To add it to a smartphone at the enterprise, group or device level, navigate to Device Management> Configure Devices> Wireless Profiles and select the new profile from the list. February

106 Open Network No security method is deployed when you select Open Network. WEP The WEP option uses a single password for the entire facility which is set in the AP. The 87-Series smartphones use only the first index key which is called either Key 1 or Key 0, depending on the environment. The passphrase can be 10 or 26 hexidecimal characters or up to 63 ASCII characters. Admin Tip Hex characters are 0-9 and a-f. Note Key rotation is not supported. The smartphone will accept either open or shared key. Set up the password in the APs and enter it in CMS. Entry criteria Type Default Unique? Required? Level Notes: Radio button Disabled No Yes for WEP security Enterprise, usually but may be set at any level See above February

107 Also configure: WEP password: Enter 10 or 26 character key in the Password field. (Required) Proxy enabled: Select None or Manual WPA/WPA2 PSK When you configure WPA/WPA2 PSK in the AP, you will determine the encryption algorithm to be used and that determines if you are using WPA (TKIP) or WPA2 (AES). Entry criteria Type Default Unique? Required? Level Notes: Radio button Disabled No Yes for WPA-PSK or WPA2-PSA security Enterprise, usually but may be set at any level See above Also configure: WPA(2)-PSK: Select Passphrase or Hex key. (Required) Passphrase / Hex key: Enter Password field. (Required) The Passphrase is 8-63 characters The Hex Key option is 64 hex characters Proxy enabled: Select None or Manual EAP (WPA2 Enterprise) Set up Three 802.1X EAP options are supported: PEAP, EAP-TLS and EAP-FAST (two methods). PEAP and EAP-FAST validate user credentials by using the username and password from the RADIUS server. EAP-TLS validates the user through a user/device certificate. Each method uses certificates in slightly different ways. Consult the PIVOT by Spectralink Wi-Fi Security Implementation Guide for additional information about security configurations. February

108 PEAP can use a CA (Certifying Authority) certificate, but it is not required. TLS uses two types of certificates. A CA certificate initially validates the RADIUS server to the smartphone. A user/device certificate validates the smartphone to the RADIUS server. EAP-FAST uses a type of certificate called a PAC (Protected Access Credential). The PAC can be auto-provisioned through QNC or CMS. In order to deploy x EAP, you must provision a RADIUS server to provide the username/password security handshake. The RADIUS server maintains the username and password for each smartphone or acquires this information from the LDAP server. Admin Tip: Fast handoff methods When using a RADIUS server, you will need to configure a fast handoff method in the AP in order to assure audio quality. Spectralink 87-Series smartphones use either of two fast-handoff techniques as they roam among APs: CCKM or OKC. CCKM is used exclusively by Cisco APs. OKC is used by most non-cisco APs. Consult the VIEW guide for your AP model for more information. Note MSCHAPv2 is supported for PEAP and TLS when enabled on your infrastructure. PEAP PEAP requires a username and password but does not require a CA certificate. Be aware that not using a certificate for server authentication is much less secure. You will only use the CMS configuration when the smartphone is already associated and you need to change the Wi-Fi profile or add a new one. Wi-Fi profile configuration is done on an February

109 enterprise-wide level and therefore unique passwords and user certificates are not supported for PEAP. All PEAP identities and passwords must be generic. Also configure: Certificate: From the Certificate Manager. Username: (Required) Password: (Required) Proxy enabled: Select None or Manual EAP-FAST EAP-FAST is used by products of Cisco, its creator, and by a growing number of other WLAN vendors. It uses a PAC file, which is similar to a certificate. You will only use the CMS configuration when the smartphone is already associated and you need to change the Wi-Fi profile or add a new one. Wi-Fi profile configuration is done on an enterprise-wide level and therefore unique passwords and user certificates are not supported. All EAP identities, passwords and CA certificates must be generic. Also configure: Username: (Required) Password: (Required) Proxy enabled: Select None or Manual EAP-TLS You will only use the CMS configuration when the smartphone is already associated and you need to change the Wi-Fi profile or add a new one. Wi-Fi profile configuration is done on an enterprise-wide level and individual EAP identities cannot be configured here. The EAP Identity field should be left blank when the device certificate provided with the smartphones is used. This field will be populated by the MAC address of the smartphone when the configuration is downloaded to the smartphone. Also configure: EAP Identity Certificate Proxy enabled: Select None or Manual February

110 Caution: Insecure setting Using a generic identity for EAP-TLS is considerably less secure than accepting and using the default MAC address as the identity. EAP-TLS is the most secure Wi- Fi method when smartphone authentication depends upon unique certificates and identities for each smartphone. Managing Wireless Profiles You can delete and edit wireless profiles from the Select actions dropdown. February

111 Chapter 12: PIVOT Certificate Manager Only the Spectralink device certificate is provided with the smartphone from the factory. Other certificates must be loaded into the smartphones before they can provide security. Installing generic CA certificates or PAC files Admin Tip: CA Certificates must use the.crt extension Only CA certificates with a.crt extension can be uploaded to CMS. For PEAP, TLS and EAP-FAST, generic CA certificates and PAC files are installed using QNC for the initial setup. After you connect to CMS you can use CMS to install them. Also configure: Username: (Required) Password: (Required) Proxy enabled: Select None or Manual 1 Create a name for the certificate. 2 Select the type of certificate from the dropdown list. 3 Enter the Password for the certificate, if any. 4 Browse to the Certificate file to load it into CMS. 5 Write a descriptive note for the certificate. 6 Click Save February

112 Managing certificates You can delete and edit certificates from the Select actions dropdown. Searching certificates 1 Use the first dropdown to set the search field. 2 The second field can be a partial. As characters are typed, the certs that match will be shown in the certificates list. 3 An empty search string will match everything. February

113 Chapter 13: Replace a PIVOT Device When a smartphone needs to be replaced, you can quickly move the configuration over to a different smartphone through the Quick RMA replacement option. Be advised that the smartphone being replaced will be removed from the CMS Device List when its configuration is moved. Caution: RMA smartphones should be restored to defaults The replaced device will still contain its configuration information on the smartphone itself. It is not wiped. We recommend that you do a restore defaults on the replacement device to keep it from interfering with the new device. If the Restore defaults option has been used on the Admin menu in the device, there is no way to recover previous CMS settings. Use the RMA method to save a configuration on a substitute phone. Admin tip: Which settings are moved? All CMS administrative settings are moved to the smartphone. User settings such as Ring tone, volumes, etc. are stored by the CMS and are also moved. Apps, People, and various customizations that are stored on the smartphone will not be moved to the new smartphone and will have to be re-setup by the administrator and/or user. The Lockscreen pin/password/pattern is not moved to the new smartphone. February

114 February

115 Chapter 14: PIVOT Feature / Device Licenses Certain Spectralink products require a license to operate. When you purchase a license, you receive a serial number and a key for each license. Enter this information in the appropriate feature license fields. CMS license For CMS, if you need to approve more than 10 devices in the Device List, you will be required to purchase a license to continue using CMS. Contact your support representative for further information. Once you enter the Serial Number and Key, Go to the Device Holding Area and CMS will now allow you to approve additional devices. They will then display in the Device List. February

116 Feature license Obtain the Feature License Serial Number and Account Key and enter them in the fields shown above. Feature licenses need to be applied to devices after being entered. Many times, features are configured at a Group level but they can also be configured at a Device level. Determine which is appropriate for your facility. 1 Enter the Serial Number and License Key. Obtain this information for your service representative. 2 Select the license in the Manage Licenses list. 3 Select the Apply Licenses action from the Select actions dropdown. The Apply License page opens and displays eligible devices. Smartphones that already have the license installed are checked. In the example below, only 8744 smartphones are displayed for the Barcode Scanner license. The feature license and the number of available licenses are displayed. Smartphones that are eligible and do not already have the license installed are not checked. 4 Ensure the devices that should receive the license are selected. 5 Click OK. 6 Configure feature. In addition to being applied to a PIVOT device, most features will require some configuration. February

117 7 Conditional: Some licenses require a reboot of the smartphone before it will activate. To reboot specific smartphones, navigate to the Device List, select the licensed devices and select the Reboot action from the Select actions dropdown. Selected smartphones will reboot if possible (powered on, charged, in range, able to heartbeat in, etc.). 8 Test functionality. February

118 Part IV: Spectralink 84-Series Configuration Management The Configuration Management System provides a GUI interface for an administrator to configure and manage Spectralink 84-Series devices. An administrator can see devices in the Device list. Each device provides information as part of its heartbeat and this information enables an administrator to check on vital activity and usage information. The system log setting can further assist the administrator in getting very specific information from any device. An administrator can configure any setting in CMS, most of which are also available on the Admin menu of each handset. In CMS, settings can be configured at the Device, Group or Enterprise level. These settings are picked up by the device when it heartbeats into CMS. Caution: Menu conflicts between CMS and manual settings? CMS is designed to be the exclusive configuration method for Admin menu options. However, if handsets are configured manually through their Admin or User menus, CMS will not know about these changes and any changes manually set in either the User or Admin menus will persist in the 84-Series devices. If the Restore defaults option has been used on the Admin menu, there is no way to recover previous CMS settings. See Re-Deploying Devices for the method to re-deploy the device with CMS. Logging in to CMS Once you have set up the CMS server with an IP address username and password, you are ready to use it to manage your 84-Series phones. Enter the IP address that you set up in your CMS in a Google Chrome browser window. Only use the Google Chrome browser. Use this format: [IP address or server name]/cms/. If security warnings appear, click the Advanced link and proceed to the CMS page. February

119 Navigation Once logged in, the banner displays the CMS username with a dropdown for Preferences and Logging out. The navigation pane helps you find the page you need. Banner The right side of the banner displays the user name and a settings icon where you can reset the password, set the number of devices per page and logout. Header The header displays the title of the page. Navigation pane The navigation pane provides intuitive icons to direct you to administrative pages. It can be expanded by clicking the right arrow. February

120 Condensed Expanded Devices Device holding area Device list Switch to PIVOT Groups Name, manage and assign devices to Groups OTA Files Upload and manage phone software Certificates Configure certificates Configuration Configure Logging, SIP Registration< Web App, Call Features Custom Settings Create and populate custom configuration files Licenses Load licenses, apply to devices Batch Configuration Upload configuration file for configuring many phone with basic settings at one time Wireless Profiles Configure the wireless profiles that can be used on the handsets. Resource File Upload files for CMS application RMA Moving a configuration from one phone to another so the source phone can be sent in for repair. About Us Info about CMS: version, account key, selfsigned public key. Log out Exit the program February

121 Logout Use the logout icon on the Nav bar to exit the CMS program. Switch to PIVOT Switch to PIVOT is the last option in the actions list on the Devices page. Deployment Sequence The following steps form the foundation for the recommended deployment procedure when using CMS. See Spectralink 84-Series Wireless Telephone Deployment Guide using CMS for additional information. This Sequence assumes that this is a new installation and all the handsets are physically in the possession of the administrator. Caution: Use the correct version of CMS! CMS 2.x is designed to work with 84-Series R5.4 and above. Always check the Release Notes to ensure that the code version you are running is compatible with the code version of CMS and vice versa. February

122 Spectralink recommends: Conduct a trial installation Select a few phones for the initial configuration. Once you have verified the desired functionality works on the subset of phones, then deploy the rest using those same settings. 1 The QNC settings produce a wireless connection as shown by bars appearing in the status bar, 2 The phones can be accepted in CMS and the settings from the Batch file appear in the device settings, 3 The phones register with the call server and calls can be made and received, 4 Any advanced features (such as groups or PTT) can be configured and work as expected. Basic Configuration 1 Infrastructure. Plan and deploy the infrastructure requirements. See Spectralink 84- Series Deployment with CMS Guide for infrastructure information. Also see the VIEW document for your access points for configuration information. 2 Use this document to install the Configuration Management Server. 3 Create the Batch.csv file for bulk configuration of basic handset parameters. 4 Bring up the CMS and load the.csv file. 5 Obtain needed information from CMS: The URL of the CMS server. If using HTTPS as your network protocol, you will need to enter the SSL certificate from the CMS server. 6 Use QNC to configure handsets to associate with the wireless LAN. See Quick Network Connect Administration Guide for complete information. 7 Upload the QNC wireless configuration into each phone. Connect each handset to QNC for its initial provisioning. Each handset in turn will download the QNC parameters. 8 Unplug the phone from QNC. It will continue to provision itself. It will find CMS, update its software as needed and park in the CMS holding area. Admin Tip: Do QNC settings persist? When configuring the parameters for wireless connectivity while also using CMS for further configuration, realize that QNC settings will persist unless set otherwise by CMS. February

123 9 In CMS, accept the handsets in the holding area. Handsets are now listed in the Device List. 10 Conditional: If you are deploying more than 10 Spectralink 84xxs, you will need to purchase a CMS license for each phone over the first 10. Contact your service representative for complete information. Once the needed number of licenses are loaded, approve the rest of the handsets. 11 Once Spectralink 84xxs are listed in the Device List, they will download their unique configuration at the next heartbeat. Wait for this to conclude. 12 Verify the settings for each phone in the Device list. Test handsets for basic telephony functionality. Handsets should register with the call server and make and receive phone calls. Correct any problems. Advanced Configuration Once you have determined that the handsets have basic functionality, you can continue to advanced configuration. You will want to complete Enterprise settings in Spectralink 84-Series Configuration and may want to enter Feature Licenses, set up Groups or perform other administrative tasks. 1 Complete Enterprise settings, as needed. 2 (Conditional) Set up any Groups and assign handsets to Groups. A handset can belong to only one Group. 3 Use manual configuration to finish configuring any parameters that are unavailable in the programs mentioned. 4 Perform a final test of the handsets. 5 Deploy. Admin Tip: Testing suggestion When you are ready to test a major deployment, please follow a staged process such as this method for the first 500 devices: 1 Test call functionality, 2 Configure Enterprise settings and test, 3 Configure Group settings and test, (add more devices to Groups as they are deployed), 4 Configure Device settings as needed. 5 Use CMS to configure another 500 devices and repeat. February

124 Chapter 15: Spectralink 84-Series Batch Configuration Admin Tip: Spectralink 84-Series installation support Please see the Spectralink 84-Series Wireless Telephone Deployment Guide using CMS for additional information about batch configuration for the 84-Series handsets. Specific deployment parameters are listed below. Batch configuration is used by CMS to bulk provision SIP service requirements. Settings loaded through the.csv file will override any enterprise/group level settings. The.csv template is available from your Spectralink support representative. The.csv file is designed to be used when deploying a number of new 84xx handsets in a new installation or when expanding an existing installation. The CSV parser expects the format as presented in the csv file template with the following rules: Field names may not be changed or altered. Any values supplied in this file will take precedence over values you've already entered in CMS and on the 84xx handset. These values are set at the Device level. The.csv format is User,Type,Address,Port,Extension,UserID,Password,Display Name,Line Label Caution: All Batch file fields must be populated Do not leave any cells empty in the Batch file. Use every column and populate it for each phone. SIP setup The following settings may be configured when using a SIP telephony server. If using Microsoft Skype for Business, see the next section. All fields are required. Provisioning all these fields gives the most efficient installation and immediate registration when the phone is accepted by CMS. These settings are all for Registration/Line 1. See detailed explanations of each field below the table. Column (field) name Parameter being set Setting function Mac or User The Mac address is the unique identifier of the phone hardware February

125 Column (field) name Parameter being set Setting function Type Sets the telephony protocol to SIP telephony (telephony) or Microsoft Skype for Business (Lync) Address reg.1.server.1.address The SIP server address and port are included in the Batch file so that the phone can register Port reg.1.server.1.port immediately upon being accepted in CMS. Extension reg.1.address The SIP Address of Record. This field is required and must be populated to achieve successful SIP registration. UserID reg.1.auth.userid Authentication credentials are included so that the phone is recognized by the server. Password reg.1.auth.password Display Name reg.1.displayname The display name is the Caller ID that displays for this phone if the PBX does not use its own procedures for this feature. Line Label reg.1.label The text for Line 1 that displays on the screen. Usually a name and extension to identify the phone as belonging to a user. Example User or Mac The field name is User or Mac but at this time only the Mac address is supported. List the Mac address of each Spectralink 84xx you will be deploying. The Mac address may be found on the label in the battery compartment or by navigating to Settings> About phone> Status. Mac addresses contain letters and numbers separated by colons. Entry criteria Type Default Unique? Required? Level Notes: Remove the colons and spaces and dots. Only numbers/letters without spaces, colons or other characters are permitted. none Yes. Every 84xx handset has a different Mac address Yes Device See above February

126 Type Spectralink software is available in two variants Skype for Business and non-skype for Business (or open SIP/Generic). The Type column sets the telephony protocol. Enter telephony if using SIP. See the next section if using Microsoft Skype for Business. Type Default Unique? Required? Level Notes: telephony none No. All phones use the same protocol. For SIP, enter telephony. Yes Device See above Server address The Address column: All devices using the same SIP server use the same entry in this field. Two formats are recognized by the device: Format A: domain Accepts: IP address, DNS A-name record using a FQDN, or a DNS SRV record that can be resolved to an IP address. The [domain] value should be resolvable to a server that accepts SIP registrations. Default value: none Registration requests, SIP Invites, and other SIP requests will be composed in the form of [extension]@[domain] and will be delivered to the IP address of [domain], whether obtained through DNS lookup or provided by an IP address. If the SIP server requires requests in the form of Extension@SIP_Domain_Name, and you wish to use this format, then you should create a DNS SRV record with the SIP_Domain_Name pointing to the server s address. Format B: [domain]; [serverspec1] Accepts: domain = SIP Domain Name; serverspec1 = a dotted-decimal IP address, a hostname, or a SRV record that can be resolved to an IP address. Registration requests, SIP Invites, and SIP messages will be sent in the form of [extension]@[domain], and will be delivered to the IP address specified after the semicolon, whether obtained through DNS lookup or provided by an IP address. If the SIP server requires requests in the form of [extension]@[sip_domain_name] and you wish to use this format, you should specify the [SIP_Domain_Name], followed by a semicolon, and then the address, hostname, or SRV record that can be resolved to the address to which you want SIP messages delivered. Entry criteria Type See above for format type Default None Unique? No. Usually all phones in a system use the same server and port for the same line #. Required? Yes, for telephony function February

127 Level Notes: Enterprise Included in the Batch file for immediate registration once the phone is accepted by CMS. Server Port The port value entered here must match the port used in the SIP server to accept connection requests. If utilizing a DNS SRV record, the SIP Server Port should be specified through the SRV record and left blank in this field. If you specify a port number here, then the device will not attempt to use SRV records at all to discover the SIP Server address and instead will only query for a DNS A record. Entry criteria Type Numeric value. Accepts 0, 1 to Default Leaving this value blank will enter the default value. Unique? No. Usually all phones in a system use the same server and port for the same line #. Required? Yes, for telephony function Level Enterprise Notes: Included in the Batch file for immediate registration once the phone is accepted by CMS. If utilizing a DNS SRV record, the SIP Server Port should be specified through the SRV record and left blank in this field. If you specify a port number here, then the device will not attempt to use SRV records at all to discover the SIP Server address and instead will only query for a DNS A record. Extension The extension column establishes the SIP extension. This is the unique number assigned to each 84xx handset. The user part of the SIP Address of Record (for example, 1002) or the user and the host part of the registration SIP URI. (for example, 1002@Spectralink.com). This field is Entry criteria Type Default Unique? Required? Level Notes: Text field. none Yes. Every 84xx handset has a different extension outside of test environments. Yes Device See above UserID SIP digest authentication User ID to be used for SIP registration. Also referred to as Username. For many call servers, this will be the same as the Extension Number, though some call servers offer the ability to have a Username that is unique from the Extension Number. February

128 Entry criteria Type Default Unique? Required? Level Notes: Text field. none Yes. Every phone has a different SIP username. Yes, for Batch file processing. Device See above Display name The Display Name is the default caller ID shown in the caller ID field of outgoing calls. Many PBXs overwrite this info with proprietary methods for displaying the caller ID. Frequently a phone number is displayed here but a name or other identifier is also used. Entry criteria Type Default Unique? Required? Level Notes: Text field none Not necessarily Yes for Batch processing Device See above Line Label The text label that displays next to the line key for registration 1 and when line 1 is in use. Frequently an abbreviated name and extension number are used here. It is an easy way to identify the phone at a glance. Entry criteria Type Default Unique? Required? Level Notes: Text field none Not necessarily Yes for Batch processing Device See above Steps for setting up the.csv file 1 In Excel, create a spreadsheet following the guidelines and examples above. 2 Complete the rows per above for each handset. 3 Save as a.csv file. 4 Verify in the.csv file that the correct columns are present and properly populated. They will appear as separated by commas in a text editor. February

129 Upload.csv to CMS The Batch file for new phones is designed to be created and uploaded to CMS before the phone(s) are configured through QNC. This way, when the phones are approved and move to the device list, they pick up the Batch file configuration parameters at their first heartbeat. This sequence gives you good predictability for verifying the success of the process. Caution: Batch file upload will overwrite earlier uploads Every time you upload a.csv Batch file to the server, any existing configuration for the same phone will be overwritten. It is not an append process. Spectralink recommends that you create a new.csv file when adding new phones. 1 Use Excel to open the.csv file and ensure the format is correct and it is properly populated. Save the file as a.csv file to a location where you can easily find it from the CMS. 2 Open CMS and navigate to > Batch configuration. 3 Click Browse Batch Files and browse to and open the.csv file you have created. 4 Click Submit. CMS now has the configuration for the Mac addresses that will show up in the Device Holding area when the devices find the CMS after the QNC configuration. 5 Configure the new phones with QNC. 6 Check that the handset is listed in the Device Holding Area in CMS. Accept it into the Device List. 7 The Batch file settings are picked up by 84xx handsets the next time the handset heartbeats into the CMS system. This could occur on normal heartbeat interval, when an inactive handset becomes active, or when a 84xx handset boots up. 8 Verify the settings are in the handset by selecting it on the Device List and selecting Change config and then seeing the correct information is in SIP Registration> Identification. February

130 Chapter 16: Spectralink 84-Series Devices The Device page lists devices in two areas: The Device Holding Area and the Device List. Device Holding Area The Device Holding Area lists devices that have associated with CMS but have not yet been approved for inclusion in the Device List. Devices that have been manually configured or configured with QNC appear here. Any device listed here must have the correct Account Key. If you think a device should be listed but it is not, the first thing to check is whether the correct account key has been loaded. Check the configuration downloaded into the phones through QNC. See next section for instructions. Admin Tip: Device not listed? If your device is not listed, your first step should be to view the configuration file that QNC downloaded to the device. Open QNC and click download Configuration. The standard configuration procedure occurs and you can find the file in your Downloads folder and review it in an.xml editor. The account key is near the beginning of the file. Check it against the account key displayed in CMS in the About Us page. If there is an error, change it in QNC and rerun the download to the phones. Approving Devices via Holding Area Caution: More than 10 phones? A CMS License required for a more than 10 Spectralink 84xx handset deployment. If you do not have a license for additional devices, when you approve an additional device, you will see a message to contact your service provider. When Spectralink 84xx first finds CMS, it is listed in the Holding area February

131 To approve or reject devices 1 Select the Spectralink 84xx(s) you want to approve (reject). 2 Select the action in the dropdown Select actions list. Spectralink recommends: Approve devices in groups of maximum 500 To prevent the infrastructure from being overwhelmed by a large number of phones trying to find the CMS and download parameters at the same time, Spectralink recommends approving devices in groups of 500 or fewer. 3 Approved devices restart and then appear in the Approved list and in the Device list. Rejected devices appear in the Rejected list. Caution: Approving devices after a change in wireless profiles If the wireless profile has been changed on CMS at an enterprise level from the profile configured by QNC, the device being approved will restart but will disconnect from the network as it does not have the correct wireless settings. Simply reboot the device to connect it. February

132 Device List The Device List is a list of all 84xx devices that have been Approved by CMS. Once devices appear in the device list, they can be configured/managed with CMS. Admin Tip: When does the Device List show changed settings? Settings sent to a device are shown in the Device List when the device has received the settings and has sent a heartbeat back to the CMS, indicating that it has successfully received the settings. For a device that is currently powered on and communicating to the CMS, this should occur within two heartbeat intervals. The displayed columns can be moved by clicking and dragging them. Columns can be hidden or displayed by clicking the Change columns button: February

133 Device List actions Management actions are provided for remote management of individual devices. Select the device(s) you wish to manage and then click the Select actions dropdown. Click the desired action: Action Reboot Devices Change Config Apply Custom Config Download Logs Apply OTA Purpose Remotely reboot a device or devices. You will need to do this when you want to activate an application that requires a reboot of the device after it has been installed. Typically used when a single device needs unique configuration parameters. This action will open the Configuration page. Used when a custom config file is applied to a single device. Download log files for Used to apply a software update to one or more handsets. This action will open the OTA page. February

134 Action View Config Purpose Allows you to view and download the configuration currently on the device. Re-Deploying Devices CMS is designed to be the exclusive configuration method for Admin menu options. If the Restore defaults option has been used on the Admin menu, Spectralink recommends reprovisioning the 84xx handset per the steps below. Admin Tip: Reconfiguring 84xx handsets This re-deploying technique is a good way to remove Device or Group Settings from an 84xx handset and reset it to the Enterprise settings. To re-configure a device after restore defaults 1 Go to the Approved list in the Device Holding Area, select the 84xx handset and use Select actions to move it to the Rejected list. 2 In the Rejected list, use Select action to Delete the device. 3 Restore the 84xx handset to defaults 4 Get the 84xx handset back onto the WLAN by using QNC to reconfigure it. The 84xx handset will associate with CMS and show up in the Pending list. 5 Approve the 84xx handset. When it is re-approved, it will receive the Enterprise settings. It now shows up in the Device list and can be configured. February

135 Chapter 17: Spectralink 84-Series Groups Being able to group devices and customize configurations for device groups gives you tremendous flexibility in your deployment options. Use the Groups page to set up and manage your groups. On this page, you can set up groups, add devices to a group, edit groups and change a group s configuration. Admin Tip: A device can belong to only one group Note that any device can belong to only one group. Carefully analyze similarities of usage and structure your Groups so they combine handsets that use features in similar ways rather than by area, job description, or any other grouping plan that may not be sufficiently unique. When a device is added to a group, the Group settings are applied to it, overriding any conflicting Enterprise settings. February

136 Group Name The Group Name uses a field to identify the Group. This name can display on the Device List. Type text Default none Unique? Yes. Each group should have a unique name Required? Yes. Each group must have a name Level Group Notes: See above Associate Devices The Select Devices button opens the Device List allowing you to select the devices you want in the named Group. Type Select by checkbox from Device List Default none Unique? Yes. Each group is unique. A device can belong to only one group. Required? Yes. Each group must have at least one associated device. Level Group February

137 Notes: See above Example of one group with two associated devices selected Manage Groups When the selected devices are saved, the Group appears on the list of groups. The device serial numbers identify the devices in the Group. The User Name is the login username when the Group was created. The actions that can be selected to manage a Group are: Action Delete group(s) Edit group Change Config Apply Custom Config Purpose Used to delete one or more Groups. Change the name of the Group, add or delete associated devices. Opens the Configuration Options pages for editing the settings. Used when a custom config file is applied to a Group such as PTT or SAFE settings.. February

138 Chapter 18: Spectralink 84-Series Configuration The Configuration pages contain the essential Spectralink 84xx configuration settings for successful deployment. Some of these settings can be configured through the Batch Deployment process. Understanding Enterprise, Group and Device Levels There are three ways to open the configuration pages and each different way allows you to view and configure the device at one of the three different levels: Enterprise, Group, and Device. When a field has been configured, a Level icon next to it indicates the value has been set at that level. A next to the field means that the field retains its default value. Enterprise settings Enterprise settings are the most generic. They apply to every device unless overridden by values set by Group or Device levels. Enterprise level settings are configured at the Enterprise level when you browse directly to the Configuration page, i.e. not going through the Group page or the Device List. The Configuration banner displays the Enterprise tab: At the enterprise level you would typically set everything except for the device specific SIP settings such as those listed in the Identification and Authentication sections. Server settings Server Address and Port are set in the Batch file for immediate access to the call server. Transport and Expires settings can be set at the Enterprise level. Message Center values are usually set at the Enterprise level. Group settings Group settings apply only to the specific Group selected from the Group page. February

139 Group level settings can be configured when you browse to the Group page, select a Group and select Edit config from the action dropdown. Configuration opens and the banner displays the Group tab. Group settings override Enterprise settings. They apply only to the handsets that have been assigned to that group. Typically, group settings are used for Feature deployment such as PTT and SAFE. A device can belong to only one group. Device settings Device level settings can be configured when you browse to the Device list, select a device or devices and select Change config from the action dropdown. Configuration opens and the banner displays the Device tab. Several Device settings are configured through the Batch configuration option. Device settings override both Group and Enterprise settings. They apply only to the specific handset(s) that has been selected from the Device List. Therefore, only those settings that pertain to specific handsets should be configured at the device level. Typically, the only settings that are configured at the device level would be SIP extension settings. When a device is selected in the Device List and the Change config action dropdown option is chosen, each configured (non-default) setting displays an icon on the right side of the page to indicate the level where the value has already been set -- Enterprise, Group or Device. Note that some settings do not support the level icons. Level icons Enterprise: This setting is configured at the Enterprise level. Click the checkbox to clear the setting. Group: This setting is configured at the Group level. Click the checkbox to clear the setting. An Enterprise or Group setting has been cleared; Use the redo button to restore the cleared value. The trash can clears the setting. If the setting cleared by clicking the trash can at the Device level, the setting will revert to the Group level if it has been set or to the February

140 Enterprise level if no Group level exists. If no Enterprise level has been set, it will revert to the default. Example: When you might single out a device for special configuration Let s say you want to isolate a particular handset that is behaving strangely. You can set that handset to log at an Info level with an appropriate filter while all the other handsets remain at a Warning level. This gives you a close-up of just one device without the unnecessary syslog traffic that would occur if all devices were set to the Info level. Understanding Default Settings Right out of the box, handsets are preconfigured with default settings. Certain defaults will be overridden when the handset is initially configured to associate with the wireless infrastructure using QNC. Then when Batch configuration is used, additional settings are loaded and additional defaults are overridden. After that, the remaining parameters are configured using the Enterprise/Group/Device levels. A default setting is indicated by DEFAULT next to the parameter. A blank field indicates the parameter is null or not set. February

141 Config Manager The Config Manager is where the heartbeat interval between the device and CMS is set. The CMS heartbeat his is the time interval between check-ins between the handset and the CMS. This interval should be increased as more devices are added. Caution: Change this setting if default has been changed in QNC This setting can be configured in QNC. If the value has been increased in QNC, be sure to also change it here. Use the following scale to determine what interval is best for your installation. Number of handsets Up to 1000 handsets Between 1000 and 2000 handsets Between 2000 and 3000 handsets, Between 3000 and 4000 handsets More than 5000 handsets Heartbeat interval No more frequent than every 1 minute. No more frequent than every 2 minutes. No more frequent than every 3 minutes. No more frequent than every 4 minutes. No more frequent than every 5 minutes. Label Description Parameter Device Heartbeat Interval The time interval between check-ins between the handset and the CMS. device.cms.heartbeat.timeoutseconds February

142 Logging Log messages provide a window into the handset s operation. These messages can assist you in troubleshooting issues and understanding how the handset executes. The handset produces logs which are stored temporarily in the handset. This log is uploaded to the FTP partition of the CMS server every upload period or when the file size limit is reached, whichever comes first. This file is added onto until the append size limit is reached and then the file is erased and the cycle starts over. Syslog settings can be set at the Enterprise, Group, or Device level. Additionally, Spectralink s log structure enables message filtering by severity. Messages may be further filtered through module tag fields provided by the software. Logs can be viewed in several ways: Select the device from the Device List and downloading the log from the action list, Download directly from the handset through the USB port, Navigate to the 8400 partition, log file and view or download the log. Admin Tip: Setting up a syslog server A custom syslog server can be set up by using the Custom Settings option. Global Log settings February

143 Label Description Parameter Timestamp Format Log File Size Upload Period Append Size Limit Hour:Minutes:Seconds:Milliseconds = Year:Month:Day:Hour:Minute = Month:Day:Hour:Minutes:Seconds= Maximum size of flash memory for logs in Kbytes. When this size is about to be exceeded, the handset will upload all logs that have not yet been uploaded, and erase half of the logs on the handset. Time in seconds between log file uploads to the provisioning server. The default is which is 24 hours. Note: The log file will not be uploaded if no new events have been logged since the last upload. Maximum log file size that can be stored on provisioning server in Kbytes. log.render.type log.render.file.size log.render.upload.period log.render.upload.append.sizelimit Module Log Level Limits Use log filter settings to obtain more detailed logging for a specific topic. The Module Log Level Limits page lists commonly-used modules and allows you to set the detail limit for the filter. The default is the lowest level. Setting one or more to a higher level permits you to see the detail you need to accurately diagnose the issue. Label Description Parameter Global Log Level Limit Sets the highest level of detail permitted for any single log level. The most detail is presented at the Debug level, the least detail is presented at the Fatal level. This setting should be configured for the highest level that any single module is set to. log.render.level Severity levels Logging Level Debug -- Produces the most messages. High detail -- Not useful for monitoring except when used with a filter. Moderate detail -- Normal operational messages - may be harvested for reporting, measuring throughput, etc. - no action required Low detail graceful recovery Minor error Indication that an error will occur if action is not taken. Graceful recovery possible if resolved within a given time. Major error Non-urgent failures which could eventually incapacitate the system. Fatal error -- the system has stopped executing correctly and should be corrected immediately. A higher level produces more messages and a lower level produces fewer messages. The levels are cumulative; each level includes all the message types of the levels below them. For example, the Minor detail setting also includes Major and Fatal messages. The lowest February

144 setting Fatal shows only Fatal messages. The highest setting, Debug contains so many messages it will likely crash your system. Use it only with a tag when filtering. Log Modules Use the modules as filters when you are analyzing specific functionality. CMS label Parameter Log Module Application log.level.change.app1 Applicationlogging Browser log.level.change.brow Browserlogging Call List log.level.change.clist Calllistlogging Certificate log.level.change.cert Certificatelogging Config log.level.change.cfg Configuration parsinglog Copy Utils log.level.change.copy Copy utilities, FTP file transferlogging DHCP Client log.level.change.dhcpc DHCP Clientlogging DNS log.level.change.dns DNSlogging February

145 CMS label Parameter Log Module Dot1x log.level.change.dot1x Dot1xlogging EFK log.level.change.efk EFKlogging Handset Polling log.level.change.poll Handset pollinglog HTTP Auth log.level.change.httpa HTTP Authenticationlogging HTTP Server log.level.change.httpd HTTP Serverlogging ICE log.level.change.ice ICE/STUN/TURNlogging Key Observer log.level.change.key Key presslogging LDAP log.level.change.ldap ldaplogging OAI log.level.change.oaip OAIlogging Power Save log.level.change.pwrsv Power Savelogging PPS log.level.change.pps Program processing (dialplan processing)log Push log.level.change.ptt Push-To-Talklogging Push-to-talk log.level.change.push Application pushlogging Real Time Location log.level.change.srtp Secure RTPlogging Secure RTP log.level.change.rtls Real-Timelocation Serviceslogging Security log.level.change.sec Securitylogging SIP log.level.change.sip SIPlogging Support Obj log.level.change.so Support objectslogging TLS log.level.change.tls Transportlayer Securitylogging Utility Main log.level.change.utilm Utility Mainlogging Wapp Mgr log.level.change.wmgr Wireless Managerlogging Web Browser log.level.change.mb Microbrowserlogging Web Ticket log.level.change.tickt Web Ticketlogging WLAN log.level.change.wlan WirelesslANlogging February

146 SIP Registration Base Profile The Base Profile is the protocol selection which is either Skype for Business or OpenSIP. 84- Series software is offered in two versions as indicated by the final four digits of the version number. For example, the complete version format for the 5.x.x GA (generally available) release is 5.x.x.xyyy. The xyyy denotes the build ID. For Lync releases the x is set to 1. For non-lync (SIP) releases, the x is set to 2. For example: Lync: SIP: The Base Profile is set in the Batch file. When using the Batch file, the Type column sets the protocol. Use telephony for OpenSIP. Use Lync for Skype for Business. If not using a Batch file, this parameter must be set at the Enterprise level. Skype for Business (not available in R2.4) Formerly known as Microsoft Lync, the Skype for Business checkbox must be checked if you are using the Lync software. Checking the Skype for Business box sets the Base Profile to Lync. Some options in the below fields change when the SfB protocol is deployed. When using a Microsoft Lync/Skype for Business server, refer to Spectralink 84-Series Wireless Telephone: Microsoft Skype for Business Interoperability Guide. Admin Tip: Microsoft server reference If using Microsoft Lync or Skype for Business, please refer to Spectralink 84-Series Wireless Telephone: Microsoft Skype for Business Interoperability Guide. Open SIP The Session Initiation Protocol (SIP) is the Internet Engineering Task Force (IETF) standard for multimedia communications over IP. It is the default protocol for the Spectralink 84-Series handsets. Selecting OpenSIP sets the Base Profile to Generic. February

147 Label Description Parameter Base Profile Audip DSCP Call Control DSCP Sets the protocol for the handsets software. Use telephony for OpenSIP. Use Lync for Skype for Business. Specify the DSCP of packets. Permitted values are: Null, 0 to 63+ Specify the DSCP of packets. Permitted values are: Null, 0 to 63 or EF or any of AF11,AF12, AF13,AF21, AF22,AF23, AF31,AF32, AF33,AF41, AF42,AF43 device.baseprofile qos.ip.rtp.dscp qos.ip.callcontrol.dscp Lines The SIP server accepts and manages the registrations for the phones. Each registration can optionally be associated with a private array of servers for completely segregated signaling. The Spectralink handsets support six registrations. For the 84-Series phones, registration is synonymous with line. One line is typically used for telephony call system and a second line can be configured for a paging-type call system or some other application that is hosted on a separate server. When using a Microsoft Lync/Skype for Business server, refer to Spectralink 84-Series Wireless Telephone: Microsoft Skype for Business Interoperability Guide. Identification Identification options establish the end user s identity. Identification options must be configured at a device level. Usually this is done through Batch configuration. Admin Tip: Device level settings Device level settings are available when you browse to the Device list, select a device or devices and select Change config from the Select actions dropdown. The banner displays the Device tab. February

148 Batch file field What it does Parameter Display Name Default Caller ID reg.x.displayname Extension Label Authentication The UserID extension number (called Address in the CMS UI) The text label that displays next to the line key for registration x and on the Home screen when that line is in use. reg.x.address reg.x.label SIP uses a User ID and Password for user authentication. These credentials are used by the call server. For line 1, these fields are usually configured through Batch configuration. Batch file field What it does Parameter User ID Password User ID to be used for authentication challenges for this registration. The password to be used for authentication challenges for this registration. reg.x.auth.userid reg.x.auth.password Message Center If you wish to configure voic , configure the Message Center settings. These settings are generally made at an Enterprise level. February

149 Label What it does Parameter One Touch VM Subscription Address Callback Contact Callback Mode If set to 1, the voic summary display is bypassed and voic is dialed directly (if subscription address is configured). The number the handset calls to subscribe to for messages. E.g or The contact to call when retrieving messages if callback mode is set to contact. E.g or contact, registration, disabled contact a call is placed to the contact specified by the entry in the Callback Contact field above registration the registration places a call to itself (the handset calls itself). disabled message retrieval and message notification are disabled. up.onetouchvoic msg.mwi.x.subscribe msg.mwi.x.callback msg.mwi.x.callbackmode Server Settings Each registration can optionally be associated with a private array of servers for completely segregated signaling. The Spectralink handsets support six registrations. Server settings set the network information for the server that serves the line or registration tab shown above. The SIP server address and port are specified in the Batch file so that the handset can register to line 1 immediately upon receiving its configuration from CMS. Batch file field What it does Parameter Address The IP address or host name of a SIP server that accepts registrations. reg.x.server.y.address Port The port of the SIP server that specifies registrations. reg.x.server.y.port February

150 Enterprise settings Transport Expires The transport method the handset uses to communicate with the SIP server. Null or DNSnaptr if reg.x.server.y.address is a hostname and reg.x.server.y.port is 0 or Null, do NAPTR then SRV look-ups to try to discover the transport, ports and servers, as per RFC If reg.x.server.y.address is an IP address, or a port is given, then UDP is used. UDPOnly only UDP will be used. TCPOnly only TCP will be used. TCPpreferred TCP is the preferred transport; UDP is used if TCP fails. TLS if TLS fails, transport fails. Leave port field empty (will default to 5061) or set to The handset s requested registration period in seconds. Note: The period negotiated with the server may be different. The handset will attempt to re-register at the beginning of the overlap period. For example, if expires= 300 and overlap= 5, the handset will re-register after 295 seconds (300 5). The overlap period is overruled by reg.x.server.y.expires values. reg.x.server.y.transport reg.x.server.y.expires February

151 Web App APP URL(s) Web applications listed here are Web applications whose shortcuts are displayed in a widget box. They are opened in the Spectralink Webview browser. Any URL available to the handset can be entered. Twelve applications can be configured. Group or Enterprise settings Application URL (x) The URL of an application apps.x.url Application Name (x) The descriptive text that displays in the Applications menu apps.x.label Web Browser The Web Browser settings control the home page, proxy and timeout to be used by the browser when it is selected to provide services for a specific application. Group or Enterprise settings Home URL The URL of the browser's Home page. For example: If blank, mb.main.home February

152 Group or Enterprise settings the browser will notify the user that a blank home-page was used. Browser Proxy Main Browser Page Timeout (seconds) The address of the HTTP proxy to be used by the browser. If blank, normal unproxied HTTP is used by the browser. The timeout, in seconds, for the interactive browser. If the interactive browser remains idle for the defined period of time, the handset returns to idle. If 0, there is no timeout. mb.proxy mb.main.idletimeout Phone State Polling Phone State Polling is used to control state polling events. Group or Enterprise settings Response Mode Poll URL User Name Password The mode of sending requested polled data. If Poll URL, requested polled data is sent to a configured URL. If Requester, the data is sent in the HTTP response. The URL to which the phone sends call processing state/device/network information. The protocol used can be either HTTP or HTTPS. Note: To enable state polling, the parameters apps.statepolling.url, apps.statepolling.username, and apps.statepolling.password must be set to non-null values. Enter the user name that the phone requires to authenticate phone state polling. Enter the password that the phone requires to authenticate phone state polling. apps.statepolling.responsemode apps.statepolling.url apps.statepolling.username apps.statepolling.password February

153 Push Request Push Request fields are used to control push server controls. Settings: Enabling Data URL Push Both apps.push.username and apps.push.password must be set for Data URL Push to be enabled. Group or Enterprise settings Push Message Type Application Server Root URL Username Choose a priority level for push messages from the application server to the phone. 0: (None) Discard push messages 1: (Normal) Allows only normal push messages 2: (Important) Allows only important push messages 3: (High) Allows only priority push messages 4: (Critical) Allows only critical push messages 5: (All) Allows all push messages See Caution: Critical message conflict note after this table. The URL of the application server you enter here is combined with the phone address and sent to the phone s browser. For example, if the application server root URL is and the relative URL is /examples/sample.html, the URL that is sent to the web browser is Can be either HTTP or HTTPS. The user name to access the push server URL. Used with the password to respond to the HTTP Digest Challenge from the handset. Note: To enable the push functionality, the parameters apps.push.username and apps.push.password must be set (not null). apps.push.messagetype apps.push.serverrooturl apps.push.username February

154 Group or Enterprise settings Password In Call Volume Scaling The password to access the push server URL. Used with the username to respond to the HTTP Digest Challenge from the handset. This parameter allows the administrator to attenuate the volume level of alert tones played in-ear when a user is in the call. Some alert tones may be perceived by users as being loud and this parameter allows an administrator to apply volume reduction to all tones played by the API when in call. If 0, the volume of the push alert is the same as the call volume. Settings of -10, -20 and -36 get progressively quieter. apps.push.password apps.push.play.incall.volume. scaling Caution: Critical message conflict Any new critical message overlays the previous one, but when 2 critical messages come to the phone too close together and both require the phone to retrieve files, the retrieval of the first file can be cut short by the retrieval of the second. This will cause the first file to not be processed properly or not at all. For instance, if the first critical message causes the phone to retrieve an html file with javascript in it to write text on the phone's display and the second critical message causes the phone to retrieve a wav file to play a tune, the user may not see the display on the phone but will just hear the tune. February

155 Telephony Notification Label Description Parameter Heartbeat timeout Line Registration Application URLs Application URLs Outgoing Call Event 0 65,535 Implements a "heartbeat" timer for telephony notifications that repeats the line registration notification on a periodic basis. With a heartbeat set, if the phone goes out of range or is power cycled, notifications are not disrupted. The default value for this parameter is 0, where the timer does not start at all, so there is no change to the behavior unless this parameter is set to a non-zero value. If 0, line registration notification is disabled. If 1, notification is enabled. The first URL to which the phone sends notifications of specified events. Can be either HTTP or HTTPS. A subsequent URL to which the phone sends notifications of specified events, where x = 1 to 3. Can be either HTTP or HTTPS. The Outgoing Call Event can be used by an application to detect that the user of the phone is busy in a call. apps.telnotification.heartbeat TimeoutSeconds apps.telnotification.lineregist rationevent apps.telnotification.url apps.telnotification.x.url apps.telnotification.outgoing Event February

156 Label Description Parameter OnHook Event In Charger Event Network Up Event User Login/Logout Incoming Call Event Alarm Event Offhook Event Out Charger Event Uninitialization Event The Onhook Event notifies an application that the user has ended a call. This can be used for call logging information, for example. InCharger and OutCharger events control what alerts are sent to the device when in/out of the charger If 0, network up notification is disabled. If 1, notification is enabled. If 0, user login/logout notification is disabled. If 1, notification is enabled. If 0, incoming call notification is disabled. If 1, notification is enabled. The Alarm event notifies an application that a (personal security) alarm condition has been detected or cleared on the phone. If 0, off-hook notification is disabled. If 1, notification is enabled. InCharger and OutCharger events control what alerts are sent to the device when in/out of the charger If 0, line unregisteration notification is disabled. If 1, notification is enabled. apps.telnotification.onhookev ent apps.telnotification.incharger Event apps.telnotification.networku pevent apps.telnotification.userlogin OutEvent apps.telnotification.incoming Event apps.telnotification.alarmeve nt apps.telnotification.offhookev ent apps.telnotification.outcharg erevent apps.telnotification.uninitializ ationevent Open Application Interface The Spectralink handsets support communications using the Open Application Interface (OAI). Label Description Parameter IP Address The address of the OAI server. oai.gateway.address User ID The lower four bytes of the six-byte OAI handset identifier in the OAI gateway. If the value is null or invalid, the handset identifies itself to the OAI gateway using the Mac address of the handset; otherwise, the upper two bytes are zero and the lower four bytes are as specified. oai.userid February

157 Label Description Parameter Key Repeat Acceleration The default is enabled, which is the usual behavior where the key repeat accelerates to one keypress every 50ms. To prevent excessive messaging when the key is held down, set the parameter to 0 which reduces the key repeat rate to 500ms. This parameter only affects OAI calls. oai.keyrepeatacceleration. enabled February

158 Call Features CMS provides you with fields to enable a few popular call features. For features not listed here, see Custom Settings. Call Handling Label Description Parameter Prefer Blind Transfer If Blind is checked, the default softkey will be for blind transfer. If Consultative is checked, the default softkey will be for consultative transfer. The other method is always available on the Features softkey menu when the handset is in call. call.transfer.blindpreferred Phone Lock The Phone Lock feature allows you to add an option to the Features softkey menu to lock the handset and require a password to unlock it. Label Description Parameter Phone Lock Enable Enable DND Use this field to enable Phone Lock. If disabled, the handset can receive calls while it is locked. If enabled, the handset enters DND mode while it is locked. The user can enable DND even if it is disabled here. This will cause the handset to demonstrate the behavior described in the below table until the user disables DND. phonelock.enabled phonelock.dndwhenlocked Idle Timeout 0 to phonelock.idletimeout February

159 Label Description Parameter The amount of time (in seconds) the handset can be idle before it automatically locks. If 0, automatic locking is disabled. Admin Password Controls access to the Admin menu. This parameter is also set in QNC. device.auth.localadminpassword Tones When a custom tone is needed, it is uploaded as a.wav file in the Resource File option. In Tones the custom tone is mapped to a Ring type or Alert type slot. Slots make programmed tones available in a dropdown selection list either on the Notification Profiles menus in the handset or in Personal Alarms Alarms and Warnings (for alerts and warnings only). Ring Type Mapper The Ring Type Mapper provides access to custom ring tones that have been uploaded through Resource Files. These ring types are commonly provided to end users for unique facility purposes. They appear on the handset s Settings> Basic Settings> Notification Profiles> Ringing menu and can be changed by the user. Saf slots 1-10 are used for custom ring types that are labeled Custom 1 through Custom 10 on the handset menu until they are populated with a custom.wav file at which time the filename is displayed. Saf 1 is reserved for a custom welcome tone at Custom 1. SAF # Sampled Audio File Number 1 (Welcome tone) Ring tone Menu slot # Alert Type Mapper The Alert Type Mapper provides access to custom alert tones that have been uploaded through Resource Files. They are commonly provided to end users for specific alerts, such as SAFE February

160 warnings and alarms, only programmable in CMS. They also appear on the handset s Settings> Basic Settings> Notification Profiles> Alerts menu. Alerts can be set for Personal Alarms in Configuration under Personal Alarms> Alarms and Warnings page and if specified in CMS cannot be changed by the user. Saf slots are used for custom alert types. They are labeled Custom 1 through Custom 10 on the device Alerts menus. After they are loaded here on this Resource files page, they can be mapped to alerts for the four notification profiles on the CMS Configuration> Personal Alarms> Alerts and Warnings page. SAF # Sampled Audio File Number Alert tone Menu slot # Personal Alarms Workers can be at risk during security breaches or if personal incidents require immediate attention. Spectralink 8441 and 8453 handsets offer personal monitoring and duress call functionality, including man down alarms, running alarms and duress calls to an emergency number. Coupled with a security alarm application program, real time location information from the alarming handset can be displayed on security monitors and sent to other Spectralink devices for mobile response. The existing functionality of Location Services allows an alarming handset s location to be pinpointed so that aid can be directed to the exact scene. When February

161 deployed in conjunction with a security alarm application, Spectralink Personal Alarms provide unparalleled support for isolated workers or other at-risk personnel in potentially threatening situations. Duress call alarms can also be deployed within the functionality of the 8440 and 8452 models. The emergency dial feature can be programmed to sound a local alarm through the built-in speakerphone when an emergency call is dialed. Coupled with a security alarm application, this duress alarm can be used to identify the handset, the user and the location of the alarming handset. Warning The reliability of the Spectralink Personal Alarms application depends on the functionality and reliability of the greater infrastructure the wireless LAN, the LAN, the call server, the central provisioning server, the server hosting location services, the central security system and its servers, the correct configuration of the Spectralink 84-Series handsets, correct installation and central provisioning server(s), and thorough training of personnel. Motion events The accelerometer in the 8441 and 8453 is used to detect movement that might indicate a condition that requires an alert. The conditions are Running, Tilt and Still. The sensitivity can be set appropriately to prevent false alarms while also providing effective protection. Running the handset detects shaking in case a user runs for a configurable number of seconds, Tilt the handset is tilted (not vertical) for a configurable number of seconds (aka man down ), Still the handset remains unmoved for a configurable number of seconds, potentially indicating the user is no longer moving. February

162 Note that personal Alarms can be disabled by setting the sensitivity for all motion events to zero. Emergency Dial is configured on the Duress Settings tab. Label Description Parameter Still Sensitivity Still Timeout Tilt Sensitivity 0 disable, 1 least sensitive, 7 most sensitive As the sensitivity increases the handset must be more stationary to trigger a no movement alarm. The specific sensitivity setting appropriate for a given application is site/user specific. The still condition must persist for this amount of time before a warning occurs. Indicates the degree of tilt from horizontal that triggers an alarm. This setting is modified by the timeout setting that determines the amount of time the position (or lower) is maintained before an alarm is triggered. In the most sensitive position setting 7, a slightly leaning position will trigger the alarm. up.personalalarm.still.sensitivity up.personalalarm.still.timeout up.personalalarm.tilt.sensitivity February

163 Label Description Parameter In the least sensitive position setting, the body must be nearly horizontal before an alarm triggers. Experiment with these settings until you find the right sensitivity for your facility. Horizontal movement can interfere with the handset's ability to sense the tilt condition. If the tilt alarm is the only motion alarm configured, we recommend using a relatively high sensitivity setting. Tilt Timeout Running Sensitivity Running Timeout Suspend Monitoring Motion Alarm Triggers Emergency Call Emergency call activates speakerphone The tilt condition must persist for this amount of time before a warning occurs. As the sensitivity increases the handset requires less movement to trigger a running alarm. The specific sensitivity setting appropriate for a given application is site/user specific. The running condition must persist for this amount of time before a warning occurs. If 0, no suspension of monitoring is allowed, otherwise duration in seconds of the amount of time during which motion event monitoring is disabled. This parameter requires correct configuration of the Emergency Dial feature as detailed in the Spectralink 84-Series Administration Guide. This parameter is disabled by default. If enabled, an emergency call is automatically placed when a running/tilt/still alarm occurs. If disabled, and a running/tilt/still alarm occurs the emergency call will NOT be placed but the alarm state will be activated. Either way, the handset will transition into the alarm state and will generate an XML alarm notification if apps.telnotification.alarmevent is also enabled. Allows you to force the speakerphone on an emergency call. If enabled, the speakerphone is activated on an emergency. If not enabled, normal audio rules apply. up.personalalarm.tilt.timeout up.personalalarm.running.sensitivity up.personalalarm.running.timeout up.personalalarm.suspendmonitoring up.personalalarm.emergencydialena ble up.personalalarm.emerdialforcespe akerphone Alarms and Warnings The Spectralink handsets support four profiles for notification alerts: Normal, Silent, Meeting, and Custom1. You can customize each profile with unique tones for alarms and warnings for Personal Alarms. If a consistent tone is desired during the warning or alarm period, no matter the profile, the same tone must be set for each profile. Although a user can set a different tone on the device, CMS will override any setting done locally by the user. The handset has several tones available by default. Custom tones can be uploaded through the Resource File option. Custom tones are then mapped to a slot in the handset s menus by using the Tones option. Once mapped, available tones can be selected for each profile. February

164 Label Description Parameter Alarm Notification Warning Timeout Location Transmit Interval Enables or disables local alarm notification (tone, vibrate, LED flash) on motion event detection in both warning and alarm states. This is the number of seconds a user has to disable the warning on the handset before the warning automatically triggers an alarm. Used in conjunction with Location Services server and the wifi.rtls.ekahau.txinterval parameter to control the interval with more precision. Generally, to enforce a shorter interval during an alarm state. RTLS must be enabled. Once the alarm is cleared, the txinterval setting will revert to its former value. up.personalalarm.notificationenable up.personalalarm.warningtimeout wifi.rtls.ekahau.txintervalseconds Alarm tone pattern Label Description Parameter Tone Use the dropdown list to select the tone. np.xxx.alert.personalalarm.tonepattern Vibration Check the vibration box. np.xxx.alert.personalalarm.vibration Warning tone pattern Label Description Parameter Tone Use the dropdown list to select the tone. np.xxx.alert.personalwarning.tonepattern Vibration Check the vibration box. np.xxx.alert.personalwarning.vibration February

165 Duress Settings The PTT talk button can be repurposed to emergency dial functionality as detailed next in the Emergency Dial section. An emergency call can be placed automatically when a running/tilt/still alarm occurs. February

166 Duress call alarms can also be deployed within the functionality of the 8440 and 8452 models. The emergency dial feature can be programmed to sound a local alarm through the built-in speakerphone when an emergency call is dialed. Coupled with a security alarm application, this duress alarm can be used to identify the handset, the user and the location of the alarming handset. Label Description Parameter Double Key Press Long Key Press Long Key Press Duration Notification of Duress Call If enabled, an emergency call is automatically placed when a running/tilt/still alarm occurs. If disabled, and a running/tilt/still alarm occurs the emergency call will NOT be placed but the alarm state will be activated. Either way, the handset will transition into the alarm state and will generate an XML alarm notification if apps.telnotification.alarmevent is enabled. This parameter enables the long press method of activating the Emergency Dial function. It is disabled by default. When set (1), it overrides the default double press method (0). If the long press method of activating the Emergency Dial function is enabled, this parameter sets the length of time in seconds that the key must be pressed for a call to be initiated. If enabled, a local alarm notification (tone,vibrate,led flash) will occur on manual duress button press (a duress or emergency dial call). up.personalalarm.emergencydialenable ptt.emergencydial.longkeypressenable ptt.emergencydial.longkeypressduration ptt.emergencydial.notificationenable February

167 Emergency Dial Emergency dial, is enabled by programming the PTT key on the left side of the handset to function as a speed dial button programmed to call an emergency number. The Emergency Dial feature will allow the user to place the emergency call without having to unlock the keypad or unlock the handset. When the button is pressed twice within two seconds, a call is placed to the programmed number. A pop-up window on the display will inform the user that this mode is being activated. If you enable Emergency Dial, PTT cannot be deployed. If both are enabled, Emergency Dial will overrule and PTT will not work. The Emergency Dial feature places the call on Line 1. Therefore the PBX that line 1 is assigned to must be able to place a local emergency call. Any active call on line 1 will be preempted by the emergency call. This method uses a simple dial mode number. In order to make a complex call that uses a macro as a dial string, see Custom Settings. Label Description Parameter Emergency Dial Description Emergency Call Number This label appears in the To: line when the call is placed. Enter the number to be dialed. ptt.emergencydial.description ptt.emergencydial.number February

168 Label Description Parameter Enable PTT Map PTT to Emergency Dial Enables PTT. Disable PTT when using Emergency Dial. When enabled, turns the PTT Talk button into a speed dial emergency call button. ptt.pttmode.enable key.20.function.prim="speeddial" ptt.pttmode.enable="0" Enhanced Feature Keys Enhanced Feature Keys are customized line keys that display when the Features softkey is pressed. When selected, they activate star code sequences (like *69) through a macro configured in this section. You can define as many EFKs as you have available lines in the Features menu. Label Description Parameter Enhanced Feature Keys For each EFK Enables EFKs feature.enhancedfeaturekeys.enabled Enable Enables/Disables the EFK softkey.x.enable EFK Label A text string to define the key. efk.efklist.x.label Macro Action Enter a valid macro action. efk.efklist.x.action.string Display EFK in Checked State(s) Active Display in the active call state softkey.x.use.active Alerting Display in the alerting state softkey.x.use.alerting Dial Tone Display in the dial tone state softkey.x.use.dialtone Hold Display in the hold state softkey.x.use.hold Idle Display in the idle state softkey.x.use.idle Proceeding Display in the proceeding state softkey.x.use.proceeding Setup Display in the setup state softkey.x.use.setup Push to Talk The Push-to-talk (PTT) feature is a collaborative tool that enables users to exchange radio broadcasts to other users subscribed to a PTT channel. In PTT mode, the handset behaves like a walkie-talkie; users can broadcast audio to a PTT channel and recipients subscribed to that February

169 channel can respond to your message. PTT broadcasts can be transmitted using the handset, headset, or speakerphone. They can be rejected, placed on hold and ended at any time. PTT broadcasts can be received on the speakerphone, handset, and headset. Administrators must enable PTT before users can subscribe to a PTT channel. PTT has 25 channels you can enable. General Settings Label Description Parameter Enable PTT If PTT is disabled, the other options will not appear. ptt.pttmode.enable PTT Display Name Multicast Address Codec Compatibility Mode This display name is shown in the caller ID field of outgoing pages. If Null, the value from reg.1.displayname will be used. If the reg.1 display name is also Null, the handset s MAC address will be used. The multicast IP address to send page audio to and receive page audio from. The audio codec to use for outgoing PTT broadcasts. Incoming PTT audio will be decoded according to the codec specified in the incoming message. If 0, the PTT protocol behavior is not compatible with Spectralink handset models 8020/8030 or older. If 1, all PTT protocol behavior is compatible with the older Spectralink handsets, even if some configuration parameters are incompatible. ptt.displayname ptt.address ptt.codec ptt.compatibilitymode PTT Channels PTT channels can be managed to allow different types of functionality per channel. Some of these settings can be changed by the user. February

170 The label is determined by the administrator and is the name used to identify the channel during broadcasts. If Channel Available is disabled, the user cannot access the channel or subscribe to it and the other channel parameters will be ignored. If enabled, the user can access the channel and may choose to subscribe. If Allow Transmit is disabled, the user cannot sent PTT broadcasts on the channel. If enabled, the user may choose to send PTT broadcasts on the channel. If Allow Receive is disabled, the user cannot receive PTT broadcasts on the channel. If enabled, the user may choose to receive PTT broadcasts on the channel. If Subscribe is disabled, the handset will not be subscribed to the channel. If enabled, the handset will subscribe to the channel. Label Description Parameter Default Channel Channel Info The PTT channel used to transmit an outgoing page if the user does not explicitly specify a channel. This setting can be changed by the user. Make the channel available to the user ptt.defaultchannel Channel x The label to identify the channel ptt.channel.x.label Channel Available Make the channel available to the user ptt.channel.x.available Subscribe Subscribe the handset to the channel ptt.channel.x.subscribed Allow Transmit Allow outgoing broadcasts on the channel ptt.channel.x.allowtransmit February

171 Label Description Parameter Allow Receive Allow incoming broadcasts on the channel ptt.channel.x.allowreceive Wireless Wireless profiles are configured in the Wireless Profiles page. The configured profiles are listed here. This page configures the exact radio characteristics to be used by any selected profile. When the profile is changed, these setting must be reconfigured. The 84-Series handsets use only one profile at a time. If the handset goes out of the range of that profile s SSID, call registration will be lost until the handset comes back into range and the registration can be regained. An out-of-range handset will show an inactive status. For 2.4GHz the maximum transmit power level may be selected. See the Spectralink 84-Series Wireless Telephone Deployment Guide for more information about power level settings. For 5 GHz the maximum power level may be set for each of the four sub-bands. See the Spectralink 84-Series Wireless Telephone Deployment Guide for more information about power level settings. The regulatory domain is specified in QNC for the initial wireless profile. Three regulatory domains are offered by Spectralink 84-Series devices. Domain Country 1 United States Canada 2 Europe (ETSI) New Zealand 10 Australia The regulatory domain dictates the subband and power settings that are allowed. Since CMS doesn t know what regulatory domain is selected in CMS, you must set domains and the radio frequency settings appropriately for the domain in CMS. Configuring radio frequency settings The Band/Frequency (2.4 GHz or 5 GHz) parameters can be configured for the desired band on your WLAN network. If both bands are configured as active, the handsets band roaming capabilities will choose the best signal available from both the 2.4 GHz and 5 GHz options. To disable the band roaming mechanism, configure only the band that the Spectralink 84-Series handsets are to use (either 2.4 GHz or 5 GHz, not both). You will need to set sub-bands for the 5 GHz frequency and transmit power for both frequencies. February

172 Subbands for the 5GHz Band Regulatory authorities throughout the world subdivide the 5 GHz band into multiple sub-bands according to the channel assignments in the country of use. After you select the regulatory domain for your country, choose the channels used in your facility. Enable only the same bands and sub-bands as are configured on your wireless infrastructure, otherwise the handsets will waste time looking for a signal on the unused sub-bands and roaming performance will be impaired. Warning Do not enable all sub-bands Do not enable all bands and sub bands in the WLAN or the phone. This will cause the phone to have a very long channel scanning cycle which causes poor roaming and poor audio. See Best Practices for Deploying Spectralink 84-Series Handsets White Paper. The link is in the Spectralink References section. Caution: Sub-bands CMS will display all four 5GHz sub-bands but only those with channels shown in the following tables are available in your domain. Sub-bands that are not available are marked in the tables as not applicable. If a band is not available and you select it anyway and that is the only selected subband, the handset will not be able to associate with an AP and the error message Invalid Regulatory Domain Setting displays on the handset. If this message displays, check that the correct regulatory domain is selected, and then compare the sub-bands that are enabled with the table for that regulatory domain shown next. Enable only those sub-bands that are permitted for your regulatory domain and available in the WLAN. The following tables identify which channels are available in each domain. For Regulatory Domain 1: Sub-band for 5 GHz Band Channel 1 36, 40, 44, 48 No 2 52, 56, 60, 64 Yes 3 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140 DFS (Yes/No) Yes 4 149, 153, 157, 161, 165 No February

173 For Regulatory Domain 2: Sub-band for 5 GHz Band Channel 1 36, 40, 44, 48 No 2 52, 56, 60, 64 Yes 3 100, 104, 108, 112, 116, 120, 124, 128, 132, 136, 140 DFS (Yes/No) Yes 4 Not applicable Not applicable For Regulatory Domain 10: Sub-band for 5 GHz Band Channel 1 36, 40, 44, 48 No 2 52, 56, 60, 64 Yes 3 100, 104, 108, 112, 116, 132, 136, 140 DFS (Yes/No) Yes 4 149, 153, 157, 161, 165 No Label Description Parameter Enable 2.4GHz Radio Power Level Enable 5GHz Radio Enable sub band x Sub-band Power Level Enables/disables the 2.4GHz radio band Sets the maximum power that the handset will use to transmit in the 2.4 GHz band. In general, this power should match the power setting at the access point so that the coverage radius of the handset matches that of the access point. Auto will use the maximum permitted power setting. Note that ESTI regulations limit the maximum setting in Europe. When domain 2 is selected, txpower will not go above 4. Enables/disables the 5GHz radio band Enables/disables the 5GHz radio band subband Sets the maximum power that the handset uses to transmit in the 5 GHz sub-band. Will use the maximum allowable power for that channel and data rate. If no maximum is set, the handset uses the P5 settings for each channel activated. device.wifi.radio.band2_4ghz.enable device.wifi.radio.band2_4ghz.txpower device.wifi.radio.band5ghz.enable device.wifi.radio.band5ghz.subbandx.enable device.wifi.radio.band5ghz.subbandx.txpower February

174 Chapter 19: Spectralink 84-Series Custom Settings Custom Settings allow you to configure parameters that are not included in the CMS UI. These settings can be applied to single devices, Groups of devices or to all devices in a facility at the Enterprise level. The XML Config page allows you to import, create and assign.xml files to phones. Import Configuration If you have XML files that you have already created or prefer to create them outside of CMS, they can be imported here. These files must be properly formed with no formatting errors. Check them with a robust XML editor before uploading them as improperly formatted files will be rejected. Tip: Separate XML files by function Do not group all custom settings into one file. Separate them by useful descriptive filenames so that they can be easily managed and deployed according to usefulness. February

175 To import a configuration 1 Create the file and save it as.xml in a place you can access from the CMS server. Ensure it is properly formatted by checking it in an editor. Example: You have created an.xml file so that you can get screen captures off test devices. Only one parameter needs to be enabled. You have called it CMSscreenCapture.xml. It looks like this: 2 Click the Import Configuration button and navigate to and select the desired file. When you import it, the configured parameter(s) is displayed in the XML editor: 3 Enter a name for the Custom Settings file and press SAVE. (The RESET button allows you to edit the name of the Custom Setting.) You cannot Save a file unless you have named it. Our example file is called Screen Capture. 4 The custom file appears in the list of files. The file extension is added by CMS. The name, the date and time it was created and whether it is applied to any device is displayed. Create Configuration If you do not have a file already created, you can use Custom Settings to enter the needed parameters. February

176 To create a Custom Settings file using CMS 1 Click the Create Configuration button and enter the Custom Settings name and the needed parameters. Example: Configure location services (ekahau) 2 Click SAVE. The custom file appears on the list: Download and Edit Custom Settings Files The Actions shown on the right side of the File Name allow you to download or edit the.xml file. The download icon allows you to save or open the file in an XML editor for editing. To change the settings in CMS you must import the configuration again thus overwriting the file in CMS. The edit icon allows you to edit the file within the CMS UI. The edits take effect immediately upon clicking the SAVE button. Apply Custom Settings File(s) Custom Settings can be applied to one or more phones using the Device, Group, or Enterprise level. February

177 Apply Custom Setting to a Device 1 Open the Device List and select the device. 2 Click the Select actions dropdown list and select Apply Custom Config. 3 The Custom Settings page opens. Select the file that you want to configure for the selected device. Click OK. 4 The Custom Settings file now displays the serial number of the selected device in the Applied to column. Apply Custom Setting to a Group When you want to apply Custom Settings to a limited number of handsets, you must use the Group feature. 1 Establish a Group for this custom configuration. 2 Open the Manage Groups page and select the Group. Click the Select actions dropdown list and select Apply Custom Config. 3 The Custom Settings page opens. Select the file that you want to configure for the selected Group. Click OK. 4 The Custom Settings file now displays the serial numbers of the devices Group in the Applied to column. February