[Index]

Model: data/HcsDpDialPlanSchemaDAT

Dial Plan Schema

Use this procedure to configure a customized group of related dial plan elements in Cisco Unified Communications Manager, including time periods, time schedules, partitions, calling search spaces, translation patterns, calling and called party transformations, CTI route points, route lists, route patterns, and SIP route patterns.

1. Log in to VOSS-4-UC as the Provider or Reseller Administrator.
2. Select Dial Plan Management > Advanced Configuration > Dial Plan Schema.
3. Click Add to add a custom schema.
4. Enter a unique name for the schema in the Dial Plan Name field.
5. (Optional) Enter a description for the schema in the Description field.
6. Click the Time Periods tab to add time periods for the schema.
7. Perform the following to add time period information for the schema:
   1. Click + on the right side of the grid to add a new row.
   2. Enter a Time Period Name and Description (optional) for the time period.
   3. From the Time of Day Start and Time of Day End drop-down menus select the start and end time for the time period.
   4. (Optional) From the Start Day, End Day, Start Month, End Month drop-down menus, select the day and month characteristics of the time period if desired.
   5. (Optional) Enter a Start Day of the Month and End Day of Month in the Start Day of Month and End Day of Month fields if desired.

8. Click the Time Schedules tab to add time schedules for the schema.
9. Perform the following to add time schedule information for the schema:
   1. Click + on the right side of the grid to add a new row.
   2. Enter a Time Schedule Name and Description for the time schedule.
   3. Click the Time Periods More button to enter more information about the time period associated with this time schedule.
10. Click the Partitions tab to add or modify partition information for the schema. Modify a partition's characteristics by changing the information in the grid. Click + on the right side of the grid to add a new row. You can use macros if desired to add partition information. For more information on using macros as part of the Partition Names, Descriptions, or Time Schedules, see Macros.
11. Click the Calling Search Spaces tab to add CSSs for the schema.
12. Perform the following to add or modify a calling search space's characteristics as follows:
    1. Click + on the right side of the grid to add a new row.
    2. Using macros if desired, enter a CSS Name and Description (optional) for the calling search space. For more information on using macros, see Macros.
    3. Enter the reason for the CSS in the Partition Usage field.
    4. Click the Class of Service box if this CSS is used in a Class of Service.
    5. Click the Partitions More button to enter more information about the partitions associated with this CSS.
13. Click the Translation Patterns tab to add translation patterns for the schema.
14. Complete fields in this tab to add or modify translation patterns.
15. Click the Calling Party Transformation Patterns tab to add calling party transformation patterns for the schema.
16. Complete fields in this tab to add or modify calling party transformation patterns.
17. Click the Called Party Transformation Patterns tab to add called party transformation patterns for the schema.
18. Complete fields in this tab to add or modify called party transformation patterns.
19. Click the CTI Route Points tab to add CTI route points for the schema.
20. Complete fields in this tab to add or modify CTI route points.
21. Click the Route Lists tab to add route lists for the schema.
22. Complete fields in this tab to add or modify route lists.
23. Click the Route Patterns tab to add route patterns for the schema.
24. Complete fields in this tab to add or modify route patterns.
25. Click the SIP Route Patterns tab to add SIP route patterns for the schema.
26. Complete fields in this tab to add or modify SIP route patterns.
27. Click Save to save the new dial plan schema. The new dial plan schema appears in the list of Dial Plan Schemas.

What to Do Next

Perform Create Schema Groups to add dial plan schemas to a schema group.

Auto-Cloning of Dial Plan Schemas and Schema Groups to the Provider Hierarchy Node

All existing dial plan schema and schema groups are cloned automatically from the System Administration level in VOSS-4-UC 10.x/11.5(x) to the Provider hierarchy node when the following events occur:

• You create a new provider
• You perform an upgrade from a previous version of VOSS-4-UC

New dial plan schema files and schema groups are also cloned automatically to existing Provider hierarchy nodes when the following events occur:

• You load or import a country dial plan template that introduces additional dial plan schema files or schema groups at the System Admin level, the new additional schema files are cloned automatically to any existing Provider hierarchy nodes.
• New dial plan schema or schema groups are created using native GUI, REST API, native bulk loader, imported JSON files, or using the app install template, the new schema and schema groups are cloned automatically to existing Provider hierarchy nodes.

The cloned version at the Provider level has the same name and is an exact replica of the dial plan schema or schema group at the System Admin level except that the Description field in the General tab of the schema indicates that it is the Cloned instance version.

Auto-cloning of the dial plan schema and schema groups to the Provider level ensures that any dial plan schema and schema group changes you make to existing Cisco templates are not lost when a Cisco template upgrade is introduced. As a Provider, you can also add your own schemas and schema groups at the Sys Admin level and be confident that these will be cloned down to the Provider level and not be overwritten by upgraded Cisco templates.

Your dial plan schema changes are retained because when you deploy new customers and sites, the system searches up the hierarchy node tree to find the first instance of a particular template name to use for the deployment.

For example, when deploying the Customer Call Screening feature schema for a customer, the system searches up the hierarchy node tree for the first instance of the CustomerCallScreening-Feature-V1-SCH. It will find two instances of CustomerCallScreening-Feature-V1-SCH:

1. CustomerCallScreening-Feature-V1-SCH (at the Provider level - e.g. sys.hcs.p1)
2. CustomerCallScreening-Feature-V1-SCH (at the System Administration level - e.g. sys-hcs)

Because the schema names are identical and the Provider hierarchy node is found first, the Provider level CustomerCallScreening-Feature-V1-SCH schema is used to deploy the customer. Any customizations you made to the CustomerCallScreening-Feature-V1-SCH schema at the Provider level are retained if the template at the System Administration level gets updated by an upgrade.

Clone Dial Plan Schemas

Use this procedure to copy one of the default dial plan schemas (or a previously customized schema) to use as a starting point when creating a new dial plan schema.

1. Log in to VOSS-4-UC as the Provider or Reseller Administrator.

2. Select Dial Plan Management > Advanced Configuration > Dial Plan Schema.

3. From the list of dial plan schemas, choose the one to be cloned, by clicking on its box in the leftmost column. For more information on the default dial plan schemas, refer to Default Dial Plan Schemas.

   Note

   There may be duplicate dial plan schemas in the list because some of the dial plan schemas may have been auto-cloned to the Provider hierarchy node. For more information, see Auto-Cloning of Dial Plan Schemas and Schema Groups to the Provider Hierarchy Node.

4. Click Action > Clone.

5. From the General tab, enter a new unique name for the cloned dial plan in the Dial Plan Name field.

6. If desired, add a description of the new cloned dial plan schema in the Description field.

7. Modify or add time periods, time schedules, partitions, calling search spaces, translation patterns, calling party transformation patterns, called party transformation patterns, CTI route points, route lists, route patterns, and SIP route patterns as desired by clicking on the appropriate tab.

8. Click Save. The new dial plan schema appears in the list of Dial Plan Schemas.

This data model encapsulates the information needed to deploy a dial plan schema.

Model Details