Routing Action

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:
  • Not present
    Matches absence of address.
  • E.164
    Matches destination and source addresses.
  • Network ID
    Matches transit network addresses.
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:
  • Unknown
  • International
  • National
  • Subscriber
  • No number
  • UK specific
  • Match any (default)
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:
  • Explicit wildcard
    Match on the exact address, as specified in the Wildcard address and Address type fields.
  • Full wildcard - any type
    Match on any address of any type.
  • Full wildcard - this type
    Match on any address with the address type specified in the Address type field.
  • Part wildcard header
    Match on an address with the address type specified in the Address type field that starts with the string specified in the Wildcard address field.
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:
  • Pre-paid / off-switch calling card subscriber
  • Fax / modem subscriber
  • Nomadic subscriber
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:
  • Local
    Match on the local exchange.
  • Remote (any)
    Match on any remote exchange.
  • Remote (specified signaling stack)
    Match on the signaling stack type specified in the Incoming Media - Remote Signaling Stack field.
  • Remote (specified exchange)
    Match on the remote exchange specified in the Incoming Media - Remote Exchange field.
  • Remote (specified media channel)
    Match on the media channel specified in the Incoming Media - Remote Media Channel field.
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:
  • ISUP
  • MF
  • ISDN
  • SIP
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 MF, ISDN, 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 MF, ISDN, ISUP or SIP, then follow the dialogs to select the appropriate channel or trunk from the list. Media channels or ISDN PRIs 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:
  • Routing complete
    Routing is complete, the call should be routed using the media channel specified in the Media channel field.
  • Reject
    It is not possible to route the call, the routing request should be rejected
  • Table lookup
    Another routing table, specified in Next table, should be processed.
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 MF Media Channels, ISDN trunk PRIs, ISUP Media Channels or SIP Trunks, then select the appropriate channel or trunk from the list. Media channels or ISDN PRIs 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 and the media channel selected in the Media channel field is an ISUP media channel rather than an MF media channel. 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:
  • True
  • False (default)
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:
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
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:
  • True
  • False
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:
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
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 Specifies how to match on the US Call Type attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to US Call Type. Values:
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - US Call Type Change Specifies the value of the US Call Type attribute that matches this entry. This field is visible only if Attribute value - US Call Type match is visible and set to Exact. Values:
  • Unknown (default)
  • Operator
  • Emergency
  • Local
  • IntraLata
  • IntraLata national
  • IntraLata international
  • Toll Free
  • Premium
  • Other non-geographic
  • Operator Service
  • Directory Assist
  • FGD cut through
  • FGB
  • International toll free
  • Other N11
  • International
  • Other
Attribute value - UK Call Type match Change This field is valid only in the UK.
Attribute value - UK Call Type Change This field is valid only in the UK.
Attribute value - CIP match Change Specifies how to match on the Carrier Identification Parameter (CIP) attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to CIP. Values:
  • Exact
  • Match even if not present (default)
  • Match any if present
  • Only match if absent
Attribute value - CIP Change Specifies the value of the CIP attribute that matches this entry. This field is visible only if Attribute value - CIP match is visible and set to Exact. Specify the CIP as a 4-digit number (with leading zeros if necessary).
Attribute value - ANI II digits match Change Specifies how to match on the ANI II digits attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to ANI II digits. Values:
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - ANI II digits Change Specifies the value of the ANI II digits attribute that matches this entry. This field is visible only if Attribute value - ANI II digits match is visible and set to Exact. Specify a value in the range 0 - 99. The default is 0.
Attribute value - Dialed Prefix match Change Specifies how to match on the Dialed Prefix attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to Dialed Prefix. Values:
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - Dialed Prefix Change Specifies the value of the Dialed Prefix attribute that matches this entry. This field is visible only if Attribute value - Dialed Prefix match is visible and set to Exact. Values:
  • Unknown (default)
  • 1+
  • 0-
  • 0+
  • None
Attribute value - Dialing Pattern match Change Specifies how to match on the Dialing Pattern attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to Dialing Pattern. Values:
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - Dialing Pattern Change Specifies the value of the Dialing Pattern attribute that matches this entry. This field is visible only if Attribute value - Dialing Pattern match is visible and set to Exact. Values:
  • 7 digits (default)
  • 10 digits
  • 0+10 digits
  • 1+10 digits
  • Other
Attribute value - User Defined 1 match Change Indicates how to match on the User Defined 1 attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to User Defined 1. Select one of the following values.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - User Defined 1 Change Specifies the value of the User Defined 1 attribute that matches this entry. This field is visible only if Attribute value - User Defined 1 match is set to Exact. Specify an integer value in the range 0 - 2147483646.
Attribute value - User Defined 2 match Change Indicates how to match on the User Defined 2 attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to User Defined 2. Select one of the following values.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - User Defined 2 Change Specifies the value of the User Defined 2 attribute that matches this entry. This field is visible only if Attribute value - User Defined 2 match is set to Exact. Specify an integer value in the range 0 - 2147483646.
Attribute value - User Defined 3 match Change Indicates how to match on the User Defined 3 attribute. This field is visible only if one of the Match attribute fields of the parent Routing Table is set to User Defined 3. Select one of the following values.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - User Defined 3 Change Specifies the value of the User Defined 3 attribute that matches this entry. This field is visible only if Attribute value - User Defined 3 match is set to Exact. Specify an integer value in the range 0 - 2147483646.
Attribute value - Line Class Code 1 match Change Indicates how to match on the Line Class Code 1 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 Line Class Code 1. Select one of the following values.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - Line Class Code 1 Change Indicates the Line Class Code 1 associated with the Routing request. This field is visible only if Attribute value - Line Class Code 1 match is set to Exact. Specify the Line Class Code as an integer value in the range 0 - 2147483646. The default is 0.
Attribute value - Line Class Code 2 match Change Indicates how to match on the Line Class Code 2 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 Line Class Code 2. Select one of the following values.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - Line Class Code 2 Change Indicates the Line Class Code 2 associated with the Routing request. This field is visible only if Attribute value - Line Class Code 2 match is set to Exact. Specify the Line Class Code as an integer value in the range 0 - 2147483646. The default is 0.
Attribute value - Line Class Code 3 match Change Indicates how to match on the Line Class Code 3 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 Line Class Code 3. Select one of the following values.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - Line Class Code 3 Change Indicates the Line Class Code 3 associated with the Routing request. This field is visible only if Attribute value - Line Class Code 3 match is set to Exact. Specify the Line Class Code as an integer value in the range 0 - 2147483646. The default is 0.
Attribute value - Line Class Code 4 match Change Indicates how to match on the Line Class Code 4 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 Line Class Code 4. Select one of the following values.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - Line Class Code 4 Change Indicates the Line Class Code 4 associated with the Routing request. This field is visible only if Attribute value - Line Class Code 4 match is set to Exact. Specify the Line Class Code as an integer value in the range 0 - 2147483646. The default is 0.
Attribute value - Line Class Code 5 match Change Indicates how to match on the Line Class Code 5 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 Line Class Code 5. Select one of the following values.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - Line Class Code 5 Change Indicates the Line Class Code 5 associated with the Routing request. This field is visible only if Attribute value - Line Class Code 5 match is set to Exact. Specify the Line Class Code as an integer value in the range 0 - 2147483646. The default is 0.
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.
  • Exact
  • Match any if present (default)
  • Match even if not present
  • Only match if absent
Attribute value - originating Signaling Gateway Change Indicates the Line Class Code 5 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.
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.
Number action - charge 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 charge 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
  • ARR allowed
  • Routing control (UK only)
  • Circuit code (North America only)
  • MF tandem routing code (North America only)
  • MF international non-operator routing code (North America only)
  • MF international operator routing code (North America only)
  • Max channel usage
  • Congestion level 1 acceptance probability
  • Congestion level 2 acceptance probability
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:
  • True (default)
  • False
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:
  • True (default)
  • False
Routing control Change This field is not valid in North America.
Circuit code 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 Circuit Code to be included in the routing request if this action is chosen. This parameter is used only if the call is routed to a transit network. Range : 0 - 15
MF tandem routing code 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. MF tandem routing code to be written back into the SETUP. This parameter is used only if the call is routed over MF signaling. Range: 0 - 99
MF international non-operator routing code 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. MF international (non-operator) routing code to be written back into the SETUP. This parameter is used only if the call is routed over MF signaling. Range: 120 - 199
MF international operator routing code 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. MF international (operator) routing code to be written back into the SETUP. This parameter is used only if the call is routed over MF signaling. Range: 120 - 199
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
Alarm state Read only Specifies whether any alarms are currently raised for this object. Values:
  • Clear
    No alarms are currently raised.
  • Attention Required
    Attention Required - the object is not operating normally, and needs operator intervention.
  • Attend To Dependent
    Attention Required elsewhere - another object on which this object depends is not operating normally.
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:
  • Enabled
    The object has been enabled.
  • Disabled
    The object has not been enabled or has been disabled.
Actual status Read only Specifies the current status of the Routing Action. Values:
  • Enabled
    The object has been enabled.
  • Disabled
    The object has not been enabled or has been disabled.

Number Actions

The Number action - called number action, Number action - calling party number action and Number action - charge number parameters in the Routing Action object provide a mechanism for editing the called number (or the calling party number, or charge 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: