| Table of Contents |
|---|
Wrangler Global Settings
Below are described the wrangler_ WxC 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
...
...
wSettings
General settings define global performance metrics and other global settings.
| Note |
|---|
These should generally be left as default unless performance issues experienced interfacing with CUCM and/ or UCXN |
...
General Settings
...
...
Setting
...
Default Value
...
Description
| Note |
|---|
Note that saving global settings will reset workflow services, so not recommended to perfom in middle of migration task such as Discovery, Allocation, Validation, Prepare, Load |
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 | ||
Enable VOSS4UC Hierarchy Move | OFF (Default) ON | Enables VOSS4UC hierarchy move - this should only be enabled for HCS to HCS migrations | |
Couch Database Settings | |||
Yarnman CouchDB Simultaneous Request Limit | 50 | Controls how many simultaneous requests to send to Couch. | |
Yarnman CouchDB Find Page Size | 200 | Controls the page size of find requests in Couch. | |
Yarnman CouchDB Bulk Get Batch Size | 500 | Controls the batch size of bulk load object requests in Couch. | |
Yarnman CouchDB Bulk Add/Update Batch Size | 500 | Controls the batch size of bulk add/update object requests in Couch. | |
CUCM Settings | |||
CUCM AXL List Page Size | 150 | Controls size of each page when loading lists of items via Unity CUPIUnity CUPI AXL. | |
CUCM AXL 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 | 315 | Controls how many simultaneous requests to send via AXL. | |
CUCM AXL Simultaneous Write Limit | 2 | Controls how many simultaneous updates to send via AXL. | |
CUCM AXL Sync Backoff Time | 75000 | Controls how long it will take to wait to send the next AXL request. Default is 75 seconds | |
CUCM AXL Sync Backoff Retry Times | 5 | Sets the amount of times to retry a sync AXL 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.
Default Schema gives option to select any custom schemas that may have been created for migration
Target Dialplan defines what Default Dialplan to be displayed when using Template Dialplan migration
Dialplan Configuration defines what dialplan migration option is displayed by default when initiating Migration
Default Countries gives option to add countries to be added by default during migration
Theses settings are the default display settings only and can be modified as required when initiating each migration.
Prefix Templates settings defines the prefixes for Dialplan objects when using Template Migration only
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.
...
Mapping Regexes define the source template objects, the siteId Source template regex is used to define the site for the Site Suggestions in the migrations
...
Default is 5 retries | ||
Enable Fast Sync | OFF ON | Using this switch, you can enable/disable the fast sync function, which uses an AXL listChanges request to collet changes during the Wrangler sync process. Default is true |
Unity Settings | ||
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. |
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. |
Webex Settings | ||
Webex List Page Size | 50 | Controls size of each page when loading lists of items via Webex API. |
Webex Simultaneous Request Limit | 20 | Controls how many simultaneous requests to send via Webex API. |
Webex Simultaneous Write Limit | 4 | Controls how many simultaneous updates to send via Webex API. Default is 4. |
Webex Request Timeout (ms) | 45000 | Controls how long to wait for webex to respond to an API request before triggering a timeout. |
Webex Sync Backoff Time (ms) | 60000 | Controls how long to wait for webex to retry a sync request after encountering a problem. |
Webex Sync Backoff Retry Times | 4 | Sets the amount of times to retry a sync request after the backoff above. |
Workflow Settings | ||
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.
Default Schema gives option to select any custom schemas that may have been created for migration
Target Dialplan defines what Default Dialplan to be displayed when using Template Dialplan migration
Dialplan Configuration defines what dialplan migration option is displayed by default when initiating Migration
Default Countries gives option to add countries to be added by default during migration
Theses settings are the default display settings only and can be modified as required when initiating each migration.
Prefix Templates settings defines the prefixes for Dialplan objects when using Template Migration only
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
Others
Clone Access Control Group Suffix This is used for Migrations to On Prem CUCM where Rank Mapping is required
...
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.
...
Mapping Regexes define the source template objects, the siteId Source template regex is used to define the site for the Site Suggestions in the migrations
All the other Mapping templates, Device Pools, Regions, Locations etc., use the Mapping regexes to determine the Site Suggestions
...
The option for each object is either A
Clone (object will be cloned in target)
Map (the object will be mapped to target configured object)
Transform (the object will use transform template to update or add fields on an object)
Skip/Ignore (the object will not be migrated)
...
migrated)
De-Duplicate and Clone Objects will be de-duplicated using a linked process before cloning.
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
...
Tip - most common object used (default) to create site suggestions are Device Pools
...
| 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 |
Wrangler Migration Menu
Note that these menu items are only visible within the migration
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
...
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.
...
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 add a default license, select from drop down, followed by +Add
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 new or required/ removal of previously defined default licenses.
To add a default license, select from drop down, followed by +Add
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
...
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
...
Location Numbers
Location Numbers displays number ranges/ site post Site Allocations.
Selecting Edit Numbers link adjacent to each range will bring up details display where, under the Data tab, ranges may be edited if and as required in the Sources/Override Column
The History Tab tracks all changes/ allocations historically during migration
Allocation tab displays Allocated site for range
The Number Sources tab displays sources used for allocation of numbers to location
Allocation
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
...
...
Ranges
The Countries menu option Ranges 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
...
allocation to site of objects using number ranges in WxC-MT only.
To add a new range for allocation, select Quick Add Range, then under the new window, the DN or E164 range start and end number may be added as required then Save & Close selected
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.
...
...
Mapping LDAP User Correlator
| Note |
|---|
Note that the LDAP correlator feature is only supported for transform object and is not supported for WxC-DI migration using clone, it is supported for
|
From Yarnman Version 2.6.5 there is an additional feature within Migration Mapping Tables allowing for selectable source attribute to use for mapping to target UserID. The use case for this is when the target UC servers CUCM LDAP uses a different AD server than source and a different LDAP attribute as UserID from the source is used in the target - for example if source cluster is LDAP synchronized to MS AD with the userID as samAccountName and target synced to Azure LDAP source and the userID is UPN.
...
In the first line under Mapping Table, in source column, type the name of the field the name of the field to be used as LDAP source UserID that will be mapped to target UserID attribute, enter the Target UserID as userId then Save Changes noting that all entries are case sensitive.
Valid sources for UserID are the Wrangler field attributes userId, email (Mailid), directoryUri, userIdentity, ldapObjectId, customUserFields* , target will always be userId
...
*customUserFields uses the source CUCM LDAP Directory Custom User Fields to be used as LDAP the source UserID that will be mapped to target UserID attribute, enter the Target UserID as userId then Save Changes noting that all entries are case sensitive.
Valid sources for UserID are the Wrangler field attributes userId, email (Mailid), directoryUri, userIdentity, ldapObjectId, customUserFields* , target will always be userId
...
*customUserFields uses the source CUCM LDAP Directory Custom User Fields to be used as the source UserID - in our sample, we have synchronised UserID AD attribute userPrincipalName as the Custom User Field and named it UPN. This would be entered in wrangler as customUserFields.UPN
...
- in our sample, we have synchronised UserID AD attribute userPrincipalName as the Custom User Field and named it UPN. This would be entered in wrangler as customUserFields.UPN
...
Conflicts
The Number Ranges → Conflicts report shows objects with multiple site allocations
To view detail of object with conflicts and if required change allocation - select the link under the Object column, allowing for view and change
...
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
...
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:
...
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.
...
Objects can also be set to skip using bulk change from v2.5.15 by setting the targetId to Skip
...
.5.15 to version 2.5.24 by setting the targetId to Skip
...
From version 2.6.X objects are skipped in bulk change by selecting Skip As Source / Set Not Used? to True
Target Mappings WxC-MT
...
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.
...
Call types specifies all the different Global call types used in the Wrangler UCMC tempalte dial plan.
| Note |
|---|
It is not advisable to modify or add to this unless advised by support |
...
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
...
Mappings tab displays the CUCM to WxC-MT object mapping
...
Additions
The Objects->Additions menu item provides a facility to manually add an object for loading into target UC clusters using the + Create New Object button
The Change column shows the status of object with a green tick indicating that it has been migrated OK. A + sign or Update sign indicates that the corresponding object has not been added or updated in the Target cluster. If the object is selected it will bring up the Object Browser for the item with more detail for further investigation.
Moves & Renames
The Objects->Moves & Renames menu item will display all objects with an option to Ignore (do not move) or to map
...
The Objects->Configure Actions menu item will display the action taken for a particular object type during the migration being. If performing a change here, it will only be valid for the current migration.
Clone - the object being cloned from source to target
Map - The object is mapped from source to target object
Skip - The object is not being migrated
| Note |
|---|
It is not advisable to alter the action for objects without consulting support |
...
...
Clone &
...
Transform
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.
...
The Ignoring Rules report will show any Rules that have been selected to be ignored (skipped) post initial 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
...
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
...
To download the report, select the Download XLSX Report button
...
Discovered 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
...
, Area and Mapped Target
...
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.
...
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 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
...
menu option shows all DN and E164 ranges overlapping and conflicting with other ranges. Ranges may be opened and edited, Auto Resolve or delete duplicates
...
Transformation (Future Option - not currently used)
Renumbering - this feature enhanced in version 2.5.20 (Not Used)
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
...
select Apply Renumbering
...
Voicemail - Discontinued Option
Mailboxes
Displays UCXN users with a voicemail box
Reports
Step Changes
...
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.15report. When completed select the link to download the Excel spreadsheet
...
Inter-Site Dependencies
New feature in 2.5.15
The Inter Site Dependency report option flags dependencies between migration batches. The intended usage for this report is for Phased migration to get an indication of dependant objects that will cause a problem during a phased migration, such as Line Groups with members in different migration batches etc. giving a chance to rectify these in advance of running the prepare step.
Select Inter-Site DependanciesDependencies, press generate and select the site group to generate Inter-Site Dependancies Dependencies report. When completed review the results
...
Example report with no inter-site issues
...
...
Duplicates Objects - Discontinued Option
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
...
with source configuration, then select the Bulk Update button to perform the change
...
Number Mappings
The number mappings option provides an export of all number mappings for numbers associated to object types and their target mappings
To run the report, select Generate Number Mappings Export which will create a spreadsheet ready for download by clicking on the File link under Files header
Sample Downloaded report screenshot belows
...
Bulk Changes
Bulk Change
Bulk changes may be used to bulk change objects in Wrangler or to create a Migration point Change
...
To Create a Migration point change point, select Bulk Changes from Migration Plan menu, then Create a Migration point change.
Select the Change Point to perform the change at, select Execute. If change should be forced irrespoective of errors encountered, select the corresponding checkbox to YES, then select Start Migration Point Bulk Change to perform the change
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*
From Menu select ITL Reset → Reset, then select the cluster from which the devices ITL reset should occur, then select the site and if required model of phone, then select Load Phones
| Note |
|---|
Note that it is preferred to use Certificate consolidation rather than the ITL reset function |
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
...
select Bulk Changes from Migration Plan menu, then Create a Migration point change.
Select the Change Point to perform the change at, select Execute. If change should be forced irrespoective of errors encountered, select the corresponding checkbox to YES, then select Start Migration Point Bulk Change to perform the change
TIP - Migration Point 'Change At' will generally be During Site Load or Before Any Sites Loaded
...
ITL Reset
Reset
The Wrangler tool includes a tool to reset ITL certificates on phones to enable registration of end devices in target cluster*
From Menu select ITL Reset → Reset, then select the cluster from which the devices ITL reset should occur, then select the site and if required model of phone, then select Load Phones
| Note |
|---|
Note that it is preferred to use Certificate consolidation rather than the ITL reset function |
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
...
Workbook
The workbook is used for WxC-MT migration to facilitate (bulk) changes to data prior to loading configuration into the Webex Cloud.
To use, select Export Objects, then select the type of objects that should be downloaded for alterations and any filters to narrow export if required
...
Then Select Generate Export Workbook that will generate a spreadsheet with the requested object ready for download, select the link to download
Open the Excel spreadsheet and modify as required, the save + Import the sheet back to Wrangler
To Import, select Import Object Changes, then Choose File to upload and Import Object Changes
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’
...
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
| Info |
|---|
Information of what the rules mean and suggested actions to resolve the same mat be found here https://yarnlab.atlassian.net/wiki/x/D4BWp |
...
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
...
To Delete current Migration in Wrangler UCMC, select Delete Migration.
...
| Note |
|---|
Warning - Take care in using these options as it will delete the current migration from Wrangler UCMC database |