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 64 characters. |
Address type | Change | Type of address used to match this action. This field is visible only if the Routing table type field of the parent Routing Table is set to Destination address, Source address or Transit address. Values:
|
Address scope | Change | Scope of address used to match this action. This field is visible only if the Address type field is visible and set to E.164. Values:
|
Wildcard address type | Change | Type of wildcard address used to match this action. This field is visible only if the Routing table type field of the parent Routing Table is set to Destination address, Source address or Transit address. Values:
|
Wildcard address | Change | Wildcard address used to match this action. This field is visible only if the Wildcard address type is visible and set to Explicit wildcard or Part wildcard header. |
Wildcard address effective prefix length | Change | Length, in bytes, of the wildcard address effective prefix used to match this action. This field is visible 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. 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 | Subscriber routing attributes used to match this action. This field is visible only if the Routing table type field of the parent Routing Table is set to Subscriber NV and routing attributes. If required, select one or more of the following values:
|
Incoming Media type | Change | Type of adjacent exchange used to match this action. This field is visible only if the Routing table type field of the parent Routing Table is set to Incoming Media type. Values:
|
Incoming Media - Remote Signaling Stack | Change | Signaling stack type used to match this action. This field is visible only if the Incoming Media type is visible and set to Remote (specified signaling stack). Values:
|
Incoming Media - ISUP Local Signaling Destination | Change | ISUP Local Signaling Destination used to match this action. This field is visible only if Incoming Media - Remote Signaling Stack is visible and set to ISUP. Select from the displayed list of ISUP Local Signaling Destinations that are associated with a valid Signaling Gateway. |
Incoming Media - Remote Exchange | Change | Remote exchange used to match this action. This field is visible only if Incoming Media type is visible and set to Remote (specified exchange). 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 | Remote media channel used to match this action. This field is visible only if the Incoming Media type is visible and set to Remote (specified media channel). 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 | Probability, expressed as a percentage, of selecting this Routing Action when the Routing Table has Routing table type set to Weighted random or Sticky random. This field is visible only if the Routing table type field of the parent Routing Table is set to Weighted random or Sticky random. Range: 0 - 100. The action probabilities for all Routing Actions within the parent Routing Table must be chosen so that the total is 100%. |
Action | Change | Type of routing action to be performed if this action is chosen. Values:
|
Media channel | Change | The Media Channel to be used for routing if this action is chosen. This field is visible only if Action is set to Routing complete. 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 | Next table to use in continued routing. This field is visible only if Action is set to Table lookup. Select from the displayed list of Routing Tables (which are all children of this Routing Action's grandparent Config Set). |
Temporary Alternate Routing indicator | Change | This field is visible 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 | Time, in ms, 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. This field is visible only if the Routing table type field of the parent Routing Table is set to Call gapping. Range: 0 - 86400000 |
Attribute value - operator call match | Change | Specifies how to match on the operator call attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to Operator call. Values:
|
Attribute value - operator call | Change | Specifies the value of the operator call attribute (whether or not the call should be treated as an operator call) that matches this entry. This field is visible only if Attribute value - operator call match is visible and set to Exact. Values:
|
Attribute value - Subscriber Group match | Change | Specifies how to match on the subscriber group attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to Subscriber Group. Values:
|
Attribute value - Subscriber Group | Change | Specifies the value of the Subscriber Group attribute (whether or not the call should be treated as an operator call) that matches this entry. This field is visible only if Attribute value - Subscriber Group match is visible and set to Exact. Select from the list of configured Subscriber Groups. |
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 | Specifies how to match on the UK Call Type attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to UK Call Type. Values:
|
Attribute value - UK Call Type | Change | Specifies the value of the UK Call Type attribute that matches this entry. This field is visible only if Attribute value - UK Call Type match is visible and set to Exact. 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 | Indicates how to match on a User Defined Attribute. This field is visible 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. Select one of the following values.
|
Attribute value - User Defined 1 - 20 | Change | Specifies the value of the User Defined Attribute that matches this entry. This field is visible 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. Specify an integer value in the range 0 - 2147483646. |
Attribute value - Line Class Code 1 - 20 match | Change | Indicates how to match on a Line Class Code value defined for the subscriber associated with the Routing request. This field is visible 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. Select one of the following values.
|
Attribute value - Line Class Code 1 - 20 | Change | Indicates the Line Class Code associated with the Routing request. This field is visible 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. 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 | Indicates how to match on the Originating Signaling Gateway attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to Originating Signaling Gateway. Select one of the following values.
|
Attribute value - originating Signaling Gateway | Change | Indicates the Originating Signaling Gateway associated with the Routing request. This field is visible only if Attribute value - originating Signaling Gateway match is set to Exact. Select from the displayed list of Signaling Gateways. |
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 is visible 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 is visible 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 is visible 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 is visible 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 is visible 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 is visible 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. 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 is visible 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 |
Congestion level 2 acceptance probability | Change | This field is visible 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 |
Maximum call duration | Change | This field is visible 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. |
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:
|
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: