.. _nextgen-dialplan-overview:

Cisco Custom Dial Plans
-------------------------

.. _18.1-Patch-Bundle-3|EKB-673:
.. _21.4-PB1|VOSS-1124|EKB-14273:



.. tip:: 

   :ref:`use-action-search-to-navigate-automate`



Overview 
..........


Automate provides support for Cisco HCS dial plans, and Cisco Custom dial plans. This section 
describes the Cisco Custom dial plans. 



.. important:: 

   Contact your dedicated VOSS support representative for details on how to set up
   and configure Cisco Custom Dial Plans.

   By default, the Dial Plan Management Tool and associated menus is visible in 
   an Enterprise environment, and hidden on Provider deployments. To expose this 
   feature on Provider deployments, set the Global Setting "Enforce HCS Dial Plan" to *No*.
   For details, see:
   
   * :ref:`nextgen-dialplan-access-profile-changes`
   * :ref:`nextgen-dialplan-menu-layout-changes`




.. rubric:: Related topics 

* :ref:`ms-custom-dialplan-models`




.. rubric:: Features of Cisco custom dial plans

Cisco custom dial plans: 

* Allow you to manage dial plans independent of the hierarchy schema approach of Cisco HCS dial plans. However, 
  you can also use Cisco Custom dial plans with schema-based dial plans.

* Can be used in place of or together with the schema or schema group approach, 
  for example to add elements in an additional dial plan in an ad-hoc manner.

* Allows senior administrators to define complete complex dial plans and to 
  provide access to these dial plans to lower level administrators, who won't need to understand 
  the complete dial plan.

* Cisco Custom dial plan models use all functionality of schemas, as well as call routing via route filters.

* Provide additional configuration options, and a repeatable process for managing CUCM elements. 

* Can be provisioned in a modular manner.

* Provide a structure for storing dial plan models. 



.. rubric:: Deployment elements included with Cisco Custom dial plans:

The elements included in a Cisco Custom dial plan are collectively referred to as a Dial Plan Model. 

Each dial plan element is broken into its own container or model for storage in Automate. 
This allows for simple management of the dial plan model as a whole.

Cisco Custom dial plan models may be bulk loaded into Automate and managed via the Admin Portal.

The following elements are included in Cisco Custom dial plan: 

* Device Pools - Regions - Locations -SRST
* Transcoders
* Conference Bridge
* Media Resource Groups
* Media Resource Group Lists
* Route Groups
* SIP Trunks
* CTI Route Points *with Lines* (Lines are not supported in schemas)
* Time Periods
* Time Schedules
* Partitions    
* CSSs
* Route Patterns
* Transition Patterns
* Called Party Transformation Patterns
* Calling Party Transformation Patterns
* SIP Route Patterns



.. _nextgen-dialplan-menu-layout-changes:

Configure the Cisco custom dial plan management menus
................................................................


1. Login as an administrator with sufficient rights to change menu layouts.
2. Go to **Menu Layouts**.
3. Click on the relevant menu to edit it.
4. Configure the **Dial Plan Management** menu as described in the table, then save your changes: 


.. tabularcolumns:: |p{4cm}|p{4.5cm}|p{5cm}|p{2cm}|


+------------------------------------+---------------------------------------+----------------+
| **Title**                          | **Type**                              | **Display As** |
+====================================+=======================================+================+
| **Dial Plan Management Tool**      |                                       | List           |
+------------------------------------+---------------------------------------+----------------+
| Dial Plan Maintenance              | /api/view/DP_MaintenanceVIEW/ add     | Form           |
+------------------------------------+---------------------------------------+----------------+
| Multi-Cluster Dialplan Maintenance |                                       | Form           |
+------------------------------------+---------------------------------------+----------------+
| Dial Plan Viewer                   | relation/DP_REL                       | List           |
+------------------------------------+---------------------------------------+----------------+
| Delete Dial Plan                   | /api/view/DP_DeleteDialPlan Model/add | Form           |
+------------------------------------+---------------------------------------+----------------+
| Dial Plan Input Data               |                                       | List           |
+------------------------------------+---------------------------------------+----------------+
| * Global Data                      | data/DP_GlobalDialPlanData            | List           |
+------------------------------------+---------------------------------------+----------------+
| * Site Level Data                  | data/DP_SiteDialPlanData              | List           |
+------------------------------------+---------------------------------------+----------------+
| Cisco Dial Plan Models             |                                       |                |
+------------------------------------+---------------------------------------+----------------+
| * Device Pool-Region               | data/DP_DP-Reg-Loc                    | List           |
|   -Location-SRST                   |                                       |                |
+------------------------------------+---------------------------------------+----------------+
| * Conference Bridge                | data/DP_ConfBridge                    | List           |
+------------------------------------+---------------------------------------+----------------+
| * Media Resource Group List        | data/DP_MediaResourceGro              | List           |
|                                    | upList                                |                |
+------------------------------------+---------------------------------------+----------------+
| * SIP Trunks                       | data/DP_SIPTrunk                      | List           |
+------------------------------------+---------------------------------------+----------------+
| * CTI Route Points                 | data/DP_CTIRoutePoint                 | List           |
+------------------------------------+---------------------------------------+----------------+
| * Route Groups                     | data/DP_RouteGroup                    | List           |
+------------------------------------+---------------------------------------+----------------+
| * Route Lists                      | data/DP_RouteList                     | List           |
+------------------------------------+---------------------------------------+----------------+
| * Route Patterns                   | data/DP_RoutePattern                  | List           |
+------------------------------------+---------------------------------------+----------------+
| * Translation Patterns             | data/DP_TransPattern                  | List           |
+------------------------------------+---------------------------------------+----------------+
| * Called Party Trans               | data/DP_Called_Party_Trans            | List           |
|   formations                       | formation                             |                |
+------------------------------------+---------------------------------------+----------------+




.. tabularcolumns:: |p{4cm}|p{4.5cm}|p{5cm}|p{2cm}|


+------------------------------------+--------------------------------------+----------------+
| **Title**                          | **Type**                             | **Display As** |
+====================================+======================================+================+
| Cisco Dial Plan Models (Continued) |                                      |                |
+------------------------------------+--------------------------------------+----------------+
| * Calling Party Trans              | data/DP_Calling_Party_Trans          | List           |
|   formations                       | formation                            |                |
+------------------------------------+--------------------------------------+----------------+
| * SIP Route Patterns               | data/DP_SIPRoutePattern              | List           |
+------------------------------------+--------------------------------------+----------------+
| * Calling Search Space             | data/DP_Css                          | List           |
+------------------------------------+--------------------------------------+----------------+
| * Transcoders                      | data/DP_Transcoder                   | List           |
+------------------------------------+--------------------------------------+----------------+
| * Time Periods                     | data/DP_TimePeriod                   | List           |
+------------------------------------+--------------------------------------+----------------+
| * Time Schedules                   | data/DP_TimeSchedule                 | List           |
+------------------------------------+--------------------------------------+----------------+
| * Media Resource Group             | data/DP_MediaResourceGroup           | List           |
+------------------------------------+--------------------------------------+----------------+
| * Partitions                       | data/DP_Partition                    | List           |
+------------------------------------+--------------------------------------+----------------+
| Dial Plan Log                      | data/DP_DialPlanLog                  | List           |
+------------------------------------+--------------------------------------+----------------+

.. note:: 

   If you have a Microsoft-only environment, or a multi-vendor or hybrid environment that includes 
   Microsoft, the Dial Plan Management Tool menu also includes the **Microsoft Dial Plan Models** menus. See 
   :ref:`ms-custom-dialplan-models` for details. 



.. _nextgen-dialplan-access-profile-changes:

Configure access profile for Cisco custom dial plans
........................................................



1. Log in as HCS administrator or higher (you'll need sufficient rights to change access profiles). 
2. Go to **Access Profiles**.
3. Select the required administrator name, for example ProviderAdminAP.
4. Configure the provider access profiles as shown in step 5.
#. Under **Type Specific Permissions** add the following new **Permitted Type**
   entries and **Permitted Operations**:

   * Permitted Type: view/DP_MaintenanceVIEW
   * Permitted Operations: Create, Field Display Policy, Read
   
   * Permitted Type: relation/DP_REL
   * Permitted Operations: Create, Read
   
   * Permitted Type: view/DP_DeleteDialPlanModel
   * Permitted Operations: Create, Read

   * Permitted Type: data/DP_GlobalDialPlanData
   * Permitted Operations: Create, Delete, Export, Export Bulk Load, Read, Tag, Update

   * Permitted Type: data/DP_SiteDialPlanData
   * Permitted Operations: Create, Delete, Export, Export Bulk Load Template, Read, Tag, Update 
   
   * Permitted Types:
     
     * data/DP_CalledParty_Transformation
     * data/DP_CallingParty_Transformation
     * data/DP_ConfBridge
     * data/DP_Css
     * data/DP_CTIRoutePoint
     * data/DP_DialPlan
     * data/DP_DialPlanLog
     * data/DP_DP-Reg-Loc
     * data/DP_MediaResourceGroup 
     * data/DP_MediaResourceGroupList
     * data/DP_Partition
     * data/DP_RouteGroup
     * data/DP_RouteList
     * data/DP_RoutePattern
     * data/DP_SIPRoutePattern
     * data/DP_SIPTrunk
     * data/DP_TimePeriod
     * data/DP_TimeSchedule
     * data/DP_Transcoder
     * data/DP_TransPattern
   * Permitted Operations: Create, Delete, Export, Export Bulk Load Template, Read, Tag, Update 
   
#. Click **Save**.




.. _concepts-nextgen-dialplan-use-checklist:

Cisco custom dial plan checklist
..................................

The high level task workflow for setting up Cisco Custom dial plans is as follows: 

* Load Dial Plan Models for Global Values via bulk loader or JSON
* Load Dial Plan Models for Site Values via bulk loader or JSON
* Set Dial Plan Input Data for Global or Site level values.
  Only the fields that are referenced via Macro in the dial plan model must be populated.
* Push Global dial plan data to Cisco Unified Communications Manager (CUCM), using the Dial Plan Maintenance Tool.
  Be sure to check that the tool is run at the appropriate hierarchy level.
* Push Site level dial plan data at CUCM, using the Dial Plan Maintenance Tool.
  Be sure to check that the tool is run at the appropriate hierarchy level.
* Should any changes need to be made to the pushed dial plans, the tool does allow
  for removal in reverse order then a re-push once the dial plan models are updated.
* Set Site Defaults via the site default profile tool.




.. |generic-dialplan-main-menu-layout| image:: /src/images/generic-dialplan-main-menu-layout.png
.. |generic-dialplan-input-data-submenu-layout| image:: /src/images/generic-dialplan-input-data-submenu-layout.png
.. |generic-dialplan-dial-plan-models-submenu-p1| image:: /src/images/generic-dialplan-dial-plan-models-submenu-p1.png
.. |generic-dialplan-dial-plan-models-submenu-p2| image:: /src/images/generic-dialplan-dial-plan-models-submenu-p2.png