Caller Location
N2FE Flow Operation - Caller Location
The CallerLocation
selects an exit according to best-matching of the Calling Party’s
network address against a system-defined set of geographic regions. This operation is similar to
the CallingParty
operation, but with two key differences:
- In the case of a ported number, this operation uses the “network address”.
- The geographic regions are externally-defined, separate from the operation.
The “network address” is the caller’s address for routing purposes in the network. This is the address which most closely correlates with geographic location. In many cases, the caller’s “network address” is the same as their “logical address” (directory number), although in some networks with number porting logic present, these addresses may differ.
The CallerLocation
operation must have at least one exit. The CallerLocation
operation is only
useful when it has more than one exit, although this is not enforced by the operation definition.
Config Parameters
The CallerLocation
operation config
attributes are as follows.
Parameter | Type | Description |
---|---|---|
geography_set
|
String |
[Required, NCC Only] The geography_set specifies the name of a (public or private) geography set
defined on the NCC platform. This set must contain all of the geographic entries configured
within the associated list of operation rules .
|
geography_set_id
|
String |
[Required, N2 SCP Only] The geography_set_id specifies the ID of a (public or private) N2 TF SCP
geography to which the entry_id or prefix_id of all routed geography rules must belong.
|
source_buffer
|
User/System Buffer |
This must be the Name of a User or System Buffer from which the Caller Location will be sourced
for matching. See the notes on Buffer Names in the Flow Introduction
documentation. The GUI will almost certainly restrict the possible values of this buffer to relevant
values such as system.network_calling_party or user.postcode .(Default = system.network_calling_party )
|
rules
|
Array of Object |
[Required] The rules Array must contain none or more Objects.
|
Config Rules
A CallerLocation
operation rules
Object is as follows.
Parameter | Type | Description |
---|---|---|
geographic_entry
|
String |
[NCC Only] Specifies the name of the system-configured named geographic entry (which is typically associated with
multiple best-match prefixes) which this rule matches. This named geographic entry must exist within the NCC geography
set indicated by the geography_set parameter in the config Object.
|
entry_id
|
String |
[N2 SCP Only] Specifies the ID of a system-configured named geographic entry (which is typically associated with
multiple best-match prefixes) which this rule matches. This geographic entry must exist within the N2 TF SCP geography
set indicated by the geography_set_id parameter in the config Object.
|
prefix_id
|
String |
[N2 SCP Only] Specifies the ID of a system-configured named geographic entry prefix which this rule matches.
This geographic entry prefix must exist within the N2 TF SCP geography set indicated by the geography_set_id
parameter in the config Object.
|
exit_idx
|
Integer | The zero-based index number down which to route calls from callers with address matching a prefix within this geographic entry. |
N2 Configuration Comments
Note that for N2 TF SCP installations, each rule must specify exactly one of entry_id
or prefix_id
.
Note that if one or more geographic rules match the calling party, then the entry or prefix associated with the longest (best match) prefix will be used.
If no prefix matches for any of the listed geographic entries, then the first exit (index zero) will be followed for Default processing.
NCC Configuration Comments
Note that if one or more geographic rules match the calling party, then the entry associated with the longest (best match) prefix will be used.
If no prefix matches for any of the listed geographic entries, then the first exit (index zero) will be followed for Default processing.
Example Operation
Here is an example CallerLocation
operation in JSON representation.
{
"id": 5,
"type": "CallerLocation",
"base_node": 1,
"config": {
"geography_set": "National Calling Areas",
"rules": [
{ "geography_entry": "LCA Otautau 160", "exit_idx": 1 },
{ "geography_entry": "Hyde 353", "exit_idx": 1 },
{ "geography_entry": "LCA Greymouth 126", "exit_idx": 1 }
]
},
"exits": [ 4, 17 ]
}
In this example, calls from a calling party with any of the prefixes configured against either of
the geographic entries LCA Otautau 160
, Hyde 353
or LCA Greymouth 126
will proceed
down exit 1
to operation ID 17
, while all other calls will down exit index 0
to operation ID 4
.
Exits
The first exit is always the “Default” exit.
Exit Index | Name | Description |
---|---|---|
0
|
Exit #1 (Default) |
[Required]
All CallerLocation operations must have at least one exit.
|
1
|
Exit #2 + |
Additional exits may be present.
|