Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
Contents
Overview ................................................................................................................................................... 4 Call Flow ............................................................................................................................................... 4 Redundancy ........................................................................................................................................... 7 SIP Options Ping ................................................................................................................................... 7 Icons .......................................................................................................................................................... 9 Edit ........................................................................................................................................................ 9 Delete .................................................................................................................................................... 9 Download .............................................................................................................................................. 9 View ...................................................................................................................................................... 9 Outbound Endpoint Group .................................................................................................................. 10 Inbound Endpoint Group .................................................................................................................... 10 Rates .................................................................................................................................................... 10 $........................................................................................................................................................... 10 Block / Unblock .................................................................................................................................. 10 Morph ................................................................................................................................................... 11 Carrier Setup ........................................................................................................................................... 12 Carriers ................................................................................................................................................ 12 Groups ................................................................................................................................................. 12 Inbound End Point Group ............................................................................................................... 13 End Points ....................................................................................................................................... 18 Outbound End Point Group............................................................................................................. 19 End Points ....................................................................................................................................... 20 Codes....................................................................................................................................................... 20 Search .................................................................................................................................................. 20 Editing a Code ..................................................................................................................................... 21 Importing Dial Codes .......................................................................................................................... 21 Importing Codes Step 1: ................................................................................................................. 21 Importing Codes Step 2: Import Sheet............................................................................................ 22 2012-2014 - IceHook Systems Page 2
Rates ........................................................................................................................................................ 22 Search .................................................................................................................................................. 23 Edit Rates ............................................................................................................................................ 23 Importing Rates ................................................................................................................................... 24 Importing Rates Step 1: Upload Rate Sheet.................................................................................... 24 Importing Rates Step 2: Import Sheet ............................................................................................. 26 Deleting Rates ................................................................................................................................. 27 Routes.................................................................................................................................................. 27 Lowest Price ........................................................................................................................................ 27 Highest Weight .................................................................................................................................... 28 Route Tables ........................................................................................................................................ 29 Adding a Route Table...................................................................................................................... 29 View Route Table ............................................................................................................................ 30 Changing Route Priorities ................................................................................................................... 30 Block Vendor....................................................................................................................................... 31 Clear Blocks and Overrides ................................................................................................................ 32 Trouble Shooting Call Logs ................................................................................................................. 32 Search Call Records ............................................................................................................................ 32 Sample Call Log.............................................................................................................................. 33 Response Codes .............................................................................................................................. 35 Appendix A: Genband S3 4.0c3-xx RouteNGN Configuration Guide ................................................... 36 Introduction ......................................................................................................................................... 36 RouteNGN Endpoint Configuration ................................................................................................... 36 Appendix B: Genband S3 v4.3m7 RouteNGN Configuration Guide: ................................................ 43 Introduction: ........................................................................................................................................ 43 RouteNGN GUI Endpoint Configuration ........................................................................................... 43 Global Configure CLI for H.323 End Point ........................................................................................ 49
Overview
The RouteNGN is a high capacity, carrier grade, flexible routing platform. It is designed and built to augment the routing capabilities of SIP compatible devices (SIP Devices). .
Call Flow
While it can be deployed in a variety of locations in a network, it is recommended that the RouteNGN is located behind an SBC or Soft Switch. In most cases users configure their SIP Devices with very basic routing. The primary role the SIP Device plays in routing will be to identify the customer sending the traffic. The RouteNGN provides routing instructions to SIP Devices via a 3XX Redirect message and is capable of sending multiple route choices in a single redirect message.
Redundancy
The RouteNGN is configured in an N+1 configuration. Upon the initiation of the service, users are provided with a Fully Qualified Domain Name (FQDN) that will serve as the users signaling address. If users SIP Device(s) are not capable of routing to a DNS address, IP addresses will be provided. All updates to the system will propagate to both the primary and secondary servers after changes are made via the user interface.
Figure 3 - An overview of call flow with both primary and secondary clusters configured
Icons
The RouteNGN web interface was designed to be as streamlined as possible. Our designers have taken great care to minimize superfluous buttons and keep a consistent look and feel throughout the system. There are a few icons that users should become familiar with.
Edit
The Edit icon appears virtually every screen in the RouteNGN interface. It allows users to change the properties of an element within the system. The Edit icon is always located within the element that it affects.
Delete
The Delete icon will permanently remove elements in the system. It will also remove all associations to that element. For example if a user deletes a dial code it will also delete all associated rates and routes associated with that dial code. The Delete feature will always ask the user if he or she is certain they wish to perform this action.
Download
This icon indicates that the user may download the items on this page as a Comma Separated Value (CSV) file
View
This icon allows the user to view more detailed information of a dataset in the system. In the case of Route Tables, it will open the view routes page. 2012-2014 - IceHook Systems Page 9
This icon indicates the traffic direction of an endpoint group. This icon is associated with endpoint groups that terminate traffic.
This icon indicates the traffic direction of an endpoint group. This icon is associated with endpoint groups that originate traffic.
Rates
$
The Rate button allows the user to view all the rates associated with the dial code it is associated with.
Block / Unblock
These icons, found on the Route Table view screen, indicate the blocked status of a particular Dialcode. If the Details column has a closed lock, it is an indication that one or more routes for that Dialcode is blocked. When editing a route, any endpoint group with a red, closed lock next to it is blocked. Clicking on this lock will allow the user to see the status of the block or unblock the route. Clicking on the open lock in the edit route view will allow the user to block that endpoint group for that destination. 2012-2014 - IceHook Systems Page 10
Morph
The Morph icon allows admin users to assume the privileges of a sub-user on the same account.
Carrier Setup
Carriers
The Carrier setup page may be found by clicking [CARRIERS] on the top menu bar. Carriers are defined as the customers and vendors that the end user is peered with. Carriers may be broken out to Groups and Groups can have within them multiple End Points (SIP Peers). Each of these items is broken out into individual sections on the New or Edit Carrier screen To set up a new Carrier, click the 'New Carrier' button on the upper right of the page NAME The top field is for Carrier Name. Color This field is auto-selected, but the user may choose a new color. Minimum Duration Default minimum billing duration in seconds. Billing Increment Default billing increment in seconds.
Groups
Groups are found on the Carrier setup page. Carriers have a one-to-many relationship with Groups and all routing is done on the Group level. Groups are defined as the features associated with an End Point or End Points (SIP Peers).
Color This field is auto-selected, but the user may choose a new color. Route On Type RouteNGN allows users to route calls based on DN, RN or ANI. NOTE 1: IF ROUTE ON TYPE IS SET TO RN AND THE RN IS NOT PRESENT, IT WILL DEFAULT TO ROUTE ON DN. NOTE 2: IF THE ROUTENGN IS PERFORMING THE LRN QUERIES, IT WILL NOT PERFORM A QUERY IF THE ORIGINAL INVITE COMES IN WITH THE NPDI PARAMETER PRESENT. IF LRN INFORMATION IS AVAILABLE ON THE ORIGINAL INVITE, AND ROUTE ON TYPE IS SET TO RN, THE ROUTENGN WILL UTILIZE THE LRN FROM THE INVITE TO ROUTE THE CALL. Min Percent Margin This field represents the minimum margin percent required for a Group. If this field is set to 0, any calls sent by that group will not route at a loss. If the field is set to '10' the minimum margin for any route returned will be 10%. Leaving this field blank disables any margin calculation. Min Absolute Margin This field represents the minimum absolute markup required for a Group. If the Min Absolute Margin field is set at '0.05' the minimum markup for any route returned will be five (5) cents. Leaving this field blank disables any margin calculation. NOTE: USING BOTH MIN PERCENT MARGIN AND MIN ABSOLUTE MARGIN REQURES THAT BOTH CONDITIONS ARE TRUE TO ADD A ROUTE. Dialcode Prefix Matcher The Dialcode Prefix Matcher field is a regular expression that allows users to configure different characters to use as a prefix demarcation point. The default character is #. Dialcode Matcher The Dialcode Matcher field is a regular expression that allows users to manipulate the DN on an inbound End Point Group. The default is set to ignore all non-numerical characters.
NOTE: IT IS IMPORTANT TO NOTE THAT THE DIALCODE PREFIX FINDER AND DIALCODE FINDER ARE MUTUALLY EXCLUSIVE. IN OTHER WORDS, IDENTIFYING THE PREFIX DOES NOT AUTOMATICALLY ASSUME THAT THE REST OF THE TO STRING IS THE DN. Contact Template The Contact Template field allows users to modify the 3XX redirect message on an End Point Group level. The default is set according to the RFC 3261. The variables represent the following:
{oepg.prefix} Outbound End Point Group Prefix {ruri.Dialcode} Request Uniform Resource Identifier Dialcode {ruri.user_params} Request Uniform Resource Identifier User Parameter {oepg.uri_user_params} Outbound End Point Group Request Uniform Resource Identifier Parameter {oep.host} Outbound End Point Host {oep.port} Outbound End Point Port {iep.host} Inbound End Point Host {iep.port} Inbound End Point Port {ruri.params} - Request Uniform Resource Identifier Parameter {oepg.uri_params} - Outbound End Point Group Parameter {ir.price} Inbound Price {ir.billing_increment} Inbound Price Billing Increment {ir.type} Inbound Rate Type (aka jurisdiction) {or.price} Outbound Price {or.billing_increment} Outbound Price Billing Increment {or.type} Outbound Rate Type (aka jurisdiction)
Example:
<sip:333#2157123111;rn=8087321000;npdi=yes;dtg=att@192.168.1.1:5060;abc=123;xyz=456>
Multi-Line Contacts The Contact Header in the redirect message may be formatted in one of two ways. 2012-2014 - IceHook Systems Page 16
Multi-Line = True: Contact: <sip:DN@IP1> Contact: <sip:DN@IP2> Contact: <sip:DN@IP3> Multi-Line = False: Contact: sip:DN@IP1, DN@IP2, DN@IP3 Where: DN = Destination Number IPx = IP address or Fully Qualified Domain Name and x = route choice
Primary and Secondary Route Table The Route Table menus are pull-down lists that contain all configured Route Tables [see the Route Table Section below on how to create and configure Route Tables]. Inbound Groups will route traffic according to the priorities set in the associated Route Table. User must select at least a Primary Route Table in order to successfully route calls. The Secondary Route Table may be left blank, or may be used to select a second Route Table to be used if the Primary Route Table fails to find any routes for a particular call. Allow List The Allow List enables the user to identify an inbound End Point Group. Prefix Prefixes may any length but must end with a delimiter. The default delimiter is set to # but this may be modified using the Dialcode Prefix Finder field. Note that the Prefix will automatically get stripped from the DN. URI User Params / URI Params The two URI Params fields allow the user to enter unique messages in order to identify an invite as belonging to a particular End Point Group. Often times the identifiers are trunk group tags, but the RouteNGN allows users to specify any string within the invite URI.
End Points
End Points are SIP Peers. Groups have a one-to-many relationship with End Points. Enter an IP address or an FQDN in the text box labeled Host. Users may specify a port number as well. The default port is 5060.
Max Contact End Points This field allows users to select the maximum number of end points for the selected Outbound End Point Group which are sent in a redirect message. For example, if a user has 5 End Points configured for End Point Group X, but sets the Max Contact End Points set to 2, the redirect message will randomly select on each call 2 End Points to return in the redirect message.
End Points
End Points are SIP Peers. Groups have a one-to-many relationship with End Points. Enter an IP address or an FQDN in the text box labeled Host. Users may specify a port number as well. The default port is 5060. NOTE: UNLESS LIMITED BY MAX CONTACT ENDPOINGS, ALL END POINTS ASSOCIATED WITH AN END POINT GROUP WILL BE ADDED TO A REDIRECT MESSAGE.
Priority Users may set a priority on any outbound End Point to specify the order in which End Points will be added to a contact message. The lower numerical value associated with an End Point takes precedence.
Codes
The Carrier setup page may be found by clicking [Codes] on the top menu bar. The Codes table is the master Dialcode table within the RouteNGN and is used to determine call jurisdiction. Dialcodes are unique within the system. Users may add attributes to codes such as Country, State, City, Local (calling area), LATA, OCN, OCN Name, and LERG category, but none of these fields are required.
Search
Users may search for Codes by populating the empty fields just below the column headers with their search criteria and clicking Search. Populating multiple fields will create a compound search with a logical AND operation. Therefore searching for Country: Canada and City: New York will yield zero results. 2012-2014 - IceHook Systems Page 20
To enable a wildcard search add a %. A search for 315% will also yield 315200.
Editing a Code
Users may edit a code by clicking on the edit icon next to the code to be modified.
click on the New Sheet button on the Codes page. Then click Browse to search the users computer or network drives for the Codes file to be uploaded. Next, click Save. Code Sheet Format The file must be in CSV (Comma Separated Value) format. The layout may vary so long as the headers in the fields match the headers in the interface. Headers should all be lowercase and any spaces must be replaced with an underscore. For example OCN Name, should be ocn_name. Code Sheet Header Row Key Value in RouteNGN Dialcode Country State City Local LATA OCN OCN Name LERG Category dialcode country state city local lata ocn ocn_name lerg_category Header
Rates
Customer and supplier rates may be found by clicking [Rates] on the top menu bar, or by clicking on the $ icon associated with a Dialcode. Rates are broken down by Direction, Type 2012-2014 - IceHook Systems Page 22
(Jurisdiction), and Effective Date. The system supports Interstate (inter), Intrastate (intra), Undefined (no jurisdiction), and Local (local) rate types.
Search
Users may search for Rates by populating the empty fields just below the column headers with their search criteria and clicking Search. Populating multiple fields will create a compound search with a logical AND operation; For example, searching for Dialcode 315200 and Type: undefined will yield only undefined rates for dial code 315200. Dialcode searches on the Rates page support wild-card searches by using %, so a search for 315% will also yield 315200.
Edit Rates
Users may edit a code by clicking on the edit icon next to the code to be modified.
Importing Rates
Importing rates into the RouteNGN is a two-step process. The process is as follows:
Effective At This field may be used to set the effective date of the rates being imported. NOTE: THE EFFECITVE AT FIELD WILL BE OVERRIDDEN BY THE EFFECITVE AT COLUMN ON THE SHEET ITSELF, SHOULD ONE EXIST. Sheet Clicking Browse on this field will allow the user to search the users computer or network drives for the Rates file to be uploaded. Next, click Save. Users will see a success message once the operation is complete. Rate Sheet Formatting The file must be in CSV (Comma Separated Value) format. The layout may vary so long as the headers in the fields match the headers in the interface. Headers should all be lowercase and any spaces must be replaced with an underscore. For example Effective At , should be effective_at. NOTE: RATE SHEETS MUST CONTAIN EITHER DIALCODE OR LATA/OCN. RATE SHEETS MUST NOT CONTAIN BOTH DIALCODE AND LATA/OCN.
Rate Sheet Header Row Key Value in RouteNGN Dialcode LATA OCN Type [Rate Type] Interstate Price Intrastate Price Undefined Price Local Price Effective Date Ineffective Date Weight Interstate Weight Intrastate Weight Undefined Weight Local Weight Minimum Duration Billing Increment dialcode lata ocn
Header
type [inter,intra,undefined,local] inter_price intra_price undefined_price local_price effective_at ineffective_at weight inter_weight Intra_weight undefined_weight local_weight minimum_duration billing_increment
Import Rates As Replacement This option will modify previously uploaded rates associated with the Endpoint Group to have an ineffective date two hours subsequent to the new rates becoming effective. NOTE: IMPORT RATES AS REPLACEMENT WILL MAKE ALL PREVIOUS RATES FOR AN ENDPOINT GROUP INEFFECTIVE, IRRESPECTIVE OF THE RATE TYPES REPLACING THEM. Successfully imported rates will have a status of imported.
Deleting Rates
To maintain optimal performance of the system, it is recommended that obsolete rates be removed from the database regularly. Rates may be deleted from the system in correspondence with the original rate sheet used to import the rates. To remove rates, navigate to the Rate Sheets tab, then click on View Sheet for the rates that are to be removed. Under Actions, select Delete All Imported Rates. The rates will then begin deleting in the background. It may take several minutes to complete this operation but the user may navigate away. NOTE: ONLY THE RATES ASSOCIATED WITH THE SELECTED RATE SHEET WILL BE DELETED.
Routes
Routing combines the information Codes, Rates, and Outbound End Point Groups to generate a real-time decision matrix that is controlled by the end user. There are two routing algorithms or Ordering Methods on the RouteNGN. Users may choose either Lowest Price or Highest Weight.
Lowest Price
Call routing on the RouteNGN uses the following algorithm to determine routing priority using Lowest Price: 1. Best price for all possible rate matches with current effective date 2. Reduce to longest code match for each End Point Group 3. Sort by End Point Group priority overrides 4. Reduce End Point Group blocks 2012-2014 - IceHook Systems Page 27
Highest Weight
Call routing on the RouteNGN uses the following algorithm to determine routing priority using Highest Rate: 1. Highest Weight for all possible rate matches with current effective date 2. Reduce to longest code match for each End Point Group 3. Sort by End Point Group priority overrides 4. Reduce End Point Group blocks 5. Reduce End Point Groups where Profit Threshold is not met
Route Tables
The Route Tables setup page may be found by clicking [Route Tables] on the top menu bar. Route Tables are where the user sets the routing rules to be applied to Inbound End Point Groups. The system allows users to add multiple Route Tables.
Order icon. NOTE: ROUTE PRIORITIES MAY AUTOMATICALLY CHANGE BASED UPON CHANGING RATES AS THEY BECOME EFFECTIVE. ROUTES WHICH HAVE BEEN MANUALLY OVERRIDDEN WILL NOT CHANGE AUTOMATICALLY BASED ON RATE CHANGES.
Block Vendor
To block a vendor on an individual Dialcode, click the Edit icon to show the route choices then click on the Block icon on the vendor to be blocked. Next click on the calendar button below the Expires At field to set the time/date when the block is to expire, then click on the block button to complete the block. To block a vendor indefinitely, leave the Expires At field blank and then click the block button. Once a route is blocked, the Details column will display a Blocked icon.
Response Codes
In order to assist with trouble shooting, every call is assigned an internal response code.
Internal Code 300 700 720 740 External Code 300 503 Code Description Redirect SIPRedirectorError ExternalProcessingError RequestProcessingError Error communicating with external DB Malformed SIP message received IP is loaded into the the ACL, but SIP request is unable to match an inbound endpoint group; check 'Allow List' This will only be viewable from the SIP device as no log is generated for this error code Notes
741
401
AccessDeniedError
742 743 744 746 760 780 790 503 503 503 503
UnknownRequestError InboundChannelError RequestTimeoutError MaxRequestError DirectoryError RouteDeterminationError ResponseError System is above its maximum number of requests per second Invite did not match an existing Dialcode No route found; check route table
From the Device Type select SIP Proxy Enter a name for the RouteNGN in the Registration ID: field Port Number will automatically populate with zero Enter the IP Address of the RouteNGN Select a Calling Plan Select the Realm on which the RouteNGN resides Select IEdge Group
In the Protocol tab confirm that only the SIP radio button is checked. Then click on the SIP Configure button.
Enter the FQDN, provided by IceHook, in the Contact: field Check the FQDN redundancy radio button Select the OK button to go back to the Protocol tab.
Check Unlimited for all three CAC setting. Confirm that all three the radio buttons are unchecked for Media control
Select the OK button to save the endpoint. The RouteNGN end point is now configured and set-up for redundancy.
From the Device Type select SIP Proxy Enter a name for the RouteNGN in the Registration ID: field Port Number will automatically populate with zero Enter the IP Address of the RouteNGN Select a Calling Plan Select the Realm on which the RouteNGN resides
In the Protocol tab confirm that only the SIP radio button is checked. Then click on the SIP Configure button.
Check the FQDN redundancy radio button Enter the FQDN, provided by IceHook, in the Contact: field Select the OK button to go back to the Protocol tab.
Check Unlimited for all three CAC setting. Confirm that all three the radio buttons are unchecked for Media control
The RouteNGN end point is now configured and set-up for redundancy.
ocn 9102
inter_price 0.05
Alternatively, this modification may only need to be made on the handful of exceptions where a LATA crosses state lines.