Run Overbuild: Overview

Run Overbuild processes Unified CM imported objects for all sites in the current customer. It 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 conditions for creating or updating the INI (Internal Number Inventory) during Overbuild are listed in the table below:

Given Then
  • INI exists at Site.
  • Site Defaults “Create Internal Number Inventory at Customer” check box is clear.
 The lines in the INI at the Site are updated to “Used”.
  • INI exists at Customer.
  • Site Defaults “Create Internal Number Inventory at Customer” check box is clear.
 The lines in the INI at the Customer are updated to “Used”.
  • No INI exists.
  • Site Defaults “Create Internal Number Inventory at Customer” check box is clear.
 The INI is created at the Site.
  • INI exists at Customer.
  • Site Defaults “Create Internal Number Inventory at Customer” check box is selected.
 The lines in the INI at the Customer are updated to “Used”.
  • INI exists at Site.
  • Site Defaults “Create Internal Number Inventory at Customer” check box is selected.
 The lines in the INI at the Site are updated to “Used”.
  • No INI exists.
  • Site Defaults “Create Internal Number Inventory at Customer” check box is selected.
 The INI is created at the Customer.

The options available in the Overbuild Action drop-down are:

  • All Enabled Sites Using Settings Below

    • All selected devices on the Run Overbuild form are included.

    • The Site Defaults Doc for each site contains an Overbuild Defaults tab. If the Include Site for Overbuild check box is selected, the site is included.

    • An internal number inventory is created at customer level if the Create Internal Number Inventory at Customer check box is selected or at site level if the check box is cleared (if Lines are included).

    • The Device Pools are from the General Defaults tab of the Site Defaults Doc and the Additional Device Pools from the Overbuild Defaults tab.

    • The devices displayed when the Limit Move Devices option is selected on the Overbuild Defaults tab are ignored. Runs Overbuild for all sites, and uses the devices selected on the Run Overbuild form.

      When the Run Overbuild tool executes with this option, it will apply to all sites and use the devices selected on the Run Overbuild form. Run Overbuild devices supersede the devices selected in Limit Move Devices.

  • All Enabled Sites Using Site Defaults Doc Overbuild Settings

    • Selected devices on the Run Overbuild form are hidden and ignored. All selected devices when Limit Moved Devices is chosen on the Overbuild Defaults tab of Site Defaults are moved.
    • The site is included only if the Include Site for Overbuild check box is selected.
    • An internal number inventory is created at customer level if the Create Internal Number Inventory at Customer check box is selected or at site level if the check box is clear (if Lines are included).
    • The Device Pools are from the General Defaults tab of Site Defaults and the Additional Device Pools from the Overbuild Defaults tab will be used.

  • Single Enabled Site Using Settings Below

    • Overbuild is applied to the single site specified in the Select Site drop-down, which is exposed when this Overbuild option is selected.

      Only sites that have the Include Site for Overbuild check box selected in the Site Defaults Doc are available in the drop-down.

    • All selected devices on the Run Overbuild form are included.

    • An internal number inventory is created at customer level if the Create Internal Number Inventory at Customer check box is selected or at site level if the check box is clear (if Lines are included).

    • The Device Pools are from the General Defaults tab of the Site Defaults Doc and the Additional Device Pools from the Overbuild Defaults tab.

    • The devices displayed when the Limit Move Devices option is selected on the Overbuild Defaults tab are ignored. Runs Overbuild for the selected site, and uses the devices selected on the Run Overbuild form.

      When the Run Overbuild tool executes with this option, it applies to the selected site only, and uses the devices selected on the Run Overbuild form. Run Overbuild devices supersede the devices selected in Limit Move Devices.

Available device types include:

  • Phones
  • Phone Remote Destinations
  • Users:
    • device/cucm/User
    • device/hcmf/User (only if HCM-F is installed)
  • Device Profiles
  • Remote Destination Profiles (RDP)
  • RDP Remote Destinations
  • Lines (a number inventory entry is also added for all device/cucm/Line instances that are in the system at the customer or site level)
  • CUC Users
  • Webex Teams Users
  • Contact Center Agents

The specific device models that are affected by the Overbuild move, are:

  • device/cuc/User
  • device/cuc/UserPassword
  • device/cuc/UserPin
  • device/cuc/AlternateExtension
  • device/cuc/ExternalServiceAccount
  • 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
  • device/cucm/Phone
  • device/cucm/User
  • device/cucm/DeviceProfile
  • device/cucm/RemoteDestinationProfile
  • device/cucm/RemoteDestination
  • device/cucm/Line
  • device/hcmf/User (only if HCM-F is installed)
  • device/spark/User
  • device/uccx/Team
  • device/uccx/Skill
  • device/uccx/ResourceGroup
  • device/uccx/Agent

Data models affected when the user is moved during Overbuild:

  • data/User
  • data/LdapUser
  • data/SsoUser
  • data/NormalizedUser
  • data/HcsUserProvisioningStatusDAT
  • data/HCSHcmfUserDAT

The availability of certain device type check boxes depends on the status of other device type check boxes. For example, the Dual-Mode Remote Destinations, Users, and Lines check boxes are only available if the Phones check box is selected. The Device Profiles, Remote Destination Profiles, and CUC Users check boxes are only available if the Users check box is selected.

Overbuild workflows do not stop on any transaction failures and no transaction rollback takes place on errors. For example, device instance move operations to Sites continue for all selected devices. Inspect the transaction log for errors.

In the Transaction log, subtransactions of a successful overbuild workflow show their Status as “Fail” if a model (such as a User) already exists. The subtransaction logs also show details of the duplicate model and an “ignore error code” information message.