Spectralink Configuration Management Server. Administration Guide. Release 2.1.x

Transcription

1 Spectralink Configuration Management Server Administration Guide Release 2.1.x Rev C vember 2016

2 Copyright tice 2016 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. 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. 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. tice 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 Spectralink Europe ApS Spectralink Europe UK th Street Bygholm Soepark 21 E Stuen 329 Bracknell, Doncastle Road Boulder, CO Horsens Bracknell, Berkshire, RG12 8PE USA Denmark United Kingdom info@spectralink.com infoemea@spectralink.com infoemea@spectralink.com vember

3 Contents About This Guide... 8 Deployment process... 8 What is QNC?... 8 What is CMS?... 8 What is MDM/EMM?... 8 What is Manual Configuration?... 9 Product Support... 9 Spectralink References... 9 Specific Documents...10 Conventions Used In This Document...11 Icons...11 Typography...12 Part I: Installing the Configuration Management Server Chapter 1: Getting Started with CMS How Secure is CMS?...15 Setting HTTPS...15 CMS 2.x Server Requirements...15 Minimum requirements...15 Capacity guidelines...16 Chapter 2: Installing the CMS VM ESXi 5.x Server Installation Overview...17 CMS 2.0 Infrastructure Installation Instructions...17 Creating your CMS Account and Logging in...21 Updating CMS Code: Installing the CMS Patch...23 Step 1: In the CMS browser...23 Step 2: On the host machine...23 Step 3: Verify in the CMS browser...25 Part II: Configuration Management How CMS Works...26 Navigation...26 Banner...26 vember

4 Navigation pane...27 Deployment Sequence...28 Chapter 3: About Us What is the CMS Certificate?...30 Chapter 4: Batch Configuration Mac address...33 Owner info...34 Group name...34 SIP extension number...34 SIP username...35 SIP password...35 Upload.csv to CMS...35 Generate.csv from Legacy CMS...36 Chapter 5: Devices Approving Devices via Holding Area...37 Device List...38 Device List actions...39 Re-Deploying Devices...40 Chapter 6: Updating PIVOT Code Upload files...41 Manage files...42 Updating Legacy Code...43 Chapter 7: Groups Chapter 8: Configuration Understanding Enterprise, Group and Device s...45 Enterprise settings...45 Group settings...45 Device settings...46 Understanding Settings...46 Deleting Settings...47 Config Manager...48 Wireless / Networking...49 Wireless profiles...49 IPv Unsecured wireless networks available notification...50 vember

5 802.11n...50 Wi-Fi frequency band...50 Standby roaming threshold...51 Device Security...52 Allow user to change lock screen password, Make passwords visible...52 Display Owner info on lock screen...53 Allow unknown application sources...53 Enable Admin password prompt...53 Lock screen after...54 Owner info...54 n Wi-Fi Certificates...54 Admin password...54 Emergency Contacts...55 Contact name, contact number...56 General Settings...57 LDAP...58 LDAP server address...59 LDAP server port...59 Communication security type...60 LDAP bind DN...60 LDAP bind PW...60 LDAP base DN...61 Primary attribute...61 Alternate attribute...61 Push to talk...62 Enable settings...62 Channel settings...63 SAFE / Panic...64 SIP Telephony...66 Enable SIP...66 Registration 1 and Server address...68 Server Port...68 Transport...69 Extension...69 Username...70 Password...70 Voic retrieval address...70 Use SIP standard hold signaling...71 Force subscription to message waiting notifications...71 Common settings...73 Audio codec priority...74 System Log...75 vember

6 Web API...79 Enable API Calls...79 Web API Format...80 Polling Username, Polling Password...80 Polling Respond Method...80 Push Username / Push Password...81 Allow message priority...81 Push ringtone...81 Server root URL...82 Web API Event URLs...82 Label...83 URL...83 Settings...84 Web Applications...85 Label, URL...85 Barcode Scanner...86 Enable Camera as a Scanner...86 Symbology Settings...87 Quick Barcode Connect...89 Encryption...89 Connection timeout...90 Response timeout...90 Keep-alive timeout...90 Inactivity timeout...90 Operation Mode...91 Server Address...91 Server Port...91 Passphrase...91 Barcode Ringtone...92 Chapter 9: Wireless Profiles Open Network...94 WEP...94 WPA/WPA2 PSK x EAP (WPA2 Enterprise) Set up...95 Managing Wireless Profiles...97 Chapter 10: Certificate Manager Installing generic CA certificates or PAC files...98 Managing certificates...99 vember

7 Chapter 11: Replace Device Chapter 12: Feature / Device Licenses CMS license Feature license Part II Appendices Appendix A: Using CMS to Refine Log Messages Setting up Your Syslog Filters in CMS Using a Filter to Refine Logging Results Appendix B: Open Source Information OFFER for Source for GPL and LGPL Software Contact Information for Requesting Source Code Appendix C: Products Mentioned in this Document vember

8 About This Guide This document is used by administrators to configure and manage the Spectralink 87-Series smartphones, also known as PIVOT by Spectralink. The following diagram shows the deployment process and the position of CMS in relation to the rest of the deployment. This guide covers the administration of the smartphones using the CMS as well as information about managing the CMS. Detailed instructions for smartphone settings are in Spectralink PIVOT Configuration Guide. 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 87-Series smartphones. 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 87-Series smartphone loads the wireless parameters into the smartphone. See Quick Network Connect Administration Guide for complete information. What is CMS? The primary tool for administering a volume of smartphones 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 smartphones and manage the deployment of many smartphones 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 vember

9 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. See Spectralink 87-Series Applications Installation Guide for complete information. What is Manual Configuration? Like any device powered by Android, PIVOT provides menus for configuring options that provide functionality and features. Two types of menus are available, the familiar user-level menus used by all smartphones and administrator menus that are behind a password. Manual configuration refers to using these smartphone menus to set up each smartphone individually. Practically any deployment will require some manual adjustments so this step is included to put the final polish on your deployment. See PIVOT by Spectralink Configuration Guide for complete information. 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 vember

10 To go to a specific product page: Select the Product Category and Product 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 AP Configuration Guides show you how to correctly configure access points and WLAN controllers (if applicable) and identify the optimal settings that support Spectralink 87-Series smartphones. 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 PIVOT 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. 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 by Spectralink Barcode Administration Guide The Barcode Administration Guide provides detailed information about supported symbologies. PIVOT by Spectralink QBC Administration Guide Provides instruction for implementation of the barcode application. The PIVOT by Spectralink User Guide contains information about using the barcode 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. vember

11 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. For information on IP PBX and softswitch vendors, see PIVOT by Spectralink Call Server Interoperability Guide. 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. te The te 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. vember

12 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. 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 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. vember

13 Convention Bright orange text Fixed-width-font Description 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>, 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. vember

14 Part I: Installing the Configuration Management Server CMS is a powerful interface for configuring and managing Spectralink 87-Series smartphones. Let s take a moment to look at some big questions. 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. Settings: Is CMS necessary? The question will arise if CMS is strictly necessary for configuring and managing the smartphones. The short answer is, 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. For specific information about configuring the smartphones manually see Spectralink 87-Series Smartphone Deployment Guide. The longer answer is Yes; if you are deploying many smartphones, have complex settings such as security certificates, smartphone groups, etc., or if the smartphones 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 smartphones remotely. Settings: t using CMS? If you are not deploying a CMS, please refer to Spectralink 87-Series Smartphone Deployment Guide for the sequence of steps to take when manually configuring the smartphones. vember

15 Chapter 1: Getting Started with CMS How Secure is CMS? CMS transfers configuration information to the smartphones 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 smartphone using QNC. This is the server key that ensures the smartphone recognizes the CMS as genuine. The smartphone contains a device certificate that is loaded during manufacturing. The CMS can recognize this key and therefore knows that the smartphone is genuine. Once this authentication handshake is complete, the smartphone and the CMS exchange information over a secure connection. For a comprehensive explanation of Wi-Fi security see Spectralink 87-Series Wi-Fi Security Implementation Guide. 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 smartphone 2 Using QNC to install the CMS certificate. See Quick Network Connect Administration Guide and the About Us Chapter in this document. 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&docid=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: vember

16 1 virtual CPU 2GB RAM 10GB 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. General guidelines for larger installations: Number managed # virtual CPUs RAM Hard drive < 50 use the minimum. 50 and virtual CPUs, 2GB 25GB 200 and virtual CPUs, 2GB 30GB 500 and virtual CPUs, 2GB 40GB virtual CPUs, 4GB 60GB Settings: t using CMS? If you are not deploying a CMS, please refer to Spectralink 87-Series Smartphone Deployment Guide. vember

17 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 te These instructions require the reader to be knowledgeable about using VMWare vsphere. See VMWare s website for more information. CMS code is available on the Spectralink support website. 3 Browse to Spectralink Support site to download the CMS 2.0 SW at 4 Within the Wi-Fi Product category select Find and select PIVOT (Spectralink 87-Series) 5 CMS software is under the Downloads tab. Download the code. 6 Download the CMS zip file from the Spectralink support site. 7 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. 8 Connect to your ESXi host server using vsphere. vember

18 9 Select File> Deploy OVF Template from VSphere. 10 Browse to the OVF file inside the unzipped folder from step 2. Select Next. 11 Select Next again. Name the new machine something like "Spectralink CMS". Select Next. vember

19 12 Select the resource pool you want to run this VM on. (You may only have one ESXi server to choose from). 13 Select the datastore that you want to deploy this VM onto. You may only have one datastore. Click Next. 14 Select Thick Provision Lazy Zeroed for the disk format. Select Next. 15 Change the Network Mapping to a network that your 87-Series smartphones have access to. Select Next. 16 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. 17 Right-click the new machine in the tree on the left of vsphere and select Power> Power On. 18 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. 19 Switch to bash shell (optional but recommended) bash 20 Run the command cd bin vember

20 21 Run the command sudo python network_init.py and follow the prompts to configure your network interfaces: DHCP address {your static IP address here} netmask {your static network mask here} gateway {your default gateway here} DNS nameserver 22 Run the command sudo python application_init.py and follow the prompts. address {your static IP address here} Admin Tip: HTTPS and IP addressing When configuring the smartphone 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 smartphone'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} 23 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.) vember

21 ========= Further customization steps (like changing server root login and web interface default admin login) are covered in PIVOT by Spectralink Configuration Guide. Creating your CMS Account and Logging in 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. vember

22 vember

23 Updating CMS Code: Installing the CMS Patch Installing the patch is a three-step procedure. Step 1: In the CMS browser 1 Download the patch from the Spectralink support site. 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. vember

24 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. vember

25 cd bin. sh upgrade.sh. The upgrade script issues messages as it is upgrading. 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. vember

26 Part II: 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. How CMS Works The Configuration Management System provides a GUI interface for an administrator to configure and manage PIVOT 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 PIVOT. In CMS, settings can be configured at the Device, Group or Enterprise level. These settings are picked up by the smartphone when it heartbeats into CMS. CMS is designed to be the exclusive configuration method for Admin menu options. If smartphones 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. If the Restore defaults option has been used on the Admin menu, there is no way to recover previous CMS settings. See Devices for the method to re-deploy the smartphone with 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. vember

27 Navigation pane The navigation pane provides intuitive icons to direct you to administrative pages. Condensed Expanded vember

28 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. Caution: Use the correct version of CMS! CMS 2.0 is designed to work with PIVOT R1.8, 2.1 and above. Always check the Release tes to ensure that the PIVOT code version you are running is compatible with the code version of CMS. 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. See Installing the CMS. 3 Create the Batch.csv file for bulk configuration of basic smartphone parameters. See Batch Configuration. 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. See Updating PIVOT Code. 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. See About Us. If you are using CMS 2.0 or above, you will need to enter the account key that CMS generates. See About Us. 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. See Approving Devices via Holding Area. Smartphones are now listed in the Device List. vember

29 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. For installing CMS licenses, see Feature / Device Licenses. Once the needed number of licenses are loaded, approve the rest of the smartphones. 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. vember

30 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 The About Us page displays the version of CMS code that you are running. For full information about updating CMS code see Installing the CMS Patch in Chapter 2. 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. The certificate can be pasted into QNC when using HTTPS. What is the CMS Certificate? te: Use QNC to install the CMS certificate A certificate cannot easily be installed on the smartphone by typing it in. and we recommend using QNC for this purpose. If you are using HTTP and not using HTTPS for the CMS/smartphone protocol, you may skip this section on certificates and go to the next chapter. vember

31 The default is to use HTTPS for smartphone-to-cms server authentication. With this type of deployment, the 87-Series smartphone 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 smartphone, 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 smartphone using QNC. When the smartphone 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 smartphone through the Spectralink device certificate loaded on the smartphone at manufacturing. With both the smartphone 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 PIVOT by Spectralink Wi-Fi Security Implementation Guide 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 smartphones before this 3-year certificate expires. vember

32 Chapter 4: 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 vember

33 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. tes: 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 vember

34 Owner info The owner info is the name that displays on the lock screen. tes: Text field none t necessarily 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. tes: Text field none 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. tes: Text field. none Yes. Every smartphone has a different extension. Yes Device See above vember

35 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. tes: Text field. none Yes. Every smartphone has a different SIP username. Device See above SIP password The SIP digest authentication password to be used for SIP registration. tes: Text field none Yes 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. vember

36 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. vember

37 Chapter 5: 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. See Feature / Device Licenses for additional information about entering the CMS License before configuring any additional devices. 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. vember

38 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: vember

39 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. vember

40 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. vember

41 Chapter 6: 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 87-Series smartphones. 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 tes 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. vember

42 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. vember

43 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. vember

44 Chapter 7: 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 te 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. vember

45 Chapter 8: Configuration The Configuration pages contain PIVOT configuration settings for successful deployment. Understanding Enterprise, Group and Device s 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. See Groups for more information on configuring Groups. 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. vember

46 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. See Batch Configuration. 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. te that some settings do not support the level icons. 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 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 vember

47 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 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 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. vember

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

49 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. Radio buttons vember

50 tes: QNC. 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. tes: Radio buttons Enabled. 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. tes: Radio buttons Enabled. 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. Dropdown list Auto vember

51 tes:. 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. Slider -75. will be used if left blank. Enterprise, usually but may be set at any level tes: See above vember

52 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. tes: Enable or disable Enabled Enterprise, usually but may be set at any level. See above. vember

53 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. tes: 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 Device, usually but may be set at any level. See above. Allow unknown application sources This is an enable/disable option. te 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. tes: Enable or disable Disabled 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. tes: Enable or disable QNC. Will use default if left blank Enterprise, usually but may be set at any level. See above. vember

54 Lock screen after This allows you to set the delay for locking the screen. tes: Dropdown list 5 seconds 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. n Wi-Fi Certificates Provides a list of non-wi-fi certificates that have been loaded on the Manage Certificates page. tes: entry permitted. This is a list of certificates already loaded ne 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. tes: Text field QNC. Will use default if left blank Enterprise, usually but may be set at any level. See above. vember

55 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. vember

56 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. tes: Text fields ne Enterprise, usually but may be set at any level. See above. vember

57 General Settings vember

58 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. vember

59 LDAP server address The IP address or hostname of the LDAP server interface to the corporate directory. For example, host.domain.com. tes: Text fields accepts: dotted-decimal IP address or hostname or FQDN ne 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). vember

60 Text field. Accepts 0, Null, 1 to tes: Enterprise, usually but may be set at any level. See above. Communication security type If you are using encryption, select the type: SSL, ne, Start TLS tes: Dropdown list ne 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. tes: Text field ne [blank] (leave empty for entire site) 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. tes: Text field ne [blank] (leave empty for anonymous) Enterprise, usually but may be set at any level. See above. vember

61 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. tes: Text field ne [blank] (leave empty for entire site) 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. tes: Text field none 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. vember

62 tes: Text field none 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 vember

63 Channel settings vember

64 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.1or 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. vember

65 vember

66 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. tes: Checkbox Disable Yes, for telephony function Enterprise Must be enabled manually at the Enterprise level for facility-wide telephony functioning vember

67 Registration 1 and 2 vember

68 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. 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. tes: See above for format type ne 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. Numeric value. Accepts 0, 1 to Leaving this value blank will enter the default value. vember

69 tes: 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. tes: 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. tes: Text entry. Configurable through.csv. ne 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. vember

70 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. tes: Text entry. Configurable through.csv. ne 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. tes: Text entry. Configurable through.csv. ne 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 tify 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 vember

71 tes: 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) ne 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) tes: Checkbox Enabled 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 tifications vember

72 Disabled: The smartphone will not send a separate SIP Subscribe notification to the Server address for message waiting tifications tes: Checkbox Disabled 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 tes: Checkbox Disabled See above Enterprise See above vember

73 Common settings Audio DSCP Specify the DSCP of packets. tes 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 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. vember

74 tes 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 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. tes: Checkbox to select and arrows for re-prioritization G.711u = 1 and G.711a = 2. The other two codecs are disabled by default. Yes, for telephony function Enterprise Must be enabled manually at the Enterprise level for facility-wide telephony functioning vember

75 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. See Appendix A for more information. 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. vember

76 Enable syslog tes: Checkbox Off. 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 vember

77 tes: Text field ne Enterprise, usually but may be set at any level See above Transport protocol Selects the method used to transport information. tes: Dropdown UDP 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. Dropdown Disable Yes, if using a syslog server. vember

78 tes: 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 tes: Dropdown Warning 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. tes: Text field ne Enterprise, usually but may be set at any level. See above. vember

79 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. Checkbox Disabled See above Enterprise, usually but may be set at any level. vember

80 tes: See above Web API Format XML and JSON are the supported formats. tes: Dropdown list XML 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. tes: Text fields ne 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. tes: Dropdown list Requester See above Enterprise, usually but may be set at any level. See above vember

81 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. tes: Text fields ne 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. tes: Dropdown list All 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. Radio buttons Enabled. will be used if left blank. Enterprise, usually but may be set at any level vember

82 tes: 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. tes: Text field ne 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. te: 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. vember

83 Label Enter a descriptive label. tes: Text field ne Enterprise, usually but may be set at any level. See above. URL Enter the URL for this Event Text field ne vember

84 tes: Enterprise, usually but may be set at any level. See above. Settings Check the setting that apply to this event. tes: Checkboxes Disabled Yes Enterprise See above vember

85 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. tes: Text fields ne Enterprise, usually but may be set at any level. See above. vember

86 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 tes: Checkbox Disabled Yes for barcode scanning Enterprise See above vember

87 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. vember

88 Example of sub-option menu vember