Cisco Unified Communications Manager Administration Guide, Release 9.1(1)
Route filter setup
Download this chapter
Route filter setupRoute filter setup
Download the complete book
Cisco Unified Communications Manager Administration Guide, Release 9.1(1)Cisco Unified Communications Manager Administration Guide, Release 9.1(1) (PDF - 10 MB)
 Feedback

Route filter setup

This chapter provides information to add, update, copy, or delete a route filter.

For additional information about route plans, see the Cisco Unified Communications Manager System Guide.

About route filter setup

In Cisco Unified Communications Manager Administration, use the Call Routing > Route Filter menu path to configure route filters.

Route filters, along with route patterns/hunt pilots, use dialed-digit strings to determine how a call is handled. Route filters only apply when you configure a pattern that contains the at (@) wildcard. When the route pattern/hunt pilot contains the @ wildcard, Cisco Unified Communications Manager routes calls according to the numbering plan that is specified in the Numbering Plan drop-down list box. The route filter window that Cisco Unified Communications Manager displays varies according to the numbering plan that you select.

Route filters allow you to determine which route patterns/hunt pilots your users can dial; for example, whether your users can manually choose a long-distance carrier (by dialing 101 plus a carrier access code).

See topics related to understanding route plans in the Cisco Unified Communications Manager System Guide for more information.


Tip

Always add and define the route filter first and then add the route filter to the route pattern/hunt pilot.

Route filter configuration tips

Synchronize a route filter with affected devices after you configure or update a route filter.

After you configure or update a route filter, see topics related to adding, editing, and removing route filter clauses.

Related Tasks

Route filter deletion

You cannot delete a route filter that route patterns/hunt pilots, translation patterns, or other items use. To find out which route patterns/hunt pilots, translation patterns, or other items are using the route filter, in the Route Filter Configuration window, choose Dependency Records from the Related Links drop-down list box and click Go. If the dependency records are not enabled for the system, the Dependency Records Summary window displays a message. If you try to delete a route filter that is in use, Cisco Unified Communications Manager displays an error message. Before deleting a route filter that is currently in use, you must perform either or both of the following tasks:

  • Assign a different route filter to any route patterns/hunt pilots, translation patterns, or other items that are using the route filter that you want to delete.
  • Delete the route patterns/hunt pilots, translation patterns, or other items that are using the route filter that you want to delete.
Related Tasks
Related References

Route filter settings

The following table describes the route filter settings.

Table 1 Route filter settings

Field

Description

Numbering Plan

From the drop-down list, choose a dial plan; for example, North American Numbering Plan. Click Next.

Route Filter Information

Route Filter Name

Enter a name in the Route Filter Name field. The name can contain up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure each route filter name is unique to the route plan.

Note   

Use concise and descriptive names for your route filters. The CompanynameLocationCalltype format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a route filter. For example, CiscoDallasMetro identifies a route filter for tollfree, inter-local access and transport area (LATA) calls from the Cisco office in Dallas.

Clause Information

Route Filter Tags

Choose the route filter tags and operators and enter data, where appropriate, to create a clause for this route filter.

See Table 1 for explanations of the route filter tags, such as AREA-CODE.

Route Filter Operators

Choose the route filter tags and operators and enter data, where appropriate, to create a clause for this route filter.

See Table 2 for explanations of the route filter operators, such as NOT-SELECTED.
Related Information

Add and edit route filter clauses

Adding route filter clauses allows you to expand upon an existing route filter by incorporating additional operators and entries for existing tags by using a logical OR. You can add route filter clauses either when initially adding a new route filter or when updating an existing route filter.

Editing route filter clauses allows you to modify an existing route filter clause.

This procedure describes adding and editing route filter clauses that comprise an existing route filter.

Procedure
    Step 1   From Cisco Unified Communications Manager Administration, choose Call Routing > Route Filter.
    Step 2   Locate the route filter to which you want to add or edit route filter clauses.
    Step 3   If you want to add a new route filter clause, click Add Clause to display a new Route Filter Clause Configuration data entry window. All the operator fields for this new clause display NOT-SELECTED.
    Step 4   Choose the route filter tags and operators and enter data, where appropriate, to create an additional clause for this route filter.
    Note   

    See topics related to route filter tag descriptions for help with entering data for route filter tags and operators for the North American Numbering Plan.

    Step 5   To add the clause, click Save.

    The new clause displays below the existing clauses in the window. (Scroll down, if necessary, to view the new information.)

    Step 6   If you want to edit an existing route filter clause, click the Edit Clause button directly above the route filter clause that you want to edit. The Route Filter Clause Configuration window opens to display the current definition of the route filter clause that you chose.
    Step 7   Modify the route filter tags and operators and enter data, where appropriate, to edit the route filter clause that you chose to edit.
    Step 8   To save your changes to this route filter clause, click Save.
    Related References
    Related Information

    Remove route filter clauses

    You can remove route filter clauses either when setting up a new route filter or when updating an existing route filter. This procedure describes removing a route filter clause from an existing route filter.

    Procedure
      Step 1   From Cisco Unified Communications Manager Administration, choose Call Routing > Route Filter.
      Step 2   Locate the route filter from which you want to remove route filter clauses.
      Step 3   Scroll down to the top of the clause that you want to remove and click Remove Clause.

      A dialog box appears that warns you that you cannot undo the removal of this route filter clause.

      Caution   

      Each Remove Clause button applies to the clause immediately below the button. Check carefully to ensure that you are removing the correct clause before initiating this action. If you accidentally remove a clause, you cannot retrieve it, and you must rebuild it.

      Step 4   To remove the clause, click OK or to cancel the action, click Cancel. If you click OK, Cisco Unified Communications Manager removes the clause from the route filter.
      Related Information

      Synchronize route filter settings with devices

      To synchronize devices with a route filter that has undergone configuration changes, perform the following procedure, which applies any outstanding configuration settings in the least-intrusive manner possible. (For example, a reset/restart may not be required on some affected devices.)

      Procedure
        Step 1   Choose Call Routing > Route Filter.

        The Find and List Route Filters window displays.

        Step 2   Choose the search criteria to use.
        Step 3   Click Find.

        The window displays a list of route filters that match the search criteria.

        Step 4   Click the route filter to which you want to synchronize applicable devices. The Route Filter Configuration window displays.
        Step 5   Make any additional configuration changes.
        Step 6   Click Save.
        Step 7   Click Apply Config.

        The Apply Configuration Information dialog displays.

        Note   

        Any necessary resetting of devices that are associated with the route filter causes calls on affected gateways to drop.

        Step 8   Click OK.
        Related Information

        Route filter tag descriptions

        The tag serves as the core component of a route filter. A tag applies a name to a subset of the dialed-digit string. For example, the NANP number 972-555-1234 comprises LOCAL-AREA-CODE (972), OFFICE-CODE (555), and SUBSCRIBER (1234) route filter tags.

        Route filter tags require operators and can require additional values to decide which calls are filtered.

        The values for route filter tag fields can contain the wildcard characters X, *, #, [, ], -, ^, and the numbers 0 through 9. (See topics related to special characters and settings for route filters in the Cisco Unified Communications Manager System Guide for definitions of wildcard characters.) The descriptions in The following table use the notations [2-9] and XXXX to represent actual digits. In this notation, [2-9] represents any single digit in the range 2 through 9, and X represents any single digit in the range 0 through 9. Therefore, the description The three-digit area code in the form [2-9]XX" means that you can enter the actual digits 200 through 999, or all wildcards, or any mixture of actual digits and wildcards that results in a pattern with that range.

        Route filter tags vary depending on the numbering plan that you choose from the Numbering Plan drop-down list box on the Route Filter Configuration window. The following table describes the route filter tags for the North American Numbering Plan.

        Table 2 Route filter tags

        Tag

        Description

        AREA-CODE

        This three-digit area code in the form [2-9]XX identifies the area code for long-distance calls.

        COUNTRY CODE

        These one-, two-, or three-digit codes specify the destination country for international calls.

        END-OF-DIALING

        This single character identifies the end of the dialed-digit string. The # character serves as the end-of-dialing signal for international numbers that are dialed within the NANP.

        INTERNATIONAL-ACCESS

        This two-digit access code specifies international dialing. Calls that originate in the U.S. use 01 for this code.

        INTERNATIONAL-DIRECT-DIAL

        This one-digit code identifies a direct-dialed international call. Calls that originate in the U.S. use 1 for this code.

        INTERNATIONAL-OPERATOR

        This one-digit code identifies an operator-assisted international call. This code specifies 0 for calls that originate in the U.S.

        LOCAL-AREA-CODE

        This three-digit local area code in the form [2-9]XX identifies the local area code for 10-digit local calls.

        LOCAL-DIRECT-DIAL

        This one-digit code identifies a direct-dialed local call. NANP calls use 1 for this code.

        LOCAL-OPERATOR

        This one-digit code identifies an operator-assisted local call. NANP calls use 0 for this code.

        LONG-DISTANCE-DIRECT-DIAL

        This one-digit code identifies a direct-dialed, long-distance call. NANP calls use 1 for this code.

        LONG-DISTANCE-OPERATOR

        These one- or two-digit codes identify an operator-assisted, long-distance call within the NANP. Operator-assisted calls use 0 for this code, and operator access uses 00.

        NATIONAL-NUMBER

        This tag specifies the nation-specific part of the digit string for an international call.

        OFFICE-CODE

        This tag designates the first three digits of a seven-digit directory number in the form [2-9]XX.

        SATELLITE-SERVICE

        This one-digit code provides access to satellite connections for international calls.

        SERVICE

        This three-digit code designates services such as 911 for emergency, 611 for repair, and 411 for information.

        SUBSCRIBER

        This tag specifies the last four digits of a seven-digit directory number in the form XXXX.

        TRANSIT-NETWORK

        This four-digit value identifies a long-distance carrier.

        Do not include the leading 101 carrier access code prefix in the TRANSIT-NETWORK value. See TRANSIT-NETWORK-ESCAPE for more information.

        TRANSIT-NETWORK-ESCAPE

        This three-digit value precedes the long-distance carrier identifier. The value for this field specifies 101. Do not include the four-digit carrier identification code in the TRANSIT-NETWORK-ESCAPE value. See TRANSIT-NETWORK for more information.

        Route filter tag operators determine whether a call is filtered based on the existence, and sometimes the contents, of the dialed-digit string that is associated with that tag. The operators EXISTS and DOES-NOT-EXIST simply check for the existence of that part of the dialed-digit string. The operator == matches the actual dialed digits with the specified value or pattern. The following table describes the operators that can be used with route filter tags.

        Table 3 Route filter operators

        Operator

        Description

        NOT-SELECTED

        Specifies do not filter calls based on the dialed-digit string that is associated with this tag.

        Note   

        The presence or absence of the tag with which the operator is associated does not prevent Cisco Unified Communications Manager from routing the call.

        EXISTS

        Specifies filter calls when the dialed-digit string that is associated with this tag is found.

        Note   

        Cisco Unified Communications Manager routes or blocks the call only if the dialed-digit string contains a sequence of digits that are associated with the tag.

        DOES-NOT-EXIST

        Specifies filter calls when the dialed-digit string that is associated with this tag is not found.

        Note   

        Cisco Unified Communications Manager routes or blocks the call only if the dialed-digit string does not contain a sequence of digits that are associated with the tag.

        ==

        Specifies filter calls when the dialed-digit string that is associated with this tag matches the specified value.

        Note   

        Cisco Unified Communications Manager routes or blocks the call only if the dialed-digit string contains a sequence of digits that are associated with the tag and within the numbering range that is specified in the attached field.


        Caution

        Do not enter route filter tag values for tags that are using the operators EXISTS, DOES-NOT-EXIST, or NOT-SELECTED.

        Route filter examples

        Example 1: A route filter that uses AREA-CODE and the operator DOES-NOT-EXIST selects all dialed-digit strings that do not include an area code.

        Example 2: A route filter that uses AREA-CODE, the operator ==, and the entry 515 selects all dialed-digit strings that include the 515 area code.

        Example 3: A route filter that uses AREA-CODE, the operator ==, and the entry 5[2-9]X selects all dialed-digit strings that include area codes in the range of 520 through 599.

        Example 4: A route filter that uses TRANSIT-NETWORK, the operator ==, and the entry 0288 selects all dialed-digit strings with the carrier access code 1010288.

        Related Information