Setup Guide
Yarnman – Wrangler On Premise
Issued byMats AgeYarnlab Pty Limited321 Pitt St Sydney 2000AustraliaACN 611077224
ABN 28611077224
Contents
Contents1
Install Yarnman2
Install As Standalone Core3
Install As Arm4
Wrangler On-Premise Setup7
Import CUCM9
Normalizations14
PBT (Phone Button Template) normalization15
Speed Dials Normalizations16
Call Forward Normalize17
User Telephone Numbers Normalization18
RDP Normalization19
License Optimizer19
Compliance Reporting20
RBAC List21
Statics21
Models21
Products22
Phone common configuration22
Device common configuration25
Ring Settings26
MoH Audio Sources26
Target CSS Templates27
EM Allocation plans27
Transforms30
Transform devices30
Transform Users33
Handle Existing User Devices35
Transform Status36
Bulk Review38
Data export40
Detailing Sheet62Table of Contents
| Table of Contents |
|---|
Install Yarnman
Deploy OVA via vMware vSphere
...
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)
...
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
...
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
...
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
...
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.
...
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 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
...
Import models first
...
Then products
...
Transform Users
This allows for updating usernames in CUCM with other fields as named in LDAP
...
Select users to transform
...
Select Device to handle
Handle Existing User Devices
This allows for passing through existing device configuration or to archive devices
...
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
...
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
...
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
...
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
...
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
...
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’
...
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
...
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
...
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
...
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’
...
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
...
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
...
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
...
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.
...
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}
...