Each Routing Action object is a child of a Routing Table object.
Each object contains information about a particular routing action in a routing table and how it is selected.
![]() |
Note that when the parent Config Set is active, this object cannot be modified; all fields are read only and all actions are disabled. You must deactivate the parent Config Set before you can modify the object. |
![]() |
Where routing actions are based on the current time, this uses the local time of the Call Agent or Integrated Softswitch. |
Parameter |
Access |
Description |
Description | Change | A text string used in the EMS System Explorer to identify this Routing Action. Specify a string of up to 32 characters. |
Incoming release cause match | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Incoming release cause.
Specifies how to match on the incoming release cause. Values:
|
Incoming release cause | Change | This field appears only if Incoming release cause match is visible and set to ISUP/ISDN release cause. Specifies the value of the incoming release cause that matches this entry. The valid values for this attribute are a subset of those defined in Q.850; the other values defined in Q.850 identify release causes for which re-routing is not appropriate, or are not appropriate to ISUP trunks. See Incoming Release Causes below for a full list of values. |
Address type | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Destination address, Source address or Transit address.
Type of address used to match this action. Values:
|
Address scope | Change | This field appears only if the Address type field is visible and set to E.164.
Scope of address used to match this action. Values:
|
Wildcard address type | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Destination address, Source address or Transit address.
Type of wildcard address used to match this action. Values:
|
Wildcard address | Change | This field appears only if the Wildcard address type is visible and set to Explicit wildcard or Part wildcard header. Wildcard address used to match this action. |
Wildcard address effective prefix length | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Destination address, Source address or Transit address and the Address type is not set to Not present and the Wildcard address type is Part wildcard header. Length, in bytes, of the wildcard address effective prefix used to match this action. The effective prefix length is used to determine the precedence of alternative wildcard address matches. If the effective prefix length is the same as the actual length of the wildcard address, set this field to zero. The default is zero. |
Subscriber NV and routing attributes | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Subscriber NV and routing attributes.
Subscriber routing attributes used to match this action. If required, select one or more of the following values:
|
Incoming Media type | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Incoming Media type.
Type of exchange used to match this action. Values:
|
Incoming Media - Remote Signaling Stack | Change | This field appears only if the Incoming Media type is visible and set to Remote (specified signaling stack).
Signaling stack type used to match this action. Values:
|
Incoming Media - ISUP Local Signaling Destination | Change | This field appears only if Incoming Media - Remote Signaling Stack is visible and set to ISUP. ISUP Local Signaling Destination used to match this action. Select from the displayed list of ISUP Local Signaling Destinations that are associated with a valid Signaling Gateway. |
Incoming Media - Remote Exchange | Change | This field appears only if Incoming Media type is visible and set to Remote (specified exchange). Remote exchange used to match this action. Click on the ellipsis symbol to the right of this field to choose ISUP or SIP, then follow the dialogs to select the appropriate exchange. |
Incoming Media - Remote Media Channel | Change | This field appears only if the Incoming Media type is visible and set to Remote (specified media channel). Remote media channel used to match this action. Click on the ellipsis symbol to the right of this field to choose ISUP or SIP, then follow the dialogs to select the appropriate channel or trunk from the list. Media channels that support only outgoing calls cannot be used to match this action and do not appear in the list. |
Routing precedence | Change | This field and the following fields (Valid from, Valid until, Route from, and Route until) are visible only if the Routing table type field of the parent Routing Table is set to Current time. Each Routing Action in the table defines a specific period of time within the week for which it applies, together wth a start and end date for its validity. The routing precedence is used to resolve conflicts when there are two or more Routing Actions that apply at the same time; the action with the higher routing precedence is used. Specify a numeric value, which should not match the routing precedence of any other action in the table that can apply at the same time as this one (as defined by the following fields). |
Valid from (year) | Change | The year in which this routing action first becomes valid. Specify a four-digit value. |
Valid from (month) | Change | The month in which this routing action first becomes valid. Specify this as a numeric value (1 for January, 12 for December). |
Valid from (date) | Change | The date within the month on which this routing action first becomes valid. |
Valid until (year) | Change | The year in which this routing action ceases to be valid. Specify a four-digit value. |
Valid until (month) | Change | The month in which this routing action ceases to be valid. Specify this as a numeric value (1 for January, 12 for December). |
Valid until (date) | Change | The date within the month on which this routing action ceases to be valid. |
Route from (day) | Change | The first day of the week on which this routing action applies. Values: Monday - Sunday. |
Route from (hour) | Change | The hour on the specified day in which this routing action starts to apply. Range: 0 - 23. |
Route from (minute) | Change | The minute past the specified hour at which this routing action starts to apply. Range: 0 - 59. |
Route until (day) | Change | The last day of the week on which this routing action applies. Values: Monday - Sunday. |
Route until (hour) | Change | The hour on the specified day in which this routing action ceases to apply. Range: 0 - 23. |
Route until (minute) | Change | The minute past the specified hour at which this routing action ceases to apply. Range: 0 - 59. |
Action probability | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Weighted random or Sticky random. Probability, expressed as a percentage, of selecting this Routing Action. Range: 0 - 100. The action probabilities for all Routing Actions within the parent Routing Table must be chosen so that the total is 100%. |
Bearer capability match | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Bearer capability.
Specifies how to match on the bearer capability that is being used by the call. Values:
|
Bearer capability | Change | This field appears only if Bearer capability match is visible and set to Exact.
Specifies the values of the bearer capability attribute that match this entry. If the call's bearer capability matches any of the values selected here, this entry counts as a match. Select one or more of the following values:
|
Action | Change | Type of routing action to be performed if this action is chosen. Values:
|
Media channel | Change | This field appears only if Action is set to Routing complete. The Media Channel to be used for routing if this action is chosen. Click on the ellipsis symbol to the right of this field to choose whether to select from a list of ISUP Media Channels or SIP Trunks, then select the appropriate channel or trunk from the list. Media channels that support only incoming calls cannot be used for routing and do not appear in the list. |
Next table | Change | This field appears only if Action is set to Table lookup. Next table to use in continued routing. Select from the displayed list of Routing Tables (which are all children of this Routing Action's grandparent Config Set). As a short-cut to select the Routing Table, you can type match details into the field and click on the search button to select from a list of items that match these details. Match details can be a text string, a wildcard string such as B*, a range such as CA-FL, an index value such as =3, or an index range such as =1-20. For more details, refer to the description of the Details panel in Operations Manual: Overview. |
Temporary Alternate Routing indicator | Change | This field appears only if Action is set to Routing complete.
Specifies whether this route is a temporary alternate route. This value is signalled over ISUP so that the call will not be routed on subsequent Temporary Alternate Routes. This mechanism is used to avoid calls taking unreasonable routes and to avoid possible routing loops in the network. Values:
|
Call gapping interval | Change | This field appears only if the Routing table type field of the parent Routing Table is set to Call gapping. Time, in milliseconds, for which this action becomes unavailable each time it is chosen when the Routing table type field of the parent Routing Table is set to Call gapping. Range : 0 - 86400000 |
Attribute value - operator call match | Change | This field appears only if one of the Match attribute fields of the parent Routing Table is set to Operator call.
Specifies how to match on the operator call attribute. Values:
|
Attribute value - operator call | Change | This field appears only if Attribute value - operator call match is visible and set to Exact.
Specifies the value of the operator call attribute (whether or not the call should be treated as an operator call) that matches this entry. Values:
|
Attribute value - Subscriber Group match | Change | This field appears only if one of the Match attribute fields of the parent Routing Table is set to Subscriber Group.
Specifies how to match on the subscriber group attribute. Values:
|
Attribute value - Subscriber Group | Change | This field appears only if Attribute value - Subscriber Group match is visible and set to Exact. Specifies the value of the Subscriber Group attribute that matches this entry.
|
Attribute value - US Call Type match | Change | This field is valid only in the US. |
Attribute value - US Call Type | Change | This field is valid only in the US. |
Attribute value - UK Call Type match | Change | This field appears only if one of the Match attribute fields of the parent Routing Table is set to UK Call Type.
Specifies how to match on the UK Call Type attribute. Values:
|
Attribute value - UK Call Type | Change | This field appears only if Attribute value - UK Call Type match is visible and set to Exact.
Specifies the value of the UK Call Type attribute that matches this entry. Values:
|
Attribute value - CIP match | Change | This field is valid only in the US. |
Attribute value - CIP | Change | This field is valid only in the US. |
Attribute value - ANI II digits match | Change | This field is valid only in the US. |
Attribute value - ANI II digits | Change | This field is valid only in the US. |
Attribute value - Dialed Prefix match | Change | This field is valid only in the US. |
Attribute value - Dialed Prefix | Change | This field is valid only in the US. |
Attribute value - Dialing Pattern match | Change | This field is valid only in the US. |
Attribute value - Dialing Pattern | Change | This field is valid only in the US. |
Attribute value - User Defined 1 - 20 match | Change | This field appears only if one of the Match attribute fields of the parent Routing Table is set to one of the values User Defined 1 - User Defined 20. If you have selected two or more User Defined Attributes as match attributes, this field appears once for each selected attribute.
Indicates how to match on a User Defined Attribute. Select one of the following values.
|
Attribute value - User Defined 1 - 20 | Change | This field appears only if Attribute value - User Defined 1 - 20 match is set to Exact. If you have selected two or more User Defined Attributes as match attributes, this field appears once for each selected attribute. Specifies the value of the User Defined Attribute that matches this entry. Specify an integer value in the range 0 - 2147483646. |
Attribute value - Line Class Code 1 - 20 match | Change | This field appears only if one of the Match attribute fields of the parent Routing Table is set to one of the values Line Class Code 1 - Line Class Code 20. If you have selected two or more Line Class Codes as match attributes, this field appears once for each selected Line Class Code.
Indicates how to match on a Line Class Code value defined for the subscriber associated with the Routing request. Select one of the following values.
|
Attribute value - Line Class Code 1 - 20 | Change | This field appears only if Attribute value - Line Class Code 1 - 20 match is set to Exact. If you have selected two or more Line Class Codes as match attributes, this field appears once for each selected Line Class Code. Indicates the Line Class Code associated with the Routing request. Specify the Line Class Code as an integer value in the range 0 - 2147483646. The default is 0. Alternatively, for a validated Line Class Code, you can select a specific value from the list of valid values by clicking on the ellipsis symbol at the end of the field. Either scroll down the alphabetic list of code value descriptions to select the value you want, or type the first few letters of the code's description so that the alphabetic list scrolls to select the entry you want. |
Attribute value - originating Signaling Gateway match | Change | This field appears only if one of the Match attribute fields of the parent Routing Table is set to Originating Signaling Gateway.
Indicates how to match on the Originating Signaling Gateway attribute. Select one of the following values.
|
Attribute value - originating Signaling Gateway | Change | This field appears only if Attribute value - originating Signaling Gateway match is set to Exact. Indicates the Originating Signaling Gateway associated with the Routing request. This identifies the MetaSwitch Signaling Gateway at which the call originated (in the case where the MetaSwitch NE includes two or more Signaling Gateways to support different point codes).
|
Attribute value - ESA Status match | Change | This field is valid only in the US. |
Attribute value - controlling ESA Protection Domain | Change | This field is valid only in the US. |
Number action - called number action | Change | This field appears only if the Action field is set to Routing complete or Table lookup. A character string specifying the editing actions to be applied to the dialed number at the end of routing if this row is matched. The syntax of this string is described in Number Actions below. Specify a string of up to 32 characters. |
Number action - calling party number action | Change | This field appears only if the Action field is set to Routing complete or Table lookup. A character string specifying the editing actions to be applied to the calling party number at the end of routing if this row is matched. The syntax of this string is described in Number Actions below. Specify a string of up to 32 characters. |
Optional attributes to set | Change | Select which attributes are added to the routing request. The attributes selected in this field will affect the following fields. Select any combination of the following values:
|
AAR allowed | Change | This field appears only if this attribute is selected in the Optional Attributes to set field. If this field is visible, it is mandatory. Attribute used internally to specify whether Automatic Alternative Routing is allowed if this action is chosen. If this field is set to True, the Routing Policy Services user may retry routing if media channel allocation fails. Values:
|
ARR allowed | Change | This field appears only if this attribute is selected in the Optional Attributes to set field. If this field is visible, it is mandatory. Attribute specifying whether Automatic Re-Routing is allowed if this action is chosen. If this field is set to True, the Routing Policy Services User may retry routing if signaling fails due to congestion at a subsequent exchange. Values:
|
Routing control | Change | This field appears only if this attribute is selected in the Optional Attributes to set field. If this field is visible, it is mandatory. Attribute indicating the UK Routing Control value to be included in the routing request if this action is chosen. Values:
|
Circuit code | Change | This field is not valid in the UK. |
MF tandem routing code | Change | This field is not valid in the UK. |
MF international non-operator routing code | Change | This field is not valid in the UK. |
MF international operator routing code | Change | This field is not valid in the UK. |
Max channel usage | Change | This field appears only if this attribute is selected in the Optional Attributes to set field. If this field is visible, it is mandatory. Maximum channel usage (as a percentage of the channel's total capacity) to be used in admission control, if this action is chosen. A media channel whose usage is higher than the maximum channel usage will be rejected by admission control. Range: 0 - 100. The default is 100 (indicating that the channel will be rejected only when it has no free capacity). |
Congestion level 1 acceptance probability | Change | This field appears only if this attribute is selected in the Optional Attributes to set field. If this field is visible, it is mandatory. Attribute that is added to the routing request after the media channel is selected and used internally. It specifies the probability, expressed as a percentage, of accepting a signaling link congested at congestion level 1. Range: 0 - 100. The default is 100 (indicating that the link is always used even if it is congested). |
Congestion level 2 acceptance probability | Change | This field appears only if this attribute is selected in the Optional Attributes to set field. If this field is visible, it is mandatory. Attribute that is added to the routing request after the media channel is selected and used internally. It specifies the probability, expressed as a percentage, of accepting a signaling link congested at congestion level 2. Range: 0 - 100. The default is 100 (indicating that the link is always used even if it is congested). |
Maximum call duration | Change | This field appears only if this attribute is selected in the Optional Attributes to set field. If this field is visible, it is mandatory. Attribute that is added to the routing request after the media channel is selected. It specifies the maximum permitted duration for a call. The call will be terminated if it continues for longer than the specified time; the duration is measured from the end of Routing processing in which the attribute is set. Specify the duration in minutes, in the range 1 - 1440 (1 minute - 24 hours), or specify zero to indicate no limit. |
Outgoing ISUP/ISDN release cause | Change | This field appears only if this attribute is selected in the Optional Attributes to set field. If this field is visible, it is mandatory. Attribute that is added to the routing request after the media channel is selected. It indicates whether a specific release cause is to be reported to the originating switch if this call could not be routed on this switch, or if it was routed to another switch and was rejected there. The release cause will be reported only if the call was received over an ISUP trunk. Note that setting a release cause does not in itself cause the call to be rejected. The valid values for this attribute are a subset of those defined in Q.850; the other values defined in Q.850 are not supported, generally because they do not apply to ISUP trunks. See Outgoing Release Causes below for a full list of values and some restrictions on their use. Alternatively, you can specify Auto (the default) to indicate that the NE should use the release cause that it determined, or the release cause signaled by the terminating switch if the call was routed to another switch and was rejected there. |
Alarm state | Read only | Specifies whether any alarms are currently raised for this object. Values:
|
Alarm log correlator - Attend To Dependent | Read only | Identifier of the log message for the event that caused the last Attend To Dependent alarm state for this object. This field is reset when the Attend To Dependent alarm events field is reset to zero. |
Attend To Dependent alarm events | Read only / Reset | Number of times (since the alarm count was reset) that this object's alarm state has gone to Attend To Dependent. |
Alarm state changed timestamp | Read only | The time at which the Alarm state last changed. |
Alarm events reset timestamp | Read only | The time at which the Attention Required alarm events was last reset to zero. |
Requested status | Read only | Specifies whether an administrator has attempted to enable the Routing Action. Values:
|
Actual status | Read only | Specifies the current status of the Routing Action. Values:
|
Number Actions
The Number action - called number action and Number action - calling party number action parameters in the Routing Action object provide a mechanism for editing the called number (or the calling party number). This action is always applied after routing is complete, so that a subsequent Routing Action matching on one of these numbers uses the original numbers and not the edited numbers. If two or more editing actions are encountered while routing a call, only the last one is used at the end of routing.
The parameter consists of a character string specifying one or more edit actions to be applied to the number. Valid edit actions are:
PAdigits | Add a prefix to the number. The characters PA are followed immediately by the digit(s) to be added as a prefix. |
PDcount | Delete a prefix from the number. The characters PD are followed immediately by the count of digits to be deleted from the start of the number. |
SDcount | Delete a suffix from the number. The characters SD are followed immediately by the count of digits to be deleted from the end of the number. |
Rdigits | Replace the complete number. The character R is followed immediately by the new digit string to replace the number. |
The action string can contain two or more actions, which are executed in the order specified, so that the second acts on the modified number resulting from the first. Note that the Replace action cannot follow any other action because this would destroy the effect of the earlier action.
Examples of changes to the called number:
Incoming Release Causes
When an outgoing call attempt sent over an ISUP trunk is rejected because it cannot be routed, the remote switch can specify a release cause as an attribute to be signaled to the originating switch, which may help that switch to determine how to re-route the call.
The MetaSwitch NE supports the release cause values listed below, which are defined in the Q.850 specification.
Value |
Description |
2 | No route to specified transit network (national use) |
3 | No route to destination |
34 | No circuit / channel available |
41 | Temporary failure |
42 | Switching equipment congestion |
43 | Access information discarded |
44 | Requested circuit / channel not available |
46 | Precedence call blocked |
47 | Resource unavailable, unspecified |
58 | Bearer capability not presently available |
62 | Inconsistency in outgoing information element |
63 | Service or option not available, unspecified |
65 | Bearer capability not implemented |
69 | Requested facility not implemented |
70 | Only restricted digital information bearer capability is available (national use) |
79 | Service option not implemented, unspecified |
88 | Incompatible destination |
95 | Invalid message, unspecified |
97 | Message type non-existent or not implemented |
99 | Information element / parameter non-existent or not implemented |
102 | Recovery on timer expiry |
103 | Parameter non-existent or not implemented - passed on (national use) |
111 | Protocol error, unspecified |
127 | Interworking, unspecified |
Outgoing Release Causes
When an incoming call attempt received over an ISUP trunk is to be rejected because it cannot be routed, you can specify a release cause as an attribute to be signaled to the originating switch, which may help that switch to determine how to re-route the call.
The MetaSwitch NE supports the release cause values listed below, which are defined in the Q.850 specification. However, you should note the following restrictions.
Value |
Description |
ISUP mapping |
Extra info? |
1 | Unallocated number | Unchanged | Yes |
2 | No route to specified transit network (national use) | Unchanged | Yes |
3 | No route to destination | Unchanged | Yes |
4 | Send special info tone | Unchanged | No |
5 | Misdialed trunk prefix | Unchanged | No |
6 | Channel unacceptable | 31 | No |
7 | Call awarded to established channel | 31 | No |
8 | Call pre-empted | Unchanged | No |
9 | Call pre-empted, circuit reserved | Unchanged | No |
16 | Normal call clearing | Unchanged | Yes |
17 | User busy | Unchanged | Yes |
18 | User not responding | Unchanged | No |
19 | User not answering | Unchanged | No |
20 | Subscriber absent | Unchanged | No |
21 | Call rejected | Unchanged | Yes |
22 | Number changed | Unchanged | Yes |
27 | Destination out of order | Unchanged | No |
28 | Invalid number format | Unchanged | No |
29 | Facilities rejected | Unchanged | Yes |
30 | Response to status inquiry | 31 | No |
31 | Normal, unspecified | Unchanged | No |
34 | No circuit / channel available | Unchanged | No |
38 | Network out of order | Unchanged | No |
41 | Temporary failure | Unchanged | No |
42 | Switching equipment congestion | Unchanged | No |
43 | Access information discarded | Unchanged | Yes |
44 | Requested circuit / channel not available | Unchanged | No |
46 | Precedence call blocked | Unchanged | No |
47 | Resource unavailable, unspecified | Unchanged | No |
50 | Requested facility not subscribed | Unchanged | Yes |
53 | Outgoing calls barred within CUG | Unchanged | No |
55 | Incoming calls barred within CUG | Unchanged | No |
57 | Bearer capability not authorized | Unchanged | Yes |
58 | Bearer capability not presently available | Unchanged | Yes |
62 | Inconsistency in outgoing information element | Unchanged | No |
63 | Service or option not available, unspecified | Unchanged | No |
65 | Bearer capability not implemented | 79 | Yes |
66 | Channel type not implemented | 79 | Yes |
69 | Requested facility not implemented | Unchanged | Yes |
70 | Only restricted digital information bearer capability is available (national use) | Unchanged | No |
79 | Service option not implemented, unspecified | Unchanged | No |
87 | User is not a member of CUG | Unchanged | No |
88 | Incompatible destination | Unchanged | No |
90 | Non existent CUG | Unchanged | No |
91 | Invalid transit network selection (national use) | Unchanged | No |
95 | Invalid message, unspecified | Unchanged | No |
97 | Message type non-existent or not implemented | Unchanged | Yes |
98 | Message not compatible with call state | Unchanged | Yes |
99 | Information element / parameter non-existent or not implemented | 111 | No |
102 | Recovery on timer expiry | Unchanged | Yes |
103 | Parameter non-existent or not implemented - passed on (national use) | Unchanged | Yes |
110 | Unrecognized parameter discarded | Unchanged | Yes |
111 | Protocol error, unspecified | Unchanged | No |
127 | Interworking, unspecified | Unchanged | No |