[Index]

Model: relation/GS_CrossSiteHuntGroup-HuntGroupRelation_REL

Cross Site Hunt Groups

Full HTML Help

Overview

The ability to have shared lines across sites allows lines to be shared across sites, and is accomplished by introducing the concept of an "inventory site", in addition to "real sites":

Devices are only provisioned on real sites (not in the inventory site).

The "shared lines** feature also supports hunt groups and call pickup groups across sites by leveraging the inventory site to provision all of the lines to be included in the hunt group or call pickup group.

Lines used in the hunt groups and call pickup groups that are provisioned in the inventory site can span multiple real sites; that is, they're used by devices on the real sites. The key requirement is that all the lines to be used by a given hunt group or call pickup group must be configured in the inventory site, along with the hunt group and call pickup group itself.

The "shared line across sites" deployment model is 100% backward compatible with the previous directory number (DN) and line configuration. Existing deployments are not impacted when the system is upgraded, and all existing dial plan configuration procedures are supported. The deployment configuration shown in Shared Line Across Sites Example is optional and is only required when sharing lines across sites.

Tip

If a line is potentially shareable, it is recommended that you create the line in the inventory site, even if it won't be shared across sites immediately.

The system does not support the ability to move a line from a real site to an inventory site, so to convert a line from site-local to cross-site shared, the line would need to be deleted from the real site and recreated in the inventory site.

Note

See the Glossary for descriptions of the following terms related to shared lines across sites functionality:

Limitations of shared lines across sites

When considering using shared lines across sites, consider the following limitations:

Example of shared line across sites

Phones are always configured on real sites, and can use both shared and site-local lines. For example, each phone can have one site-local line (for example, 1000), and one cross-site shared line (for example, 9000). The following is a summary of the configuration that resides at each hierarchy type:

  1. Customer hierarchy

  2. Inventory site, includes:

  3. Real site, includes

Fields in Automate that reference DNs, such as the Pattern field in the Line tab of a phone, are in a drop-down list of DN inventory. The drop-down list of DNs includes inventory defined at the customer level, combined with the inventory defined at the current site context. The administrator can chose either a cross-site shared DN or a site-local DN.

Diagram showing shared line across sites configuration

The image provides a basic shared line across sites configuration:

../www/img/doc/401572.png

Configure shared line across sites

Tip

Use the Action search to navigate Automate

The steps for configuring shared lines across sites is generally the same as with conventional lines. This section highlights the differences.

Configure shared line across sites at customer

The customer configuration is similar except that you create DN inventory at the customer hierarchy for lines you would like to share (or potentially share) across sites.

  1. Configure the Cisco UCM and Cisco Unity Connection (CUC) devices. These can be at the customer level (dedicated) or above (shared).

  2. Configure the customer normally (for example, c2).

  3. Configure the Network Device List (NDL) for the customer (for example, c2Ndl) that will be used for your site group (NDL/Country combination).

  4. Deploy the customer dial plan.

    This must be a flat dial plan (for example, Type 4) since shared lines across site dictates that DNs cannot be site-specific. The Type 4 dial plan does not impose site-specific structure (in other words, site location codes). When configuring the customer dial plan, ensure that the Site Location Code check box is unchecked.

  5. Configure the DN inventory to be used across sites for shared lines (via the Directory Number Inventory). Note that you should leave the site drop-down list empty to create the inventory on the Customer hierarchy node.

Configure shared line across sites at inventory site

The inventory site is only needed if you want to configure shared lines across sites. If you do not have this requirement you do not need an inventory site and configuration is exactly as it is done normally. Most of the inventory site configuration is the same as configuration for a real site (for example, deploy site dial plan, configure DN inventory, and so on). The areas that are unique to the inventory site are provided in Steps 1, 3, and 5.

  1. Configure the inventory site and specify the NDL and Country, for example, c2InventorySite. A different inventory site is needed for each NDL/Country combination (site group). If the customer only has one NDL and one Country, they only need one inventory site.

  2. Deploy the site dial plan (Type 4 will automatically be used based on the customer dial plan that was deployed).

  3. Create the new Classes of Service to be used as the default line CSS and update the Site Defaults procedure for the inventory site.

    See Class of Service for Shared Line Across Sites.

  4. Configure Directory Number Routing (DNR) for the shared lines (via Directory Number Routing).

  5. Create line relations for each shared line (via Line).

  6. Create E.164 inventory (via Add E164 Inventory).

  7. Associate E.164 to DN (via E164 Associations (N to N)).

  8. Configure Hunt Groups that use shared lines (via Hunt Groups).

  9. Configure Call Pickup Groups that use shared lines (via Call Pickup Groups).

Configure shared line across sites at real sites

Configuration at the real sites is almost exactly the same as in past Cisco HCS releases. The major difference is that the Shared Lines Across Sites exist at the inventory site and therefore any configuration associated with those lines (CoS, DNR, E.164 associations, and so on) exists at the inventory site.

  1. Configure the real site (for example c2s1, c2s2, and so on). Use the same NDL and Country as the inventory site (same site group).
  2. Deploy the site dial plan on each of the real sites (again, the customer dial plan enforces that the flat dial plan is used).
  3. Create DN inventory for an DNs that will be used only at this site.
  4. Create Directory Number Routing (DNR) for any DNs created at this site.
  5. Create E.164 inventory and associations for an DNs created at this site.
  6. Create Device Class of Service if needed. See Class of Service for Shared Line Across Sites.
  7. Create Line Class of Service if needed for your site-specific lines. Refer to Class of Service for Shared Line Across Sites.
  8. Configure users and phones (via Quick Add User, or Phones).
    1. When configuring normal lines (lines that aren't shared across sites), select a line from the local site DN inventory, not the customer-level DN inventory. The line is created at the local site as normal; you can configure line CoS, DNR, E.164 associations at this site as normal. Note that this includes shared lines that are only shared within the site.
    2. When configuring a shared line across sites, select a customer-level DN from the drop-down list. Remember, the line should be configured at the inventory site first.
  9. Configure site-specific Hunt Groups that use lines local to the real site.
  10. Configure site-specific Call Pickup Groups that use lines local to the real site.

Dial plan type for shared line across sites

The shared lines across sites functionality only works if you're using a flat dial plan (Type 4), or a custom, non-site-specific, dial plan. This is because other dial plans (Types 1 to 3) have site location codes in the DN that don't work if the DN is shared by multiple sites.

If you're using predefined dial plans, ensure the Site Location Code checkbox is clear (disabled) when deploying the customer dial plan.

Class of service for shared line across sites

Class of Service (CoS) refers to a Calling Search Space (CSS) that is specifically used to define call routing and feature processing for a line or a phone.

Several CSSs are defined when a customer and site dial plan are deployed. Some of these are only used internally (don't select these CSSs in the CSS drop-downs when configuring a line or phone).

Class of Service CSSs are listed on the Class of Service page. A few example CoSs are predefined when a site dial plan is deployed, but the intent is for the administrator to create their own CoSs to meet the desired call routing and feature processing behavior. Below is a summary of Class of Service as it pertains to Shared Lines Across Sites feature.

Class of service is used in two places in Automate:

Additionally, CoS can provide line-based routing (LBR) or device-based routing (DBR). For each call made from a phone, the device CSS of the phone is combined with the line CSS of the line from which the call is being made, and the features and routing for the call are processed based on the combined list of partitions of these two CSSs. The default set of CoSs provided when a site dial plan is deployed includes a device CoS for emergency dialing only, and several line CoSs for feature processing, national dialing, and international dialing and that support either DBR and LBR. The following table shows the default allocation of feature and routing duties between the two sets of CoSs.

Feature Default Device CoS Default Line CoS
Emergency call routing yes* -
Intrasite routing - yes
Intersite routing - yes
Local PSTN call routing - yes**
National PSTN call routing - yes
International PSTN call routing - yes
Feature processing - yes

Table: Default Class of Service for Shared Line Across Sites Feature

* Emergency call routing is dependent on the country configured for the site. The country is used to route to the correct emergency number for that country (for example, 911 routes to 112 in the United Kingdom). Emergency call routing is assigned to the Device CoS because it is location-dependent, and must be tied to the site where the phone/user actually resides.

** Local call routing is dependent on local area codes defined in the site dial plan. The local area codes configured in the site dial plan allow dialing local dialing (for example 7-digit dialing in the United States).

As shown in the table above, routing is weighted heavily toward the line CoS because when the CoS is assigned to the line, it applies equally to the phone, extension mobility, and single number reach, which all typically share the same line configuration and provide similar dialing behavior for a given user. However, this assumes that the lines and devices are all constrained to individual sites. When we open up lines to be shared across sites, the site-specific configuration becomes more important in order to determine what to put in the device CoS versus the line CoS.

Class of Service (CoS) management for Shared Lines Across Sites is heavily dependent on the customer's specific deployment scenario. The distribution of work between the device CoS and the line CoS depends on the type of country dial plan, and the dialing behavior the customer wants.

For example, if the country dial plan is flat and closed like the Swiss dial plan, meaning that the user numbers are not variable length and there is no site-specific area codes (only national dialing), then most of the routing can occur in the line CoS because there is not much site-specific dialing behavior.

However, if the country dial plan uses area codes and the customer wants a local dialing experience (ability to dial a shorter number such as 7-digit dialing in the United States, and relying on the dial plan to fill in the local area code), then local call routing must be in the device CoS because the device context is needed to determine which area codes to apply to the dialed number. Feature processing partitions can almost always stay with the line CoS since there is usually no geographic dependencies for the feature processing. The exception to this is Time of Day (TOD) routing which may vary depending on the site.

The table provides details for determining how to distribute routing and feature processing between the line CoS and device CoS.

Feature Line CoS Device CoS
Emergency call routing - Emergency routing should always be location-specific
Intrasite routing Always using the PrelSR route partition -
Intersite routing Always using the PrelSR route partition -
Local call routing When full E.164 number is always dialed for offnet calls, for example, national dial plans with no local call routing When site-specific area codes and/or variable length user numbers (local dialing behavior) are defined
National call routing If local dialing is line-specific, national dialing should be line-specific. If local dialing is device-specific, national dialing should be device-specific.
Toll-free call routing If local dialing is line-specific, toll-free dialing should be line-specific. If local dialing is device-specific, toll-free dialing should be device-specific.
International call routing If local dialing is line-specific, international dialing should be line-specific. If local dialing is device-specific, international dialing should be device-specific.
Service call routing If local dialing is line-specific, service number dialing should be line-specific. If local dialing is device-specific, service number dialing should be device-specific.

To speed up the process of configuring lines and phones when you create new Classes of Service, set the site-specific default line CSS and site-specific default device CSS (Site Management > Defaults). These fields appear in the following tabs:

Call forward considerations for shared line across sites

As the administrator, you can create the Call Forward CSS as a CoS for a particular deployment scenario. Considerations must be made based on whether the local, national, and/or international dialing is configured on the device CoS or line CoS.

Be aware that if the Call Forward CSS allows national and local PSTN routing, you may need to consider call forward scenarios when a line is not associated to a device and PSTN dialing is in the device CoS.

Phone, user, and Quick User for shared line across sites

Phones and users should only be created at real sites and not at inventory sites. However, the system workflows don't enforce this rule, but will help facilitate ongoing management of the configuration data for the customer.

Lines referenced in the Phone screen, the Users screen, or the Quick Users screen are created automatically if they have not already been provisioned in the inventory sites and pushed to Cisco UCM. This is acceptable as long as you intend for these lines to be only referenced within one site. If a line gets created on a real site that you intended to share across sites, it is recommended that you delete the line, and recreate it in the inventory site.

Relevant fields for shared lines across sites on the Phone screen are:

The Route Partition Name field is automatically populated with the correct directory number partition based on the Pattern (DN) chosen. Similar fields exist in the User tabs.

Hunt groups and call pickup groups for shared line across sites

Hunt groups and call pickup groups can be set up in either the inventory site or in the real sites, with the following conditions:

Example scenario

The image provides an example of a hunt group that uses lines spanning multiple sites.

../www/img/doc/401573.png

In this example, the hunt group includes the following lines:

These lines are not shared across sites, but to include them all in one hunt group, they must all be configured at the inventory site so that they can all be grouped under a single hunt pilot number, 5500.

Note

Handling voicemail to secondary shared lines

To handle voicemail to secondary shared lines, create a separate user for each shared line at the Inventory Site level, then enable the voice mailbox for that user so that it can be managed by all shared lines.

This approach:

Note

One additional license is required for the shared line user mailbox.

Relation for Hunt Group Elements

Model Details: relation/GS_CrossSiteHuntGroup-HuntGroupRelation_REL

Title Description Details
Hunt Pilot * Enter the hunt pilot, including numbers and wildcards (do not use spaces); for example, for NANP, enter 9.@ for typical local access, or 8XXX for a typical private network numbering plan. Valid characters include the uppercase characters A, B, C, and D and \+, which represents the international escape character +. Note    Ensure that the directory hunt pilot, which uses the chosen partition, route filter, and numbering plan combination, is unique. Check the hunt pilot, translation pattern, directory number, call park number, call pickup number, message waiting on/off, or meet me number if you receive an error that indicates duplicate entries. You can also check the route plan report.
  • Field Name: pattern
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 1024
Description Enter a description of the hunt pilot. The description can include up to 50 characters in any language, but it cannot include double-quotes ("), percentage sign (%), ampersand (&), or angle brackets (<>).
  • Field Name: description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 1024
Route Partition If you want to use a partition to restrict access to the hunt pilot, choose the desired partition from the drop-down list box. If you do not want to restrict access to the hunt pilot, choose <None> for the partition. You can configure the number of partitions that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more partitions exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Partitions window, then find and choose a partition name. Note    To set the maximum list box items, choose System > Enterprise Parameters and choose Unified CMAdmin Parameters. Note    Make sure that the combination of hunt pilot, route filter, and partition is unique within the Cisco Unified Communications Manager cluster.
  • Field Name: routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Block this pattern If the checkbox is checked, then block this pattern. Also choose the required Release Clause. If the checkbox is unchecked, then Route this pattern.
  • Field Name: blockEnable
  • Type: Boolean
  • Cardinality: [1..1]
Called Party Transform Mask Enter a transformation mask value. Valid entries include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If the field is blank, no transformation takes place. Cisco Unified Communications Manager sends the dialed digits exactly as dialed.
  • Field Name: calledPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Calling Party Transform Mask Enter a transformation mask value. Valid entries include the digits 0 through 9, the wildcard character X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If this field is blank and the preceding field is not checked, no calling party transformation takes place.
  • Field Name: callingPartyTransformationMask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Use Calling Party's External Phone Number Mask * Check the check box if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls. You may also configure an External Phone Number Mask on all phone devices. Note    The calling party transformation settings that are assigned to the line groups in a hunt list override any calling party transformation settings that are assigned to a hunt pilot that is associated with that hunt list. Default: Default
  • Field Name: useCallingPartyPhoneMask
  • Type: String
  • Cardinality: [1..1]
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Off", "On", "Default"]
Prefix Digits Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9; the wildcard characters asterisk (*) and octothorpe (#); the international escape character +; and blank. Note    The appended prefix digit does not affect which directory numbers route to the assigned device.
  • Field Name: callingPartyPrefixDigits
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Numbering Plan Choose a numbering plan.
  • Field Name: dialPlanName
  • Type: ["String", "Null"]
  • Target: device/cucm/DialPlan
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Digit Discard Instruction Name
  • Field Name: digitDiscardInstructionName
  • Type: ["String", "Null"]
  • Target: device/cucm/DiscardDigitInstruction
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Urgent Priority If the dial plan contains overlapping hunt lists, Cisco Unified Communications Manager would not route the call until the interdigit timer expires (even if it is possible to dial a sequence of digits to choose a current match). Check this check box to interrupt interdigit timing when Cisco Unified Communications Manager must route a call immediately.
  • Field Name: patternUrgency
  • Type: Boolean
  • Cardinality: [0..1]
Prefix Digits Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9; the wildcard characters asterisk (*) and octothorpe (#); the international escape character +; and blank. Note    The appended prefix digit does not affect which directory numbers route to the assigned device.
  • Field Name: prefixDigitsOut
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
Route Filter If your hunt pilot includes the @ wildcard, you may choose a route filter. The optional act of choosing a route filter restricts certain number patterns. The route filters that display depend on the numbering plan that you choose from the Numbering Plan drop-down list box. You can configure the number of items that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more route filters exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Route Filters window, then find and choose a route filter name. Note    To set the maximum list box items, choose System > Enterprise Parameters and choose Unified CMAdmin Parameters.
  • Field Name: routeFilterName
  • Type: ["String", "Null"]
  • Target: device/cucm/RouteFilter
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Calling Line ID Presentation Cisco Unified Communications Manager uses calling line ID presentation (CLIP/CLIR) as a supplementary service to allow or restrict the originating caller phone number on a call-by-call basis. Choose whether you want the Cisco Unified Communications Manager to allow or restrict the display of the calling party phone number on the called party phone display for this hunt pilot. Choose Default if you do not want to change calling line ID presentation. Choose Allowed if you want your system to allow the display of the calling number. Choose Restricted if you want your system to block the display of the calling number. Default: Default
  • Field Name: callingLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Calling Name Presentation Cisco Unified Communications Manager uses calling name presentation (CNIP/CNIR) as a supplementary service to allow or restrict the originating caller name on a call-by-call basis. Choose whether you want the your system to allow or restrict the display of the calling party name on the called party phone display for this hunt pilot. Choose Default if you do not want to change calling name presentation. Choose Allowed if you want your system to display the calling name information. Choose Restricted if you want your system to block the display of the calling name information. Default: Default
  • Field Name: callingNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Line ID Presentation Cisco Unified Communications Manager uses connected line ID presentation (COLP/COLR) as a supplementary service to allow or restrict the called party phone number on a call-by-call basis. Choose whether you want Cisco Unified Communications Manager to allow or restrict the display of the connected party phone number on the calling party phone display for this hunt pilot. Choose Default if you do not want to change the connected line ID presentation. Choose Allowed if you want to display the connected party phone number. Choose Restricted if you want Cisco Unified Communications Manager to block the display of the connected party phone number. If a call that originates from an IP phone on your system encounters a device, such as a trunk, gateway, or route pattern, that has the Connected Line ID Presentation set to Default, the presentation value is automatically set to Allowed. Default: Default
  • Field Name: connectedLinePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
Connected Name Presentation Cisco Unified Communications Manager uses connected name presentation (CONP/CONR) as a supplementary service to allow or restrict the called party name on a call-by-call basis. Choose whether you want your system to allow or restrict the display of the connected party name on the calling party phone display for this hunt pilot. Choose Default if you do not want to change the connected name presentation. Choose Allowed if you want to display the connected party name. Choose Restricted if you want your system to block the display of the connected party name. Default: Default
  • Field Name: connectedNamePresentationBit
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Default", "Allowed", "Restricted"]
MLPP Precedence Choose an MLPP precedence setting for this hunt pilot from the drop-down list box: Executive Override—Highest precedence setting for MLPP calls. Flash Override—Second highest precedence setting for MLPP calls. Flash—Third highest precedence setting for MLPP calls. Immediate—Fourth highest precedence setting for MLPP calls. Priority—Fifth highest precedence setting for MLPP calls. Routine—Lowest precedence setting for MLPP calls. Default—Does not override the incoming precedence level but rather lets it pass unchanged. Default: Default
  • Field Name: patternPrecedence
  • Type: String
  • Cardinality: [0..1]
  • Default: Default
  • MaxLength: 1024
  • Choices: ["Flash Override", "Flash", "Immediate", "Priority", "Routine", "Default", "Executive Override"]
Provide Outside Dial Tone Provide Outside Dial Tone indicates that Cisco Unified Communications Manager routes the calls off the local network. Check this check box for each hunt pilot that routes the call off the local network and provides outside dial tone to the calling device. To route the call in the network, leave the check box unchecked. Default: True
  • Field Name: provideOutsideDialtone
  • Type: Boolean
  • Cardinality: [0..1]
  • Default: True
Calling Party Numbering Plan Choose the format for the numbering plan in calling party directory numbers. Cisco Unified Communications Manager sets the calling DN numbering plan. We recommend 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 your system 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 number. Choose one of the following options: Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager 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. Default: Cisco CallManager
  • Field Name: callingPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • MaxLength: 1024
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Calling Party Number Type Choose the format for the number type in calling party directory numbers. Cisco Unified Communications Manager 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 your system 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 a non-national numbering plan type. Choose one of the following options: Cisco Unified Communications Manager—The Cisco Unified Communications Manager sets the directory number type. Unknown—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 dialing a subscriber by using a shortened subscriber number. Default: Cisco CallManager
  • Field Name: callingPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • MaxLength: 1024
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Called Party Numbering Plan Choose the format for the numbering plan in called party directory numbers. Cisco Unified Communications Manager 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 your system 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 number. Choose one of the following options: Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager 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. Default: Cisco CallManager
  • Field Name: calledPartyNumberingPlan
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • MaxLength: 1024
  • Choices: ["Cisco CallManager", "ISDN", "National Standard", "Private", "Unknown"]
Called Party Number Type Choose the format for the number type in called party directory numbers. Cisco Unified Communications Manager 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 your system 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 a non-national type numbering plan. Choose one of the following options: Cisco Unified Communications Manager—Use when the Cisco Unified Communications Manager 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 dialing a subscriber by using a shortened subscriber number. Default: Cisco CallManager
  • Field Name: calledPartyNumberType
  • Type: String
  • Cardinality: [0..1]
  • Default: Cisco CallManager
  • MaxLength: 1024
  • Choices: ["Cisco CallManager", "Unknown", "National", "International", "Subscriber"]
Hunt List * Choose the hunt list for which you are adding a hunt pilot from the drop-down list box. After you choose a hunt list, click the Edit link to the right to edit the hunt list.
  • Field Name: huntListName
  • Type: String
  • Target: device/cucm/HuntList
  • Target attr: name
  • Cardinality: [1..1]
  • MaxLength: 1024
  • Format: uri
Park Mon Forward No Retrieve
  • Field Name: parkMonForwardNoRetrieve
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Use Personal Preferences
  • Field Name: parkMonForwardNoRetrieve.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
Destination
  • Field Name: parkMonForwardNoRetrieve.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Calling Search Space No Retrieve External
  • Field Name: parkMonForwardNoRetrieve.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Alerting Name Enter an alerting name for the hunt pilot in UNICODE format. This name gets displayed on phones that the hunt pilot dials when it receives an incoming call, along with calling party information. The phone users can use this information to answer the call accordingly. This name also gets displayed on the calling phone. If you do not enter a name, the hunt pilot DN displays on the phones.
  • Field Name: alertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
ASCII Alerting Name Enter an alerting name for the hunt pilot in ASCII format. This name gets displayed on phones that the hunt pilot dials when it receives an incoming call, along with calling party information. The phone users can use this information to answer the call accordingly. This name also gets displayed on the calling phone. If you do not enter a name, the hunt pilot DN displays on the phones.
  • Field Name: asciiAlertingName
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 32
External Number Mask Enter an external number mask value for the hunt pilot. Cisco Unified Communications Manager uses this mask to format calling line identification for external (outbound) calls. When AAR initiates a reroute, the system applies this external number mask to the hunt pilot number to form a fully qualified DN of the called party, which allows AAR to reroute properly in out-of-bandwidth conditions.
  • Field Name: e164Mask
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
AAR Group Choose an Automated Alternate Routing (AAR) group from the drop-down list box.
  • Field Name: aarNeighborhoodName
  • Type: ["String", "Null"]
  • Target: device/cucm/AarGroup
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Forward Hunt No Answer
  • Field Name: forwardHuntNoAnswer
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Use Personal Preferences
  • Field Name: forwardHuntNoAnswer.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
CFNA Destination When a call that was routed via the hunt list is parked, the Hunt Pilot Park Monitoring Forward No Retrieve Destination parameter value is used (unless it is blank) to forward the parked call when the service parameter Park Monitoring Forward No Retrieve Timer expires. If the parameter value of the Hunt Pilot Park Monitoring Forward No Retrieve Destination parameter is blank, then the call will be forwarded to the destination configured in the Directory Number Configuration window when the Park Monitoring Forward No Retrieve Timer expires. Specify the following values: Destination—This setting specifies the directory number to which a parked call is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. Calling Search Space—A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call.
  • Field Name: forwardHuntNoAnswer.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
CSS CFNA
  • Field Name: forwardHuntNoAnswer.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Forward Hunt Busy
  • Field Name: forwardHuntBusy
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Use Personal Preferences
  • Field Name: forwardHuntBusy.usePersonalPreferences
  • Type: Boolean
  • Cardinality: [0..1]
CFB Destination
  • Field Name: forwardHuntBusy.destination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
CSS CFB
  • Field Name: forwardHuntBusy.callingSearchSpaceName
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Call Pickup Group Choose the number that can be dialed to answer calls to this directory number (in the specified partition). Note    The Call Pickup Group setting has been moved to this section from the Forward settings section.
  • Field Name: callPickupGroupName
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 1024
Maximum Hunt Timer Value "-1" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.
  • Field Name: maxHuntduration
  • Type: ["Integer", "Null"]
  • Cardinality: [0..1]
Block this pattern Default: No Error
  • Field Name: releaseClause
  • Type: String
  • Cardinality: [0..1]
  • Default: No Error
  • MaxLength: 1024
  • Choices: ["No Error", "Unallocated Number", "Call Rejected", "Number Changed", "Invalid Number Format", "Precedence Level Exceeded"]
Display Line Group Member DN as Connected Party Check this check box to display the directory number of the answering phone as the connected party when a call is routed through a hunt list. Uncheck this check box to display the hunt pilot number as the connected party when a call is routed through a hunt list.
  • Field Name: displayConnectedNumber
  • Type: Boolean
  • Cardinality: [0..1]
Queue Calls
  • Field Name: queueCalls
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Maximum Number of Callers Allowed in Queue * Enter an integer value for the number of callers allowed in the queue for this hunt pilot. The default value is 32. The field range is from 1 to 100. When the maximum number of callers in queue has been reached, and if subsequent calls need to be disconnected, select the “Disconnect the call” radio button. When the maximum number of callers in queue has been reached, and if subsequent calls need to be routed to a secondary destination, select the “Route the call to this destination” radio button. Provide a specific device DN, shared line DN, or another Hunt Pilot DN. You may also select the “Full Queue Calling Search Space” from the drop-down list (optional).
  • Field Name: queueCalls.maxCallersInQueue
  • Type: Integer
  • Cardinality: [1..1]
Queue Full Destination
  • Field Name: queueCalls.queueFullDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Full Queue Calling Search Space
  • Field Name: queueCalls.callingSearchSpacePilotQueueFull
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Maximum Wait Time in Queue * Enter an integer value to set the maximum wait time, in seconds, in a queue. The default value is 900 seconds. The field range is from 10 to 3600 seconds. When the maximum wait time in queue has been reached, and if the queued caller needs to be disconnected, select the “Disconnect the call” radio button. When the maximum wait time in queue has been reached, and if the queued caller needs to be routed to a secondary destination, select the “Route the call to this destination” radio button. Provide a specific device DN, shared line DN, or another Hunt Pilot DN. You may also select the “Maximum Wait Time Calling Search Space” from the drop-down list (optional).
  • Field Name: queueCalls.maxWaitTimeInQueue
  • Type: Integer
  • Cardinality: [1..1]
Max Wait Time Destination
  • Field Name: queueCalls.maxWaitTimeDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
Maximum Wait Time Calling Search Space
  • Field Name: queueCalls.callingSearchSpaceMaxWaitTime
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
No Agent Destination
  • Field Name: queueCalls.noAgentDestination
  • Type: ["String", "Null"]
  • Cardinality: [0..1]
  • MaxLength: 50
No hunt members logged in or registered Calling Search Space
  • Field Name: queueCalls.callingSearchSpaceNoAgent
  • Type: ["String", "Null"]
  • Target: device/cucm/Css
  • Target attr: name
  • Cardinality: [0..1]
  • Format: uri
Network Hold MOH Source & Announcements
  • Field Name: queueCalls.networkHoldMohAudioSourceID
  • Type: ["String", "Null", "Integer"]
  • Target: device/cucm/MohAudioSource
  • Target attr: sourceId
  • Cardinality: [0..1]
  • Format: uri
Hunt List
  • Field Name: HuntList
  • Type: Object
Description Enter a description to help you identify further details about the hunt list that do not fit into the name.
  • Field Name: HuntList.description
  • Type: String
  • Cardinality: [0..1]
  • MaxLength: 1024
Cisco Unified Communications Manager Group * Choose a Cisco Unified Communications Manager Group from the drop-down list. The Hunt List registers to the first node in the Cisco Unified Communications Manager Group. Note    If you choose a Cisco Unified Communications Manager group that has only one node that is configured, you receive a warning. To avoid this issue, choose a group that is configured with more than one node.
  • Field Name: HuntList.callManagerGroupName
  • Type: ["String", "Null"]
  • Target: device/cucm/CallManagerGroup
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Enable this Hunt List (change effective on Save; no reset required) Check this check box to enable your hunt list immediately when you click Save. No system reset is required.
  • Field Name: HuntList.routeListEnabled
  • Type: Boolean
  • Cardinality: [0..1]
For Voice Mail Usage If this hunt list is to be used for voicemail, check this check box. If you this check box, the route list control process keeps a count of the setups that are being served to the hunt list, and will not allow more setups than the number of available devices. As a result, each device in the hunt list is treated as if it has a Busy Trigger and related Maximum Number of Calls of one.
  • Field Name: HuntList.voiceMailUsage
  • Type: Boolean
  • Cardinality: [0..1]
Members
  • Field Name: members
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
Line Group Name *
  • Field Name: HuntList.members.member.[n].lineGroupName
  • Type: ["String", "Null"]
  • Cardinality: [1..1]
Selection Order
  • Field Name: HuntList.members.member.[n].selectionOrder
  • Type: Integer
  • Cardinality: [1..1]
Name * The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure each hunt list name is unique to the route plan. Note    Use concise and descriptive names for your hunt lists. The CompanynameLocationCalltype format provides enough detail and is short enough so you can easily identify a hunt list.
  • Field Name: HuntList.name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 1024
Line Group
  • Field Name: LineGroup.[n]
  • Type: Array
Distribution Algorithm * Choose a distribution algorithm, which applies at the line-group level, from the options in the drop-down list box: Top Down—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Circular—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the (n+1)th member of a route group, where the nth member is the next sequential member in the list who is either idle or busy but not "down." If the nth member is the last member of a route group, Cisco Unified Communications Manager distributes a call starting from the top of the route group. Longest Idle Time—If you choose this distribution algorithm, Cisco Unified Communications Manager only distributes a call to idle members, starting from the longest idle member to the least idle member of a line group. Broadcast—If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to all idle or available members of a line group simultaneously. See the Note in the description of the Selected DN/Route Partition field for additional limitations in using the Broadcast distribution algorithm. The default value specifies Longest Idle Time. Default: Longest Idle Time
  • Field Name: HuntList.LineGroup.[n].distributionAlgorithm
  • Type: String
  • Cardinality: [1..1]
  • Default: Longest Idle Time
  • MaxLength: 1024
  • Choices: ["Top Down", "Circular", "Longest Idle Time", "Broadcast"]
RNA Reversion Timeout * Enter a time, in seconds, after which Cisco Unified Communications Manager will distribute a call to the next available or idle member of this line group or to the next line group if the call is not answered and if the first hunt option, Try next member; then, try next group in Hunt List, is chosen. The RNA Reversion Timeout applies at the line-group level to all members. Default: 10
  • Field Name: HuntList.LineGroup.[n].rnaReversionTimeOut
  • Type: Integer
  • Cardinality: [1..1]
  • Default: 10
No Answer * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that does not answer. This option gets applied at the member level. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group when the RNA reversion timeout value elapses for the first member. Cisco Unified Communications Manager then proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first member of this line group and the member does not answer the call. Default: Try next member; then, try next group in Hunt List
  • Field Name: HuntList.LineGroup.[n].huntAlgorithmNoAnswer
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • MaxLength: 1024
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Busy * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is busy. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering a busy member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first busy member of this line group. Default: Try next member; then, try next group in Hunt List
  • Field Name: HuntList.LineGroup.[n].huntAlgorithmBusy
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • MaxLength: 1024
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Not Available * For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is not available. The Not Available condition occurs when none of the phones that are associated with the DN in question is registered. Not Available also occurs when extension mobility is in use and the DN/user is not logged in. Choose from the options in the drop-down list box: Try next member; then, try next group in Hunt List—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. Try next member, but do not go to next group—If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. Skip remaining members, and go directly to next group—If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering the first unavailable member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. Stop hunting—If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first unavailable member of this line group. Default: Try next member; then, try next group in Hunt List
  • Field Name: HuntList.LineGroup.[n].huntAlgorithmNotAvailable
  • Type: String
  • Cardinality: [1..1]
  • Default: Try next member; then, try next group in Hunt List
  • MaxLength: 1024
  • Choices: ["Try next member; then, try next group in Hunt List", "Try next member, but do not go to next group", "Skip remaining members, and go directly to next group", "Stop hunting"]
Members
  • Field Name: members
  • Type: ["Object", "Null"]
  • Cardinality: [0..1]
Member
  • Field Name: member.[n]
  • Type: Array
Line Selection Order
  • Field Name: HuntList.LineGroup.[n].members.member.[n].lineSelectionOrder
  • Type: Integer
  • Cardinality: [1..1]
Directory Number The uuid attribute is read here
  • Field Name: directoryNumber
  • Type: ["Object", "Null"]
  • Cardinality: [1..1]
Directory Number Contains * Enter the character(s) that are found in the directory number that you are seeking and click the Find button. Directory numbers that match the character(s) that you entered display in the Available DN/Route Partition box.
  • Field Name: HuntList.LineGroup.[n].members.member.[n].directoryNumber.pattern
  • Type: String
  • Target: device/cucm/Line
  • Target attr: pattern
  • Cardinality: [1..1]
  • Format: uri
Partition * Choose a route partition for this line group from the drop-down list box. The default value specifies <None>. If you click Find, the Available DN/Route Partition list box displays all DNs that belong to the chosen partition.
  • Field Name: HuntList.LineGroup.[n].members.member.[n].directoryNumber.routePartitionName
  • Type: ["String", "Null"]
  • Target: device/cucm/RoutePartition
  • Target attr: name
  • Cardinality: [1..1]
  • Format: uri
Line Group Name * Enter a name for this line group. The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure that each line group name is unique to the route plan. Timesaver    Use concise and descriptive names for your line groups. The CompanynameLocationGroup format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a line group. For example, CiscoDallasAA1 identifies a Cisco Access Analog line group for the Cisco office in Dallas.
  • Field Name: HuntList.LineGroup.[n].name
  • Type: String
  • Cardinality: [1..1]
  • MaxLength: 1024
Automatically Logout Hunt Member on No Answer If this check box is checked, line members will be logged off the hunt list automatically. Line members can log back in using the "HLOG" softkey or PLK.
  • Field Name: HuntList.LineGroup.[n].autoLogOffHunt
  • Type: Boolean
  • Cardinality: [0..1]
Extended Data
  • Field Name: extendedData
  • Type: Object
name
  • Field Name: extendedData.name
  • Type: String
  • MaxLength: 1024
Hierarchy execute at this HN
  • Field Name: extendedData.executeHn
  • Type: String
  • MaxLength: 1024
HG Hierarchy HG HIerarchy
  • Field Name: extendedData.HgHnType
  • Type: String
  • MaxLength: 1024
Member Line Search Scope of search for member lines Default: Local
  • Field Name: extendedData.lineSearchScope
  • Type: String
  • Default: Local
  • MaxLength: 1024
  • Choices: ["Local", "IncludeOtherSites"]
Include Remote Site members in Line Search Scope of search for member lines
  • Field Name: extendedData.lineSearchScopeBool
  • Type: Boolean
Remote Site members exist remote members exist
  • Field Name: extendedData.remoteSiteMembers
  • Type: String
  • MaxLength: 1024
Hierarchy Node Type current HN type
  • Field Name: extendedData.hnNodeType
  • Type: String
  • MaxLength: 1024
Network Device
  • Field Name: networkDevice
  • Type: Object
Network Device Select the network device for which you would like to add this element.
  • Field Name: networkDevice.nd
  • Type: String
  • MaxLength: 1024
  • Choices: [" "]
Hf
  • Field Name: HF
  • Type: Object
Name
  • Field Name: HF.name
  • Type: String
  • MaxLength: 1024
Queue Calls
  • Field Name: HF.queue_calls_checkbox
  • Type: Boolean
Forward Hunt No Answer Action
  • Field Name: HF.cfna_action
  • Type: String
  • MaxLength: 1024
  • Choices: ["Do Not Forward Unanswered Calls", "Use Forward Settings of Device that Forwarded to Hunt Pilot", "Forward Unanswered Calls to Destination"]
Forward Hunt Busy Action
  • Field Name: HF.cfb_action
  • Type: String
  • MaxLength: 1024
  • Choices: ["Do Not Forward Busy Calls", "Use Forward Settings of Device that Forwarded to Hunt Pilot", "Forward Busy Calls to Destination"]