Overbuild for Cisco#

Overview#

VOSS Automate’s overbuild feature allows Provider and Reseller administrators to integrate an existing, deployed Cisco Unified Communications Manager (CUCM) system into VOSS Automate without re-provisioning, unless required.

This option is available for single-cluster dedicated deployments only.

Overbuild tools allow an administrator manage data synced from existing configurations in CUCM and Cisco Unity Connection (CUC).

Important

It is recommended that VOSS Automate training and/or VOSS Services are engaged during the initial use of the overbuild feature to help ensure optimized processes and guidance.

Note

References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.

Although a deployed CUCM system does not contain VOSS Automate components such as hierarchies or subscribers, the relationship between CUCM components makes it possible to, for example, create a VOSS Automate subscriber at a site hierarchy during the overbuild process. The necessary workflows, macros and brownfield move processes are available for this purpose. You will not need to access these tools directly; they are part of the Run Overbuild user interface.

The table summarizes the overbuild logic:

Component	Description
Phones	This is based on the device pool of the phone. It will be moved to a site based on the device pool matching one of the device pools set up under the site defaults for a site.
Dual Mode Remote Destinations	This will move the remote destination to the site of the dual mode device.
Phone Remote Destinations	(Provider deployment). This will move the remote destinations to the site of the associated phone.
Users	If the user has an associated phone, that user is moved to the same site as the phone. A user without an associated phone must be manually moved to the relevant site, using the Move Users menu (under either User Management or Overbuild). It is recommended that you do this prior to the overbuild, so that all their related services are moved during overbuild, or you will need to run the overbuild again, after moving the user, to handle their related services.
Device Profiles	This will move the device profile to the same site as the user associated to the device profile.
Remote Destination Profiles	This logic is the same as phones, based on the device pool of the RDP. It will be moved to a site based on the device pool matching one of the device pools setup under the site defaults for a site.
Remote Destinations	This will move the remote destination to the same site as the associated remote destination profile.
Lines	This will move the line to the same site as the phone/device profile/RDP it is associated to.
CUC Users	This will move the voicemail user to the same site as the base user.
Webex App Users	This will move existing Webex App users that are synced into VOSS Automate to the same site as the base user (if it finds a matching email address).
Contact Center Agents	This will move contact center agents to the same site as the base user (if it finds a matching CUCM user ID).

Overbuild Workflow#

provider-admin

reseller-admin

The table describes the general steps for overbuild:

Component	Description
Initial setup	Step 1 involves the initial setup and configuration on VOSS Automate; the provisioning of the business hierarchy. Identify the business information of the existing, deployed system, and add these details to VOSS Automate. This can be done manually, or via bulk load. Create the hierarchy, with customers, sites, and site codes to generate the initial configuration data, such as site dial plan (Provider deployment only), and site defaults data. Modify the data, if required, according to CUCM data, so that overbuild processing can move the data to required sites. For example, the default, generated VOSS Automate Site Defaults for a site have the site name as the device pool name. Since the Site Defaults are used in the overbuild, this name should be modified to match the device pool name on the imported phones before the overbuild is run. VOSS Automate allows Provider and Reseller Administrators to modify Site Defaults update the configuration of an overbuild. While customers and sites have access to the Site Defaults under the Site Management menu, the Overbuild Defaults tab in Site Defaults is only visible to Provider and Reseller Administrators.
Create shell dial plan schema	Provider deployment only. Associate a shell schema group with the customer, then add a custom dial plan under Advanced Configuration (Optional at the site hierarchy). In this step, you will need to create a shell dial plan schema group at the Customer hierarchy. The shell schema group enables Partners, Resellers, and Provider Administrators to access customers that have existing or deployed dial plans without having to use the pre-packaged type 1-4 dial plans. The shell schema groups only contain two default values: Device Pool CUCM Group The rest of the fields are blank for customization. This enables administrators to “over-build” VOSS Automate operations on top of customers’ existing dial plans. See “Provider HCS Dial Plan Management Support Guide”.
Configure network device connections	Identify and create network device connections, associate these with a Network Device List (NDL) and import. This includes CUCM and CUCX clusters. This step involves provisioning Cisco UC applications, NDLs, and NDL references. Once the UC applications are configured, the sync from CUCM is scheduled and executed. Caution: Whenever this data is synced in, it becomes managed by VOSS Automate and, as a result, would be deleted by any hierarchy delete. One CUCM typically belongs to a customer and resides in a cluster, so this device import takes place at the created customer hierarchy. The device can also be associated with a NDL on VOSS Automate that is mapped to a created hierarchy.

Component

Description

Initial setup

Step 1 involves the initial setup and configuration on VOSS Automate; the provisioning of the business hierarchy.

Identify the business information of the existing, deployed system, and add these details to VOSS Automate. This can be done manually, or via bulk load.

Create the hierarchy, with customers, sites, and site codes to generate the initial configuration data, such as site dial plan (Provider deployment only), and site defaults data.
Modify the data, if required, according to CUCM data, so that overbuild processing can move the data to required sites.

For example, the default, generated VOSS Automate Site Defaults for a site have the site name as the device pool name. Since the Site Defaults are used in the overbuild, this name should be modified to match the device pool name on the imported phones before the overbuild is run.

VOSS Automate allows Provider and Reseller Administrators to modify Site Defaults update the configuration of an overbuild.

While customers and sites have access to the Site Defaults under the Site Management menu, the Overbuild Defaults tab in Site Defaults is only visible to Provider and Reseller Administrators.

Create shell dial plan schema

Provider deployment only.

Associate a shell schema group with the customer, then add a custom dial plan under Advanced Configuration (Optional at the site hierarchy).

In this step, you will need to create a shell dial plan schema group at the Customer hierarchy. The shell schema group enables Partners, Resellers, and Provider Administrators to access customers that have existing or deployed dial plans without having to use the pre-packaged type 1-4 dial plans.

The shell schema groups only contain two default values:

Device Pool
CUCM Group

The rest of the fields are blank for customization. This enables administrators to “over-build” VOSS Automate operations on top of customers’ existing dial plans. See “Provider HCS Dial Plan Management Support Guide”.

Configure network device connections

Identify and create network device connections, associate these with a Network Device List (NDL) and import. This includes CUCM and CUCX clusters.

This step involves provisioning Cisco UC applications, NDLs, and NDL references. Once the UC applications are configured, the sync from CUCM is scheduled and executed.

Caution: Whenever this data is synced in, it becomes managed by VOSS Automate and, as a result, would be deleted by any hierarchy delete.

One CUCM typically belongs to a customer and resides in a cluster, so this device import takes place at the created customer hierarchy. The device can also be associated with a NDL on VOSS Automate that is mapped to a created hierarchy.

Component	Description
Choose device pools and devices	Choose the device pool and devices for the site on both the General tab and on the Overbuild Default tabs in the Site Defaults.
Run overbuild	Run the overbuild to move the imported UC applications data into the site hierarchy that corresponds with the existing deployed site. Select User on Run Overbuild to move users exposed in User Management to the site of their associated phones (as specified in the Site Defaults Doc Device Pools). Users without phones are not moved and can be moved separately. Note that the user’s role is not changed when moving to the site. The following model instances are moved from customer level to the site level: `data/User` `data/HCSHcmfUserDAT` `device/cucm/User` `device/hcmf/User` (only if HCM-F is installed) If the Lines checkbox is selected on Run Overbuild, lines are moved to the relevant site, and marked as in use in the Directory Number (DN) inventory. If a matching DN inventory entry does not exist then one is created. DN entries are created at site by default unless the Create Internal Number Inventory at Customer option is selected (in Site Defaults > Overbuild Defaults tab). Note: Adding Directory Number inventory at Customer level is only possible if the dial plan is non-SLC, if no dial plan is in use. The Run Overbuild tool selects which data to move based on device pool configurations. You can run the tool for all sites, or a particular site. The existing system’s provisioned phones that have been imported should have their device pools matched with Site Default data values on each specific site. Imported elements are moved according to overbuild Move workflows, which are triggered by the Run Overbuild tool. These workflows identify imported network device data and move it to the site hierarchy that corresponds to the existing deployed site.

Component

Description

Choose device pools and devices

Choose the device pool and devices for the site on both the General tab and on the Overbuild Default tabs in the Site Defaults.

Run overbuild

Run the overbuild to move the imported UC applications data into the site hierarchy that corresponds with the existing deployed site.

Select User on Run Overbuild to move users exposed in User Management to the site of their associated phones (as specified in the Site Defaults Doc Device Pools). Users without phones are not moved and can be moved separately. Note that the user’s role is not changed when moving to the site.

The following model instances are moved from customer level to the site level:
- data/User
- data/HCSHcmfUserDAT
- device/cucm/User
- device/hcmf/User (only if HCM-F is installed)
If the Lines checkbox is selected on Run Overbuild, lines are moved to the relevant site, and marked as in use in the Directory Number (DN) inventory. If a matching DN inventory entry does not exist then one is created. DN entries are created at site by default unless the Create Internal Number Inventory at Customer option is selected (in Site Defaults > Overbuild Defaults tab).

Note: Adding Directory Number inventory at Customer level is only possible if the dial plan is non-SLC, if no dial plan is in use.

The Run Overbuild tool selects which data to move based on device pool configurations. You can run the tool for all sites, or a particular site.

The existing system’s provisioned phones that have been imported should have their device pools matched with Site Default data values on each specific site.

Imported elements are moved according to overbuild Move workflows, which are triggered by the Run Overbuild tool. These workflows identify imported network device data and move it to the site hierarchy that corresponds to the existing deployed site.

Component	Description
Verify data	Use Overbuild > Overview Tool to verify the number of UC elements at the selected hierarchy and below. You can manually validate and modify the overbuild run by reviewing the moved items, using the Overview Tool. Use Device Models and/or Relations to move, update, delete, and in a few limited cases, add instances of device types for the selected hierarchy. Optionally, review the device model types listed with hierarchy in the Device Models or Subscriber Management menu.
Post-move	Move any users who were not moved during the overbuild Add your E.164 inventory (optional). See Add an Inventory of E164 Numbers in the Core Feature Guide. Filter calling search spaces and assign a class of service (optional). See Filter Calling Search Spaces and Assign a Class of Service in the Core Feature Guide. Perform Self-service authentication provisioning steps for non-LDAP, LDAP, and SSO-enabled scenarios. See User Authentication in the Core Feature Guide. Add additional internal number inventory for future lines. See Number Management.

Component

Description

Verify data

Use Overbuild > Overview Tool to verify the number of UC elements at the selected hierarchy and below.

You can manually validate and modify the overbuild run by reviewing the moved items, using the Overview Tool. Use Device Models and/or Relations to move, update, delete, and in a few limited cases, add instances of device types for the selected hierarchy.

Optionally, review the device model types listed with hierarchy in the Device Models or Subscriber Management menu.

Post-move

Move any users who were not moved during the overbuild
Add your E.164 inventory (optional). See Add an Inventory of E164 Numbers in the Core Feature Guide.
Filter calling search spaces and assign a class of service (optional). See Filter Calling Search Spaces and Assign a Class of Service in the Core Feature Guide.
Perform Self-service authentication provisioning steps for non-LDAP, LDAP, and SSO-enabled scenarios. See User Authentication in the Core Feature Guide.
Add additional internal number inventory for future lines. See Number Management.

Overbuild for Cisco

On this page

Overbuild for Cisco#

Overview#

Overbuild Workflow#