Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Contents

Table of Contents

...

Overview

The UCentric ZT (Zero Touch) interface is an SPA (Single Page Application) that provides a “Zero Touch” approach to both auditing and provisioning of voice phone systems.

Scope

This document should be used for initial user training in usage of UCentric ZT. However, the The interface has been deliberately simplified in order to allow it’s use throughout an organisation without any prior training or incumbent knowledge of PABX’s or UC platforms.

Supported Vendor Backups / Provisioning Targets

Supported Vendor Backups for Auditing

A list of all supported vendors can be found here:

https://mittech.atlassian.net/wiki/spaces/MKB/pages/3866637/Vendor+Support+and+Capabilities#Supported-Audit-Methods-for-Voice-Audits

Supported Provisioning Targets

A list of all provisioning targets can be found here:

https://mittech.atlassian.net/wiki/spaces/MKB/pages/3866637/Vendor+Support+and+Capabilities#Direct-orchestration

Using UCentric ZT

Anchor
login
login
Logging In

Logging in uses the standard UCentric login credentials, (SSO will be later supported). Each User Login defines the branding and capabilities associated with the user’s organisation(s). This allows us to limit what types of systems can be audited or provisioned to. Once logged in, there are just two options: - “Auditing” or “Provisioning”.

...

Note, depending on the login profile options selected in the main web interface, only “Auditing” may be shown.

...

Anchor
audit
audit
Auditing

To audit any (compatible) PABX/UC platform, you simply drop the standard PABX/UC vendor backup on the page. The system will analyse the file and determine the PABX/UC platform automatically. For info on what PABXs are supported please refer to the ‘UCentric Voice Audit and Migration Capabilities’ document.

...

Once you have dropped in the file you wish to Audit select the PABX type (depending on the audit type this may be automatically detected/selected for you). Now simply enter a new site name (or select from an existing site), along with the recipient email address(es) and click “Create Migration Plan”.

...

Once clicked the migration plan will start building and You will also be given options that relate to the login profile that is set.

This will be either “Email” or “Direct Download”

Note

Note: When dropping a file onto the portal, ensure that it is not open in another application (e.g. Excel) otherwise it may not upload.

Anchor
download
download
Direct Download

If using the direct download option, you will see a window similar to the one below. Here you can choose a name for the site or PBX being audited and may also have an additional field for sales order, customer reference or other data which is customisable in the login profile.

Click “Create migration plan” to begin the audit.

...

You can also blend additional files at this point such as CDR, Voicemail DDI ranges, and Active Directory extracts. This will include information for this against users/devices in the Migration Plan/LLD.

Please refer to the Data Blending section for more information and guides on carrying this out.

...

The audit window will show you the processing of data which will usually take less than a minute but may take up to 5

...

Once complete you can select the HLD or LLD reports to download. The report templates set by default or the LLD formats you have available will be chosen by the settings in the login profile.

...

Multiple LLD templates are available and can be selected if they are set in the login profile.

The report downloads the same files (in real-time) as would be delivered by email, including any branding or output format that has been selected within the login profile.

Anchor
email
email
Email

If using the “Email” option within the login profile, you will see a window similar to the one below. Here you can choose a name for the site or PBX being audited as well as the email address to send the reports to.

Click “Create migration plan” to begin the audit.

...

You can also blend additional files at this point such as CDR, Voicemail DDI ranges, and Active Directory extracts. This will include information for this against users/devices in the Migration Plan/LLD.

Please refer to the Data Blending section for more information and guides on carrying this out.

When using the email option, you will see a confirmation of the audit being run as shown below. You will not see the live processing status like when using the Direct Download option

...

Reports should be sent to the previously inserted email address(es) within an hour. You will receive two separate Emails, one containing a HLD (High Level Document) and another containing an LLD (Bulk Loader/Migration plan). These documents will be braded branded based on the logged-in user’s organisationprofile.

...

Auditing with direct results

If enabled by the login profile, the email box will be replaced by a direct download link upon completion of the audit (with real-time messages shown during the audit)

...

The links at the bottom of the page produce the same files (in real-time) as would be delivered by email, including any branding or output format that has been selected within the login profile.

Anchor
provisioning
provisioning
Provisioning

To provision, simply click on the Provisioning tab, select the target vendor and drop a standard LLD Excel Spreadsheet onto the form. You will then be presented with the following screen.

...

Make sure to select your ‘target platform’ and fill out any other required fields. Once done, enter in the desired email address(es) and click ‘Provision System’.

You will now receive an email within 3 hours. This will contain either the Bulk Loader (e.g. Cisco BATS) or a Provisioning Report (e.g. Broadsoft, Mitel etc.) detailing all the users and devices that have been provisioned, along with their usernames, passwords etc.

Supported Vendor Backups / Provisioning Targets

Supported Vendor Backups for Auditing

The following is the list of currently supported Audits by Vendor Backups. This list is ever growing, so it is recommended that you speak to your accounts manager to enquire as to any Vendor Backups that are not featured in this list, as these may be in development / earmarked for future development.

  • Alcatel OmniPCX

  • Asterisk

  • Cisco CUCM

  • Siemens/Unify HiPath

  • Avaya IP Ofiice

  • Mitel MiCC

  • Mitel MiCollab

  • Mitel MiVoice Connect (Shoretel Shoreware)

  • ONE425

  • Unify OpenScape (OSV)

  • Avaya BCM

  • 3CX

Supported Provisioning Targets

The following is the list of currently supported Audits Provisioning Targets. As previous it is recommended that you speak to your accounts manager to enquire as to any Provisioning Targets that are not featured in this list, as these may be in development / earmarked for future development.

...

Cisco BATS (Bulk Loader)

...

Cisco WebEx Calling / WxC (Bulk Loader)

...

Broadsoft (Direct provisioning)

...

Teams (PowerShell Scripts [Graph API to follow])

...

...

The options available will change depending on the target vendor. For example, WebEx by Cisco/WebEx Calling provisioning requires you to authenticate with WebEx prior to the provision.

Permission is also required from the vendor for some solutions therefore please contact us for further information and we can assist.

...

Note

NOTE: When dropping the Excel LLD file onto the portal, ensure that you do not have it open in Excel otherwise it will not upload.


Anchor
advanced
advanced
Advanced Options (Data Blending)

Data blending is the process of adding additional files to a PBX audit to augment it and add information from other systems such as Active Directory, Voicemail or call data (CDR).

To add files for blending, you can select the “Advanced options” section within the ZT Portal which will provide the options shown below.

...

Click the File upload icon in order to begin uploading additional files.

...

Additional files can then be dropped into this window once you have selected the relevant file from the drop down, once selected and you have added the file, click “Add” to add it to the audit.

Supported formats

All additional files for blending are required to be in CSV format. We can also provide example files for you to compare/check against if required.

The format for each supported filetype is shown in the sections below, please ensure “Default Field Mappings” match the column names in your csv files.

Type

Typical export from

Default Field mappings

Info

Active Directory

Microsoft AD

Telephonenumber/Phone
DDI/Phone
CN
DisplayName/FullName/DirectoryName
firstName/givenname/forename
SAMAccountName
Company
Department
E-Mail/Email/EmailAddress/Mail
SIPADdress
ObjectSID
UPN/UserPrincipalName
Mobile/MobilePhone/Cell/CellPhone

Looks for Line1DN to patch telephonenumber/phone, if no match, attempts to match on name.

Will map all appropriate fields if it finds a match.

DDI

This is generated by us/you on a per-customer basis

EXTNPATTERN
DDIPATTERN
REGIONID
REGIONNAME
NAMESPACE
OVERRIDEREGIONNAME

This is used to bulk-map DDI and override locations if needed.

In this example, any extension in the form 420xxx will be given an appropriate line1DDI number, and the regionName will be overrriden to "Amsterdam" - The RegionId of -1 means "match all locations to find this number in the list"

The example 567x will only be overridden if the existing location (regionID /regionName ) matches.

Note: The number of underscores must be the same in the suffix of the 1st two columns for this to work

Devices

Generated by you/us if needed 

userId
MAC
deviceType

Used primarily for Broadworks exports where device information isn't in the backup;
Looks for the Line1DN or Line1DDI matching userId, if matched, sets the MAC and primaryModel (if each not already populated)

Network

Edge switches

Number
MAC
IP
Switch
Port
Last Seen

Will try to match on Number, IP or MAC. If found, will set LANSwitch, LANPort and LANLastSeen values

Recorder

NICE NTR

Primary Extension Name

If the "Primary Extension Name" matches Line1DN, then the callRecordingMode column is set to "Yes"

Voicemail

Unity

FirstName
LastName
Extension
group

Will persVoicemail voicemail if found, or groupVoicemail if set

CDR

Cisco CUCM

https://mittech.atlassian.net/wiki/spaces/MKB/pages/35323905#Adding-CDR-to-Cisco-BATs-audit

Vendor Specific Blending

Some vendors have their own formats for files that can be extracted when collecting a backup from a PBX, guides for blending these specific files are shown in this section.

Adding CDR to Cisco BATs audit

CDR files can also be added to the backup that is being imported into UCentric. The guide below explains how to do this for Cisco CUCM BATS files and CDR extracts.

https://mittech.atlassian.net/wiki/spaces/MKB/pages/35323905#Adding-CDR-to-Cisco-BATs-audit

Ensure that the CDR file (NOT CMR) is in CSV format and the filename suffix is .cdr.txt

Create a new ZIP files (NOT tar, 7zip or tgz)

Add the .tar/.tgz BATS backup and the CDR file to the new ZIP file. Ensure it looks like the below and is not in a sub folder within the ZIP file.

...

Use the ZIP file instead of the tar/tgz for the audit following the https://mittech.atlassian.net/wiki/spaces/MKB/pages/35323905#Auditing section of this guide to process the audit and generate reports. Any HLD or LLD you generate will now include the CDR that you processed in this audit.

Overiding settings for special edge-cases

For some decoders (e.g. Cisco CUCM) there are specific edge-case situations that are catered for with options that appear in the Advanced Options.

These options only appear if applicable.

Cisco CUCM

The two options available for Cisco CUCM/HCS are “Allow Duplicate DNs” and “Check End-Users first”

Allow Duplicate DNs: Cisco allows the same DN (Directory Number) to appear on multiple devices and profiles. Generally UCentric will ignore repeated devices or profiles and only allow one of each. This option allows multiples to appear. They will however be seperated and placed on the “Duplicates” tab of the LLD spreadsheet.

Check End-Users first: The normal order of scanning is devices, profiles, end-users, with the creation of a DN as a device / profile actioned in this order. The end-users is then applied to the list (device profiles first). Selecting this option forces the logic to end-users, devices, profiles instead.

...

Index

Table of Contents