| 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
...
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 Enable VOSS4UC Hierarchy Move | OFF (Default) ON | Enables VOSS4UC hierarchy move - this should only be enabled for HCS to HCS migrations | |
Yarnman CouchDB Simultaneous Request Limit | 1550 | 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 | 200to 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 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 15 | Controls how many simultaneous requests to send via AXL. |
CUCM AXL Simultaneous Write Limit | 2 | Controls how many simultaneous updates to send via AXL. | |
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.
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
All the other Mapping templates, Device Pools, Regions, Locations etc., use the Mapping regexes to determine the Site Suggestions
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.
These options can also be overridden if required for any object type
The option for each object is either
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 (the object will not be migrated)
...
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
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. |
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
All the other Mapping templates, Device Pools, Regions, Locations etc., use the Mapping regexes to determine the Site Suggestions
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.
These options can also be overridden if required for any object type
The option for each object is either
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 (the object will not be migrated)
...
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.
...
| 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
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 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 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
...
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 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
...
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
...
creation of number ranges to be manually created for addition to WxC-MT
To create a new range for addition, 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
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 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.
...
*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
...
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.
...
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.
...
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
...
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
...
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
...
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
...
Phones meeting the criteria will be displayed, individual phones may be unselected by selecting the Selected link adjacent to the phone.
...
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
...