Upload
others
View
10
Download
0
Embed Size (px)
Citation preview
721-0055-000 Rev C April 2019
Spectralink Applications Management (SAM)
Administration Guide For Versity Smartphones
Release 1.1.0.527.503
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 2
Copyright Notice
© 2018-2019 Spectralink Corporation All rights reserved. SpectralinkTM, 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 securely 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.
Android is a trademark of Google LLC; Oreo is a trademark of Mondelez International, Inc. group.
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
http://support.spectralink.com.
Contact Information
US Location Denmark Location UK Location
+1 800-775-5330 +45 7560 2850 +44 (0) 20 3284 1536
Spectralink Corporation Spectralink Europe ApS Spectralink Europe UK
2560 55th Street Bygholm Soepark 21 E Stuen 329 Bracknell, Doncastle Road
Boulder, CO 80301 8700 Horsens Bracknell, Berkshire, RG12 8PE
USA Denmark United Kingdom
721-0055-00_C.docx April 2019 3
Contents
Introduction ...................................................................... 9
Welcome to SAM ............................................................................................................... 9
About this Document ........................................................................................................ 9
Product Support ..............................................................................................................10
Part I: SAM installation ..................................... 11
Capacity Guidelines .........................................................................................................11
Chapter 1: Install SAM Server .............................................. 12
Requirements ...................................................................................................................12
Step I: Deploy Virtual Machine ........................................................................................12
Windows vSphere Client .............................................................................................12
vSphere Web Client ....................................................................................................14
Step 2: Setup Networking and SAM Server ....................................................................15
Part II: Pre-configuration Setup .......................... 18
Step 3: Enter Account Info & Account Number .............................................................18
Opening the SAM Browser Window ............................................................................18
Logging into SAM via Active Directory .........................................................................18
Logging into SAM via Local Administrator Account .....................................................20
Changing the Password ..............................................................................................21
Logout .........................................................................................................................22
Step 4: Install License .....................................................................................................22
Step 5: Install Certificate .................................................................................................22
Chapter 2: Navigation ........................................................ 24
Banner ........................................................................................................................24
Navigation Bar ............................................................................................................25
Chapter 3: About SAM ........................................................ 26
App Version / Update SAM software ...........................................................................26
Account Key ................................................................................................................26
Account Number .........................................................................................................26
SAM server certificate .................................................................................................26
Cert signing request file ...............................................................................................27
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 4
Chapter 4: SAM License ..................................................... 29
Part III: Implementing the Design ........................ 31
Chapter 5: Batch Configuration ............................................ 32
MAC address ..............................................................................................................33
Device info 1-4 ............................................................................................................33
Group name ................................................................................................................33
SIP extension number .................................................................................................34
SIP username .............................................................................................................34
SIP password ..............................................................................................................34
SIP secondary… .........................................................................................................35
PTT caller ID ...............................................................................................................35
Steps for Creating the .csv File .......................................................................................35
Upload .csv to SAM .........................................................................................................35
Chapter 6: Versity Devices .................................................. 36
The Holding Area .............................................................................................................36
Approving Devices ......................................................................................................36
Rejecting Devices .......................................................................................................37
Deleting Devices .........................................................................................................37
Approving Devices ..........................................................................................................38
Device List ........................................................................................................................39
Chapter 7: Copy Configuration ............................................. 42
Chapter 8: Versity Groups ................................................... 44
Create new Groups .....................................................................................................44
Configure or change Group settings ............................................................................44
Prioritize Groups .........................................................................................................44
Part IV: Applications ........................................ 46
Allow/Disallow .............................................................................................................47
Saving the configuration ..............................................................................................47
Blue dot .......................................................................................................................47
Updating applications ..................................................................................................48
Understanding Enterprise, Group and Device Levels ...................................................48
Enterprise settings ......................................................................................................48
Group settings .............................................................................................................48
Device settings ............................................................................................................49
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 5
Custom Attributes............................................................................................................50
Chapter 9: Custom Apps ..................................................... 52
Chapter 10: Barcode .......................................................... 53
Supported Symbologies ..................................................................................................53
General Settings ..............................................................................................................53
Enable barcode scanner .............................................................................................54
Illumination power .......................................................................................................54
Decode Session Timeout ............................................................................................55
Automatic carriage return ............................................................................................55
Scan success indicators ..............................................................................................55
Symbology settings .........................................................................................................56
Chapter 11: Batt Life .......................................................... 58
Enable Battery Monitoring ...........................................................................................58
Vibrate/Sound .............................................................................................................58
Low Battery Threshold ................................................................................................59
Snooze Time ...............................................................................................................59
Alarm Tone .................................................................................................................59
Chapter 12: Biz Phone ........................................................ 60
Enable SIP ........................................................................................................................60
Registration 1 and 2 .........................................................................................................61
Server address ............................................................................................................61
SIP server port ............................................................................................................62
Transport.....................................................................................................................62
Extension ....................................................................................................................63
Username ...................................................................................................................63
Password ....................................................................................................................64
Voicemail retrieval address .........................................................................................64
Use SIP standard hold signaling .................................................................................65
Force subscription to message waiting notifications ....................................................65
Allow contact header updates .....................................................................................65
Specify new TCP port in contact header .....................................................................66
Use vendor protocol if licensed ...................................................................................66
Allow call forwarding ...................................................................................................66
Cisco Solution Partner Program .....................................................................................67
Allow iDivert ................................................................................................................67
Allow call park .............................................................................................................68
Allow hunt group login/logout ......................................................................................68
Voicemail enable .........................................................................................................68
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 6
Common settings.............................................................................................................69
Audio DSCP ................................................................................................................69
Call Control DSCP ......................................................................................................69
DTMF relay payload type ............................................................................................70
Audio codec priority .....................................................................................................71
LDAP .................................................................................................................................72
LDAP server address ..................................................................................................73
LDAP server port .........................................................................................................73
Communication security type ......................................................................................74
LDAP Bind DN ............................................................................................................74
LDAP Bind PW ............................................................................................................74
LDAP Base DN ...........................................................................................................74
Primary email attribute ................................................................................................75
Alternate email attribute ..............................................................................................75
Emergency Contacts .......................................................................................................76
Contact name, contact number ...................................................................................77
Chapter 13: Device Settings ................................................. 78
Enable device settings ................................................................................................78
NTP server address ....................................................................................................79
Wi-Fi and Airplane mode toggles ................................................................................79
Time ..................................................................................................................................79
Allow time zone configuration ......................................................................................79
Allow time format configuration ...................................................................................80
Allow auto timezone configuration (LTE only) ..............................................................80
Automatic timezone (LTE only) ...................................................................................80
Time zone ...................................................................................................................80
Time display format .....................................................................................................80
Device Info .......................................................................................................................80
Display device info ......................................................................................................80
Device info 1-4 ............................................................................................................81
Chapter 14: Lens Grid ........................................................ 82
Enable lens grid ..........................................................................................................82
Lens grid size ..............................................................................................................82
Chapter 15: Logging .......................................................... 83
Syslog ...............................................................................................................................83
Enable syslog ..............................................................................................................84
Server address ............................................................................................................84
Server port ..................................................................................................................84
Logcat parameters ......................................................................................................84
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 7
Advanced Debugging ......................................................................................................85
Advanced debugging password ..................................................................................86
Bug report, etc. ...........................................................................................................86
Logcat .........................................................................................................................86
QXDM .........................................................................................................................87
File upload server ........................................................................................................87
Chapter 16: Push to talk ..................................................... 88
Enable / Disable PTT ..................................................................................................88
Username ...................................................................................................................88
Multicast address ........................................................................................................89
Codec .........................................................................................................................89
Transmit audio frame size ...........................................................................................89
Audio redundancy .......................................................................................................89
Default channel ...........................................................................................................90
Emergency call volume ...............................................................................................90
Channel Info ................................................................................................................91
Priority and Emergency channels ................................................................................92
Chapter 17: SAFE .............................................................. 93
Monitoring ........................................................................................................................94
Motion settings ............................................................................................................95
Snooze and Warning timeouts ....................................................................................95
Panic Alarm ......................................................................................................................96
On/Off options .............................................................................................................96
Panic Button silent alarm .............................................................................................97
Emergency call ...........................................................................................................97
Emergency dial force speaker .....................................................................................97
Emergency dial number ..............................................................................................97
SAFE ring tones ..........................................................................................................97
Chapter 18: Sys Updater ..................................................... 99
Trigger OTA .............................................................................................................. 100
Force reboot after OTA update .................................................................................. 100
Server address .......................................................................................................... 100
Server port ................................................................................................................ 101
Chapter 19: VQO ............................................................. 103
Wi-Fi low RSSI threshold .......................................................................................... 103
Wi-Fi auto band selection .......................................................................................... 104
Wi-Fi 2.4 GHz band selection .................................................................................... 104
Wi-Fi 5 GHz band selection ....................................................................................... 104
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 8
Chapter 20: Web API ........................................................ 106
Web API .......................................................................................................................... 106
Enable API calls ........................................................................................................ 106
Web API format type ................................................................................................. 107
Polling ....................................................................................................................... 107
Respond Method ....................................................................................................... 107
Push API ................................................................................................................... 108
Web API event URLs ................................................................................................ 109
APP URLs ....................................................................................................................... 112
Label, URL ................................................................................................................ 112
Part V: Appendices ........................................ 113
Appendix A: Spectralink References .................................... 114
Specific Documents ....................................................................................................... 114
Specific Documents .................................................................................................. 114
White Papers ............................................................................................................ 115
Appendix B: Conventions Used in this Document ................... 116
Icons ......................................................................................................................... 116
Typography ............................................................................................................... 117
Appendix C: Products Mentioned in this Document ................. 119
721-0055-00_C.docx April 2019 9
Introduction
Welcome to SAM
The primary tool for administering a volume of Spectralink devices is SAM---Spectralink
Application Management. SAM runs on a browser using a GUI interface. It provides an easy
and intuitive way to configure and manage the deployment of many Versity smartphones.
An administrator can configure any Versity administrative settings in SAM. 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 SAM.
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.
SAM is designed to be the exclusive configuration method for Admin menu options. If devices
are configured manually through their Admin menus, SAM will not “know” about these changes.
Existing SAM configuration settings will overwrite any manual changes at the next heartbeat.
About this Document
This document covers how to install the SAM server and use the SAM interface. This document
assumes that Versity phones either have been deployed or are in the process of being
deployed.
This document details these aspects of the deployment process:
• Installing the SAM server
• Updating the SAM software
• Obtaining and installing the SAM certificate
• Preparing and uploading the .csv Batch file
• Pre-configuration of Spectralink application parameters
• Accepting devices from the Holding Area into the Device List.
• Configuring the applications
• Maintaining the SAM server
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 10
Product Support
Spectralink wants you to have a successful installation. If you have questions please contact the
Customer Support Hotline at 1-800-775-5330.
The hotline is open Monday through Friday, 6 a.m. to 6 p.m. Mountain time.
For Technical Support: mailto:[email protected]
For Knowledge Base: http://support.spectralink.com
For Return Material Authorization: mailto:[email protected]
721-0055-00_C.docx April 2019 11
Part I: SAM installation
Capacity Guidelines
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 SAM on a laptop or a less powerful host.
Conversely, an administrator might expect slightly better performance from a host
with a more robust processor.
Caution: Capacity guidelines
The R2.4 OVF requires 4 processors and 8 GB of RAM. This configuration will
handle up to 100,000 devices based on our testing. When approving more than
1000 devices at a time, SAM may display a spinning gear icon until the operation
completes. Increase the heartbeat interval accordingly. Keep in mind, the longer
the heartbeat interval that is set, the longer it may take the phone to accept new
changes.
721-0055-00_C.docx April 2019 12
Chapter 1: Install SAM Server
Requirements
The SAM server requires the following components:
• VMWare ESXi server 6.0 (or later) host machine capable of running 64-bit guest OS
Virtual Machines (ESXi is a hypervisor OS that allows you to run multiple virtual
machines)
• 8GB of free memory on your ESXi server
• 100GB free disk space on ESXi server datastore
• SAM account number (obtain this from your Spectralink representative)
Contact your Spectralink representative with any questions.
Step I: Deploy Virtual Machine The SAM server VM is available for download as a zip file from Spectralink. Once downloaded
you will deploy the proper files to your ESXi server using a VMware client. There are two types
of client—the Windows vSphere client or the vSphere Web Client.
Caution: ESXi deployment
Currently the SAM VM must be deployed directly to an ESXi server instead of
through vCenter to an ESXi server. This is due to the OVF format. Once installed
the VM may be managed by vCenter.
1 Download the SAM zip file from the Spectralink support representative.
2 Extract the files contained in the zip archive onto a machine that has a compatible
version of VMWare vSphere® Client installed. The new directory will contain two files:
spectralink-sam.ovf (VM descriptor file) and spectralink-sam-disk1.vmdk (VM disk
image). These files need to remain in the same directory.
Windows vSphere Client
1 Connect to your ESXi host server using the Windows vSphere client. Authenticate with
your credentials.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 13
2 Once you are logged in select File>Deploy OVF Template….
3 Click the Browse button and navigate to the spectralink-sam.ovf file, inside the
uncompressed folder from step 2, then click the Open button. Click the Next button.
4 Click the Next button again. You will be prompted for the VMware name for the VM. Your
administrator may have a VM naming convention to follow. If not then name the new
machine "spectralink-sam". Click Next.
5 Select the resource pool under which you want this VM to run, if you have resource
pools defined.
6 Select the datastore where you want this VM to install. Generally you do not want to run
any VM from the datastore where ESXi is installed. Click Next.
7 Select Thick Provision Lazy Zeroed for the disk format. Click Next.
8 Change the Network Mapping from the network used when the VM was created, NAT, to
one of your local networks. You may need a network administrator to tell you which one
of your networks to select. Click Next.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 14
9 Click the Finish button. You will see the progress of the OVF being deployed to your
server.
10 Right-click the new machine in the list of VM’s in the left pane and then select Power>
Power On.
vSphere Web Client
1 Open a compatible web browser and connect to your ESXi host server using the URL
https://<server-ip>. Authenticate with your credentials.
2 In the Host view, click the Create/Register VM button. Click the option “Deploy a virtual
machine from an OVF or OVA file”. Click the Next button.
3 Enter the VMware name for the VM. Click the blue box. Navigate to the uncompressed
directory from step 2 and select both (ctl-click) of the files spectralink-sam.ovf and
spectralink-sam-disk1.vmdk. Click the Next button.
4 Select the datastore where you want this VM to install. Generally you do not want to run
any VM from the datastore where ESXi is installed. Click Next.
5 Choose the Network Mapping from the network used when the VM was created, NAT, to
one of your local networks. You may need a network administrator to tell you which one
of your networks to select. For disk provisioning choose Thick. You can leave Power On
Automatically checked. Click Next.
6 Click the Finish button to start deployment.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 15
Step 2: Setup Networking and SAM Server
1 Open a console to the SAM VM. If you’re using the Windows Client, right-click the VM
and select Open Console; for the web client click the VM and then select console->open
browser console. Log into the host under account sam and password sam.
Caution: Change the password!
All new SAM deployments use the default password. You must change the
password to maintain security by running the passwd command. Record the new
password afterward since if you forget it, you cannot reset the system and you will
need to redeploy the VM.
2 Run the command passwd
You will be prompted for a new password. Enter it twice to verify. From that point onward
the sam/sam credentials will not allow you access.
3 Run the command cd bin
4 Run the command sudo python network_init.py
and follow the prompts to configure your primary network interface.
You have the option of selecting DHCP or static addressing.
If you select DHCP, the host will be configured with the startup DHCP address.
If you select static addressing, you will be prompted for the following network
parameters:
○ address (address assigned by your network administrator)
○ net mask (net mask for the connected network)
○ gateway (gateway for the connected network)
○ DNS nameserver (one or two nameservers for the connected network)
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 16
5 Run the command sudo python application_init.py
and follow the prompts to generate a certificate.
○ IP address
Admin Tip: Host name with SSL certificates
The application_init.py script generates a self-signed certificate. The certificate will
be associated with the host name/ip number that you enter. When configuring the
Sam Client app, the SAM URL you enter must match what is entered here. You can
use either the IP address or a fully-qualified domain name.
○ Desired Hostname (DNS name or IP address if not DNS registered)
○ Administrator Name (name of host administrator)
○ Administrator Email (email address of host administrator)
○ Country Code (the 2 digit SSL country code where the host is located)
○ State (2 digit state code)
○ City (city name)
○ Company (your company name)
○ Organization (designation for your work area)
○ Database Password (desired password for SAM backend)
○ Authentication (local account or Active Directory)
6 The script will run and then pause to ask whether authentication should be local or via
Active Directory. If you choose Active Directory, you will be prompted for the following
information:
○ Active Directory LDAP URL (URL to your domain controller e.g. ldap://10.20.30.40)
Admin Tip: Using Active Directory?
When configuring AD integration with SSL support you can add the : and port
number information to enable that support.
○ Company Domain (name of your AD domain)
○ Administrator Group (AD group that will have full access)
○ User Group (AD group with only the ability to add and remove phone)
○ Read Only (AD group with only the ability to view settings)
The administrator group must have an AD group set—the user and read-only groups
may be left blank. Also the same group cannot be used in two different roles.
7 The machine will reboot.
8 Your SAM should now be initialized. This step installs the certificate.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 17
The SAM installation is complete. The server will restart automatically across system reboots.
721-0055-00_C.docx April 2019 18
Part II: Pre-configuration Setup
Step 3: Enter Account Info & Account Number
Before using SAM, you may need to set up the local administrator account if you did not choose
Active Directory for authentication. You will also need an account number, provided by
Spectralink. After initial startup, SAM will continue to prompt for this information until entered.
Afterward you may log into the system.
Admin Tip: SAM is designed for one administrator at a time
If more than one administrator is logged into SAM, a collision of configuration
parameters might occur.
If you are an administrator and making changes to SAM parameters and another
administrator is also making changes in the same page, you will see a message
like this: New configuration changes: Click here to load settings. Clicking will
refresh the page with the other administrator’s settings, overwriting your changes,
which you may enter again.
Opening the SAM Browser Window
Enter the IP address that you set up in your SAM in a Google™ Chrome™ browser window.
Only the Google™ Chrome™ browser is supported. Use this format:
https://[IP address or server name]/sam/.
When Chrome security warnings appear, click the Advanced link and proceed to the SAM page.
The warnings appear due to SAM using a self-signed certificate by default. To eliminate the
warnings, install a certificate signed by your company’s root server or a public CA.
The first time you log into SAM, you will need to enter your account number. A local
administrator account name and password may also be needed. Once you have entered the
required information, you are ready to manage your Versity smartphones.
Logging into SAM via Active Directory
SAM supports the use of Active Directory (AD) to authenticate. If you elect to use it, you were
prompted for group information during set up. For access and permissions purposes, Active
Directory supports three different levels of access for three distinct groups. Instruct your SAM
users how to use SAM according to their permission levels.
• Administrator Group—any member of the specified AD group will be able to log into
SAM with their AD credentials and can change any setting, manage any phone. To
prevent access, the person must be removed from the AD group.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 19
• User Group—any member of the specified AD group can only approve, reject, and
delete managed phones. They may not change application settings for any phones.
• Read Only—any member of the specified AD group can only view phone information
and current application settings. All changes are blocked.
If you have an Active Directory SAM instance then on your first access to the system, an
account number must be entered. Enter the account number sent to your organization via e-mail
from Spectralink.
Note: How to obtain the account number
SAM server licenses are tied to a customer account number, which is entered when
you log in for the first time. You can obtain this number through your Spectralink
representative. Account numbers are sent from the Service Department via email.
After you click the Create Account button, there will be a small delay while SAM initializes its
database. From that point onward you will only be prompted for your Active Directory
credentials.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 20
Logging into SAM via Local Administrator Account
If you set up a standalone SAM instance, the first time you log into SAM you will need to enter
your account number, an administrator account name, and a password. Enter the account
number sent to your organization via e-mail from Spectralink. Your account name can include
any alphanumeric characters except spaces. The same applies to your password but it can also
include special characters.
On subsequent logins, you must enter the administrator account name and password that you
created above. The login prompt looks the same.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 21
If your SAM login session is inactive for 15 minutes, SAM will timeout the session and take you
back to the login prompt again.
Changing the Password
For local administrator account SAM deployments, you may change the administrator password
at any time. The SAM banner displays the SAM username with a settings icon to its right.
Clicking the settings icon opens a menu for Preferences and Logout. Click Preferences.
Reset Password is the second option. Click the Reset Password toggle button then the Save
button. A message will appear explaining that after the next logon, you will be prompted to reset
the password. Click the Logout icon to exit SAM. Log back into SAM using the previous
credentials. You will then be asked for a new password.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 22
Logout
Use the logout icon on the Nav bar to exit the SAM program.
Step 4: Install License
Before deploying phones you should enter your SAM license key. After purchasing SAM you are
sent an account number and license key via e-mail. The account number is used during the
initial setup—the license key is manually pasted into SAM in the License area (see the license
section for further info).
The account number and license key are bound together and must match in order for any phone
licenses to be added to the license pool. If you entered an account number during setup that
does not match the one sent to you, applying your license key will cause an error. In this
situation you must redeploy the VM and step through the setup again using the correct account
number.
Step 5: Install Certificate
SAM installs a self-signed certificate by default. This certificate is used for encrypted interaction
between the SAM server and its phones. It’s sufficient for small, trial, or non-production
environments where security is not an absolute necessity.
However, the self-signed certificate is also used for HTTPS access to the SAM web interface.
Since most modern browsers warn about self-signed certificates and require the user to
approve exceptions, Spectralink recommends that customers obtain a new certificate, signed by
their own root CA or a public CA. SAM provides a mechanism to export a signing request (CSR)
and then import the signed certificate (CRT) back into SAM (see the About SAM section for
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 23
further info). This step should be done before deploying phones since all phones must use the
same certificate to operate with SAM.
721-0055-00_C.docx April 2019 24
Chapter 2: Navigation
Banner
Once logged in, the top banner displays the SAM account name along with a menu for
accessing preferences and logging out. The lower banner displays the area that you are
currently in. It also may include the context in which you are currently editing settings.
SAM has three context levels when editing application settings, as seen in the lower right corner
above: Enterprise, Group, and Device. Each level affects a smaller number of phones and
supersedes the level above. (See more info in the Applications section)
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 25
Navigation Bar
The left navigation bar provides icons to direct you to various features. Clicking any of the icons
will take you to the related area. The navigation bar can be expanded for more detail by clicking
the right arrow.
721-0055-00_C.docx April 2019 26
Chapter 3: About SAM
The About SAM page gives you information about the SAM version, your unique Account Key,
your Spectralink Account Number, and two methods of using the SAM certificate for HTTPS
security. It also provides a mechanism for updating the SAM server.
App Version / Update SAM software
The app version is the software version currently running on SAM. After applying an update, this version number will change.
Deciphering the app version
The app version code includes both the Release version, the VM version and the SAM version.
The App version 1.1.0.527.503 provides this information:
SAM release branch Virtual appliance SAM deploy version
<major>.<minor>.<patch>
1.1.0 .587 .503
The VM version and the SAM version are provided to guide engineering and support in
recreating customer scenarios for testing and development. Please provide all numbers
when contacting Spectralink service. Upon upgrade the minor version and the SAM version
will change. The VM version only changes when the VM is upgraded.
Admin Tip: Updating SAM software
For beta deployment, SAM will require a new installation with a completely new
version of software.
Account Key
The Account Key is a random string of 22 characters, generated by SAM internally. This number
provides additional security for EMM enrollment and is required by the SAM client app
Account Number
The Account Number is a numeric number generated by Spectralink and sent to the customer
for licensing and identification purposes.
SAM server certificate
SAM uses a certificate to establish a secure connection between Versity smartphones and itself.
Clicking the Copy Certificate to Clipboard button allows you to copy the SAM certificate to the
clipboard and paste it into an EMM attribute field for loading onto a Versity.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 27
Cert signing request file
For full deployments, a Certificate Signing Request (CSR) is provided. Using this method, a
private or public CA signs the certificate, which is then imported into SAM.
The root certificate provided by the CA server can be loaded into an EMM, which sends it to the
smartphones, that in turn use it to automatically establish a secure connection with SAM.
Note: Private CA
Our expectation is that most customers will have their own, Private CA. They will
need to import the CSR into that CA and have it signed, then export the signed
request for importing back into SAM. The signed certificate can be copied into an
EMM for delivery to the smartphones as a .crt file.
Upload Signed Certificate (.crt)
Admin Tip: SAM expects an ASCII format file
When using a Windows 2012 CA server, be sure the cert is produced with Base 64
encoding.
1 Copy the now-signed certificate file with a .crt extension into your file system.
2 Log into SAM web interface. Navigate to the About page. Click the “Browse file” button.
Navigate to the .crt file and select it. Click the Open button.
3 After upload is complete, log into the VM host for SAM, change to the bin directory [cd
bin] and run the importCert script [./importCert.sh].
Admin Tip
At this point if you disconnect from and browse back to SAM, and you have the
SlnkEngrCA cert in your PC's trusted Root Store, then you should no longer see
https warnings in your browser.
Upload SAM upgrade file (.zip) and update SAM
1 Obtain the artifacts.zip upgrade file from Spectralink.
2 Navigate to the About page. Click the “Browse file” button. Navigate to the .zip file
location and select the artifacts.zip file. Monitor the progress bar to verify upload
completion.
3 From the console or using SSH to access the VM host, log in (sam/sam). Navigate to the
“bin” directory [cd bin]. Run the upgrade script from the sam account [“./upgrade.sh”].
4 Monitor the output. Near the end you should see messages saying Tomcat is being
restarted. Any errors will be noted at the end of the console messages.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 28
5 The previous browser tab should be closed and re-opened to clear the browser cache.
Request an immediate SAM backup
1 Obtain and load the upgrade file per the steps above.
2 Navigate to the About page. Click the “Backup Now” button and follow the prompts.
Monitor the progress bar to verify completion.
721-0055-00_C.docx April 2019 29
Chapter 4: SAM License
Certain Spectralink products, including SAM, require a license to operate. When you purchase a
license, you receive a license key for each set of licenses you purchase. A purchased “License
Key” contains the account number, the PO number, validity dates, and other information. SAM
parses the information and displays it in the license table. The Identifier is either “demo” for a
demo version or a PO number that is part of the account key.
The first 10 phones do not require the purchase of a license. If you need to manage more than
10 phones, you will be required to purchase a license for each additional phone, sold in blocks.
Your support representative will help you with this purchase. When installing purchased
licenses, the Demo license pool is removed and replaced with the new pool. Existing phones
will draw licenses from the new pool.
Admin Tip: What if the license expires?
Licenses are granted for a year. When a license expires, SAM configuration
becomes read-only until a new license is purchased. Contact your system
administrator and/or Spectralink support team for more information.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 30
Entering licenses
1 Receive an email with the License Key.
2 Enter the License Key. Copy/paste this from the email you received when you made a
SAM license purchase.
3 Click Save. You will see the columns populate with the information from the new License
Key. You should also see the Valid License and Available license counters increase by
the proper amounts.
Applying licenses
Once you enter the license key for additional licenses, navigate to the Device Holding Area and
SAM will now allow you to approve additional devices.
721-0055-00_C.docx April 2019 31
Part III: Implementing the Design
The Spectralink Application Administration Guide is your central reference for all Spectralink
App configuration options. Please refer to it for detailed information about each app
configuration option available to you through SAM.
721-0055-00_C.docx April 2019 32
Chapter 5: Batch Configuration
The Batch configuration tool is used by SAM to bulk provision SIP service requirements, the
PTT display name, and Groups. Settings loaded through the .csv file will override any
enterprise/group level settings. Two CSV templates, one without a group example and one with,
are available from the Batch Configuration area. Click either to download.
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. It sets values at the Device level only. To
remove them, you would have to access each phone in SAM singly and delete each one
manually. 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 first and mandatory.
• You can optionally set the Owner info, which is meant to be used for a convenient SAM-
only identifier when displayed in the Device List.
• The devices can be associated to existing or new groups by setting a Group name.
Multiple Group names can be set, separated by semi-colon “;”.
• If a field has no intended value, leave it blank or remove the entire column. SAM does
not overwrite a value if the cell is blank.
• Any values supplied in this file will take precedence over values you've already entered
at the Enterprise or Group levels. These values are set at the Device level.
Two template batch files are provided---the basic one if you do not deploy group settings and
the group one if you do.
The following settings may be configured. The MAC address and one other field are required, at
a minimum.
MAC address [found on box label or in phone settings]
Device info 1-4 [phone user name and other info]
Group name(s) [SAM Group name list separated by a semi-colon ;]
SIP extension number phone sip1_extension string
SIP username phone sip1_username string
SIP password phone sip1_password string
SIP secondary extension number phone sip2_extension string
SIP secondary username phone sip2_username string
SIP secondary password phone sip2_password string
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 33
PTT caller ID slnkptt username string
Note: Batch file examples
Two batch .csv files are available online. Please refer to them for examples of how
to configure the batch files for your facility.
MAC address
List the MAC address of each Versity you will be deploying. The MAC address may be found on
the packaging box, on the label underneath the battery, or by opening the Settings app and
navigating to System->About phone->Status.
Entry criteria
Type 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
Default none
Unique? Yes. Every smartphone has a different MAC address
Required? Yes
Level Device
Notes: See above
Device info 1-4
The owner info is the name that displays in the Device List in SAM.
Entry criteria
Type Text field
Default none
Unique? Not necessarily
Required? No
Level Device
Notes: See above
Group name
You may assign each smartphone to a Group. By naming a Group here, SAM will create a
Group by that name.
Entry criteria
Type Text field
Default none
Unique? No
Required? No
Level Device
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 34
Notes: 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, [email protected]). 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 Text field.
Default none
Unique? Yes. Every smartphone has a different extension.
Required? Yes
Level Device
Notes: See above
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 Text field.
Default none
Unique? Yes. Every smartphone has a different SIP username.
Required? No
Level Device
Notes: See above
SIP password
The SIP digest authentication password to be used for SIP registration.
Entry criteria
Type Text field
Default none
Unique? Yes
Required? No
Level Device
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 35
Notes: See above
SIP secondary…
If using a secondary registration, enter the information using the same entry criteria as for the
first registration.
PTT caller ID
You can specify a caller ID for PTT broadcasts. This could be entered by device or by group.
Entry criteria
Type Text field.
Default none
Unique? Not necessarily
Required? No
Level Device or Group
Notes: See above
Steps for Creating the .csv File
1 Either download a template from SAM or create a new spreadsheet in Excel®, following
the guidelines and examples above and in the provided templates.
2 Add one row for each phone with its specific information.
3 Save as a .csv file.
Upload .csv to SAM
1 Open SAM and click the Batch Configuration icon in the sidebar.
2 Click the “Browse Batch Files” button, navigate the file system to the CSV file you
created, select it and click Open.
After you upload the .csv file to SAM, any previously approved phones included in the CSV will
get updated on the phone’s next heartbeat. Any phones not already approved or unknown to
SAM will get updated after they have been approved and send a heartbeat. This could occur on
the normal heartbeat interval, when an inactive smartphone becomes active, or when a
smartphone boots up.
721-0055-00_C.docx April 2019 36
Chapter 6: Versity Devices
The Device page has two options – the Device Holding Area and the Device List.
The Holding Area
The Device Holding Area is the place where devices are approved for management, temporarily
rejected, or deleted completely from the system. Initially this area displays Pending phones—
phones that have presented themselves to SAM but have not yet been approved. Devices that
have been manually configured through the Sam Client app or configured via EMM first appear
here. Once a pending phone is approved, SAM sends all appropriate settings to the phone and
locks the phone’s app settings so that users cannot alter them.
Once you have configured a phone to connect to SAM, it may take up to a minute to appear in
the Pending area. If it does not appear, check the Sam Client app on the phone to verify
settings. Open Sam Client by tapping the icon. From the overflow menu select Settings. The
SAM URL should be using HTTPS (e.g. https://172.29.76.20). The account key, a 22-character
random string, should exactly match that found in the About SAM area. The heartbeat switch
should be enabled. Also the phone must have the SAM server’s certificate installed. Verify with
your EMM that it’s sending the proper certificate and settings..
Approving Devices
You approve Pending phones to begin managing them with SAM. A SAM license is required for
each. If you have used all available licenses and then attempt to approve an additional device,
you will see a message to contact your service provider for purchasing additional licenses.
Using the displayed MAC address, the administrator can identify the device using the Versity
Implementation Plan (VIP) as described in the Versity Deployment Guide. Click the checkbox
beside the target phone and select either Approve Device(s) or Reject Device(s) from the
Select actions menu. Clicking the checkbox in the title bar allows you to select all phones in the
Pending area, whether visible or not. If you reject a phone, it will not receive settings and will
remain in the Rejected area indefinitely. If you approve a phone, it will move to the Approved tab
and will also be visible in the Device List.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 37
Rejecting Devices
You can reject a phone from either the Pending or Approved tabs. Click the Approved tab to see
the list of devices already approved. Click the checkbox beside the target phone and select
Reject Device(s) from the Select actions menu to move the phone under the Rejected tab.
If you reject a Pending phone, it never receives any further configuration settings from SAM and
does not use a license.
If you reject an Approved phone, the phone no longer receives updates but retains its last
settings. Rejecting a previously approved phone also returns its license to the license pool,
allowing you to add another phone. The settings for a rejected phone remain in the database so
that if you approve it again, it will get its previous settings along with any changes since it was
rejected.
Deleting Devices
You can delete a phone from the Rejected tab. Click the Rejected tab to see the list of devices
previously rejected. Click the checkbox beside the target phone and select Delete Device(s)
from the Select actions menu to remove all device level settings set on that specific phone
from the database. SAM essentially forgets that the device ever existed.
If you do not reset the phone to factory settings as well, it will continue trying to contact SAM
and will appear again in the Pending list after some period of time.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 38
Approving Devices
Using the displayed MAC address, the administrator can identify the device using the Versity
Implementation Plan (VIP) as described in the Versity Deployment Guide. The Select actions
menu allows the administrator to approve or reject devices in this list.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 39
Device List
The Device List is a list of all devices that have been Approved in SAM. Once devices appear in
the device list, they are managed by SAM.
The displayed columns can be moved by clicking and dragging them. Columns can be hidden or
displayed by clicking the Change Columns button. Enabling various headings causes them to
appear at the end of the existing columns. Disable columns to suppress them in the Device List.
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 menu. Select the desired action:
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 40
• Change config: Typically used when a single phone needs unique configuration
parameters. This action will open the Applications page in the device context, meaning
that only the selected phone will receive changes.
• Re-apply config: Causes SAM to resend its entire configuration on the next heartbeat.
Used when a phone has been reset to factory settings and reconnected to SAM. Also
needed when a phone has been out for repair.
• Trigger heartbeat: Immediately forces the Versity smartphone to heartbeat into SAM.
Usually used when a configuration parameter has changed or a software update is
needed and the administrator wants to deploy them without delay.
Use this option sparingly when doing a software update (1GB+) as it could negatively
affect Wi-Fi network performance for large phone deployments with few access points.
• Export all devices: Exports all accepted devices to a .csv file with a subset of
configuration parameters for identification purposes.
Note: Heartbeat Interval
Versity smartphones check into SAM using a “heartbeat.” The minimum heartbeat
interval is 15 minutes and maximum is 24 hours. It’s set in the Sam Client app
when first connecting the phone to SAM. At the heartbeat, the phone asks SAM for
any configuration changes and SAM sends them back, taking effect immediately.
An administrator can select any single device or many devices from the Device List
and force a heartbeat if necessary. See Device List actions below.
A smartphone will heartbeat at longer intervals while it is inactive. An immediate
heartbeat can also be forced using the smartphone SAM client application.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 41
Re-Deploying Devices
SAM is designed to be the primary configuration method for all Spectralink applications. If the
Erase all data (factory reset) option has been selected from the Android Settings app on the
smartphone, Spectralink recommends re-provisioning the smartphone per the steps below.
Admin Tip: Reconfiguring smartphones
This re-deploying technique is an efficient way to remove all Device level settings
from a smartphone and reset it to the Enterprise settings.
To re-configure a device after restore defaults:
1 Go to the Approved tab in the Device Holding Area, click the smartphone, and select
Reject Device(s) from the action menu to move it to the Rejected list.
2 Click the Rejected tab. Select Delete Device(s) from the action menu to remove device
level settings for the device.
3 On the phone, open the Settings app. Navigate to System->Reset Options. Tap Erase
all data and follow the prompts.
4 Setup the phone by either using the NFC bump from an EMM master device or
configuring it manually as device owner. You may need to delete it from the EMM for this
step. After it enrolls, the smartphone will associate with SAM and show up in the
Pending list.
5 Approve the smartphone in SAM. After it is re-approved, it will receive the Enterprise
settings. It now shows up in the Device list and can be configured.
721-0055-00_C.docx April 2019 42
Chapter 7: Copy Configuration
When you wish to configure a replacement smartphone, Copy Configuration allows you to move
device-level settings from one Versity phone to another.
How to copy configuration:
1 Select the source device:
a Click Select Device to bring up the Device List screen.
b Select the smartphone with the settings that you wish to use as the source or
origination device, based on its serial number or MAC address.
2 Select the target device:
a Click Target Device to bring up the Device List screen and select the smartphone to
which you will copy settings.
or
b Enter the target device’s MAC address in the MAC address field. If this device is not
is the Device List, you just need to know its MAC address. The target device will get
its settings after it is approved in SAM.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 43
3 Click Copy Config to copy the device-level settings of the source device to the target
device to complete the configuration transfer.
721-0055-00_C.docx April 2019 44
Chapter 8: Versity Groups
Being able to group devices and customize configurations for device groups gives you
tremendous flexibility in your deployment options. Groups are commonly used for splitting
phones between SIP servers, offering different PTT channel lineups, or department contacts. It
can also be used for simple distinction by building, department, or retail area. Group settings
override any identical Enterprise level settings already established.
On this page you can create new groups, add devices to a group, change existing groups, and
edit a group’s configuration. Groups can also be established and assigned in a Batch
Configuration file. You may have an indefinite number of groups, and each device may belong
to multiple groups.
Create new Groups
1 Enter the group name.
2 Click Select Devices to open the device selector panel.
3 Click the checkbox next to devices that should become members. Click the Select
Device button to finish choosing phones.
4 The selected devices appear below the button, each with their own box. To remove one
or more, click the x at the right of any box.
5 Click Save. Use the Reset button to clear the Group name and members and start over.
Configure or change Group settings
Once Groups are established, they will need to be configured with the parameters that they
need. Click the checkbox next to the target group then select Change Config from the Actions
menu. The Applications page will open in the group context.
Configure the applications for this Group, remembering to Save the configuration before you
leave the Applications page. A page with unsaved parameters will display a blue dot.
Prioritize Groups
A device may belong to multiple groups but restraint should be used. Groups are prioritized by
position in the Groups table. The first row has precedence over every row below it. The second
row has precedence over every row below it and so forth. The senior group’s setting will
override any conflicting junior group’s setting. As such if you define the same setting in multiple
groups and the phone belongs to all of them, the top group’s setting will be applied. However, if
you have a particular setting that is missing from a higher group but not a lower group, the lower
group’s setting will still apply. This may create complexity when trying to predict which group
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 45
setting will be applied. Spectralink recommends that you separate phones into groups with
unique settings, which will prevent confusion.
Groups can be created using a Batch Configuration file. Any groups that do not already exist are
created after import. The Versity phones listed in the file are automatically added into the
specified group so that they receive group settings. Those groups will then appear in the SAM
Manage Groups list.
721-0055-00_C.docx April 2019 46
Part IV: Applications
Spectralink applications perform specialized functions for the enterprise environment. They can
be tailored to specific criteria in these pages.
Barcode
Barcode capture is available on the 9553 and 9653 models.
Battery Life (Batt Life)
Batt Life helps the user manage battery use by allowing a specified charge
level to begin low battery alerting.
Biz Phone
The Biz Phone app is Spectralink’s SIP telephony application for Versity
devices.
Buttons
The Buttons app is Spectralink’s application to allow users to program the
buttons on Versity devices
Device
The Device Settings app is Spectralink’s application that provides additional
controls for the system administrator for Versity devices.
Lens Grid
The Lens Grid app is Spectralink’s application to apply a standardized grid to
the on board camera for precise measurement of objects using Versity
devices.
Logging
The Logging app is Spectralink’s application for the management of syslog
information by the system administrator for Versity devices.
PTT
The Push-to-talk (PTT) app is Spectralink’s radio multicast app for Versity
devices.
SAFE
The SAFE app is Spectralink’s application for emergencies. It can be deployed
in lone worker environments or where facilities require extra security.
Sys Updater
The Sys Updater app is Spectralink’s application to check for software updates
for Versity devices.
VQO
Voice Quality Optimization (VQO) app is Spectralink’s application for
optimizing audio and video calls from Spectralink dialers or other third-party
dialers.
Web API
The Web API app is used by developers to interface with external services and
provide links to frequently used websites.
Custom Apps
Custom Apps allow you to make your own app for SAM to manage.
721-0055-00_C.docx April 2019 47
For more information on app settings, see Spectralink Application Administration Guide.
Allow/Disallow
The Allow and Disallow enable or prevent (respectively) the user from making changes to the
listed fields on their phone—allow gives the user the power to override the SAM settings. In the
case of allowing an override, the SAM settings are still sent initially but are not enforced.
Saving the configuration
Each SAM configuration page has a set of Save/Cancel buttons at the bottom.
• Cancel—clears changes but remains in the page.
• Save Configuration—saves any changes to the database. Any affected phone will get
the changes when it next heartbeats in.
• Send Configuration Now—saves any changes to the database and also triggers a
heartbeat for the affected phones so they pick up the changes “Now”.
Admin Tip: SAM is designed for one administrator at a time
If more than one administrator is logged into SAM, a collision of configuration
parameters might occur.
If you are an administrator and making changes to SAM parameters and another
administrator is also making changes in the same page, you will see a message
like this: New configuration changes: Click here to load settings. Clicking will
refresh the page with the other administrator’s settings, overwriting your changes,
which you may enter again.
Blue dot
If an app icon displays a blue dot, it means that there are unsaved configuration parameters.
Save parameters before exiting the Applications page. Exiting without saving will erase the
changes.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 48
Updating applications
Applications are delivered with the Versity software updates. When the Versity software update
is downloaded and installed on the smartphone, any application updates are also received and
installed..
Understanding Enterprise, Group and Device Levels
There are three ways to get to the Applications 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 Applications page—not
going through the Group page or the Device List. The banner displays the Enterprise tab.
The Enterprise level is used to make changes to all approved phones. You would use this level
to set application settings that are common to every phone you manage. At the Enterprise level,
settings from other levels are not visible. Conversely, when editing settings in the Group or
Device levels, settings from the Enterprise level will be visible.
Various icons next to each individual setting indicate the various states in which they can be.
The possible icons for the Enterprise level are listed below. Some icons are clickable. Clicking
the trash can immediately deletes the setting at the current level. Note that some settings do not
support the level icons.
Level icons
“DEFAULT” indicates that the current value has not changed from the default value.
The trash can icon indicates that a non-default value has been saved at the current level. Click to delete value.
Group settings
Group level settings are available when you browse to the Group page, select a Group and
select Change Config from the menu. The banner displays the Group tab.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 49
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 more than one Group. If there are conflicting settings, the Group
that is listed in the Group table closer to the top of the table has settings priority.
Level icons
“DEFAULT” indicates that the value has not changed from the default value at any level.
Click the note icon to edit the value at the current level.
The phone group icon indicates that a value has already been set at the Enterprise level.
The Group indicates that a value will be set at the Group level.
Click the undo icon to undo an updated value back to the previous level’s value.
The trash can icon indicates that a non-default value has been saved at the current level. Click to delete value.
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 menu. 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.
Level icons
“DEFAULT” indicates that the value has not changed from the default value.
Click the note icon to edit the value at the current level.
The phone group icon indicates that a value has already been set at the Enterprise level.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 50
The Group icon indicates that a value has already been set at the Group level.
The phone icon indicates that a value will be set at the Device level.
Click the undo icon to undo an updated value back to the previous level’s value.
The trash can icon indicates that a non-default value has been saved at the current level. Click to delete value.
Example
Let’s say you want to inspect more closely a particular smartphone that is behaving strangely.
You can alter the logging settings at the Device level for that phone only, setting it 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.
Custom Attributes
The Custom Attributes feature is used to deploy application parameters and features that have
been developed by Spectralink but are not yet available in the SAM GUI. All custom attributes
are listed under the application and may be edited and deleted as needed.
Click the + symbol to expand the option:
The “key-value pairs” are entered in this screen. Key-value pairs can be found in the
Applications Administration Guide, available online at the Spectralink support site. See
Appendix A: Spectralink References.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 51
Users are strongly recommended to use this feature at their discretion. Here are a few pointers:
• You can enter a custom attribute value to an existing attribute with a dedicated UI field.
Due to the evolving nature of apps, an app may expect a field that has not been
programmed in the SAM GUI yet.
• Custom attributes can be edited. All custom attributes are listed under the application.
Simply return to the list and make the changes to the key or value. Make changes to the
level by using the Device, Group, Enterprise tab. Save the configuration when finished
editing.
• Custom attribute values can be deleted at all levels. When deleted, a device will get the
following value for the option.
○ blank for string
○ false for boolean
○ 0 for integer
• Value checking is not done. If an incorrect value is entered (for example you enter an
integer when it should be a string or vice-versa), it can be edited per above bullets.
Caution: Beware of conflicting parameters
It would be possible to configure conflicting parameters when deploying custom
attributes. This is not a foolproof system. Custom attributes that are programmed
for any given app will be saved whenever one of the Save buttons is clicked,
whether or not there is some internal conflict.
721-0055-00_C.docx April 2019 52
Chapter 9: Custom Apps
Custom Application is a new feature that is under beta trials which Spectralink is releasing in
this version as it may prove useful to certain facilities.
Custom Apps works like Custom Attributes. Please see Custom Attributes for more information.
721-0055-00_C.docx April 2019 53
Chapter 10: Barcode
Versity models 9553 and 9653 have built-in barcode readers, others do not. If a Versity does not
have a Barcode reader then these settings are ignored.
On this page, you can enable the barcode reader and set the symbologies you will be using.
Barcode is enabled by default, along with all symbologies.
Symbologies are listed in two sets. The first set can either be switched on or off. The second set
have additional settings that apply if the symbology is switched on. These can be changed by
clicking the arrow icon.
Admin Tip: Barcode settings
Barcode settings are fully covered in the Spectralink Applications Administration
Guide. Please refer to that document for full explanation of this application.
Supported Symbologies Aztec
Codabar
Code 11
Code 32
Code 39
Code 93
Code 128
Data Matrix
Data Matrix Inverse
EAN8
EAN13
GS1 Databar 14
GS1-128
Han Xin Code
Interleaved 2 of 5
Inverse 1D
Matrix 2 of 5
Micro PDF417
Micro QR
MSI Plessy
PDF 417
QR
QR Inverse
UPC-A
UPC-E
General Settings
The first set of options provide global settings for barcode that apply to every symbology.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 54
Enable barcode scanner
If not enabled, the rest of the settings are not active.
Entry criteria
Type Checkbox
Default Enabled
Unique? No
Required? Yes for barcode scanning
Level Enterprise or Group
Notes:
Illumination power
The intensity of the scan light.
Entry criteria
Type Integer. Enter a value 0-10
Default 5
Unique? Yes
Required? Depends on the lighting.
Level Device
Notes:
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 55
Decode Session Timeout
How long you allow for the scanner to complete decoding the scanned code.
Entry criteria
Type Integer. Enter a value 5-99
Default 50
Unique? Yes
Required? Yes
Level Any, usually Group
Notes: Measured in tenths of a second. I.e. default value 50 = 5.0 seconds.
Automatic carriage return
The Enter key may be used to move to the next field to be populated by scanning by enabling
this option.
Entry criteria
Type Radio button
Default Disable
Unique? No
Required? No
Level Any
Notes: See above
Scan success indicators
Vibrate / Sound
Entry criteria
Type Radio button
Default Allow
Unique? No
Required? No
Level Any
Notes “Vibrate” or “Play a sound” “ on successful scan” in AAG
Scan Success Sound
Entry criteria
Type Dropdown selectable
Default Low pitch beep
Unique? No
Required? No
Level Any
Notes: “Successful scan sound” in AAG
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 56
Symbology settings
Symbologies that are enabled/disabled only
Symbologies that have sub-options
Click the arrow to display the sub-option window and configure the sub-options. Sub-options are
pre-configured at the default value. Barcode options can be found in the Applications
Administration Guide, available online at the Spectralink support site. See Appendix A:
Spectralink References.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 57
Example of sub-option menu
Note: Deprecated barcode symbologies
If you are deploying Versity in a mixed environment with Spectralink PIVOT or other
barcode readers, be aware that some previously offered symbologies have been
deprecated due to aging technology. These are: Code 49, Grid Matrix, Hong Kong
2 of 5, IATA 2 of 5, NEC 2 of 5, Plessy, Straight 2 0f 5, Telepen.
721-0055-00_C.docx April 2019 58
Chapter 11: Batt Life
The Batt Life application displays the current condition of the battery and allows the user to
adjust charge alerts and other parameters and metrics. The configurable parameters are
controlled by the user unless otherwise set in SAM.
Enable Battery Monitoring
Entry criteria
Type Checkbox
Default Disabled
Unique? No
Required? Yes for battery monitoring
Level Any
Notes:
Vibrate/Sound
Entry criteria
Type Checkbox
Default Enabled
Unique? No
Required? Yes for battery monitoring
Level Any
Notes:
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 59
Low Battery Threshold
Entry criteria
Type Dropdown selectable
Default 15%
Unique? No
Required? No
Level Any
Notes: 15% or 20% are the options
Snooze Time
Entry criteria
Type Dropdown selectable
Default 2 minutes
Unique? No
Required? No
Level Any
Notes: Options are 1-5 minutes
Alarm Tone
Entry criteria
Type Dropdown selectable
Default Cesium
Unique? No
Required? No
Level Any
Notes: List of available tones from Android
721-0055-00_C.docx April 2019 60
Chapter 12: Biz Phone
The Biz Phone app is Spectralink’s SIP telephony application. The following settings may be
configured when using a SIP telephony server.
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 Checkbox
Default Disable
Unique? No
Required? Yes, for telephony function
Level Enterprise
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 61
Notes: Must be enabled manually at the Enterprise level for facility-wide telephony functioning
Registration 1 and 2
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
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 62
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. if you
configure a DNS SRV record that returns a port number it will override the port value you configured
in the SIP Settings.
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], 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
Required? Yes, for telephony function
Level Enterprise
Notes: Must be set manually at the Enterprise level for facility-wide telephony functioning
SIP server port
The port value entered here must match the port used in the SIP server to accept connection
requests.
Entry criteria
Type Integer. Accepts 0, 1 to 65535
Default 5060. Leaving this value blank will enter the default value.
Unique? No
Required? Yes, for telephony function
Level Enterprise
Notes: 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 Versity 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. if you configure a DNS SRV record that returns a port number it will override
the port value you configured in the SIP Settings
Transport
The network transport protocol. Use UDP unless recommended otherwise.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 63
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 Dropdown selectable: UDP, TCP
Default UDP
Unique? Yes
Required? Yes, for telephony functioning.
Level Device
Notes: 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 Text entry. Configurable through .csv.
Default None
Unique? Yes
Required? Yes, for telephony functioning.
Level Device
Notes: Must be set at the Device level for smartphone telephony functioning.
Example
If the extension is 1002, the Address of Record would become [email protected] where
1002 is the extension number and Spectralink.com is the server value set above.
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 Text entry. Configurable through .csv.
Default None
Unique? Yes
Required? Yes, for telephony functioning.
Level Device
Notes: Must be set at the Device level for smartphone telephony functioning.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 64
Password
The SIP digest authentication password to be used for SIP registration.
Check the Show Password checkbox to see the entry.
Entry criteria
Type Text entry. Configurable through .csv.
Default None
Unique? Yes
Required? Yes, for telephony functioning.
Level Device
Notes: Must be set at the Device level for smartphone telephony functioning.
Voicemail retrieval address
The number to dial to retrieve voicemail messages.
Admin Tip
Many call servers will send this information in the Message-Account field of the SIP
Notify messages to the Spectralink smartphones 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 voicemail system, then populate this field with the number to dial to retrieve a voicemail message (the Voice Mail system’s pilot number.). Invites will be sent to: voicemail_retrieval_address@Server
Entry criteria
Type 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 [email protected])
Default None
Unique? No
Required? Maybe, see Admin Tip
Level Enterprise
Notes: Must be set manually at the Enterprise level for facility-wide voicemail functioning.
Example 1: if Server is defined as 192.168.20.1 and Voicemail retrieval address is defined as 6416, Invites to voicemail will be sent to [email protected]
Example 2: If Server is defined as a DNS SRV record that resolves to an IP address (e.g. 192.168.0.1), and Voicemail retrieval address is set to [email protected], then Invites to voicemail will be sent to the IP address 192.168.0.1 with a To: address of [email protected]
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 65
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 0.0.0.0 when
initiating hold)
Entry criteria
Type Checkbox
Default Enabled
Unique? No
Required? Yes, for telephony function
Level Enterprise
Notes: 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 send 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 Versity 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
Disabled: The smartphone will not send a separate SIP Subscribe notification to the Server
address for message waiting Notifications
Entry criteria
Type Checkbox
Default Disabled
Unique? No
Required? See above
Level Enterprise
Notes: 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 port values
contained in the Via of the 200 OK response to SIP Registration. Versity will then renew the SIP
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 66
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 Checkbox
Default Disabled
Unique? No
Required? See above
Level Enterprise
Notes: See above
Specify new TCP port in contact header
This parameter is disabled by default.
If enabled, it causes the smartphone to open a new listening port for TCP and put that port
number in the contact header field. This parameter should be enabled if the phone will be
integrated against a SIP Proxy rather than a SIP (B2BUA) Back to Back User Agent.
Entry criteria
Type Checkbox
Default Disabled
Unique? No
Required? See above
Level Enterprise
Notes: See above
Use vendor protocol if licensed
Only applies to Cisco SPP phones. It's enabled by default which means that the phone supports
the signaling to work with CUCM. If this is turned off then all the special Cisco signaling is
disabled – the phone works like a non-Cisco SPP phone.
Entry criteria
Type Checkbox
Default Enabled
Unique? No
Required? See above
Level Enterprise
Notes: See above
Allow call forwarding
The administrator can determine whether the phone is allowed to activate call forwarding. If this
is turned off then you don't see Call Forwarding in the app menu.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 67
Entry criteria
Type Checkbox
Default Enabled
Unique? No
Required? See above
Level Enterprise
Notes: Not available for SIP Registration 2
Cisco Solution Partner Program
Cisco-enabled Versity smartphones can use SAM to deploy additional features as programmed
in the CUCM server with COP file. See Appendix A: Spectralink References.
Admin Tip: Enable Vendor Protocol option
Enable the Use Vendor Protocol If Licensed option in the Registration 1 settings to
use Cisco configuration options.
Allow iDivert
This feature allows the user to redirect (or divert) calls to the Voicemail system as programmed
in the CUCM server with COP file.
Entry criteria
Type Checkbox
Default Enabled
Unique? No
Required? See above
Level Enterprise
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 68
Allow call park
Cisco supports several variants of the Call Park feature as programmed in the CUCM server
with COP file.
Entry criteria
Type Checkbox
Default Disabled
Unique? No
Required? See above
Level Enterprise
Notes: See above
Allow hunt group login/logout
Hunt groups can be configured to allow the user to log in and log out. Enable this option if you
want hunt group members to have this choice.
Entry criteria
Type Checkbox
Default Disabled
Unique? No
Required? No
Level Enterprise or Group
Notes:
Voicemail enable
Both traditional and visual voicemail can be deployed with Versity as programmed in the CUCM
server with COP file.
Entry criteria
Type Checkbox
Default Disabled
Unique? No
Required? Yes for barcode scanning
Level Enterprise or Group
Notes:
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 69
Common settings
Audio DSCP
Specify the DSCP of packets. This value should be a decimal number. The default DCSP is 46.
Leaving this value blank will enter the default value. This field accepts decimal values from 0 to
63.
Entry criteria
Type Enter a decimal number. Accepts: 0 to 63 decimal.
Default 46
Unique? No
Required? Yes, for telephony function
Level Enterprise
Notes 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.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 70
Entry criteria
Type 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)
Default 0x2e
Unique? No
Required? Yes, for telephony functioning.
Level Enterprise
Notes Must be set manually at the Enterprise level for facility-wide telephony functioning
Override automatic switch from UDP to TCP
Section 18.1.1 of SIP RFC3261 mandates that SIP packets exceeding 1300 bytes in size should
switch their transport protocol from UDP to TCP automatically. If this parameter is enabled
Versity will no longer switch to TCP for packets greater than 1300 bytes. This parameter should
be left disabled unless the SIP Server does not honor the RFC or unless you are advised to
change this by Spectralink support personnel.
DTMF relay payload type
Spectralink recommends leaving this value at the default setting (96) unless the far end will not
accept DTMF payload types of 96 and fails to respond to invites with the service delivery
platform (SDP) payload value it requires. Entering a different value allows the RFC2833 DTMF
telephone-event payload type advertised in the SDP of SIP messaging to be modified. Value
should be a decimal number (no leading characters).
Entry criteria
Type Enter a decimal number. Accepts: 96 to 127 decimal.
Default 96
Unique? No
Required? Yes, for telephony functioning.
Level Enterprise
Notes Leaving the Default value field blank will enter the default value.
Note: Telephone-event payload values
The handset will honor the SDP telephone-event value returned by the called party for
DTMF payload negotiation, and will match the SDP telephone-event payload value type
of received invites, but modifying this parameter will change the telephone-event
payload type the endpoint advertises in initial invites
Force In-band DTMF tones
This parameter is disabled by default. The handset advertises support for RFC2833 through the
SIP SDP telephony event parameter.
If enabled, the handset will not advertise support of the telephony event parameters in the SIP
SDP, and will result in In-band DTMF tones rather than RFC2833 tones.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 71
Note: Reversion to In-band DTMF
Versity will revert to In-band DTMF if telephony event packages are not advertised
in the SDP of the far end, regardless of the setting of this parameter.
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. Options:
• G.711u
• G.711a
• G.729a
• G.722
Entry criteria
Type Checkbox to select and arrows for re-prioritization
Default G.711u = 1 and G.711a = 2. The other two codecs are disabled by default.
Unique? No
Required? Yes, for telephony function
Level Enterprise
Notes: Must be enabled manually at the Enterprise level for facility-wide telephony functioning
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 72
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 Applications Administration Guide
721-0055-00_C.docx April 2019 73
Versity smartphones currently support the following LDAP servers:
• Microsoft® Active Directory®
• Open LDAP Directory Server 2.4.12
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 4510 - 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.
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 Text fields accepts: dotted-decimal IP address or hostname or FQDN
Default None
Unique? No
Required? Yes
Level Enterprise, usually but may be set at any level.
Notes: 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).
Entry criteria
Type Text field. Accepts 0, Null, 1 to 65535
Default 389
Unique? No
Required? No
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 74
Level Enterprise, usually but may be set at any level.
Notes: See above.
Communication security type
If you are using encryption, select the type: SSL, None, Start TLS
Entry criteria
Type Dropdown list
Default None
Unique? No
Required? See above
Level Enterprise, usually but may be set at any level.
Notes: See above
LDAP Bind DN
Distinguished Name for the site. An LDAP representation of the name of your domain. You may
include the CN for the admin.
Entry criteria
Type Text field
Default None [blank] (leave empty for entire site)
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
LDAP Bind PW
For OpenLDAP, a password is used to access the directory.
Entry criteria
Type Text field
Default None [blank] (leave empty for anonymous)
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
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 Text field
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 75
Default None [blank] (leave empty for entire site)
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
Primary email attribute
In your implementation of LDAP, what attribute are you using for the primary email addresses of
your contacts? E.g. mail or msExchxxx.
Caution: The “mail” attribute should be validated against an email server
The “mail” attribute may be a text field on the LDAP server and might not contain a
valid email address. Be sure to verify email addresses against an email server in
order to ensure that valid email addresses are being provided to smartphones.
Caution: Use attributes that are populated by a single email address only
Certain LDAP attributes may contain multiple emails—such as a primary address
and a number of alias addresses. Use an attribute that provides only a single email
address.
Entry criteria
Type Text field
Default none
Unique? No
Required? Yes if you are using LDAP
Level Enterprise, usually but may be set at any level.
Notes: See above.
Alternate email attribute
A different field used for email addresses. For instance, you might have multiple mail servers or
some contacts may use some other email address.
Entry criteria
Type Text field
Default none
Unique? No
Required? Yes if you are using LDAP
Level Enterprise, usually but may be set at any level.
Notes: See above.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 76
Emergency Contacts
Warning: Power failure may prevent call functionality
The Versity 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.
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.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 77
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 Text fields
Default None
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
721-0055-00_C.docx April 2019 78
Chapter 13: Device Settings
Device Settings allow you to set additional parameters that do not belong to any particular app.
Enable device settings
Entry criteria
Type Checkbox
Default Disabled
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 79
Unique? No
Required? Yes to use device settings
Level Enterprise
Notes:
NTP server address
For devices that are not connected to the internet and therefore getting their time from Google
or some other cloud server, a local time server should be deployed. LTE phones with a SIM
card use time server provided by Google.
Entry criteria
Type Text field, usually IP address is entered here
Default None
Unique? No
Required? Yes for an NTP server
Level Enterprise, usually but may be set at any level.
Notes: See above.
Wi-Fi and Airplane mode toggles
Entry criteria for all the following radio buttons
Type Radio button
Default Allow
Unique? No
Required? No
Level Any
Notes: See notes for each option
In certain situations you may not want users to disable Wi-Fi or enter Airplane mode. If you
allow the toggle, you allow users to enable or disable these features at will. The toggle is
enabled by default.
Time
Allow time zone configuration
If enabled, the time zone can be manually changed on the phone by the end-user from
Settings>System>Date & Time.
If disabled, the time zone cannot be manually changed on the phone by the end-user.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 80
Allow time format configuration
If enabled, the time format can be manually changed on the phone by the end-user from
Settings>System>Date & Time> Use 24-hour format.
Allow auto timezone configuration (LTE only)
If enabled, the automatic time zone toggle can be manually changed on the phone by the end-
user from Settings> System> Date & Time> Automatic date & time.
If disabled, the automatic time zone toggle is not allowed to be manually changed on the phone
by the end-user.
Note: LTE only parameters in Wi-Fi phones
Wi-Fi models ignore any LTE-only parameters.
Automatic timezone (LTE only)
A toggle that when enabled will use the network provided time zone.
Time zone
The Time zone option allows the administrator to set the timezone facility-wide. It provides drop-
down list of all the available time zones. Unset/Deferred option will leave this setting up to the
user.
Time display format
A drop-down list of the options: 'Unset/Deferred', '12 Hours', and '24 Hours'. Unset/Deferred
option will leave this setting up to the user.
Device Info
Display device info
The Device info options provide further information about the owner of the phone. When
enabled, the text in Device info 1-4 is shown in a notification on the lockscreen. This is useful to
show people who pick up devices who the device belongs to, e.g. “Nursing Team”, “West Wing.”
“4th Floor”, “Smith Building”.
Entry criteria for all the following radio buttons
Type Radio button
Default Disabled
Unique? No
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 81
Required? No
Level Any
Notes: See notes for each option
Device info 1-4
Text boxes are provided for entries. This information can be configured for each device in the
.csv file.
Entry criteria
Type Text field
Default None [blank]
Unique? No
Required? No
Level Device
Notes:
721-0055-00_C.docx April 2019 82
Chapter 14: Lens Grid
The Lens Grid app is Spectralink’s application to apply a standardized grid to the on-board
camera for consistent measurement of objects using Versity devices. It is not a precision
instrument but is a helpful guide for a general record of change over time.
Enable lens grid
Entry criteria
Type Checkbox
Default Disabled
Unique? No
Required? No
Level Enterprise or Group
Notes:
Lens grid size
Determines the size of the grid. Consistency in grid size from one photo to the next will provide
a stable comparison.
Entry criteria
Type Dropdown selectable
Default auto
Unique? No
Required? No
Level Any
Notes: 6 available options: 1cm to 5”
721-0055-00_C.docx April 2019 83
Chapter 15: Logging
The Logging app allows you to configure a syslog server to precise log captures. A syslog
server provides valuable logging information about the smartphone’s operation. The Logging
app also provides debugging tools under the Advanced Debugging tab. Complete information
about the options offered by SAM can be found in the Applications Administration Guide,
available online at the Spectralink support site. See Appendix A: Spectralink References. Only a
brief summary is offered here.
Spectralink recommends: Set up a syslog server We recommend that you set up a syslog server as part of your initial deployment.
Caution: LTE phone should not use logging
Logging requires a fair amount of data usage. When LTE phones are using data on
the cellular network, they can easily exceed their limit. Therefore, disable logging
on LTE phones while using an LTE data connection.
Syslog
Syslog settings can be set at an Enterprise, Group, or Device level. Messages are buffered in
the smartphone and can be retrieved through a USB download.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 84
Enable syslog
Entry criteria
Type Checkbox
Default Off
Unique? No
Required? No. Default will be used if left blank.
Level Enterprise, usually but may be set at any level
Notes:
Server address
IP address of the syslog server, or the relevant DNS name.
Entry criteria
Type Text field
Default None
Unique? No
Required? Yes, for syslog server functionality
Level Enterprise, usually but may be set at any level
Notes: See above
Server port
Entry criteria
Type Numeric value. Accepts 0, 1 to 65535
Default 514. Leaving this value blank will enter the default value.
Unique? No.
Required? Yes, for syslog server functionality
Level Enterprise, usually but may be set at any level
Notes:
Logcat parameters
Enter the string for filtering per https://developer.android.com/studio/command-line/logcat.html
Entry criteria
Type string
Default *:w (warning level)
Unique? No
Required? Yes, if using a syslog server
Level Enterprise, usually but may be set at any level
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 85
Advanced Debugging
Advance debugging options allow you to access technical debugging utility features on the
Versity smartphone, including capturing a bug report. The various options are summarized here.
Various complexities and usage notes are explained in the Spectralink Applications
Administration Guide, Logging section. Please refer to that document for more information.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 86
Advanced debugging password
Entry criteria
Type string
Default admin
Unique? No
Required? Yes, to access options
Level May be set at any level
Notes: See Spectralink Applications Administration Guide
Bug report, etc.
Allow on-device configuration Capture bug report Enable crash dump USB download mode Capture network traffic
Entry criteria
Type Checkbox
Default Off
Unique? No
Required? No
Level As needed for debugging. May be set at any level
Notes: See Spectralink Applications Administration Guide
Network traffic snapshot length
Entry criteria
Type string
Default 114
Unique? No
Required? No
Level May be set at any level
Notes: See Spectralink Applications Administration Guide
Logcat
Capture logcat
If an upload server is configured, captured logcats will be uploaded to it.
Entry criteria
Type Checkbox
Default Off
Unique? No
Required? No
Level Device usually but may be set at any level
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 87
Notes: See Spectralink Applications Administration Guide
Logcat file size
Entry criteria
Type string
Default 1 MB
Unique? No
Required? No
Level May be set at any level
Notes: See Spectralink Applications Administration Guide
QXDM
Capture QXDM log
Entry criteria
Type Checkbox
Default Off
Unique? No
Required? No.
Level Device usually but may be set at any level
Notes: See Spectralink Applications Administration Guide
QXDM filter set
Entry criteria
Type Dropdown
Default Audio and Network Related
Unique? No
Required? Yes, for QXDM log
Level Any
Notes: See Spectralink Applications Administration Guide
File upload server
File upload port File upload protocol Password protect files
Enter the upload server configuration parameters. If configured, bug reports will be uploaded to
this location. If no server is configured, logs must be manually downloaded from the phone.
See the Spectralink Applications Administration Guide for a list of the parameters offered in
advanced debugging. A full description of the options and their use is available in that
document.
721-0055-00_C.docx April 2019 88
Chapter 16: Push to talk
Spectralink Versity smartphones can operate in a group broadcast mode called Push-to-talk
(PTT). Complete information about the options offered by SAM can be found in the Applications
Administration Guide, available online at the Spectralink support site. See Appendix A:
Spectralink References. Only a brief summary is offered here.
Caution: PTT compatibility with earlier Spectralink models
If you are planning to use Spectralink Versity smartphones with the 84-Series
handsets and need to deploy PTT so both families can send and receive
transmissions to each other, you must disable compatibilityMode in the 84-Series
Config files. See the Spectralink 84-Series Administration Guide for full information.
Enable / Disable PTT
PTT must be enabled in order for it to be activated on the selected handsets.
Username
This is the “caller ID” that displays on the broadcast. If nothing is entered, the default is
“anonymous”.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 89
Entry criteria
Type Text field
Default Anonymous
Unique? Yes, as labeled by administrator
Required? See above
Level Device or Group
Notes: See above
Multicast address
Enter the multicast address for broadcast traffic.
The default address is 224.0.1.116 and has been reserved with the Internet Assigned Number
Authority in Spectralink’s name.
Codec
Select either G.711Mu or G.726. For interoperability with 84-Series handsets and Pivot (87-
Series) smartphones, use G.711. For Versity alone, use G.726.
Transmit audio frame size
The default audio payload size is 30 milliseconds.
Note: Matching codec transmit audio frame size and multi-cast address
Codec transmit audio frame size and multi-cast address must match on all phone
models in the same communication group (all sharing the same PTT channel).
Audio redundancy
When audio redundancy is enabled, the Spectralink Versity smartphone will re-send the
previous audio payload in the next frame that it transmits.
If redundancy is enabled, the Spectralink Versity smartphone will transmit audio payloads as
follows:
1 Packet 1 contains audio payload 1.
2 Packet 2 contains audio payload 1 and audio payload 2.
3 Packet 3 contains audio payload 2 and audio payload 3.
4 Etc.
If redundancy is disabled, the Spectralink Versity smartphone will transmit audio payloads as
follows:
1 Packet 1 contains audio payload 1.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 90
2 Packet 2 contains audio payload 2.
3 Packet 3 contains audio payload 3.
4 Etc.
Default channel
The default channel is the channel that will broadcast when the Talk button is pressed. The user
can change the default channel.
Caution: Ensure the user is subscribed to the default channel and can
transmit on it.
Do not set a default channel and neglect to subscribe the user to it.
Ensure “Can Transmit” is checked for the default channel.
Emergency call volume
When transmitting over channel 25, the emergency channel, the volume can be set to broadcast
at a higher volume. The user can adjust this volume but only for the current broadcast.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 91
Channel Info
Enter the name and subscribe/transmit values for each channel. Click the plus (+) button to add
another channel.
By default, channels 1, 24 and 25 are subscribed.
Entry criteria
Type Text field and checkbox
Default Can Transmit, Subscribe
Unique? Yes, as labeled by administrator
Required? See above
Level Enterprise, group, device
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 92
Note: Channel label length
You can enter a label with more than 15 characters but a long label will be
truncated when it displays on the handset.
Channel can transmit
When the checkbox is checked, this channel is permitted to transmit.
By default, Can Transmit is checked only on channel 1.
Channel subscription
A user must be subscribed to a channel in order to receive broadcasts.
Priority and Emergency channels
Channels 24 is the priority channel; channel 25 is the emergency channel. You cannot
unsubscribe from these channels.
Entry criteria
Type Text field and checkbox
Default Priority or Emergency, subscribe
Unique? Yes, as labeled by administrator
Required? See above
Level Enterprise, group
Notes: See above
721-0055-00_C.docx April 2019 93
Chapter 17: SAFE
The Spectralink SAFE application utilizes Versity’s accelerometer for personal monitoring,
including “no movement” alarms, “tilt” alarms, “running” alarms and duress calls to an
emergency number.
The Panic button is usually the red button on the top of the handset but it may be programmed
to another button. There is also a soft Panic button that is available when the SAFE app is
opened. The Panic button produces a loud alarm and/or instantaneous calling to a pre-
programmed emergency number.
These features are activated by smartphone and can be programmed at Device, Group or
Enterprise levels. Complete information about the options offered by SAM can be found in the
Applications Administration Guide, available online at the Spectralink support site. See
Appendix A: Spectralink References. Only a brief summary is offered here.
Warning
The reliability of the Spectralink Panic Button and SAFE 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 Versity smartphones, correct installation and configuration
management server, and thorough training of personnel.
Spectralink assumes no responsibility and shall not be liable for any of the above
dependency factors. In addition, please be aware that the Spectralink Panic Button
and SAFE application should not be your sole solution to any of your safety
concerns and are not a substitute for safe practices and procedures.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 94
Monitoring
-
Monitoring
Monitoring must be enabled in order for any of the SAFE motion settings to trigger.
Entry criteria
Type Radio button
Default Disabled
Unique? No
Required? Yes for monitoring
Level Any
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 95
Motion settings
All motion settings use the same settings style for entry criteria.
Entry criteria
Type Enabled/disabled and Numeric value. See screenshot example.
Default Disabled
Unique? No
Required? Yes, to specify movement type
Level any
Notes: See above for discussion of settings
No move sensitivity
No move is the degree of motionlessness or lack of any type of movement of the handset. Level
7 would require that the user be almost completely still for the warning to trigger. Level 1 would
trigger a warning if the user was still moving some, but below the normal threshold.
No move timeout
The length of time that the user would have to maintain the configured degree of stillness (or a
more severe degree). It is measured in seconds. Minimum = 5, maximum = 300.
Tilt sensitivity
Tilt is a non-vertical position of the handset which might indicate that the user has fallen or is in
some other position than sitting or standing/walking. Level 1 would require that the user be
nearly prone to trigger the warning. Level 7 would trigger a warning if the user was leaning
somewhat.
Tilt timeout
The length of time that the user would have to maintain the configured degree of tilt (or a more
severe degree). It is measured in seconds. Minimum = 5, maximum = 300.
Running sensitivity
Running is triggered when the handset detects shaking, indicating that the user is moving fast or
possibly suffering a seizure. Level 1 would require quite a bit of jostling before a warning was
triggered. Level 7 would trigger the alarm if the user walked fast.
Running timeout
The length of time that the user would have to maintain the configured degree of shaking (or a
more severe degree). It is measured in seconds. Minimum = 5, maximum = 60.
Snooze and Warning timeouts
Entry criteria
Type Enabled/disabled
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 96
Default See screen example
Unique? No
Required? No
Level any
Notes: See above for discussion of settings
Snooze timeout
The Snooze feature allows the user to temporarily suspend SAFE motion monitoring. To
activate this feature, set the timeout in seconds. Disabled = 0, maximum = 300.
Warning timeout
The warning timeout is the amount of time between the warning being triggered and the alarm
state, when an emergency call might be placed or an alarm is sent to an external security
application. Set the timeout in seconds. Minimum = 10, maximum = 60.
Panic Alarm
Panic Button
The Panic Button option allows you to set the type of press that will prompt the alarm. Options
are Long press, Two short presses, Two short or long presses.
Entry criteria
Type Dropdown
Default Disable
Unique? No
Required? Yes, for Panic Button
Level Any
Notes: Must be enabled manually at the Enterprise level for facility-wide telephony functioning
On/Off options
These use the same settings style for entry criteria.
Entry criteria
Type Radio buttons
Default See screenshot
Unique? No
Required? No. Default will be used.
Level Any
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 97
Panic Button silent alarm
The silent alarm suppresses the loud local alarm that will sound when the Panic Button is
pressed.
Emergency call
Either the Panic Button or a SAFE motion alarm can trigger an emergency call, or both. If
Emergency call is On, a call will be placed to the number configured in Emergency dial number.
Emergency dial force speaker
When an emergency call is placed, the audio can be routed through the speakerphone so the
user can be in handsfree mode in case holding the phone to the ear is not possible. Turn this
option On to use the speakerphone instead of the earpiece for incoming audio.
Emergency dial number
This is the number that will be dialed when the Panic Button is pushed or a SAFE alarm state is
triggered. You must configure and enable the other related settings in order for the call to occur.
Follow any dialplan rules when you enter the emergency dial number.
Entry criteria
Type string
Default blank
Unique? No
Required? Yes if an emergency call is to be placed to a specified phone number
Level Any
Notes: See above
SAFE ring tones
Ring tones use the same settings style for entry criteria. The dropdown gives you all the ring
options included with Versity. Some of these are appropriate for warnings and alarms.
Entry criteria
Type Dropdown
Default blank
Unique? No
Required? Yes, for SAFE to make a sound
Level Any
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 98
Warning tone
Configure the tone to play during a warning period. Note that this tone will play at a gradually
increasing volume. Tones play even when the handset is silenced. There is no warning period
for the Panic Button; it goes straight to the alarm state.
Alarm tone
Configure the tone to play when a Panic Button press or SAFE alarm triggers. Note that this
tone will play at high volume. Tones play even when the handset is silenced.
721-0055-00_C.docx April 2019 99
Chapter 18: Sys Updater
The software that is installed in the smartphone at the factory must be updated periodically.
With SAM, you can send a notification to devices to contact an HTTP server and download
updated software.
Stagger the process so APs are not overloaded. When updating more than 1000 devices at a
time, SAM may display a spinning gear icon until the operation completes.
Software releases are available at http://support.spectralink.com/versity . You must have a
current service agreement to download updates. Complete information about the options offered
by SAM can be found in the Applications Administration Guide, available online at the
Spectralink support site. See Appendix A: Spectralink References. Only a brief summary is
offered here.
Admin Tip: LTE Smartphones using VPN?
System updating is not available when LTE Versity Smartphones are using VPN to
connect to the call server.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 100
Trigger OTA
Selecting this option and clicking the Save Configuration button will allow you to update specific
devices immediately. Updating options can be found in the Applications Administration Guide,
available online at the Spectralink support site. See Appendix A: Spectralink References.
Entry criteria
Type Checkbox
Default Disabled
Unique? No
Required? See above
Level Device
Notes: See above
Force reboot after OTA update
When checked, the Versity smartphone will automatically reboot after an update is downloaded.
When using SAM to trigger an update, the phone will download the version specified by SAM.
After the code is delivered to the phone, it must be manually rebooted in order to apply the new
version. This can be inconvenient when deploying a large number of phones, such as during
initial deployment.
The “Force reboot” option allows the admin to choose to have the phone automatically reboot as
soon as the update file is finished downloading. This option applies the update without any
additional touch by either the administrator or the user.
If used on a live system this option will cause interruption of any action the user may have been
performing (phone call, EMR data entry, etc…). Therefore, the Force reboot option must be
used only upon consideration of the effect on users’ communication.
Because of its potential for disruption, the feature requires re-arming every time it is intended to
be used. To re-arm, uncheck the Force reboot check box and click the SAVE button, then
enable the check box and click SAVE again.
Server address
The IP address or hostname of the OTA server
Entry criteria
Type Dotted-decimal IP address or FQDN
Default None
Unique? No
Required? Yes, for OTA update support
Level Enterprise
Notes: Must be set manually at the Enterprise level for OTA update support
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 101
Server port
Entry criteria
Type Numeric value. See above.
Default Leaving this value blank will enter the default value.
Unique? No
Required? Yes, for OTA update support
Level Enterprise
Notes: Must be enabled manually at the Enterprise level for OTA update support
Settings: Use full file name for Sys Updater relative path setting
You must include the full filename in the relative path setting. E.g.
/apollo-ota_update-signed-1.0.0.741-to-1.0.0.784.zip
Relative path on the server
If necessary, enter the relative path which would be relative to the server name. If upgrading
1.0.x or downgrading, this must be the complete path to the desired file.
Admin Tip: Are downgrades possible?
In the unlikely event you need to downgrade phones, contact Spectralink for a
custom file.
Entry criteria
Type Text field: full path name
Default None
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
System update transport
HTTP and HTTPS are available.
Entry criteria
Type Dropdown list
Default HTTP
Unique? No
Required? See above
Level Enterprise, usually but may be set at any level.
Notes:
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 102
System update check frequency
The system update check frequency specifies when or how often the phone will check the
specified server to determine if a new version of firmware (ota-update.bin file) is available.
Three options are available.
• SAM only – The phone will check for and download new firmware if available only when
the upgrade process is initiated by the SAM Administrator through the Trigger OTA
option at the top of this page.
• On Boot Only – The phone will check for and download new firmware if available any
time the device is rebooted.
• Background: phone randomly checks any time within 24 hours. This option is designed
to stagger updates to not overload the system.
Entry criteria
Type Dropdown list
Default Sam only
Unique? No
Required? See above
Level Enterprise, usually but may be set at any level.
Notes: See above
Admin Tip: Dozing phone checks for updates
Smartphones in Doze mode check for updates at maintenance intervals. Doze is an
Android-controlled feature to preserve battery life while the phone is not in use.
Admin Tip: Phone prompt overrides SAM settings
The manual Check for update button in the Sys Updater app on the phone will
override SAM settings. When that button is tapped, the phone will check for a
software update and download it no matter what settings are selected here.
Note: When are updates applied
The handset will check for and download the update but will not apply it until the
handset is rebooted or the user initiates the update from the Notification bar.
721-0055-00_C.docx April 2019 103
Chapter 19: VQO
Voice Quality Optimization (VQO) is mostly done automatically in the phone but adjustments
can be made through the VQO app..
Wi-Fi low RSSI threshold
Voice quality can degrade if the Wi-Fi signal is too weak. The Received Signal Strength
Indicator (RSSI) will change as the user moves closer to or away from the connected AP. The
RSSI threshold value setting is the RSSI level at or below which the device seeks a better AP.
The device uses many attributes of an AP to determine if it is a good candidate including the
current load on the AP, the available bandwidth on the AP, and channel. Sometimes the best
AP may have an RSSI value lower than other candidates.
Caution
Do not change the RSSI threshold value unless instructed to do so by Spectralink
service personnel.
Entry criteria
Type Slider -100 to -55
Default -67 (Do not change unless instructed to do so by Spectralink service personnel)
Unique? No
Required? No
Level Do not change unless instructed to do so by Spectralink service personnel.
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 104
Wi-Fi auto band selection
When Auto is Enabled, both bands (2.4 Ghz and 5 Ghz) and all available Wi-Fi channels are
enabled and you cannot make Band or Channel selection.
When Auto is Disabled, you can select which band to enable and select specific channels within
each band.
All bands are enabled by default but channels can be disabled.
Caution: Phones will malfunction if all active channels are disabled!
Disabling channels can result in the loss of network connectivity for each affected
device, requiring them to be reset to factory defaults. Review the channels in use at
the intended location before making changes.
Entry criteria for all Wi-Fi band selections
Type Checkbox
Default Enabled
Unique? No
Required? See above
Level Enterprise, usually but may be set at any level.
Notes: See above
Wi-Fi 2.4 GHz band selection
User can enable/disable specific channels within 2.4 GHz band.
Wi-Fi 5 GHz band selection
User can enable/disable specific channels within 5 GHz subbands.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 105
721-0055-00_C.docx April 2019 106
Chapter 20: Web API
Web API
Web API allows you to configure the smartphones to integrate with a Web 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 Checkbox
Default Disabled
Unique? No
Required? See above
Level Enterprise, usually but may be set at any level.
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 107
Web API format type
XML and JSON are the supported formats.
Entry criteria
Type Dropdown list
Default XML
Unique? No
Required? See above
Level Enterprise, usually but may be set at any level.
Notes: See above
Polling
Username/Password
Enter the username that the smartphone requires to authenticate polling.
Enter the password that the smartphone requires to authenticate polling.
Entry criteria
Type Text fields
Default None
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
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 Dropdown list
Default Requester
Unique? No
Required? See above
Level Enterprise, usually but may be set at any level.
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 108
Push API
Username / Push password
These credentials are for the Web API and are needed in order to do any kind of push.
Entry criteria
Type Text fields
Default None
Unique? No
Required? Yes, for a push
Level Enterprise, usually but may be set at any level.
Notes: 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 Dropdown list
Default All
Unique? No
Required? See above
Level Enterprise, usually but may be set at any level.
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 109
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->Phone ringtone.
Entry criteria
Type Radio buttons
Default Disable
Unique? No
Required? No. Default will be used if left blank.
Level Enterprise, usually but may be set at any level
Notes: See above
Push Notification Ringtone Volume
This setting determines the volume at which the Push Ringtone will play.
Entry criteria
Type Slider
Default 50
Unique? No
Required? No. Default will be used if left unchanged.
Level Enterprise, usually but may be set at any level
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
http://172.24.128.85:8080/sampleapps and the relative URL is /examples/sample.html, the URL
that is sent to the web browser on the smartphone is
http://172.24.128.85:8080/sampleapps/examples/sample.html. Can be either HTTP or HTTPS.
Entry criteria
Type Text field
Default None
Unique? No
Required? Yes
Level Enterprise, usually but may be set at any level.
Notes: 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.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 110
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.
Label
Enter a descriptive label.
Entry criteria
Type Text field
Default None
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
URL
Enter the URL for this Event
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 111
Entry criteria
Type Text field
Default None
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
Settings
Check the setting that apply to this event.
Entry criteria
Type Checkboxes
Default Disabled
Unique? No
Required? Yes
Level Enterprise
Notes: See above
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 112
APP URLs
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 Text fields
Default None
Unique? No
Required? No
Level Enterprise, usually but may be set at any level.
Notes: See above.
721-0055-00_C.docx April 2019 113
Part V: Appendices
721-0055-00_C.docx April 2019 114
Appendix A: Spectralink References
All Spectralink documents are available at http://support.spectralink.com.
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
Specific Documents
Spectralink Versity software and support documents are available on the Spectralink support
site at http://support.spectralink.com/versity.
Spectralink SAM software and support documents are available on the Spectralink support site
at http://support.spectralink.com/sam.
Release Notes accompany every software release and provide the new and changed features
and resolved issues in the latest version of the software. Please review these for the most
current information about your software.
Spectralink Versity Deployment Guide provides a high-level overview of the deployment process
for Spectralink Versity smartphones. This includes the interface with an EMM, the method for
getting Versity connected to the wireless LAN, and the interface with the Spectralink Application
Management (SAM) server.
Spectralink Applications Management Guide The Spectralink Applications Management (SAM)
Guide provides information about every setting and option for the Spectralink applications that
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 115
are available to the administrator on the SAM server. Time-saving shortcuts, troubleshooting
tips and other important maintenance instructions are also found in this document.
The Spectralink Applications Administration Guide describes each Spectralink app and lists
each parameter configured for each app.
The Spectralink Versity User Guide offers comprehensive instructions for using each of the
Spectralink Applications deployed on the handsets.
For information on IP PBX and soft switch vendors, see the Spectralink Call Server
Interoperability Guide.
For Cisco SPP SIP Integration: CUCM with COP file see the document listed on the Versity site
under the Interoperability tab.
Technical Bulletins and Feature Descriptions explain workarounds to existing issues and
provide expanded descriptions and examples.
AP Configuration Guides explain how to correctly configure access points and WLAN controllers
(if applicable) and identify the optimal settings that support Spectralink Versity smartphone. You
can find them on the VIEW Certified webpage.
White Papers
Spectralink White Papers are available at https://www.spectralink.com/resources/white-papers-
ebooks?page=1.
For 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. They provide recommendations for ensuring that a network
environment is adequately optimized for use with Spectralink devices.
721-0055-00_C.docx April 2019 116
Appendix B: 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.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 117
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 high-
level 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 Description
Bold Highlights interface items such as menus, soft keys, file names, and directories. Also used to represent menu selections and text entry to the smartphone.
Italics 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.
Underlined blue 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.
Bright orange text 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.
Fixed-width-font Used for code fragments and parameter names.
This guide also uses a few writing conventions to distinguish conditional information.
Spectralink Applications Administration Guide
721-0055-00_C.docx April 2019 118
Convention Description
<MACaddress> 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 <installed-directory>, 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.
721-0055-00_C.docx April 2019 119
Appendix C: Products Mentioned in this
Document
Android, Google, Google Play and other marks are trademarks of Google, Inc.
Microsoft, Active Directory and Excel are either registered trademarks or trademarks of
Microsoft Corporation in the United States and/or other countries.
Cisco is a registered trademark of Cisco Systems, Inc. and/or its affiliates in the United States
and certain other countries.
****END OF DOCUMENT****