Column	Description
System Name	Name the device that will be used to register and send traffic on the SIP network (for example: sip:5224@netsapiens.com). This field must match parameters in the phone configuration. System Name appears only in the display page.
Owner	User account with which this device is associated.
Device Name	Same as the system name above. This column can be displayed or hidden by clicking the Show/Hide Device Name button.
Date Created	The date that the user device was created in the system.
Device Type	Hardware name of the phone (for example, PolycomSoundPointIPSIP).
Contact	Name and LAN IP address of the phone (for example, 5244@192.168.1.120). This column can be displayed or hidden by clicking the Show/Hide Contact button.
Nat Wan	Make your selection depending on whether your phones are on a LAN or on WAN addresses. Automatic = use this setting if your phones are on a LAN. Best to use this setting for devices (default) None = use this setting if your phones are on WAN addresses. Best to use this for connections as they are on a public network Never = This option is generally not used; only use in this in specific circumstances Fixed =
IP Address	IP address the phone last registered from. A black font means the address is currently registered. A grayed-out font means the address was registered, but is not currently in use.
Remote	Reserved for future use.
Registration Time	Last time the phone registered. Black font means the phone is currently registered. Grayed out font means the phone was registered, but currently is not. You can use this to see when an unregistered phone was last registered.
Registration Expire(s)	Shows how often the phone will be forced to re-register with the server.
Watch	Yes = an email or SMS message is sent when this device loses registration. If set to Yes and registration expires, the email address in System Settings, Status Email receives a notification. The Timer Registration Grace Period under System Settings, Timers, controls this operation. No = no email is sent when the device loses registration. (default)
Origination Allowed	Specifies whether the user is allowed to originate calls. This column can be displayed or hidden by clicking the Show/Hide Permissions button. Yes = device can originate calls. (default) No = device cannot originate calls.
Termination Allowed	Specifies whether the user is allowed to terminate calls. This column can be displayed or hidden by clicking the Show/Hide Permissions button.
Authenticate Registration	Specifies whether authentication will be required when a register packet is sent from the phone. This column can be displayed or hidden by clicking the Show/Hide Permissions button.
Authenticate Invite	Specifies whether authentication will be required when an invite is sent from the phone. This column can be displayed or hidden by clicking the Show/Hide Permissions button.
Rules	Reserved for future use. This column can be displayed or hidden by clicking the Show/Hide Permissions button.

Initially, the User Devices page shows all the user devices in the system. To locate a particular user device, you can search criteria using the Find Device and/or Find Owner fields at the top right side of the User Devices page, or the Reseller and/or Domain drop-down lists at the bottom-left side of the User Device page to filter user devices by reseller and/or domain.

If the number of user devices shown exceeds what the page can display, a next link appears at the lower right area of the page. Click this link to display the next page of user devices.

The User Devices page has three toggle buttons:

• Show/Hide Device Name lets you show or hide device names in the User Devices page. The name of this button toggles depending on whether device names are shown or hidden.

• Show/Hide Contact lets you show or hide contacts in the User Devices page. The name of this button toggles depending on whether contacts are shown or hidden.

• Show/Hide Permission lets you show or hide permissions in the User Devices page. The name of this button toggles depending on whether permissions are shown or hidden.

• The User Devices page also has a Refresh button. After you add, edit, or delete user devices, click this button to update the contents on this page.

Finding a User Device

• You can find a device using the name of the device and/or the device owner:

• To find a device by its device name, enter the first few characters of the user device in the Find Device field. For example, to find the user device 5244@netsapiens.com, you can type 5244 or 52.

• To find a device associated with a user, enter the first few characters of the user name in the Find Owner field. For example, to find the owner 5244, you can type 5244 or 52.

The Find Device and Find Owner fields can be used together to narrow your view by filtering user devices by device and owner names.

• Click the Refresh button. Only the user devices that match the characters you typed appear in the User Devices page.

Filtering User Devices by Reseller and/or Domain

Initially, the Reseller and Domain fields contain an asterisk. This character means the User Devices page shows user devices for all resellers and domains.

• To filter user devices by a particular reseller, select a reseller in the Reseller drop-down list.

• To filter user devices by a particular domain, select a domain in the Domain drop-down list.

The Reseller and Domain drop-down lists can be used together to narrow your view by filtering user devices by reseller and domain.

• Click the Refresh button. Only the user devices that correspond to the reseller and/or domain you selected are displayed in the User Devices page.

Editing Devices

There may be times when you need to edit the information for a device. To edit a device:

• From the User Devices page, under the System Name column, click the system name that corresponds to the device whose settings you want to edit. The Details dialog box appears

• Change the values in the Details dialog box.

• Click the Modify button to exit the dialog box, then click the Refresh button to update the screen.

Column	Description
Device Name	Read-only field that shows the name of the device.
System Name	This read-only field appears in the Details dialog box and shows the name of the system you selected on the User Devices page.
Owner	Select the User name from the drop down list.
Date Created	Date the User Device was created
NatWan	Make your selection depending on whether your phones are on a LAN or on WAN addresses. Automatic = use this setting if your phones are on a LAN. (default) None = use this setting if your phones are on WAN addresses
Expires	How often in seconds the device registration will need to be re registered.
Watch	Yes = an email or SMS message is sent when this device loses registration. If set to Yes and registration expires, the email address in System Settings, Status Email receives a notification. The Timer Registration Grace Period under System Settings, Timers, controls this operation. No = no email is sent when the device loses registration. (default)
Record	Determines whether a device can have its conversations recorded. Yes = device can have its conversations recorded. No = device cannot have its conversations recorded. (default)
Registration Required	Determines whether the phone has to register with the server. Yes = phone has to register with the server. (default) No = phone does not have to register with the server.
Origination Allowed	Select whether the device is permitted to originate calls. Yes = device can originate calls. (default) No = device cannot originate calls.
Termination Allowed	Select whether the device is permitted to terminate calls. Yes = device can terminate calls. (default) No = device cannot terminate calls.
Force Notify	Some phones require Force Notify to be on to turn the message waiting light on at the phone. Yes = Force Notify on. No = do not force Notify on. (default)
Authenticate Registration	When a Register packet is sent from the phone, allows the server to require it to be authenticated. Yes = when a Register packet is sent from the phone, the server requires it to be authenticated. (default) No = when a Register packet is sent from the phone, the server does not require it to be authenticated.
Authenticate Invite	Specifies whether the server requires an Invite packet is sent from the phone to be authenticated. Yes = server requires authentication. (default) No = server does not require authentication.
Authentication Realm	Domain name (for example, netsapiens.com).
Authentication Key	Authentication password. This password must match the password in the phone.
Service Code	(regular) (test)

Deleting Devices

If you no longer need a device, use the following procedure to delete it from the system.

Deleting a device does not delete the associated user. You must delete the user separately.

• From the User Devices page, under the System Name column, click the system name that corresponds to the device you want to delete. 

• Click the Delete button. A precautionary message asks if you are sure you want to delete the item.

• Click OK to delete the device (or click Cancel to retain it).

• Click the Refresh button to update the screen.

Working with Connections

The following sections describe how to work with servers and gateways. Servers and gateways are managed using the Connections page.

To Display the Connections Page

• On the Connections menu, click Connections

Column	Description
Origination Match	The IP address of the originating connection
Domain
Termination Match
IP Address	IP address of the server or gateway to which you are connecting.
NatWan	Determines whether all RTP will be relayed through the SNAPsoftware connection module for this connection. Automatic = all RTP will be relayed through the connection module. None = RTP will not be relayed through the connection module. (default)
Orig	Determines whether origination is allowed on this server or gateway connection. Yes = origination is allowed. (default) No = origination is not allowed.
Term	Determines whether termination is allowed on this server or gateway connection. Yes = termination is allowed. (default) No = termination is not allowed.
Auth Invite	Authenticate upon INVITE received on this connection. Yes = send authentication challenge toward connection upon INVITE. No = do not send authentication challenge toward connection upon INVITE.
Request User	This OPTIONAL field is a NetSapiens translation rule used to modify the User portion of the "Request-URI:" field in a SIP message.  It only applies to outbound SIP INVITE messages on this connection. It is normally used when the SIP trunk provider this connection terminates to requires a "dial string prefix" number for all calls outbound on this connection. Providers usually need a fixed prefix to identify calls from their various SIP trunk users. This information will be provided by the SIP trunk provider and a translation rule will then be used here to prepend a prefix to the "Request-URI:" string.
Request Host	This OPTIONAL field is a NetSapiens translation rule used to modify the Host portion of the "Request-URI:" field in a SIP message.  It only applies to outbound SIP INVITE messages on this connection.
To User	This OPTIONAL field is a NetSapiens translation rule used to modify the User portion of the "To:" field in a SIP message.  It only applies to outbound SIP INVITE messages on this connection. It is normally used when the SIP trunk provider this connection terminates to requires a "dial string prefix" number for all calls outbound on this connection. Providers usually need a fixed prefix to identify calls from their various SIP trunk users. This information will be provided by the SIP trunk provider and a translation rule will then be used here to prepend a prefix to the "To:" string.
To Host	This OPTIONAL field is a NetSapiens translation rule used to modify the Host portion of the "To:" field in a SIP message.  It only applies to outbound SIP INVITE messages on this connection.
From User	This OPTIONAL field is a NetSapiens translation rule used to modify the User portion of the "From:" field in a SIP message.  It only applies to outbound SIP INVITE messages on this connection.
From Host	This OPTIONAL field is a NetSapiens translation rule used to modify the Host portion of the "From:" field in a SIP message.  It only applies to outbound SIP INVITE messages on this connection.
Orig Limit
# Orig
Term Limit
# Term
Total Limit
Send Register	In some cases, it may be necessary to register into a gateway or server connection from the SNAPsolution connection module. This field enables and disables this feature. This column can be displayed or hidden using the Show/Hide Registration button. Yes = send Register to server or gateway. No = do not send Register to server or gateway. (default)
Registration Time	This column can be displayed or hidden using the Show/Hide Registration button. Shows the last registration time if Send Register is set to “yes”.
Expire	Shows the expiration period if Send Register is set to “yes”.
Dial Translation	Used to configure which dial translation should be used for inbound calls to this connection.
Dial Permission	Used to configure dial permissions for this connection, including “Deny All”, “Permit All”, or custom permissions created in the Dial Permission page.
Time Zone	Time Zone in which this connection resides.
Rules
# Routes
Description	Area for a text description of the connection.

If the number of servers and gateways shown exceeds what the page can display, a next link appears at the lower right area of the page. Click this link to display the next page of servers and gateways.

A Show/Hide Registration button at the bottom of the page lets you view or hide registration information on the Servers/Gateways page.

The Connections page also has a Refresh button. After you add, edit, or delete servers and gateways, click this button to update the contents on this page.

Adding New Servers and Gateways

To add a new server or gateway:

• From the Connections page, click the Add Connection button. The Connections dialog box appears. 
  

• Complete the fields in the Servers/Gateways dialog box
  

• Click the Add Server button to exit the dialog box, then click the Refresh button. The PBX/PSTN gateway account you added appears on the PBX/PSTN Gateways page, with the settings you selected in the Add dialog box.

Field	Description
Destination Host	Host part of the destination match (could be IP address or domain name).
Orig Match	Match on the From-URI for the inbound side of the connection. In the Details dialog box, this field is read only.
Domain	If the connection is to be attributed to a specific domain then select here
IP Address	IP address of the server or gateway.
From User	Field used to translate the outbound user part of the From-URI. If the field is set as “[*]”, the user part of the From-URI will be passed through unchanged.
From Host	Field used to translate the outbound host part of the From-URI. If the field is set as “[*]”, the host part of the From-URI will be passed through unchanged.
Orig	Determines whether origination is allowed on this server or gateway connection. Yes = origination is allowed. (default) No = origination is not allowed.
Term	Determines whether termination is allowed on this server or gateway connection. Yes = termination is allowed. (default) No = termination is not allowed.
NatWan	Determines whether all RTP will be relayed through the SNAPsolution connection module for this connection. Automatic = all RTP will be relayed through the connection module. None = RTP will not be relayed through the connection module. (default)
Auth Invite	Determines whether an INVITE sent on this server/gateway connection should be challenged. Yes = INVITE is challenged. (default) No = INVITE is not challenged.
Authentication User	The name of the user that needs to be entered for authentication purposes - (Only if Auth Invite is set to YES)
Authentication Realm	A string displayed to users, so they know which user name and password to use (usually the domain name, such as netsapiens.com). - (Only if Auth Invite is set to YES)
Authentication Key	Authentication password - (Only if Auth Invite is set to YES)
Send Register	Yes = Require registration of the connection/trunk No = Does not require registration of the connection/trunk
Dial Translation	Inbound translation rule to which this connection points (usually Inbound Gateway).
Dial Permission	Permit All, Deny All, or custom (configured in the Dial Permission page).
Check IP	Determines whether to check the IP address from the inbound connection. Yes = check IP address. (default) No = do not check IP address.
Show Server	Determines whether the server name is shown in the SIP messages. Yes = show server name. (default) No = do not show server name.
Block Remote Ringback	Determines whether to block remote ringback and play local ringback. This setting converts a SIP183 RINGING to 180 RINGING. Yes = block remote ringback, play local ringback. No = play remote ringback. (default)
Time Zone	Time zone for this connection.
Orig Limit	The maximum number of originating calls that can be made at one time
Term Limit	The maximum number of terminating calls that can be made at one time
Total Limit	The total number of calls (originating or terminating) that can be made at one time
Min Duration(s)	Minimum duration of calls connected through this connection (if applicable)
Rate Account	The rating account to be used (only applies if the connection will be rated by the NAS)
Description	Text description of the server or gateway.

Editing Servers/Gateways

There may be times when you need to edit the information for a server or gateway. To edit a server or gateway:

• From the Connections page, under the Origination Match column, click the server or gateway whose settings you want to edit. The Connections Details dialog box appears
  

• Change the values in the Connections Details dialog box.  Note that the Request User/Host, From User/Host and To User/Host fields are only accessible in the edit menu once a connection has been created.  See the section above for a description.
  

• Click the Modify button to exit the dialog box, then click the Refresh button to update the screen.

Deleting Server and Gateway Accounts

If you no longer need a server or gateway account, use the following procedure to delete it from the system.

• From the Servers/Gateways page, under the Destination Host column, click the server or gateway you want to delete. The Details dialog box appears. 
  

• Click the Delete button. A precautionary message asks if you are sure you want to delete the item.

• Click OK to delete the PBX/PSTN gateway (or click Cancel to retain it).

• Click the Refresh button to update the screen.

Working with DIDs

The following sections describe how to work with DIDs. DIDs are managed using the DIDs page.

Adding New DIDs

To add a new DID:

•  From the Connections page, click the Add button. Then select DID in the dialog box that appears.

• The DID Info dialog box appears

• Complete the fields in the DID Info Add dialog box
  

• Click the Add DID button to exit the dialog box, then click the Refresh button. The DID account you added appears on the DIDs page, with the settings you selected in the DIDs dialog box.

Field	Description
Phone Number	DID phone number.
Domain	Domain to which the DID will be routed.
Orig	Determines whether origination is allowed on this DID connection. Yes = 0rigination is allowed. (default) No = 0rigination is not allowed.
Auth Invite	Determines whether an INVITE received from this DID connection should be challenged. Yes = INVITE is challenged. (default) No = INVITE is not challenged.
Authentication Realm	A string displayed to users so they know which user name and password to use (usually the domain name, such as netsapiens.com).
Authentication Key	Authentication password.
IP Address	IP address of the carrier who owns the DID.
NetWan	Determines whether all RTP will be relayed through the SNAPsolution connection module. Yes = RTP is always relayed through the connection module. No = RTP is not relayed through the connection module. (default)
Check IP	Determines whether to check the IP address from which the inbound call is coming. Yes = check IP address. (default) No = do not check IP address.
Show Server	Determines whether the server name is shown. Yes = show server name. (default) No = do not show server name.
Block Remote Ringback	Determines whether to block remote ringback and play local ringback. This setting causes a translation of SIP 183 RINGING to 180 RINGING. Yes = block remote ringback, play local ringback. No = play remote ringback. (default)
Time Zone	Time zone of the connection
Dial Translation	Inbound translation rule to which this connection points (usually Inbound Gateway)
Dial Permission	Permit All, Deny All, or custom (created in the Dial Permission page).
Orig Limit
Term Limit
Total Limit
Min Duration(s)
Description	Text Description of the DID connection.

Editing DIDs

There may be times when you need to edit the information for a DID. To edit a DID use the same process as for editing Servers/Gateways

• Change the values in the Details dialog box
  

• Click the Modify button to exit the dialog box, then click the Refresh button to update the screen.

Deleting DIDs

If you no longer need a DID, use the following procedure to delete it from the system.

• From the Connections page, under the Origination Match column, click the match that corresponds to the DID you want to delete. The Details dialog box appears
  

• Click the Delete button. A precautionary message asks if you are sure you want to delete the item.

• Click OK to delete the DID (or click Cancel to retain it).

• Click the Refresh button to update the screen.

Working with Legal Intercepts

The following sections describe how to work with legal intercepts. Legal intercepts are managed using the Legal Intercept - LEA page.

To Display the Legal Intercept - LEA Page

•  On the Connections menu, click Legal Intercept.

Column	Description
LEA ID	Call Content Connection Identifier, assigned by the law enforcement agency.
Edit	Link to allow editing of the legal intercept.
Name	Law enforcement address.
Address	Law enforcement contact.
Contact	Law enforcement phone number.
Phone	Law enforcement email address.
E-Mail	Used to select a user to monitor. You can monitor either Call Detail Recordings or actual RTP conversations for a certain time period.
SELECT	Call Content Connection IP address, where data or RTP is sent.
CCC IP	Call Content Connection Port. (UDP port) where data or RTP is sent.
CCC Port	Call Data Connection URL for law enforcement agency.
CDC URL	Legal intercept case number.
# LIC	Number of Legal intercept cases.

If the number of legal intercepts shown exceeds what the page can display, a next link appears at the lower right area of the page. Click this link to display the next page of legal intercepts.

The Legal Intercepts – LEA page also has a Refresh button. After you add, edit, or delete legal intercepts, click this button to update the contents on this page.

Adding New Legal Intercepts

• To add a new legal intercept:

From the Legal Intercept – LEA page, click the Add LEA button. The Add New LEA dialog box appears

• Complete the fields in the Add New LEA dialog box
  

• Click the Create button to exit the dialog box, then click the Refresh button. The LEA information you added appears on the Legal Intercepts – LEA page, with the settings you selected in the Add New LEA dialog box.

Field	Description
LEA ID	Call Content Connection Identifier, assigned by the law enforcement agency.
Name	Law enforcement name.
Address	Law enforcement address.
Contact	Law enforcement contact.
Phone	Law enforcement phone number.
E-Mail	Law enforcement email address.
CCC IP	Call Content Connection IP address where data or RTP is sent.
CCC Port	Call Content Connection Port (UDP port) where data or RTP is sent.
CDC URL	Call Data Connection URL for law enforcement agency.

Editing Legal Intercepts

• There may be times when you need to edit the information for a legal intercept. To edit a legal intercept:

From the Legal Intercept - LEA page, under the EDIT column, click the EDIT link for the legal intercept whose settings you want to edit. The Edit LEA Information dialog box appears

• Change the values in the Edit LEA Information dialog box
  

• Click the Modify button to exit the dialog box, then click the Refresh button to update the screen.

Adding Legal Intercept Information

• From the Legal Intercepts – LEA page, under the SELECT column, click the SELECT link that corresponds to the legal intercept you want to add information to. The LIC page appears
  

• Click the Add LIC button. The Add New LIC dialog box appears.

Add New LIC Dialog Box

• Complete the fields in the Add New LIC dialog box

• Click the Create button to exit the dialog box, then click the Refresh button. The LEA information you added appears on the Legal Intercepts – LEA page, with the settings you selected in the Add New LEA dialog box.

Field	Description
LEA ID	Read-only field that shows the unique ID assigned to the LEA derived from the LEA page.
Case ID	Enter the Case ID number
Device AOR	Select the device to be monitored.
Valid From	Select the date and time to start recording.
Valid To	Select the date and time to end recording.
Intercept CCC	When checked, intercept RTP and record.
Intercept CDC	When checked, intercept Call Detail Recordings.

Editing Legal Intercept Information

If you want to edit legal intercept information:

• From the Legal Intercepts – LEA page, under the SELECT column, click the SELECT link that corresponds to the legal intercept you want to edit. The LIC page appears
  

• From the LIC page, under the Case ID column, click the case ID whose information you want to edit. The Edit LIC Information dialog box appears

• Change the values in the Edit LIC Information dialog box
  

• Click the Modify button to exit the dialog box, then click the Refresh button to update the screen.

Deleting Legal Intercept Information

If you no longer need the legal intercept information for a case, use the following procedure to delete it from the system.

• From the Legal Intercepts – LEA page, under the SELECT column, click the SELECT link that corresponds to the legal intercept you want to edit. The LIC page appears

• From the LIC page, under the Case ID column, click the case ID whose information you want to delete. The Edit LIC Information dialog box appears
  

• Click the Delete button. A precautionary message asks if you are sure you want to delete the item.

• Click OK to delete the item (or click Cancel to retain it).

• Click the Refresh button to update the screen.

Working with Ratings

Using the Rating command in the Connections menu, you can set up a Rating server connection to your SiPbx. To set up a Rating server connection, you must have a separate rating server. With this Rating feature, you can perform Prepaid and Billing applications.

• On the Connections menu, click Rating. The Rating dialog box appears. Any rating parameters previously entered are displayed in the dialog box.

• To change the rating settings, click the Change button. The Rating dialog box appears.

• Change the values as necessary

• When you finish, click the Apply button. Your settings are enabled and the first Rating dialog box reappears.

Field	Description
Server Address	IP address of the Rating Server NetSapiens NAS
Server Port	UDP port (8008).
Refresh Period(s)	Specifies how often data transfers between SiPbx and NAS.
Response T/Os	Maximum number of times a refresh is tried before giving up.
Enable Rating	Determined whether rating is enabled on this SNAPsolution platform. Yes = enable rating on this SNAPsolution platform. (default) No = disable rating on this SNAPsolution platform

Managing Users

Dial Planning