This guide outlines how to create a word merge template, the use of tokens and the context each should be used in.
...
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
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
...
| {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} |
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
...
| Anchor | ||||
|---|---|---|---|---|
|
| Anchor | ||||
|---|---|---|---|---|
|
The system type is ‘{platformType}’ running on ‘{platformName}’
There are {total_mg}nodes in this configuration.
...
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} |
...
| 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
| Anchor | ||||
|---|---|---|---|---|
|
...
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} |
| Anchor | ||||
|---|---|---|---|---|
|
...
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 |
| Anchor | ||||
|---|---|---|---|---|
|
...
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 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} |
...
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
...
{#huntsumm} {/huntsumm} - Hunt groups only
{#queuesumm} {/queuesumm} - Queues only
{#pickupsumm} {/pickupsumm} - Pickup group only
...
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
| Anchor | ||||
|---|---|---|---|---|
|
...
LIM | Type | Analog Extns | Digital Extns | Operator Extns | Total for LIM |
{#sapsec}{lim} | {type} | {analogextns} | {digitalextns} | {oprextns} | {total}{/sapsec} |
Totals: | {saptotalanalog} | {saptotaldigital} | {saptotaloperator} |
| Anchor | ||||
|---|---|---|---|---|
|
...
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} |
| Anchor | ||||
|---|---|---|---|---|
|
...
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} |
...
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 {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} 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}
| Anchor | ||||
|---|---|---|---|---|
|
...
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}
| Anchor | ||||
|---|---|---|---|---|
|
This details features that have limited or no support in Teams
Facility | # in Use | Comment |
{#teamsinsights} {facility} | {count} | {info}{/teamsinsights} |
...
| Anchor | ||||
|---|---|---|---|---|
|
{chartcabs}
Note: Scaling may be required after the document is generated.
...