.. _cisco-overbuild: Overbuild for Cisco --------------------------- .. _25.3|VOSS-1507|EKB-26263: :bdg-primary:`Cisco` .. tip:: :ref:`use-action-search-to-navigate-automate` Overview .......... The overbuild feature allows Provider and Reseller administrators to integrate an existing, deployed Cisco Unified Communications Manager (Cisco UCM) system 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 Cisco UCM and Cisco Unity Connection (CUC). .. important:: It is recommended that VOSS services are engaged during the initial use of the overbuild feature to help ensure optimized processes and guidance. Although a deployed Cisco UCM system does not contain Automate components such as hierarchies or users, the relationship between Cisco UCM components makes it possible to, for example, create an Automate user 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 list below summarizes the overbuild logic: * Cisco UCM 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. * Cisco UCM Phone Remote Destinations This will move the remote destinations to the site of the associated phone. * Cisco UCM 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. * Cisco UCM Device Profiles This will move the device profile to the same site as the user associated to the device profile. * Cisco UCM 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. * Cisco UCM RDP Remote Destinations This will move the remote destination to the same site as the associated remote destination profile. * device/cucm/TodAccess * device/cucm/TimeSchedule * device/cucm/TimePeriod * Cisco UCM Lines This will move the line to the same site as the phone/device profile/RDP it is associated to. * Cisco Unity Connection 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 Automate to the same site as the base user (if it finds a matching email address). * Contact Center Express Agents This will move contact center express agents to the same site as the base user (if it finds a matching Cisco UCM user ID). Overbuild workflow ...................... :bdg-info-line:`provider-admin` :bdg-info-line:`reseller-admin` The general steps for overbuild are: 1. Initial setup The provisioning of the business hierarchy. Identify the business information of the existing, deployed system, and add these details to 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 Cisco UCM data, so that overbuild processing can move the data to required sites. For example, the default, generated 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. 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. 2. 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 * Cisco UCM Group The rest of the fields are blank for customization. This enables administrators to "over-build" Automate operations on top of customers' existing dial plans. See "Provider HCS Dial Plan Management Support Guide". 3. Configure network device connections Identify and create network device connections, associate these with a Network Device List (NDL) and import. This includes Cisco UCM and CUCX clusters. This step involves provisioning Cisco UC applications, NDLs, and NDL references. Once the UC applications are configured, the sync from Cisco UCM is scheduled and executed. Caution: Whenever this data is synced in, it becomes managed by Automate and, as a result, would be deleted by any hierarchy delete. One Cisco UCM 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 Automate that is mapped to a created hierarchy. 4. 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. 5. 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`` * ``device/cucm/User`` * 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. 6. 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 User Management menu. 7. 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. Run overbuild (Cisco) ...................... :bdg-primary:`Cisco` The Run Overbuild tool processes Cisco UCM imported objects for all sites in the current customer. Run Overbuild must be run at the customer hierarchy. A device model is moved to a site on condition that there is a Network Device List Reference (NDLR) referencing the device at the site. .. note:: The line goes to the first site that the Run Overbuild tool finds. The site selection is not deterministic. The table lists the conditions for creating or updating the internal number inventory (INI) during overbuild: .. tabularcolumns:: |p{8cm}|p{7cm}| +--------------------------------------------------------+----------------------------------+ | Given | Then | +========================================================+==================================+ | * INI exists at site. | The lines in the INI at the site | | * Site Defaults "Create Internal Number Inventory at | are updated to "Used". | | Customer" checkbox is clear. | | +--------------------------------------------------------+----------------------------------+ | * INI exists at customer. | The lines in the INI at the | | * Site Defaults "Create Internal Number Inventory at | customer are updated to "Used". | | Customer" checkbox is clear. | | +--------------------------------------------------------+----------------------------------+ | * No INI exists. | The INI is created at the site. | | * Site Defaults "Create Internal Number Inventory at | | | Customer" check box is clear. | | +--------------------------------------------------------+----------------------------------+ | * INI exists at customer. | The lines in the INI at the | | * Site Defaults "Create Internal Number Inventory at | Customer are updated to "Used". | | Customer" checkbox is selected. | | +--------------------------------------------------------+----------------------------------+ | * INI exists at Site. | The lines in the INI at the Site | | * Site Defaults "Create Internal Number Inventory at | are updated to "Used". | | Customer" checkbox is selected. | | +--------------------------------------------------------+----------------------------------+ | * No INI exists. | The INI is created at the | | * Site Defaults "Create Internal Number Inventory at | Customer. | | Customer" checkbox is selected. | | +--------------------------------------------------------+----------------------------------+ .. _objects-moved-during-overbuild: Objects moved during the overbuild '''''''''''''''''''''''''''''''''''''''''' The overbuild processes imported Cisco UCM objects for selected sites in the current customer. During overbuild, some objects are moved to the site hierarchy, while others remain at the customer hierarchy. .. rubric:: Objects moved to the site during overbuild The list shows objects moved to the site during the overbuild: * Cisco UCM models: * device/cucm/Line * device/cucm/Phone * device/cucm/RemoteDestinationProfile * device/cucm/RemoteDestination * device/cucm/DeviceProfile * device/cucm/User * device/cucm/TodAccess * device/cucm/TimeSchedule * Cisco Unity Connection models: * device/cuc/User * device/cuc/UserPassword * device/cuc/UserPin * device/cuc/AlternateExtension * device/cuc/SmtpDevice * device/cuc/SmsDevice * device/cuc/PagerDevice * device/cuc/PhoneDevice * device/cuc/HtmlDevice * device/cuc/CallHandler * device/cuc/CallhandlerMenuEntry * device/cuc/CallhandlerTransferOption * device/cuc/Greeting * device/cuc/MessageHandler * Voicemail-related models: * device/cuc/User * device/cuc/UserPassword * device/cuc/UserPin * device/cuc/AlternateExtension * device/cuc/SmtpDevice * device/cuc/SmsDevice * device/cuc/PagerDevice * device/cuc/PhoneDevice * device/cuc/HtmlDevice * Self-care models: * device/cuc/Callhandler. By default, one CallHandler entry is created when a Cisco Unity Connection user is created. * device/cuc/CallhandlerMenuEntry * Contact Center After the initial sync, agents will be located at the customer hierarchy level. The overbuild tool will attempt to move these agents to the correct site hierarchy levels, based on matching Cisco UCM users. This matching is done according to the Cisco UCM user ID and the agent user ID. * Contact Center models * device/uccx/Team * device/uccx/Skill * device/uccx/ResourceGroup * device/uccx/Agent Data models affected when the user is moved during overbuild: * data/User .. rubric:: Objects remaining at the customer during overbuild The list shows objects that remain at the customer hierarchy during the overbuild: * Cisco UCM models: * device/cucm/DevicePool * device/cucm/Region * device/cucm/Location * device/cucm/VoiceMailPilot * device/cucm/VoiceMailProfile * device/cucm/Css * device/cucm/RoutePartition * device/cucm/HuntList * device/cucm/HuntPilot * device/cucm/LineGroup * device/cucm/CallPickupGroup * device/cucm/DirectedCallPark * device/cucm/CallPark * device/cucm/CtiRoutePoint * * Cisco Unity Connection models: * operator * undeliverablemessagesmailbox * CallHandler device models: * Goodbye * Opening Greeting * Operator * operator * undeliverablemessagesmailbox * Call Pickup Groups: no objects moved .. rubric:: Related topics * :ref:`move-user-without-services` * :ref:`site-defaults` * :ref:`run-overbuild` * :ref:`user-authentication` * :ref:`number-range-management` * :ref:`perform-a-bulk-load` * :ref:`run-overbuild` * :ref:`uc-overbuild-overview` * :ref:`device-models` * .. raw:: latex Add an inventory of E164 numbers in the Core Feature Guide .. raw:: html Add an inventory of E164 numbers * .. raw:: latex Filter calling search spaces and assign class of service in the Core Feature Guide .. raw:: html Filter calling search spaces and assign class of service