Destination Sets


Destination Set is list of all prefixes, called Routes, with associated minute rates that should be sent to a particular Connection or group of Connections.

The role of Destination Set is two fold:

  1. First of all, it defines complete list of pefixes that have to be route to a particular Connection or group of Connections. When Connection is associated with particular Destination Set in Routing Group, only prefixes listed in that Destination Set will be routed to that Connection.
  2. Secondly, Destination Set defines prices that will be charged by the termination provider (Vendor) when the call is being sent to that provider. Those prices will be used to track balance with each particular Vendor as well as to make routing decisions when Least Cost routing is enabled.


Billing parameters in Destination Set are: 

  • FreeSeconds - in seconds
  • ConnectFee - in money units
  • PostCallSurcharge - in percents
  • GracePeriod - in seconds


The parameters above have the same meaning as similar parameters in Tariffs and they are used to calculate cost of the outgoing call.


Any changes related to Rates, Routes, Destination Sets, Tariffs, DID numbers, DID Charging Groups and Routing Groups may not be applied immediately. You need to wait at least for 1 min so that the system can update its internal "cache". Sometimes, in case of a heavy bulk update of, for example, multiple destination sets at once, it may be required more than 1 min. Read more...


Routes


Each Destination Set can have set of prefixes attached to it. All those prefixes are called Routes.

For example


if you have service agreement with carrier FooTel, who provides you with access to two his SIP-to-PSTN termination gateways: one in the Moscow, Russia and the second one in London, UK there will be Vendor in the system representing that carrier, two Connections associated with that vendor and two Destination Sets. One Destination Set will have Route with prefix 795 and the second with one with 44207 prefix. In addition, if those gateways can terminate calls to other destinations within the same area (mobile, nearby areas etc) there can be other prefixes in those two Destination Sets as well.

In addition, each Route has number of billing parameters matching the same parameters in Rates above and they are used to calculate cost of the outgoing call. 


Adding, Updating, and Deleting a Destination Set


On the Destination Sets page (shown below), you can add a new Destination Set, update an existing Destination Set, or delete an existing Destination Set.



To add a new Destination Set, under the Add Destination Set section, select Add New.



On the Add New Destination Set page, enter the desired values under the Basic Parameters and Advanced Parameters sections. Note that you must enter a Destination Set Name. When you are done, select Save & Close. The Destination Set you just added is now listed on the Destination Sets page.



To update an existing Destination Set, in the table of Destination Sets, select the name of the Destination Set you wish to edit (e.g. "Test Destination Set"), which appears as a link. Update the desired values. When you are done, select Save & Close. The Destination Set has now been updated, and you are returned to the Destination Sets page.


Update existing Destination Set Screenshot:



 To delete an existing Tariff, in the table of Destination Sets, locate the Destination Set you wish to delete. On the row associated with that Destination Set, select the image of a red cross under the Action column. The Destination Set has now been deleted, and you are returned to the Tariff page.


Delete Destination Set Screenshot:



Adding, Updating, and Deleting New Routes


To add one or more new Routes to a Destination Set, in the table of Destination Set, locate the Destination Set you wish to add one or more new Route(s) to. On the row associated with that Destination Set, select Open Routes under the Action column. On the Routes page (shown below) associated with the Destination Set, you can add Routes to the Destination Set either individually or by uploading a file containing the Routes and desired values you wish to add.



Method 1: Individually


When adding, updating, or deleting one or a small number of Rates, it is sometimes feasible to do so individually.

To add a new Route, under the Add Route section associated with the Destination Set, select Add.



Enter the desired values, noting that you must enter a Prefix, and that each Prefix can be associated with at most one Rate. For example, the Prefix "1604" refers to the geographic region British Columbia, Canada. When you are done, select Save & Close. The Route you just added is now listed on the Routes page associated with the Destination Set.


To update an existing Route, under the table of Routes, locate the Route you wish to update. On the row associated with that Route, select the Prefix under the Prefix column, which appears as a link. Update the desired values, noting as before that each Prefix can be associated with at most one Route. When you are done, select Save & Close. The Route has now been updated, and you are returned to the Routes page associated with the Destination Set.



To delete an existing Route, under the table of Routes, locate the Route you wish to delete. On the row associated with that Route, select the image of a red cross under the Action column. The Route has now been deleted, and you are returned to the Routes page associated with the Destination Set.




Method 2: Uploading a Bulk Destination Set File


As an alternative to adding, updating, or deleting Routes individually, it may be more convenient to do so by uploading a file containing Routes, especially when adding, updating, or deleting a large number of Routes at the same time. The two main file types you can use to upload the Rates and desired values are (a) Microsoft Excel [.xls] files and (2) Comma-separated value [.csv] files.




To begin, go to the Routes page associated with the Destination Set. Under the Download Routes section, select Download to download the .xls file, which is named, e.g., "[Tariff Name] Rates.xls".



Once downloaded, open the file using a spreadsheet application, e.g., Microsoft Excel or OpenOffice Calc. The spreadsheet displays the Routes associated with the Destination Set (shown below): each Route is displayed on a row and associated with a unique ID automatically generated by the system. By modifying, saving, and uploading this spreadsheet, you can add, update, and delete a large number of Routes all at once.



Action [A|D|U|S|SA] 


Entering "A" adds a new Route for a given Prefix, entering "D" deletes an existing Route, entering "U" updates an existing Route according to the associated Id, entering "S" updates an existing Route according to the associated Prefix, and entering "SA" functions as either "A" or "S", depending on whether the Prefix entered is already associated with an Id. See below for details.


Id 


The unique Route Id is automatically generated by the system. You need not enter a value, but if you do, the system will ignore it.


Prefix 


The Prefix is associated with phone numbers. You must enter a Prefix, and this value cannot already be associated with another Rate.


Country 


The country is automatically generated by the system according to the associated Prefix. You need not enter a value, but if you do, the system will ignore it.


Preference 


This must be a non-negative integer corresponding to Preference under the Basic Parameters section when adding or updating a Route individually (see above). The field is used by the "Routing Preference" policy type in routing groups. It is useful for fine tuning your routing for specific prefixes.


Interval 1 


This must be a non-negative integer corresponding to Interval 1, sec under the Billing Parameters section when adding or updating a Route individually (see above).


Interval N 


This must be a non-negative integer corresponding to Interval N, sec under the Billing Parameters section when adding or updating a Route individually (see above).


Price 1 


This must be a non-negative integer corresponding to Price 1, USD/min under the Billing Parameters section when adding or updating a Route individually (see above).


Price N 


This must be a non-negative integer corresponding to Price N, USD/min under the Billing Parameters section when adding or updating a Route individually (see above).


1xx Timeout 


This must be a non-negative integer corresponding to 1xx Timeout, sec under the Basic Parameters section when adding or updating a Route individually (see above).


2xx Timeout 


This must be a non-negative integer corresponding to 2xx Timeout, sec under the Basic Parameters section when adding or updating a Route individually (see above).


Huntstop 


This must be either "0" or "1", corresponding to the Huntstop checkbox under the Basic Parameters section when adding or updating a Route individually. Parameter if set instructs the Softswitch to stop hunting routes when Connection associated with such Route has been reached in the process. The failure code will be returned to the caller if attempt to send the call into such Connection fails.


Forbidden


This must be either "0" or "1", corresponding to the Forbidden checkbox under the Billing Parameters section when adding or updating a Route individually (see above). A "0" indicates that the geographic region associated with the Prefix is not forbidden, i.e., permitted. A "1" indicates that the associated geographic region is forbidden. 


To add, update, or delete one or more Routes, you will need to enter values under the Action [A|D|U|S|SA] ("Action") column associated with the row of the Route you wish to add, update, or delete. 


Activation Date and Expiration Date


The Activation and Expiration Dates determine when a particular route and rate is used for specific timeframe. These values must be expressed as Activation Date "now" and Expiration Date "never", or specified date and time. Date value to be expressed as "DD-MM-YYYY" and 24hr time format expressed as "HH:MM:SS". For Example "09-10-2013 21:30:00". The system will not recognize an activation date in the past, and will also disregard Expiration dates set in the past.


To add a new Route for a given Prefix, insert a new row below the existing rows. On this new row, enter A under the Action column. You must enter values under each of the columns, except possibly the Id and Country columns, since the Id is automatically generated for the Route by the system and the Country is automatically generated in accordance with the Prefix. In this case, you must ensure that the Prefix you enter is not already associated with a Route in the system. Otherwise, the system will generate an error message.


To update an existing Route by Id, enter U under the Action column of the Route you wish to update. Update the desired values corresponding to that Route, being careful not to edit the Id (because the system identifies a Route by its Id, and editing that Id means that the system cannot identify the Route you wish to update).


To update an existing Route by Prefix, insert a new row below the existing rows. On this new row, enter S under the Action column and the Prefix you wish to update. Note that in this case, the system identifies a Route by its (unique) Prefix, rather than by its Id. This method of updating a Route, by identifying it by its Prefix rather than by its Id, is useful when you have a long list (e.g., hundreds or thousands) of Routes, since you can update Route values corresponding to the Prefix without knowing its Id.


To add a new Rate for a given Prefix or update the existing Route associated with the Prefix, insert a new row below the existing rows. On this new row, enter SA under the Action column. You must enter values under each of the columns, except possibly the Id and Country columns, since the Id is automatically generated for the Route by the system and the Country is automatically generated in accordance with the Prefix. In this case, you need not ensure that the Prefix you enter is not already associated with a Route in the system. If the Prefix is not already associated with a Route, the system adds the new Route, functioning in the same way as add a new Rate for a given Prefix (A). If the Prefix is already associated with a Route, the system updates that Rate with the new values you enter, functioning in the same way as update an existing Rate by Prefix (S).


To delete an existing Route, enter D under the Action column.



When you are done adding, updating, or deleting Rates in your spreadsheet application, save the file. On the Routes page associated with the Destination Set, under the Upload Rates section, select Choose File. Select the saved Routes file, and then select Upload.

If your modifications have been successfully made, a dialog box appears indicating the number of rows processed, commands recognized, and records added, updated, and deleted. In this case, select OK.



If your modifications have not been successfully made, the system prompts you to open or download (depending on your internet browser's specifications) a .xls file detailing the errors found in the Error Message column associated with a Route. In this case, correct the errors found in the saved Routes file and upload the corrected file.