[Index]

Model: view/EasyOverbuild

Run Overbuild

To access the latest documentation, go to Documentation and Resources at: https://voss.portalshape.com

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.

The conditions for creating or updating the INI (Internal Number Inventory) during Overbuild are listed in the table below:

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 App Users
• Pexip 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/pexip/Conference
• 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/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.

Run Overbuild

Full HTML Help

Overview

The Run Overbuild tool imports objects.

Overbuild Action

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

Available device types

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

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

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.

Run Overbuild (Cisco)

CISCO

The Run Overbuild tool processes CUCM 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.

The table lists the conditions for creating or updating the INI (Internal Number Inventory) during overbuild:

Overbuild for Microsoft

Full HTML Help

Overview

The Overbuild feature enables Provider and Reseller administrators to integrate existing, deployed Microsoft tenants into VOSS Automate without re-provisioning, unless required.

In Automate, a Microsoft tenant shows the combined and specific details of a MS Office 365 and MS Teams tenant.

Overbuild provides tools to help the administrator manage Microsoft Tenant data synced from existing configurations.

While a Microsoft Tenant does not contain such VOSS Automate components as a hierarchy or a subscriber, the relationship with Microsoft tenant components makes it possible to, for example, create an Automate subscriber at a site hierarchy during the Overbuild process. The necessary filters can be set up and workflows, macros, and brownfield move processes are available for this purpose.

After overbuild is run for the first time, a schedule is created in Automate that can be set up to run at a selected interval.

The table describes overbuild logic for handling users and subscribers:

Related Topics

• Quick Add Subscriber for Microsoft Users.

Configure Overbuild Site Defaults for Microsoft

Pre-requisite:

• Microsoft User Move Configuration

To configure a site for overbuild:

1. In the Automate Admin Portal, go to (default menus) Overbuild > Site Defaults.

2. In the Site Defaults list view, click on a site to open its site default settings.

3. On the Overbuild Defaults tab, configure the following:

   • Enable Include Site for Overbuild
   • At Overbuild Device Control, choose Limit Moved Devices.
   • Select Microsoft Users to enable Microsoft users.

4. On the Move Filter Criteria tab, configure the following:

   • At MS 365 User Model Filter Criteria, select the relevant filter.

     Note

     For more information about filters, see Model Filter Criteria.

   • If required, select Move by Number.

     Note

     User data is moved to a site using Move by Number only if the synced in Microsoft Teams user's LineURI matches a pre-loaded internal number at that site.

     If you've selected a filter for MS 365 Model Filter Criteria and you've enabled Move by Number, the overbuild first processes MS 365 Model Filter Criteria, and then processes Move by Number.

     For more information about options on the Move Filter Criteria tab, see Site Defaults in the Core Feature Guide.

Related Topics

Site Defaults in the Core Feature Guide

• Model Filter Criteria

Run Overbuild

1. In the Automate Admin Portal, go to (default menus) Overbuild > Run Overbuild.

2. Choose the site.

3. In a Microsoft-only environment, select only Microsoft Users to include in the overbuild.

   Note

   This allows Microsoft users to move to the site. Automate looks at the MS user, and checks whether it has MS Teams and MS Exchange, and moves these elements to the sites along with the user.

4. Save your changes to run the overbuild.

Related Topics

Microsoft User Move Configuration in the Core Feature Guide

Model Filter Criteria in the Core Feature Guide

Flow Through Provisioning in the Core Feature Guide

• Run the Directory Number Inventory Audit Tool

Model Details: view/EasyOverbuild