Contents

Revision history

Please refer to Supported Vendors List document in SharePoint or Repo for revision history prior to moving article to Confluence

Overview

This page details the supported vendors and capabilities for UCentric Voice Audit and Migration.

It is designed as a broad overview of capabilities and the types of data that can be captured. It is not intended to be a complete specification of each decoder and should be used as a general reference guide only.

Supported Audit Voice Platforms Features Matrix

Outputs

Migration Plan Export formats

The migration plan exporting allows blending of additional data (e.g. AD, CDR, DDI ranges etc.) and then export to either “Bulk loaders” or direct provisioning through a script, backup or direct “Orchestration”.

Additional Data Imports and Blending

When exporting data for the purposes of migration, additional data sources can be imported into UCentric to blend it with audit data. Supported additional datasets and formats are shown in this section

DDI number ranges / extension ranges

This data ensures DDI information is associated with a device, user, or extension. It can be used to highlight any issues a migration would encounter from users who have moved locations but retained their extension number. Hunt groups spanning multiple locations can also be identified with this information

Call Logging SMDR/CIL

This data allows for identification of any extensions or users that have no or little activity, and therefore may not need to be migrated.

Network MAC/IP captures (CDP/LLDP logs)

Network data allows for IP devices that have not been connected to the network to be identified which may then be considered as inactive or unused.

Active Directory/LDAP

An export from Active Directory or an LDAP server allows for the correct allocation of names against extension numbers where an integrated telephone directory is either unpopulated or inaccurate. Departmental information can also be associated against a user.

Voicemail Exports (Cisco Unity Included)

We can also blend in exports from Voicemail systems such as unity or 3^rd party voicemail if it contains a list of users with voicemail configured. This allows for identification of voicemail users in the LLD reports for replication on the hosted voice or system that is being migrated to.

Export Formats

Bulk Loaders

UCentric has the capability to export the audited data in several pre-defined export formats suitable for direct bulk-loading into client platforms.

Excel Spreadsheet

This is the standard format for export, which provides separate tabs for devices, profiles, hunt groups, pickup groups, and region information and allows blending and highlighting of usage and out-of-service, and the blending and transformation of data.

JSON

This provides the same data as the Excel output, but in JSON format suitable for consumption by orchestration platforms.

Custom formats

In addition to the above, there are several client-specific bulk export formats.

SPA (Zero Touch)

SPA, or “Zero Touch” refers to the “Single Page Application”, a simplified interface for Auditing and Provisioning within UCentric. This only functions with ‘PABX Backups’ and is indicated by the UCentric Zero Touch Logo (below) shown against the vendor name in the Backup Support sections of this document.

Direct orchestration

The “Direct Orchestration” provides the means to directly build or ‘Orchestrate’ the config of a new system though a script, a backup, or through direct API Orchestration

BroadWorks (Broadsoft)

With BroadWorks credentials, this can directly populate a Broadsoft/Cisco BroadWorks platform through their web API.

Microsoft Teams

Using the Graph API (expected Q2022) or PowerShell scriptlets, this automatically creates users, direct connect and presence groups.

BATS

Creates a v12.5 BATS backup that can be restored directly onto a Cisco CUCM / HCS solution

Skype PowerShell Script

This generates a script that can be locally executed on a private cloud / on-premise Skype-for-Business platform to create all the users, groups and direct connects.

EMU

With a direct connection into EMU (or EMU JSON format), this ultimately publishes to a Cisco BroadWorks platform through intermediate JSON.

8x8

Provides an 8x8 compatible spreadsheet that can be bulk loaded into the 8x8 platform

5. Direct orchestration (continued)

WebEx Calling

Creates a WebEx calling direct bulk loader

RingCentral

Direct API provisioning to the RingCentral cloud solution using SSO credentials

Unify XML

Creates an XML file compatible with the Unify OpenScape bulk loading process

Backup support

The backup mechanisms and tools vary from vendor to vendor. Below is a brief description of the supported IMPORT backup formats and methods for each.

OmniPCX

The standard tab format from an Alcatel OmniPCX appears as follows:-

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live Alcatel -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.txt”

/ FreePBX (and derivatives)

First of all, obtain a backup through the web portal for the Asterisk/FreePBX by selecting the top menu, then click “Admin” and select “Backup & Restore”

Select “Add Backup”

Under “Add Backup” Give the backup a name and a description.

Under “Storage” click the drop-down menu and select the file storage location you can access (create one if none are shown)

Click “Submit” in the lower right corner of the page. Doing so will return you to the “Backup & Restore” page.

Running the backup

On the “Backup” tab of the “Backup & Restore” page click the “play” icon under the “Actions” heading.

You will be presented with a scrolling log of the backup in real time. Depending on the size and complexity of your PBX this may take some time.

When your backup is complete, a blue banner stating “Your backup has finished” will briefly appear. If you happen to miss this banner look for a line stating “Finished saving to selected filestore locations” in the log.

Select “Close” on the log display

Downloading the Backup

On the “Backup & Restore” page select the “Restore” tab and click the “Download” icon in the “Actions” field of the “Restore from local cache” block.

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live Alcatel -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.tar.gz”

CUCM

The Cisco CUCM decoder utilises the “BATS backup” capability of the CUCM. To obtain and import a BATS backup, follow these steps.

Login to the Cisco Unified Administration

Login into the “Cisco Unified CM Administration” portal from a Web Browser, note: Firefox is recommended for older Cisco CUCM’s due to HTML compatibility issues on other browsers.

Creating the backup

Select the “Export” function from “Bulk Administration” in the top menu

Enter a suitable name for the backup and press “Submit”

You should see the following message appear in the status panel

Check Scheduler

Go to the Scheduler to ensure that the backup job in progress

If the job says “Hold”, activate it by ticking the checkbox and clicking on “Activate Selected”

If the job appears to get stuck on “Pending”, us the “Cisco Unified Serviceability” interface and ensure that the AXL, BPS and TAPS services are all activated (Note: this requires Admin access)

When completed, the status will change

Downloading the backup

Select “Upload/Download” files in the “Bulk Administration” menu.

Enter the prefix you entered in 2.2 and click on “Find”

Select the backup and click on “Download Selected”

Finally, save the file on your local system to use as an import to UCentric Voice Audit.

Cisco backups performed from the standard web portal for the Cisco CUCM. This generates a .tar file. You can import this into UCentric the Universal Decoder, through the site manager in the web portal or from the command line using

Audit.exe Live CISCO -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.tar”

CUCM CDR Data

If you want to capture actual usage of the CUCM, you can also capture the CDR data at the same time and UCentric will process this when combined with a BATS backup.

Login to the Cisco Unified Serviceability

Login into the “Cisco Unified Serviceability” portal from a Web Browser, note: Firefox is recommended for older Cisco CUCM’s due to HTML compatibility issues on other browsers.

Then select “CDR Analysis and Reporting” from the “Tools” menu.

This will open a new window, select “Export CDR/CMR” from the “CDR” menu

Select the date range (ideally more than 3 months) and click “Export to File”

This will then display the following:-

Right-click and save both files then click on “Close”

CME (Call Manager Express)

For call manager express you can use the CME GUI and select “Administration -> Save Router Config”

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live CME -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.txt”

Avaya - IP Office

Perform a backup as described here: https://pbxbook.com/ipoffice/iposcimp.html

Login to IP Office Manager 
Click on File ➤ Import/Export ➤ Export...

Select the Check Box for All of the configuration, and click OK.

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live IP Office -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.txt”

Lync / Skype for Business / Teams

At present this is a semi-automated task that requires domain-admin privileges.

Please contact support@mit-tech.co.uk for more details.

BCM

The Notel/Avaya BCM audit can be imported from either an Excel config file that looks like this:-

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live BCM -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.xls”

HiPath / HiCom

Siemens/Unify HiPath’s can be audited from what is called a “Regen” or “LastLoad” file. Both are .txt files and look something like this:-

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live HiPath -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.txt”

OpenScape OSV

OSV can be imported from a ZIP file that contains .cfg and .csv files for the OSV configuration. It needs at a minimum:-

uc_users.csv UC Users

mediatrix.csv Mediatrix Servers

????_bgl_????.txt Main location devices

DLS-export.csv SIP + Keys

mlhg_??????.csv Hunt groups

export_all.txt Main configuration file

In addition the .cfg files for each gateway will enable UCentric to accurately audit the entire solution.

Then import the zip file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live OSV -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.zip”

MiCollab / MiCC / MiVoice Connect

Backups are achieved through importing standard ‘backups’ downloaded through the MiVoice Connect, MiCollab and MiCC application web portals.

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live MiVB -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.tar”

Audit.exe Live MiCC -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.tar”

Audit.exe Live MiCollab -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.tar”

MiVB

Backups are achieved through importing standard ‘backups’ downloaded through the MiVoice Business application web portal.

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live MiVB -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.tar”

NOTE: This method is only available to Mitel, and their Authorised Users

3300 / Legacy MiVB

Backups are achieved through manually exporting the following forms manually, and exporting them from the Mitel Application portal to a CSV file (one for each section) – then zipping them up into a single file for processing

Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live MiVB2 -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.zip”

BroadWorks (Broadsoft)

Cisco Broadworks can be audited via two methods. These are.

Using a tool called EMU if the customer has access which can then produce a (Broadsoft) JSON backup. Then import the file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live EMU -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.json”

A direct connection to BroadSoft using the OCI-P protocol. This relies on the customer providing the URL to the XSP server and a group admin and password for each account that requires auditing.

OpenScape Business (OSBiz )

OSBiz can be imported from a standard OSBiz XML input/export file.

It should appear in this form:

<?xml version="1.0" encoding="UTF-8"?>

<osbiz>

<general>

<xml_file_version>1.0</xml_file_version>

<system_type>OSBiz S</system_type>

<system_mode>UC Suite</system_mode>

<system_in_network>false</system_in_network>

</general>

<basic>

<gateway>

<customer_name>Test In House</customer_name>

<contract_number/>

<system_name>Test</system_name>

<gateway_location/>

<contact_address/>

<system_country>United Kingdom</system_country>

<brand>OpenScape Business</brand>

<international_prefix>00</international_prefix>

<national_prefix>0</national_prefix>

<country_code>44</country_code>

<local_area_code/>

<pabx_number/>

<node_id>0</node_id>

<continuous_tone>true</continuous_tone>

</gateway>

Then import the zip file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live OSBiz -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.xml”

NEAX

NEC NEAX systems can be imported from a Standard XLSX backup that has the following tabs:-

You can import the XLSX file into UCentric from within the site manager, Zero-Touch SPA or using the following command line:

Audit.exe Live NEC -S 123 -d 127.0.0.1 -f “relative\path\to\myfile.xlsx”

Call flows

The following PABX vendors exports also include ‘Call Flows’ – This details where a DID/DDI call originating from the public network is routed to an IVR, Hunt Group or ACD call path.

At present this is supported for:-

Mitel MiVC, Mitel MiVB, Avaya CM and Skype for Business

These call flows are included within the Excel Bulk Loader and High-Level Word documents.