A site dial plan cannot be created until a customer dial plan is created for the customer. There are attributes that are defined in the customer dial plan that are needed when creating a site dial plan.

A site dial plan does not get created automatically for a site when a site is created. Perform this procedure to associate a site dial plan with the site. After the first site for a specific customer is deployed, the customer-level dial plan elements are provisioned on Cisco Unified Communications Manager (Unified CM), followed by the site-specific dial plan elements. Each subsequent site only has site-specific dial plan elements to provision, so it takes less time to create. If there is more than one site for a customer, do not forget to apply the site dial plan to each site.

Update a Site Dial Plan

For the Cisco Type 1-4 dial plans, area code changes result in the affected local dialing translation patterns getting reapplied for the site. For new area codes, new translation patterns are deployed to the site based on the country dial plan schema associated with the site. Any translation patterns related to deleted area codes are undeployed from Cisco Unified CM based on the site's country dial plan schema. For updated area codes, related translation patterns are undeployed from Cisco Unified CM, then new translation patterns based on the updated area codes are deployed.

For the Cisco Type 1-4 dial plan schema groups, area code changes generate LBO IOS area code events. If you change the area code for a site associated with one or more Local SIP Gateways, area code IOS commands are generated. If an area code is:

If you changed the Published Number, the following site defaults are updated if they used the previous Published Number:

If you changed the Published Number, then Phone Line Masks, Device Profiles, and Remote Destination Profiles that use the previous Published Number are updated. Any Phone Line Masks, Device Profiles, and Remote Destination Profiles that use a number other than the previous Published Number are not updated.

If you changed the Published Number, previously generated E164 IOS commands for a SIP Local Gateway associated with the site are automatically regenerated.

If you have configured a Type 1 - 4 dial plan, two calling party transformations are created automatically with the Emergency Call Back Number. Changing the Emergency Call Back Number updates the calling party mask in these calling party transformation patterns if it used the previous Emergency Call Back Number:

These calling party transformation patterns insert the Emergency Call Back Number as the caller ID for any emergency calls placed from phones within the site.

Model Details

Field	Description
Area Code	An area code associated with the site.
Local Number Length	The length of a locally dialed number for the specified area code.
Area Code Used for Local Dialing	Select this check box if the area code is included in locally dialed calls.
Published Number	The site published number is the default E.164 mask when a line is associated to a phone at a particular site.
Emergency Call Back Number	The site emergency call-back number is the calling number when initiating an outgoing emergency call.

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

Site name *

Default: {{ macro.HcsDpSiteName }}

Field Name: siteName
Type: String
Target: data/BaseSiteDAT
Target attr: SiteName
Default: {{ macro.HcsDpSiteName }}
MaxLength: 1024
Format: uri

Customer

Specify the customer that owns this site Default: {{ macro.HcsDpCustomerName }}

Field Name: custName
Type: String
Target: data/BaseCustomerDAT
Target attr: CustomerName
Default: {{ macro.HcsDpCustomerName }}
MaxLength: 1024
Format: uri

External breakout number

The external breakout number for the country associated with this site.

Field Name: ext
Type: String
MaxLength: 1
Pattern: ^$|^[0-9]*$

Site location code

Site location code can have a maximum of 8 digits.

Field Name: slc
Type: String
MaxLength: 8
Pattern: ^$|^[0-9]+$

Extension length *

Extensions can be from 1 to 30 digits in length. Default: 4

Field Name: extLen
Type: String
Default: 4
MaxLength: 2
Pattern: ^([1-9]|[12][0-9]|[3][0])$

Extension prefix required?

Indicates that this site will use the extension prefix as specified in the customer dial plan. If the extension prefix is not specified in the customer dial plan, this setting has no effect. Default: false

Field Name: extPrefixReq
Type: Boolean
Default: false

Area Codes

Specify one or more area codes for this site.

Field Name: areaCodeArray.[n]
Type: Array

Area Code *

An area code associated with this site.

Field Name: areaCodeArray.[n].areaCode
Type: String
MaxLength: 8
Pattern: ^[0-9#*]+$

Local Number Length *

Length of the local numbers associated with this area code.

Field Name: areaCodeArray.[n].locNumLen
Type: String
MaxLength: 2

Area Code Used for Local Dialing

Indicates whether area code is needed for local dialing.

Field Name: areaCodeInLocalDialing
Type: Boolean

Published number

The site published number is the default E164 mask when a line is associated to a phone, device profile, or remote destination profile at a particular site. The default CUCM phone line E164 mask, default CUCM device profile line E164 mask, and the default CUCM remote destination profile line E164 mask in the site default doc are updated with this number, unless those default values in the site defaults doc have been manually updated to some other number. Furthermore, if any existing subscribers are using the site published number in their phone line E164 mask, device profile line E164 mask, or remote destination profile line E164 mask, that value is updated as well.

Field Name: pubNumber
Type: String
MaxLength: 1024
Pattern: ^$|^(\\\+)?[0-9]+$|^\+?[0-9]+$

Emergency number

The site emergency callback number is the calling number when initiating an outgoing emergency call. If you change the emergency callback number, the following calling party transformation patterns are updated to use the new value: *{{ macro.HcsDpSiteId}}*! and *{{ macro.HcsDpSiteId}}*\+!

Field Name: emerNumber
Type: String
MaxLength: 1024
Pattern: ^$|^(\\\+)?[0-9]+$|^\+?[0-9]+$

Site ID *

Unique ID for this site Default: {{ macro.HcsDpSiteId }}

Field Name: siteId
Type: String
Default: {{ macro.HcsDpSiteId }}
MaxLength: 1024

Site Active

Enable to activate the site. Default: false

Field Name: active
Type: Boolean
Default: false

Site-Location Code (SLC) Based Dial Plan *

Indicates whether or not Site Location Code is required for this customer. This value for this field taken from Customer Dial Plan model. Default: {{ data.DpCustomer.slcBased }}

Field Name: slcBased
Type: Boolean
Default: {{ data.DpCustomer.slcBased }}

Debug Info

Used to store store debug info and on-screen help information. Default: Default debug info

Field Name: debug
Type: String
Default: Default debug info
MaxLength: 1024

Use DDI for emergency calls

Use DDI for emergency calls when user is at home location

Field Name: createEmerPattern
Type: Boolean

Shadow

Field Name: shadow.[n]
Type: Array
Cardinality: [0..1]

Name *

Field Name: shadow.[n].name
Type: String
MaxLength: 1024

Model: relation/HcsDpManageSiteREL

Create a Site Dial Plan

Update a Site Dial Plan

Model Details