Patton electronics SIPxNano Getting Started Manual

Patton electronics SIPxNano Getting Started Manual

Ip-pbx server
Hide thumbs Also See for SIPxNano:
Table of Contents

Advertisement

Quick Links

For Quick
Start Installation
SIPxNano
IP-PBX Server

Getting Started Guide

Important
This is a Class A device and is intended for use in a light industrial environment. It is not intended nor approved for use in an industrial
or residential environment.
Sales Office:
+1 (301) 975-1000
Technical Support:
+1 (301) 975-1007
E-mail:
support@patton.com
WWW:
www.patton.com
Document Number: 09407U1-001, Rev. B
Part Number: 07MSIPxNANO-GS
Revised: June 13, 2007

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the SIPxNano and is the answer not in the manual?

Questions and answers

Summary of Contents for Patton electronics SIPxNano

  • Page 1: Getting Started Guide

    For Quick Start Installation SIPxNano IP-PBX Server Getting Started Guide Important This is a Class A device and is intended for use in a light industrial environment. It is not intended nor approved for use in an industrial or residential environment.
  • Page 2 E-mail: support@patton.com Trademark Statement The term SIPxNano are trademarks of Patton Electronics Company. All other trade- marks presented in this document are the property of their respective owners. Copyright © 2007, Patton Electronics Company. All rights reserved. The information in this document is subject to change without notice. Patton Elec- tronics assumes no liability for errors that may appear in this document.
  • Page 3: Table Of Contents

    Summary Table of Contents General Introduction............................6 Setting Up the SIPxNano ..........................9 3 Users................................14 Devices ................................25 Features ................................. 40 System ................................56 7 Diagnostics..............................73 8 Voicemail............................... 78 Contacting Patton for assistance ........................83 Session Initiation Protocol (SIP) ........................
  • Page 4 Factory defaults ...............................7 GUI Defaults ..............................7 Hardware included ..............................8 What you will need ..............................8 About the NanoServ ..............................8 Setting Up the SIPxNano ..........................9 Introduction ................................10 Before you begin.............................10 Configuring and Running the Reset Script ......................11 Accessing the system ..............................11 Configuration Overview ............................12...
  • Page 5: Table Of Contents

    SIPxNano IP-PBX Getting Started Guide Table of Contents 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 User Groups ............................23 Deleting User Groups .............................23...
  • Page 6 SIPxNano IP-PBX Getting Started Guide Table of Contents Configuring intercom .............................48 Using intercom ...............................48 Hunt Groups.................................49 Adding hunt groups ............................49 Editing hunt groups ............................50 Deleting hunt groups ............................50 Call Park ................................51 Adding Call Park Extensions ...........................51 Editing Call Park Extensions ...........................52...
  • Page 7 SIPxNano IP-PBX Getting Started Guide Table of Contents Registrations................................74 Viewing registrations ............................74 Job Status ................................75 Viewing the job status log ..........................75 Clearing the job status log ..........................75 Services..................................76 Snapshot................................77 8 Voicemail............................... 78 Overview ................................79 Accessing the Voicemail webpage ..........................79 Managing Voicemail Messages ..........................79...
  • Page 8 SIPxNano IP-PBX Getting Started Guide Table of Contents 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 URLs ................................92 Transactions..............................93 Sessions................................93 Calls................................93 Caller ID ..............................93...
  • Page 9 SIPxNano IP-PBX Getting Started Guide Table of Contents Sample code ................................110 Compliance information ..........................111 Compliance .................................112 ................................112 Safety ................................112 Radio and TV interference ..........................112 CE Declaration of Conformity ..........................112 Authorized European Representative ........................112...
  • Page 10: List Of Figures

    Rear panel of the SIPxNano (Model 6075 shown) ....... . .
  • Page 11 SIPxNano Services ........
  • Page 12: List Of Tables

    List of Tables General conventions ..............5 User IDS and SIP URLs .
  • Page 13: About This Guide

    About this guide This guide describes the SIPxNano hardware, installation and basic configuration. Audience This guide is intended for the following users: • Operators • System administrators • Network engineers Structure This guide contains the following chapters and appendices: •...
  • Page 14: Precautions

    SIPxNano IP-PBX Getting Started Guide Precautions Notes, cautions, and warnings, which have the following meanings, are used throughout this guide to help you become aware of potential problems. Warnings are intended to prevent safety hazards that could result in per- sonal injury.
  • Page 15: Safety When Working With Electricity

    Hazardous network voltages are present in WAN ports regardless of whether power to the SIPxNano is ON or OFF. To avoid electric shock, use caution when near WAN ports. When detaching cables, detach the end away from the WARNING SIPxNano first.
  • Page 16: Typographical Conventions Used In This Document

    Terminal sessions and information the system displays are in screen screen font The leading IP address or nodename of a SIPxNano is substituted with node in node boldface italic font. The leading SN on a command line represents the nodename of the SIPxNano...
  • Page 17: General Introduction

    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: Welcome

    8 • “What you will need” on page 8 Factory defaults When you first access the SIPxNano, the following defaults are activated. You have the option to change these defaults when the system first boots. • Hostname: sipx.patton.com IP: 192.168.200.200 •...
  • Page 19: Hardware Included

    • Quick Start guide What you will need Note The following items are NOT included, but you will still need them to use the SIPxNano. You will need the following items to use the SIPxNano: • Monitor • Keyboard •...
  • Page 20: Setting Up The Sipxnano

    Chapter 2 Setting Up the SIPxNano 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 ...............................13 Diagnostics ..............................13 Voicemail...
  • Page 21: Introduction

    2 • Setting Up the SIPxNano Introduction This chapter will help you set up the SIPxNano for the first time. The factory has already installed the CentOS operating system, but you will need to initially configure the system the first time you use it.
  • Page 22: Configuring And Running The Reset Script

    2 • Setting Up the SIPxNano Configuring and Running the Reset Script When you turn on the SIPxNano for the first time, you will need to run and configure a reset script before you can access the webpage interface. When you boot the system, a CLI prompt will appear asking for a login and password: •...
  • Page 23: Configuration Overview

    SIPxNano IP-PBX Getting Started Guide 2 • Setting Up the SIPxNano 3. The SIPxNano homepage will appear. Figure 2. SIPxNano homepage 4. From the main page, on the main navigation menu at the top, you can access the configuration pages for setting up Users, Devices, Features, System, or Diagnostics.
  • Page 24: Features

    SIPxNano IP-PBX Getting Started Guide 2 • Setting Up the SIPxNano Features From the Features menu, you can: • Add and configure auto attendants • Add and configure hunt groups • Add and configure call park extensions For more information on Features, see Chapter 5, “Features”...
  • Page 25: Users

    Chapter 3 Users Chapter contents Overview ................................15 Users ..................................15 Adding Users ..............................16 User 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 User Groups...
  • Page 26: Overview

    • The location of hosts 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. Users This section covers: •...
  • Page 27: Adding Users

    SIPxNano IP-PBX Getting Started Guide 3 • Users aged from the respective phone after adding user(s) and user groups to SIPx- Nano. Adding Users To add a new user: 1. From the main menu, click on Users > Users, then the Add User hyperlink. The New User screen appears.
  • Page 28: User Ids

    When you add a user, SIPxNano automatically sets up a user line with a SIP URL based on the new User ID so that calls can be directed to that user. This line automatically registers with the Comm Server’s SipRegistrar component for each SIP phone assigned to the user.
  • Page 29: Extensions

    If you assign numeric-only User IDs to your users, an additional extension may not be needed. When you set up an extension or alias for a User ID, SIPxNano automatically adds them to a database of User IDs and all of the extensions and aliases associated with each one. The components of the Comm Server use...
  • Page 30: Aliases

    Another example of an alias is one that resembles an email address, which callers from VoIP phones may find easier to remember than a phone number. That is, for a user with a SIPxNano User ID of 2435 and an email...
  • Page 31: Permissions

    SIPxNano IP-PBX Getting Started Guide 3 • Users Permissions With the SIPxNano interface for administrators, you authorize or prohibit access to certain system features by enabling permissions for users or groups of users. Table 3. Permissions Feature: Description: 900 Dialing...
  • Page 32: Editing Users

    SIPxNano IP-PBX Getting Started Guide 3 • Users Editing users After creating a new user, you can adjust certain settings such as call forwarding and permissions. From the Users page, click on the User ID of the user you’d like to configure settings for.
  • Page 33: User Groups

    “Moving User Groups” on page 23 SIPxNano user groups help you deliver configuration settings to users efficiently; you can create groups of users through the SIPxNano 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- able consistently.
  • Page 34: Adding User Groups

    SIPxNano IP-PBX Getting Started Guide 3 • Users Adding User Groups To add a new user group: 1. From the main menu, click Users > User Groups > Add Group. 2. Enter a user group name (e.g., CustomerService) in the “Name” field.
  • Page 35: Extension Pool

    SIPxNano IP-PBX Getting Started Guide 3 • Users Extension Pool The Extension Pool link allows you to edit the range of extensions that can be used by users. To edit the Extension Pool: 1. From the main menu, click on Users > Extension Pool.
  • Page 36: Devices

    Chapter 4 Devices Chapter contents Overview ................................26 Phones...................................26 Adding phones ..............................27 Editing phones ..............................28 Adding lines 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...
  • Page 37: Overview

    “Restarting phones” 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 displays: Figure 7. Phones main screen Note From this screen you have the ability to Send Profiles to a particular user or...
  • Page 38: Adding Phones

    SIPxNano IP-PBX Getting Started Guide 4 • Devices Adding phones To set up a phone, you supply a serial number and description, then select a phone model and associate one or multiple groups with that phone. To set up a phone: 1.
  • Page 39: Editing Phones

    SIPxNano IP-PBX Getting Started Guide 4 • Devices Editing phones The Edit Phone page has links to additional parameters that can be configured for a particular phone. Note The optional links that you can edit phone settings for are: Identification, Lines, Date/Time, User Preferences, DTMF, Sound Effects,...
  • Page 40: Adding A Line To A Phone

    You can choose to add another line from the lines screen by clicking the Add Line link above the table. You can add an external line for users not managed by the SIPxNano you are currently working with. Phones...
  • Page 41: Filtering Phones

    SIPxNano IP-PBX Getting Started Guide 4 • Devices Note From the Lines screen you can also edit the parameters for the associated phone by clicking a link in the left-hand navigation on the Lines screen. Filtering phones You can filter phones in the phones list by using the Filter by... drop-down menu.
  • Page 42: Phone Groups

    Groups allow you to organize phones into logical groups. Phones can be in any number of groups. You can add or edit Phone Groups 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.
  • Page 43: Adding Phone Groups

    SIPxNano IP-PBX Getting Started Guide 4 • Devices Adding Phone Groups To add a phone group: 1. From the main screen, click on Devices > Phone Groups > Add Group. Figure 13. Adding a phone group 2. Enter a phone group name (e.g., Support) in the Name field.
  • Page 44: Editing Phone Groups

    SIPxNano IP-PBX Getting Started Guide 4 • Devices Editing Phone Groups To edit a phone group: 1. From the main menu, click on Devices > Phone Groups. 2. Click on the name of the phone group you want to edit.
  • Page 45: Deleting Phone Groups

    SIPxNano IP-PBX Getting Started Guide 4 • Devices Deleting Phone Groups To delete a phone group: 1. From the list on the Phone Groups screen, check the box next to the group you want to delete. 2. Click the Delete button.
  • Page 46: Gateways

    “Deleting gateways” on page 37 You can define gateways that the SIPxNano will use to route outbound calls. You can specify gateways to use for routine calls sepertaely from gateways to use for emergency calls. To access the Gateways page, click Devices > Gateways.
  • Page 47: Editing Gateways

    SIPxNano IP-PBX Getting Started Guide 4 • Devices Editing gateways To edit an existing gateway: 1. On the Gateways screen, click on the name of the gateway in the Name column. 2. The Gateway Details screen will appear. Using the links on the left, you can edit the gateway details.
  • Page 48: Deleting Gateways

    SIPxNano IP-PBX Getting Started Guide 4 • Devices 6. Click OK to save and return to the Gateways screen; 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.
  • Page 49: Files

    file for Cisco 7940 and 7960 series phones (circum- vents the need to press the dial button on the phone after entering the dialed number), and ringtones that can be uploaded into SIPxNano and then distributed to all phones associated with the device name (e.g., Poly- com).
  • Page 50: Deleting Files

    SIPxNano IP-PBX Getting Started Guide 4 • Devices Deleting files To delete a file: 1. From the list on the Files screen, check the box next to the file you want to delete. 2. Click the Delete button. 3. A confirmation prompt will appear. Click OK.
  • Page 51: Features

    Chapter 5 Features Chapter contents Overview ................................41 Auto Attendants ..............................41 Adding auto attendants ...........................42 Editing auto attendants ...........................44 Deleting auto attendants ..........................44 Adding auto attendants to Dial Plans ......................44 Setting the Special Auto Attendant .........................47 Intercom................................48 Configuring intercom .............................48 Using intercom ...............................48 Hunt Groups.................................49...
  • Page 52: Overview

    The routing rules for which menu to use for a specific number are defined using the Dial Plan functionality of SIPxNano. An auto attendant’s dialing rules...
  • Page 53: Adding Auto Attendants

    4. Select a standard prompt (i.e., autoattendant.wav, afterhours.wav) using the Prompt section’s ‘select...’ drop-down menu, or record and upload an Auto Attendant prompt using the Prompt section’s Browse... button. Prompts can be recorded from any phone connected to the SIPxNano voicemail system and are immedi- Auto Attendants...
  • Page 54 SIPxNano IP-PBX Getting Started Guide 5 • Features ately selectable from the Prompt drop-down list after they are recorded. You can click Listen to listen to a standard prompt after you make your selection or browse to upload a new prompt.
  • Page 55: Editing Auto Attendants

    SIPxNano IP-PBX Getting Started Guide 5 • Features Editing auto attendants To edit an existing auto attendant: 1. From the main screen, click on Features > Auto Attendant. 2. On the Auto Attendants screen, click on the name of the auto attendant you want to edit.
  • Page 56: Editing The Auto Attendant Dialing Rule

    SIPxNano IP-PBX Getting Started Guide 5 • Features 3. Select Attendant from the Dialing Rule Type drop-down list and click Next. Figure 22. Editing the auto attendant dialing rule 4. Select the Enabled check box. 5. Enter a Name for the auto attendant dial plan.
  • Page 57: Setting Up The Holiday Attendant

    SIPxNano IP-PBX Getting Started Guide 5 • Features Figure 23. Setting up the holiday attendant 12. Click OK to save auto attendant dial plan information and return to the Dial Plans screen; click Apply to save auto attendant dial plan information and remain at the current screen; click Cancel to return to the Dial Plans screen without saving any of the auto attendant dial plan information you created.
  • Page 58: Setting The Special Auto Attendant

    SIPxNano IP-PBX Getting Started Guide 5 • Features Setting the Special Auto Attendant You can use the Special Auto Attendant feature to temporarily overwrite auto attendant configuration. By default, the auto attendant is selected based on the auto attendant dialing rules. If the Special Auto Attendant is activated, it is used to handle all calls.
  • Page 59: Intercom

    SIPxNano IP-PBX Getting Started Guide 5 • Features Intercom The Intercom feature is supported only if a Polycom phone is receiving the call, while Intercom calls can be initiated by any phone by dialing the proper intercom prefix. Figure 26. Configuring the intercom feature Configuring intercom...
  • Page 60: Hunt Groups

    SIPxNano IP-PBX Getting Started Guide 5 • Features Hunt Groups This section covers: • “Adding hunt groups” on page 49 • “Editing hunt groups” on page 50 • “Deleting hunt groups” on page 50 Hunt Groups allow you to set up an extension that encompasses a group of users. When a hunt group exten- sion is dialed, such as 400, a group of users associated with this master extension fall into a call sequence.
  • Page 61: Editing Hunt Groups

    SIPxNano IP-PBX Getting Started Guide 5 • Features 7. Click OK to save hunt group information and return to the Hunt Groups screen; click Apply to save hunt group information and remain at the current screen; click Cancel to return to the Hunt Groups screen without saving any of the user information you created.
  • Page 62: Call Park

    SIPxNano IP-PBX Getting Started Guide 5 • Features Call Park This section covers: • “Adding Call Park Extensions” on page 51 • “Editing Call Park Extensions” on page 52 • “Using Call Park Extensions” on page 53 • “Deleting Call Park Extensions”...
  • Page 63: Editing Call Park Extensions

    SIPxNano IP-PBX Getting Started Guide 5 • Features 4. Enter an extension in the Extension field. 5. Enter a description in the Description field. 6. Select background music from the Background Music drop-down list. If there are no files to select or you want to upload new background music, click Browse and upload new music.
  • Page 64: Using Call Park Extensions

    2. Check the box next to the call park extension that you want to delete. 3. Click the Delete button. A confirmation prompt will appear. Click OK. Recording .WAV Files (Windows OS) WAV files are recorded, uploaded, and set in SIPxNano for the following reasons: • Auto Attendant Prompts •...
  • Page 65: Properties For Sound

    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 SIPxNano Configuration server. Browse from the Auto Attendant and Call Park sections of the Configuration server to locate .wav files that you have recorded and upload them to SIPxNano.
  • Page 66: Music On Hold

    8kHz sampling rate and 16 bit PCM wave format, and that you save the files to a location that is accessible from the SIPxNano Configuration server (e.g., a network location that you can browse to).
  • Page 67: System

    Chapter 6 System Chapter contents 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 ............................60 General..................................61 SIP Parameters ..............................61 Voice Mail ..............................62 Call Pickup ..............................63 Presence Server...
  • Page 68: Overview

    The System Management section of the SIPxNano Configuration Server interface allows you to configure and view SIPxNano settings that impact SIPxNano behind the scenes (not directly apparent to users) and are important to administrators for monitoring system performance status as well as providing the ability to take precautionary measures in backing up the system.
  • Page 69: Adding Dial Rules

    SIPxNano IP-PBX Getting Started Guide 6 • System Adding dial rules To add a dial rule: 1. Click System > Dial Plans > Add Dial Rules. Figure 33. Add dialing rule 2. From the Add Dialing Rule drop-down menu, select the type of dialing rule you want to add.
  • Page 70: Activating Dial Rules

    SIPxNano IP-PBX Getting Started Guide 6 • System Note The AutoAttendant dial rule should never be at the top of the Dial Rules list because it will catch all the other dial plans and prevent calls out. Activating dial rules When you have completed your dial plan configurations, select the respective dial plan’s checkbox on the Dial...
  • Page 71: Permissions

    SIPxNano IP-PBX Getting Started Guide 6 • System Permissions To access the Permissions page, click System > Permissions. Permissions defined on the Permissions page under System can be used when defining dialing plan rules.Built- in permissions cannot be changed or removed. You can enable and disable permissions for User and User Groups.
  • Page 72: General

    • “Call Detail Records (CDRs)” on page 66 To access the General screen, click System > General. General configuration of SIPxNano includes SIP paramters, voicemail, call pickup, presence server, logging changes and settings, and call detail records (CDRs). Note When you click Apply after making changes to the sections under General, the Restart Services screen will display.
  • Page 73: Voice Mail

    SIPxNano IP-PBX Getting Started Guide 6 • System Voice Mail The Voice Mail section under General has configurable fields including: VoiceMail expiration (which defines the number of days voicemail messages should remain on the system before they are deleted) and Maximum internal extension length (which defines the longest internal extension allowed in the system dialing plan).
  • Page 74: Call Pickup

    SIPxNano IP-PBX Getting Started Guide 6 • System Call Pickup Enter dialing codes for global call pickup, directed call pickup, and call park retrieve. Click Show Advanced Settings enter the setting for Call Pickup Timeout, in seconds, that the original call will ring after the pickup code is dialed.
  • Page 75: Presence Server

    SIPxNano IP-PBX Getting Started Guide 6 • System Presence Server This server determines the code that people use to log in and out of the system at phones. The default login is *88 and the default logout is *86, but you can change these based on your requirements.
  • Page 76: Logging

    SIPxNano IP-PBX Getting Started Guide 6 • System Logging Logging parameters set here determine the level of log detail for associated components, including Authoriza- tion Proxy, Proxy, Registrar, Park Server, Status Server, and the Presence Server. Figure 40. Logging The settings you can configure are: •...
  • Page 77: Call Detail Records (Cdrs)

    SIPxNano IP-PBX Getting Started Guide 6 • System Call Detail Records (CDRs) Call Detail Records capture information about calls handled by your SIPxNano ECS system. They can be used for billing and cost accounting. Figure 41. Call Detail Records (CDR) The settings you can configure are:...
  • Page 78: Import

    SIPxNano IP-PBX Getting Started Guide 6 • System Import You can generate a comma separated values file (CSV) by exporting data from your favorite spreadsheet appli- cation (e.g., Microsoft Excel). Figure 42. Importing CSV files Importing CSV files 1. From the main screen, click System > Import.
  • Page 79: Ldap

    LDAP Lightweight Directory Access Protocol (LDAP) can be used to import information on users and their attributes. Currently, LDAP on the SIPxNano works only with OpenLDAP. Before you can import LDAP, you must first configure the LDAP server. Configuring the LDAP server To configure the LDAP server:...
  • Page 80: Import Ldap

    SIPxNano IP-PBX Getting Started Guide 6 • System Import LDAP To setup an LDAP import: Figure 44. Import LDAP 1. From the main screen, click System > LDAP. 2. Click Preview to see the example of the user imported from the LDAP server. Click OK.
  • Page 81: Backup

    System administrators should regularly create backup copies of the SIPxNano data 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 voicemail.
  • Page 82: Scheduling Backups

    Figure 46. Successful backup Note SIPxNano backup files should be stored on media or a machine other than the SIPxNano server. Scheduling backups In addition to performing a manual backup, you can schedule backups.
  • Page 83: Domain

    SIPxNano IP-PBX Getting Started Guide 6 • System Domain To access the Domain page, click System > Domain. Note If the Domain Name setting is changed in a production system, all the phone profiles have to be regenerated. Use with caution.
  • Page 84: Diagnostics

    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: Overview

    • “Snapshot” on page 77 Registrations From the Registrations screen, you can 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 registrations: 1.
  • Page 86: Job Status

    SIPxNano IP-PBX Getting Started Guide 7 • Diagnostics Job Status When you send profiles to managed phones, the Job Status log records and displays information, including the date and time of your request and its status. Figure 50. Job Status log...
  • Page 87: Services

    7 • Diagnostics Services Services allows you to start, stop, restart, 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 as SIPAuthProxy, SIPProxy, SIPRegistrar, and SIPStatus, all parts of the Com- mServer.
  • Page 88: Snapshot

    SIPxNano IP-PBX Getting Started Guide 7 • Diagnostics Snapshot Snapshot allows you to capture Log files, Apache configuration files, and if you are diagnosing a problem that requires real credential information, you can select the Credentials checkbox to capture password information from the credentials file.
  • Page 89: Voicemail

    Chapter 8 Voicemail Chapter contents Overview ................................79 Accessing the Voicemail webpage ..........................79 Managing Voicemail Messages ..........................79 Listening to messages ............................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...
  • Page 90: Overview

    SIPxNano IP-PBX Getting Started Guide 8 • Voicemail Overview Each existing user has voicemail access, but the voicemail page is separate from the main screen. Note You can only access the voicemail webpage with an active User ID and PIN.
  • Page 91: Listening To Messages

    SIPxNano IP-PBX Getting Started Guide 8 • Voicemail Listening to messages To listen to voice messages: 1. Click on the folder you’d like to access (Inbox, Saved, Deleted, or Personal). 2. Under the Play column, click on the speaker icon by the message you want to hear.
  • Page 92: Editing Voicemail Preferences

    SIPxNano IP-PBX Getting Started Guide 8 • Voicemail Editing Voicemail Preferences Under the Voicemail Preferences section on the Voicemail webpage, the following options are available: Manage Folders, Manage Greetings, Manage Distribution, and Mange Notifications. Manage Folders From the Manage Folders page, you can add, delete, and edit personal folders.
  • Page 93: Manage Distributions

    4. If you want to attach a voice message, select the Attach voice message checkbox. 5. Click Save. Note The Email Notification Feature must be enabled by your SIPxNano admin- istrator in order for individual users to set up email notifications. Editing Voicemail Preferences...
  • Page 94: Contacting Patton For Assistance

    Chapter 9 Contacting Patton for assistance Chapter contents Introduction ................................84 Contact information..............................84 Patton 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-warranty service ..........................85 Returns for credit...
  • Page 95: Introduction

    SIPxNano IP-PBX Getting Started Guide 9 • Contacting Patton for assistance Introduction This chapter contains the following information: • “Contact information”—describes how to contact Patton technical support for assistance. • “Warranty Service and Returned Merchandise Authorizations (RMAs)”—contains information about the warranty and obtaining a return merchandise authorization (RMA).
  • Page 96: Out-Of-Warranty Service

    SIPxNano IP-PBX Getting Started Guide 9 • Contacting Patton for assistance Out-of-warranty service Patton services what we sell, no matter how you acquired it, including malfunctioning products that are no longer under warranty. Our products have a flat fee for repairs. Units damaged by lightning or other catastro- phes may require replacement.
  • Page 97: A Session Initiation Protocol (Sip)

    Appendix A Session Initiation Protocol (SIP) Chapter contents Overview ................................87 SIP Messages .................................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 URLs ................................92...
  • Page 98: Overview

    SIPxNano IP-PBX Getting Started Guide A • Session Initiation Protocol (SIP) Overview The Session Initiation Protocol (SIP) establishes a standard methodology for setting up, maintaining, and end- ing interactive communication sessions. To perform these tasks, SIP, like HTTP (Hypertext Transfer Protocol), uses a request-response model in which messages are exchanged by system components.
  • Page 99: Methods

    SIPxNano IP-PBX Getting Started Guide A • Session Initiation Protocol (SIP) Methods SIP call control methods identify the type of request that is being made. The following table lists SIP methods and their functions. Table 7. SIP Methods and Functions...
  • Page 100: Response Codes

    SIPxNano IP-PBX Getting Started Guide A • Session Initiation Protocol (SIP) SIP Phones support these SIP methods: Table 8. Supported Methods Methods Initiated Methods Received INVITE INVITE REFER REFER CANCEL CANCEL REGISTER OPTIONS OPTIONS NOTIFY NOTIFY SUBSCRIBE Response Codes SIP response codes indicate the status of a session. Response codes are generated and sent in outgoing mes- sages, and accepted when received in incoming messages.
  • Page 101: Message Headers

    SIPxNano IP-PBX Getting Started Guide A • Session Initiation Protocol (SIP) Message Headers Each SIP message is accompanied by a header with these required fields: Table 10. Message Headers Field: Contains: From The address of the session originator, expressed as a SIP URL The address of the session target, expressed as a SIP URL Call-ID A unique identifier assigned to all of the SIP messages related to a call...
  • Page 102: Call Setup

    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 transfer SIP Messages...
  • Page 103: Successful Consultative Transfer

    SIPxNano IP-PBX Getting Started Guide A • Session Initiation Protocol (SIP) Successful consultative transfer Figure 59. Successful consultative transfer SIP URLs Instead of only being assigned to specific devices the way that telephone numbers traditionally are assigned, you can assign SIP URLs to both a specific device and to the individual users who participate in SIP sessions.
  • Page 104: Sip Transactions

    SIPxNano IP-PBX Getting Started Guide A • Session Initiation Protocol (SIP) SIP Transactions A SIP transaction consists of a set of related SIP messages: usually, a request such as an INVITE, zero or more provisional responses (1xx response code), and a final response (2xx or greater). For example, the set of mes- sages sent by a callee phone during call setup to indicate trying, ringing, and Ok make up a SIP transaction.
  • Page 105: System Components

    SIPxNano IP-PBX Getting Started Guide A • Session Initiation Protocol (SIP) System Components Components in a SIP system send and respond to the messages that set up, establish, and terminate sessions. Table 11. SIP System Components Component Description UAC (User Agent Client) An application that initiates a request and sends it in a SIP message.
  • Page 106: Firewalls And Nat

    Appendix B Firewalls and NAT Chapter contents Working with Firewalls and NAT .........................96 Configure the firewall ............................96 Recording the external 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...
  • Page 107: Working With Firewalls And Nat

    SIPxNano IP-PBX Getting Started Guide B • Firewalls and NAT Working with Firewalls and NAT For phones to make calls to parties on the other side of a firewall, you configure both the firewall and the phone. • If your firewall is packet-based, you configure both the firewall and the phone to identify the ports that allow incoming VoIP traffic (SIP, RTP, and RTCP packets) to pass through it.
  • Page 108: Configure A Phone

    SIPxNano IP-PBX Getting Started Guide B • Firewalls and NAT Configure a Phone Once you have identified the external IP address and opened ports for the incoming VoIP traffic on your packet-based firewall, you configure the phone to use those same values. Use the phone’s browser-based inter- face to: •...
  • Page 109: Work With A Firewall With Nat

    SIPxNano IP-PBX Getting Started Guide B • Firewalls and NAT Work with a Firewall with NAT If you are using multiple phones behind a firewall with NAT, and if that firewall has only a single external IP address, you must open a unique set of external SIP and RTP/RTCP port/address pairs for each phone that makes calls through the firewall.
  • Page 110: Work With A Proxy Firewall

    SIPxNano IP-PBX Getting Started Guide B • Firewalls and NAT Work with a Proxy Firewall For phones to work in an environment with a proxy-based firewall, the firewall must have a SIP-specific proxy implemented. Refer to the documentation provided by your firewall vendor for instructions on how to config- ure its SIP features.
  • Page 111: Configuration Apis

    Appendix C Configuration APIs Chapter contents SIPxNano Configuration APIs ..........................101 Install the APIs ..............................101 Core 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...
  • Page 112: C Configuration Apis

    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 with new and revised user and device data as an ongoing system activity Install the APIs Patton delivers the files for SIPxNano Configuration APIS in a single compressed zip file.
  • Page 113: Core Classes And Operations

    API from other languages as long as the access con- forms to the WSDL. Add User Creates a new user in SIPxNano from your external source data. To add a user, you use either: • createUser operation in the UserService. See the WSDL user-service.xml file •...
  • Page 114: Edit User

    (without the quotation marks). Edit User Modifies data for an existing SIPxNano user to match your external source data. To edit a user, you use either: • editUser operation in the UserService. See the WSDL user-service.xml file •...
  • Page 115: Delete User

    ID. See “Add User” on page 102. Add Device Creates a new device in SIPxNano from your external source data. To add a device, you use either: • createDevice operation in the DeviceService. See the WSDL device-service.xml file • AddDeviceCommand class in the com.Patton.pds.applications.loader.commands package Table 16.
  • Page 116 SIPxNano IP-PBX Getting Started Guide C • Configuration APIs Table 16. Core Operations: Add Device WSDL Parameter Java Method Description Required? deviceType Valid strings are: setDeviceType() xpressa_strongarm_vxworks (for Patton xpressa phones) ixpressa_x86_win32 (for Patton instant xpressa softphones) 7960 (for Cisco 7960G IP...
  • Page 117: Edit Device

    SIPxNano IP-PBX Getting Started Guide C • Configuration APIs Edit Device Modifies data for an existing SIPxNano device to match your external source data. To edit a device, you use either: • editDevice operation in the DeviceService. See the WSDL device-service.xml file •...
  • Page 118: Delete Device

    Assign Device to a User Creates an association between a user and a device in SIPxNano. An association between a user and a device allows SIPxNano to route incoming and outgoing calls properly. To assign a device to a user, you use either: •...
  • Page 119: Unassign Device From A User

    Send all profiles Sends all user, device, and application profiles to all phones managed by SIPxNano. You should send all profiles after you add users or devices to SIPxNano, or after assigning devices to users. To send all profiles, you use either: •...
  • Page 120: Send All Profiles To A Specified User

    SIPxNano IP-PBX Getting Started Guide C • Configuration APIs Send all profiles to a specified user Sends user, device, and application profiles to all phones assigned as devices to a specified SIPxNano user. To send profiles to a user’s phones, you use either: •...
  • Page 121: Sample Code

    SIPxNano IP-PBX Getting Started Guide C • Configuration APIs Sample code The SimpleClient class in the com.Patton.pds.applications package demonstrates how to use LoaderCommand objects to send requests to SIPxNano. A sample Java application follows. ////////////////////////////////////////////////////////////////////////// // Public Methods //// public static void *main(String[] args) { if(args.length != 3){...
  • Page 122 Appendix D Compliance information Chapter contents Compliance .................................112 ................................112 Safety ................................112 Radio and TV interference ..........................112 CE Declaration of Conformity ..........................112 Authorized European Representative ........................112...
  • Page 123: D Compliance Information

    SIPxNano IP-PBX Getting Started Guide D • Compliance information Compliance • FCC Part 15, Class A • EN55022, Class A • EN55024 Safety • IEC/EN 60950-1 Radio and TV interference This equipment generates and uses radio frequency energy, and if not installed and used properly—that is, in strict accordance with the manufacturer's instructions—may cause interference to radio and television recep-...

Table of Contents