WARP Plus Administrator's Guide Revision 2.1 / September 2011

Transcription

1 WARP Plus Administrator's Guide Revision 2.1 / September 2011

2 COPYRIGHTS Copyright 2011 PIKA Technologies Inc. All rights reserved. No part of this document may be reproduced, stored in a retrieval system, or in any other form or by any means, electronic, mechanical, photocopying, recording or otherwise, without prior written permission of PIKA Technologies Inc. TRADEMARKS PIKA is a registered trademark of PIKA Technologies Inc. WARP is a registered trademark of PIKA Technologies Inc. All other trademarks, product names and company names and/or logos cited herein, if any, are the property of their respective holders. DISCLAIMER This document is provided to you for informational purposes only and is believed to be accurate as of the date of its publication, and is subject to change without notice. PIKA Technologies Inc. assumes no responsibility for any errors or omissions in this document and shall have no obligation to you as a result of having made this document available to you or based upon the information it contains.

3 Administrator's Guide Contents CONTENTS... 1 FIGURES... 3 ABOUT THIS DOCUMENT... 4 CONTACTING PIKA TECHNOLOGIES... 4 CHAPTER 1 INTRODUCTION... 5 Features... 5 CHAPTER 2 OVERVIEW... 6 System Requirements... 6 On Premise Paging... 7 Local Music on Hold Source... 8 GSM Least Cost Routing... 9 Local and Remote IP Survivability...11 Feature Licensing...12 WARP Plus Architecture...12 CHAPTER 3 - CONFIGURATION OVERVIEW Using the Web GUI...15 Using Configuration Files...19 CHAPTER 4 CONFIGURING THE SYSTEM Licensing...23 System Settings...24 Network Settings...25 NTP Settings...26 T/FTP Client Settings...27 CHAPTER 4 CONFIGURING FEATURES Paging Feature...29 Local Music on Hold Configuration...41 GSM Least Cost Routing Configuration...48 Local and External IP Survivability Configuration...53 General SIP Settings...65 System Parameters...66 CHAPTER 5 TROUBLESHOOTING LCD...70 Error Codes...71 Logs...76 PCAP Logging...78 Status Information...79 Additional Help...82 CHAPTER 6 OTHER ADMINISTRATOR TASKS Configuring GSM Trunks...83 Changing the Web GUI Account Information...86 Restarting the WARP Appliance...87 September 2011 Copyright 2011 PIKA Technologies Inc. Page 1

5 Administrator's Guide Figures FIGURE 1 PAGING NETWORK VIEW... 7 FIGURE 2 - LOCAL MUSIC ON HOLD NETWORK VIEW... 8 FIGURE 3 - GSM LEAST COST ROUTING WITHOUT WARP... 9 FIGURE 4 - GSM LEAST COST ROUTING USING WARP PLUS...10 FIGURE 5 - LOCAL AND REMOTE IP SURVIVABILITY NORMAL OPERATION...11 FIGURE 6 - LOCAL AND REMOTE IP SURVIVABILITY WAN FAILURE SCENARIO...12 FIGURE 7 APPLICATION STARTUP AND PROVISIONING...14 FIGURE 8 TFTP/FTP SERVER DISCOVERY...21 FIGURE 9 - TOGGLE BUTTON...70 FIGURE 10 - GSM TRUNK NUMBERING...83 September 2011 Copyright 2011 PIKA Technologies Inc. Page 3

6 Administrators Guide About this Document This document is for administrators who configure, troubleshoot and manage WARP Plus applications. The following related documents are available on the PIKA Technologies Web site at WARP Plus Quick Start Guide Describes the WARP appliance assembly WARP Plus Pager Quick Start Configuration Guide Describes basic Pager 15 and Pager 40SZ configuration WARP Plus Local Music on Hold Quick Start Configuration Guide Describes basic Local Music on Hold configuration WARP Plus Local and External IP Survivability Quick Start Configuration Guide Describes basic IP Survivability configuration WARP Plus GSM Least Cost Routing Quick Start Configuration Guide Describes basic GSM Least Cost Routing configuration WARP Plus Release Notes Describes new and changed features for the release Customer Care Contacting PIKA Technologies For support issues, phone or our Customer Care department at the following: Tel: Fax: International Headquarters PIKA Technologies Inc. 535 Legget Drive, Suite 400 Ottawa, Ontario, Canada K2K 3B8 Tel: Fax: Internet Visit our website at for the latest news, product announcements, downloads, online community, documentation updates, and contact information. Page 4 Copyright 2011 PIKA Technologies Inc. Sep 2011

7 Administrator's Guide Chapter 1 Introduction WARP Plus provides a dedicated device located at the customer premise to complement a hosted PBX solution by delivering a subset of capabilities better suited to be delivered by customer premise equipment. A single product family provides a flexible combination of licensable features, allowing service providers to standardize on a single device to address their individual requirements. Based on the PIKA WARP Appliance, the capabilities of WARP Plus extend its offering by leveraging a set of traditional TDM expansion modules for local connectivity. WARP Plus can be installed into new or existing hosted PBX systems and operates seamlessly with most common IP phones manufacturers. The following features are supported: On Premise Paging Local Music on Hold Source GSM Least Cost Routing Local and External IP Survivability Features BroadSoft BroadWorks Compatible (IOT Approved) BroadWorks release independent Easily adaptable to other Hosted PBX systems Supported IP phones: Polycom, Cisco, Aastra, snom. Flexible, simplified configuration and installation procedure 40 character/image (2 x 20) LCD backlit display - provides status information such as IP address and error codes Web-based GUI for configuration, status, and troubleshooting information Features are individually activated by a simple licensing procedure Small form factor Surface standalone or wall mountable to accommodate any space requirements Isolated from the hosted solution: can be installed or removed without disruption to hosted services Customizable look so you can promote your brand Purpose-built solid-state telephony platform with solid state reliability. September 2011 Copyright 2011 PIKA Technologies Inc. Page 5

8 Administrators Guide Chapter 2 Overview The topics in this section describe: WARP Plus system requirements Available features WARP Plus architecture Overview of WARP Plus application configuration System Requirements Power source: 110V-240V AC (50-60 Hz) o Power supply and country specific power cord included in the WARP appliance package. Non-VLAN tagged LAN port at the customer premise on the same network as the IP phones in the paging group. Standard SIP User Agent (UA) account on the BroadSoft switch (unique user agents required for each of On Premise Paging, GSM Least Cost Routing, and Local Music on Hold Source) MAC address & Directory Number (DN) (or user ID) for each IP phone in the paging group SIP UA information for each IP phone using IP Survivability Feature code or extension for each of On Premise Paging and GSM Least Cost Routing FTP or TFTP Server with option 66 or 150 or a static FTP/TFTP server Optional: GSM Module and antenna (required for the Local and External IP Survivability and GSM Least Cost Routing) Page 6 Copyright 2011 PIKA Technologies Inc. Sep 2011

9 Administrator's Guide On Premise Paging Once installed at the customer premise, page announcements are redirected through the WARP appliance to the speakers of each IP phone in the page group. On Premise Paging offloads WAN bandwidth demands and provides the local paging functionality typically available with traditional legacy PBX systems. Overhead speaker systems can also be connected to the WARP appliance without additional hardware. The WARP appliance acts as a local SIP User Agent (SIP UA) registered with the BroadSoft switch. Page requests are handled locally by the WARP appliance instead of sending multiple RTP media streams from the BroadSoft switch across the WAN to the customer premise. Figure 1 Paging Network View Pager Application Description Pager 15: o Maximum capacity to page 15 phones simultaneously in a single zone or page group Pager 40SZ: o Maximum capacity to page 40 phones simultaneously o Zone paging - 10 zones, zones 0 and 1 include overhead speaker paging o Integrated audio line output jack to drive Overhead Speaker Systems September 2011 Copyright 2011 PIKA Technologies Inc. Page 7

10 Administrators Guide Local Music on Hold Source WARP Plus with Music on Hold (MOH) provides users with an easily customizable content source, routed directly through the WARP appliance. The WARP appliance provides the physical connectivity at the customer premise to easily connect a custom source of music such as an ipod, radio, or CD player. End customers can use content that may only be available from their premise. An Identity/Device Profile must be created and provisioned as the external source on the Music on Hold services page on the BroadSoft switch. Figure 2 - Local Music on Hold Network View Page 8 Copyright 2011 PIKA Technologies Inc. Sep 2011

11 Administrator's Guide GSM Least Cost Routing GSM Least Cost Routing (LCR) is the process of selecting the path of outbound traffic based on cost. Using WARP Plus, service providers can offer the ability to optionally direct outbound calls through an alternative interface to reduce the overall monthly phone bill to the end customer. The WARP appliance acts as a local SIP User Agent (SIP UA) registered with the BroadSoft switch. When a user dials the LCR feature code assigned by the service provider, outbound calls are routed through the GSM trunks on the WARP appliance. The WARP appliance acts as a local SIP User Agent (SIP UA) registered with the BroadSoft switch. Typical Call Routing IP Phone PSTN Wireless Network Figure 3 - GSM Least Cost Routing without WARP September 2011 Copyright 2011 PIKA Technologies Inc. Page 9

13 Administrator's Guide Local and Remote IP Survivability WARP Plus with IP Survivability provides always available functionality. In case of WAN failure, all outbound calls are transparently rerouted through the GSM trunks on the local WARP appliance, eliminating any potential downtime. Incoming calls are routed to an IVR through the GSM trunks. Incoming callers can dial the extension of the user they want to reach. This feature is most useful in configurations that do not use an edge device. IP phones provisioned for the IP Survivability feature must be configured to use the WARP appliance as a backup registrar. When the WAN connection fails, the WARP appliance automatically routes any local or external outbound calls from the registered IP phones through the GSM trunks. When the WAN connection is restored, the phones automatically reregister with the BroadSoft switch and normal call routing resumes. Typical Call Routing Figure 5 - Local and Remote IP Survivability Normal Operation September 2011 Copyright 2011 PIKA Technologies Inc. Page 11

14 Administrators Guide WAN Failure Call Routing Figure 6 - Local and Remote IP Survivability WAN Failure Scenario Feature Licensing Each individual feature requires a separate license. When you purchase WARP Plus, you receive an with a license key for each feature you ordered. On the Licensing page in the Web GUI, you need to activate each license before using the associated WARP Plus feature. Licenses for additional features can be activated later if new features are purchased. You cannot provision a feature through the GUI until you activate the feature license. Refer to section Licensing on page 23 for more information. WARP Plus Architecture There are three major components of WARP Plus: Application software Configuration files Web GUI The application software performs the following functions: FTP/TFTP server discovery and provisioning o Locates the configuration files on the TFTP/FTP server for each licensed feature o Configures all licensed features, using information in either the configuration files retrieved from the server or provisioned through the GUI Page 12 Copyright 2011 PIKA Technologies Inc. Sep 2011

15 Administrator's Guide Application Engine o Processes actions for all applications Application Upgrades o Upgrades application software Web GUI o Used for configuration, troubleshooting, and license registration WARP Plus features use configuration files to provision SIP account information to register with the host switch and to provision application specific information. Configuration files can be created manually using a text editor to specify the parameter names and values, or you can use the Web GUI which creates the configuration files based on values you enter in the fields provided. September 2011 Copyright 2011 PIKA Technologies Inc. Page 13

17 Administrator's Guide Chapter 3 - Configuration Overview There are two methods available to configure WARP Plus: Configuration files located on an FTP or TFTP server Using the Web GUI Using the Web GUI You can access the Web GUI from a standard Web browser such as Internet Explorer or Firefox. The following versions have been tested: Internet Explorer 8.0 Firefox 3.5 and 4.0 Chrome 12 Opera 11 Safari 5 When parameter values are entered using the Web GUI, configuration files are created on the WARP appliance. You have the option to upload the files to an FTP or TFTP server or to continue to use the files stored on the WARP appliance. Logging On In the address bar of your browser, type the IP address of the WARP appliance. You can use the toggle button on the LCD to change to the IP address screen to determine the IP address of the WARP appliance. The following page appears. The user name is admin and the password is pikapika. September 2011 Copyright 2011 PIKA Technologies Inc. Page 15

18 Administrators Guide The System Status page appears. To log out, click the Logout link in the upper right corner of the page. Menus There are six menus you can use to perform various tasks: System, Network, Applications, Connections, Maintenance, and Troubleshooting. The System menu has the following options: Option Name Status Licensing Settings Description Displays system time, firmware version and error information Feature license activation General system settings Page 16 Copyright 2011 PIKA Technologies Inc. Sep 2011

19 Administrator's Guide The Network menu has the following options: Option Name Network Status Network Settings NTP Settings T/FTP Client Settings Description Displays network interface and routing information DHCP and static IP settings NTP server and time zone settings FTP server settings and configuration file upload and download The Applications menu has the following options: Option Name Pager Settings Pager Targets Music On Hold Least Cost Routing Survivability Settings Survivability SIP UA General SIP Settings Description Pager SIP UA configuration MAC address and extension of phones registered for Paging Music On Hold UA SIP configuration LCR SIP UA Configuration Feature operation settings SIP User Agent information for phones using Survivability SIP settings that apply to SIP accounts for all features Note that the Applications menu does not appear if you have not activated any feature licenses. Only options for licensed features appear in the Applications menu. The Connections menu has the following options Option Name GSM Trunk Configuration Description Broadsoft Connection Status SIP User Connection Status Description GSM radio settings GSM network registration status Status of WARP appliance connection to BroadSoft switch Status of SIP users registered with the WARP appliance The Maintenance menu has the following options: Option Name Description Logs View and download logs PCAP Logging Turn network debugging logs on and off Remote Software Upgrade Update WARP appliance firmware GUI Account Settings User names and passwords for GUI access accounts Reboot Restart the WARP Appliance Apply Configuration Changes Activate configuration changes saved on settings pages Factory Reset Erase configuration changes The Troubleshooting menu has the following options: Option Name Available Software Updates Help Description Link to the latest jnformation about new software updates Link to the latest WARP Plus documentation and support September 2011 Copyright 2011 PIKA Technologies Inc. Page 17

20 Administrators Guide Entering Information Using the Web GUI When you enter values for the fields in the GUI, errors are highlighted in red after you click Save. Position the mouse pointer over the red text to view the error message. See the example below. After you save updates to parameters, the message The last saved settings have not been applied. appears. See the example below. Page 18 Copyright 2011 PIKA Technologies Inc. Sep 2011

21 Administrator's Guide After you finish changes on all the pages you want to update, you must finalize the changes. Under the Maintenance menu, click Apply Configuration Changes. The following page appears. Click the Apply Changes button. The page updates as shown below. When the page refreshes, the configuration changes are complete. If you change the network settings, be aware that the WARP appliance restarts to apply the changes. Using Configuration Files As an alternative to the using the Web GUI, you can manually create configuration files using a standard text editor. WARP Plus features use configuration files which contain a list of comma separated parameter names and values. Parameters can be listed in the files in any order. The files are retrieved from a central server accessed by FTP or TFTP. This provisioning method is typical for mass deployment. Configuration files for each feature are uniquely identified using the MAC address of the WARP appliance, which is located on the underside of the unit. Files are named <mac-address>.feature where <mac-address> is the MAC address of the WARP appliance, and feature is the feature name, for example, 001e840006d9.lcr. Be sure to use lower case for the file name and do not use colons in the MAC address. When you create the file, ensure that parameters names are spelled correctly in lower case. September 2011 Copyright 2011 PIKA Technologies Inc. Page 19

22 Administrators Guide Configuration files are unique to each application unless otherwise indicated. Features are individually activated using a license key which is entered using the Web GUI. If there is no active license for a feature, the configuration files for the feature are not retrieved from the FTP/TFTP server and the feature does not work. You need the following files to configure WARP Plus features: On Premise Paging: The file <mac-address>.pager contains the SIP User Agent (UA) account information assigned to the WARP appliance for the paging feature and additional parameters that change the behaviour of the paging feature. The file <mac-address>.phones contains a list of IP Phones and corresponding phone numbers in the paging group. GSM Least Cost Routing: The file <mac-address>.lcr contains the SIP User Agent (UA) account information assigned to the WARP appliance for the LCR feature. The optional file <mac-address>.trunks contains the GSM trunk information for the GSM radios on the WARP appliance. Local Music on Hold Source: The file <mac-address>.moh contains the SIP User Agent (UA) account information for the WARP appliance associated with the Identity/Device Profile on the BroadSoft switch for MoH. Local and Remote IP Survivability: The file <mac-address>.users contains a list of SIP user account names and passwords for the phones that use the IP Survivability features. The optional file <mac-address>.survive contains additional parameters to change the behaviour of the IP survivability feature. The optional file <mac-address>.trunks contains the GSM trunk information for the GSM radios on the WARP appliance. Other WARP appliance settings: The optional file <mac-address>.warp contains network configuration, GUI account settings, and other system configuration parameters that are not specific to any feature. The files are retrieved each time the WARP appliance restarts. Be aware that configuration files on an FTP/TFTP server override configuration values provisioned using the Web GUI. If you use the Web GUI for provisioning, you can save the configuration information on an FTP/TFTP server using the T/FTP Client Settings page under the Network menu on the GUI. Refer to T/FTP Client Settings on page 27 for more details. FTP and TFTP Server Setup and Discovery Page 20 Copyright 2011 PIKA Technologies Inc. Sep 2011

23 Administrator's Guide To use a central FTP or TFTP server to store configuration information, you must either configure your network DHCP server to use option 150 or option 66 to automatically discover the server, or you must provision the server IP address using the WARP Plus Web GUI. We recommend that you use DHCP. The server discovery process uses either DHCP or the static FTP/TFTP information provisioned using the GUI. The figure below shows the discovery sequence. Figure 8 TFTP/FTP server discovery DHCP Discovery The discovery process tries to use DHCP first to locate an FTP or TFTP server. In the DHCP reply message, it checks for the option 150 field and the option 66 field. If the option 150 field is present, it uses the FTP/TFTP server IP address. If the option 150 field is not present, it checks for the September 2011 Copyright 2011 PIKA Technologies Inc. Page 21

24 Administrators Guide option 66 field, and, if present, uses the FTP/TFTP server name. If neither option field is present, the DHCP discovery method fails. The discovery process only checks the root directory of the FTP/TFTP server for configuration files. While option 150 can optionally support multiple hosts to provide server redundancy, only one host or IP address is supported. If you use the default FTP user name and password, discovery is complete, the configuration files are retrieved and the application configuration process continues. WARP Plus does not support an FTP user name and password in the DHCP option 66 field. If you have an FTP server that requires a user name and password other than the default values (refer to T/FTP Client Settings section on page 27), you must provision the values using the GUI. If the connection to the server fails, or you do not use an FTP/TFTP server, and there is existing provisioning information available on the WARP appliance, the applications use the existing provisioning information. Existing provisioning information may exist if you used the Web GUI to provision the WARP appliance or if files were previously downloaded successfully from the server. Page 22 Copyright 2011 PIKA Technologies Inc. Sep 2011

25 Administrator's Guide Chapter 4 Configuring the System Licensing To use the features of WARP Plus, you need to activate feature licenses. Ensure that you log on to the GUI using the Admin User name (the default user name is admin and the default password is pikapika). Under the System menu, click Licensing. The following page appears. To activate a license, type the license key you received in the with the subject PIKA Registration Key and click Apply. The box in the Status column beside the feature changes to Licensed as shown in the example below. September 2011 Copyright 2011 PIKA Technologies Inc. Page 23

26 Administrators Guide System Settings You can provision system settings that affect the behavior of the multiple features. Under the System menu, click Settings. The following page appears. To change the country code to match the country where the WARP appliance is located, click the country in the Country Code list. This setting is used to select the tone set to use for playing tones such as dial tone, congestion, and ringing. There may be a delay when establishing calls to the GSM network when initiating calls with the Least Cost Routing and IP Survivability features. During this time, the user hears silence on the line and may interpret this to mean the call is unsuccessful. When Early Ringback is enabled, the WARP appliance plays ringback to the user to indicate that the call is proceeding. The ringback tone the user hears is determined by the value of the Country Code parameter. There may be scenarios, such as when the far end party is busy, when the user hears ringback which does not reflect the actual state of the call. If this is unacceptable, you can disable this setting. Change the fields to the appropriate values and click Save. To complete the changes, you must use the Apply Configuration Changes page under the Maintenance menu. Refer to Entering Information Using the Web GUI on page 18 for more information. This information can be provisioned in the configuration file <mac-address>.warp. The corresponding parameters are: country early_ringback Refer to section System Parameters on page 66 for more information. Page 24 Copyright 2011 PIKA Technologies Inc. Sep 2011

27 Administrator's Guide Network Settings By default, the WARP appliance uses DHCP for network settings. If you want to use a static IP address for the WARP appliance, you can use the Network Settings page. Under the Network menu, click Network Settings. The following page appears. Change the fields to the appropriate values and click Save. To complete the changes, you must use the Apply Configuration Changes page under the Maintenance menu. Refer to Entering Information Using the Web GUI on page 18 for more information. Be aware that the WARP appliance restarts to apply network configuration changes. This information can be provisioned in the configuration file <mac-address>.warp. The relevant parameters are: network_dhcp network_ip network_dns network_gateway network_netmask network_hostname Refer to section System Parameters on page 66 for more information. September 2011 Copyright 2011 PIKA Technologies Inc. Page 25

28 Administrators Guide NTP Settings To change the address of the NTP server or the time zone, under the Network menu, click NTP Settings. The following page appears. If you want to use option 42 on your DHCP server to retrieve the NTP server address and time zone information, in the NTP Source Setting list, click dhcp. Other fields are unavailable. If you do not use option 42, in the NTP Source Setting list, click static and click Save. The page refreshes and you can type the address of the NTP server in the NTP Server field and a time zone offset in the Time Zone field. The time zone is specified as an offset from UTC. When you finish, click Save. To complete the changes, you must use the Apply Configuration Changes page under the Maintenance menu. Refer to Entering Information Using the Web GUI on page 18 for more information. This information can be provisioned in the configuration file <mac-address>.warp. The relevant parameters are: time_source ntp_server utc_offset Refer to section System Parameters on page 66 for more information. Page 26 Copyright 2011 PIKA Technologies Inc. Sep 2011

29 Administrator's Guide T/FTP Client Settings If you want to use a static FTP server or your FTP server needs a user name and password different from the default, under the Network menu, click T/FTP Client Settings. The following page appears. If you want to use a static FTP server, type the address in the FTP Server box. You can specify a path as well as an address, for example, /pager14. If you want to use a user name and password with either a static FTP server or the FTP server discovered using DHCP option 66 or 150, type the user name in the FTP Username box and the password in the FTP Password box. Regardless of whether you use an FTP or TFTP server discovered through DHCP, you must specify the server address in the FTP Server box to upload configuration files. When you finish, click Save. To complete the changes, you must use the Apply Configuration Changes page under the Maintenance menu. Refer to Entering Information Using the Web GUI on page 18 for more information. FTP server information can be provisioned in the configuration file <mac-address>.warp. The relevant parameters are: ftp_server ftp_user ftp_password Refer to section System Parameters on page 66 for more information. If you configure the WARP appliance using the Web GUI, you can save your configuration files on a central server. Files are named <mac-address>.feature (for example, 001e840006d9.lcr) and <macaddress>.warp. Perform the following steps: 1. If not already provisioned, type the server address in the FTP Server box, including the path if needed. 2. If your FTP server requires it, type the user name in the FTP Username box and the password in the FTP Password box. 3. Click Save. It is not necessary to finalize your changes to continue. September 2011 Copyright 2011 PIKA Technologies Inc. Page 27

30 Administrators Guide 4. Click Upload Configuration Files. The page refreshes with a message to indicate if the upload was successful. When you upload configuration files, they overwrite any existing files on the server. If you store configuration files on an FTP server, you can download existing configuration files to change the feature configuration without restarting the WARP appliance. You must name the files with the MAC address of the WARP appliance, for example, 001e840006d9.lcr. Perform the following steps: 1. Type the IP address of the FTP server in the FTP Server box. 2. If applicable, type the user name in the FTP Username box and type the password in FTP Password box. 3. Click Save. It is not necessary to finalize your changes to continue. 4. Click the Download Configuration button. The page refreshes with a message to indicate if the download was successful. 5. Under the System menu, click Status. Check that there are no error messages in the Errors box. Page 28 Copyright 2011 PIKA Technologies Inc. Sep 2011

31 Administrator's Guide Chapter 4 Configuring Features The following sections describe the configuration parameters for each application, SIP phone configuration changes (if needed), and feature usage information. If you use the Web GUI and no feature licenses are activated, the Applications menu does not appear. You must activate features licenses on the Licensing page under the System menu. After you activate a license, to show the Applications menu, you need to reload the page in your browser. Only features for which there are active licenses appear in the Applications menu. When you use the Web GUI to provision features, to finalize all provisioning, you must apply your configuration changes. Under the Maintenance menu, click Apply Configuration Changes. Click the button Apply Changes. Paging Feature To use the paging feature, you must provision SIP account information for the WARP appliance to register with the BroadSoft switch, and phone information for each phone that can be used with the paging feature. SIP Account Configuration To configure the SIP account for paging using the Web GUI, under the Applications menu, click Pager Settings. If you have a license for the Pager 40SZ feature, the following page appears. September 2011 Copyright 2011 PIKA Technologies Inc. Page 29

32 Administrators Guide If you have a license for the Pager 15 feature, the following page appears: Refer to the table below for a description of each parameter and valid values. After you change the values of fields, click Save. If you want to reset the pager settings, click Remove Configuration File. This action removes the file <mac-address>.pager from the WARP appliance. To configure the SIP account for paging using a configuration file, use a standard text editor and create the file <mac-address>.pager, where <mac-address> is the MAC address of the WARP appliance. Store the file on an FTP or TFTP server. The file format is: parameter_name,value The following shows an example of the file <mac-address>.pager: username, auth_username, auth_password,28dktiqj domain,my.domain.com domain_proxy,proxy.yourdomain.com callerid_name,warp-pager answer_string,auto Answer dtmfmode,rfc2833 Page 30 Copyright 2011 PIKA Technologies Inc. Sep 2011

33 Administrator's Guide Paging Configuration Parameters The following tables describe each parameter and possible values. Parameter auth_username (configuration file) Authorization User (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings Authentication user name provided by the hosted PBX service provider. Used when a Registration Request is challenged. Yes Not applicable Text string Parameter auth_password (configuration file) Authorization Password (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings The password used to authenticate the WARP appliance with the external SIP server. Yes Not applicable Text string Parameter username (configuration file) Username (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings SIP user agent account name provided by the hosted PBX service provider The value is usually the same as auth_username. Yes Not applicable Text string Parameter domain (configuration file) Domain (Web GUI) Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings September 2011 Copyright 2011 PIKA Technologies Inc. Page 31

34 Administrators Guide Description Mandatory Default The domain of the external SIP server to register the WARP appliance against. This value is required if domain_proxy is not provisioned. If both parameters are missing, pager configuration fails. Yes The value of domain_proxy (configuration file) Valid values Proxy (Web GUI) Text string Parameter domain_proxy (configuration file) Proxy (Web GUI) Description Mandatory Default Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings The proxy for the external SIP server. All SIP packets are sent to the proxy when provisioned. This value is required if domain is not provisioned. If both parameters are missing, pager configuration fails. Yes The value of domain (configuration file) Domain (Web GUI) Valid values Text string Page 32 Copyright 2011 PIKA Technologies Inc. Sep 2011

35 Administrator's Guide Parameter callerid_name (configuration file) Caller ID (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings An optional string to use if no caller ID information is available in the INVITE message. No WARP-PAGER Text string Parameter answer_string (configuration file) Answer String (Web GUI) Description Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings This parameter affects only Polycom phones. Defines the payload of the SIP Alert-Info header designated for the phone. This must match the value expected by the phone. Mandatory Default Valid values Consult the user manual for your IP phone for the correct value. You may need to update the SIP phone configuration. Refer to section SIP Phone Configuration on page 38 for more information. No Auto Answer Text string Parameter dtmfmode (configuration file) DTMF Mode (Web GUI) Description Mandatory Default Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings You may need to change this parameter if you are unable to select which group you want to page by pressing digits on your phone. Typically, the value should be consistent with the mode used for the SIP phones on the network. No rfc2833 September 2011 Copyright 2011 PIKA Technologies Inc. Page 33

36 Administrators Guide Valid values info: Use SIP INFO messages for DTMF digits rfc2833: Use RFC2833 inband: Inband audio (requires 64 kilobit codec - alaw, ulaw) auto: Use RFC2833 if offered, otherwise, use inband Parameter usercontext (configuration file) User Context (Web GUI) Description Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings The WARP appliance uses an internal context, for example warppager, in its Address of Record in the Contact header used during registration, for example, warppager@ip_address. Some edge devices need the username to match the To header. This parameter indicates whether to use the username assigned to the SIP UA account in the Contact header. If you use an edge device and are having problems with call routing, enabling this parameter may resolve the problem. Mandatory Default Valid values If you use an edge device and are having problems with call routing, enabling this parameter may resolve the problem. No disable disable: Use internal context in Contact header enable: Use username in Contact header Parameter extension_length (configuration file) Extension Length (Web GUI) Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings Page 34 Copyright 2011 PIKA Technologies Inc. Sep 2011

37 Administrator's Guide Description Number of digits in the phone number of the user that initiates the page. This value is used when removing the paging user s number from the list of numbers to page. If the caller ID of the paging user is a different length than the extension (for example, a 10 digit caller ID with a 4 digit extension), it may be necessary to provision this parameter. Mandatory Default Valid values If you use the Shared Lines feature (multiple single line phones register to the same user account), the value should be set to 0. No Not applicable Integer value Parameter audio_out (configuration file) Audio Out Mode (Web GUI) Description Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings This parameter applies to the Pager 40SZ only. The port to use when paging using the overhead speaker. Mandatory Default Valid values If you use an overhead speaker, provision this parameter based on the port you use to connect the speaker to the WARP appliance. No lineout lineout: The overhead speaker is connected to the audio line out port on the WARP appliance. fxs: The overhead speaker is connected to the built-in FXS port on the WARP appliance. September 2011 Copyright 2011 PIKA Technologies Inc. Page 35

38 Administrators Guide Parameter use_ivr (configuration file) Enable IVR (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.pager Web GUI Applications menu -> Pager Settings Configure the Pager 40SZ to use an IVR. No enable disable: The user does not hear a message prompting the user to dial a digit corresponding to the group number to page. Each phone listed in the file <mac-address>.phone plus the overhead speaker receives the page announcement. enable: The user initiating the page hears a message prompting the user to dial a digit corresponding to the group number to page. Ensure that you provision one or more group numbers for each phone in the file <macaddress>.phones. Paging Group Configuration The Pager 15 feature supports up to 15 phones in a single paging group. The Pager 40SZ feature supports up to ten paging groups which must be numbered 0 to 9, each of which can contain up to 40 phones. Paging groups 0 and 1 automatically include the overhead speaker. You can add additional phones to these groups if you want to page both phones and the overhead speaker with a single call. It is not possible to add the overhead speaker to any other group. To provision the paging group, you need the following information: MAC address The MAC address of the phone in lower case. It is not necessary to include colons in the value. Extension number The number to dial to call the phone List of paging groups (Pager 40SZ only) numeric list of paging groups, values 0 to 9 When adding to the list of phones in either the Web GUI or the configuration file, do not include the extension assigned to the WARP appliance in the list. Page 36 Copyright 2011 PIKA Technologies Inc. Sep 2011

39 Administrator's Guide To configure the list of phones using the Web GUI, under the Applications menu, click Pager Targets. If you have a license for the Pager 15 feature, the following page appears: If you have a license for the Pager 40SZ feature, the following page appears. Type the MAC address of the phone in the box in the MAC Address column. Type the phone extension in the Extension column. If the Pager 40SZ feature license is active, the Group column appears. Type a comma separated list of numbers of the paging groups the phone belongs to. When you finish, click Save. Errors are highlighted in red. Position the mouse pointer over the red text to view the error message. September 2011 Copyright 2011 PIKA Technologies Inc. Page 37

40 Administrators Guide If you want to reset the pager targets, click Remove Configuration File. This action removes the file <mac-address>.phones from the WARP appliance To configure a list of phones in the paging group using a configuration file, use a standard text editor and create the file <mac-address>.phones. Store the file on an FTP or TFTP server. The file format is a comma separated list of MAC Address, extension number and paging zone number (Pager 40SZ only). The file format is: MAC address,extension number,group number The following shows a sample <mac-address>.phones file for WARP Pager 15: 0016d32ac578, e , c73168, The following shows a sample <mac-address>.phones file for WARP Pager 40SZ: 0016d32ac578, ,1,3,6 00e , ,0,2, c73168, ,3,4 If paging group numbers are provisioned in the configuration file for the Pager 15 feature, they are ignored. SIP Phone Configuration When the phones in the paging group receive the SIP Alert-Info or CallInfo header in the INVITE message, the auto-answer feature causes the phone to automatically answer the paging call and provide a brief page notification tone. Polycom Phones Polycom phones in a paging group need the auto-answer feature enabled. The recommended definition (tag value pair) for Auto Answer is shown below. If needed, add this information to the SIP configuration file (for example, sip.cfg on the TFTP server used by Polycom phones). This setting is normally the default value. Ensure that the phone configuration is updated prior to installing the WARP appliance. <alertinfo voipprot.sip.alertinfo.1.value="auto Answer" voipprot.sip.alertinfo.1.class="3" /> <AUTO_ANSWER se.rt.3.name="auto Answer" se.rt.3.type="answer" /> The alertinfo.1.class in this example is set to 3 corresponding to the se.rt.3 ring type. The value 3 may be replaced with another number to use a different ring type. Adding these configuration entries does not affect any other phone features. You can find a sample sip.cfg at ftp://ftp.pikatech.com/outgoing/polycom-sip-cfg/. Refer to the Polycom manual for more details about the available options. Page 38 Copyright 2011 PIKA Technologies Inc. Sep 2011

41 Administrator's Guide snom Phones By default, snom phones only accept calls from the proxy to which they are registered. To configure snom phones to work with the paging feature, add or change the following entries in the phone settings XML file. <network_id_port perm="rw">5060</network_id_port> <filter_registrar perm="rw">off</filter_registrar> <user_descr_contact idx="1" perm="rw">off</user_descr_contact> <user_sipusername_as_line idx="1" erm="rw">on</user_sipusername_as_line> <answer_after_policy perm="">idle</answer_after_policy> <intercom_connect_type perm="">intercom_connect_type_handsfree</intercom_connect_type> Cisco Phones Cisco phones do not require any configuration changes to enable auto-answer. To avoid interrupting active calls with a page announcement, ensure that Auto Answer Page During Active Call is disabled. Refer to section Using the Paging Feature on page 39 for more information. Aastra Phones Aastra phones do not require any configuration changes to enable auto-answer. Using the Paging Feature The user that initiates the paging announcement should be aware of the following: With Polycom phones, if the user s phone is included in the paging group, the user will hear a call waiting tone indicating an incoming call from the WARP Pager. Refer to for information about preventing this behaviour. With Cisco phones, if the user is a member of the paging group, all the paging calls are put on hold. To avoid this behavior, dial *70 before dialing the paging extension. Refer to Bargin-in-feature-disrupts-Paging for more information. After dialing the extension for the WARP Pager 15, the user hears a tone to prompt the user to begin speaking into the handset. After dialing the extension for the WARP Pager 40SZ, the user first hears an announcement prompting the user to dial a digit corresponding to the group number to page and then hears a tone to indicate that the user should begin speaking. If multiple users attempt to page simultaneously, the second user receives a busy tone. Users receiving paging announcements should be aware of the following: Phones with Do Not Disturb (DND) enabled do not receive page announcements. If call forward is enabled on a phone, page announcements are not forwarded. With Polycom phones, if the user has a call in progress and receives an incoming call from the WARP appliance, they hear a call waiting tone and the caller ID of the WARP appliance is shown on the phone display. With Cisco phones, if the user has a call in progress and receives an incoming call from the WARP appliance, the existing call is placed on hold and the user is connected to the paging user. This is a known issue with the barge-in function on some Cisco phones (models SPA5xx). To September 2011 Copyright 2011 PIKA Technologies Inc. Page 39

42 Administrators Guide resolve this issue (CSCti53461), Cisco released SPA5xx firmware version which includes the following changes: A new parameter Auto Answer Page During Active Call has been added under the EXT tab. In conjunction with the global Auto Answer Page parameter, this parameter determines the behavior of the phone when a page call arrives. o When Auto Answer Page is disabled, paging calls are not auto answered (even if the phone is idle), regardless of the value of Auto Answer Page During Active Call. o When Auto Answer Page is enabled, the setting for PER LINE Auto Answer Page During Active Call determines whether page calls are auto answered during an active call. o Both Auto Answer Page and Auto Answer Page During Active Call o are enabled by default. To avoid this 'Barge-in' behavior, ensure that Auto Answer Page During Active Call is disabled. Be aware that this parameter is functional on a per line basis. Refer to Phones-Bargin-in-feature-disrupts-Paging for more information. To use the Shared Lines feature (multiple single line phones register to the same BroadSoft SIP user account), ensure that Cisco phones are configured as described. Page 40 Copyright 2011 PIKA Technologies Inc. Sep 2011

43 Administrator's Guide Local Music on Hold Configuration To use the paging feature, you must provision SIP account information for the WARP appliance to register with the BroadSoft switch. To configure the SIP account for paging using the Web GUI, under the Applications menu, click Music On Hold. The following page appears. Refer to the table below for a description of each parameter and valid values. After you change the values of fields, click Save. If you want to reset the music on hold settings, click Remove Configuration File. This action removes the file <mac-address>.moh from the WARP appliance To use a configuration file to provision Music on Hold, use a standard text editor to create the file <mac-address>.moh. Store the file on an FTP or TFTP server. The file format is: parameter_name,value The following shows an example of the MoH parameters in file <mac-address>.moh: username,warplinein auth_username,warplinein domain,yourdomain.com domain_proxy,proxy.yourdomain.com Music On Hold Configuration Parameters The following tables describe each parameter and possible values. September 2011 Copyright 2011 PIKA Technologies Inc. Page 41

44 Administrators Guide Parameter username (configuration file) Username (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.moh Web GUI Applications menu -> Music On Hold SIP user agent account name provided by the hosted PBX service provider The value can be any alphanumeric string and should not correspond to an existing SIP UA account name. Yes Not applicable Text string Parameter auth_username (configuration file) Authorization User (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.moh Web GUI Applications menu -> Music On Hold Authentication user name provided by the hosted PBX service provider. Used when a Registration Request is challenged. No Not applicable Text string Parameter auth_password (configuration file) Authorization Password (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.moh Web GUI Applications menu -> Music On Hold The password used to authenticate the WARP appliance with the external SIP server. This parameter is not usually necessary. Provision this parameter only if required. No Not applicable Text string Parameter domain (configuration file) Domain (Web GUI) Configuration file - <mac-address>.moh Web GUI Applications menu -> Music On Hold Page 42 Copyright 2011 PIKA Technologies Inc. Sep 2011

45 Administrator's Guide Description Mandatory Default The domain of the external SIP server to register the WARP appliance against. This value is required if domain_proxy is not provisioned. If both parameters are missing, pager configuration fails. Yes The value of domain_proxy (configuration file) Valid values Proxy (Web GUI) Text string Parameter domain_proxy (configuration file) Proxy (Web GUI) Description Mandatory Default Configuration file - <mac-address>.moh Web GUI Applications menu -> Music On Hold The proxy for the external SIP server. All SIP packets are sent to the proxy when provisioned. This value is required if domain is not provisioned. If both parameters are missing, pager configuration fails. Yes The value of domain (configuration file) Domain (Web GUI) Valid values Text string September 2011 Copyright 2011 PIKA Technologies Inc. Page 43

46 Administrators Guide Parameter usercontext (configuration file) User Context (Web GUI) Description Configuration file - <mac-address>.moh Web GUI Applications menu -> Music On Hold The WARP appliance uses an internal context, for example warppager, in its Address of Record in the Contact header used during registration, for example, warppager@ip_address. Some edge devices need the username to match the To header. This parameter indicates whether to use the username assigned to the SIP UA account in the Contact header. If you use an edge device and are having problems with call routing, enabling this parameter may resolve the problem. Mandatory Default Valid values If you use an edge device and are having problems with call routing, enabling this parameter may resolve the problem. No disable disable: Use internal context in Contact header enable: Use username in Contact header Page 44 Copyright 2011 PIKA Technologies Inc. Sep 2011

47 Administrator's Guide BroadSoft Switch Configuration Use the BroadSoft GUI to log on to the BroadSoft switch. Ensure that you create a Music on Hold Identity/Device Profile at the group level with settings as shown below. September 2011 Copyright 2011 PIKA Technologies Inc. Page 45

48 Administrators Guide Click Services in the left navigation menu. The Services screen appears. Click Music/Video on Hold. The Music/Video on Hold screen appears. Click Edit. Page 46 Copyright 2011 PIKA Technologies Inc. Sep 2011

49 Administrator's Guide The Music/Video on Hold Modify screen appears. 1. Ensure that you are on the General Settings page. 2. Click External Source. 3. Click Identity/Device Profile. 4. Select a profile from the Identity/Device Profile Name list. It should correspond to the one added at the group level above. 5. In the text box for Line/Port, type the user name. It must match the value of the parameter Username (Web GUI) or username (configuration file) provisioned on the WARP appliance. 6. In the menu beside the text box, select the item that matches the value of Domain (Web GUI) or domain (configuration file) provisioned on the WARP appliance. 7. Click Apply to save. September 2011 Copyright 2011 PIKA Technologies Inc. Page 47

50 Administrators Guide GSM Least Cost Routing Configuration To use the Least Cost Routing feature, you must provision SIP account information for the WARP appliance to register with the BroadSoft switch. Optionally, you can also provision the GSM trunk settings. Refer to section Configuring GSM Trunks on page 83 for more information. SIP Account Configuration To configure the SIP account for paging using the Web GUI, under the Applications menu, click Least Cost Routing. The following page appears. Refer to the table below for a description of each parameter and valid values. After you change the values of fields, click Save. If you want to reset the Least Cost Routing settings, click Remove Configuration File. This action removes the file <mac-address>.lcr from the WARP appliance. To configure the SIP account for Least Cost Routing using a configuration file, use a standard text editor and create the file <mac-address>.lcr. Store the file on an FTP or TFTP server. The file format is: parameter_name,value Page 48 Copyright 2011 PIKA Technologies Inc. Sep 2011

51 Administrator's Guide The following shows an example of <mac-address>.lcr: auth_username, auth_password,password username, domain,yourdomain.com domain_proxy,proxy.yourdomain.com dtmfmode,rfc2833 GSM Least Cost Routing Parameters The following tables describe each parameter and possible values. Parameter auth_username (configuration file) Authorization User (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.lcr Web GUI Applications menu -> Least Cost Routing Authentication user name provided by the hosted PBX service provider. Used when a Registration Request is challenged. Yes Not applicable Text string Parameter auth_password (configuration file) Authorization Password (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.lcr Web GUI Applications menu -> Least Cost Routing The password used to authenticate the WARP appliance with the external SIP server. Yes Not applicable Text string Parameter username (configuration file) Username (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.lcr Web GUI Applications menu -> Least Cost Routing SIP user agent account name provided by the hosted PBX service provider The value is usually the same as auth_username. Yes Not applicable Text string September 2011 Copyright 2011 PIKA Technologies Inc. Page 49

52 Administrators Guide Parameter domain (configuration file) Domain (Web GUI) Description Mandatory Default Configuration file - <mac-address>.lcr Web GUI Applications menu -> Least Cost Routing The domain of the external SIP server to register the WARP appliance against. This value is required if domain_proxy is not provisioned. If both parameters are missing, pager configuration fails. Yes The value of domain_proxy (configuration file) Valid values Proxy (Web GUI) Text string Parameter domain_proxy (configuration file) Proxy (Web GUI) Description Mandatory Default Configuration file - <mac-address>.lcr Web GUI Applications menu -> Least Cost Routing The proxy for the external SIP server. All SIP packets are sent to the proxy when provisioned. This value is required if domain is not provisioned. If both parameters are missing, pager configuration fails. Yes The value of domain (configuration file) Domain (Web GUI) Page 50 Copyright 2011 PIKA Technologies Inc. Sep 2011

53 Administrator's Guide Parameter dtmfmode (configuration file) DTMF Mode (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.lcr Web GUI Applications menu -> Least Cost Routing You may need to change this parameter if you are unable to select which group you want to page by pressing digits on your phone. Typically, the value should be consistent with the mode used for the SIP phones on the network. No rfc2833 info: Use SIP INFO messages for DTMF digits rfc2833: Use RFC2833 inband: Inband audio (requires 64 kilobit codec - alaw, ulaw) auto: Use RFC2833 if offered, otherwise, use inband September 2011 Copyright 2011 PIKA Technologies Inc. Page 51

54 Administrators Guide Parameter usercontext (configuration file) User Context (Web GUI) Description Configuration file - <mac-address>.lcr Web GUI Applications menu -> Least Cost Routing The WARP appliance uses an internal context, for example warppager, in its Address of Record in the Contact header used during registration, for example, warppager@ip_address. Some edge devices need the username to match the To header. This parameter indicates whether to use the username assigned to the SIP UA account in the Contact header. If you use an edge device and are having problems with call routing, enabling this parameter may resolve the problem. Mandatory Default Valid values If you use an edge device and are having problems with call routing, enabling this parameter may resolve the problem. No disable disable: Use internal context in Contact header enable: Use username in Contact header Using the GSM Least Cost Routing Feature Users of the GSM Least Cost Routing feature should be aware of the following: The application cannot detect whether a Pay-As-You-Go SIM card is out of minutes. The user placing the call hears a message from the GSM network indicating that there are no minutes available, in which case the user should inform their system administrator. If there are multiple SIM cards, the application cannot determine which card is out of minutes. When the user finishes dialing, there is a delay before the user hears ring back from the far end. Press the # key to indicate that dialing is complete. Refer also to section System Settings on page 24 for information about enabling early ringback. Incoming and outgoing SMS is not supported. SIM cards should not have voice mail enabled. If all GSM trunks are in use, the user hears a congestion tone. Page 52 Copyright 2011 PIKA Technologies Inc. Sep 2011

55 Administrator's Guide Local and External IP Survivability Configuration To use the Least Cost Routing feature, you must provision a list of phones that can use the survivability feature. Optionally, you can also provision the GSM trunk settings. Refer to section Configuring GSM Trunks on page 83 for more information. SIP Phone Account Configuration To configure the list of phones using the Web GUI, under the Applications menu, click Survivability SIP UA. The following page appears. Refer to the table below for a description of each parameter and valid values. After you change the values of fields, click Save. To configure a list of phones using a configuration file, use a standard text editor to create the file <mac-address>.users. Store the file on an FTP or TFTP server. The file format is: username,auth_username,auth_password,extension,callerid_name,dtmf mode Substitute commas for any unspecified optional parameters. Refer to the example below. The following shows an example of the file <mac-address>.users: ,password,1019,Joe Smith,rfc ,password,,Mary Jones,rfc ,password,,Alice Munster, 1099,password,,, September 2011 Copyright 2011 PIKA Technologies Inc. Page 53

56 Administrators Guide IP Survivability Phone Configuration Parameters The following tables describe each parameter and possible values. Parameter username (configuration file) Username (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.users Web GUI Applications menu -> Survivability SIP UA SIP UA account username used to identify the phone with the WARP appliance. Yes Not applicable Text string Parameter auth_username (configuration file) Authorization User (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.users Web GUI Applications menu -> Survivability SIP UA Authentication user name used when the WARP appliance challenges a Registration Request. No Value of extension (configuration file) Extension (Web GUI) Text string Parameter password (configuration file) Authorization Password (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.users Web GUI Applications menu -> Survivability SIP UA SIP UA account password used to register with the WARP appliance. We recommend that you use the password used to register the phone with the BroadSoft switch. Yes Not applicable Text string Page 54 Copyright 2011 PIKA Technologies Inc. Sep 2011

57 Administrator's Guide Parameter extension (configuration file) Extension (Web GUI) Description Configuration file - <mac-address>.users Web GUI Applications menu -> Survivability SIP UA The extension number of the SIP phone. We recommend that you use the extension used to register the phone with the BroadSoft switch. Mandatory Default Valid values Provision this parameter to route calls to the phone using an extension (normally a subset of the username). Refer to the entry for user Joe Smith in the example below. No Value of the parameter username (configuration file) Extension (Web GUI) Integer value Parameter callerid_name (configuration file) Caller ID (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.users Web GUI Applications menu -> Survivability SIP UA Caller ID of the phone. We recommend that you use the caller ID provisioned on the BroadSoft switch. No None Alphanumeric characters September 2011 Copyright 2011 PIKA Technologies Inc. Page 55

58 Administrators Guide Parameter dtmfmode (configuration file) DTMF Mode (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.users Web GUI Applications menu -> Survivability SIP UA Mode used to receive DTMF digits from the SIP phones. No rfc2833 info: Use SIP INFO messages for DTMF digits rfc2833: Use RFC2833 inband: Inband audio (requires 64 kilobit codec - alaw, ulaw) auto: Use RFC2833 if offered, otherwise, use inband IP Survivability Configuration It is only necessary to provision these parameters if you want to change the default behaviour of the IP Survivability feature. To change the settings using the Web GUI, under the Applications menu, click Survivability Settings. The following page appears. Refer to the table below for a description of each parameter and valid values. After you change the values of fields, click Save. To configure IP Survivability using a configuration file, use a standard text editor and create the file <mac-address>.survive. Store the file on an FTP or TFTP server. The file format is: parameter_name,value Page 56 Copyright 2011 PIKA Technologies Inc. Sep 2011

59 Administrator's Guide The following shows an example of the file <mac-address>.survive: incoming_ivr,enable outgoing_min_digits,10 outgoing_prefix,9 emergency_number,911 IP Survivability Configuration Parameters The following tables describe each parameter and possible values. Parameter incoming_ivr (configuration file) IVR (Web GUI) Description Configuration file - <mac-address>.survive Web GUI Applications menu -> Survivability Settings Determines whether to answer incoming calls to any of the GSM ports in the system. If enabled, the user hears a message asking for an extension to dial. If disabled, incoming calls are not answered. The user continues to hear ringback. Mandatory Default Valid values You may want to disable this feature to avoid tariff fees. No enable disable: Do not answer incoming calls while in survivability mode enable: Answer incoming calls while in survivability mode September 2011 Copyright 2011 PIKA Technologies Inc. Page 57

60 Administrators Guide Parameter outgoing_min_digits (configuration file) Minimum Outgoing Digits (Web GUI) Description Configuration file - <mac-address>.survive Web GUI Applications menu -> Survivability Settings If a prefix is required to dial outgoing calls to the PSTN, the value must be provisioned. Many PBXs use the number 9. If this number is set, the value of this parameter will be stripped from the dialed number before the call is placed to the PSTN. Mandatory Default 7 Valid values Parameter Defines the minimum number of digits required to make an outgoing call to the PSTN using the GSM trunks. In North America this is usually 7 or 10 while in Europe it is usually 11. The value for this parameter must match the dialing requirements of the network. No Integer value. It should include only the number of digits after outgoing_prefix (configuration file) or Minimum Outgoing Digits (Web GUI). outgoing_prefix (configuration file) Outgoing Digits Prefix (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.survive Web GUI Applications menu -> Survivability Settings If a prefix is required to dial outgoing calls to the PSTN, the value must be provisioned. Many PBXs use the number 9. If this number is set, the value of this parameter will be stripped from the dialed number before the call is placed to the PSTN. No None Integer value Parameter emergency_number (configuration file) Emergency Number (Web GUI) Configuration file - <mac-address>.survive Web GUI Applications menu -> Survivability Settings Page 58 Copyright 2011 PIKA Technologies Inc. Sep 2011

61 Administrator's Guide Description Specifies the number used to access emergency services in your location. To access emergency services when IP survivability is active, ensure that this parameter is provisioned. If an outgoing prefix is provisioned, it is valid but not required to use the prefix when dialing the emergency number. For example, if the prefix value is 9 and the emergency number is 911, both 9911 and 911 are acceptable. Mandatory Default Valid values The number in North America is 911. No None Integer value SIP Phone Configuration Each phone that uses the IP survivability feature must provision the WARP appliance as a fallback registrar in the appropriate phone configuration file. Ensure that phones using this feature have the latest firmware installed. If you use an edge device, ensure that the phones do not use the edge device as a fallback registrar. Polycom Polycom phones support configuration of multiple servers per SIP registration for server redundancy. At start time, SIP phones register with all configured servers. New outgoing calls automatically use the fallback server if the primary server (the BroadSoft switch) is unreachable. When the connection to the primary server is restored, the phone automatically resumes normal call routing through the BroadSoft switch. In the per-phone configuration file, phone<mac-address>.cfg, where <mac-address> is the MAC address of the Polycom phone, change or add the following parameters: reg.1.server.2.address o The value must be the IP address of the WARP appliance. reg.1.auth.optimizedinfailover o If the value is 0, new calls will automatically use the fallback server provisioned in reg.1.server.2.address if the primary server (the BroadSoft switch) is unreachable. September 2011 Copyright 2011 PIKA Technologies Inc. Page 59

62 Administrators Guide The following shows an example of the phone s configuration file using the Joe Smith user and a WARP appliance with the IP address <reg reg.1.displayname="joe Smith" reg.1.address="1019" reg.1.label="" reg.1.type="private" reg.1.lcs="" reg.1.csta="" reg.1.thirdpartyname="" reg.1.auth.userid="1019" reg.1.auth.password="password" reg.1.auth.optimizedinfailover="0" reg.1.musiconhold.uri="" reg.1.server.1.address=" " reg.1.server.1.port="" reg.1.server.1.transport="dnsnaptr" reg.1.server.1.expires="30" reg.1.server.1.expires.overlap="" reg.1.server.1.register="1" reg.1.server.1.retrytimeout="" reg.1.server.1.retrymaxcount="" reg.1.server.1.expires.lineseize="" reg.1.server.1.lcs="" reg.1.server.2.address=" " reg.1.server.2.port="" reg.1.server.2.transport="dnsnaptr" reg.1.server.2.expires="30" reg.1.server.2.expires.overlap="" reg.1.server.2.register="1" reg.1.server.2.retrytimeout="" reg.1.server.2.retrymaxcount="" reg.1.server.2.expires.lineseize="" reg.1.server.2.lcs="" reg.1.outboundproxy.address="" reg.1.outboundproxy.port="" reg.1.outboundproxy.transport="" reg.1.acd-login-logout="0" reg.1.acd-agent-available="0" reg.1.proxyrequire="" reg.1.ringtype="2" reg.1.linekeys="" reg.1.callsperlinekey="" reg.1.bargeinenabled="" reg.1.serverfeaturecontrol.dnd="" reg.1.serverfeaturecontrol.cf="" reg.1.strictlineseize="" reg.1.tcpfastfailover="" reg.1.protocol.sip="1" reg.1.protocol.h323="" reg.1.server.h323.1.address="" reg.1.server.h323.1.port="" reg.1.server.h323.1.expires="" /> Cisco A fallback registrar for Cisco phones can be provisioned in the phone specific configuration file which is named using the phone model number and MAC address. For example, for phone model SPA504 with MAC address is 00:1e:79:00:05:ab, the corresponding Cisco phone configuration file would be spa001e790005ab.xml. Firmware version or higher is required. New outgoing calls attempt to use the server with the highest priority (the BroadSoft switch). If there is no response from the server within the time period defined by Proxy Fallback Intvl, the phone automatically attempts the call using the server with the next highest priority (the WARP appliance). When the connection to the primary server is restored, the phone automatically resumes normal call routing through the BroadSoft switch. The following shows an example of the phone s configuration file using the Joe Smith and a WARP appliance with the IP address The example is shown in XML-style format. For other formatting options, or to use the phone s GUI, consult your Cisco phone administrator s guide for more information. For information about SIP proxy redundancy on Cisco phones, refer to Page 60 Copyright 2011 PIKA Technologies Inc. Sep 2011

63 Administrator's Guide  <Proxy_1_ ua="na">my_proxies:srv= :5060:p=1:w= :5060:p=2:w=30< /Proxy_1_> <Outbound_Proxy_1_ ua="na"></outbound_proxy_1_> <Use_Outbound_Proxy_1_ ua="na">no</use_outbound_proxy_1_> <Use_OB_Proxy_In_Dialog_1_ ua="na">yes</use_ob_proxy_in_dialog_1_> <Register_1_ ua="na">yes</register_1_> <Make_Call_Without_Reg_1_ ua="na">no</make_call_without_reg_1_> <Register_Expires_1_ ua="na">60</register_expires_1_> <Ans_Call_Without_Reg_1_ ua="na">no</ans_call_without_reg_1_> <Use_DNS_SRV_1_ ua="na">yes</use_dns_srv_1_> <DNS_SRV_Auto_Prefix_1_ ua="na">no</dns_srv_auto_prefix_1_> <Proxy_Fallback_Intvl_1_ ua="na">60</proxy_fallback_intvl_1_> <Proxy_Redundancy_Method_1_ ua="na">normal</proxy_redundancy_method_1_>  <Display_Name_1_ ua="na">joe Smith</Display_Name_1_> <User_ID_1_ ua="na">1019</user_id_1_> <Password_1_ ua="na">password</password_1_> <Use_Auth_ID_1_ ua="na">no</use_auth_id_1_> <Auth_ID_1_ ua="na"></auth_id_1_> <Mini_Certificate_1_ ua="na"></mini_certificate_1_> <SRTP_Private_Key_1_ ua="na"></srtp_private_key_1_> September 2011 Copyright 2011 PIKA Technologies Inc. Page 61

64 Administrators Guide The following table provides more details about the settings to change. Field Default Recommended Value Proxy None Manually defined DNS SRV Description In the example above: MY_PROXIES - An arbitrary name of your choice. SRV - Indicates a manual DNS SRV entry : The address and SIP registration port of the primary proxy. This should be set to the IP address of the BroadSoft switch. p=1 - The priority of the proxy. Smaller numbers have higher priority. w=50 - The weight of the proxy. The larger the number the higher the probability of it being used. - A character to separate proxy entries : The address and SIP registration port for the secondary proxy. This should be set to the IP address of the WARP appliance p=2 - This is the secondary proxy. w=30 - The weight of the proxy. NOTE: Port number is optional. The default is port Use DNS SRV No Yes Enables DNS SRV lookup for the proxy and outbound proxy. Proxy Fallback Intvl Specifies how long to wait, in seconds, before attempting to use a lower priority proxy after the connection to the highest priority has failed. The phone should have the primary and backup proxy server list via the DNS SRV record look up on the server name. It needs to know proxy priority; otherwise, it does not retry. Page 62 Copyright 2011 PIKA Technologies Inc. Sep 2011

65 Administrator's Guide Aastra Aastra phones first attempt to register with the primary proxy when the registration period expires. If the proxy is unreachable, either when attempting a phone call or when the registration period expires, the phone automatically registers with the backup proxy (the WARP appliance). When the connection to the BroadSoft switch is restored, the phone reestablishes its registration to the primary proxy when the registration period expires. Any calls made after the connection is restored but before the registration expires continue to use the WARP appliance. The timeout value should be carefully chosen to minimize this time window without causing excess network traffic. Add the entries shown in bold in the phone s SIP configuration file (<mac-address>.pager). sip line1 auth name: 1019 sip line1 password: "password" sip line1 user name: 1019 sip line1 display name: Joe Smith sip line1 screen name: Joe Smith sip line1 proxy ip: sip line1 proxy port: 5060 sip line1 registrar ip: sip line1 registrar port: 5060 sip line1 registration period: 60 sip line1 backup proxy ip: sip line1 backup proxy port: 5060 sip line1 backup registrar ip: sip line1 backup registrar port: 5060 sip line1 vmail: *98 sip line1 mode: 0 snom snom phones do not use a fallback registrar but instead use a second line which registers with a different proxy. The Primary Identity registers with the BroadSoft switch while the Failover Identity registers with the WARP appliance. If the proxy for the Primary Identity is unreachable, either when attempting a phone call or when the registration period expires, the phone automatically switches to the Failover Identity (the WARP appliance). When the connection to the BroadSoft switch is restored, the phone switches back to the Primary Identity the next time the registration period expires. Any calls made after the connection is restored but before the registration expires continue to use the WARP appliance. The timeout value should be carefully chosen to minimize this time window without causing excess network traffic. September 2011 Copyright 2011 PIKA Technologies Inc. Page 63

66 Administrators Guide The following shows an example of a snom phone registration settings.xml with a Failover Identity provisioned. It uses the Joe Smith user from the example <mac-address>.survive above and a WARP appliance with the IP address <user_realname idx="1" perm="rw">joe Smith</user_realname> <user_realname idx="2" perm="rw">joe Smith</user_realname> <user_name idx="1" perm="rw">1019</user_name> <user_name idx="2" perm="rw">1019</user_name> <user_host idx="1" perm="rw"> </user_host> <user_host idx="2" perm="rw"> </user_host> <user_pname idx="1" perm="rw">1019</user_pname> <user_pname idx="2" perm="rw">1019</user_pname> <user_pass idx="1" perm="rw">password</user_pass> <user_pass idx="2" perm="rw">password</user_pass> <user_expiry idx="1" perm="rw">60</user_expiry> <user_descr_contact idx="1" perm="rw">off</user_descr_contact> <user_outbound idx="1" perm="rw"> </user_outbound> <user_outbound idx="2" perm="rw"> </user_outbound> <user_failover_identity idx="1" perm="rw">2</user_failover_identity> <user_subscription_expiry idx="1" perm="rw">60</user_subscription_expiry> Using the IP Survivability Feature Users of the IP Survivability feature should be aware of the following: The application cannot detect whether a Pay-As-You-Go SIM card is out of minutes. The user placing the call hears a message from the GSM network indicating that there are no minutes available. The user should inform their system administrator when this occurs. If there are multiple SIM cards, the application cannot determine which card is out of minutes. When the user finishes dialing, there is a delay before the user hears ring back from the far end. Press the # key to indicate that dialing is complete. Refer also to section System Settings on page 24 for information about enabling early ringback. Incoming and outgoing SMS is not supported. SIM cards should not have voice mail enabled on them. If all GSM trunks are in use, the user hears a congestion tone. When the connection to the BroadSoft switch is restored, Aastra and snom phones continue to use the WARP appliance to make calls until the registration period expires. The registration timeout value should be carefully chosen to minimize this time window without causing excess network traffic. Incoming calls to users of these phone models fail until the registration to the WARP appliance expires. If there is no GSM module installed in the WARP appliance, only calls between users on the WARP appliance are successful. All external outbound and inbound calls fail. Voice mail does not work in survivability mode. Other WARP Plus features (LCR, MoH, Paging) work as expected in survivability mode. If you use an edge device, ensure that you disable survivability mode on the edge device. BroadSoft Switch Configuration To route incoming calls through the WARP appliance when the WAN connection is unavailable, you need to provision the call forward unavailable feature. The value should be the external PSTN number assigned to the WARP appliance. Page 64 Copyright 2011 PIKA Technologies Inc. Sep 2011

67 Administrator's Guide General SIP Settings SIP parameters that are affect SIP accounts for all features and SIP settings that are not specific to a SIP account are provisioned on the General SIP Settings page. Under the Applications menu, click General SIP Settings. The following page appears. The time interval used to refresh the registration of SIP users to the SIP registrar is determined by the value of the SIP Registration Expiry Interval parameter. You may need to change this parameter if you use an edge device or SIP proxy that requires a different time interval. To change the refresh interval, in the SIP Registration Expiry Interval box, type the new value and click the Save button. You can also provision the expiration interval in the configuration file <mac-address>.warp. The relevant parameter is: default_expiry To configure the WARP appliance to restart when a remote restart is initiated from the BroadSoft Administration, in the Remote Reset Code box, click check-sync and click the Save button. You can also provision remote restart in the configuration file <mac-address>.warp. The relevant parameter is: notify_reset Change the fields to the appropriate values and click Save. To complete the changes, you must use the Apply Configuration Changes page under the Maintenance menu. Refer to Entering Information Using the Web GUI on page 18 for more information. Refer to section on System Parameters on page 66 for more information. September 2011 Copyright 2011 PIKA Technologies Inc. Page 65

68 Administrators Guide System Parameters The following table describes parameters in the file <mac-address>.warp that are not specific to any application. You do not have to create this file if you do not want to change the default values of the parameters. The file format is: parameter_name,value The following table describes each parameter and possible values. Parameter name Description Default Notes ftp_server IP address of a static None FTP/TFTP server. ftp_user The user name used to log on to the FTP server. The FTP server can be provisioned using options 66/150 on your network or using the value of ftp_server. ftp_password network_dhcp The password used to log on to the FTP server. The FTP server can be provisioned using options 66/150 on your network or using the value of ftp_server. Determines whether the WARP should get an IP address using DHCP. PlcmSpIp Mandatory for an FTP server that requires a user name and password. The default value is only used if you are using an FTP server defined by options 66/150 on your network. PlcmSpIp Mandatory for an FTP server that requires a user name and password. The default value is only used if you are using an FTP server defined by options 66/150 on your network. yes Valid values for this parameter are: yes: Use DHCP to obtain an IP address for the WARP appliance. no: Use a static IP address for the WARP appliance. See below for the additional parameters that must be provisioned. network_ip The IP address assigned to the WARP appliance. None This parameter is ignored if the value of network_dhcp is enable. You must provision this parameter if network_dhcp is set to disable. Page 66 Copyright 2011 PIKA Technologies Inc. Sep 2011

69 Administrator's Guide Parameter name Description Default Notes network_dns The IP address of the DNS to use on the network. None This parameter is ignored if the value of network_dhcp is enable. network_netmask The IP address of the gateway to use on the network. None You must provision this parameter if network_dhcp is set to disable. This parameter is ignored if the value of network_dhcp is enable. You must provision this parameter if network_dhcp is set to disable. network_gateway The netmask of the network. None This parameter is ignored if the value of network_dhcp is enable. network_hostname ntp_server utc_offset The host name assigned to warp the WARP appliance. The IPv4 address of the None NTP server to use to retrieve the current date and time from during system start up. The time offset from UTC for the time zone where the WARP appliance is located. gui_admin_username The name to use for the admin Administrator account for the web GUI on the WARP appliance. gui_admin_password The password for the pikapika Administrator account for the web GUI on the WARP appliance. gui_user_username The name to use for the User pager account for the web GUI on the WARP appliance. gui_user_password The password for the User account for the web GUI on the WARP appliance. pikapika You must provision this parameter if network_dhcp is set to disable. If option 42 is set on the DHCP server that the WARP connects to, this parameter is ignored unless the time cannot be retrieved from the server defined by option 42. None The valid values are from -12 through 12. If time zone information is obtained using DHCP option 2, it is not necessary to provision this parameter. September 2011 Copyright 2011 PIKA Technologies Inc. Page 67

70 Administrators Guide Parameter name Description Default Notes country The country code for the tone set to use for tones such as dial tone, congestion, or ringback. us early_ringback There may be a delay when establishing calls to the GSM network when using the Least Cost Routing and IP Survivability. During this time, the user hears silence on the line and may interpret this to mean the call is unsuccessful. This parameter specifies whether the WARP appliance or the GSM network plays ringback to the calling party. The ringback tone the user hears is determined by the value of the country parameter. There may be scenarios, such as when the far end party is busy, when the tone the user hears ringback which does not reflect the actual state of the call. If this is unacceptable, you can disable this setting. enable Valid values for this parameter are: br : Brazil cl : Chile de : Germany es : Spain fr : France in : India it : Italy mx : Mexico nl : Netherlands uk : United Kingdom us : Standard North America ve : Venezuela Valid values for this parameter are: enable: The WARP appliance plays ringback to the calling party for outbound GSM calls. disable: The GSM network plays ringback to the calling party for outbound GSM calls. Page 68 Copyright 2011 PIKA Technologies Inc. Sep 2011

71 Administrator's Guide Parameter name Description Default Notes notify_reset This parameter is used to support remote reset from None Valid values for this parameter are: the BroadSoft switch. When you click Reboot Phone from the BroadSoft Administration interface, it sends a SIP NOTIFY to reset the device. check-sync: When the WARP appliance receives SIP_NOTIFY message that includes the checksync event, it a responds with a 200 OK and the WARP appliance restarts. None: The WARP appliance responds to the incoming SIP_NOTIFY with a 200 OK but does not restart. default_expiry The time interval used to refresh the registration with the SIP Registrar. This period is typically between 30 and 60 seconds. You may need to change this parameter if you use an edge device or SIP proxy that requires a different time interval. 30 Any integer number is valid. September 2011 Copyright 2011 PIKA Technologies Inc. Page 69

72 Administrators Guide Chapter 5 Troubleshooting This chapter describes the information available to troubleshoot configuration, registration, network, and upgrade problems. LCD Status and error information is displayed on the LCD. During the WARP appliance startup sequence, the display shows the message Please Wait Loading As part of the startup sequence, the upgrade software checks for new software. If new software is available on the FTP/TFTP server, the display shows messages to indicate the progress of the upgrade. When the WARP appliance is ready to use, there are three screen displays and you can switch between the displays using the touch sensitive toggle button next to the LCD. Figure 9 - Toggle Button The three screens are: Title the main screen, shows WARP Plus. Underneath, Version version shows the version of the software running on the WARP appliance. IP Address of the WARP appliance Error screen displays codes for any errors that occur during configuration or upgrade Page 70 Copyright 2011 PIKA Technologies Inc. Sep 2011

73 Administrator's Guide Error Codes The following table describes the list of error codes that may be displayed on the ERROR CODES screen on the LCD and the System Status page and describes possible solutions to problems. Error Description Code 1 Could not retrieve configuration files from FTP/TFTP server 2 Could not retrieve configuration files from static FTP/TFTP server Diagnosis Confirm the following: Option 66 or 150 is set on your DHCP server. If you use an FTP server that requires a user name and password, confirm the values of the parameters in the file <mac-address>.warp: o ftp_password o ftp_user There is no firewall blocking access to the FTP/TFTP server. The FTP/TFTP server is running The file names use the correct MAC address in lower case with no colons. Consult the file updates.log on the WARP appliance for additional details. Confirm the following: The static FTP/TFTP server information provisioned in the file <mac-address>.warp has the correct values for the parameters: o ftp_server o ftp_password (if applicable) o ftp_user (if applicable) There is no firewall blocking access to the FTP/TFTP server The FTP/TFTP server is running The file names use the correct MAC address in lower case with no colons. Consult the file updates.log on the WARP appliance for additional details. September 2011 Copyright 2011 PIKA Technologies Inc. Page 71

74 Administrators Guide Error Description Code 3 Could not determine the IP address of all the phones listed in the file <macaddress>.phones 4 The WARP appliance could not register with the BroadSoft switch using values defined in the configuration files. Diagnosis Confirm the following: All phones are turned on All phones are connected to the network All phones are on the same LAN as the WARP appliance MAC addresses of the phones are correctly specified in lower case in the file <mac-address>.phones Phone extensions are correct in the file <mac-address>.phones The MAC address, extension, and group number (if applicable) must be separated by a comma Consult the file configuration.log for additional information. This error appears if the registration attempt failed or did not complete within the expected time. Confirm the following if the WARP appliance remains unregistered: Ensure that the registration server information provisioned in the files <mac-address>.pager, <macaddress>.lcr, and <mac-address>.moh have the correct values for the parameters: o username o auth_password o auth_username o domain or domain_proxy There is no firewall blocking access to the registration server. 7 The parameter username is missing from the file <mac-address>.pager, <mac-address>.lcr, or <macaddress>.moh. Consult the file configuration.log for additional information. This parameter is mandatory for the Paging, LCR, and MoH features. Ensure that the parameter exists in the associated file and is spelled correctly. Consult the file configuration.log for additional information. Page 72 Copyright 2011 PIKA Technologies Inc. Sep 2011

75 Administrator's Guide Error Description Code 8 The parameter auth_username is missing from the file <macaddress>.pager, <mac-address>.lcr, or <mac-address>.moh. 9 The parameter auth_password is missing from the file <macaddress>.pager, <mac-address>.lcr, or <mac-address>.moh. 10 The parameters domain and domain_proxy are both missing from the file <mac-address>.pager, <macaddress>.lcr, or <mac-address>.moh. 11 There is an invalid parameter in the file mac-address>.pager, <mac-address>.lcr, or <mac-address>.moh. Diagnosis This parameter is mandatory for the Paging, LCR, and MoH features. Ensure that the parameter exists in the associated file and is spelled correctly. Consult the file configuration.log for additional information. This parameter is mandatory for the Paging, LCR, and MoH features. Ensure that the parameter exists in the associated file and is spelled correctly. Consult the file configuration.log for additional information. You must provision either the parameter domain or the parameter domain_proxy in the configuration file for the Paging, LCR, and MoH features. Check that one of the parameters exists in the file and is spelled correctly. Consult the file configuration.log for additional information. Ensure that the only the required parameters exist in the file and that all parameters are spelled correctly in lower case. Consult the file configuration.log for additional information. 12 An upgrade attempt failed. Confirm the following: The TFTP/FTP server information is correct. o If you use DHCP, ensure that option 66 or 150 is set on your DHCP server. o If you use a static TFTP/FTP server, ensure that the values for the following parameters in the file <mac-address>.pager are correct: ftp_server ftp_password (if applicable) ftp_user (if applicable) There is no firewall blocking access to the FTP/TFTP server. The FTP/TFTP server is running. All required files for update are on the FTP/TFTP server Consult the file updates.log on the WARP Pager for additional details. September 2011 Copyright 2011 PIKA Technologies Inc. Page 73

76 Administrators Guide Error Description Code 13 One or more phones in the file <macaddress>.phone do not have a group provisioned. 14 One or more phones in the file <macaddress>.phones have one or more invalid groups provisioned. 15 There are more than 15 phones provisioned or the file <mac-address>.phones. 16 An optional parameter in the file <macaddress>.pager, <mac-address>.lcr, or <mac-address>.moh. has an invalid value. 17 A parameter in the file <macaddress>.pager, <mac-address>.lcr, or <mac-address>.moh. was provisioned more than once. 18 The parameter gsm_trunks in the file <mac-address>.trunks has an invalid value. Diagnosis If you use the WARP Pager 40SZ and the value of the parameter use_ivr is enable, each phone must have one or more groups provisioned in the file <mac-address>.phones file. Ensure that all the phones provisioned in the file have at least one group provisioned. Any phone without a group cannot be paged. Consult the file configuration.log for a list of phones that do not have a group provisioned. The WARP Pager 40SZ supports groups numbered 0 to 9. One or more phones have an invalid group number provisioned in the file <mac-address>.phones file. Ensure that all phones have valid group numbers in the range 0-9. Consult the file configuration.log for a list of phones that the error applies to. The WARP Pager 15 supports a single paging group contain up to 15 phones. Additional phones provisioned in the file <mac-address>.phones are ignored. Consult the file configuration.log for the list of phones that are ignored. This error applies to the parameters such as dtmfmode. The default value for the parameter is used. Consult the file configuration.log for a list of parameters that have an invalid value. The first instance of the parameter is used and all subsequent instances are ignored. Consult the file configuration.log for a list of parameters that caused the error. This error can occur only if the WARP appliance has an LCR or IP Survivability license. Ensure that the value is from 1 through 4 and does not exceed the number of GSM trunks present in the system. Consult the file configuration.log file for additional details. If this error occurs, all GSM trunks in the system are configured. Page 74 Copyright 2011 PIKA Technologies Inc. Sep 2011

77 Administrator's Guide Error Description Code 19 Configuration parameters for the LCR feature are present in the file <macaddress>.lcr but the feature cannot be configured. 20 Configuration parameters for the MOH feature are present in the file <macaddress>.moh but the feature cannot be configured. 21 Configuration parameters for the IP Survivability feature are present in the file <mac-address>.survive but the feature cannot be configured. 22 Configuration parameters for the Paging feature are present in the file <macaddress>.pager but the feature cannot be configured. 23 A mandatory parameter in the file <macaddress>.users is missing. Diagnosis Confirm the following: Check if the WARP appliance has a LCR license. There is a GSM module installed in the WARP appliance. Consult the file configuration.log for additional details. This error can occur if the WARP appliance does not have a MOH license. Confirm the following: Check if the WARP appliance has an IP Survivability license. There is a GSM module installed in the WARP appliance. Consult the file configuration.log for additional details. Confirm the following: Check if the WARP appliance has Pager 15 or Pager 40SZ license. There is a <mac-address>.phones file. Consult the file configuration.log for additional details. Confirm that all the entries in the file < macaddress >.users have a username and password. Consult the file configuration.log for additional details. September 2011 Copyright 2011 PIKA Technologies Inc. Page 75

78 Administrators Guide Logs The applications write status and error messages to log files. Log files are stored on the WARP appliance and you can view them using the GUI. Under the Maintenance menu, click Logs. The following page appears. The following files may be present: configuration.log feature configuration information and error messages flash.log messages call processing error messages pager.pcap network packet data for troubleshooting SIP registration issues updates.log upgrade and server discovery information and error messages Log files are rotated to limit the amount of space used. The five most recent sets of logs are available: current current1 current2 current3 current4. Older log files are discarded when the system restarts. Page 76 Copyright 2011 PIKA Technologies Inc. Sep 2011

79 Administrator's Guide To view a set of log files, click the link to the set of logs you want to view. For example, to view the most recent set of log files, click the current link. The following figure shows an example of the page that appears. To view the log file using your browser, click the View button. To download the log file to your local computer, click the Download button. You cannot use your browser to view the file pager.pcap. You must download the file to your computer and use a network protocol analyzer application, such as Wireshark, to view the logs. September 2011 Copyright 2011 PIKA Technologies Inc. Page 77

80 Administrators Guide PCAP Logging You collect network packet data for troubleshooting network and registration problems. Under the Maintenance menu, click PCAP Logging. The following page appears. The Packet Capture Count box specifies how many packets to capture. If you want to change number of packets to collect, type the number in the box. To enable PCAP logs, click Enable PCAP Logging. Packet capture starts the next time you restart the WARP appliance. Packet capture stops either when the number of packets to collect has been reached or after you restart the WARP appliance. To disable packet capture, click Disable PCAP Logging. After any changes to PCAP logging settings, you need to restart the WARP Appliance. Refer to section Restarting the WARP Appliance on page 87 for instructions. To retrieve the PCAP log file for analysis, refer to section Logs on page 76 for information. Note that you cannot use your browser to view the file. You must download the file to your computer and use a network protocol analyzer application, such as Wireshark, to view the logs. Page 78 Copyright 2011 PIKA Technologies Inc. Sep 2011

81 Administrator's Guide Status Information You can use the GUI to view the following: o System status o Network status o GSM trunk status o BroadSoft connection status o SIP user registration status System Status Under the System menu, click Status. The following page appears. The page shows the following: how long the system has been running system temperature firmware versions error code descriptions refer to the section Error Codes on page 71 for information If the WARP appliance reaches 65 degrees Celsius (149 degrees Fahrenheit), the appliance stops running to prevent overheating. Ensure that there is proper airflow and cooling in the appliance location. September 2011 Copyright 2011 PIKA Technologies Inc. Page 79

82 Administrators Guide Network Status Under the Network menu, click Network Status. After a few seconds, the following page appears. The page shows information about the network interface and network routing information. GSM Status To view information about the connection to your wireless provider, under the Connections menu, click GSM Status. The following page appears. Page 80 Copyright 2011 PIKA Technologies Inc. Sep 2011

83 Administrator's Guide The page shows the wireless provider information for each SIM card used in the appliance. Note the port numbering described in section Configuring GSM Trunks on page 83 to determine the port corresponding to the SIM card. Broadsoft Connection Status To view information about the status of the connections to the BroadSoft switch, under the Connections menu, click Broadsoft Connection Status. The following page appears. The page shows the registration status of the SIP user account for each feature (Paging, Music on Hold, GSM Least Cost Routing). The User column corresponds to the username (configuration file)/username (Web GUI) parameter. The Host column shows the IP address and port number of the WARP appliance. The Timeout column corresponds to the expiration (configuration file)/expiration (Web GUI) parameter. SIP User Connection Status To view information about the SIP phones registered to the WARP appliance, under the Connections menu, click SIP User Connection Status. The following page appears. September 2011 Copyright 2011 PIKA Technologies Inc. Page 81

84 Administrators Guide The information on this page applies to the IP Survivability feature. The Extension column shows the extensions or user names provisioned on the SIP Survivability UA page. When the WAN connection functions normally, the Status column shows Aastra and Cisco phones as unregistered, Polycom phones show as registered and snom phones may show as registered. In survivability mode, all phones should be registered if they are turned on. Additional Help Under the Troubleshooting menu, click Help. The following page appears. Click the link WARP Plus downloads and documents to view the WARP Plus: downloads and docs page on the PIKA Technologies Web site. Click the link Support to send a question or comment to the PIKA Customer Care department. Page 82 Copyright 2011 PIKA Technologies Inc. Sep 2011

85 Administrator's Guide Chapter 6 Other Administrator Tasks This chapter describes how to: Configure GSM trunks Change the Web GUI account names and passwords Restart the WARP appliance Reset the WARP appliance to factory settings Upgrade the WARP appliance software Log on to the WARP appliance from another computer Configuring GSM Trunks By default, all available GSM trunks are configured. It is only necessary to configure the trunks if you want to use a subset of available GSM trunks or if your SIM cards require a PIN. GSM ports are numbered from 1 through 4, with port 1 positioned above the built-in FXS port when the WARP appliance is viewed from the back. Refer to the figure below. Figure 10 - GSM Trunk Numbering If both GSM Least Cost Routing and IP Survivability are licensed, GSM trunk configuration applies to both features. September 2011 Copyright 2011 PIKA Technologies Inc. Page 83

86 Administrators Guide To configure the GSM trunks using the Web GUI, under the Connections menu, click GSM Trunk Configuration. The following page appears. Refer to the table below for a description of each parameter and valid values. After you change the values of fields, click Save. To configure GSM trunk parameters in a configuration file, use a standard text editor to create the file <mac-address>.trunks. Store the file on an FTP or TFTP server. The file format is: parameter_name,value The following shows an example of <mac-address>.trunks: gsm_trunks,2 Page 84 Copyright 2011 PIKA Technologies Inc. Sep 2011

87 Administrator's Guide GSM Trunk Configuration Parameters The following tables describe each parameter and possible values. Parameter gsm_trunks (configuration file) Number of GSM Trunks (Web GUI) Description Configuration file - <mac-address>.trunks Web GUI Applications menu -> GSM Trunk Configuration The number of GSM trunks to configure. The value must not exceed the number of GSM radios present in the system. There are a maximum of four radios, two per module. If you provision more radios than are present in the system or this parameter is not present in the file, LCR provisioning fails and the feature does not function. If your SIM cards require a PIN, you must provision this parameter even if you want to use all available GSM trunks. Mandatory Yes Default None Valid values Integer value from 1 through 4 Parameter gsm_number_pin (configuration file) PIN for SIM Number (Web GUI) Description Mandatory Default Valid values Configuration file - <mac-address>.trunks Web GUI Applications menu -> GSM Trunk Configuration The PIN for the SIM card used for GSM radio Number, where Number is from 1 through 4. Normally, a PIN is not required; however, if your SIM card requires a PIN, you must provision this parameter. If you set the PIN incorrectly, you may temporarily lock out your SIM card. No None Integer value September 2011 Copyright 2011 PIKA Technologies Inc. Page 85

88 Administrators Guide Changing the Web GUI Account Information There are two accounts available to access the GUI: An administrator account with full access rights. A user account with rights to view pages. On pages the user account can view but not change, the Save button does not appear. Pages the user account cannot view show the message: You do not have permission to access this page. To change the user name and password of these accounts, under the Maintenance menu, click GUI Account Settings. The following page appears. In any of the fields, type a new value in the associated box and click Save. This information can be provisioned in the configuration file <mac-address>.warp. The relevant parameters are: gui_admin_username gui_admin_password gui_user_username gui_user_password Refer to section on System Parameters on page 66 for more information. Page 86 Copyright 2011 PIKA Technologies Inc. Sep 2011

89 Administrator's Guide Restarting the WARP Appliance To restart the WARP appliance, under the Maintenance menu, click Reboot. The following page appears. To manually restart the WARP appliance, click Reboot Now. When the page refreshes, the WARP appliance is ready to use. September 2011 Copyright 2011 PIKA Technologies Inc. Page 87

90 Administrators Guide Factory Reset If you want to remove provisioning for all features, you can use the Factory Reset page on the Web GUI. Feature licenses and firmware updates remain in place. Under the Maintenance menu, click Factory Reset. The following page appears. Follow the instructions on the screen and click the Factory Reset button. The page updates as shown below. When the page refreshes, the reset procedure is complete. Page 88 Copyright 2011 PIKA Technologies Inc. Sep 2011

91 Administrator's Guide Upgrading the WARP Pager Software When PIKA Technologies releases new versions of software for WARP Plus, a Windows zip file and Linux tarball are available from the PIKA Technologies Web site. Under the Troubleshooting menu, click Available Software Updates. The following page appears. The page shows the current version of WARP Plus software running on the WARP appliance. To check if there is a newer version of software available, click the link Check For Updates to view the WARP Plus: downloads and docs page on the PIKA Technologies Web site. The table Current Release and Maintenance Releases has links to the latest upgrade packages. The upgrade package contains the following: Image files required for the upgrade. Only the files needed for the new software version are included in the package. The file warpplus.update which the upgrade process uses to determine what software to upgrade. Do not modify the contents of this file. If you want to upgrade only a single WARP appliance on your network, you need to rename the file to <mac-address>.update, where <mac-address> is the MAC address of the WARP appliance you want to upgrade. Alphabetical characters in the MAC address must be lower case. If the file name remains warpplus.update, all the WARP appliances on the network are upgraded. The upgrade process runs each time the WARP appliance starts. It checks for the upgrade files on the FTP/TFTP server and, if the files are present, performs the upgrade only if the software running on the WARP appliance is different from the software in the upgrade package. To upgrade the software, perform the following steps: 1. Download the upgrade package from the PIKA Technologies Web site to the computer or server that runs the TFTP/FTP server used for WARP appliance configuration files. 2. Unpack the files using the appropriate program, for example, WinZip for Windows or tar for Linux. You must put the files into the same directory as the configuration files. 3. Rename the file to <mac-address>.update if you want to upgrade a single WARP appliance. September 2011 Copyright 2011 PIKA Technologies Inc. Page 89

92 Administrators Guide 4. Use the Web GUI to restart the WARP appliance. Under the Maintenance menu, click Reboot. On the Web page that appears, click the Reboot button. During the upgrade sequence, the LCD shows progress messages. If you are present at the customer premise during the upgrade, do not interrupt the upgrade sequence in any way (press the reset button, disconnect the power). The upgrade process restarts the WARP appliance automatically to activate the new software. After approximately 10 minutes, the upgrade finishes and the WARP appliance is ready to use. To check if the upgrade was successful, you can log on to the WARP appliance Web GUI and click Status under the System menu. The information in the Version box shows the software version running on the WARP appliance. You can view status and error information about the upgrade from the Web GUI. Under the Maintenance menu, click Logs. Click the link current-1 and click the View link for the file updates.log. Error codes for the upgrade are shown on the ERROR CODES screen on the LCD and on the Status page under the System menu. Remote Software Upgrade You can use the Web GUI to upgrade the WARP appliance. Under the Maintenance menu, click Remote Software Update. The following page appears. You can use the FTP, TFTP or HTTP transfer protocols. You must use a Linux tarball for the upgrade files and the file name must use the extension.tgz or.tar.gz. The tarball must contain the files to upgrade and the corresponding warpplus.update file. In the URL box, type the path and file name of the upgrade tarball. The following examples show valid URLs: HTTP protocol: FTP protocol: ftp://ftp.pikatech.com/warpplus/warpplus_update tgz TFTP protocol: /warpplus/warpplus_update tgz Click the Download button. The page refreshes periodically to show progress. An example is shown below. Page 90 Copyright 2011 PIKA Technologies Inc. Sep 2011

93 Administrator's Guide The upgrade process automatically restarts the WARP appliance. When the system begins to restart, the page shows the following message. When the WARP Plus log on screen appears, the WARP appliance is ready to use. Remote Access You need to log on to the WARP appliance to perform the following tasks: Change the password for the pager user account Changing the Password for the pager User Account The WARP appliance has a user account accessible through SSH access. Administrator tasks are normally performed using the Web GUI and typically, it is not necessary to log on to the WARP appliance. However, for security reasons, you should change the default password. To log on to the WARP appliance from another computer, you need to use an SSH client to open a session to the WARP appliance. The WARP appliance has a pager user account and the corresponding password is pikapika. The remote access pager account is different from the GUI September 2011 Copyright 2011 PIKA Technologies Inc. Page 91

94 Administrators Guide user account; you cannot use the pager account to log on to the GUI and you cannot use the user account name to log on using to the WARP appliance through remote access. To change the password for the pager user, type passwd at the Linux command prompt on the WARP appliance. Follow the prompts to enter a new password. Page 92 Copyright 2011 PIKA Technologies Inc. Sep 2011