Routing script tutorial - Revision history

Abrassard: /* 'route_remap' method */

2018-05-09T15:42:00Z

'route_remap' method

Abrassard: /* 'route_match' method */

2018-05-09T15:41:16Z

'route_match' method

Abrassard: /* 'route_match' method */

2018-05-09T15:39:24Z

'route_match' method

Luc Morissette: /* Useful links */

2014-01-31T14:27:12Z

Useful links

Luc Morissette: Added link to Tmedia routing

2014-01-31T14:26:02Z

Added link to Tmedia routing

Luc Morissette: /* Examples and tutorials */

2014-01-29T16:21:16Z

Examples and tutorials

Abrassard at 13:01, 17 November 2010

2010-11-17T13:01:31Z

Ktrueman: /* 'route_match' method */ capitalized ASR

2010-08-20T14:17:13Z

'route_match' method: capitalized ASR

Ktrueman: /* 'route_order' method */ corrected definition of ASR and added link

2010-08-20T14:16:39Z

'route_order' method: corrected definition of ASR and added link

Lucas Trottier at 19:01, 24 March 2010

2010-03-24T19:01:34Z

Show changes

@@ Line 85: / Line 85: @@
 'route_remap' allows to remap the parameter of the route or the call using one of the 4 possible arguments. There are actually 3 types of remapping that can be performed: via the&nbsp;:call_field_name/:route_field_name arguments; the&nbsp;:proc argument; and/or the&nbsp;:method argument.
-#&nbsp;:call_field_name - The field name of the call to remap
+====:call_field_name====
-#&nbsp;:route_field_name - The field name of the route to remap with. The default is to use the call field name. If the value of the field is empty, the incoming call's attribute is used. The value of the route field can be a regular expression remap. (e.g., /(555000.)/001\1/ )
-#&nbsp;:proc - A user supplied proc to call instead of trying to do the remap internally. It should accept four arguments (route, call object, nap list, call params) and return a hash of remapped fields
-#&nbsp;:method - A user supplied method to call instead of trying to do the match internally. It should accept four arguments (route, call object, nap list, call params) and return a hash of remapped fields
-<br>
+ The field name of the call to remap
 === 'init_routes' method  ===

@@ Line 48: / Line 48: @@
 'route_match' allows to match a call to one route using one of 4 possible arguments. It is possible to call 'route_match' multiple times to reduce the number of matching routes. Since 'route_match' will return the first matching route it find, there is a possibility that there is more than one route match, therefore it is important to order the routes or prioritize them using 'route_order'.
 ====:call_field_name====
@@ Line 60: / Line 55: @@
 * A route that has a specific value will only match if the call has the same value
 * A route with a regular expression value will match if the regular expression from the route matches the value from the call
 * This function supports a special case when matching SIP :calling or :called attributes: The format 'number@sip_host:sip_ort' can be used for matching calling/called number, the domain, and the port.
-** For example 1234@abc.com:5060 will match only calls with number 1234, on SIP host 'abc.com' on port 5060.
+** For example: 1234@abc.com:5060 will match only calls with number 1234, on SIP host 'abc.com' on port 5060.
-** For example @abc.com will match any call on sip_host 'abc.com' on any port
+** For example: @abc.com will match any call on sip_host 'abc.com' on any port
 ====base_routing pre-implemented matching method====

@@ Line 54: / Line 54: @@
 #&nbsp;:method - A user-supplied method to call instead of trying to do the match internally. It should accept three arguments (route, call, nap list) and return a boolean to indicate the match
-base_routing pre-implemented matching method:
+====:call_field_name====
 *'match_nap_availability', this method will verify the availability through the nap status.

← Older revision		Revision as of 14:27, 31 January 2014
Line 118:		Line 118:

	== Useful links ==		== Useful links ==
−	[[Tmedia_Routing\|Tmedia Routing]]	+	*[[Tmedia_Routing\|Tmedia Routing]]

← Older revision		Revision as of 14:26, 31 January 2014
Line 116:		Line 116:

	Back to the [[Scriptable Routing Engine\|Scriptable Routing Engine]] page.		Back to the [[Scriptable Routing Engine\|Scriptable Routing Engine]] page.
		+
		+	== Useful links ==
		+	[[Tmedia_Routing\|Tmedia Routing]]

@@ Line 105: / Line 105: @@
 === Examples and tutorials  ===
-*[[Routing script tutorial:Routing Class Tutorial|script routing class tutorial]]
+*[[Routing script tutorial:Routing Class Tutorial|Routing Script class tutorial]]
 *[[Routing script tutorial:route order Tutorial|'route_order' tutorial]]
 *[[Routing script tutorial:route match Tutorial|'route_match' tutorial]]

@@ Line 90: / Line 90: @@
 == Route retry algorithm  ==
+Documentation on route retry algorithm can be found here:
-The route retry feature applies when more than one matching route is returned by the active routing script. The route retry algorithm works the following way:
+[[Route_retry]]
-−
-*An outgoing call will be made based on the first matching route
-*If that outgoing call fails while there are other matching routes left, another outgoing call attempt is made using next matching route
-−
-A call attempt is considered failed in the following conditions:
-−
-*Call is terminated with an error cause before it's answered
-*Timeout occurs before call reaches specified call state (this timeout is ignored when last matching route is attempted)
-−
-Route retry timeout can be customized using two parameters:
-−
-*Timeout delay in seconds before retry with next route (value of 0 makes timeout never occur)
-*Minimum call state to reach before the specified timeout occurs:
-**Call accepted
-**Call progress received
-**Call alerted
-**Call answered
-−
-If the timeout delay is passed before the call reaches the specified state, call is considered failed and retry occurs. If the call reaches that state, timeout no longer apply.
-−
-=== Route retry global configuration  ===
-−
-These route retry timeout parameters can be configured globally, per NAP, or per Route. Per-route value has precedence on per-NAP value, which has precedence on global value.
-−
-The global route retry timeout parameters are found in the Gateway application configuration page in the Toolpack Web Portal:
-−
-*Go to the '''Gateway-&gt;Configuration''' menu.
-*Click on the '''Edit''' link of the configuration you wish modify.
-*Expand the '''Advanced''' section
-*Change values of 'Route retry mode' and 'Route retry timeout'
-−
-=== Route retry per-NAP configuration  ===
-−
-The per-NAP route retry timeout parameters are configured by adding a custom 'NAP column':
-−
-*Go to the '''Gateway-&gt;Configuration''' menu.
-*Click on the '''Edit''' link of the configuration you wish modify.
-*Click on '''Create New Nap Column''' in the '''Editing Naps''' section
-−
- - In the '''Name''' text box, enter 'route_retry_mode'
- - In the '''Type attributes''' text box, enter '|accept|call_progress|alert|answer'
- - Leave the '''Default''' text box blank
-−
-*Click '''Save'''
-*Click again on '''Create New Nap Column''' in the '''Editing Naps''' section
-−
- - In the '''Name''' text box, enter 'route_retry_timeout'
- - In the '''Type attributes''' text box, enter 'integer'
- - Leave the '''Default''' text box blank
-−
-*Click '''Save'''
-−
-Now that these columns have been created, each time you create or edit a NAP, route retry mode and timeout will be shown under '''Custom Params'''. Leaving empty value for a NAP will make global value to be used. Assigning a value in either of these parameters will override the global value for that parameter.
-−
-=== Route retry per-route configuration  ===
-−
-The per-route route retry timeout parameters are configured by adding a custom 'Route column':
-−
-*Go to the '''Gateway-&gt;Configuration''' menu.
-*Click on the '''Edit''' link of the configuration you wish modify.
-*Click on '''Create New Route Column''' in the '''Editing Routes''' section
-−
- - In the '''Name''' text box, enter 'route_retry_mode'
- - In the '''Type attributes''' text box, enter '|accept|call_progress|alert|answer'
- - Leave the '''Default''' text box blank
-−
-*Click '''Save'''
-*Click again on '''Create New Route Column''' in the '''Editing Routes''' section
-−
- - In the '''Name''' text box, enter 'route_retry_timeout'
- - In the '''Type attributes''' text box, enter 'integer'
- - Leave the '''Default''' text box blank
-−
-*Click '''Save'''
-−
-Now that these columns have been created, each time you create or edit a route, route retry mode and timeout will be shown under '''Custom Params'''. Leaving empty value for a route will make NAP value used (or global value if NAP value is also empty). Assigning a value in either of these parameters will override the NAP or global value for that parameter.
-−
-=== Customize route retry parameters from routing script  ===
-−
-Any part of the routing script that has access to the route can modify these parameters by reading and writing from/to:
-−
- route[:route_retry_mode]
- route[:route_retry_timeout]
-−
-These fields initially contain value read from the added 'Custom Route Columns' (as explained above), but can be overwritten by the routing script.
 == What else?  ==

@@ Line 60: / Line 60: @@
    route_match&nbsp;:method =&gt;&nbsp;:match_nap_availability
-*'match_asr_threshhold', this method will verify will match any route who's destination NAP has a higher asr than the threshold stored for that nap. This method requires adding 2 custom '''NAP''' parameters called. The first custom parameter is 'asr_threshhold_type'. Its values can be: global, last_24h, current_hour, last_hour. The second custom parameter is 'asr_threshhold'. Its value needs to be an '''integer''' between 0 and 100.
+*'match_asr_threshhold', this method will verify will match any route who's destination NAP has a higher ASR than the threshold stored for that nap. This method requires adding 2 custom '''NAP''' parameters called. The first custom parameter is 'asr_threshhold_type'. Its values can be: global, last_24h, current_hour, last_hour. The second custom parameter is 'asr_threshhold'. Its value needs to be an '''integer''' between 0 and 100.
    route_match&nbsp;:method =&gt;&nbsp;:match_asr_threshhold
 <br>
 === 'route_remap' method  ===

@@ Line 39: / Line 39: @@
 base_routing pre-implemented ordering method:
-*'order_by_asr', this method will order the routes according to the asr(average success rate). This method requires adding a custom '''NAP''' parameter called ':asr_type'. Its value can be: global, last_24h, current_hour, last_hour. It can be used in your custom class like this:
+*'order_by_asr', this method will order the routes according to the [[ASR]] (answer seizure ratio). This method requires adding a custom '''NAP''' parameter called ':asr_type'. Its value can be: global, last_24h, current_hour, last_hour. It can be used in your custom class like this:
    route_order&nbsp;:method =&gt;&nbsp;:order_by_asr
 <br>
 === 'route_match' method  ===