[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.

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:

Available device types include:

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

Data models affected when the user is moved during Overbuild:

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.

Note

To access the Run Overbuild tool, go to (default menus) Overbuild > Run Overbuild. Alternatively, search for Run Overbuild from the VOSS Automate Search bar.

Overbuild Action

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

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.
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 include:

Affected device models

The following device models are affected by the overbuild move:

Affected data models

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

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

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.

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 INI (Internal Number Inventory) during overbuild:

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.

Objects Moved During the Overbuild

The overbuild processes imported Ç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.

Objects moved to the site during overbuild

The table describes objects moved to the site during the overbuild:

Object Description
Unified CM models

device/cucm/Line

device/cucm/Phone

device/cucm/RemoteDestinationProfile

device/cucm/RemoteDestination

device/cucm/DeviceProfile

device/cucm/User
HCMF (if installed) device/hcmf/User
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

Data models affected when the user is moved during overbuild:

Objects remaining at the customer during overbuild

The table describes objects that remain at the customer hierarchy during the overbuild:

Object Description
Unified CM 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

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.

Important

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

In VOSS 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 a VOSS 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 VOSS Automate that can be set up to run at a selected interval.

The table describes overbuild logic for handling users and subscribers:

Component Description
Users

The synced in Microsoft tenant user is moved to the site, based on the MS 365 model filter criteria selected for the site in the site overbuild defaults. To allow this, ensure you select Include Site for Overbuild and Microsoft Users (on the Overbuild Defaults tab in the site defaults).

To view the number of Microsoft users at the hierarchy level (MS 365 users, MS Teams users, and MS Exchange users), go to Overbuild > Overview Tool.
Subscribers A Microsoft tenant user can be set up with services using Quick Subscriber.

Related Topics

Configure Overbuild Site Defaults for Microsoft

Pre-requisite:

Note

To configure a site for overbuild:

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

Note

Alternatively, go to (default menus) Site Management > Defaults and select the Overbuild Defaults tab.

  1. Choose a site to open its settings.
  2. On the Overbuild Defaults tab, configure the following:
  3. On the Move Filter Criteria tab, at the MS 365 User Model Filter Criteria dropdown, select the relevant filter. For more information about filters, see Model Filter Criteria.

Run Overbuild

  1. In the VOSS 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. VOSS 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.

Note

The overbuild moves assigned numbers to the number inventory, flagged with the user's name, location (customer or site), number status (Used when assigned, else, Available), and the relevant vendor (Microsoft, in this case).

The number management step occurs on sync, overbuild, as well as in a number audit. You can run a number audit anytime to verify that numbers are correctly flagged as used or available (via Number Management > Audit Number Inventory) - see Run the Directory Number Inventory Audit Tool.

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

Model Details: view/EasyOverbuild

Title Description Details
Overbuild Action Select the method of Overbuild execution. NOTE: only sites that have been enabled by having 'Include Site for Overbuild' selected in the Site Defaults Doc will be affected. Default: all
  • Field Name: siteInclude
  • Type: String
  • Default: all
  • Choices: ["All Enabled Sites Using Settings Below", "All Enabled Sites Using Site Defaults Doc Overbuild Settings", "Single Enabled Site Using Settings Below"]
Select Site User selects specific site to apply overbuild to. NOTE: only sites that have been enabled by having 'Include Site for Overbuild' selected in the Site Defaults Doc will be displayed.
  • Field Name: site
  • Type: String
Phones Move Phones, which match the configured Device Pool, to destination site. Default: true
  • Field Name: move_phone
  • Type: Boolean
  • Default: true
Headsets Move Headsets, which match the associated User and/or Phone. Default: true
  • Field Name: move_headset
  • Type: Boolean
  • Default: true
Phone Remote Destinations Move Phone Remote Destinations to associated Phone. Default: true
  • Field Name: move_remote_destination_phone
  • Type: Boolean
  • Default: true
Users Move Users to associated Phones. Default: true
  • Field Name: move_user
  • Type: Boolean
  • Default: true
Device Profiles Move User Device Profiles to associated User. Default: true
  • Field Name: move_device_profile
  • Type: Boolean
  • Default: true
Remote Destination Profiles (RDP) Move Remote Destination Profiles to associated User. Default: true
  • Field Name: move_remote_destination_profile
  • Type: Boolean
  • Default: true
RDP Remote Destinations Move RDP Remote Destinations to associated Remote Destination Profile Default: true
  • Field Name: move_remote_destination
  • Type: Boolean
  • Default: true
Lines Move Lines associated to 1) Phones, 2) Device Profiles, 3) RDPs. Default: true
  • Field Name: move_line
  • Type: Boolean
  • Default: true
CUC Users Move Unity Connection Users to associated User Default: true
  • Field Name: move_cuc_user
  • Type: Boolean
  • Default: true
Webex App Users Move Webex App Users to Site level where a User exists with the same email address. Default: true
  • Field Name: move_webex_teams_user
  • Type: Boolean
  • Default: true
PexIP Users Move PexIP Users to Site level where a User exists with the same username. Default: true
  • Field Name: move_pexip_user
  • Type: Boolean
  • Default: true
Contact Center Agents Contact Center Agents that have a User at Site level with same user ID. Default: true
  • Field Name: move_contact_center_agent
  • Type: Boolean
  • Default: true
Microsoft Users Move Microsoft Users down to Site level using Model Filter Criteria. Default: true
  • Field Name: move_ms_user
  • Type: Boolean
  • Default: true