| Table of Contents |
|---|
Wrangler
...
Settings
Below are described the UCMC UCMCwrangler_tool global settings. These can generally be left as default but contain some settings that may be useful to change depending on migration requirements, particularly the Mapping Tables that define the Site suggestions for migration
...
Settings
General settings define global performance metrics and other global settings.
...
Setting | Default Value | Description |
|---|---|---|
General Settings | ||
Generate new incremental siteID’s | OFF ON (Default) | Site ID’s number will generate incrementally. If off will leave as Site name |
Workflow Performance Settings | ||
CUCM AXL List Page Size | 150 | Controls size of each page when loading lists of items via AXL. |
CUCM AXL Simultaneous Request Limit | 15 | Controls how many simultaneous requests to send via AXL. Exceeding 24 is not recommended. |
CUCM AXL Simultaneous Write Limit | 2 | Controls how many simultaneous updates to send via AXL. Exceeding 2 is not recommended for low vCPU CUCM clusters. |
Yarnman CouchDB Simultaneous Request Limit | 50 | Controls how many simultaneous requests to send to Couch. Exceeding 200 is not recommended. |
Unity CUPI List Page Size | 200 | Controls size of each page when loading lists of items via Unity CUPI |
Unity CUPI Simultaneous Request Limit | 5 | Sets the amount of objects to be retrieved from Unity/UCXN API calls. |
Unity CUPI Request Timeout (ms) | 30000 | Controls how long to wait for Unity to respond to an API request before triggering a timeout. Exceeding 60s is not recommended. |
Unity CUPI Sync Backoff Time (ms) | 90000 | Controls how long to wait for Unity to retry a sync request after encountering a problem. Only effects sync/discovery requests. |
Unity CUPI Sync Backoff Retry Times | 3 | Sets the amount of times to retry a sync request after the backoff above. |
Maximum validation issue item count | 5000 | Controls the number of entries that can be saved in validation issue task |
Interstep processing pause | 10000 | Controls pause during clone transform process |
UCMC Settings | ||
CDR Repository Path | /var/lib/couchdb/cdr | Local path that CDR folders and files are deposited in. Default is /var/lib/couchdb/cdr These are required if running migration report CDR Dialing Forest |
Mappings
...
Defaults
The Defaults tab defines the default settings that are displayed on the migration initiation screen.
...
Customer Prefix defines the prefix for multiple dialplan objects deployed for Template Migration only
Site Prefix defines the prefix for multiple dialplan objects deployed for Template Migration only
...
Mapping Object Defaults
The Mapping Object Default Matrix defines source data objects mapping to target data objects. These should be left as default
...
Mapping Tables
Mapping Tables contain Templates that are used to determine Sites during the Site allocation migration step. These regexes can be modified as required to correctly match source cluster settings required to create site suggestions during the migration. Note that these are global settings, but they can also be modified on a migration specific basis during the migration. This is described under migration process chapter.
...
Tip - most Mapping Table common object used to create site suggestions is Device Pool, but the more objects are mapped the easier it is to determine migration object site allocation
Source Type Actions
Depending on the dial plan migration option the CUCM configuration objects will be migrated using one of the four functions.
...
Tip - If unsure what objects requires mapping (needs preconfiguration in target) the Source Type Action Defaults table will confirm all objects that require mapping for each dialplan migration type
Site Suggestions
Site Suggestion work in conjunction with Mapping Tables to define specific conditions to be met for creating sites. In example as per screen shot below, it is specified that Device Pools are mandatory for site suggestions and that there needs to be a minimum of 1 template match to create a site suggestion.
...
Tip - most common object used to create site suggestions are Device Pools
Schemas
...
Schemas contain templates defining how objects are treated during a migration. The initial installation contain a Default schema, but customised schemas might be imported and used if required.
...
| Note |
|---|
The Default schemas should not be altered - if for some reason changes are required, the default schema should be cloned and modifications performed on the clone only |
Customer
The Customer Screen display enables information regarding the customer to be added and modified as and if required in the Override Value column, then Save Changes
...
Clusters
The source and target clusters are automatically defined after discovery for single source and target cluster migration.
The Clusters menu item displays information regarding the Source and Target Cluster interfaces and servers
...
Selecting the MainTargetCluster link displays information re the target cluster.
It is not recommended to change any value in the Cluster or other tabs here unless advised to by support
...
WxC-MT
Licenses
A default license must be defined for WxC-MT migration. The Licenses menu option displays defined default licenses for the current migration, and allows for the addition of new or removal of previously defined default licenses.
...
To remove displayed license/s - select the X in red box adjacent to the license
...
Roles
The Roles menu option allows for the addition of required/ removal of previously defined WxC-MT Roles for the migration by selecting Roles to be added from the drop down followed by the +Add button and/or the removal of previously defined Roles for migration by selecting the X in Red Box
...
Sites
Sites are used to group the various configuration objects within the source cluster and are also selected for the migration batches
...
Site may also be Imported and Exported in CSV format for bulk updates of details, this is particularly useful when many sites for Grouping sites and also for adding Address details that are required for WxC-MT migrations as can be seen in below screenshot
...
Countries
The Countries menu option allows for the view, add or modification of country details pertinent to countries where migrating sites resides. These settings are used for site country allocation
...
Select the country from the Identifier column to view and edit country specific details
...
Mapping Tables
The Mapping Table option within the migration allows for the change of mappings on a per migration basis, then preview to check if the defined templates generate site suggestions as required. To check site suggestions for a particular mapping table option - select Preview table adjacent to required mapping source - in the below sample, we select Preview Table adjacent to Device Pools, although any of the Objects in the Name column can be used to generate sites.
...
If we now add a new template to try and match the DP that was not matched in original run, then Save and Preview, we can now see that the Device Pools match the new template.
...
Target Mappings WxC-DI
Select Target Mappings menu item to view the status of all objects. The Target Mappings are divided into four object types:
...
You can view the details of each object for each type.
Map Types
Map types are objects that must be mapped from source to target clustter. The types show objects in Unmapped, Mapped, Skipped, Loaded state. During a migration you will be prompted to map the objects that are currently unmapped, all of these are highlighted in Yellow in Map Types (mandatory mappings) section under Source Cluster Objects, Unmapped, Customer headings and cannot progress until all mappings performed.
...
If there are objects that should not be migrated, from the target object drop down, select Skip Target Binding
...
Transform Types (only shows in Map or Template Migrations)
Transform Types are objects that are transformed during a Map or Template migration where the object needs to be transformed such as for example if a partition changes between source and target, all the objects that use that partition will be transformed to use the new target partition
As per the Map types, the Transform Types shows the migration status summary of all transform objects, Waiting, Transformed, Skipped and Moved state.
...
Clone Types
Clone Types are objects that are cloned from source to target
...
| Note |
|---|
Note that renaming of objects such as device pool is not fully automated for clone and is not recommended If you do rename device pools it should be done during clone on the cloned object but you will need to update every reference for the object i.e. for device pool each phone that references will need to be updated with the new name |
Skip Types
Skip types are objects that are skipped in the migration
...
Objects can also be set to skip using bulk change from v2.5.15 by setting the targetId to Skip
...
Target Mappings WxC-MT
Select Target Mappings menu item to view the status of all objects in a WxC-MT migration. The Target Mappings are here divided into:
Mappings
Multi-Tenant Transforms
Skipped Types
Skipped Objects
Mappings
Mappings are objects that must be mapped from source to target. The types show objects in Waiting, Skipped, Issues and Mapped state. During a migration you will be prompted to map the objects that are currently unmapped, all of these are highlighted in Yellow in Mappings section and cannot progress until all mappings performed.
Multi-Tenant Transforms
These shows the status of objects that are transforming from CUCM format to WxC-MT format
Skipped Types
These how types of objects that don’t have any mappings in the particular migration
Skipped Objects
Shows specific objects with no target mappings in the migration
Schema
Templates
Selecting Templates from the menu will display all templates in the schema used for the current migration. The templates define what treatment will be performed on a type of object during the migration.
...
To view or modify a template, select the link in the Name column which will bring up the detail of the Template in question. Here the template can be modified and a preview on the outcome of template be performed by selecting the Preview Template Button to verify the expected outcome prior to migration or for troubleshooting. If a template is modified here, using Override Template, this modification is only valid for current migration
...
Call Types
Call types specifies all the different Global call types used in the Wrangler UCMC dial plan.
| Note |
|---|
It is not advisable to modify or add to this unless advised by support |
...
Objects
Browse
The Object Browser can be accessed from menu by selecting Objects → Browse and isan essential tool during the migration process as it displays the status of and is used to display and modify any of the objects that are being migrated. A specific object can be searched for using the Search box where the object name or part of it can be entered. It is also possible to narrow down the view by using the filters.
...
To view a specific object select Edit link corresponding to the specific Object. To modify an object, specify the override value in the Override Value column corresponding to the parameter to be altered, then save
...
Select the objects that should be modified, then modify as required and Save Changes
...
Configure Actions
The Objects->Configure Actions menu item will display the action taken for a particular object type during the migration being
...
| Note |
|---|
It is not advisable to alter the action for objects without consulting support |
...
Clones & Transforms
The Objects → Clones & Transforms menu displays all objects that have been Cloned & Transformed. The top right of the screen shows if any objects with issues. Filters can be used to narrow down the displayed objects. If the object is selected it will bring up the object summary detail screen with a link to Object Browser for the item with more detail for further investigation.
...
Dialplan
The Objects → Dialplan report displays all Dialplan objects status when performing a Template Dial plan migration. The Status column shows the current status of each objects. A Green tick adjacent to object means that it has been loaded OK. Any objects with a + Sign has not been loaded. To investigate a Dialplan object, select it from the Object column which will bring up a detailed view in the Object Browser.
...
SIP Trunks
Menu item Objects - > SIP Trunks will show an SIP trunk includd in the migration. Select the Edit link adjacent to SIP trunk to watch detail for the trunk in Object Browser.
...
Ignoring Rules
The Ignoring Rules report will show any Rules that have been selected to be ignored post validation steps. Individual ignored rules may be investigated by selecting the Edit link adjacent to object in question which will show detail view of it in the Object Browser. The report may be Exported using the Export link in top right hand corner above of the table
...
Users Missing Email
Menu item Objects → Users Missing Email displays any users that are missing Email, Select the link to individual user to bring up Object Browser with more detail and to resolve as required. The report may be Exported using the Export link in top right hand corner above of the table
...
Dialplan
Configuration
Menu item Dialplan → Configuration allows for configuration changes to Dial plan default settings
...
*There are additional values available to select in the Default Migraton Point/ Change-At-Settings Values column but only the most common selections shown here.
Routing Analysis - Future Option
The Dialplan → Routing Analysis selection will provide a Routing Analysis of Dialplan filtered as required on
...
To download the report, select the Download XLSX Report button
...
Numbers
Number Mappings
Displays all Infra Numbers with detail displaying the Source Object (with Link to Object detail), Allocated Site, Migration Status, Type (Title), DN, DN Path, E164, E164 Path, CC, Area and Mapped Target
...
MT Location Numbers
Displays all WxC-MT numbers. By selecting the Edit Number link adjacent to each number, the Infra-source number of each item may be viewed and modified as required
...
DN
The Number Ranges → DN report shows all discovered DN ranges/ site and size of the range> to Edit a range, select the Edit Range link adjacent to the corresponding DN range.
...
To download the report, select the Download XLSX Report button
...
E164
The Number Ranges → E164 report shows all discovered E164 ranges and DN range/ site and size of the range. to Edit a range, select the Edit Range link adjacent to the corresponding DN range
...
To download the report, select the Download XLSX Report button
...
Invalid E164s
The Number Ranges → E164 report shows all invalid E164 ranges discovered
To download the report, select the Download Report button
...
Conflicts
The Number Ranges → Conflicts report shows conflicting E164, DN and range size conflicts
To download the report, select the Download Report button
Transformation
Renumbering - this feature enhanced in version 2.5.20
The Transformation → Renumbering option allows for the transformation of existing individual numbers or number ranges as part of the migration and should be performed post prepare step and prior to load as it can only be applied to target objects
...
All impacted numbers and associated will display. Object types can be unselected if required, also any individual item can be unselected by selecting Transform toggle adjacent to the item. When all adjusted as required, select Apply Renumbering
...
Reports
Step Changes
The Reports → Step Changes report provides a report providing all changes performed in each migration step
...
| Info |
|---|
Depending on the cluster/s size this report may take some time to generate |
...
Orphaned Objects
The Reports → Orphaned Objects report is initiated by selecting Generate Orphaned Objects which will generate a report that may be downloaded by selecting the link, then opened in Excel. The individual orphand object types may be viewed by selecting relevant tab.
...
Service & Enterprise Settings
The Reports → Service & Enterprise Settings report is initiated by selecting Generate Service & Enterprise Settings which will generate a report that may be downloaded by selecting the link, then opened in Excel. The Service & Enterprise Settings may be viewed by selecting relevant tab.
...
CSS Usage
The Reports → CSS Usage option will generate a report on CSS usage in the source cluster that may be downloaded and viewed in Excel. There are individual Tabs for CSS Usage Objects, CSS Usage and Unused CSSs
...
Dialing Forest
Uses the dialling forest DA dump from DNA to compare the source and target dial plans to ensure all patterns are present. To generate the report from menu, select Reports → Dialing Forest then select Generate
...
Report may be downloaded by selecting the link and may also be viewed by selecting the Report X tab
...
Expand as required
...
CDR Dialing Forest
Extracts dialling patterns from CDR for cross reference to ensure historical patterns dialled are available on the target cluster. Select Reports → CDR Dialing Forest then select Generate to run the report. Noting that there must be a CDR file loaded to server in CDR path (path may be found in Settings)
Reconcile Clusters
The Reports → Reconcile Clusters report initiates a report to reconcile any differences between the source and target clusters
...
Select Source & Target Objects to view differences
...
Dialplan Connections
Select Generate Dialplan Connections to generate Dial Plan Connections report. When completed select the link to download the Excel spreadsheet
...
Inter-Site Dependancies
New feature in 2.5.15
Select Inter-Site Dependancies, press generate and select the site group to generate Inter-Site Dependancies report. When completed review the results
...
Example report with no inter-site issues
...
...
Duplicates Objects
This menu item allows for bulk update of object migration status. Any objects that are flagged as duplicate issues during the migration can be bulk updated here. There are four tabs
...
select required tab with data, then select action for the object groups using check box and if consolidating clusters select the Source Cluster object to use or for duplicates between source and target Ignore Source to keep object in target unchanged or Update Target Object to update target with source configuration, then select the Bulk Update button to perform the change
...
Bulk Changes
Bulk Change
Bulk changes may be used to bulk change objects in Wrangler or to create a Migration point Change
...
Note that if performing bulk change moving objects to Site from customer level, ensure to also select ‘Change At’ to ‘During Site Load' or alternatively if moving objects from Site to Customer level, set site to null and ‘Change At’ to 'Before any Sites Loaded’
Migration Change Point
The migration change point provides a way to run in isolation any specific work flow task based on the migration change point and optional Site(s)
...
TIP - Migration Point 'Change At' will generally be During Site Load or Before Any Sites Loaded
...
ITL Reset
Reset
The Wrangler UCMC tool includes a tool to reset ITL certificates on phones to enable registration of end devices in target cluster*
...
Phones meeting the criteria will be displayed, individual phones may be unselected by selecting the Selected link adjacent to the phone.
When ready, select Run ITL Reset which will reset the certificates on the selected end devices
...
ITL Scripts
The ITL Reset → ITL Scripts menu item will display a list of end device types. To view the ITL or CTL reset script for a particular phone model, select the adjacent ‘Eye’
...
The created duplicate will be displayed
...
Rules
Imported data from source clusters are validated against preset validation rules. These rules may be enabled or disabled by selecting Rules from the menu, to disable or enable individual rules, select the relevant check box - YES enables the rule, NO disables the rule
...
Tasks
The Tasks menu item will display all the individual task steps that have been performed by Wrangler UCMC. Additionally, tasks include an option to Delete or Reset current Migration.
The details of each task may be viewed by selecting the corresponding Completed link.
...
From the detail, the Events tab may be selected which will display all the events and errors pertaining to the task
...