.. _configure_route_lists: Route Lists ------------ Overview ......... Route lists are made up of route groups and are associated with route patterns. A route list associates a set of route groups with a route pattern and determines the order in which those route groups are accessed. The order controls the progress of the search for available trunk devices for outgoing calls. A route list can contain only route groups. Each route list should have at least one route group. Each route group includes at least one device, such as a gateway, that is available. Based on device type, Cisco Unified Communications Manager (Unified CM) can choose some, or all, ports as resources in each route group. Some devices, such as digital access, only allow you to choose all ports. You can add a route group to any number of route lists. Configure Route Groups ........................ This procedure adds route lists and adds, removes, or changes the order of route groups in a route list. **Pre-requisites**: * Configure the route groups. **Perform these steps**: 1. Log in to as Provider, Reseller or Customer administrator. .. note:: When configuring a route list as a provider or reseller, ensure that you select a valid customer or site under your customer in the hierarchy node breadcrumb at the top of the view. 2. Perform one of the following: * If you logged in as provider or reseller administrator, choose **Device Management > CUCM > Route Lists**. * If you logged in as customer administrator, choose **Device Management > Advanced > Route Lists**. 3. Choose an appropriate option: * To add a new route list, click **Add**, then go to Step 4. * To edit an existing route list, choose the list to be updated by clicking on its box in the leftmost column, then click **Edit** to update the selected route list. Go to Step 5. 4. Complete at minimum, the mandatory :ref:`route_lists_details_fields`. 5. To add a route group to this route list, click + on the right side of the **Route Group Items** box and complete at minimum, the mandatory :ref:`route_group_items_fields`. 6. To remove a route group from this route list, click - on the right side of its row in the **Member** box. 7. To change the priority of a route group, move it up or down in the list by clicking the arrows on the right side of the **Member** box. Using the Up arrow, move the group higher in the list to make it a higher priority, or using the Down arrow, move the group lower in the list to make it a lower priority. 8. To save a new or updated route list, click **Save**. .. _route_lists_details_fields: Route Lists Field Reference ............................. .. tabularcolumns:: |p{3.5cm}|p{12cm}| +--------------------+-----------------------------------------------+ | Field | Description | +====================+===============================================+ | CUCM \* | Select a Unified CM for the route list. This | | | field is mandatory. | +--------------------+-----------------------------------------------+ | | Enter a unique name for the new route list. | | | The name can contain up to 50 alphanumeric | | | characters and can contain any combination of | | | spaces, period(s), hyphens (-), and | | | underscore characters (_). This field is | | | mandatory. | | | | | | Tip: | | Name \* | | | | Use concise and descriptive names for the | | | route list. The CompanynameLocationCalltype | | | format usually provides a sufficient level of | | | detail and is short enough to enable you to | | | quickly and easily identify a route list. For | | | example, 'CiscoDallasMetro' identifies a | | | route list for toll-free, inter-local access | | | transport area (LATA) calls from the Cisco | | | office in Dallas. | +--------------------+-----------------------------------------------+ | Description | A description of the route list. | +--------------------+-----------------------------------------------+ | | Select a Unified CM Group. Default is the | | | default field. You can choose from | | | **Default**, **None**, or select a group. This| | Call Manager Group | field is mandatory. | | Name \* | | | | Note: The route list registers with the first | | | Unified CM in the group (which is the Primary | | | Unified CM). | +--------------------+-----------------------------------------------+ | | Select to enable the route list. This is the | | | default. | | | | | Route List Enabled | Clear to disable the route list. When | | | disabling a route list, calls in progress do | | | not get affected, but the route list does not | | | accept additional calls. | +--------------------+-----------------------------------------------+ | Run on Every Node | Select to enable the active route list to run | | | on every node. | +--------------------+-----------------------------------------------+ | Route Group Items | See "Route Group Items fields". | +--------------------+-----------------------------------------------+ .. _route_group_items_fields: Route Group Field Reference ............................ .. tabularcolumns:: |p{3.5cm}|p{12cm}| +------------------------+------------------------------------------------+ | Field | Description | +========================+================================================+ | Route Group \* | Choose the route group. This field is | | | mandatory. | +------------------------+------------------------------------------------+ | | Indicate the order in which to prioritize | | | multiple routes. A lower selection order | | Selection Order | indicates higher priority. This field | | | requires an integer value. The default is | | | no setting. | +------------------------+------------------------------------------------+ | | Choose **On** from the drop-down list if you | | | want the full external phone number to be | | | used for calling line identification | | Use Calling Party's | (CLID) on outgoing calls. Choose **Off** or | | External Phone Number | **Default** if you do not want to use the | | Mask \* | full external phone number for CLID on | | | outgoing calls. You may also configure an | | | External Phone Number Mask on all phone | | | devices. This field is mandatory. | +------------------------+------------------------------------------------+ | | Enter a transformation mask value. Valid | | | entries include the digits 0 through 9; | | | the wildcard characters X, asterisk (*), | | | and octothorpe (#); and the international | | | escape character \+. | | Calling Party | | | Transformation Mask | If the **Digit Discards** field is blank, the | | | **Prefix Digits** field is blank, the **Calling| | | Party Transformation Mask** field is blank, | | | and **Use Calling Party's External Phone | | | Number Mask** is set to **Off** or **Default**,| | | no calling party transformation takes place. | +------------------------+------------------------------------------------+ | | Enter prefix digits in the field. Valid | | | entries include the digits 0 through 9, | | | the wildcard characters asterisk (*) and | | Calling Party Prefix | octothorpe (#), and the international | | Digits | escape character \+. | | | Note: The appended prefix digit does not | | | affect which directory numbers route to | | | the assigned device. | +------------------------+------------------------------------------------+ | | Choose the format for the number type in | | | calling party directory numbers. | | | | | | Unified CM sets the calling directory | | | number (DN) type. Cisco recommends that | | | you do not change the default value | | | unless you have advanced experience with | | | dialing plans such as NANP or the | | | European dialing plan. You may need to | | | change the default in Europe because | | | Unified CM does not recognize European | | | national dialing patterns. You can also | | | change this setting when you are | | | connecting to a PBX that expects the | | | calling directory number to be encoded to | | Calling Party Number | a non national type numbering plan. | | Type | | | | Choose one of the following options: | | | | | | * **Cisco CallManager** - Use when the | | | Unified CM sets the directory number | | | type. | | | * **Unknown** - Use when the dialing plan | | | is unknown. | | | * **National** - Use when you are dialing | | | within the dialing plan for your | | | country. | | | * **International** - Use when you are | | | dialing outside the dialing plan for | | | your country. | | | * **Subscriber** - Use when you are | | | dialling a subscriber by using a | | | shortened subscriber number. | +------------------------+------------------------------------------------+ .. tabularcolumns:: |p{3.5cm}|p{12cm}| +------------------------+-------------------------------------------+ | Field | Description | +========================+===========================================+ | | Choose the format for the numbering plan | | | in calling party directory numbers. | | | | | | Unified CM sets the calling DN numbering | | | plan. Cisco recommends that you do not | | | change the default value unless you have | | | advanced experience with dialing plans | | | such as NANP or the European dialing | | | plan. You may need to change the default | | | in Europe because Unified CM does not | | | recognize European national dialing | | | patterns. You can also change this | | | setting when you are connecting to PBXs | | | by using routing as a non-national type | | Calling Party | number. | | Numbering Plan | | | | Choose one of the following options: | | | | | | * **Cisco CallManager** - Use when the | | | Unified CM sets the Numbering Plan in | | | the directory number. | | | * **ISDN** - Use when you are dialing | | | outside the dialing plan for your | | | country. | | | * **National Standard** - Use when you are| | | dialing within the dialing plan for | | | your country. | | | * **Private** - Use when you are dialing | | | within a private network. | | | * **Unknown** - Use when the dialing plan | | | is unknown. | +------------------------+-------------------------------------------+ | Called Party Discard | Choose the discard digit instructions | | Digits | that you want to be associated with this | | | called party transformation pattern. | +------------------------+-------------------------------------------+ | | Enter a transformation mask value. Valid | | | entries include the digits 0 through 9; | | | the wildcard characters X, asterisk (*), | | Called Party | and octothorpe (#); the international | | Transform Mask | escape character \+; and blank. If this | | | field is blank and the preceding field is | | | not checked, no transformation takes | | | place. | +------------------------+-------------------------------------------+ | | Enter prefix digits in the field. Valid | | | entries include the digits 0 through 9, | | | the wildcard characters asterisk (*) and | | Called Party Prefix | octothorpe (#),the international escape | | Digits | character \+, and blank. | | | Note: The appended prefix digit does not | | | affect which directory numbers route to | | | the assigned device. | +------------------------+-------------------------------------------+ | | Choose the format for the number type in | | | called party directory numbers. | | | | | | Unified CM sets the called directory | | | number (DN) type. Cisco recommends that | | | you do not change the default value | | | unless you have advanced experience with | | | dialing plans such as NANP or the | | | European dialing plan. You may need to | | | change the default in Europe because | | | Unified CM does not recognize European | | | national dialing patterns. You can also | | | change this setting when you are | | | connecting to a PBX that expects the | | | called directory number to be encoded to | | Called Party Number | a non-national type numbering plan. | | Type | | | | Choose one of the following options: | | | | | | * **Cisco CallManager** - Use when the | | | Unified CM sets the directory number | | | type. | | | * **Unknown** - Use when the dialing plan | | | is unknown. | | | * **National** - Use when you are dialing | | | within the dialing plan for your | | | country. | | | * **International** - Use when you are | | | dialing outside the dialing plan for | | | your country. | | | * **Subscriber** - Use when you are | | | dialling a subscriber by using a | | | shortened subscriber number. | +------------------------+-------------------------------------------+ .. tabularcolumns:: |p{3.5cm}|p{12cm}| +------------------------+-------------------------------------------+ | Field | Description | +========================+===========================================+ | | Choose the format for the numbering plan | | | in called party directory numbers. | | | | | | Unified CM sets the called DN numbering | | | plan. Cisco recommends that you do not | | | change the default value unless you have | | | advanced experience with dialing plans | | | such as NANP or the European dialing | | | plan. You may need to change the default | | | in Europe because Unified CM does not | | | recognize European national dialing | | | patterns. You can also change this | | | setting when you are connecting to PBXs | | | by using routing as a non-national type | | Called Party Numbering | number. | | Plan | | | | Choose one of the following options: | | | | | | * **Cisco CallManager** - Use when the | | | Unified CM sets the Numbering Plan in | | | the directory number. | | | * **ISDN** - Use when you are dialing | | | outside the dialing plan for your | | | country. | | | * **National Standard** - Use when you | | | are dialing within the dialing plan for | | | your country. | | | * **Private** - Use when you are dialing | | | within a private network. | | | * **Unknown** - Use when the dialing plan | | | is unknown. | +------------------------+-------------------------------------------+