Patton electronics SIPxNano, Getting Started Manual

Page 1: ...t patton com WWW www patton com Document Number 09407U1 001 Rev B Part Number 07MSIPxNANO GS Revised June 13 2007 Important This is a Class A device and is intended for use in a light industrial envir...

Page 2: ...in this document is furnished under a license and may be used or copied only in accordance with the terms of such license For information about the license go to www patton com Patton Electronics war...

Page 3: ...tting Up the SIPxNano 9 3 Users 14 4 Devices 25 5 Features 40 6 System 56 7 Diagnostics 73 8 Voicemail 78 9 Contacting Patton for assistance 83 A Session Initiation Protocol SIP 86 B Firewalls and NAT...

Page 4: ...onventions 5 1 General Introduction 6 Welcome 7 Factory defaults 7 GUI Defaults 7 Hardware included 8 What you will need 8 About the NanoServ 8 2 Setting Up the SIPxNano 9 Introduction 10 Before you b...

Page 5: ...es to an existing phone 28 Filtering phones 30 Deleting phones 30 Restarting phones 30 Phone Groups 31 Adding Phone Groups 32 Editing Phone Groups 33 Deleting Phone Groups 34 Moving Phone Groups 34 Ga...

Page 6: ...ic on Hold 55 6 System 56 Overview 57 Dial Plans 57 Adding dial rules 58 Editing and deleting dial rules 58 Activating dial rules 59 Setting up emergency routing 59 Permissions 60 Adding permissions 6...

Page 7: ...folder 81 Manage Greetings 81 To play a greeting 81 To make a greeting active 81 To record a greeting 81 Manage Distributions 82 To add a distribution list 82 Manage Notifications 82 9 Contacting Pat...

Page 8: ...Configure a Phone 97 Identifying the external IP address 97 PHONESET_EXTERNAL_IP_ADDRESS 97 Setting the SIP port 97 Setting the RTP RTCP ports 97 Work with a Firewall with NAT 98 Work with a Proxy Fir...

Page 9: ...etting Started Guide Table of Contents Sample code 110 D Compliance information 111 Compliance 112 EMC 112 Safety 112 Radio and TV interference 112 CE Declaration of Conformity 112 Authorized European...

Page 10: ...g a dialing rule 44 22 Editing the auto attendant dialing rule 45 23 Setting up the holiday attendant 46 24 Activating dial plans 46 25 Setting up the special auto attendant 47 26 Configuring the inte...

Page 11: ...72 49 Registrations 74 50 Job Status log 75 51 SIPxNano Services 76 52 Snapshot 77 53 Successful snapshot 77 54 Voicemail inbox 79 55 Sample SIP Message 90 56 Call setup 91 57 Call teardown 91 58 Suc...

Page 12: ...ssage Headers 90 11 SIP System Components 94 12 Parameter settings for certain phones 98 13 Core Operations Add User 102 14 Core Operations Edit User 103 15 Core Operations Delete User 104 16 Core Ope...

Page 13: ...ormation on setting up devices Chapter 5 Features on page 40 contains an overview of setting up and configuring features Chapter 6 System on page 56 contains information about system settings Chapter...

Page 14: ...ing calls attention to important information The alert symbol and CAUTION heading indicate a potential haz ard Strictly follow the instructions to avoid property damage The shock hazard symbol and CAU...

Page 15: ...to be installed and that it is connected to a wall outlet which has earth ground The mains outlet that is utilized to power the devise shall be within 10 feet 3 meters of the device shall be easily a...

Page 16: ...font Futura bold italic type Parts of commands which are related to elements already named by the user are in boldface italic font Italicized Futura type Variables for which you supply values are in...

Page 17: ...6 Chapter 1 General Introduction Chapter contents Welcome 7 Factory defaults 7 GUI Defaults 7 Hardware included 8 What you will need 8 About the NanoServ 8...

Page 18: ...the option to change these defaults when the system first boots Hostname sipx patton com IP 192 168 200 200 Netmask 255 255 255 0 Note Make sure to set the netmask to the same subnet as the PC you wi...

Page 19: ...nitor Keyboard Mouse Separate PC Ethernet cable About the NanoServ The NanoServ is a unique tiny embedded system for a wide range of applications from industrial to office to home The system offers mu...

Page 20: ...Nano Chapter contents Introduction 10 Before you begin 10 Configuring and Running the Reset Script 11 Accessing the system 11 Configuration Overview 12 Users 12 Devices 12 Features 13 System Settings...

Page 21: ...pace about 1 inch If mounted in a closed enclosure it will need 1 or 2 fans on the outer enclosure for proper air flow inside 1 Place the SIPxNano upright in the metal stand included 2 Attach a VGA mo...

Page 22: ...t settings such as the hostname IP address netmask gateway nameserver password and timezone If you would like to keep the default settings press enter at each prompt Type yes then press enter The syst...

Page 23: ...he manual provide information on how to set up and configure users devices fea tures system settings diagnostics and voicemail Users From the Users menu you can Add and configure settings for new user...

Page 24: ...n on System Settings see Chapter 6 System on page 56 Diagnostics From the Diagnostics menu you can Refresh registrations and view the primary registrar View and edit the status of jobs Start stop rest...

Page 25: ...er IDs 17 Extensions 18 Aliases 19 Permissions 20 Editing users 21 Filtering users 21 Deleting users 21 More Actions 21 User Groups 22 Adding User Groups 23 Adding Users to a User Group 23 Editing Use...

Page 26: ...ts and ports for the device to use when receiving or sending data through a firewall When you send profiles to a device SIPxNano delivers settings only to the SIP phone associated with that device Use...

Page 27: ...ser s Last Name In the next field enter the user s First Name 4 Create a numeric PIN for the user to access voicemail In the next field type the PIN again 5 The SIP password is used by the user s phon...

Page 28: ...be the numeric only identifier If you assign numeric User IDs to your users an additional extension is not needed Note If you use extensions all User IDs and extensions must be unique the same number...

Page 29: ...ion pools to manage the set of usable extensions and keep track of numbers that have already been assigned to users Extension pools are not hierarchical and each extension number can only be assigned...

Page 30: ...er with a User ID of sales and a unique extension An end user can then use the extension to access voicemail for the sales user Another example of an alias is one that resembles an email address which...

Page 31: ...Outbound Authorization databases Table 3 Permissions Feature Description 900 Dialing User can dial 900 numbers Auto Attendant Include this user in the dial by name directory presented by the Auto Att...

Page 32: ...ced Settings link to view and modify the SIP password settings Filtering users You can filter users in the users list by using the Filter by drop down menu The following options are available in the F...

Page 33: ...Nano interface for administrators When you specify settings for a group they automatically apply to all of the members assigned to the group speeding configuration and making selected features avail a...

Page 34: ...t an existing group 1 From the list on the User Groups screen click on the name of the group you want to edit 2 The Group Settings page appears To enable a setting check the box next to it To disable...

Page 35: ...he Extension Pool 1 From the main menu click on Users Extension Pool 2 Type the lowest number of the range you desire in the First pool extension field 3 Type the highest number of the range you desir...

Page 36: ...e 28 Filtering phones 30 Deleting phones 30 Restarting phones 30 Phone Groups 31 Adding Phone Groups 32 Editing Phone Groups 33 Deleting Phone Groups 34 Moving Phone Groups 34 Gateways 35 Adding gatew...

Page 37: ...nes on page 30 You can add or edit phones by accessing the SIPxNano Configuration server interface through a Web browser and clicking Phones under Devices from the main navigation The following screen...

Page 38: ...ser or lines associated with the phone phone s purpose loca tion etc 4 Select a Phone Model Note If you cannot find the phone in the Phone Model drop down list the phone is not directly managed throug...

Page 39: ...From the main menu click on Devices Phones 2 From the list of phones click on the serial number of the phone you want to edit Figure 9 List of phones 3 The Edit Phone page will display You can edit p...

Page 40: ...orma tion Associated matches appear in the table below the Search and Cancel buttons If the search has returned the correct user select that user by selecting the check box to the left of the User ID...

Page 41: ...Addi tionally you can choose to add phones to or remove phones from a particular group at the Phones screen by selecting all or a particular group from the Filter by drop down menu selecting the check...

Page 42: ...ps by accessing the SIPxNano Configuration server interface through a Web browser and clicking Phone Groups under Devices from the main navigation The following screen displays Figure 12 Phone Groups...

Page 43: ...the Name field The Name of the phone group cannot contain any spaces or whitespace characters 3 Create a description of this group in the Description field e g Support Group phones 4 Click OK to save...

Page 44: ...of the phone group you want to edit Figure 14 Phone model groups Note You can also edit the group parameters associated with a phone or set of phones associated with a particular phone type from the...

Page 45: ...irmation prompt will appear Click OK Moving Phone Groups On the Phone Groups page you can change the order of the phone groups in the list To move a phone group in the phone group list 1 Check the box...

Page 46: ...way or SIP trunk Figure 16 Adding a gateway 2 Enter details for the following options Name The name of the gateway Address IP address example 10 1 1 1 or a fully qualified hostname example gateway exa...

Page 47: ...teway unless more specific caller ID is specified for a caller Block Caller ID If checked all calls connected through this gateway will have Caller ID blocked unless more specific caller ID is specifi...

Page 48: ...n click Apply to save and remain at the current screen click Cancel to return to the Gateways screen without saving any of the information you created Deleting gateways To delete an existing gateway 1...

Page 49: ...Poly com Unmanaged TFTP files can also be uploaded Use the Unmanaged TFTP Trivial File Transfer Protocol option to upload files for phones not listed in the Add files drop down menu You must have a c...

Page 50: ...until it is idle When an idle phone receives new profiles and a restart request it displays a message and restarts automatically after approximately one minute Note You should plan to send profiles on...

Page 51: ...ial Plans 44 Setting the Special Auto Attendant 47 Intercom 48 Configuring intercom 48 Using intercom 48 Hunt Groups 49 Adding hunt groups 49 Editing hunt groups 50 Deleting hunt groups 50 Call Park 5...

Page 52: ...ns on page 44 Setting the Special Auto Attendant on page 47 The Auto Attendant feature allows you to create multiple automatic answering operators within a single SIPx Nano system When a live person i...

Page 53: ...uto attendant 2 Enter a name for the Auto Attendant in the Name field 3 Enter a description in the Description field 4 Select a standard prompt i e autoattendant wav afterhours wav using the Prompt se...

Page 54: ...er s request 8 Enter a transfer extension in the Transfer Extension field of the Invalid Response section and choose to transfer calls or not using the Transfer the Call checkbox The settings in the I...

Page 55: ...endant 4 To save your changes click the OK button Deleting auto attendants To delete an auto attendant 1 From the main screen click on Features Auto Attendants 2 Check the box next to the auto attenda...

Page 56: ...ess hours form the Working Time Attendant drop down menu When you make a selection from this drop down menu a settings form displays shown next where you can set the days of the week weekends and time...

Page 57: ...ent screen click Cancel to return to the Dial Plans screen without saving any of the auto attendant dial plan information you created Note Dial plans are sensitive to order You may want to move the Au...

Page 58: ...ls To set up the Special Auto Attendant 1 From the main screen click on Features Auto Attendants 2 In the Special Auto Attendants section on the Auto Attendants screen click on Use special auto atten...

Page 59: ...d Use spaces to separate multiple group names Note The Intercom feature is only enabled for Polycom phones at the receiving end of the call that are members of the groups listed 4 Check the Enabled bo...

Page 60: ...he initial user to dial in the hunt group Adding hunt groups To create a hunt group 1 From the main screen click Features Hunt Groups Add Hunt Group Figure 27 Adding a hunt group 2 Click the Enabled b...

Page 61: ...xisting hunt group 1 From the main screen click on Features Hunt Groups 2 On the Hunt Groups screen click on the name of the hunt group you want to edit 3 From this screen you can add more users to th...

Page 62: ...xtension screen provides the ability to transfer calls to call park extensions In the transfer state the caller hears background music while waiting for someone to pick up at the extension Calls can b...

Page 63: ...ecked callers put on park are able to transfer the call back to the extension that parked the call by pressing 0 To configure a new Transfer key click the Show Advanced Settings link 11 Click OK to sa...

Page 64: ...e a call park extension 1 From the main screen click on Features Call Park 2 Check the box next to the call park extension that you want to delete 3 Click the Delete button A confirmation prompt will...

Page 65: ...perties 4 Select PCM from the Format drop down list 5 Select 8 000 kHz 16 Bit Mono from the Attributes drop down list 6 Click Save As and save the wav file to a location you can navigate to from the S...

Page 66: ...IPxNano Configuration server e g a network location that you can browse to Music on Hold The Music on Hold feature is supported for all phones that implement the Music on Hold service IETF draft Figur...

Page 67: ...g 59 Permissions 60 Adding permissions 60 General 61 SIP Parameters 61 Voice Mail 62 Call Pickup 63 Presence Server 64 Logging 65 Call Detail Records CDRs 66 Import 67 Importing CSV files 67 LDAP 68 C...

Page 68: ...n backing up the system Menu options include Dial Plans on page 57 Permissions on page 60 General on page 61 Import on page 67 LDAP on page 68 Backup on page 70 Domain on page 72 Dial Plans This secti...

Page 69: ...xt to the name of the dialing rule you want to activate 10 Click the Activate button under Dial Plan Activation 11 A confirmation screen will appear Click OK Editing and deleting dial rules You can ed...

Page 70: ...oes not support direct forwarding If this feature is enabled all emergency calls are forwarded to the default gateway Optionally you can configure a set of phone numbers to be forwarded to an alternat...

Page 71: ...me field The Permission name is displayed on the User Cal Per mission screen and on the Dial Rule edit screen 3 Enter a description for the permission in the Description field 4 Check the Default valu...

Page 72: ...tinue without restarting services you can select the Do Not Restart Services Now checkbox In either case services must be restarted at some point for the Configuration changes to take effect but setti...

Page 73: ...termining whether a user has entered the entire extension For more information about Voice Mail see Chapter 8 Voicemail on page 78 Figure 37 Voicemail settings in the General menu The settings you can...

Page 74: ...e Global pickup code Code to dial to pick up a ringing call on any phone Set it to empty to disable global call pickup Default 78 Directed call pickup code Code to dial to pick up a ringing call on a...

Page 75: ...39 Presence server The settings you can configure are Presence sign in Code to dial to sign in to the presence monitor Default 88 Presence sign out Code to dial to sign out from the presence monitor...

Page 76: ...tching of SIP traffic Default NOTICE Registrar Log Level Handling of phones registering for calls Default NOTICE Park Server Log Level Handling of calls getting parked and picked up Default NOTICE Sta...

Page 77: ...Default unchecked Log Authorization Proxy Events Log authorization proxy CSEs to the CDR database Default unchecked Purge the CDR Database Daily Schedule a daily purge of the CDR database Purge both...

Page 78: ...uld have a title line and the following fields User Name Voicemail PIN SIP Password First Name Last Name User Alias User Group User s Phone Serial Number User s Phone Manufacturer User s Phone Model U...

Page 79: ...ctory Leave this field empty is accessing anonymously Password and Confirm Password Enter and re enter the password for simple authentication 3 Click Continue 4 On the LDAP attribute mapping configura...

Page 80: ...k OK If you receive an error then the LDAP server is configured incorrectly and you will need to fix the server settings See Configuring the LDAP server on page 68 3 On the Import LDAP screen click Im...

Page 81: ...ta files so that site specific SIPxNano data can be readily restored in the event of a disk failure or other loss of data Administrators can back up configuration and profile information as well as vo...

Page 82: ...kup 1 From the main screen click System Backup 2 Select the Schedule checkbox next to the Every day menu 3 Select a specific day or every day from the Every day drop down menu and enter the time you w...

Page 83: ...NS SRV is not configured to send all SIP traffic to the SIP proxy on this machine This controls how SIP addresses are built and used through the system For example sip user old value becomes sip user...

Page 84: ...73 Chapter 7 Diagnostics Chapter contents Overview 74 Registrations 74 Viewing registrations 74 Job Status 75 Viewing the job status log 75 Clearing the job status log 75 Services 76 Snapshot 77...

Page 85: ...an monitor all phones registered with SIPxNano as well as showing or hiding primary registrar by clicking on that link in its current state Figure 49 Registrations Viewing registrations To view active...

Page 86: ...g To view the job status log 1 From the main menu click Diagnostics Job Status If the Configuration server is in the process of running a job you can view its Job Name Start Time Stop Time Status and...

Page 87: ...estart and refresh all component services of the SIPxNano server including CommServer ConfigServer and ACD Server and MediaServer You can also start stop and restart parts of SIPxNano components such...

Page 88: ...ntials checkbox to capture password information from the credentials file Figure 52 Snapshot After selecting or deselecting the appropriate checkboxes click Apply The sipx configuration tar gz archive...

Page 89: ...s 80 Moving messages 80 Deleting messages 80 Editing messages 80 Editing Voicemail Preferences 81 Manage Folders 81 To add a folder 81 To delete or edit a folder 81 Manage Greetings 81 To play a greet...

Page 90: ...r a user name and password Enter your Extension and PIN and click OK Note To logout of the voicemail page the user must exit the web browser Note Online help is available for the Voicemail webpage To...

Page 91: ...t to the message you want to move 2 In the drop down menu select the folder you d like to move the message to 3 Click the Move button Deleting messages To delete a message 1 Check the box next to the...

Page 92: ...nt to delete This will delete all of the messages in that folder along with the folder itself Manage Greetings From the Manage Greetings folder you can play a greeting or select an active greeting The...

Page 93: ...eld Use a comma to separate addresses in the distribu tion list 4 Click Save Manage Notifications Notifications can be sent to your email when you receive a new voice mail 1 Click on the Manage Notifi...

Page 94: ...n support headquarters in the USA 84 Alternate Patton support for Europe Middle East and Africa EMEA 84 Warranty Service and Returned Merchandise Authorizations RMAs 84 Warranty coverage 84 Out of war...

Page 95: ...Fax 1 253 663 5693 Alternate Patton support for Europe Middle East and Africa EMEA Online support available at www patton inalp com E mail support e mail sent to support patton inalp com will be answ...

Page 96: ...will be issued upon receipt and inspection of the equipment 30 to 60 days We will add a 20 restocking charge crediting your account with 80 of the purchase price Over 60 days Products will be accepted...

Page 97: ...87 Methods 88 Response Codes 89 Message Headers 90 Sample SIP Message 90 Message Flow Examples 90 Call setup 91 Call teardown 91 Successful blind transfer 91 Successful consultative transfer 92 SIP UR...

Page 98: ...ets they describe This section introduces the contents of SIP messages and describes how the messages are organized into trans actions sessions and calls The Internet Engineering Task Force IETF Reque...

Page 99: ...n REFER Indicates that the recipient should contact a third party using provided contact information ini tiates a transfer CANCEL Cancels a pending request does not affect a com pleted request REGISTE...

Page 100: ...61 for standard SIP status code definitions Additional codes may also be listed in Internet Draft draft ietf sip rfc2543bis 05 txt Table 8 Supported Methods Methods Initiated Methods Received INVITE I...

Page 101: ...ustrate the sequence and direction in which SIP call control methods and response codes are sent message flow examples follow for Call setup Call teardown Successful transfer blind Successful transfer...

Page 102: ...es 91 SIPxNano IP PBX Getting Started Guide A Session Initiation Protocol SIP Call setup Figure 56 Call setup Call teardown Figure 57 Call teardown Successful blind transfer Figure 58 Successful blind...

Page 103: ...ign SIP URLs to both a specific device and to the individual users who participate in SIP sessions As a result when a phone call or other interactive session is made to a SIP address it can be routed...

Page 104: ...SIP session have the same values in the To From and Call ID fields However the addresses in the To and From fields switch to reflect the endpoint that originated the message SIP Calls A SIP call cons...

Page 105: ...Description UAC User Agent Client An application that initiates a request and sends it in a SIP message UAS User Agent Server An application that uses a SIP message to respond to a request accepts re...

Page 106: ...ernal IP address 96 Opening VoIP ports 96 Configure a Phone 97 Identifying the external IP address 97 PHONESET_EXTERNAL_IP_ADDRESS 97 Setting the SIP port 97 Setting the RTP RTCP ports 97 Work with a...

Page 107: ...ided with your firewall software for instructions Recording the external IP address While you are working with the server or router that provides your firewall services determine and record its extern...

Page 108: ...51 66 16 The phone includes this IP address or host name in the SIP messages it sends to other SIP user agents to indi cate that this is the address to which SIP RTP and RTCP packets should be sent Se...

Page 109: ...secutive However when you have multiple phones behind the firewall you use different ports for each one For exam ple open unique SIP port 5060 for phone A port 5061 for phone B and 5062 for phone C Th...

Page 110: ...figure your phones by setting one or more of the following HTTP proxy host name and HTTP proxy port number PHONESET_HTTP_PROXY_HOST and PHONESET_HTTP_PROXY_PORT Host address outside NAT firewall PHONE...

Page 111: ...e classes and operations 102 Add User 102 Edit User 103 Delete User 104 Add Device 104 Edit Device 106 Delete Device 107 Assign Device to a User 107 Unassign Device from a User 108 Resync data sets 10...

Page 112: ...DAP directory into a SIPxNano installation These tools help programmers Migrate data to a new SIPxNano installation by importing a large number of user and device records Periodically update SIPxNano...

Page 113: ...SDL Parameter Java Method Description Required userId setId Valid strings contain only a z A Z Numbers Under score _ Must be less than 80 characters in length Cannot be a duplicate of an existing user...

Page 114: ...sys tem The ancestry is delimited with charac ters A leading should not be used For example to create a new user in the sales user group which in turn belongs to the top level west coast user group su...

Page 115: ...ee the WSDL device service xml file AddDeviceCommand class in the com Patton pds applications loader commands package Table 15 Core Operations Delete User WSDL Parameter Java Method Description Requir...

Page 116: ...qualified device group of the device You must specify the complete group hier archy including the device group names of both the immediate parent group and all ancestor groups relative to the root of...

Page 117: ...eld will be set to null in SIPxNano Note You cannot change the device type for a SIPxNano device Instead you must delete the current device add a new device with the different device type and then ass...

Page 118: ...tgoing calls properly To assign a device to a user you use either assignDevice operation in the UserService See the WSDL user service xml file AssignDeviceCommand class in the com Patton pds applicati...

Page 119: ...on should be performed after all other SIPxNano operations are complete To resynchronize all data sets you use either rebuildDataSets operation in the DataSetService See the WSDL dataset service xml f...

Page 120: ...sService See the WSDL send profiles service xml file SendUsersProfilesCommand class in the com Patton pds applications loader commands package Preparing source data The SIPxNano Configuration APIs imp...

Page 121: ...ssword try create the specific LoaderCommand object In this case we are going to add a new user to the system AddUserCommand addUserCmd new AddUserCommand args 0 hostname Boolean valueOf args 1 boolea...

Page 122: ...111 Appendix D Compliance information Chapter contents Compliance 112 EMC 112 Safety 112 Radio and TV interference 112 CE Declaration of Conformity 112 Authorized European Representative 112...

Page 123: ...onnecting the cables try to correct the interference by one or more of the following measures moving the computing equipment away from the receiver re orienting the receiving antenna and or plugging t...