/
Wrangler WxC Administration Guide

Wrangler WxC Administration Guide

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

Settings

General settings define global performance metrics and other global settings.

These should generally be left as default unless performance issues experienced interfacing with CUCM and/ or UCXN

image-20241017-002837.png
image-20240402-052304.png
image-20240402-052341.png

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

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

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

CUCM AXL Simultaneous Request Limit

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.

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. 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
(ON)

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

image-20241017-003333.png

 

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 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)

  • De-Duplicate and Clone Objects will be de-duplicated using a linked process before cloning.

 

image-20241017-003941.png

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 (default) 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.

image-20241017-004212.png

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

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

 

image-20240402-055618.png

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

 

image-20240402-055754.png

The History Tab tracks all changes/ allocations historically during migration

 

image-20240402-060201.png

Allocation tab displays Allocated site for range

 

image-20240402-060343.png

The Number Sources tab displays sources used for allocation of numbers to location

 

image-20240402-060613.png

Allocation

Sites

Sites are used to group the various configuration objects within the source cluster and are also selected for the migration batches

Site can be added manually or by using the site suggestions method.

The Sites menu item displays the sites that have been defined, and additionally allows for the creation of new sites as required

The Name Column displays the site name - to view and modify Site details, select the individual site name

The Select column allows for the selection/ deselection of sites to be migrated

The Group column allows for grouping of sites, which is required to run an Inter Dependency Report. This is described further under Reports below

The Bulk Select button allows for the bulk selection/ deselection of sites to be migrated

The Create New Site button allows for the creation of a new site manually

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 Ranges Option allows for the allocation to site of objects using number ranges in WxC-MT only.

 

image-20240402-061421.png

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

 

image-20240402-061552.png

 

 

image-20240402-061742.png

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.

TIP - Device Pool is generally the best object to create sites

 

Here we can see the Object Name (Device Pools in Source) and the Template/s that provides the match. We can also see that there is one objet name that is not matching a template - ‘Sel-Prov-DP’.

To create a template that matches the Device Pool, select the Device Pools link as highlighted in screenshot below which will open the mappings table.

 

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

Added in wrangler 2.6.5

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

  • WxC-DI MAP

  • WxC-MT

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

To use the correlator functionality, select Mapping Tables from within the Migration (note that this only works as override within migration, not as a global mapping table option), then Create Mapping Table

image-20240213-051236.png
image-20240213-051446.png

 

Name the table ldap-user-correlator

image-20240213-051628.png

Select the created ldap-user-correlator

image-20240213-051830.png

In the first line under Mapping Table, in source column, type 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

image-20240213-052820.png

 

*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

image-20240213-052434.png

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

image-20240402-063542.png

 

image-20240402-063835.png

 

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

●   Transform Types (only for Template and Map migration option)

●   Clone Types

●   Skip 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.

The mappings can be done from the prompts during migration, or from selecting Target Mappings, then selecting the object link here

 

Select the highlighted item from the Type column, to view the details of the object type. In the screenshot below the CUCM-REGION object is shown. From the screen we can see the umapped objects in yellow background and the mapped objects in green background

Use filters to limit the view as required. For example, to map New1-REG, enter Ne in Search source/ target name … filter box which will limit the view to only include New1-REG, we can then select available target objects from the Target Object drop down. In this instance we can see that only Default Region exist in target cluster. If we want to map New1-REG Region in source to Default region in target, we select Blue Box Update 1 Objects, then OK.

If many source objects to be mapped to a single target object, then use the filter boxes to limit the source objects as required, then slect Target object + Update X Objects.

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

As per the Map types, the Clone Types shows the migration status summary of all clone objects, Waiting, Transformed, Skipped and Moved state.

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

 

image-20240606-033641.png

 

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.

  • The Name column contains the name of the individual templates that may be opened by selecting the same

  • Source Type column displays the source type of the corresponding template

  • The Group column displays the type of dialplan the template applies to

  • Country column specifies if the template applies to a particular country or any

  • ApplyOn clumn displays if template applies to Target or Source

  • Apply Every column displays the rule for where the template applies

 

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 tempalte dial plan.

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 is an 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

Below screenshot shows the detail for CUCM/WxC-DI object

WxC-MT Object Browse Specifics

Below screenshots show WxC-MT objects detail in tabs rather than WxC-DI/CUCM single page above- Under Data tab configuration may be changed/overridden , then saved

History & Sync tab details the migration change history for the object

Allocation Tab shows site allocation details for the object

 

The change tab displays the change steps that will be executed during load or manually using Preview Execute

The Dependencies & Dependents tab lists all dependencies and links to these objects

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

yarnlab website