TAG LINE
SMALL TITLE

GeoTree

Last Updated: Aug 04, 2020

The GeoTree is configured in Setup / Usage Rating / Rate Types / GeoTree

Overview

The GeoTree is a structured tree comprised of nodes which can represent locations (e.g. Everywhere/South America/Brazil) or another location specific entity such as a carrier/service area (e.g. Everywhere/North America/Canada/Zone 1). At each node patterns can be configured. When the GeoTree is used by the rating engine the usage record's destination value (terminating number, IP address, etc.) is matched against the patterns defined in the tree in order to map the usage to a location. When a pattern match occurs the rate that is applied is determined by checking the 'Location' value on the rates that exist in a rate plan. If a rate with a matching location cannot be found a usage exception will occur.

The GeoTree can be as granular as you require it to be and map to whatever scheme you require. For instance the tree could be organized by:

  • Patterns within a state/province

  • Zones or groups of locations

  • Top level rates (one price for the an entire country/region instead of having to define each individual pattern)

  • Regions or types of operators (allowing you to specify a different rate based on which operator's network the user is on)

Locations defined in the GeoTree can also be used to create location groups. Location groups are comprised of multiple GeoTree locations which rates can be applied to (for example a single location group could include multiple countries).

Prerequisites

No back-end configuration or custom code is required to create or modify the GeoTree. The data in the GeoTree can be imported as needed.

Note: The GeoTree will not be used for rating unless the usage class related to the usage being rated is setup to use the GeoTree (the class's 'Rater' field is set to 'GeoTree').

The GeoTree Panel

The GeoTree panel on the left of this screen allows you to expand and select nodes in the tree so that you can view or edit configuration details.

GeoTree List

The list on the left of the screen shows the nodes that are currently configured in the GeoTree. The list will display nodes that you have viewed in grey (emoji) while you are on the GeoTree screen. If you navigate away from the GeoTree screen what you have selected in the tree will be cleared.

When you select a node in the list patterns for the selected node will be shown in the Edit Pattern panel to the right. These settings are explained in more detail below.

The Edit Pattern Panel

The information in this panel reflects the currently selected node in the GeoTree list. From here you can view, add, edit or delete patterns and nodes in the tree.

Patterns tab

This tab will show any patterns currently configured on the node. When the rating engine processes usage it will compare the destination value of the mediated usage record against the patterns in the GeoTree (provided the tree is configured to be the rater for the class of usage in question). A matched pattern will result in the system looking for a rate configured for the location where the pattern resides (e.g. if the pattern found was under the 'Everywhere/France/Paris' node there needs to be a usage rate in the rate plan with a 'Location' value of 'Everywhere/France/Paris' in order to rate the usage). If the usage record destination value doesn't match any pattern in the GeoTree, a usage exception will occur.

Patterns added/edited here can by any alphanumeric value. For IP addresses slash notation is supported (e.g. 207.236.223.8/29). For more information on adding and editing patterns see the Guides section below.

Nodes tab

This tab displays the nodes that exist beneath the current node you are viewing. From here you can create, edit and delete sub-nodes beneath the currently selected node. See the guides section below for details on how to add/edit/delete nodes in the GeoTree.