Table of Contents
Install Yarnman
Deploy OVA via vMware vSphere
e.g. yarnman-2.X.X-master-XXXXXX.ova
If using Ovftool to deploy
ovftool --name="<VMNAME>” --powerOn --datastore="<datastore>" --net:"nat"="<network name>" <Yarnman OVA> "<VI path >"
VI Paths
Direct ESXI "vi://<vmware username>@<ESXI IP>"
Direct ESXI with resource pool "vi://<vmware username>@<ESXI IP>/<resource Pool>"
vSphere Host "vi://<vmware username>@<vSphere>/<datacenter name/host/<Host IP or name>"
vSphere Cluster "vi://<vmware username>@<vSphere>/<datacenter name/host/<cluster name>/<Host IP or name>"
if you use a “@” in your password, it must be escaped with %40 as in vi://foo:b%40r@hostname
Using VMware Console log into Yarnman Default username: yarnman Password: yarnman
Set IP address via VMware console:
cd /opt/yarnlab/yarnman
sudo ./scripts/bootstrap.sh
Select the ens32 interface (or ensXXX interface)
Follow the prompts
It is strongly recommended to change the default password for SSH access
Update hostname if required via /etc/hosts
Install As Standalone Core
This will install Yarnman as a core server with a single standalone CouchDB, Redis and Yarnman Node all on the same VM. This automatically sets up Admin App and other services required to get started. Other Arm Nodes may connect to this one as well.
SSH to Yarnman
CD to /opt/yarnlab/yarnman/
Run the script using node and sudo: sudo node ./scripts/install-as-core-standalone.js -p <password> --couchport <couchport> --redisport <redisport> with values prepared above substituted for <value>.
sudo node ./scripts/install-as-core-standalone.js -p <password> --couchport 5984 --redisport 6379
Monitor the process for any errors and record them if they occur
Browse to Yarnman IP and login default username password yarnman/yarnman
It is strongly recommended to change the default password for web access this is done by going into the default access policy then users
Install As Arm
Only follow these steps if you are deploying Yarnman as a distributed system (multiple VMs)
This will install the OVA as a node of Yarnman. This will connect to a central core database and enroll. Once accepted by the core services and interfaces can be added to it
Target full path of the core's Redis - redis://<some host or ipaddress>:<port - likely 6378>
CD to /opt/yarnlab/yarnman/
Run the script using node and sudo: sudo node ./scripts/install-as-arm.js -n <node name> -c <couchpath> -r <redispath> with values prepared above substituted for <value>.
Name to appear on the enrollment screen in AdminApp of the core do is easy to accept this node.
Target full path of the core's CouchDB - http(s)://<some host or ipaddress>:<port - likely 5984>
sudo node ./scripts/install-as-arm.js -n <name> -c http://<core ip>:5984 -r redis://<core ip>:6379'
Go to the Core's Administration App → Enrollments and accept the new node, you may add services and interface in the normal way.
The enrollment process will auto-generate credentials for the Arm.
Adding Interfaces
Setup CUCM interfaces
Add CUCM interfaces for each CUCM depending on requirements. If the Arm is within the customer network use real IP address, if the Arm is in the management network use NAT addresses.
Select arm from drop down then bind to arm
Set CUCM host IP address and credentials
Test connection
Wrangler On-Premise Setup
Start the Wrangler service, select node and authentication policy
Add to the proxy
Switch to Wrangler app
Create new migration
NOTE separate migration required per cluster being imported in this release
Setup migration
Select manage to enter the migration
Import CUCM
Create an import plan
Enter name for CUCM from where to import data, select CUCM interface as defined previously then click create
When importing, there is a choice to import Devicepools without modifications in which case ‘Import Devicepools as is’ button is selected. If modification is required, enter Regex rules and select ‘Load Devicepools’
In this example, we are importing the first 7 characters from Device Pool to map to Site Name –click on ‘Create Site +’ button
When mapped – next screen shows – either select country or click on ‘Set country base on Migration’ button
This allows for normalizing CSS names or otherwise, add CSS as is.
Note: In our sample we are importing as is but if CSS mapping is required it may be easier to modify on import using Regex than later during export phase
Start Import
In Import Log, take note of items that Require Attention, Warnings and Autofixes that appear when import has been completed. There are 4 tabs with the first being a summary of tasks
Second tab flags issues that require attention
Third Tab contains warnings from import
The last tab contains automatically fixed items
Review flagged and rectify as required
Normalizations
Wrangler contains a feature to allow for normalizations of imported data
PBT (Phone Button Template) normalization
The PBT functionality identifies separate phone button templates with the same data and consolidates them.
Speed Dials Normalizations
This function will check all speed dials. It will normalize speed dials to +E164 format where they can be identified as valid numbers. Additionally, invalid speed dial numbers will be identified and flagged.
Call Forward Normalize
Call forward normalization will attempt to normalize call forward numbers to +E164 format or otherwise flag and remove anomalies
User Telephone Numbers Normalization
To normalize User Telephone Numbers to +E164 format
RDP Normalization
This function normalizes RDP (Remote Destination Profile) numbers to +E164 format
License Optimizer
This function optimizes the usage of licenses to ensure that customer do not use more licenses than absolutely required by consolidating services to users
Compliance Reporting
The Compliance report gives a view of services that do not comply with rules. The report can be filtered by site or list a summary of all sites and additional granularity by adding filter for:
Users without Lines or Devices
Devices with no Lines
Devices with missing E164
Lines without a Device
Sites
Number Ranges
Unused custom Phone Button Templates
Archived custom Phone Button Templates
Soft Key Templates
User phone number to Primary line
RBAC List
The RBAC List option provides a matrix where predefined roles and associated privileges can be viewed/ modified giving granular access per feature
Statics
Statics menu provides a list of static references used in transformations
Models
This menu contains a list of all supported models of devices. If a new model will need to be supported, it can be imported from a later CUCM version system and merged with existing. To use this function, select the system to import from in drop down + ‘Update and Merge’
Products
Products currently supported listed here – if product needs to be imported from later version CUCM – select CUCM to import from drop down + ‘Update & Merge’
Phone common configuration
This option consists of existing standard common phone configurations and also allows for the creation of additional common configurations such as templates for Restricted phones or Common profiles that may be used for a particular phone model
To view existing profile, select ‘Edit’ adjacent to the profile to be viewed or to create a new profile – select ‘+ Create’ button fill out required config and ‘Save’
Create New Form
Edit Existing
Device common configuration
Device Common configuration allows to create standard common device configurations. It allow configuration of specific Use and Network MOH Id, User Locale, Soft Key Template etc
Ring Settings
This option allows for the import and merge of specific custom ring settings from CUCM. Select CUCM to import from drop down menu + Update & Merge
Note: prerequisite is that CUCM models be imported prior to running this command
MoH Audio Sources
This displays imported Audio sources used for MoH and Announcements (Queue and initial) and allows for the modifications of these. Items that can be configured includes Multicast, Repeat, Source File Name for MoH, Repeat IntervalsUser Locale and define if Always Play Initial Announcement
Target CSS Templates
This option allows for the creation and modifications of CSS templates.
EM Allocation plans
The EM allocation plan option allows EM to be allocated per site.
Select parameters for EM allocation plan – ‘+Create’
This will map EM devices based on last login
To view and edit result
Issues - 0
The Issues sub menu shows user related issues or creation of a new issue.
To Create a new Issue – select ‘+Create’ button
Enter Details – ‘Save’
To view or edit existing. All existing issues may be listed or filtered by Solved/ Not resolved and additionally by User Changed Site, User Issue, User individual request
Select required Filter
Existing issues will be listed with current status
To Edit or View Details – click on listed item and action as required
Transformations
NOTE keep transforms less than 500 objects in current release
Transform devices
This allow for creating BOT/TAB/CSF/Spark-RD/EM
This regex will only let alpha numeric through and upper case and limit to 15 char max so that first.last with prefix CSF becomes CSFFIRSTLAST
[a-zA-Z0-9]
CSF transform
iPhone transform
Tablet transform
Android Transform
EM device
Spark RD transform
If the imported system does not have the required target device, you will need to import from a system that has these devices i.e v9.1 system does not have Spark-RD so need to import from 11.5
Import models first
Then products
Transform Users
This allows for updating usernames in CUCM with other fields as named in LDAP
Add LDAP interface for Admin User Auth
Create transform template
Setup and run template
Select users to transform
Select Device to handle
Handle Existing User Devices
This allows for passing through existing device configuration or to archive devices
There are groups to help with this
Spark devices
Jabber Devices
Extension mobility devices
Physical devices
Transform Status
Sites Manager
The Sites Manager menu item allows for the split of existing number ranges between sites as required
Select ‘+Create Split Plan’
Enter Plan Name + ranges to be split and associated Target Site – ‘+Create’
Bulk Review
This is used for approving devices and users – this is used for additional filtering when exporting data
Note that you need to click on the status field to approve or user the approve all based on the current site and search filter.
Find all users – Transformed & Not Transformed, Approved & Not Approved
Find all devices – Transformed & Not Transformed, Approved & Not Approved
Find devices with no owner – Transformed & Not Transformed, Approved & Not Approved
LDAP Users Compare - Transformed & Not Transformed, Approved & Not Approved
Data export
Data Export Menu have three options – Create Export Plan, Quick Export (to view subset of data) and Site Validation Report
Quick Export provides a view of subset of data which is helpful to check data sets. Here you can view data per site or all sites, filtered by Users, Devices etc. as per drop down displayed for combination of Transformed & Not Transformed, Transformed, No Transformed and additionally Approved & Not Approved, Approved, Not Approved. Result may be downloaded to Spreadsheet as required
Site Validation Report provides a report on all transformed data ready to be exported
Select per site or leave as is for all sites – Generate Report. Will create a spreadsheet report on all data which is useful for sign off from customer that all data is valid
Export Plan is created to map all data and get ready for export to target as described below
Create export plan – provider/reseller/customer/division/location not required for CUCDM10/11
Create CSS Mappings
Generate workbook
Migration Objects
The Migration Objects Menu item contains submenu items to view and edit all individual items prior to Data Export.
Sites
Under the sites menu a summary list of all sites or will be displayed or alternatively a specific site can be displayed by using the Filter
Click on Edit adjacent to site to view/ edit site detail or select ‘+Create’ button to create a new site
Edit View – Edit as required, then ‘Update’
From this menu you can also access the corresponding site users, devices and detailing sheet (noting that the detailing sheet is only accessible if site status is set to Detailing)
Users View
Devices View
For detailing sheet view – see under Detailing section
Sites Create View – Enter site details + status of site ‘+Create’
Site Groups
Sites may be grouped together in a Site Group which may be useful to split sites into separate countries or specific areas. To create a site group – select ‘Site Groups’ menu item followed by ‘+Create’
Enter Name for Site Group and Country Code from drop down menu - ‘Save’
Users
Users details can be managed under the ‘Users’ menu item which when selected provides a list of all users. To limit the view, filter can be applied by user and/or site
From here, individual user can be selected by clicking on ‘Edit’ adjacent to relevant user
Where users may be viewed, edited or deleted
User Groups
As is the case with Sites, Users may be grouped together by type of user, worker type etc. Select ‘User Groups’ menu item ‘+Create’
To create the user group, enter name, then from drop down menus, select Group Type, Worker type Associated device type and device protocol – ‘Save’
Group Types supported are
Worker Types Supported are
Lines
Lines can be managed under the ‘Lines’ menu item. Here the lines may be viewed Edited or Deleted. Select ‘Lines’ from menu
All lines summary will be listed. To limit the view, it may be filtered by Name, CSS, Partition
To manage individual line, select ‘Edit’ adjacent to relevant line DN
This will display all relevant details pertaining to the line where details may be edited or line deleted, Items that may be managed are
LineCSS, Partition, Label, Alerting Name, Voice Mail Profile, Enum, CF destination and CSS for all CF cases, Call Park Monitoring, User and Network Hold MoH sources
Devices
Devices can be managed under the ‘Devices’ menu item. The devices may here be Viewed, Edited or Deleted. Select ‘Devices’ from menu
All devices summary will be listed. To limit the view, it may be filtered by Name, Product, Site, PBT, EM&Real EM& Real Devices and Original& transformed devices and also to Include Archived and/or Approved
To view individual Device item, select ‘Edit’ adjacent to relevant device
This will display all relevant details pertaining to the device where details may be edited or device deleted, Items that may be managed are
Name, description, Product Model, owner UserID, Line Details, BLF, Site, Location, SIP Profile, Security Profile, Common Phone Profile, Common Device Profile, PBT, SKT
Vendor Configs
In the Vendor Configs menu item, all vendor configs may be viewed
To view detail of individual configuration, select ‘Edit’ adjacent to relevant item – note that the details can only be viewed, not edited
Phone Button Templates
Phone button templates may be viewed, edited and deleted – Select ‘Phone button Template’ from menu
A summary of phone button templates will appear. The list can be filtered to limit the number of displayed items by Template name, Model, Default& Custom PBT’s
To manage individual template select ‘Edit’ adjacent to relevant PBT
Here the template can be modified as required. Specifying model, Device Protocol, Base Phone button Template and – changing or deleting button associations as required from drop down menu
Number Ranges
Number ranges may be managed under ‘Number Ranges’ menu item. Select ‘Number Ranges’
A summary of number ranges will appear. To limit the search, apply filter for Site and/or dn range
Individual range can be edited by selecting ‘Edit’ adjacent to relevant range
Under Configuration, the number range association with Device Pool can be changed and number range can also be altered – DN and e164. There is also an option to toggle ‘Non E164 range’ for numbers that have no associated E164 number
Selecting ‘Device Lines – 0/10’ gives an option to set E164 mask + regenerate number
When ‘Set e164 Mask & Regenerate e164 Numbers’ button is selected – below pop up allows country to be selected – a validation to be performed. When OK with change. Select ‘Make Changes’ button and the range will be regenerated with the selected items
Pickup Groups
To manage Pick Up Groups – Select ‘Pickup Groups’ from menu
A summary list of existing pickup groups will appear
To Edit existing pick up group – select ‘Edit’ adjacent to relevant pick up group
Change items as required – configurable items are
Pickup Group number and partition, Pickup group members (Target Lines), Enable Called info if information regarding called number is required to be displayed, Enable Calling info if information regarding the calling party should be displayed, Select alert as required from Audio, Audio and Visual, Visual or no alert
Enter the seconds of delay between the time that the call comes into the called party and the time that the notification to the call pickup group is to occur.
To create a new Pick up Group – Select ‘+Create’ button
Configure - Pickup Group number and partition, Pickup group members (Target Lines), Enable Called info if information regarding called number is required to be displayed, Enable Calling info if information regarding the calling party should be displayed, Select alert as required from Audio, Audio and Visual, Visual or no alert
Enter the seconds of delay between the time that the call comes into the called party and the time that the notification to the call pickup group is to occur.
Hunt Groups
To Manage Hunt Groups – Select ‘Hunt Groups’ from menu
A summary of configured Hunt Groups will appear – select from list or search entering name
To edit individual Hunt Group select ‘Edit’ adjacent to relevant group
Edit Hunt Group details as required – configurable items are
Name, Description, Alerting Name + Ascii, Call manager Group Name if hunt group needs to be configured in a specific call manager group, Calling and Called Party Transform Mask can be specified or left blank. Calling party Phone Mask display can be On, Off or Default.
Add or remove Line Groups from drop Down – ‘Save’
To Create a new Hunt Group
Configure Name, Description, Alerting Name + Ascii, Call manager Group Name if Hunt Group needs to be configured in a specific call manager group, Calling and Called Party Transform Mask can be specified or left blank. Calling party Phone Mask display can be On, Off or Default.
Add Line Groups from drop Down – ‘Save’
Line Groups
To manage Line Groups – Select ‘Line Groups’ from menu
A Summary list of all configured Line Groups will appear
To edit a specific Line Group, select ‘Edit’ adjacent to relevant group
Edit Line Group – configurable items are Name, Lines (members of Line Groups – selected from drop down list) or removed, RNA Reversion timer specifies in second the time before a call moves to the next available member in the Line Group or to the next line group in Hunt List, Distribution Algorithm – select from drop down as required, Algorithm on No Answer, Busy, Not Available as per drop down lists. Auto Logout Hunt Member on No Answer – On or Off – ‘Save’
To Create a Line Group
Configure Name, Add Lines (members of Line Groups – selected from drop down list), Specify RNA (Reversion timer specifies in second the time before a call moves to the next available member in the Line Group or to the next line group in Hunt List)
Distribution Algorithm – select from drop down as required (Top Down, Circular, Longest idle or Broadcast)
Algorithm on No Answer, Busy, Not Available as per drop down lists.
Auto Logout Hunt Member on No Answer – On or Off – ‘Save’
Detailing
Detailing is a ‘separate’ module within Wrangler that may be used for detailing of users and user data. This can be used for loader macros.
Detailing is closely linked to RBAC roles with various roles having different privileges to create, edit and validate user data
To use detailer, first a site must be configured manually or it may be imported from XLS. To Import from XLS - Download Template
Populate template with Site details – Save
Select ‘Choose File’ button
Next, we need to add Number ranges to site
Now we need to set the Site to detailing status to enable us to use it in the detailing sheet ‘Sites’ -> Click on ‘Edit’ adjacent to site that we want to update
Set Site Status to Detailing – Update
We will now need to create Device Transform Templates for devices that we wish to create/transform, Worker Types and Transformation Templates
Open Detailing Option – select Device Transform Templates
Click on “+ Create Template” to create new one. Device Template has several mandatory fields:
Dropdowns: Product Model*, Phone Button Template*, Security Profile | Table: name
* or physical phones
In Tables column “template” you can put your custom mappings for device fields. To create your own mapping use one of variable from list below and type characters for example:
Name: jabber_${username}
Description: This is ${email} of user owner
Display / Label: ${lastName} ${firstName} - ${dn}
Available mapping values**: ${mac}, ${username}, ${firstName}, ${lastName}, ${email}, ${dn}, ${e164}
**values come from detailing user sheet
Next create Transformation Templates
When you are done with “Device Transform Templates” you are ready to create “Transform Template” for generating devices base on detailing inputs. Click on “+ Create Template ”
Name the template, Description, select Detailing Transform - Save
Select required
You can add multiple “Transform templates”. Select “Device transform template” this is required field for transform element. Devices are generated if the device has MAC / name and model match device template model. When you want to always generate for eg. Jabber device select “Create always”. Then this device will be created for all users in detailing sheet.
Add device transform templates as required - Save
Create Worker Types
Click on „Detailing“ in Administration section on the left side menu. The following screen will open:
Populate details as required - +Create
Before we start building “Detailing Sheet” we must to create user “Worker Type” from which we will create users. To do this, click on “Worker Types“ button in the top right side menu. Worker Type “Device Models” and “Transform Template” are required and should match. In User and Line tables you can build custom mappings. Base on this template we will create User and Lines in Wrangler database.
You can “Duplicate” Worker Type to speed up detailing setup process. This feature automatically create copy of Worker Type.
Available mapping values**: ${mac}, ${username}, ${firstName}, ${lastName}, ${email}, ${dn}, ${e164}
**values come from detailing user sheet
We can now create Detailing Worksheet
Enter User Details either manually or cut and paste from spreadsheet
Username, First Name, Last Name, Email, DN, E164 (will populate automatically after DN is entered), Worker Type, EM, MAC address, then click Create
You may now enter further details or edit in sheet. Additionally, you may enter Multi Line Data, Speed Dials, Hunt Groups, Line Groups and Pick Up Group Data on the individual tabs
Once all data completed – click on ’Validate’ – Status should change to approved. You may now select ‘Transform sheet’ which will transform all the data – ready to use loader from
Data Quick Export
Download as required
