The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The generic leaf cluster workbook is used to provision the Unified Communications Manager. The workbook consists of the following worksheets.
The Dial Plan Model is detailed by configurable Microsoft Excel workbooks. Each spreadsheet in a Cisco HCS model workbook corresponds to the configurations of different elements within the target product (Unified Communications Manager, Cisco vPGW Softswitch, and so on), such as Unified Communications Manager partitions or Unified Communications Manager calling search spaces.
Generally, all the configuration elements detailed in the model worksheets correspond to a transaction that occurs during the provisioning workflow. Therefore you always see a transaction name associated with the elements that you are configuring to tell the system when to provision those elements.
A transaction is defined as a singular element during the provisioning life cycle for a customer or can occur multiple times, for example, when locations are added to that customer.
The Cisco HCS consists of the following standard model files. The files and directories are loaded to Cisco Unified Communications Domain Manager in the listed order.
Because there are multiple files for the Cisco HCS Dial Plan Model, there is a model configurator tool that allows the service provider or your Cisco representative to select the countries from the country dial plan and features from the Addon directory. The configurator tool then combines all the selected files in to one Excel spreadsheet.
These files are released along with the Dial Plan Model. They are loaded to Cisco Unified Communications Domain Manager using the Bulk Loader. |
||
The Dial Plan Model for Unified Communications Manager is split into several directories. The base DP model is specified in the generic leaf cluster spreadsheet. The country-specific Dial Plans are specified in the Country DP Directory. |
||
The Dial Plan Model for Cisco IOS gateways is defined in the Generic IOS spreadsheet. |
||
The Dial Plan Model for SME is defined in the Generic SME spreadsheet. |
||
The Dial Plan Model for Cisco PGW is defined in the Generic Cisco PGWmml spreadsheet. |
||
The Dial Plan Model for Cisco PGW Times Ten Database is defined in the Generic Cisco PGW Times Ten Database spreadsheet. |
The preceding directories and files are described in the following sections.
The Base Data directory consists of two files:
The Base Data files are loaded using the Bulk Loader in Unified Communications Domain Manager.
Note | Be sure that you are using the latest Bulk Loader files. Download the base data from http://software.cisco.com/download/navigator.html?mdfid. To locate the latest files for this release, navigate as follows: Downloads Home > Cisco Products > Unified Communications > Call Control > Hosted Collaboration > Cisco Hosted Collaboration Solution (HCS) > Cisco Hosted Collaboration Solution Version 10.0 > Unified Communications Domain Manager (CUCDM) Bulk Loaders>. |
When you load new base data, existing base data is not overwritten.
The Platform Specific Base Data workbook consists of the following worksheets:
This worksheet is used to specify revision history and changes made to the workbook. |
|
This worksheet is used to define all brands that are supported by the Cisco HCS deployment. |
|
This worksheet is used to define all the phone types that are supported by the Cisco HCS deployment. |
|
This worksheet is used to define all the expansion modules that are supported by the Cisco HCS deployment. |
|
This worksheet is used to associate phone types with the expansion modules that are supported by the Cisco HCS deployment. |
|
This worksheet is used to define Cisco Unified Communications Domain Manager level preferences such as time zone, auditing, banners, and so on. |
|
This worksheet is used to define the hardware set that is used in a Cisco HCS deployment. The generic hardware set (Cisco HCS-Basic) consists of: |
|
This worksheet is used to associate the hardware set to a dial plan. The generic hardware set Cisco HCS-Basic is linked to Cisco HCS Dial Plan Cisco HCS-G1. |
|
The Dial Plan Specific Base Data workbook consists of the following worksheets:
This worksheet is used to specify revision history and changes made to the workbook. |
|
This worksheet is used to define service types (Classes of Service) that can be assigned to end users. The service types are used to define outbound and call forwarding restrictions. |
|
This worksheet is used to define the Dial Plan name (Cisco HCS-G1) and number construction rules for both Unified Communications Manager and internal use for Unified Communications Domain Manager. These rules are applied globally to all the enterprises. |
|
This worksheet is used to define preferences for both the Internal and PSTN published numbers. |
|
This worksheet is used to define all the countries supported by the Cisco HCS. |
Cisco Unified Communications Domain Manager uses class of service to assign calling restrictions to an end user. The class of service is mapped by Dial Plan Model to a calling search space and partitions that are understood by Unified Communications Manager.
The classes of service in the following table are used in Unified Communications Domain Manager. These class of service types are loaded without loading the AddOn features (described later in this guide in Additional Features).
Temporary Out of Service Class of Service - Only allows emergency dialing |
||
International 24 hours Standard - Following calls are blocked: |
||
International Working Hours Enhanced - No restrictions during standard working hours |
||
International Working Hours Standard - Following calls are blocked during standard working hours: |
||
National 24 Hours Enhanced - Following calls are blocked: |
||
National 24 Hours Standard - Following calls are blocked: |
||
National 24 hours Restricted - Following calls are blocked: |
||
National Working Hours Enhanced - Following calls are blocked during standard working hours: |
||
National Working hours Standard - Following calls are blocked during standard working hours: |
||
National Working hours Restricted - Following calls are blocked during standard working hours: |
||
Local 24 hours Enhanced - Following calls are blocked: |
||
CLIRInternational24Hrs-Enhanced |
CLIRIntl24HrsEnh-CSS |
International 24 hours Enhanced - No restrictions Caller ID is not sent |
CLIRInternational24Hrs-Standard |
CLIRIntl24HrsStd-CSS |
Caller ID is not sent |
CLIRInternationalWrkHrs-Enhanced |
CLIRIntlWrkHrsEnh-CSS |
International Working Hours Enhanced - No restrictions during standard working hours Caller ID is not sent |
CLIRInternationalWrkHrs-Standard |
CLIRIntlWrkHrsStd-CSS |
International Working Hours Standard - Following calls are blocked during standard working hours: Caller ID is not sent |
CLIRIntl24Hrs-FAC |
CLIRIntl24HrsFAC-CSS |
International 24 Hours Standard - Following calls are blocked during standard working hours: Caller ID is not sent and Forced Authorization Code is required |
CLIRNational24Hrs-Enhanced |
CLIRNatl24HrsEnh-CSS |
National 24 Hours Enhanced - Following calls are blocked: |
CLIRNational24Hrs-Restricted |
CLIRNatl24HrsRst-CSS |
National 24 hours Restricted - Following calls are blocked: Caller ID is not sent |
CLIRNational24Hrs-Standard |
CLIRNatl24HrsStd-CSS |
National 24 Hours Standard - Following calls are blocked during standard working hours: Caller ID is not sent |
CLIRNationalWrkHrs-Enhanced |
CLIRNatlWrkHrsEnh-CSS |
National Working Hours Enhanced - Following calls are blocked during standard working hours: Caller ID is not sent |
CLIRNationalWrkHrs-Restricted |
CLIRNatlWrkHrsRst-CSS |
National Working hours Restricted - Following calls are blocked during standard working hours: Caller ID is not sent |
CLIRNationalWrkHrs-Standard |
CLIRNatlWrkHrsStd-CSS |
National Working hours Standard - Following calls are blocked during standard working hours: Caller ID is not sent |
CLIRNatl24Hrs-FAC |
CLIRNatl24Hrs-FAC |
Caller ID is not sent and Forced Authorization Code is required |
These classes of service map to partitions, calling service spaces, and time periods defined in an Excel spreadsheet.
The Unified Communications Manager of the leaf cluster model consists of several files and directories:
These features are not optional, but are classified as Additional because the features are available in the release but can be decoupled from the generic model, or the features are selectable as part of a deployed Dial Plan.
The following features are classified as Additional features:
Analog Line class of service (referred to as EmergencyCallsSupport for Analog Gateways)
Cisco Emergency Responder
Calling Line Identification Restriction (CLIR)
Forced Authorization Codes (FAC)
Cisco Unified Contact Center Enterprise (Unified CCE)
Redirecting, Connected, Called and Calling Transformation Support (RCC-Transformation)
Extension Mobility Cross Cluster (EMCC)
Generic SIP Trunk (GSIP-Trunk)
Forced On-Net
Cisco IP Manager Assistant (IPMA)
This document does not cover provisioning but describes the role of the feature in the Dial Plan Model.
This feature enables analog ports on H.323 and SIP gateways to be configured with a per-port calling search space when the gateway is activated. The ALineCOS directory contains all the definitions that are required to support this feature; provisioning of this feature is out of scope of this document.
The ALineCOS AddOn contains the following definitions to support this feature:
A global definition, AnalogGWCSS, in the Add Service Types of the Base Data Bulk Loader file. Assign this service type as the calling search space of the Inbound Calls of the gateway.
For each location, create a new partition, AnalogLineCOS-PT and associate it to the new calling search space, AnalogGWCSS. (This calling search space must be the same name as the service type and is hard coded as AnalogGWCSS.)
Map the calling search space to the service type with the same name.
In the COS-CSS mappings worksheet, add a new column, where a class of service code is assigned to each existing COS-CSS mapping the feature uses.
A new translation pattern, #COSCODE#.!, is added to the Translate Pattern Worksheet. Create this translation pattern in Cisco Unified Communications Manager when a user (analog line) is associated to a class of service defined above. The variable is replaced with the Analog Class Of Service Code value that is associated to the class of service and the calling search space is replaced with what is defined in the COS-CSS mapping worksheet.
Part of this feature is to support emergency dialing through analog line. For each location within a country, add the following translation pattern to the AnalogLineCOS-PT partition:
Where XX and XX#EXT# is replaced with +02<CountryCode> and the Calling Party Number is prefixed with '*#LRID#' before the translation pattern goes to the emergency routing calling search space.
In the case where Cisco Emergency Responder is used, remove only XX and XX.#EXT# before the translation pattern goes to E#ISO#CSS.
The following call flow shows how class of service is supported for each analog port that is provisioned with this feature:
Cisco Emergency Responder is specified for United States deployment where Emergency Responder is used to support enhanced emergency call handling. The following definition is added to the model to support this feature:
When a Cisco Emergency Responder server is connected:
Partition—EUS
Calling search space—EUSCSS
Partition-CSS Map—EUS and InterSiteRoutingPT partitions map to EUSCSS
Route pattern to handle Default ERL and Default OnSite number in the EUS partition
Route pattern to handle enhanced emergency calls with Calling Party Number set as the ELIN number in the EUS partition
CTI Route Point to handle 911, 912, and 913, where 912 is for fallback if 911 is unavailable and 913 is to handle callback from the PSAP
CTI Port for internal alerting
When a location is added two translation patterns, 911 and #EXT#.911 are added to the AllowEmerCalls partition of that location and the handover calling search space is set to be EUSCSS.
When a line is added to the ERL (for example ELIN) to handle callback from the PSAP through the ELIN number a translation pattern, +1<ELIN number>, is added to the E.164LookUp partition, and the handover calling search space is set to EUSCSS.
The Calling Line Identification Restriction (CLIR) setting in the model is based on the system default. In Cisco HCS, the system default should be set to Allowed. This AddOn feature enables per line calling line identification presentation setting to be restricted.
The following definition is included in the model to support this feature:
Additional service types—to set CLIR as the default for the line (for example CLIRInternational24Hrs-Enhanced, CLIRInternational24Hrs-Standard, CLIRNational24Hrs-Enhanced, CLIRNational24Hrs-Standard and also for Working Hours).
Addition to the Cisco Unified Communications Manager model—Partition, Calling Search Space, Partition-CSS Map, and COS-CSS mapping to support the preceding service type.
The following translation patterns are added to the per-country translate pattern worksheet:
The preceding translation patterns basically set the calling line to Restricted and handed over to the standard calling search space with the similar name but without CLIR prefix.
Example of a call flow for the United States:
A phone line that is associated to CLIRInternational24Hrs-Enhanced services with the CLIRIntl24Hrs-Enh-CSS dial uses the 9011[^0]![0-9#] pattern (nonemergency PSTN number), has its Calling Line Restriction set to Restricted and call processing passed to Intl24Hrs-Enh-CSS.
This feature is used to enable Forced Authorization Code (FAC) in conjunction with route patterns to restrict access to long distance and international calls for certain groups of users.
Note | FAC is supported in deployments that use Shared Instance but the Forced Authorization Codes are global in nature, and not customer-specific. |
In the Cisco HCS, add the following to the generic model for this feature:
Additional service types for FAC (for example, International24Hrs-FAC and National24Hrs-FAC)
New partitions associated to Central and Local PSTN call handling
When a provider country is added, create the following partitions to handle call handling through the aggregation: FACIntl24Hrs-<CC>, FACMobl24Hrs-<CC>, FACNatl24Hrs<CC>, and a FAC route selection partition FACRteSelPT-<CC>.
When a local gateway is added to a location, create the following partitions: FACILBO24Hrs-<CC>, FACMLBO24Hrs-<CC>, FACNLBO24Hrs-<CC>, and a LBO route selection partition FACRetSelPT-LBO.
Add the following partitions to support plus dialing: FACPlusIntl24Hrs-<CC> and FACPlusNatl24Hrs-<CC>.
Two new FAC CSS (for example, Intl24HrsFAC-CSS and Natl24HrsFAC-CSS) are added and associated with the preceding item FAC service type.
The FAC Calling Search Space contains the same partitions as its equivalent non-FAC Calling Search Space except for the following:
For Handling of International Calls, use FACIntl24Hrs-<CC> instead of AllowIntl24Hrs-<CC> and FACILBO24Hrs-<CC> instead of AllowILBO24Hr-<CC>.
For Handling of National Calls, use FACNatl24Hrs-<CC> instead of AllowNatl24Hrs-<CC> and FACNLBO24Hrs-<CC> instead of AllowNLBO24Hr-<CC>.
For Handling of Mobile Calls, use FACMobl24Hrs-<CC> instead of AllowMobl24Hrs-<CC> and FACMLBO24Hrs-<CC> instead of AllowMLBO24Hr-<CC>.
Add two additional calling search spaces to handle call routing, FACRteSelCSS-<CC> that contains the FACRteSelPT-<CC>, and FACRteSelCSS-LBO, that contains the FACRteSelPT-LBO.
For each country added by the Provider Country transaction, add the same route patterns as those defined for non-FAC, except that the FAC column is populated with the following:
The same call handling is applied to the route pattern for Local Breakout through the Location LocalGateway.
For each country that is added by the Provider Country transaction, add translation patterns to handle International, National, and Mobile calls to the appropriate FAC partitions. These translation patterns have the same characteristics as those defined for non-FAC, except that the call is handled by FACRteSelCSS-<CC>. The same is applied to the translation patterns that are added when Location LocalGateway is added.
The dial plan AddOn supports Cisco Unified Contact Center Enterprise (Unified CCE) integration with the following functions:
After Unified Communications Manager is added, a partition AllowUCCEXferPT is created. This partition contains the route patterns that are assigned to route calls to the Unified Contact Center server when one of the DNs that is assigned to the CTI route point is dialed.
Class of service for Unified Contact Center Agent Line.
Provide routing of ingress call based on the assigned Contact Center PSTN Pilot Number to Cisco Unified Border Element (Cisco UBE) from the Cisco PGW through a SBC. Only Cisco PGW routing is provisioned.
Translate the Contact Center PSTN Pilot Number associated to a local gateway of a location to an internal Pilot Number (for example Contact Center Pilot DN).
Provide routing of Internal Pilot Number (that is, Contact Center Pilot DN) to the Cisco UBE.
Provide routing of VRU number to the Cisco Unified Customer Voice Portal (Unified CVP) server.
Handling incoming call from the Unified CVP server.
Provide connection to the Unified CVP server and Cisco UBE from the Unified Communications Manager. This leverages the Generic SIP Trunk AddOn feature.
All other integration needed to support the Unified Contact Center Enterprise is out of scope of this AddOn. For more information on Unified Contact Center Enterprise, see http://www.cisco.com/en/US/products/sw/custcosw/ps1844/prod_installation_guides_list.html.
Before the Contact Center is provisioned through Unified Communications Domain Manager, you must create the SIP Connection between the Unified CVP server and Cisco UBE with the Generic SIP Trunk feature (refer to the Generic SIP Trunk (GSIP) section).
When the Contact Center Enterprise Server is connected to Unified Communications Manager by Unified Communications Domain Manager, the following dial plan is added:
On the Cisco PGW, the AddCCCIP transaction is executed, which creates a dial plan similar to ConnectIPPX but associates it to the Unified Contact Center. The route list used by this dial plan is statically configured.
On Unified Communications Manager, the following is created:
Routing of VRU number that is returned from CC-UCCE-<CCCPID>-CSS, which contains UCCE-<CCCPID>-PT with the VRU number as the route pattern to route the call to the Unified CVP through the RL-UCCE-CVP-OR-CUBESP-#CCCPID# route list. This route list and its associated route group and trunk are created through the Generic SIP Trunk feature.
Routing of Call Transfer or Conference Call from the Agent—AllowUCCEXferPT is populated with the Transfer pattern that was created by Unified Communications Domain Manager as a translation pattern with the handover calling search space set to UCCE-<CCCPID>-CSS.
When Contact Center Service is created by Unified Communications Domain Manager for Unified Communications Manager, an Internal CC Pilot Number Pattern is added to the InterSiteRoutingPT as a route pattern with route list set to RL-UCCE-CUBEE-OR-CUBESP-#CCCPID#. This is to route CC Pilot Number to the Cisco UBE.
When a location is created, the following dial plan is added:
Two classes of service for Agent Line support - National24Hrs-Standard-wCC and NationalWHrs-Standard-wCC.
Calling search spaces - Natl24HrsStdwCC-CSS, and NatlWHrsStdwCC-CSS that contains the same partitions as Natl24HrsStd-CSS and NatlWrkHrsStd-CSS respectively, with the addition of the AllowUCCEXferPT.
When Contact Center Internal Pilot number is associated with a PSTN Number, the following is added:
On Times Ten Database—Add an entry to map the PSTN number to the Unified Contact Center Enterprise server dial plan on the Cisco PGW.
On Unified Communications Manager—Add as a translation pattern, that transforms PSTN to DN with the handover calling search space set to InterSiteRoutingCSS.
On IOS gateway (H.323 and SIP)—Add as a rule in voice translation-rule 9121, 9122, and 802.
The Redirecting Connected Called (RCC) AddOn feature enables you to perform a number transformation on the redirecting, called, and connected number. Unified Communications Domain Manager uses service type to associate transformation calling search space to the outbound trunk. The following service types are defined:
ClusterW-Redirecting-Transformation
ClusterW-Connected-Transformation
ClusterW-Called-Transformation
For ClusterW-Redirecting-Transformation and ClusterW-Connected-Transformation, the following are created:
ClusterWDN2DDIMapping-CSS is associated to both service types and contains ClusterWDN2DDIMapping-PT.
For ClusterW-Called-Transformation, the following are created:
ClusterWCalledTranf-CSS, which contains ClusterWCalledTranf-PT and FMCCalledTransf-PT.
Currently FMC uses the Called Number Transformation. When Unified Communications Domain Manager executes AssociateFMC, a called number transformation pattern is added to the FMCCalledTransf-PT.
The Redirecting, Calling, Called and Connected Party Transformation CSS for the Shared Instance Dial Plan (G3) is defined in the following table:
Calling Search Space | Transformation Pattern | Partition | Description | |
---|---|---|---|---|
Calling Party Transformation |
CallingT2AggregCSS |
\+.! Multiple ! |
CallingT4CFwdCallPT CallingT4EmerCallPT ClusterWDN2DDIMapping-PT |
The Transformation Pattern is defined to use External Mask. |
Called Party Transformation |
ClusterWCalledTransf-CSS |
NULL \+.#COUNTRY##MOBILE# |
ClusterWCalledTransf-PT FMCCalledTransf-PT |
There is no transformation defined for Called Party. |
Connected Party Transformation |
ClusterWDN2DDIMapping-CSS |
! |
ClusterWDN2DDiMapping-PT |
The Transformation Pattern is defined to use External Mask. |
Redirecting Party Transformation |
ClusterWDN2DDIMapping-CSS |
! |
ClusterWDN2DDiMapping-PT |
Note | The external mask for each line is defined as the +E.164 number. |
Based on the Transformation Patterns defined in the preceding table:
The EMCC model AddOn is a small part of Extension Mobility Cross Cluster (EMCC), to ensure that emergency calls egress from the originating country where the device resides. To achieve this, the following is added to the model:
As a prerequisite, set the calling search space for PSTN Access SIP trunk to use phone's original Device Calling Search Space.
When ActiveEMCC is executed, add the following to Unified Communications Manager:
EMCC-CSS-<EMCC-CC> containing the EMCC-PT-<EMCC-CC>.
Adjunct-CSS-<EMCC-CC> containing the Adjunct-PT-<EMCC-CC>.
RL-EMCC, SLRG for route group and their associated RL-RG mapping.
SIP trunk with no destination address.
EMCC Country Emergency Number as a translation pattern in EMCC-PT-<EMCC-CC>, where EMCC Country is the home country. This translation pattern transforms the Called Emergency to a Global Generic Emergency Number, that is, +09112.
The Global Generic Emergency Number as a route pattern in the EMCC-PT-<EMCC-CC> with route list set to RL-EMCC.
Adjunct Country Emergency Number as a route pattern with Called Number Mask set to +09112 and route list set to RL-EMCC. An Adjunct Country is the Visiting Country.
Each country dial plan is enhanced to handle the Global Generic Emergency Number.
Note | This step can be added at a later date, when additional clusters are added. Cisco recommends that you conduct this step using the Cisco Unified Communications Domain Manager GUI. |
Step 1 | Go to for example select Connectivity for VS | ||
Step 2 | (For example) select Connectivity for VSC-CL1. | ||
Step 3 | Select required extra clusters, for example VSC-CL2. | ||
Step 4 | Select Connect IPPBX. | ||
Step 5 | Select Trunk Protocol = SIP, and Topology Type = Full Mesh or Star. | ||
Step 6 | Modify Trunk Descriptions, SIP Profile, Normalization Script and Script Parameters as required. | ||
Step 7 | Select Confirm. | ||
Step 8 | Monitor the
Cisco Unified Communications Domain Manager Transaction logs and Device Logs
and confirm that Cisco Unified Communications Domain Manager creates the
required InterClusterSIP trunks, Route Groups and Route Lists on each cluster.
For example, on VSC-CL1: ICT-SIP-1102, RG-IPPBX-SIP-1102, RL-IPPBX-1102 (where
1102 = CPID of VSC-CL2) on VSC-CL2: ICT-SIP-1101, RG-IPPBX-SIP-1101,
RL-IPPBX-1101 (where 1101 = CPID of VSC-CL1).
|
The Generic SIP Trunk (GSIP) feature provides the ability to create, modify, or delete trunks, route groups, route lists and route patterns associated with a connection for SIP.
Templates are provided to create elements within the connection (for example, trunks, RL-RG mapping, and route patterns). The naming convention for the template is as follows: AddConnection-<ProtocolType>-<TemplateName>.
The only ProtocolType supported is SIP.
Within the model the following templates are supported:
Unified CCE support:
Cisco Unity Connection support: ToCisco Unity for creating trunks and RL-RG Mappings connection to Cisco Unity Connection.
Generic Aggregation: ToAggregation for creating route pattern, trunks and RL-RG Mappings connection to the aggregation.
Aggregation country specific:
<ISO CC>_NATL_wPlus, <ISO CC>_INTL_wPlus and <ISO CC>_SVC_wPlus - for <ISO CC>, using a trunk that is created with the ToAggregation template, route pattern and RL-RG Mappings where the External Mask is a National Number and requires +44 to be the prefix to the Mask.
<ISO CC>_NATL_woPlus, <ISO CC>_INTL_woPlus and <ISO CC>_SVC_woPlus using a trunk that is created with the ToAggregation template, route pattern and RL-RG Mappings where the External Mask is in plus E.164 format.
<ISO CC>_EMR for route pattern and RL-RG Mapping for Emergency call routing (where <ISO CC> is the ISO Country Code, for example GBR for Great Britain).
You can configure all gateways or trunks as Off-Net (external) or On-Net (internal) in Cisco Unified Communications Domain Manager. When an end user dials a PSTN number to another corporate location in the network, the Forced On-Net feature automatically routes the call on-net, maximizing savings by directing traffic over the customer's IP VPN and avoiding international toll charges.
There is no transaction on Unified Communications Domain Manager to enable or disable this feature. Forced On-Net is enabled by adding the E.164LookUp partition to the routing calling search space, that is, RouteSelCSS-<CC>.
When enabled, Forced On-Net is applicable to all the provider customers.
Note | On the Cisco PGW, the default setting is Forced On-Net. If you do not require Forced On-Net, on the Provider Country page of the Unified Communications Domain Manager you can configure a set of E.164 ranges to be Forced Off-Net. |
Note | The Forced On-Net feature is not available to Shared Instance Dial Plan (G3) subscribers. |
The Cisco IP Manager Assistant (IPMA) feature allows managers and their assistants to work together effectively. This feature comprises a call routing service that enhances the phone capabilities for the manager and the desktop interfaces for both the manager and the assistant. This service intercepts calls that are made to managers and routes them to selected assistants, managers, or other targets based on preconfigured call filters. The manager can change the call routing dynamically. For example, by pressing a soft key press on the phone, the manager can instruct the service to route all calls to the assistant and can receive status on these calls.
IPMA can be provisioned in one of two ways:
Cisco Unified Communications Domain Manager operates on a transactional model that is called on every user action whether through the web or bulk loading interface. These transactions occur at key steps of building the providers and services, and then with Cisco Unified Communications Manager individual activations of customers, locations, phones, and features. For example, when a provider adds a new Cisco Unified Communications Manager to the system, the transaction InitIPPBX must be called to load all the base configurations (namely partitions, calling search spaces, translation patterns, time schedules, so on) as defined in the Dial Plan Model.
Administrators and users execute functions or operations on the Unified Communications Domain Manager to carry out certain tasks. For example, the task may be to add a new customer configuration into the network components or to add a new E.164 number range into the Unified Communications Domain Manager database. In Unified Communications Domain Manager, these functions or operations are named "Transactions."
A transaction may be a single operation, to add a number into the database for example, or it may include many subtransactions that are executed with a single operation. Every operation, or transaction, is kept in the Unified Communications Domain Manager Transaction log and can be used for searching the status of previous transactions and to even stop or replay individual entries. To summarize, against every action that a user performs on Unified Communications Domain Manager, there is a transaction that runs as a result of this action. The details of the transactions are specified in the model. The model tells the Unified Communications Domain Manager what configuration needs to be executed against a specific transaction.
Called at the initialization of the Unified Communications Manager by Unified Communications Domain Manager, either by the bulk loading spreadsheet or Static Load Config button on the GUI when adding a Unified Communications Manager. |
|
Called when a new country support is needed by the customer. |
|
Called to connect one Unified Communications Manager Cluster with another. |
|
Called when local gateway is added to support local PSTN breakout. |
|
Called when Single Number Reach feature is added to a location. |
The dial plan also makes use of variables that are assigned at runtime during a transaction.
The model must use variables on certain occasions to get runtime information at the time of a transaction execution. A list of the most common variables that apply to Dial Plan follows. The complete list of model variables can be found in the Unified Communications Domain Manager product documentation.
National number prefix per country (for example, 0 for Great Britain before nationalcode) |
|
The pretranslated number (shortcode) as captured in the front-end |
|
The Site Extension Mask, a variable site translation mask to match the number of digits in the extensions of a location |
|
The partition that is mapped to the descriptive name from the front-end |
Cisco Unified Communications Domain Manager uses a once-only transaction called InitIPPBX to load static Cisco Unified Communications Manager configuration on each Cisco Unified Communications Manager cluster.
The following time periods, time schedules, and their mapping is created during InitIPPBX transaction.
The generic Cisco HCS model supports two time periods:
The generic Cisco HCS model supports two time schedules:
The generic Cisco HCS model maps Time Periods to Time Schedules as follows:
Cluster-wide partitions are added during the InitIPPBX transaction. The translation patterns associated with these partitions are added while executing other transactions.
Partition containing translation patterns to convert incoming E.164 numbers to a directory number (DN) format |
|
Partition to map calling party DN to DDI mapping for emergency calls |
|
The following cluster-wide calling search spaces are added, and mapped to above partitions during InitIPPBX transaction:
Calling Party Transformation Calling Search Space for calls toward aggregation layer |
||
Calling search space assigned to incoming trunk from Cisco Unity Connection |
||
The following transformation pattern is added to handle incoming PSTN number with + and to override route pattern Calling Party transformation when a call is forwarded toward aggregation:
Remove + if it exists in the calling party number else do nothing and then prefix + to the calling party number. This is to avoid prefixing another + to the calling party number. |
The InitIPPBX transaction applies to those countries that are already associated with the customer. Depending on what countries are added at the service provider level in Unified Communications Domain Manager the country relevant model elements are provisioned with the InitIPPBX transaction.
Complete this procedure to activate the InitIPPBX and AddProviderIPPBXCountry functions and push the cluster-wide and country-level dial plan models settings to the Cisco Unified Communications Manager cluster. The InitIPPBX step can be run using the Cisco Unified Communications Domain Manager GUI for each cluster.
Step 1 | Browse to . |
Step 2 | Scroll to the bottom of the CCM Cluster Management Page and select Load Static Configuration. |
Step 3 | Alternatively, configure the C1 CUCDM81x VS P1 NetworkElements vy(Single Customer)(VSC CL1 CL2) loader sheet as follows (where x is the Cisco Unified Communications Domain Manager version, and y is the sheet version number): |
Review the InitIPPBX transaction device log or log in to the Unified Communications Manager cluster to verify that the cluster-wide and country-level dial plan has been loaded into the Unified Communications Manager cluster. Check for the addition of Partitions, CSSs, RPs, TPs, and so on. Successful completion of the InitIPPBX step is an important milestone in configuring a Cisco HCS Unified Communications Manager cluster, indicating the static configuration has been added correctly.
This is an optional procedure that is only required for the Extension Mobility Cross Cluster (EMCC) feature where a customer requires EMCC support across multiple clusters, for example between VSC-CL1 and VSC-CL2.
Step 1 | Configure the C7 CUCDM81x VS P3 NetworkElements-MultiCustomerClusters-MCC-CL1-CL2-vy loader sheet as follows (where x is the Cisco Unified Communications Domain Manager version, and y is the sheet version number): |
Step 2 | Monitor the Cisco Unified Communications Domain Manager Transaction logs and Device Logs and confirm the required EMCC settings have been added, for example: |
Cisco Unified Communications Domain Manager uses the AddCountryIPPBX transaction when a new country is added to the customer. The configuration consists of the following worksheets:
Creates route patterns for National, International, and Service Calls |
|
Creates country-specific translation patterns to allow and restrict calls |
|
Creates country-specific route lists for National, International, Emergency, and Service Calls |
|
Calling search spaces are added for a specific country. These calling search spaces include Per-Country Calling Search Space for Emergency Handling, Per-Country Calling Search Space PSTN Route Selection, and Per-Country Calling Search Space FAC PSTN Route Selection.
Route patterns are added using country specific route filters for emergency, national, and international calls. Same route patterns exist for calls to aggregation layer and also to local breakout gateway.
Route lists are added for National, International, Emergency, and Service calls on per-country basis.
The following country-specific partitions are added during AddProviderCountryIPPBX transaction. The variable #COUNTRY# is replaced with the country code. If the country being added is the United States, Cisco Unified Communications Domain Manager replaces #COUNTRY with a 1. Therefore partition BlkIntl-#COUNTRY# is provisioned as BlkIntl-1.
Allow Freephone (paid by called party) calls from #COUNTRY# (missing in the model) |
||
Allow International calls from #COUNTRY# during standard working hours |
||
Allow Mobile calls from #COUNTRY# during standard working hours |
||
Allow National calls from #COUNTRY# during standard working hours |
||
Allow Service calls from #COUNTRY# during standard working hours |
||
Allow Freephone (paid by called party) calls from #COUNTRY# during standard working hours (missing in the model) |
The following country-specific route pattern is added during the AddProviderCountryIPPBX transaction:
The following country-specific route pattern calling search spaces are added during AddProviderCountryIPPBX transaction:
Route pattern for National calls dialed using Customer Short Code Dialing |
The country-specific translation patterns to allow or block calls are added during AddProviderCountryIPPBX Transaction. The following table lists all the translation patterns associated with United States:
Block 1+ calls to Canada and other countries outside of the United States |
|||
Allow direct and operator dialed calls to international numbers |
|||
Allow direct and operator dialed calls to international numbers during standard working hours |
|||
Allow calls to Service Numbers, operators, and Directory Assistance |
|||
Allow calls to Service Numbers, operators, and Directory Assistance during standard working hours |
|||
Allow calls to Freephone (paid by called party) numbers during standard working hours |
|||
The AddCountry transaction adds country-specific route lists to route national, international, service, and emergency calls.
Cisco Unified Communications Domain Manager uses the AddLocation transaction every time a location is added. The following worksheets are invoked for the AddLocation transaction:
Adds translation patterns for Intrasite Calls, Intersite Calls, E.164 Calls, Country Specific National and emergency calls |
The AddLocation transaction creates the following site specific partitions. The site ID is appended to each partition.
Intra and intersite Calls Calling Line Identification Restriction (CLIR) |
||
Allow Plus Dialing for International Enhanced calls* from #COUNTRY# |
||
Allow Plus Dialing for International Standard calls* from #COUNTRY# |
||
Allow Plus Dialing for National Enhanced calls* from #COUNTRY# |
||
Allow Plus Dialing for National Standard COS* from #COUNTRY# |
||
Allow Plus Dialing for National Restricted COS* from #COUNTRY# |
||
Allow Plus Dialing for International Enhanced calls* from #COUNTRY# |
||
Allow Plus Dialing for International Standard calls* from #COUNTRY# |
||
Allow Plus Dialing for National Enhanced calls* from #COUNTRY# |
||
Allow Plus Dialing for National Standard COS* from #COUNTRY# |
||
Allow Plus Dialing for National Restricted COS* from #COUNTRY# |
||
*For definition, see Predefined Telephone Class of Service Types |
The following site specific calling search spaces are created during the AddLocation transaction:
Note | The following table is based on HCS Software Release 8.6(2) and may not include all Calling search spaces. Refer to the latest dial plan model for a complete list of available CSSs. |
Intra and intersite calls only (Calling Line Identification Presentation (CLIP) is default)
Intra and intersite calls only with Calling Line Identification Restriction (CLIR)
The AddLocation transaction maps the following calling search spaces and partitions based on each class of service that is associated with the calling search space:
Note | The following table is based on HCS Software Release 8.6(2) and may not include all Calling search spaces. Refer to the latest dial plan model for a complete list of available CSSs. |
The AddLocation transaction is used in the Country Dial Plan to create site-specific route patterns to route emergency calls. For the United States, the AddLocation creates following route pattern:
In Cisco HCS 8.6(2) and earlier, the following Translation Patterns were created by the AddLocation Transaction to route intrasite and intersite calls. As of Cisco HCS Release 9.0(1), the IntraSite and InterSite translation patterns are created using ENT Templates. This table applies to the Generic Dial Plan (G1) only.
In addition, site-specific country-based translation patterns are created.
Step 1 | Unhash Column A (Add Customer Flag) in the #CUSTOMER-LOCATIONS-INPUT sheet (normally cell A20). |
Step 2 | Click Save. |
Step 3 | Browse to Browse. > |
Step 4 | Load the Customer-Divisions-Locations loader. |
Step 5 | Monitor the
Cisco Unified Communications Domain Manager Transaction and Device Logs and
confirm the following required settings have been added:
|
Step 1 | Unhash Column B (Add Customer Flag) in the #CUSTOMER-LOCATIONS-INPUT sheet (lines 20 to 41 as required). |
Step 2 | Click Save. |
Step 3 | Browse to . |
Step 4 | Load the Customer-Divisions-Locations loader. |
Step 5 | Monitor the
Cisco Unified Communications Domain Manager Transaction logs and Device Logs
and confirm the required settings have been added, for example:
|
On completion of loading the Customer-, Division-, and Location-level settings, the Cisco HCS platform will be primed and ready for the addition of users, phones, and services into Customer-Locations. These can either be loaded using the Cisco Unified Communications Domain Manager GUI or in bulk using the LocationAdmin loader.
The VS-P1 LocationAdmin loader provides reference examples of the loader worksheets: C3-CUCDM81x-VS-P1-LocationAdmin(Extended Formula-Loader)vy(VS-Corp)(where x is the Cisco Unified Communications Domain Manager version number and y is the worksheet version number).
Refer to the Cisco Unified Communications Domain Manager Bulk loader and Training Documentation for more information on bulk loading user and phone services.
The AssociateFNN or FNN-Range transaction is used to create translation patterns to map Direct Dialed Inward (DDI) numbers to internal DNs.
It is also used to create transformation patterns to convert the Internal DN to a DDI Number and is used to add route patterns and route lists for voicemail.
The following site-specific route patterns are created by the AssociateFNN transaction.
The following site-specific route patterns using country dial plan are created by the AssociateFNN-Range transaction. The table shows specific route patterns for the United States.
Route PSTN Calls to voice mail - Cisco Unity Connection - via LGW |
The following site-specific translation patterns using Generic leaf cluster dial plans are created by the AssociateFNN and AssociateFNN-Range transactions.
The following site-specific Calling Party Transformation patterns using the generic leaf cluster dial plan are created by the AssociateFNN and AssociateFNN-Range transactions.
Cisco Unified Communications Domain Manager uses the Connect IPPBX transaction to connect:
Cisco Unified Communications Manager to other Cisco Unified Communications Managers
Cisco Unified Communications Manager to unmanaged PBX
Cisco Unified Communications Domain Manager uses the following transaction to create the H.323 trunk:
Cisco Unified Communications Domain Manager uses the following transactions to create SIP trunks.
SIP trunk to another Cisco Unified Communications Manager (intercluster trunk) |
||
Cisco Unified Communications Domain Manager uses the following transactions to create route lists.
Cisco Unified Communications Domain Manager uses the AddLocationLocalGateway transaction when a local gateway is added to a location to handle Local PSTN breakout. The configuration consists of the following:
IOS gateway configuration
Trunk, route group and route list associated with the IOS gateway
CSS, partition to handle incoming calls from the IOS gateway
Translation and route patterns to handle outgoing and incoming calls from the IOS gateway
Adds Country-specific National, International and Service Route patterns for LBO routing. It also maps Route patterns to LBO route lists. |
||
Adds translation pattern EXTNAT-IncomingLGW (#EXT##NAT#.!) to add + for calls incoming from local gateway. |
||
Provides Calling Number Transformation for Handling Incoming PSTN number with +. During Call Forwarding replace + with * so that it can be transported across SIP or H.323. In IOS, replaces the whole number with the Site Published Number. |
||
Adds route lists to route National, International, Service and emergency calls through LBO. Adds route lists for Tail End Hop Off towards LBO - #LOCATION-ID# |
||
Adds country-specific translation patterns to route local, national, international, service, and emergency calls through LBO. |
Unified Communications Domain Manager uses the AddSNR transaction when the Single Number Reach (SNR) feature (part of Cisco Unified Mobility) is enabled for a specified location. The following worksheets are invoked.
Country-specific national and international route patterns for SNR mobile connect routing. |
Emergency Calling Line Identification (CLI) is a Cisco Unified Communications Domain Manager enhancement for the Hosted Collaboration Solution Dial Plan that allows a site to send either the Device CLI or the Site Emergency Published Number to Cisco Unified Communications Manager when an emergency call is made. This feature was previously available in Cisco Hosted Unified Communications Services (HUCS).
This feature is useful to send a callback from the Emergency Service to the device that made the original emergency call (Device CLI) or a Published Number (for example, Security desk or Attendant), on either a customer or location basis.
The Cisco Unified Communications Manager performs the number transformations for Emergency CLI using the following transactions:
If you are an existing customer, you can add Emergency CLI functionality by using the DPMIG Tool. See Using the Dial Plan Model Migration Tool.
For all locations of a particular customer, you can change the Emergency Calling Line Identification (CLI) preference from “Published Number” to “Device CLI” in order to have callbacks routed to the device that made the emergency call.
This procedure submits a new EmergencyCLI transaction for each location belonging to the customer if the preference for that locations is to “Derived from Customer.” The following Cisco Hosted Collaboration Solution dial plan transactions are run for each of the customer locations:
What to Do Next
To view the current setting of Driver_ApplyConfig_FNNIPPBXs, see Viewing AssociateFNN Emergency CLI Preference or Viewing DisassociateFNN Emergency CLI Preference.
For a specific location, you can change the Emergency Calling Line Identification (CLI) preference from “Published Number” to “Device CLI” in order to have callbacks routed to the device that made the emergency call.
This procedure submits a new EmergencyCLI transaction for this location. The following Cisco Hosted Collaboration Solution dial plan transactions are run for the location:
What to Do Next
To view the current setting of Driver_ApplyConfig_FNNIPPBXs, see Viewing AssociateFNN Emergency CLI Preference or Viewing DisassociateFNN Emergency CLI Preference.
You can change the Emergency Calling Line Identification (CLI) preference from “Device CLI” to “Published Number” in order to have callbacks routed to a single published number for a specific customer (for example, to a Security department or Attendant). When performed at the customer level, the system applies this change through all locations of the customer. Selecting the Published Number results in the removal of the outbound FNN mapping for emergency numbers using the DisassociateFNN transaction.
The following Cisco Hosted Collaboration Solution dial plan transactions are run for each of the customer locations:
What to Do Next
To view the current setting of Driver_ApplyConfig_FNNIPPBXs, see Viewing AssociateFNN Emergency CLI Preference or Viewing DisassociateFNN Emergency CLI Preference.
You can change the Emergency Calling Line Identification (CLI) preference from “Device CLI” to “Published Number” in order to have callbacks routed to a single published number for a specific location (for example, to a Security department). When performed at the location level, the system iterates the change to the location. Selecting the Published Number results in the removal of the outbound FNN mapping for emergency numbers using the DisassociateFNN transaction.
The following Cisco Hosted Collaboration Solution dial plan transactions are run for the location:
What to Do Next
To view the current setting of Driver_ApplyConfig_FNNIPPBXs, see Viewing AssociateFNN Emergency CLI Preference or Viewing DisassociateFNN Emergency CLI Preference.
If the Emergency CLI preference of the location is set to “Device CLI,” the AssociateFNN transactions are executed. If the Emergency CLI preference of the location is set to “Published Number” the AssociateFNN transaction is not executed. The workflow for Cisco Hosted Collaboration Solution AssociateFNN transaction is as follows:
If the Emergency CLI preference of the location is set to “Published Number” no AssociateFNN is sent to Cisco Unified Communications Manager and the location Emergency CLI uses the Published Emergency Number. If the location was previously provisioned to use "Device CLI” and changed using either Changing Emergency CLI Preference From Published Number to Device CLI (Customer Level) or Changing Emergency CLI Preference From Published Number to Device CLI (Location Level), the Cisco Unified Communications Domain Manager executes DisassociateFNN transactions (which removes the Device CLI for each device in Cisco Unified Communications Manager). The workflow for Cisco Hosted Collaboration Solution DisassociateFNN locations is as follows:
The External Group Command Line Interface (CLI) feature provides the capability to define a Direct Inward Dialing (DDI) number, also known as a Direct Dial-In (DDI) number, that can be used as the Group CLI number associated to one or more directory numbers. The Group CLI is used as the Calling Party Number when one of those directory numbers makes a PSTN call.
For Cisco Unified Communications Manager, the model name is AddGCLI-External and it is used to map the DN to the external number (GCLI) in the Transform Patterns worksheet. The variables supported are the same as those provided for the AddGCLI transaction. The Group CLI Number can be entered in Free Form in National Format (that is, not from the DDI range allocated to a Location) or from one of the DDIs allocated to a Location.
The following variables are used:
The External Group CLI feature for the Shared Instance Dial Plan (G3) requires per-customer Calling Party Transformation Calling Search Spaces (CSS). In addition, SMB SIP Trunk Groups are required to support this feature.
To create per-SMB trunks:
Note | When you add an External Group CLI, you must load the models first in Cisco Unified Communications Domain Manager for any of the transactions described in this procedure to have an effect on Cisco Unified Communications Manager. The model information for the Model Name AddGCLI-External must be loaded once. |
Step 1 | Navigate to General Administration>Customer>Advanced Management>CLI Group Management. Example: | ||
Step 2 | Enter CLI Group Name. This is a unique name for the External Group CLI. | ||
Step 3 | From the dropdown menu, select Division. | ||
Step 4 | From the dropdown menu, select Location. When Location is selected, a list of numbers is displayed in the Extensions list box as shown in the preceding figure. | ||
Step 5 | Choose one of the following:
| ||
Step 6 | To search for specific extensions, select either the ‘Number starts with’ or ‘Number ends with’ option from the dropdown list and enter a relevant digit or digits in the text field. As the search criteria are entered, the Extensions list box is repopulated with only relevant numbers based on the search criteria. | ||
Step 7 | When all required extensions for the External CLI Group are selected, click Apply CLI Group Configuration.
|
You can bulk load CLI Groups by loading the Add CLI Group sheet (in the LocAdmin sample workbook). For more information on bulk loading, see Bulk Loader Guide for Cisco Unified Communications Domain Manager 8.1.4.
The Cisco HCS Dial Plan uses the Connect Location feature to allow customers to provision sites (locations) while “offline” and then use the Connect button to activate the sites later. Once a location is connected, billing starts. This feature is particularly useful when migrating the Dial Plan model from legacy systems to Cisco HCS.
Note | When deploying a new location, it is a good practice to first verify all the IP phones work with calls within the location, assign all the DDIs, hunt groups, and so on, and if everything works, then connect to the PSTN as the last step. |
This feature provides the following:
These changes are optional and can be accessed from both the Operations Tools and Telephony GUI screens.
The Connect feature is not activated in the Dial Plan models by default. To activate the feature:
To connect to the PSTN, perform the following: