MiVoice Office Application Suite - Technical Manual
Requirements
Introduction > Requirements

Overview

The system requires specific information and requirements to be met for any installation. Read each of the sections and ensure that the information requested is available prior to an installation.

  1. System Requirements
  2. PBX Supported Versions
  3. Browser Requirements
  4. Real-Time Client Requirements
  5. Desktop Client Requirements
  6. Network Configuration
  7. Anti-Virus Recommendations
  8. Email Details
  9. Users & Business Units
  10. Telephone Number Prefixes
  11. PBX Integration
  12. Backups
 

System Requirements

The server(s) must meet the minimum requirements described here.

Operating Systems

From release 5.0, Mitel Communication Service is supported on 64-bit operating systems only.

Windows Server Core installations are not supported.

Windows Server Small Business/Foundation/Essential versions are not supported.

 

SQL Server Requirements

SQL Server 2019 is installed during a new installation of MiVoice Office Application Suite. During MiVoice Office Application Suite upgrades, the version of SQL Server is not updated. The following versions of SQL are supported for use with MiVoice Office Application Suite:

From January 2020, SQL Server 2008 will no longer be supported by Microsoft and security updates will not longer be provided. Any system using SQL Server 2008 should upgrade to a later version of SQL. The following document provides instructions on performing an upgrade to SQL Server 2014 http://download.microsoft.com/download/3/8/E/38E85EDC-1D5E-4ED3-A106-87B125D42675/SQL_Server_2014_Express_Upgrade_Guide.pdf

Hardware Requirements

The minimum required hardware is dependent on the call rate, the number of Phone Manager clients that will be connected and the Application Suite features in use.

Select the size of system which will cover all of the systems limits.

 

System Limits
Hardware Requirements

Small:

  • 1,200 calls per hour
  • 50 Phone Manager Desktop Clients
  • 50 Phone Manager Mobile Clients (up to 5 softphone calls in progress)
  • 50 Mitel 6900 SIP Handsets
  • 8 Concurrent Call Recordings
  • 2 Concurrent Real-Time Wallboards/Dashboard

 

  • CPU: 1 x Intel Core i3 dual core @ 3.3 GHz
  • RAM: 8GB
  • HDD: 100GB + 1GB for each million call records
  • HDD: 1TB for each 175,000 hours of call audio data (Only applies when using MiVoice Office Call Recorder)
  • SQL Server: Express

Medium:

  • 2,400 calls per hour
  • 100 Phone Manager Desktop Clients
  • 100 Phone Manager Mobile Clients (up to 10 softphone calls in progress)
  • 100 Mitel 6900 SIP Handsets
  • 60 Concurrent Call Recordings
  • 5 Concurrent Real-Time Wallboards/Dashboard

 

  • CPU: 1 x Intel Xeon quad core @ 3.1 GHz
  • RAM: 16GB
  • HDD: 100GB + 1GB for each million call records
  • HDD: 1TB for each 175,000 hours of call audio data (Only applies when using MiVoice Office Call Recorder)
  • SQL Server: Express
  • NIC: 1Gb

Large:

  • 4,200 calls per hour
  • 500  Phone Manager Desktop Clients
  • 250 Phone Manager Mobile Clients (up to 25 softphone calls in progress)
  • 500 Mitel 6900 SIP Handsets
  • 250 Concurrent Call Recordings
  • 10 Concurrent Real-Time Wallboards/Dashboard

 

  • CPU: 2 x Intel Xeon quad core @ 3.1 GHz
  • RAM: 32GB
  • HDD: 100GB + 1GB for each million call records
  • HDD: 1TB for each 175,000 hours of call audio data (Only applies when using MiVoice Office Call Recorder)
  • SQL Server: Full
  • NIC: 1Gb
If a Teamed NIC is present on the server do NOT use this for licensing, Licenses the software against a physical NIC's MAC address only.

Software Requirements

The following software is required to be installed:

The Mitel Communication Service can not be installed on a Domain controller or Small Business Server

Virtualization Environments

Mitel Communication Service is supported in a virtual environment. The supported environments are listed in the table below.

Environment
Supported?
VMWare vSphere ESXi v5.1 or greater
Supported
Hyper-V 2012 R2 or greater
Supported
To ensure maximum performance for SQL server in a virtual environment please ensure that each virtual CPU is configured with a minimum of four cores per socket

Co-Hosting with Xarios Call Recorder

If the MCS is being installed on the same server as a Xarios Call Recorder, it is advisable to change the following settings so that there are no clashes between the products:

Website Port

By default, both products will host their websites on port 80. To access the products individually, one of the websites must be reconfigured within IIS to use a different port. The website can then be accessed by appending the port to the URL:

 

http://[server_name]:81

 

Be aware that the port will be reset to 80 after by any upgrade applied to the system.

 

Database Backup & Log Archive Directories

By default, both Xarios Call Recorder and MCS use the same folders for database backups and log archives. Both of these locations need to be changed otherwise files will be overwritten.

PBX Supported Versions

The following Mitel MiVoice Office 250 versions are currently supported:

If Mitel 6900 Handsets are being supported, the Call Processing Version must be 6.3 SP2 or higher.

The following Multi-Node configuration is supported:

The following pre-requisites must be met on the telephone system:

The following requirements must be met if using desktop or mobile Phone Manager Softphones:

The following requirements must be met if using Mitel 6900 Series Handsets:

The following requirements must be met if using the MCS Record-A-Call feature:

 MCS will not connect to CT Gateway Versions below 5.0.64. If it detects the version is lower than this it will fail to start.
 MCS does not support ACD member hunt groups, only ACD Agent hunt groups.
Only one SIP voicemail can be configured by default on the telephone system. If you are using NuPoint Messaging then the MCS will not be able to be added as a SIP Voicemail.
If using Phone Manager Mobile Softphone then the relevant SIP extensions need to be configured to use G.711
If using Phone Manager Mobile Office Link features then an OfficeLink Assistant Extension needs creating on the telephone system. Also, any user wanting to make use of the feature needs to have at least one external number in their DEE configuration.

Browser Requirements

The system is managed and accessed through a web browser. The following web browsers are currently supported.

Browser Version Plugins
Chrome 72 or greater  
Mozilla Firefox 65 or greater  
Microsoft Edge Current  
Microsoft Internet Explorer * 11 (not in compatibility view) Windows Media Player v10 for call recording playback

* Microsoft Internet Explorer can be used to access the website, however performance for the Real-time Dashboard can be slow. When using the Real-Time Dashboard, Chrome or Firefox browsers are recommended.

Due to the listed functionality limitations and Microsoft's focus being on other browsers, support for IE is being deprecated. This means we cannot guarantee that all functions will work in future versions of Application Suite and recommend the use of one of the other fully supported browsers. Issues using IE will be looked at on a best endeavors basis.

If accessing the website from an iOS device using Safari, the normal redirect does not work. Instead, use the following URL: http://[ServerAddress]/Login.aspx

Real-Time Wallboard/Dashboard Requirements

To be able to access the Real-Time Wallboard/Dashboard client device needs to meet the following minimum requirements. Please refer to the Browser Requirements section for further information.

PC Hardware Requirements

Processor Intel Atom x5-Z8330 or better
Memory Minimum: 2GB RAM
Recommended: 4GB RAM or more
Network IPv4, 100Mb / 1Gb LAN
Hard Disk Minimum: 32GB free space
Video

Minimum: DirectX v9 compatibly graphics cards with 120MB RAM
Recommended:DirectX v9 compatibly graphics cards with 1024MB RAM

Tablet/Mobile Hardware Requirements

Tablet iPad 5 or higher
Mobiles iPhone 5s or higher

Amazon FireTV Requirements

The table below outlines the requirements for using the application. In addition, the application requires a Real-Time Wallboard license from MiVoice Office Application Suite.

Area Minimum Requirement
MiVoice Office Application Suite 5.1.22 or later
Amazon Fire TV

Fire TV Stick 4k Ultra HD (2018) or later
FireTV OS 6 or higher
Mains USB Power (TV USB port may not supply enough power)

Television Must meet FireTV requirements (HDMI input, 1080 resolution etc)
Network

WiFi access is required or the optional Amazon Ethernet Adaptor for Fire TV. Please refer to your specific FireTV manual for supported configurations.

TCP Ports 8200/8204 are used to communicate to the MiVoice Office Application Suite

The Real-Time Wallboard FireTV application has been optimized for a 1080 HD resolution.

If the Real-Time Wallboard seems to overlap the sides of the screen, perform a screen calibration in the FireTV's settings:

Settings \ Display & Sound \ Display \ Calibrate Display

Phone Manager / Call Recorder Client Requirements

To be able to install and run Phone Manager the client computer needs to meet the following minimum requirements. If installing into a multi user environment where multiple instances of the client will be running, for example Microsoft Terminal Service, Citrix etc. then see the Multi User Computer Requirements section.

The Call Recorder Client is embedded within the Phone Manager installation. It has the same requirements as Phone Manager.

Operating Systems

Windows Server Core installations are not supported.

Windows Server Small Business/Foundation/Essential versions are not supported.

Hardware Requirements

Processor Intel Core 2 Duo 1.8GHz or faster processor (or equivalent)
Memory

Minimum: 1GB RAM
Recommended: 2GB RAM or more

When Phone Manager is running it will use a minimum of 70MB of RAM per
client. (Terminal environments) - this can be significantly more depending on
configuration and number of devices and/or users on the system.

Network IPv4, 100Mb / 1Gb LAN
Hard Disk Minimum: 20GB free space
Video

Minimum: DirectX v9 compatibly graphics cards with 120MB RAM
Recommended:DirectX v9 compatibly graphics cards with 1024MB RAM

Software Requirements

The following software is required to be installed.

Multi Users & Virtual Desktop System Requirements

Phone Manager can be run in multi user and virtual desktop environments such as Microsoft Terminal/Remote Desktop Services, Citrix XenApp or VMWare Virtual Desktop Infrastructure (VDI) with the following limitations:

When deploying in these environments, the amount of memory, CPU usage and Video resource that Phone Manager will use needs to be determined. As the resources required are dependent on configuration and the number of devices and Users in the system, you must exercise your own due diligence in reviewing, planning, implementing and testing a customer configuration.

There are options available on the Advanced tab in the Client Profiles section that can reduce the performance requirements for Phone Manager.

 

Network Configuration

The MCS requires a 100Mb/1Gb LAN connection that has access to the telephone system. Phone Manager clients will also need access to the MCS over the network. If the server is installed into a Microsoft Active Directory environment then it should be added to the domain, ideally before the MCS software is configured.

Custom Active Directory Group Policies can adversely affect the system and they should be tested before going live.

To enable users to easily access the server with the website role a valid DNS entry should be created that can then be used when browsing to the server, for example http://communicationserver.

The sections below provide information on all ports used by the system that may need to be opened on server or network based firewalls. Which ports will depend on the features and system configuration.

For information on configuring remote connections through an MBG, please refer to the Engineering Guidelines.

 

MiVoice Office Application - Host Server

Incoming Ports

The following ports need to be opened on the firewall of the server running the MiVoice Office Application Suite:

Application Description Source Port
Website access Browser access to the MiVO App Suite website for Configuration, Reporting, Recording Access etc. Browser Access HTTP 80, HTTPS 443
Phone Manager Desktop CTI Event Link Phone Manager Desktop TCP 2001
Client Sessions Phone Manager Desktop TCP 8187, 8186
Client Personal Wallboard Sessions Phone Manager Desktop TCP 8200, 8204
Broadcast location service Phone Manager Desktop UDP 8184
Phone Manager Mobile Client Sessions Phone Manager Mobile TCP 8185
Audio Phone Manager Mobile TCP 8190
SIP Audio MiVoice Office 250 UDP 20000-20500
SIP Proxy MiVoice Office 250 TCP 8196
MiVoice Office Call Recorder MiVoice Office 250 SIP (RAC Call Recording) MiVoice Office 250 UDP 5060
MiVoice Office 250 Audio (RAC Call Recording) MiVoice Office 250 UDP 12000-12100
Live Streaming Browser Access TCP 8201
Integration Services Call Recorder Client and Phone Manager Desktop TCP 8188
6900 Handset Service Server Connections & 6900 Handset Requests 6900 Series Handsets

HTTPS 8202, HTTP 8203

6900 Handset Multicast DNS 6900 Series Handsets UDP 5353
6900 Handset Requests 6900 Series Handsets TFTP 69
6900 Handset Directory Requests (LDAP) 6900 Series Handsets TCP 8205
6900 Syslog 6900 Series Handsets UDP 514
Windows Time Server Windows Time Server UDP 123

MiVoice Office Real-Time
Wallboard / Dashboard

Data Link from client browser or from Amazon Fire TV application. Browser Access and Amazon Fire TV

TCP 8200, 8204

       

Outgoing Ports

MiVoice Office Application Suite makes outgoing connections to the ports listed in the table below. The local port used by the server when making these request will be random.

Application Description Target Port
Licensing License update and activation requests to the licensing server. https://service.xarios.com HTTPS 443
Phone Manager Mobile SIP Audio MiVoice Office 250 UDP 20000-20500
Push Notification Service https://fcm.googleapis.com/fcm/send
sb://mcs-default.servicebus.windows.net
TCP 5228, 5229, 5230, HTTPS 443
CTI Link CTI Link to Phone System

MiVoice Office 250 / CT Gateway

TCP 4000
MiVoice Office Call Recorder MiVoice Office 250 SIP (RAC Call Recording) MiVoice Office 250 UDP 5060
MiVoice Office 250 Audio (RAC Call Recording) MiVoice Office 250 UDP 12000-12100
6900 Handset Service Outgoing post to handsets 6900 Series Handsets HTTP 80

 

Internal Use Ports

The following ports are used by internal services on the MiVoice Office Application. Traffic on these ports will not leave the server.

Port/Protocol
TCP 8183
TCP 8189
TCP 8191
TCP 8197
       
During the installation rules will be added to the in-built Windows Firewall for ports used by the MCS services. When using the Record-A-Call or SIP/RTP recording, the IP address of the PBX (Base server, PEC & PS1) may need to be added to the firewall allowed list to allow traffic into the MCS.

 

Phone Manager Desktop Client

The table below outlines the network connections made by Phone Manager Desktop clients.

Description Target/Source Port
CTI Link MiVO App Suite Server TCP 2001
Client Sessions MiVO App Suite Server TCP 8187*, 8186*
Client Personal Wallboard Sessions MiVO App Suite Server TCP 8200, 8204
Integration Services MiVO App Suite Server TCP 8188*
Broadcast location service MiVO App Suite Server UDP 8184*
SIP Audio (Only required if using the integrated softphone client) MiVoice Office 250 UDP 20000-20500
SIP Connection (Only required if using the integrated softphone client) MiVoice Office 250 TCP/UDP 5060
The SIP Audio/Connection ports are the default ports only and may have been updated on the MiVoice Office 250.
During Phone Manager Desktop client installation, rules for communication will automatically be added to the Windows Firewall on the client computer.
Ports marked with a * also apply to the Call Recorder Client.

 

Phone Manager Mobile Client

The table below outlines the network connections made by Phone Manager Mobile clients.

Description Target/Source Port
Client Sessions MiVO App Suite Server TCP 8185
Audio MiVO App Suite Server TCP 8190

 

6900 Handsets

The table below outlines the network connections made by 6900 handsets.

Description Target/Source Port
Configuration Server Link MiVO App Suite Server HTTPS 8202
HTTP 8203
TFTP MiVO App Suite Server TFTP 69
Multicast DNS MiVO App Suite Server UDP 5353
LDAP MiVO App Suite Server TCP 8205
Time Server Network or Internet Time Server UDP 123
Syslog MiVO App Suite Server UDP 514
SIP Audio MiVoice Office 250

UDP 6004-6603(HX)
UDP 6604-7039(PEC)

SIP Connection MiVoice Office 250 TCP/UDP 5060

   

 

Anti-Virus Recommendations

Anti-virus software can be installed onto the servers, but the following exclusions must be configured:

           

For servers with the call recording role:

 

If a support issue is raised then the removal of the anti virus may be required to aid in any diagnostics.

 Email Details

The system uses email as a key alert, notification and messaging system and needs to be configured correctly. There are five main areas where email is used:

  1. Internal Monitoring: There is an internal monitoring system that can report any potential problems or issues when they occur and the system can also send out emails to alert the administrator about these problems.
  2. New account details, password reminders for users.
  3. Phone Manager Mobile user invitations.
  4. For sending reports out from the scheduler
  5. For emailing call recordings
Configuring email is a mandatory requirement and without this the system will not generate alerts until this is made available.

See the Email & SMTP section for details.

 Users & Business Units

The system uses the concept of Users to control security and access to the system and to assign a Phone Manager license class in the user's profile.

Each user can have multiple agent IDs and/or extensions associated to it. When a call is handled by this agent/extension the "User" is tagged against this call.

Users can either be created manually, via Active Directory or automatically whenever a new agent ID/extension is created on the PBX. User creation choice needs to be determined before installation to ensure that all calls are tagged correctly.

See the Users and Business Units section for details.

 Telephone Number Prefixes

When a call is logged the outside number (caller ID or dialed number) and the inbound direct dial number will be logged against the call. The numbers that are logged may not contain all the digits expected or show extra digits that are not required.

See the Dial Plan section for more details.

 PBX Integration

The solution integrates with the MiVoice Office 250 PBX system either directly or through a CT Gateway. The solution monitors devices through the System OAI Protocol and logs all call information as well as acting as a proxy for any Phone Manager clients.

See the Phone Systems section for details.

 Backups

The system stores all of the information relating to the calls and the configuration of the system in a Microsoft SQL Server database installed on the server with the Database role. The system will back up the database every night to a user defined location. This needs to be set to a location that is NOT on the server itself.

If the database fails or becomes corrupted and this backup is available then the database can be easily restored. If the database backup is not available then the call information may be permanently lost.

See the Database Maintenance section for details.

If using the call recording features of the solution then recorded calls need archiving separately from the database. Please refer to the Call Archiving section for more information.