.. _run-overbuild:

Run UC overbuild
-----------------------

.. _18.1-Patch-Bundle-3|EKB-145:
.. _21.1|VOSS-790:
.. _25.3|VOSS-1507|EKB-25879:
.. _25.4|VOSS-1490:


.. tip:: 

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


Overview
..........

The **Run UC Overbuild** tool imports objects. 


.. image:: /src/images/run-overbuild.png 



.. rubric:: Related topics 

* 
  .. raw:: latex

     Microsoft Defender for Office security management and policies in the Core Feature Guide

  .. raw:: html
  
     <a href="ms-defender-for-office.html">Microsoft Defender for Office security management and policies</a> 

* 
  .. raw:: latex

     Microsoft Defender for Endpoint security management and policies in the Core Feature Guide

  .. raw:: html
  
     <a href="ms-defender-for-endpoint.html">Microsoft Defender for Endpoint security management and policies</a> 




Overbuild action 
....................

The table describes options available for **Overbuild Action** on the **Run UC Overbuild** page

.. tabularcolumns:: |p{7cm}|p{8cm}|

+--------------------------------------------------------------+-------------------------------------------------+
| Overbuild action                                             | Description                                     |
+==============================================================+=================================================+
| All Enabled Sites Using Settings Below                       | * Includes all devices selected on the form.    |
|                                                              | * Includes all sites that have their site       |
|                                                              |   defaults doc configured to include the site   |
|                                                              |   in overbuild                                  |
|                                                              | * An internal number inventory is created at    |
|                                                              |   customer level when Create Internal Number    |
|                                                              |   Inventory at Customer setting is selected,    |
|                                                              |   else, it's created at the site (if lines      |
|                                                              |   are included).                                |
|                                                              | * Device pools are from the General Defaults    |
|                                                              |   tab in the Site Defaults, and additional      |
|                                                              |   device pools are from the Overbuild Defaults  |
|                                                              |   tab.                                          |
|                                                              | * The devices that display when                 |
|                                                              |   **Limit Move Devices** is selected on the     |
|                                                              |   **Overbuild Defaults** tab are ignored.       |
|                                                              |   Runs Overbuild for all sites, and uses the    |
|                                                              |   devices selected on the **Run Overbuild**     |
|                                                              |   page.                                         |
|                                                              |                                                 |
|                                                              | When Run Overbuild executes with this option,   |
|                                                              | it applies to all sites and uses devices        |
|                                                              | selected on the **Run Overbuild** page.         |
|                                                              |                                                 |
|                                                              | Run Overbuild devices supersede the devices     |
|                                                              | selected in **Limit Move Devices**.             |
+--------------------------------------------------------------+-------------------------------------------------+
| All Enabled Sites Using Site Defaults Doc Overbuild Settings | * Hides and ignores selected devices on the Run |
|                                                              |   Overbuild page. Moves all selected devices    |
|                                                              |   (when Limit Moved Devices is selected on the  |
|                                                              |   Overbuild Defaults tab in the Site Defaults)  |
|                                                              | * Includes sites that are included for          |
|                                                              |   overbuild in their Site Defaults doc.         | 
|                                                              | * Creates internal number inventory at Customer |
|                                                              |   level (when Create Internal Number Inventory  |
|                                                              |   at Customer option is chosen, else            |
|                                                              |   at site level (if lines is selected).         |
|                                                              | * Device pools are from the General Defaults    |
|                                                              |   tab in the Site Defaults, and Additional      |
|                                                              |   Device Pools are used from the Overbuild      |
|                                                              |   Defaults tab in the Site Defaults.            |
+--------------------------------------------------------------+-------------------------------------------------+


.. tabularcolumns:: |p{7cm}|p{8cm}|

+--------------------------------------------------------------+-------------------------------------------------+
| Overbuild action                                             | Description                                     |
+==============================================================+=================================================+
| Single Enabled Site Using Settings Below                     | * Overbuild is applied to the single site       |
|                                                              |   you choose.                                   |
|                                                              | * The only sites available for selection are    |
|                                                              |   sites included for overbuild via their Site   |
|                                                              |   Defaults.                                     |
|                                                              | * Includes all devices you choose on the page   |
|                                                              | * Creates internal number inventory at Customer |
|                                                              |   (if Create Internal Number Inventory at       |
|                                                              |   Customer option is selected); else,           |
|                                                              |   only at site (if Lines are included)          |
|                                                              | * Device pools are from the General Defaults    |
|                                                              |   tab in the Site Defaults doc, and Additional  |
|                                                              |   Device Pools from the Overbuild Defaults tab. |
|                                                              | * 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** page.       |
|                                                              |                                                 |
|                                                              | When the Run Overbuild tool executes with this  |
|                                                              | option, it applies to the selected site only,   |
|                                                              | and uses devices selected on the Run Overbuild  |
|                                                              | page. Run Overbuild devices supersede the       |
|                                                              | devices selected in **Limit Move Devices**.     |
+--------------------------------------------------------------+-------------------------------------------------+


Available device types 
..........................

Available device types for Run UC Overbuild depend on enabled services in :ref:`global-settings`. For example:

* Cisco CUCM
* Cisco CUCX
* Cisco WebEx
* Cisco Webex App(Teams)
* Cisco UCCX
* Microsoft
* Defender for Office
* Defender for Endpoint


Available device types include:

* Phones
* Phone Remote Destinations
* Users (``device/cucm/User``)
* 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 App Users
* Pexip Users
* Contact Center Agents
* Microsoft Users 
* Microsoft Defender for Endpoint
* Microsoft Defender for Office



Affected device models 
............................

The following device models are affected by the overbuild move:

* 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/pexip/Conference
* device/spark/User
* device/uccx/Team
* device/uccx/Skill
* device/uccx/ResourceGroup
* device/uccx/Agent
* device/msexchangeonline/SafeAttachmentPolicy
* device/msexchangeonline/SafeLinksPolicy
* device/msexchangeonline/QuarantinePolicy
* device/mssecurity/Machine
* device/msgraphsecurity/Alert
* device/msgraphsecurity/Incident
* device/msgraph/Room

.. note::

   In Microsoft environments, certain device models are moved based on relationships with other entities 
   during overbuild. For example, meeting rooms (`device/msgraph/Room`) are associated with Microsoft users 
   and are automatically moved to the same hierarchy level when the corresponding Microsoft user is moved.

   This association is determined by matching the room email address with the user principal name (UPN).


Affected data models 
.......................

The following data models are affected when moving a user during overbuild: 

* ``data/User``


Device types available for selection depend on the status of other device type check boxes. For 
example: 

* The following device types are only available if you've selected **Phones**: 

  * Dual-Mode Remote Destinations
  * Users
  * Lines

* The following device types are only available if you've selected **Users**: 

  * Device Profiles
  * Remote Destination Profiles
  * CUC Users


Overbuild and failures 
...........................

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, sub-transactions of a successful overbuild workflow show
their status as "Fail" if a model (such as a User) already exists. 
The sub-transaction logs also show details of the duplicate model and an
"ignore error code" information message.

If a number already exists and the global setting *Prevent Duplicate Number* is enabled, the 
sub-transaction to create a duplicate of an existing number fails.


.. rubric:: Related topics

* 
  .. raw:: latex

     Prevent duplicate numbers in the Core Feature Guide

  .. raw:: html
  
     <a href="prevent-duplicate-numbers.html">Prevent duplicate numbers</a> 






