Table Lookup
N2FE Flow Operation - Table Lookup
The TableLookup
maps a specified prefix or CLI to a geographical routing code, such as a postal code or an exchange code, by looking up the code in a selected table lookup dataset.
The TableLookup
stores the resulting code in a profile field. The exit taken from the TableLookup
depends on whether or not a match is found for the prefix or CLI.
A table lookup dataset contains a group of related codes, for example, for a specific geographic area or suburb.
A table lookup dataset can be public or private. A private table lookup dataset belongs to a specific customer. It is only available to that customer and the parent customers linked to that customer in the customer hierarchy. A public table lookup dataset is available to all customers.
Config Parameters
The TableLookup
operation config
attributes are as follows.
Parameter | Type | Description |
---|---|---|
source_profile_block |
String | [Required] The source_profile_block selects the block from which to parse from within the lookup dataset. |
source_tag_code |
String | [Required] The source_tag_code selects the tag from which to parse from within the lookup dataset. |
target_profile_block |
String | [Required] The target_profile_block indicates the profile block to store the result of the lookup dataset. |
target_tag_code |
String | [Required] The target_tag_code indicates the profile tag in which to store the result of the lookup dataset. |
lookup_dataset |
String | [Required] The lookup_dataset` the mapping of profile blocks and tags within a lookup dataset to compare and retreive values from. |
Example Operation
Here is an example TableLookup
operation in JSON representation.
{
"type": "TableLookup",
"config": {
"source_tag_code": "327688",
"lookup_dataset": "Suburb Lookup",
"target_profile_block": "3",
"target_tag_code": "4",
"source_profile_block": "18"
},
"base_node": "4",
"exits": [
1,
2,
3
],
"id": "4"
}
In this example, source tag 327688
within the block 18
from the lookup dataset Suburb Lookup
will be stored within the target tag 4
within the block 3
.
If a match is found exit 1
will be used while all non matches will be directed down exit 2
. If an error occurs the call will be directed down exit 3
Exits
Exit Index | Name | Description |
---|---|---|
0 |
Match | [Required] A prefix has been mapped to a code. |
1 |
No Match | [Required] No matching prefix was found in the dataset. |
2 |
Error | [Required] An internal error has occurred. |