[Index]
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 |
---|---|
|
The lines in the INI at the Site are updated to "Used". |
|
The lines in the INI at the Customer are updated to "Used". |
|
The INI is created at the Site. |
|
The lines in the INI at the Customer are updated to "Used". |
|
The lines in the INI at the Site are updated to "Used". |
|
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
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:
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.
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 |
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 |
|
Overbuild action | Description |
---|---|
Single Enabled Site Using Settings Below |
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 |
---|---|
|
The lines in the INI at the Site are updated to "Used". |
|
The lines in the INI at the Customer are updated to "Used". |
|
The INI is created at the Site. |
|
The lines in the INI at the Customer are updated to "Used". |
|
The lines in the INI at the Site are updated to "Used". |
|
The INI is created at the Customer. |
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 |
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 Unified CM users. This matching is done according to the Unified CM 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:
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 |
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:
Note
Alternatively, go to (default menus) Site Management > Defaults and select the Overbuild Defaults tab.
Run Overbuild
In the VOSS Automate Admin Portal, go to (default menus) Overbuild > Run Overbuild.
Choose the site.
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.
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
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 |
|
|||||||||||||||||||||||||||||||||||||||||||||||
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. |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phones | Move Phones, which match the configured Device Pool, to destination site. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Headsets | Move Headsets, which match the associated User and/or Phone. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Phone Remote Destinations | Move Phone Remote Destinations to associated Phone. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Users | Move Users to associated Phones. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Device Profiles | Move User Device Profiles to associated User. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Remote Destination Profiles (RDP) | Move Remote Destination Profiles to associated User. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
RDP Remote Destinations | Move RDP Remote Destinations to associated Remote Destination Profile Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Lines | Move Lines associated to 1) Phones, 2) Device Profiles, 3) RDPs. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
CUC Users | Move Unity Connection Users to associated User Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Webex App Users | Move Webex App Users to Site level where a User exists with the same email address. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
PexIP Users | Move PexIP Users to Site level where a User exists with the same username. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Contact Center Agents | Contact Center Agents that have a User at Site level with same user ID. Default: true |
|
|||||||||||||||||||||||||||||||||||||||||||||||
Microsoft Users | Move Microsoft Users down to Site level using Model Filter Criteria. Default: true |
|