UCentric HLD/Word Merge Creation Guide

Owned by Sean Millar
Last updated: Feb 28, 2024 by Paul McGuinness
12 min read

This guide outlines how to create a word merge template, the use of tokens and the context each should be used in.

Word Merge Syntax

Overview

 

The merging of data from a Voice Audit into a Word Document is achieved via tokens placed within a normal .docx style word document.

The location of the templates is typically c:\inetpub\UCentricServer\merge_templates and an example _Default_Template.docx is provided to give you examples.

There are 3 types of tokens that can be used within a document to insert data from a voice audit, these are listed below:

  • Variables: variables are single tokens that do not require and an closingtoken which are encapsulated within curly braces in the form {varname} these can be used outside of tables or used on their on in a row/column/field in a table.

  • Table tokens: tables require opening and closing tokens and are used in tables only. They are in the form {#tablename} … {var1} {var2} etc… {/tablename}

  • Image Tokens: Images are in the same form {imgtag} but instead of inserting text, they will insert a dymanically created or stock icon image.

 

 

Variables

The variable tokens used below need to be used with curly braces {system_name} for example and can be used on their own outside of tables, please see overview above for an example of usage

Variable Name

Description

system_name

Name assigned within Asset Manager, i.e. “ACME Site 1”

system_version

PABX Version

system_revision

PABX Software Revision

system_firmware

PABX Firmware

system_mac

PABX MAC Address

system_ipaddress

PABX IP Address

system_dbversion

PABX Database Version (if applicable)

system_dbbuildid

PABX Database Build ID (if applicable)

system_network_element

Mitel “root” network element

system_dbregion

Mitel MiVO Database Region

scan_date

Audit date

connection_type

Numeric 1 – 8;

 

1 = ip, 2= modem/ tracker,

3=7100, 4= mixml, 5=ras/vpn 6=Race, 7=Serial, 8=Marwatch

system_type

Platform Type

ip_address

IP Address of PABX, i.e. “10.1.1.22”

total_extns

Total # of Extensions available

total_trunks

Total # of Trunks available

total_analog_extns

Total # of Analog Extensions available

total_digital_extns

Total # of Digital Extensions available

total_hybrid_extns

Total # of Hybrid Extensions available

total_analog_trunks

Total # of Analog Trunks available

total_digital_trunks

Total # of Digital Trunks available

total_hybrid_trunks

Total # of Hybrid Trunks available

total_out_of_service

Total # of “Out of Service” (Trunks, Extns and Consoles)

total_cards

Total cards in PABX

total_circuits

Total circuits

total_extn_cards

Total Extension cards

total_trunk_cards

Total Trunk cards

total_programmed_trunks

Total # of Programmed Trunks

total_programmed_extns

Total # of Programmed Extensions

total_programmed_consoles

Total # of Programmed Consoles

total_extn_capacity

Total # of Extensions available

total_trunk_capacity

Total # of Trunks available

total_oos_trunks

Total # of Trunks marked “Out of Service”

total_oos_extns

Total # of Extensions marked “Out of Service”

total_semi_programmed_trunks

Total # of Trunks with no Trunk number

total_semi_programmed_extns

Total # of Extensions with no Extension number

total_ip_extns

Total # IP Extensions

total_ip_trunks

Total # IP Trunks

used_analog_extns

# of used Analog Extensions

used_digital_extns

# of used Digital Extensions

used_hybrid_extns

# of used Hybrid Extensions

used_ip_extns

# of used IP Extensions

used_analog_trunks

# of used Analog Trunks

used_digital_trunks

# of used Digital Trunks

used_hybrid_trunks

# of used Hybrid Trunks

used_ip_trunks

# of used IP Trunks

total_ac15

Total # of AC15 Trunks

total_ac13

Total # of AC13 Trunks

total_em

Total # of E&M Trunks

total_mg

Total # of Media Gateways or Cabinets

cisco_unsupported

Total # of Unsupported Cisco devices

{totalgooddevices}

Total Checked OK

{totalbaddevices}

Total Checked BAD

{totalwarndevices}

Total Checked WARN

Vendor

Vendor ID code Novalog.dbo.PABX_Sites.{switchtype}

 

cardsfull

# of cards that are 100% utilised

cardsnearlyfull

# of cards that are >90% utilised

license_alert

# of licenses that are >90% utilised

Siplicenses

Total SIP Licenses (MiVB)

Note, 3 tokens, Total Checked OK {totalgooddevices} Total Checked BAD {totalbaddevices} Total Checked WARN {totalwarndevices} will only work when used in conjunction with the table that uses one of the checkHandsetsCisco, checkHandsets8x8 , checkHandsetsMitel, checkHandsetsOCC, checkHandsetsBW, checkHandsetsTeams, checkHandsetsRC or checkHandsetsEvolve tokens listed in this section



Example Word Merge Template:

 

This section outlines an example template that can be copied into a word document. Not all tokens will be relevant for each vendor. Vendor specific tokens can be found in the relevant sections or as indicated in the examples below

Name

{system_name}

Type

{system_type}

Audit date

{scan_date}

SPA/ZT client ID

{clientId}

SPA/ZT SOW ID

{sowId}

SPA/ZT Phase ID

{phaseId}

SPA/ZT Partner Type

{partnerType}

 

Platform details

Version

{system_version}

Revision

{system_revision}

Firmware

{system_firmware}

IP Address

{system_ipaddress}

MAC Address

{system_mac}

SPA Version

{SPAVersion}

UCentric Server Version

{UCVersion}

Decoder Version

{DecoderVersion}

Scan Duration

{ScanDuration}

 

Gateway / Cabinet overview

The system type is ‘{platformType}’ running on ‘{platformName}’

There are {total_mg} nodes in this configuration.

Node Type name

Name

Detail

MAC

IP Address

{#gateways} {cabtype}

{name}

{detail}

{mac}

{ip} {/gateways}

 

Note: You can replace {cabtype} with {switchtype} for Mitel MiVoice Connect systems to show more meaningful information



 

SRST Servers (Cisco only)

SRST

IP Address 1

Port 1

IP Address 2

Port 2

IP Address 3

Port 3

{#srst}{srst}

{ipaddress1}

{port1}

{ipaddress2}

{port2}

{ipaddress3}

{port3}{/srst}

 

Migration overview

 

These tokens allow you to insert a number of ‘insights’ into your template document that show the impact of attempting to migrate the audited platform to a hosted solution

 

The following important discoveries were made during the audit of the existing voice platform.

Category

Count

Information

Cards full

{cardsfull}

Cards that are 100% utilised

Cards almost full

{cardsnearlyfull}

Cards that are >90% utilised

License status

(See licensing section)

{license_alert}

{#migsumm}{title}

{count}

{detail} {/migsumm}

 

Migration considerations

This table will detail any common facilities being used by a legacy platform and if it is supported in the commonly used hosted environments

Facility in use

# of instances

Microsoft Support

{#migrationfeatures} {statusimg} {desc}

{count}

{sfbIcon} {sfbInfo} {/migrationfeatures}

 

Vendor specific considerations: -

 

Cisco: {ciscoIcon} {ciscoInfo}

BroadSoft: {broadsoftIcon} {broadsoftInfo}

Microsoft: {sfbIcon} {sfbInfo}

Mitel: {mitelconnectIcon} {mitelconnectInfo}

Zoom: {zoomIcon} {zoomInfo}

8x8: {eightIcon} {eightInfo}

RingCentral: {rcIcon} {rcInfo}

 

 

Migration overview by location

Location

Analog

Digital

IP

Cisco

Broadsoft

Skype

 

Counts

Ana

Dig

IP

Ana

Dig

IP

Ana

Dig

IP

{#migrationbyloc} {Region_Name}

{Total_analog}

{Total_digital}

{Total_IP}

{ciscoAnalogIcon}

{ciscoDigitalIcon}

{ciscoIPIcon}

{broadsoftAnalogIcon}

{broadsoftDigitalIcon}

{broadsoftIPIcon}

{skypeAnalogIcon}

{skypeDigitalIcon}

{skypeIPIcon} {/migrationbyloc}

 

Migration Features Graphs

{chartcccisco} -> CISCO

{chartccbroadsoft} - > RING CENTRAL

{chartccteams} - > TEAMS

{chartccbroadsoft%} - > BROADSOFT

{chartccrc} - > RINGCENTRAL

{chartcceight} - > 8x8

 

 

 

Each of the above tokens will provide a % compliance across ALL insights for that vendor, e.g. 250 items (phones, hunt groups, call forwarding etc.) and 125 compliant would show 50%

 

The color banding is automatic as follows:-

0 – 30% -> Red

31 – 65% -> Blue

65%+ -> Green

Handset Summary

This details a summary of all of the extensions and trunks captured within the audit.

 

Extensions

There are {total_extn_cards} extension cards within the system, providing the following capacities:

 

Capacity

Used

Total

{total_extns}

{total_programmed_extns}

 

 

 

Analog

{total_analog_extns}

{used_analog_extns}

Digital

{total_digital_extns}

{used_digital_extns}

Hybrid (i.e. COV)

{total_hybrid_extns}

{used_hybrid_extns}

IP

{total_ip_extns}

{used_ip_extns}

 

 

{chartextn}

 

 

There were {total_oos_extns} extensions marked as ‘out of service’

 

 

The extension digit length for this system is {extnlength} {extnlengtherror}

Handset Types

Where known, this details all the different handsets or softphone types in use. This allows you to understand what features and facilities users are currently utilising and ensuring that any migration does not reduce their experience.

Handset

Model

Programmed

OOS

No Extn #

Details

 

{#handsets} {extnimg}

 

{extntype}

{extntotal}

{extnoos}

{extnnonum}

{extndesc} {/handsets}

 

 

 

User types

ID

Description

Abbreviation

{#usertypes} {id}

{Description}

{Abbreviation} {/usertypes}

Unsupported phones/Provisioning Compatibility Check

The below tokens can be used to check compatibility of the current phones/devices on a selected voice vendor, useful for checking prior to provisioning a cloud or hosted voice solution.

The table is the same for each vendor, just change checkHandsetsCisco to one of these: checkHandsets8x8 , checkHandsetsMitel, checkHandsetsOCC, checkHandsetsBW, checkHandsetsTeams, checkHandsetsRC and checkHandsetsEvolve

Handset

Model

Programmed

Details

 

{#checkHandsetsCisco} {extnimg}

 

{extntype}

{extntotal}

{comment} {/checkH

Trunks

Trunk utilisation

There are {total_trunk_cards} trunk cards within the system, providing the following capacities:

 

Capacity

Used

Total

{total_trunks}

{total_programmed_trunks}

 

 

 

Analog

{total_analog_trunks}

{used_analog_trunks}

Digital

{total_digital_trunks}

{used_digital_trunks}

Hybrid (i.e. AC13/AC15/E&M)

{total_hybrid_trunks}

{used_hybrid_trunks}

IP

{total_ip_trunks}

{used_ip_trunks}

 

 

 

AC13

{total_ac13}

 

AC15

{total_ac15}

 

E&M

{total_em}

 

 

 

{charttrunks}

 

 

There were {total_oos_trunks} extensions marked as ‘out of service’

 

 

Trunk groups

 

Trunk Group

# of Members

Description

Audio

Day Type / In

Night Type / In

Calling Name / Number

Group type

{#trunkgroups}

{groupnum}

{count}

{description}

{audio}

{dayRingType} / {dayRingIn}

{nightRingType} / {nightRingIn}

{callingPartyName} / {callingPartyNumber}

 

{type}{/trunkgroups}

Trunks (detailed)

Trunk Group

Type / Desc

Trunk / Desc

Audio

Day Type / In

Night Type / In

Calling Name / Number

{#trunks} {trunkGroup}

{type}

{groupDesc}

{trunkNo}

{desc}

{audio}

{dayRingType} / {dayRingIn}

{nightRingType} / {nightRingIn}

{callingPartyName} / {callingPartyNumber}

{/trunks}

 

Dial plan / ARS digits in use

 

Digit

Digits to follow

Group #

COR

Route Type

Trunk

Type

Description

Absorb

Insert

Final

Group

type

{#ars} {digit}{following}

{digitstofollow}

{trunkgroup}

{cor}

{routetype}

{type}

{description}

{abs}

{ins}

{ft}

{grouptype}{/ars}

 

Or

Digit

Digits to follow

Route Termination Type

1st

2nd

3rd

Absorb

Insert

{#ars2} {digit}{following}

{digitstofollow}

{rid}

{c1}

{c2}

{c3}

{abs}

{ins}{/ars2}

 

List all Routes (in use or not)

Digit

Route Type

Trunk Group Type

Absorb

Insert

Final Tone/Marker

{#ars3} {rn}

{routetype}

{tt}

{abs}

{ins}

{ft}{/ars3}

 

List all Plans

Route Termination Type

Route Plan Number

Day and Time Zone #

Day Zone

Zone 1 Term Type

Zone 2 Term Type

Zone 3 Term Type

Zone 4 Term Type

{#ars4} {rid}

{rpn}

{dtz}

{dz}

{z1type} {z1term}

{z2type} {z2term}

{z3type} {z3term}

{z4type} {z4term} {/ars4}

 

Shows only discreet routes (no duplication for 1st/2nd/3rd etc.)

Route Number

Routing Medium

Trunk group number

Description / SIP Peer Profile Label

Trunk Type

Route Type

{#ars5}

{rn}

{type}

{trunkgroup}

{description}

{grouptype}

{routetype}

{/ars5}

MiVB:

You can also add:-

 

{rt} to show the route number if required

{term} to show the termination number

Hunt and Pickup Groups

 

List all hunt / pickup groups and members

(Warning – Do not use on large systems as 100’s of pages may result)

Category

Pilot Number

Name

Mode

Type

Member No.

Member Name

{#groups}

{pilotType}

{pilotNumber}

{groupName}

{huntMode}

{groupType}

{memberNo}

{memberName}

{/groups}

 

Summary of hunt and pickup groups

Category

Pilot Number

Distribution

Name

# of Members

Warning

{#groupsumm}{pilotType}

{pilotNumber}

{distribution}

{groupName}

{totalMembers}

{warning}{/groupsumm}

 

Note: You can split out some group types by replacing the start / end tags for :-

 

{#huntsumm} {/huntsumm} - Hunt groups only

{#queuesumm} {/queuesumm} - Queues only

{#pickupsumm} {/pickupsumm} - Pickup group only

{#workgrpsumm} {/workgrpsumm} - Workgroups only (MiVC/Shoretel)

{#prgsumm} {/prgsumm} - Programmed Ring Groups only (Mitel)

{#parksumm} {/parksumm} - Park Groups only

{#pagingsumm} {/pagingsumm} - Paging Groups only

{#acdsumm} {/acdsumm} - ACD/ACD2/ACDX/MCD Groups only

{#ringsumm} {/ringsumm} - Ring Groups only

{#mdusumm} {/mdusumm} - MDU Groups only

{#twinsumm} {/twinsumm} - Twin Groups only

 

Hunt/Pickups with 1 member

Pilot

Group Name

Type

Member

Member Name

{#badgroups}

{pilotNumber}

{groupName}

{pilotType}

{memberNo}

{memberName}{/badgroups}

 

Groups with no members

Pilot

Name

Type

{#badgroups2} {pilotNumber}

{groupName}

{pilotType}{/badgroups2}

 

There are {emptygroups} groups with no members

Out of service

This shows the total of all “Out of Service” devices. This is determined as: Analog Extensions/Trunks that have been marked “OOS” by an Engineer; Digital Extensions/Trunks that have been marked “OOS” by either the PABX or an Engineer (e.g. If a digital set is unplugged, it is usually marked “OOS” by the PABX automatically).

 

Type

Sub-type

State

Total OOS

Resilient

Actual OOS

{#oos}{type}

{subtype}

{state}

{oos}

{resilient}

{actualoos}{/oos}

 

Feature Codes

Shows all feature codes (e.g. “Make Busy”, “DND” etc.) – Note the orange entries apply to some vendors only (e.g. MiVO 250)

Feature name

Code

Admins Only

Directory Entry

Engineering Only

{#codes} {featurename}

{code}

{adminonly}

{direntry}

{engonly}{/codes}

 

I

Energy insights

Note: for this model, the assumption is made that ALL devices are in use for 30% of a 5-day working week. This report is for illustration purposes only.

 

The current Total kWh of {greentotalkwh} can be reflected as the following environmental impact :-

Impact on the environment – PER HOUR

{greentotalco2} Kilograms of CO2/hour generated by electricity production

{greentotal_felled} fully grown trees felled

{greentotal_cars} passenger vehicles driven for 1 year (or {greentotal_miles} miles driven in one car)

{greentotal_phones} mobile phones charged

The total energy usage of {greentotal_homes} homes

 

Annually, this means a total kWh/annum of {greentotalkwh_y}

Impact on the environment – ANNUALLY {greentotalco2_y} Kilograms of CO2 generated!

{greentotal_felled_y} fully grown trees felled

{greentotal_cars_y} passenger vehicles driven for 1 year (or {greentotal_miles_y} miles driven in one car)

{greentotal_phones_y} mobile phones charged

The total energy usage of {greentotal_homes_y} homes

 

Mitigation

The above could be mitigated by

Migrating your on-premise voice system to a hosted solution, where the overall electricity usage is shared across a large number of clients using more efficient technologies.

You might also consider

Recycling {greentotal_bags_y} bags of waste instead of sending them to landfill – EACH YEAR

Planting {greentotal_trees_y} seedlings let letting them grow for 10 years – EACH YEAR

Swapping {greentotal_bulbs_y} incandescent bulbs to LED’s

 

Basic Carbon footprint information

Description

Type

Subtype

Qty

Total kWh

Watts/item

kgCO2

gCO2/item

{#green}{desc}

{type}

{subtype}

{total}

{totalkwh}

{watts}

{kgco2}

{gco2}{/green}

 

Total kWh: {greentotalkwh} Total kgCO2: {greentotalco2}

Region / Location information

If your system is a modern IP platform (i.e. Cisco, Avaya etc.), the circuits within the platform can be separated into a number or regions or locations. This details that information if it is available.

Circuit ID

User

MAC

IP Address

Revision

Region

{#regions}{circuitid}

{username}

{mac}

{ipaddress}

{revision}

{regionname}

{/regions}

 

This report summarises region information for larger systems

Region ID

Region Name

Standard Sets

IP Sets

{#regionsumm}{regionId}

{regionName}

{totalSets}

{totalIpSets}{/regionsumm}

License usage

There are a number of ways in which licenses are detailed within voice platforms.

Description

Num of devices licensed

Licenses per device

Total Used

{#ciscolicenses}{description}

{numdevices}

{unitsperdevice}

{used}{/ciscolicenses}

{totalCiscoLicensesUsed}

 

General Licenses

This table will automatically display license usage for Mitel, Avaya, Aastra and older Cisco platforms.

License type

Name

ID

Fixed Value

Maximum

Used

Available

% Used

{#licenses}{type}

{name}

{id}

{fixed}

{max}

{used}

{available}

{percused}{/licenses}

 

 

Aastra SAP/SEC license counts

LIM

Type

Analog Extns

Digital Extns

Operator Extns

Total for LIM

{#sapsec}{lim}

{type}

{analogextns}

{digitalextns}

{oprextns}

{total}{/sapsec}

Totals:

 

{saptotalanalog}

{saptotaldigital}

{saptotaloperator}

 

 

 

User profiles in use

Profiles in use

Count

{#userprofiles} {profilename}

{count}{/userprofiles}

 

Admin roles in use

Count

{#adminroles} {rolename}

{count}{/adminroles}



COS/COR Usage

The following COS / COR’s were discovered during the audit

COS / COR

Total DN’s

% using

Device type

COS / COR descriptions

Information

{#cossummary} {COS} / {COR}

{totalDN}

{percentage}

{phoneType}

{cosdesc}

{cordesc}

{comment} {/cossummary}

 

Details of where there are less than 20 DN’s using a COS / COR combination

COS / COR

DN

Name

Detail

COS / COR descriptions

Device type

Information

{#cosdetail} {COS} / {COR}

{circuitId}

{name}

{detail}

{cosdesc}

{cordesc}

{phoneType}

{comment}

{/cosdetail}

COS/COR (Mitel MiVB/3300/SX2000)

COS

COR

Total DN’s

% using

Device type

COS / COR descriptions

Information

{#cossummary} {COS} / {COSN1} / {COSN2}

{COR} / {CORN1} / {CORN2}

{totalDN}

{percentage}

{phoneType}

{cosdesc}

{cordesc}

{comment} {/cossummary}

 

 

Details of where there are less than 20 DN’s using a COS / COR combination

COS

COR

DN

Name

Detail

COS / COR descriptions

Device type

Information

{#cosdetail} {COS} / {COSN1} / {COSN2}

{COR} / {CORN1} / {CORN2}

{circuitId}

{name}

{detail}

{cosdesc}

{cordesc}

{phoneType}

{comment}

{/cosdetail}

 



Card Summary

The following tables produce a card usage summary

 

Name

Detail

Port/PLID

Max

% using

IP

Total OOS

{#cardsumm} {name}

{detail}

{PLID}

{maxCapacity}

{percUtilised}

{ip}

{totalOOS} {/cardsumm}

 

Firmware and Card End-of-life

This produces a list of cards / cabinets / devices that are cross-referenced against the [EndOfLife] table to produce a list of compliant/out-of-date devices/firmware

Status

Item

Type

firmware

revision

Latest version

Latest version date

{#firmwareeol}

{statusimg}

 

{name}

{type}

{firmware}

{revision}

{latestVersion}

 

{latestDate}

{/firmwareeol}

Comparison Summary

Provides a comparison between the selected audit and the next oldest one preceding it. If no available scans, then the table is left empty.

Type

Added

Removed

Changed name

Changed detail

Changed firmware

{#comparisonsummary} {type}

{addedimg} {added}

 

{removedimg} {removed}

 

{changednameimg} {changedname}

 

{changeddetailimg} {changeddetail}

 

{changedfirmwareimg} {changedfirmware}

{/comparisonsummary}

 

 

Comparison Detail

PLID

Name

Detail

Number

Part number

Revision

Firmware

{#comparison} {plid}

{nameimg} {name}

 

{oldName}

{detailimg} {detail}

 

{oldDetail}

{circuitidimg} {circuitid}

 

{oldCircuitid}

 

{partnumberimg} {partnumber}

 

{oldPartnumber}

{revisionimg} {revision}

 

{oldRevision}

{firmwareimg} {firmware}

 

{oldFirmware}

{/comparison}

 

 

Migration plan

This produces a list of commonly used TDM features and indicates if they are supported (or have specific requirements) on the major hosted solutions

Facility in use

# of instances

Cisco Support

Broadsoft Support

SfB Support

{#migrationfeatures}

{statusimg}

{desc}

{count}

{ciscoIcon} {ciscoInfo}

{broadsoftIcon} {broadsoftInfo}

{sfbIcon} {sfbInfo}

{/migrationfeatures}

 

Other Tokens

 

SNMP

SNMP Type

Name / IP

Mode

{#snmp} {type}

{name}

{mode} {/snmp}

 

This will detail all SNMP communities and Trap targets

Avaya Specific Tokens

 

Uniform Dial Plan

Prefix

Length

Delete

Insert digits

Conv

Node

Num

{#uniformplan} {id}

{Len}

{Del}

{Insert}

{Conv}

{Node}

{Num}

{/uniformplan}

 

Shows dial plan information (digit modification)

Coverage Paths

 

Path ID

and

Settings

Next Path?

Active

Busy

Don’t Answer

All

DNDSACGoto_Cover

Holiday Coverage

Points

{#coveragepaths}

Path: {id}

 

 

CvgEnable: {CvgEnable}

HuntAfter: {HuntAfter}

Linkage: {Linkage}

 

 

{NextPath}

In: {Active_In}

 

Out: {Active_Out}

In: {Busy_In}

 

Out: {Busy_Out}

In: {Dont_Answer_In}

 

Out: {Dont_Answer_Out}

In: {All_In}

 

Out: {All_Out}

In: {DNDSACGoto_Cover_In}

 

Out: {DNDSACGoto_Cover_Out}

In: {Holiday_Coverage_In}

 

Out: {Holiday_Coverage_Out}

1: {Point1}

2: {Point2}

3: {Point3}

4: {Point4}

5: {Point5}

6: {Point6}

 

{/coveragepaths}

 

Coverage Time-of-day

Set

Day

Act Time

Coverage Path

{#coveragetod} {set}

{id}

{ActTime}

{CvgPath}

{/coveragetod}

 

Abbreviated Personal Dial Lists

Extension DN

List #

Code

Number

{#abvperslist} {set}

{id}

{Code}

{Number}

{/abvperslist}

Mitel Specific Tokens

 

 

Application Record ID

{applicationId}

Platform Type

{platformType}

Platform Name

{platformName}

e.g. “Industry Standard Server”

System Unique Identifier

{uniqueId}

Database Version (MiVO)

{system_dbversion}

Database Build ID (MiVO)

{system_dbbuildid}

 

DN’s exceeding 12 button limits

DN

Name

Location

# of buttons

{#miccbuttonlimits} {dn}

{name}

{location}

{count} {/miccbuttonlimits}

Used to identify DN’s that cannot migrate as-is to MiCloud Connect

DID Ranges

Total DID : {totaldidranges}

All DID Ranges

Trunk group

Base number

DN Count

Trunk Count

{#didranges} {trunkgroup}

{basenumber}

{dncount}

{trunkcount}

{/didranges}

 

Individual DID

Trunk group

Base number

DN Count

Trunk Count

{#didranges2} {trunkgroup}

{basenumber}

{dncount}

{trunkcount}

{/didranges2}

 

Ranges only

Trunk group

From

To

DN Count

Trunk Count

{#didranges3} {trunkgroup}

{from}

{to}

{dncount}

{trunkcount}

{/didranges3}



 

Detail # of Button Boxes per location

Location

# of Button Boxes

{#bboxes} {location}

{total} {/bboxes}

Total Button Box count: {bboxcount}

 

Dialling Plan

Digit

Description

{#dialingplan} {digit}

{desc}{/dialingplan}

 

Gateways

Type

Name

Detail

MAC

IP Address

{#gateways}{cabtype}

{detail}

 

{name}

{mac}

{ip}{/gateways}

 

Note: You can replace {cabtype} with {switchtype} for Mitel MiVoice Connect systems to show more meaningful information within the {#gateways} table

 

Languages

Language

User Count

Code

LCID

Locale

Voice LCID

Voice Locale

{#languages}{language}

{count}

{code}

{LCID}

{locale}

{voiceLCID}

{voiceLocale}{/languages}

 

Details each language used in a MiVC configuration

For MiVoice Office

Primary Language

Secondary

{#languages} {primary}

{secondary} {/languages}

 

DNIS Map

Trunk Group

Received Digits

Type

Destination

Display Name

Music on Hold

{#dnis} {tg}

{received}

{type}

{dest}

{name}

{moh} {/dnis}

 

Conferencing Map

Trunk Group

Received Digits

Destination

Display Name

Music on Hold

{#conf} {tg}

{received}

{dest}

{name}

{moh} {/conf}

 

Schedules

Name

Mode

Type

Date or Date

Start / End Time

Time Zone

{#schedules}{name}

 

{mode}

{type}

{dayordate}

{starttime}

{stoptime}

{timezone}

{/schedules}

Details all schedules in place on a MiVoice Connect/Shoretel

Or just use {schedulecount} to just get the count of the schedules.

 

Contacts

Company Name

Serial

Address

City

Contact

Tenant ID

{#contacts} {companyname}

{serialnumber
}

{companyaddress}

{companycity}

{primarycontactname}

{tenantid}

{/contacts}

 

System Devices

System Extension

Name

Extn Name

Detail

Description

Username

IP Address

MAC

{#sysdevices}

{circuitid}

{name}

{extname}

{detail}

{desc}

{username}

{IP_Address}

 

{MAC}

{/sysdevices}

This details all extensions that are not actual phones (e.g. Voicemail etc.)

 

Call Flows (MiVC)

Shows a simplified view of the DNIS -> Groups/Points

Type / Name

Received

Destination

Trunk Group

Slot

Key/Event

Action

DN

Name

{#callflows}

{type}

{name}

{info}

{rec}

{dest}

{tg}

{slot}

{key}

{action}

{dn}

{dnname} {/callflows}

 

Dynamic Extensions (MiVO 250)

Extension

Type

Destination

Description

Outside No?

Private?

Active?

Message Waiting

{#dynamic}

{extn}

 

{dest_type}

{dest}

{description}

{outside_number}

{private_number}

{is_active}

{mwi}

{/dynamic}

 

 

 

 

 

 

 

 

 

Maintenance Accounts

ID

Description

Username

Password

Enabled Adv Web Page + Diags

Linux Account

{#maintacc}

{password_id}

{description}

{username}

{password}

{web_page_and_diagnostics}

{linux_account}

{/maintacc}

 

 

 

 

 

 



Route Groups (MIVO 250)

 

 

Route Group Extension

Order

Route Group Description

Pattern

Facility Group Number

Facility Group Desc

{#routegroups}

{extn}

{order}

{groupdesc}

{pattern}

 

{route}

{routedesc}

{/routegroups}

 

Shows route groups and facilities

 

Route Patterns

Number

Description

Order

Ring In Dest

Call routing key

{#routepatternskeys} {num}

{desc}

{order}

{ringin}

{key}

{/routepatternskeys}

 

Route Patterns (Keys)

Number

Description

Call routing key

{#routepatternskeys}

{num}

{desc}

{key}{/routepatternskeys}

 

Facility Groups (MIVO 250)

 

Facility Group Extension

Facility Group Description

Trunk Group Extension

Trunk Group Description

Dial Rule Number

Rule

Absorb Flag?

Hidden Flag?

{#facilitygroups} {extn}

{desc}

{trunk_extn}

{trunk_desc}

{ruleid}

{dialrule}

 

{absorbFlag}

{hiddenFlag}

{/facilitygroups}

 

 

Route Groups (MIVO 250)

Route Group Extension

Order

Route Group Description

Pattern

{#routegroups}{extn}

{order}

{groupdesc}

{pattern}{/routegroups}

 

Emergency Numbers (MIVO 250)

Entry

Emergency Number

{#emergency}{entry}

{emergencynumber} {/emergency}

 

Area Codes (MIVO 250)

Entry

Emergency Number

{#areacodes}{entry}

{code}{/areacodes}

 

User list (MIVO 250)

First name

Last name

Access

{#userlist}{firstname}

{lastname}

{access}{/userlist}

 

User List Summary (MIVO 250)

Type

Count

{#userlistsumm}{type}

{count}{/userlistsumm}

 

Details MiVO UserGroup usage

User group name

Total users

Percentage using

{#usergroups} {userGroup}

{totalUsers}

{percentUsing}{/usergroups}

 

MiVO Metrics

Category

Count

{#metrics} {name}

{value}{/metrics}

 

MIVO COS Counts

COS

Number of DNs using day

Number of DNs using night

{#coscounts} {cos}

{totalday}

{totalnight}{/coscounts}

 

Cisco Specific Tokens

 

Translation Patterns

Pattern

Description

CSS

Route Partition

Called Party Transform Mask

Called Party Prefix Digits

{#translationpatterns} {pattern}

{desc}

{css}

{routepartition}

{calledmask}

{calleddigits} {/translationpatterns}

 

SRST Servers

SRST

IP Address 1

Port 1

IP Address 2

Port 2

IP Address 3

Port 3

{#srst}{srst}

{ipaddress1}

{port1}

{ipaddress2}

{port2}

{ipaddress3}

{port3}{/srst}

 

Calling Search Spaces

Name

Description

Calling Search Spaces

{#searchspace}

 

{name}

 

{desc}

{ccs}

 

{/searchspace}



Migration considerations and totals

 

Icon and info {mitelconnectIcon} {mitelconnectInfo}

{mf_itemName} Will show individual fields from above migration considerations (e.g. mf_HuntGroups)

{mfs_itemName} Will show MiCloud Connect support for the same field

{mfi_itemName} Will show MiCloud Connect support for the same field as an Icon

 

Insight

Count

Comment

Total devices

{migc_totaldevices}

(Mobility hidden)

{migd_totaldevices}

Total Analog Devices

{mf_AnalogPhones}

Analog phones, faxes etc.

Total profiles

{migc_totalprofiles}

{migd_totalprofiles}

Total Mobility

{migc_totalmobility}

{migd_totalmobility}

Total Soft Phones

{migc_totalsoftphones}

{migd_totalsoftphones}

Total DNs

{migc_totaldns}

{migd_totaldns}

Total DNs without name

 

{migc_totaldnswithoutname}

{migd_totaldnswithoutname}

Total Extns/Profiles within a DN

{migc_totalwithoutnumber}

{migd_totalwithoutnumber}

Total Hunt Groups

 

{migc_totalhuntgroups}

{migd_totalhuntgroups}

Total Queues

{migc_totalqueues}

{migd_totalqueues}

Total Route Points

{migc_routepoints}

Total # of route points

Total ACD Groups

{migc_totalacdgroups}

{migd_totalacdgroups}

Total Workgroups

{migc_totalworkgroups}

{migd_totalworkgroups}

Total PRG

{migc_totalprg}

{migd_totalprg}

Total MDUG Groups

{migc_totalmduggroups}

{migd_totalmduggroups}

Total Ring Groups

{migc_totalringgroups}

{migd_totalringgroups}

Total Pickup Groups

{migc_totalpickupgroups}

{migd_totalpickupgroups}

System Devices

{migc_totalsystemdevices}

{migd_totalsystemdevices}

Trunk groups

{migc_trunkgroups}

{migd_trunkgroups}

Empty trunk groups

{migc_emptytrunkgroups}

{migd_emptytrunkgroups}

Total Paging Groups

{migc_totalpaginggroups}

{migd_totalpaginggroups}

Soft Phones

{migc_totalsoftphones}

{migd_totalsoftphones}

ARS Route Groups

{migc_totalarsgroups}

{migd_totalarsgroups}

NON-SIP Trunk Groups

{migc_nonsiptrunkgroups}

{migd_nonsiptrunkgroups}



Additional Migration Insights Tokens for Specific Vendors

Insight

Count

Comment

Vendor

Phantom Devices

{migc_totalphantomdevices}

{migd_totalphantomdevices}

MIVO 250

Network Groups

{migc_totalnetworkgroups}

{migd_totalnetworkgroups}

MIVO 250

Off-Node Devices

{migc_totaloffnodedevices}

{migd_totaloffnodedevices}

MIVO 250

Total Hotdesking (Active)

{migc_totalhotdesking} ( {migc_totalactivehotdesking} )

{migd_totalhotdesking}

MIVB/3300

 

XNET Trunk Groups

Trunk Group

Number of trunks

SIP Peer Profile Label

Group type

{#xnettrunkgroups}{groupnum}

{count}

{description}

{type}{/xnettrunkgroups}

 

 

SIP Trunk Groups

Trunk Group

SIP Licenses

Min Reserved

Max Simultaneous Calls

SIP Peer Profile Label

Group type

{#siptrunkgroups}{groupnum}

{maxSIP}

{minCalls}

{maxCalls}

{description}

{type}{/siptrunkgroups}

 

SIP Peers (MiVB)

SIP Peer Profile Label

Minimum Reserved Call Licenses

Max Simultaneous Calls

{#sippeers} {description}

{minCalls}

{maxCalls} {/sippeers}

 

 

STAR configuration (MiVO)

Extension

Description

Username

Type

{#star} {extn}

{desc}

{user}

{type} {/star}

 

LOS License File (MiVB 9+)

Licensed Options

Locally Consumed or Locally Allocated

Locally Allocated

Available for Allocation

Purchased

Licenses Allowed

Can be Over Allocated

{#loslicenses}

{licenseOption}

{locallyConsumed}

{locallyAllocated}

{availableForAllocation}

{purchased}

{licensesAllowed}

{canBeOverAllocated}

{/loslicenses}

 

LOS Configuration options

Configuration Option

Value

{#losoptions}{name}

{value}{/losoptions} 

 

 

 



Extension Lists (MiVO)

Type

Extension

Description

Count

{#extensionlists} {type}

 

{extension}

{desc}

{count}{/extensionlists}

 

For RingCentral support, you can also add {rcwarning} to show any Extension List issues.

 

 

 

Server Settings

Returns all Server settings located in the “Server” feature table

Name

Current IP

IPS IP

{#serverinfo} {platform_name}

{current_ip}

 

{ips_ip} {/serverinfo}



Call Usage Tokens

The high-level insights for the usage of the telephone usage of users.

NOTE: This section of the report requires CDR data to allow population.

 

{total_phones} Total DN's

(Directory Numbers)

{total_calls} DN's making calls

 

{total_calls_in} DN's receiving incoming calls.

 

{total_calls_out} DN's making outgoing calls

 

 

 

Zero / Low Usage

 

 

Medium Usage

High Usage

{total_users_zero_calls} users with 0 calls

 

{total_users_less20_calls} with under 20 calls

 

{total_users_less50_calls} users with under 50 call involvements

 

{total_users_less100_calls} with under 100 call involvements

 

{total_users_over100_calls} users with over 100 call involvements

 

{total_users_over250_calls} over 250

 

{total_users_over1000_calls} over 1000

 

Alternative Tokens:

Metric

Count

Total Extension Directory Numbers (DN’s)

{extns_calls_totalextns}

Total Calls out for ALL DN’s

{extns_calls_out}

Total Calls out duration

{extns_durn_in}

Total Calls in for ALL DN’s

{extns_calls_in}

Total Calls in duration

{extns_durn_out}

Total number of extensions with more than 10 calls out

{extns_calls_out_10}

Total number of extensions with more than 10 calls in

{extns_calls_in_10}

Total number of extensions with more than 10 calls in or out

{extns_calls_in_out_10}

Cost of an E3 license for all devices {e3}

Cost of an E5 license for all devices {e5}

Cost of an E3 license for all devices making or receiving >10 calls {e3_over_10}

Cost of an E5 license for all devices making or receiving >10 calls {e5_over_10}

 



Special case tokens

 

{hide8x8} Removes 8x8 handset compatibility from considerations list.

{hide164} Removes international flags and names from extension number ranges.

{miccwarnings} Adds MICC migration warnings [DEPRECATED]

{rcwarnings} Adds RC warnings to certain tokens (e.g. {#groupsumm})

 

 



Teams Migrations Tokens

License Insights

The following tokens are generally specific to teams, although some (like ‘usage’ tokens) can be used for other target vendors too.

 

Total Extension DN’s : {extns_calls_totalextns}

Extensions making outbound calls: {extns_calls_out} (>10 Calls = {extns_calls_out_10})

Extension receiving calls: {extns_calls_in} (>10 calls = {extns_calls_in_10})

 

Extensions making OR receiving > 10 calls {extns_calls_in_out_10}

 

{chartusage}

 

Total cost if using E3 : {e3}* Total cost if using E5: {e5}*

 

Total cost if using E3+Voice based on {extns_calls_in_out_10} extensions in use (based on CDR data):

{e3v}* - {e3insight}

 

*Based on costs of E3 = {e3cost}, E3+Voice = {e3vcost} and E5 = {e5cost}

 



Unsupported Teams Features

 

This details features that have limited or no support in Teams

 

Facility

# in Use

Comment

{#teamsinsights} {facility}

{count}

{info}{/teamsinsights}

ACD Chart

 

This will show an ACD/IVR tree on compatible audits (Mitel MiVB, Shoretel/MiVoice Connect)

 

{chartacd}

Note: Scaling may be required after the document is generated.

 

Cabinet/PABX Wiremap Chart

 

{chartcabs}

 

Note: Scaling may be required after the document is generated.

 

Index