Site Dial Plan#
Overview#
A site can be associated with only one dial plan.
A Cisco HCS site dial plan is not automatically created for a site when the site is created. Instead, once the first site is deployed for a specified customer, the customer-level dial plan elements are provisioned on Cisco Unified Communications Manager (CUCM), followed by the site-specific, Cisco HCS dial plan elements. Each subsequent site takes less time to create as they have only site-specific dial plan elements to provision.
For customers with two or more sites, the site dial plan must be applied to each site.
Only one site dial plan can be added at a time against a specific CUCM. Parallel transactions are disallowed. When adding a site dial plan, its transaction workflow acquires a lock that prevents a parallel transaction for adding another site dial plan from completing. The lock value is unique per CUCM.
If you try adding another site dial plan while a transaction is in progress for the first one you added, the transaction for the second dial plan starts and is in progress for 3 minutes, trying to acquire the lock. If it cannot acquire the lock, the second transaction fails with this message:
Failed to Add Cisco HCS Site Dial Plan, a Site Dial Plan is currently being added for this Unified CM, please wait for that transaction to complete, or wait 15mins for the lock to auto expire in the case that a failed transaction did not release the lock automatically
If the first transaction fails, the lock is set to auto-expire after 15 minutes.
Add a Cisco HCS Site Dial Plan#
This procedure creates a Cisco HCS site dial plan and associates the dial plan with a site.
Pre-requisites:
Create the customer dial plan. See Customer Dial Plan
You can only create a site dial plan once the customer dial plan exists because there are attributes defined in the customer dial plan that are required when the site dial plan is created.
To add a site dial plan:
Log in to the Automate Admin portal as a Provider administrator or Customer administrator.
Note
For details around tasks that can be performed for each admin level, see Dial Plan Roles and Privileges.
Go to (default menus) Cisco Dial Plan Management > Site > Dial Plan, then view existing site dial plans in the list view.
Click the Plus icon (+) to add a new site dial plan; then, select the site.
On the Dial Plan / New Record page, configure the dial plan. The table describes the configuration options:
Field
Configuration
External Breakout Number
Fill out the one digit external breakout number for the country associated with the site.
The external breakout number is the PSTN prefix that is used when deploying a country dial plan. The default is 9. For Cisco HCS Type 1 to 4 dial plan schemas, country dial plans are deployed at the Customer level.
The country dial plan is pushed to CUCM once the first site associated with a given country is deployed. For example, if a site is associated with the United States (USA), and it is the first site dial plan being created for the USA, the USA country dial plan is deployed as part of creating the site’s dial plan.
Automate supports only one external breakout number for each country. For example, all sites within the USA have the same external breakout as the first site within the USA.
Use extension prefix
Defines, for sites without Inter-Site Prefixes (ISPs), whether this dial plan uses the extension prefix from the customer dial plan.
Displays only if your customer dial plan does NOT use ISPs, for example, HCS Type 3 dial plans (SLC, no ISP, DN=SLC+EXT).
When enabled, this setting is applied ONLY if there is an extension prefix defined in the customer dial plan.
Area Codes
Click the Plus icon (+) to add valid local area codes for the site, if required.
For each area code you add:
Fill out the area code.
Specify the length of the subscriber part of the PSTN number.
Note
The area code is used to generate the PSTN local route patterns for the site. For example, in the USA, if area codes are added for Dallas, Texas, the area codes could be specified for local dialing as 214, 469, and 972, with a subscriber length of 7.
The Local Number Length field defines the length for the subscriber section of the entire E.164 number.
Field
Configuration
Site Location Code
Displays only when the customer dial plan uses site location codes.
Fill out the site location code (SLC). The maximum number of digits is 8.
The SLC must be unique across sites for a customer.
Extension Length
Fill out the number of digits for the extension (between 1 and 30 digits).
Area Code Used for Local Dialing
Defines whether the area code is required for local dialing from this site.
Note
In the USA, this setting defines whether you use 7-digit or 10-digit local dialing.
Published number
Select from the available E.164 inventory numbers, or fill out a custom number.
Note
The site published number is the default E.164 mask when a line is associated to a phone at a particular site.
Field
Configuration
Emergency Call Back Number
Select from the available E.164 inventory numbers, or fill out a custom number.
Note
Site emergency call-back number is the calling number when initiating an outgoing emergency call. It can be used when you use Extension Mobility and make an emergency call from a site other than your own. It can be used when the emergency call goes out to the PSTN network, when the system includes the site emergency number so that the origin of the call is known.
The system adds this calling party transformation to the DN2DDI4Emer-PT partition.
The emergency call back number is not the number to dial for an emergency. Instead, it is the number used to identify the calling party for emergency calls originating from a particular site.
Use DDI for emergency calls
Define whether to use DDI for emergency calls when user is at home location.
Site ID
A read-only field that displays a unique, auto generated number for each customer site, which is prefixed to elements as an identifier (for example, Cu4Si2 indicates Customer 4, Site 2).
Click Save.
View transaction progress and details in the Transaction Logs.
The new site dial plan is added. The system takes a few minutes to provision the site dial plan, especially for the first site. The site information is loaded on CUCM, and is identifiable by its Customer ID, Site ID prefix.
Related Topics
Update a Cisco HCS Site Dial Plan#
This procedure updates a Cisco HCS site dial plan.
Log in as the Provider, Reseller, or Customer administrator.
Set the hierarchy path to the site where you want to update the dial plan.
Go to (default menus) Cisco Dial Plan Management > Site > Dial Plan.
In the list view, click on the site dial plan where you want to make changes.
On the Dial Plan page, you can update the following:
Field
Description
Area Code
You can modify or delete existing area codes, or add new area codes.
Local Number Length
The length of a locally dialed number for the specified area code.
Area Code Used for Local Dialing
Defines whether 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.
Click Save.
View transaction progress and details in the Transaction Logs.
Related Topics
Area Code Changes in Cisco HCS Site Dial Plans#
For the Cisco Type 1-4 dial plans, area code changes result in the affected local dialing translation patterns getting reapplied for the site:
When adding new area codes |
New translation patterns are deployed to the site, based on the country dial plan schema associated with the site. |
When deleting area codes |
Related translation patterns are un-deployed from CUCM, based on the country dial plan schema associated with the site. |
When modifying area codes |
Related translation patterns are un-deployed from CUCM, and new translation patterns are deployed, based on the updated area codes. |
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:
When adding an area code |
The area code add IOS command is generated. |
When deleting an area code |
The area code delete IOS command is generated if no other sites associated with the same SIP Local Gateway are using the deleted area code. If another site still references the same gateway’s area code, the delete area code IOS command is not generated. This prevents invalidating the other site’s local dialing behavior. |
When updating an area code |
The area code delete and add IOS commands are generated as necessary, based on the added and deleted logic. |
Published Number Changes in Cisco HCS Site Dial Plans#
When changing an existing published number in a Cisco HCS site dial plan:
The following site defaults are updated, if they were using the published number you changed:
Default CUCM Phone Line E164 Mask
Default CUCM Device Profile Line E164 Mask
Line E164 Mask
Updates any phone line masks, device profiles, and remote destination profiles that were using the published number you changed.
Automatically regenerates previously generated E164 IOS commands for a SIP Local Gateway associated with the site.
Emergency Call Back Number Changes in Cisco HCS Site Dial Plans#
When updating a Cisco HCS site dial plan and you have a Type 1 - 4 dial plan configured, 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:
"{{ macro.HcsDpSiteId}}!"
"{{ macro.HcsDpSiteId}}\+!"
If the calling party mask has been manually changed, the fields are untouched.
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.
Next Steps
Apply any generated or regenerated IOS commands to your IOS gateway.