[Index]

Model: relation/HcsDpManageSiteREL

HCS Site Dial Plan

Full HTML Help

PROVIDER ONLY

CISCO

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:

To add a site dial plan:

  1. 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 Cisco Hosted Collaboration Solution Roles and Privileges.

  2. Go to (default menus) Cisco Dial Plan Management > Site > Dial Plan, then view existing site dial plans in the list view.

  3. Click the Plus icon (+) to add a new site dial plan; then, select the site.

  4. 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.
    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.
    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).

  5. 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

Transaction Logging and Audit in the Core Feature Guide

Update a Cisco HCS Site Dial Plan

PROVIDER ONLY

CISCO

This procedure updates a Cisco HCS site dial plan.

  1. Log in as the Provider, Reseller, or Customer administrator.

  2. Set the hierarchy path to the site where you want to update the dial plan.

  3. Go to (default menus) Cisco Dial Plan Management > Site > Dial Plan.

  4. In the list view, click on the site dial plan where you want to make changes.

  5. 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.

  6. Click Save.

    View transaction progress and details in the Transaction Logs.

Related Topics

Transaction Logging and Audit in the Core Feature Guide

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:

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:

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.

Create a Site Dial Plan

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

This procedure creates a site dial plan and associates the dial plan with a site.

Note

Before you start:

To add a site dial plan:

  1. Log in to the VOSS Automate Admin portal as a Provider administrator or Customer administrator.

    Note

    For details around tasks that can be performed for each admin level, see Cisco Hosted Collaboration Solution Roles and Privileges.

  2. Go to (default menus) Dial Plan Management > Site > Dial Plan. The Dial Plan list view displays existing dial site plans.

  3. Click the Plus icon (+) to add a new site dial plan; then, select the site.

  4. On the Dial Plan / New Record page, configure the dial plan:

    Note

    This field 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.

    Note

    The read-only Site ID field 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).

  5. Click Save.

    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.

Updating Site Dial Plans (Provider deployment)

Update a Site Dial Plan

This procedure updates a Cisco HCS dial plan for a site.

Note

Relevant for a Provider deployment only.

  1. Log in as the Provider, Reseller, or Customer administrator.

  2. Set the hierarchy path to the site where you want to update the dial plan.

  3. Go to (default menus) Dial Plan Management > Site > Dial Plan.

  4. In the list view, click on the site dial plan where you want to make changes.

  5. 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.

  6. Click Save.

Making Area Code Changes in 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.

Making Published Number Changes in Site Dial Plans

When changing an existing published number in a site dial plan:

Making Emergency Call Back Number Changes in Site Dial Plans

When updating a 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:

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.

Model Details: relation/HcsDpManageSiteREL

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