Tmedia Routing - Revision history

Luc Morissette: Updated formatting

2020-04-14T21:02:39Z

Updated formatting

Luc Morissette: First draft of parameters description

2020-04-14T20:28:54Z

First draft of parameters description

Luc Morissette: Updated to link filters

2020-02-04T19:50:41Z

Updated to link filters

Abrassard: /* After remap (after_remap) */

2019-05-30T19:29:17Z

After remap (after_remap)

Abrassard: /* After filter (after_filter) */

2019-05-30T19:28:18Z

After filter (after_filter)

Abrassard: /* Filter Scripts examples: */

2019-03-28T18:49:03Z

Filter Scripts examples:

Abrassard: /* Filters */

2019-03-28T18:42:59Z

Filters

Abrassard: /* Route remap (route_remap) */

2019-03-28T18:37:21Z

Route remap (route_remap)

Abrassard: /* After remap (after_remap) */

2019-03-28T18:35:16Z

After remap (after_remap)

Abrassard: /* After filter (after_filter) */

2019-03-28T18:34:59Z

After filter (after_filter)

@@ Line 278: / Line 278: @@
 === Notes on parameters ===
-Parameters will be mapped to variables to be used in the script.
+Parameters will be mapped to variables to be used in the script.<br\>
-For example the "SIP:To - user-info" will be mapped to the "called" parameter.
+For example the '''SIP:To - user-info''' will be mapped to the '''called''' parameter.<br\>
-Parameters will only appear in the structures if they are present.
+Parameters will only appear in the structures if they are ''present''. For example a call without any SIP '''diversion''' header will not have the '''original_called_number''' parameter present.
-For example a call without any diversion header will not have the "original_called_number" parameter present.
-===='''call''' parameters include all the parameters here:====
+===='''call''' parameters====
 [[Routing_script_tutorial:Mini_Development_Guide#Script_parameters_protocol_mapping|Routing Scripts variables]]
-===='''routes''' parameters include:====
+===='''routes''' parameters====
 {| cellpadding="5" border="1" class="wikitable"
 |-
 ! width="250" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | Variable name
-! width="400" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | Description
+! width="500" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | Description
 |-
 | valign="top" |
@@ Line 300: / Line 301: @@
 routeset_name
 | valign="top" |
-Label name. Only used in label routing: [[Label_Routing]]
+Label name. Only used in label routing: see [[Label_Routing]]
 |-
 | valign="top" |
 nap
 | valign="top" |
-NAP where the incoming call was received
+NAP (Network Access Point) where the incoming call was received
 |-
 | valign="top" |
@@ Line 316: / Line 317: @@
 | valign="top" |
 calling number of the incoming call
 |-
 | valign="top" |
@@ Line 343: / Line 349: @@
 |}
-===='''naps''' parameters include:====
+===='''naps''' parameters ====
 {| cellpadding="5" border="1" class="wikitable"
 |-
 ! width="250" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | Variable name
-! width="400" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | Description
+! width="500" style="background: rgb(239, 239, 239) none repeat scroll 0% 0%; -moz-background-clip: border; -moz-background-origin: padding; -moz-background-inline-policy: continuous;" | Description
 |-
 | valign="top" |
 routeset_definition
 | valign="top" |
-pointer to routeset definition file if label routing is used: [[Label_Routing]]
+pointer to routeset definition file if label routing is used: see [[Label_Routing]]
 |-
 | valign="top" |
@@ Line 365: / Line 372: @@
 |}
-===='''out_calls''' parameters are the same as "call" parameters, but one set for each route.====
+===='''out_calls''' parameters====
 The list of parameters can be different for each route. This describes the call parameters for each one of them. <br\>
 out_call[0] maps the first set of parameters to be used for the first route. <br\>

@@ Line 276: / Line 276: @@
      return params
    end
 === Filter Scripts examples:  ===

@@ Line 278: / Line 278: @@
 === Filter Scripts examples:  ===
+See  [[How to Setup Filters|How to setup Filters]]<br>
-*'''priority_and_weight_load_balancer.rb:''' After filter that will reorder routes by priority and weight (load sharing per weight for routes with the same priority)
-*'''forward_sip_domain.rb:''' Route remap filter that will, per route, control forwarding of sip domain of various SIP headers (forward domains, else replace by local IP / proxy IP)
-*'''sip_header_params.rb:''' After remap filter that will add specified parameters to specified SIP headers
-*'''Black and White listing (black_white_listing.rb):''' With this script, any called or calling number prefix can be blacklisted or whitelisted. This script can be assigned globally, or per NAP. It reads a .csv file which has the called and calling number list. See [[Adding White or Black listing to Routing Script]]
-*'''lawful_intercept.rb:''' Script that will identify some calls to perform lawful interception on (by calling/called number matching from a .csv file)
-−
-Learn how to add a Filter to normal scripts: [[How to Setup Filters|How to setup Filters]]<br>
 == <br>Label routing<br>  ==
@@ Line 375: / Line 368: @@
 == Related actions ==
 '''Refer to the appropriate Toolpack release:'''
+*[[Toolpack:Tsbc_Call_Routes_Settings_3.1|Call Routes Settings v3.1]]
 *[[Toolpack:Call_Routes_Settings_D|Call Routes Settings v3.0]]
 *[[Toolpack:Call_Routes_Settings_C|Call Routes Settings v2.10]]
 *[[Toolpack:Call_Routes_Settings_B|Call Routes Settings v2.9]]
 *[[Toolpack:Call_Routes_Settings_A|Call Routes Settings v2.8]]
 *[[Web_Portal_Tutorial_Guide_v2.7#Routes|Web Portal v2.7: Routes Configuration]]
 *[[Web_Portal_Tutorial_Guide_v2.6#Routes|Web Portal v2.6: Routes Configuration]]
 </div>

@@ Line 265: / Line 265: @@
    # Called once per incoming call
    def my_custom_after_remap_filter( params )
-     #  - params[ :out_calls] Array of all outgoing call to be created (corresponding to each matching route).
+    #  - params[ :call]      Hash of call attributes of the incoming call.
      #                        Can be modified to customize each outgoing call attempt.
      #  - params[ :routes ]   Array of all routes in your configuration with all their attributes.

@@ Line 213: / Line 213: @@
    # Called once per incoming call
    def my_custom_after_filter( params )
-     # See init_my_custom_after_filter above for details about params
+     # See my_custom_before_filter above for details about params
      return params

@@ Line 110: / Line 110: @@
 Other standard routing scripts implement Filters and are covered in the next section.
-== <br>Filters<br>  ==
+== Filters  ==
 <pre>Gateway -&gt; Routing scripts </pre>
 Adds functionality to standard scripts. Filters can be added to any standard script in a few steps. For example, you may want to remove the '1' prefix for uniformed routing, select the SIP Request URI to route the call instead of the called number, and more.

@@ Line 219: / Line 219: @@
 ==== Route remap (route_remap) ====
-Called once per matching route. Perform per-route remapping of some call attributes, based on per-route attributes.
+* Called once per matching route.
 ==== After remap (after_remap) ====

@@ Line 245: / Line 245: @@
      #  - params[ :naps ]     Array of all NAPs in the configuration and their attributes
      #                        Cannot be modified.
    end