You are on page 1of 164

MiCollab

Installation and Maintenance Course


Software Release 6.0
Issue 1
MiCollab Installation and Maintenance

NOTICE

The information contained in this document is believed to be accurate in all respects but is not warranted
by Mitel Networks Corporation or any of its affiliates or subsidiaries (collectively “Mitel”). The information
is subject to change without notice and should not be construed in any way as a commitment by Mitel.
Mitel assumes no responsibility for any errors or omissions in this document. Revisions of this document
or new editions of it may be issued to incorporate changes. The document in its entirety or any part
thereof may not be reproduced or transmitted in any form by any means – electronic or mechanical – for
any purpose without the express written permission from Mitel Networks Corporation.

Trademarks
Mitel is a registered trademark of Mitel Networks Corporation.

Other product names mentioned in this document may be trademarks of their respective companies and
are hereby acknowledged

MiCollab
Release 6.0
July 2014

© 2014 Mitel Networks Corporation


Personal use of this material is permitted. However, permission to reprint/republish this material
for advertising or promotional purposes or for creating new collective works for resale or
redistribution to servers or lists, or to reuse any copy righted component of this work in other
works must be obtained from Mitel Networks Corporation
.
MiCollab Installation and Maintenance Course

Table of Contents

1. About this Course ................................................................................................. 1

2. System Overview............................................................................................... 2-1

3. Install MiCollab .................................................................................................. 3-1

4. System Configuration ........................................................................................ 4-1

5. Provision Users and Services ............................................................................ 5-1

6. MiCollab Client Integrated Mode ....................................................................... 6-1

7. System Maintenance ......................................................................................... 7-1

i
MiCollab Installation and Maintenance Course

Course Description, Certification, and Prerequisites

This MiCollab Installation and Maintenance course covers fundamental tasks involved in
installing, configuring, and troubleshooting a MiCollab platform.

This course qualifies new technicians as MiCollab System Installers with a MiCollab Release
6.0 Installation and Maintenance certification.

MiCollab Installation and Maintenance Certification


To become certified on MiCollab Installation and Maintenance, trainees must successfully
complete the following, in the order listed:

 Mitel Standard Linux Release 10.1 Installation and Maintenance Course Self-Study

 Mitel UCC v3 User Licensing Course Self-Study

 MiCollab Release 6.0 Installation and Maintenance Course Self-Study

1
MiCollab Installation and Maintenance Course

Information Icons

Information icons are used throughout the course to identify the following:

Reference: Directs you to additional reference information in the Technical


Documentation, Online Help, or other support documents

Note: Identifies a key point of interest. The note symbol may also direct you to
helpful information in the system documentation or other supporting
documentation.

Navigation: Identifies tips on how to navigate through the course material.

Remote Training: Identifies instructions that are specific to remote training


courses.

Tools and Equipment: Identifies tools and equipment you will need to
complete a lab exercise.

Caution: Identifies a potentially dangerous situation that may result in injury to


you or damage to the equipment.

2
MiCollab Installation and Maintenance Course

Product Documentation

You can view all the product documentation required to complete this course from the Mitel
E-docs web site at: http://edocs.mitel.com. (You will need a Mitel OnLine account to log in.)

3
MiCollab Installation and Maintenance Course

Getting Help

If you have trouble with any part of this course, please contact our Technical Training
Department.

In North America, call 1-800-722-1301. When the Automated Attendant answers, select menu
option 6 and then option 2. The first available operator will answer your call. Please be ready to
provide the following information:

 Your name

 Your telephone number

 The course name

 A description of the problem you’re having or the assistance you need.

You can also email technical_training@mitel.com

In Europe, Middle East, Asia (EMEA), call Mitel Training at +44 (0) 1291436539. After normal
working hours, your call is transferred to voice mail.

You can also email uktraining@mitel.com.

The Mitel Learning Management System


We recommend that you review the Student User Guide and Quick Reference Guides available
at the What’s New in Technical Training page of Mitel OnLine to learn about navigating the
training site and the Mitel Learning Management System:

4
MiCollab Installation and Maintenance Course

Technical Certification

To gain Mitel technical certification on this product, you must complete an online test. Your final
test score must be 80% or higher to attain certification.

When you have completed the required course modules, follow the onscreen instructions to
complete the test.

5
System Overview

Objectives
2
When you finish this module, you will be able to:
 Identify the features and applications provided by MiCollab
MiCollab Installation and Maintenance Course

About MiCollab

MiCollab combines a set of Unified Communications and Collaboration tools into a single
software package to deliver presence, collaboration, mobility, and messaging features to end
users.

MiCollab 6.0 supports any combination of the following applications on a single Industry
Standard Server or as a single virtual machine in a VMware vSphere or Microsoft Hyper-V
environment:

 MiCollab Client Release 6.0


 Audio, Web, and Video Conferencing Release 5.0
 NuPoint Unified Messaging (UM) Release 7.0 (includes Speech Auto Attendant)
 MiVoice Border Gateway Release 8.1 (includes Teleworker, SIP Trunk Proxy, and
Secure Recording Connector services)

Mitel Standard Linux 10.1 is the base operating system.

Call control and feature support is provided by MiVoice Business or MiVoice Office.

MiCollab Client

MiCollab Client delivers access to voice, presence,


video, messaging, call history, conferencing,
collaboration, contact management capabilities, and
mobility options in a single client interface.

 Single client interface for Audio and Video


Collaboration
 Call Control Support (MiVoice Business, MiVoice
Office)
 Dynamic Status, Presence, and Location
 Contact Management
 Knowledge Management
 Presence and Availability
 Corporate Secure IM
 Visual Voicemail

2- 2 02_SystemOverview.docx
System Overview

Audio, Web and Video Conferencing


MiCollab includes a simple, cost-effective, and scalable audio, web, and video conferencing
solution to allow users to schedule and create audio or web conferences.

Audio, video, and web collaboration

 Integration with MiCollab Client


 Multi-point, high-quality desktop video
 View available meeting timeslots
 Email notification template
 Lotus Notes and Outlook email integration
 Webinar / Lecture mode tools – Q&A, polling, file sharing

Ad Hoc / MeetMe and Reservation-based conferencing

 Active speaker indication


 International Dialing Plan support
 Integrated UI with MiCollab User Portal

2- 3
MiCollab Installation and Maintenance Course

NuPoint Unified Messaging (UM)


From basic voice mail to advanced unified messaging, Mitel NuPoint Unified Messaging™ (UM)
satisfies the diverse messaging needs of your entire user population.

Voice Mail and Unified Messaging features

 Scalable to 2500 mailboxes in single application deployment on physical server


 UM Integration supports SMTP forwarding to most email servers.
 Inbound / Outbound FAX
 Personal Call Director
 Record-a-Call
 Visual Voice Mail on Mitel 5300 Series IP Phones, UC Advanced, and MiCollab End User
Portal
 Context-sensitive displays and soft keys to phones with 6-line displays
 Message playback on mobile devices with callback sender
 Compatible with RIM BlackBerry® “Smart Dialing”

Speech Auto-Attendant
Speech Auto Attendant improves customer service levels and offloads the company receptionist
from answering routine calls.

 Routing by employee name, department name, or a telephone number


 Recorded names and TTS playback support
 Reduce the number of trunks required to support incoming calls
 Integrate with Active Directory and LDAP directories or NuPoint UM mailbox directory
 Integration with Mitel UC Server presence management, Microsoft OCS, and Lotus
Sametime®

MiVoice Border Gateway


MiVoice Border Gateway is a platform for the secure deployment of multiple network
connectivity services in a number of network edge scenarios.

Consolidated services

 Teleworker Service
 SIP Trunk Proxy Service
 Application Web Proxy Service
 Secure Recording Connector Service

2- 4 02_SystemOverview.docx
System Overview

Secure, trusted connectivity between LAN and public internet

 Manages IP network traversal, no separate VPN required


 Provides secure access to MiCollab client applications
 High grade security
 Authentication and Encryption of signalling and media
 Secure embedded 128-bit AES encrypted voice, SRTP

Reference
Consult the MiCollab General Information Guide for more information about
these MiCollab features.

2- 5
MiCollab Installation and Maintenance Course

MiCollab with Voice

MiCollab with Voice combines the call control capabilities of the MiVoice Business platform with
the versatility of MiCollab to provide integrated communications and collaboration for small to
medium businesses.

Comprehensive

 Voice
 Collaboration
 Conferencing
 Unified Messaging
 Mobility
 VMware High Availability for business continuity

Simple

 Delivered as a single virtual appliance


 Simplified installation and initial configuration
 Support for up to 500 users

Reference
MiCollab with Voice training and certification is provided separately. Register
for the MiCollab with Voice Configuration and Maintenance course to learn
more.

2- 6 02_SystemOverview.docx
System Overview

Administrator Portal

The MiCollab Administrator Portal provides you with single point access to configure and
manage multiple applications and users on the MiCollab platform.
Access the Administrator Portal login page, by entering the server IP address or fully qualified
domain name; for example, https://apps.example.com/server-manager.
The password credentials entered here are those configured during installation of Mitel
Standard Linux. The username is admin.

By default, access to the Administrator Portal is restricted to authorized users on the local
network only. Allowing access to remote hosts requires additional MSL configuration steps.

Reference
Server Manager Help: Consult Remote Access in the Security chapter for
configuration procedures.

2- 7
MiCollab Installation and Maintenance Course

Navigation Panel
In addition to options available with other MSL-based installations, the Applications category in
the navigation panel of the Administrator Portal provides links to the following MiCollab features:

Users and Services - allows you to manage user data and assign or remove user services.

Licensing Information - displays details about user licensing for installed applications.

The User Licenses column indicates the maximum number of users that can be assigned a
particular service before an over-provisioning warning is shown.
The Currently used column indicates the total number of assigned licenses for a particular
service. When a total is over the licensed limit, the value appears in red.

2- 8 02_SystemOverview.docx
System Overview

Use the other links under the Applications heading to define features for each installed
application. Refer to the specific application Installation and Maintenance course for
programming and configuration lessons.

The Configuration category in the navigation panel of the Administrator Portal provides links to
the following MiCollab features:

MiCollab Settings - allows you to collect application and server logs in a file, change the
strength of the password for the user web portal, and configure a Welcome e-mail to inform
users of their MiCollab account information.

MiCollab Language - allows you to set the end-user interface language for the user web portal
and the Telephone User Interface (TUI).

2- 9
MiCollab Installation and Maintenance Course

Users and Services

MiCollab consolidates the system administration functions of each individual application into a
single management console, making ongoing administration (moves, adds and changes) quick
and easy.
The Users and Services application allows you to add users, associate application services to
each user and to enter configuration settings for all of the applications from a single web-based
management interface.
Common data elements are shared by the applications, reducing the need for duplicate entry
and the possibility for error. User templates are available, making the task of adding new users
even simpler.

Users
The Users tab in the Users and Services application, displays a directory of user names, office
numbers, and the application services that are assigned to each user.

2- 10 02_SystemOverview.docx
System Overview

The initial view of the directory is blank. To display a list of all users, click Show all. To search
for an individual user, enter a name or directory number in the Search field and click Search.

The Add, Quick Add, and Import controls allow you to populate the directory with users and their
assigned services.
Users and Services allows you to assign an unlimited number of services to users, with useable
services being determined by the actual number of user licenses.
In the case where a system has been “over-provisioned”, a warning is displayed on the Users
and Services page directing you to the Licensing Information page.

The Edit and Delete controls allow you to modify the configuration of users on the system. To
enable these controls, select the checkbox next to a user.
You can select the checkbox next to an individual user to edit settings for that user. You can
select multiple users if you want to perform a Delete action.

The use of the Send Service Info E-mail control is discussed in Module 5.

Network Element
The Network Element tab provides the controls to help you create and manage network element
data (MiVoice Business platform only).

To ensure that MiCollab has consistent network element information, always use this tab to add
or change network element information.
If network element information is modified in the individual applications, it can cause incorrect
data to be presented to the MiCollab system.
MiCollab can interface with multiple MiVoice Business platforms simultaneously.
The Users and Services application allows you to manage multiple users on different MiVoice
Business platforms. From the Network Element management tab, you can add host information
and MiVoice Business application data to the system.

MiCollab also supports IP device resiliency in clustered environments. This support does NOT
extend to Audio, Web and Video Conferencing.

2- 11
MiCollab Installation and Maintenance Course

Customer sites that need to deploy resiliency require OPS Manager Release 7.6 to maintain the
cluster and resiliency.
Single Point Provisioning provides you with the option to automatically update resources on
the MiVoice and MiCollab platforms when you add, modify or delete information for an individual
user in the Users and Services panel.
Users and Services writes configuration data to MiVoice Business first and then to each of the
MiCollab application databases.
The option is enabled/disabled by toggling the “Single Point Provisioning Enabled” check box
located under the Element Identification heading on the Create Network Element tab.

Information is added to a number of MiVoice Business programming forms:

 User and Services Configuration,


 Telephone Directory,
 Station Attributes,
 Multiline Set Keys,
 User Call Forwarding.

A User Authorization Profile must be added to MiVoice Business manually, if one is required.

Single Point Provisioning is not available for the Mitel Office platform. You must manually
provision users and their phones (endpoints) before or after you add the items in the Users and
Services application.

User Templates
The User Templates tab provides the controls that allow you to define user templates with pre-
configured information to quickly add new users to the system directory.

2- 12 02_SystemOverview.docx
System Overview

Depending on the licensing the customer has selected, various default User Templates are
created. (Templates are discussed in detail in Module 5.)

Locations
The Locations tab provides the controls to allow you to create and manage locations within the
system directory.

When you add an individual user to the system, you may choose to assign a location to that
user for identification purposes.

Departments
The Departments tab provides the controls to allow you to create and manage departments
within the system directory.

When you add an individual user to the system, you may select to assign one of the
departments contained within the directory to the user for identification purposes.

2- 13
MiCollab Installation and Maintenance Course

MiCollab Settings

Password Strength
Select the Password Strength tab to define the password strength rules that apply when a user
logs in to the end user portal for the first time.

Collect Logs
Select the Collect Logs tab to gather diagnostic logs and information for installed applications.

2- 14 02_SystemOverview.docx
System Overview

Welcome Email
Select the Welcome E-mail tab to define the contents of the introductory email that is sent to
system subscribers to inform them of their account settings.

2- 15
MiCollab Installation and Maintenance Course

MiCollab Language

MiCollab supports seven languages: US English, UK English, Canadian French, European


French, German, Dutch, and Latin American Spanish.
The default language for all users on a newly installed MiCollab 6.0 system is English (United
States).

All supported languages are available following installation and are listed in the Language pull
down menu on the MiCollab Language settings form. This system-wide setting allows you to
specify the language for end user interfaces (TUI and MiCollab End User Portal). All
administrator interfaces are available in English only.

To configure NuPoint UM for Bilingual Service, you specify the Secondary NuPoint Prompt
Language for the system.
When calling in to the system, callers are asked to select a preferred language. Once a
selection is made, all system prompts are played in the chosen language for the duration of the
call.
When English (United States) is selected as the system default language setting, you can
choose between numeric (“press 7 to play”) or mnemonic (“press P to play”) prompts for
NuPoint UM voice mail.

The numeric prompt set is the default value. Check Use NuPoint UM Mnemonic English Prompt
to enable mnemonic prompts.

When you change the System Language, the application end user interface switches to the
selected language. Activation of NuPoint UM is required when this setting is changed.

The Speech Auto Attendant feature of NuPoint UM provides speech in US and UK English only.
When you select any other System Language, a warning appears to remind you of this. The end
user speech interface for SAA remains in English.

2- 16 02_SystemOverview.docx
System Overview

NuPoint Unified Messaging


The prompt language for call flows in Call Director is determined by the system default language
setting. However, users can set the prompt language for a call flow independently of the
MiCollab language setting through the Action menu in the Call Director application.
The Line Group language setting and LCOS language setting use the system default language.
In the interface, the Line Group language setting is set to "undefined" and the LCOS language
setting is set to "default".
Speech Auto Attendant TUI prompts are available in US and UK English only.

Audio, Web and Video Conferencing


The language for Telephone User Interface (TUI) prompts for all users is determined by the
system default language.
The Prompt Language setting in USP and MiCollab End User Portal does not apply to Audio,
Web and Video Conferencing.

2- 17
MiCollab Installation and Maintenance Course

Google Integration

When MiCollab applications require access to user-generated data that is stored in Google
Gmail or Google Calendar, they must meet Google's authorization requirements. The Google
Apps panel in the MiCollab administrator portal can automatically generate these requirements.

OAuth is an open authentication protocol that allows users to share specific data with Mitel
applications while keeping their credentials and other information private. This is typically done
by creating a Client ID and Secret on the Google side. Once MiCollab is aware of these
credentials, it can generate an authorization code and subsequent access token.

Reference
Configuration of Google Apps is discussed in the Mitel Standard Linux
Installation and Maintenance training course.

2- 18 02_SystemOverview.docx
System Overview

MiCollab End User Portal

The MiCollab Client enables a user to change their dynamic status, access visual voice mail
and see the availability and presence of other users before choosing how to best communicate
with that user.
Users who are not licensed for MiCollab Client can access their business communication profile
settings, manage their telephone pass codes, access their voice mail, set their greetings, and
update their Audio, Web and Video Conferencing settings from the MiCollab End User Portal.

Upon completion of this section you will be able to explain the following key points to end users:

 How to access the MiCollab End User Portal


 How to change access passwords
 How to modify application settings

Access MiCollab End User Portal


To access the login page for MiCollab End User Portal, enter the MiCollab server FQDN or IP
address in the browser address bar.
By default the Login ID is the user’s last name followed by the first initial of the first name. You
need to provide the user with the password that you entered in Users and Services.

1. Enter the Login ID and Password. 2. Click Login.

2- 19
MiCollab Installation and Maintenance Course

The login page includes a link to the Audio, Web and Video Conferencing Public Portal, if it is
properly licensed and installed. This link provides access to public conferences.

When accessing MiCollab End User Portal, the end user can select a Preferred Language on
the login page. Once a selection is made, the page refreshes and the login page is presented in
the selected language.

After the initial login, users are prompted to change their password. Users are prompted to
follow the password strength rules defined on the MiCollab Settings page when entering a new
password.

2- 20 02_SystemOverview.docx
System Overview

1. Enter the old password on the Change Password form.

2. Enter a new password and confirm.

3. Click Submit.

Modify Settings
The Settings page allows users to modify their own configuration settings. Settings that you
configured using the Configuration Wizard or Users and Services are displayed.

Users can change their Email Address, specify a preferred prompt language and default launch
page, and enter numbers for Home and Mobile phone categories, if applicable.

Users can enter descriptions but cannot change the numbers assigned to communications
platform devices (MiVoice Business/MiVoice Office)

2- 21
MiCollab Installation and Maintenance Course

Change Password
The Change Password form allows users to reset the password used to access MiCollab End
User Portal. The new password must adhere to the rules defined by the password strength
rules.

Change Passcode
The Change Passcode form allows the user to reset the passcode used to access applications
from the telephone. The new passcode must adhere to the rules listed on this page.

Search Directory
Users can search for any other user configured on the server using the Search Directory
feature.

2- 22 02_SystemOverview.docx
System Overview

Enter the first name, last name, or extension number on the Search Directory form and click
Search.

Select a link in the Search Results section to view the user’s details.

2- 23
MiCollab Installation and Maintenance Course

NuPoint Unified Messaging


Users can manage settings and options of the NuPoint Unified Messaging service.

Messages: view and listen to NuPoint UM messages.

Settings: change personal settings

 The UM Audio Encoding drop-down list contains ADPCM, GSM 6.10, and MP3 as audio
encoding options for Unified Messaging audio files.
 The UM WebView Email Address field is populated with the Primary Email Address
configured on the Users tab of the Users and Services application.
 The user can enter the Call Me Phone Number that the system will call to allow private
message playback and prompt recording.
 The user can enter the telephone number or extension of the attendant for their mailbox
in the Personal Attendant Number field.

Distribution Lists: create and manage personal distribution lists used for messaging.

Greetings: record and manage mailbox greetings.

Call Director: create or modify call flows to control how incoming calls are handled.

2- 24 02_SystemOverview.docx
System Overview

Audio, Web and Video Conferencing


A user can manage settings and options of the Audio, Web and Video Conferencing service.

Home: access links to Published Conferences, Published Documents, and Published


Recordings and to quickly create an instant conference.

Set Up a Conference: create these conference types:

 One-time – occurs once on the date and time specified.


 Recurring – occurs on the date and time specified and repeats according the
Recurrence schedule (Daily, Weekly, Monthly).
 Reservationless – occurs for the span of dates specified.

My Conferences: manage current and expired conferences.

Recordings: manage recordings associated with audio and web conferences.

Settings: modify account settings including password and phone number, the format for e-mail
invitations, and delegates.

Reports: generate reports showing details of a conference.

2- 25
Install MiCollab

Objectives
3
When you finish this module, you will be able to:
 Explain available deployment options and requirements
 Install MiCollab on Industry Standard Server hardware
 Deploy MiCollab Server Appliance
 Deploy MiCollab Virtual Appliance
MiCollab Installation and Maintenance Course

Installation Requirements

Host Platform
MiCollab 6.0 software is supported on the following platforms:

Industry Standard Server


This option allows a customer to purchase their own MSL qualified server. Refer to the MSL
Qualified Hardware List for a list of supported server platforms.

MiCollab Server Appliance (North America and United Kingdom only)


The MiCollab Server Appliance consists of a Dell™ PowerEdge™ R210 Rack Server with pre-
installed MSL and MiCollab base software. Versions are available for deployment with Mitel
Communications Director and Mitel MiVoice Office.
After installing the hardware and configuring server settings to site-specific values, the MiCollab
Server Appliance is ready for use. DVDs containing the original operating system and
application software are shipped with the appliance.

VMware® ESXi™ Hypervisor


MiCollab runs as a virtual machine within a VMware vSphere virtual infrastructure. All required
the MiCollab virtual appliance software and tools are pre-packaged in a virtual appliance.

Microsoft® Hyper-V®
This option involves creating a Hyper-V Virtual Machine (VM) with the correct resource
allocation followed by installation of Mitel Standard Linux and MiCollab applications similar to an
Industry Standard Server.

Communications Platform
Call control and feature support is provided by the following communications platforms:

 MiVoice Business Release 5.0, 6.0, 7.0 (recommended) with latest Service Packs (3300
MXe, MiVoice Business-ISS, Virtual MiVoice Business)
 MiVoice Office Release 5.0, 5.1, and 6.0 with latest Service Packs

Software
Application software is available from Mitel Online as individual ISO images.

For installation on Industry Standard Servers and Microsoft Hyper-V, you install Mitel Standard
Linux software followed by the MiCollab software.
In the case of the MiCollab Server Appliance, Mitel Standard Linux and MiCollab software are
pre-installed.
For a VMware environment, the MiCollab virtual appliance is delivered as an .ova template file
that is deployed with the vSphere Client application.

3- 2 03_InstallMiCollab.docx
Install MiCollab

Note
Speech Auto Attendant (SAA) and Text-to-Speech (TTS) software is delivered
separately from the NuPoint UM base software.
The MiCollab 6.0 virtual appliance does NOT include SAA or TTS software
either. If required, these options need to be installed following deployment of
the virtual appliance.

Licensing

Part Numbers
MiCollab is licensed as a base software package with application connection and enablement
licenses for MiCollab Client, Audio, Web and Video Conferencing, NuPoint Unified Messaging,
Speech Auto Attendant, and MiVoice Border Gateway – the selection of available applications
(single or multiple) is made during software installation. The base software package does not
provide user licenses.
Depending on your site requirement, you need to register the appropriate part number and
apply the necessary user licenses to the customer Application Record ID.

Part Number Description Note

Base software for MiCollab Client, MiCollab


Audio, Web and Video Conferencing, NuPoint
Unified Messaging (includes Speech Auto-
MiCollab 6.0 Base Software Attendant), and MiVoice Border Gateway.
54005441
No user licenses are included 6 Application Connection licenses (for MiVoice
Business connectivity)
6 SIP peering licenses (for MiVoice Office
connectivity)

Base software for MiCollab Client, MiCollab


Audio, Web and Video Conferencing, NuPoint
MiCollab 6.0 Base Virtual
Unified Messaging (includes Speech Auto-
54005442 Appliance
Attendant), and MiVoice Border Gateway.
No user licenses are included
6 Application Connection licenses (for MiVoice
Business connectivity)

MiCollab Add-on to MiCollab Apply to existing MiCollab Client installation to


54005444
Client add MiCollab 6.0 base applications.

Apply to existing the MiCollab virtual appliance


Virtual Base Add-on to the
54005445 Client installation to add MiCollab 6.0 base
MiCollab virtual appliance Client
applications.

3- 3
MiCollab Installation and Maintenance Course

MUST be applied to upgrade from MiCollab


MiCollab 2.x to MiCollab 3.0/4.0 2.x to MiCollab 3.0/4.0.
54005447
Base Upgrade
Adds MiCollab Client with no user licenses.

the MiCollab virtual appliance MUST be applied to upgrade from the


2.X to the MiCollab virtual MiCollab virtual appliance 2.x to the MiCollab
54005449
appliance 3.0/4.0 Base virtual appliance 3.0/4.0. Adds MiCollab Client
Upgrade with no user licenses.

MiCollab Server Appliance for Content as per 54005441 less 6 SIP peering
52002722
MiVoice Business (NA) licenses

MiCollab Server Appliance for Content as per 54005441 less 6 Application


52002723
MiVoice Office (NA) Connection licenses

MiCollab Server Appliance for Content as per 54005441 less 6 SIP peering
52002726
MiVoice Business (UK) licenses

MiCollab Server Appliance for Content as per 54005441 less 6 Application


52002727
MiVoice Office (UK) Connection licenses

Caution
MiCollab requires an online connection to the AMC in order to obtain licensing
information.
Although Mitel Standard Linux supports Offline Synchronization, do NOT use
this registration method for MiCollab. The system MUST be online when you
register the MiCollab Application Record with the AMC.

The MiCollab base software package can be used with either MiVoice Business or MiVoice
Office Communications Platform – the type of communications platform is chosen during
installation.

UCC License Bundles (Business or Enterprise)


Although not mandatory for MiCollab systems, Unified Communications and Collaboration
(UCC) License Bundles simplify the licensing process by gathering MiVoice Business platform
and MiCollab application user licenses under a single part number.
UCC License Bundles are available to satisfy the needs of customers with a Business-level or
Enterprise-class MiVoice Business platform.

Each UCC license bundle includes a different selection of user licenses:

3- 4 03_InstallMiCollab.docx
Install MiCollab

Default User Templates, User Roles and corresponding MiCollab Client feature profiles are
created from the following licensing bundle definitions:

 UCC (V3.0) Basic – adds cost-free desktop and web client with Chat feature to MiCollab
Client Default Feature Profile.
 UCC (V3.0) Entry – adds Presence feature to corresponding MiCollab Client UCC Feature
Profile.
 UCC (V3.0) Standard – supports 8 devices for single number reach.
 UCC (V3.0) Premium – includes two Teleworker licenses.

Note: The UCC v3 Licensing Self-Study course provides detailed information


and case studies on UCC v3 license bundles and is required prerequisite
training for this MiCollab 6.0 course.

3- 5
MiCollab Installation and Maintenance Course

Deployment Options

LAN Deployment
Host platform deployed on LAN with ICP/CP, behind Firewall or Router.

 Not generally accessible from the Internet with some allowance for outgoing connections
(e.g. DNS resolution).
 Host platform requires single Ethernet interface only. A non-routable IP address is assigned
to this interface.
 Option is available to deploy on LAN with separate MiVoice Border Gateway server in DMZ
or on Network Edge.
 MiVoice Border Gateway Teleworker service is not supported in this configuration.
 MiCollab Audio, Web and Video Conferencing web collaboration and MiCollab Client clients
require port forwarding settings to be configured on Firewall to allow communication
between the server and the AMC, the ICP, IP phones, and in some cases, the Internet.

Reference
Refer to MiCollab in LAN Mode Firewall Settings in the MiCollab
Engineering Guidelines for appropriate firewall rules for your customer
installation.

3- 6 03_InstallMiCollab.docx
Install MiCollab

LAN Deployment + MiVoice Border Gateway Web Proxy (DMZ)


This option provides a secure method for remote web clients (such as MiCollab Client) to
connect to MiCollab server located on the corporate LAN.

 Internal DNS must be programmed to resolve requests for MiCollab1.mitel.com to the IP


address of the MiCollab server on the LAN.
 External DNS must be programmed to resolve requests for MiCollab1.mitel.com to the IP
address of the corporate firewall.
 Firewall must be programmed to route web browser requests to HTTPS port programmed
on Web Proxy.

Note
For further details about installation and configuration of Mitel Web Proxy,
refer to your MiVoice Border Gateway 8.1 Remote Proxy Services Installation
and Maintenance course.

3- 7
MiCollab Installation and Maintenance Course

LAN Deployment + MiVoice Border Gateway Teleworker (DMZ)


Remote Teleworker users connect to the MiCollab server through MiVoice Border Gateway
server located in the DMZ.

 MiCollab Server is clustered with the MiVoice Border Gateway server (slave) allowing you to
manage Teleworker services from server manager.
 Both MiCollab server and MiVoice Border Gateway server require Teleworker blade to be
installed.
 Web Proxy service may also be installed in this configuration.

3- 8 03_InstallMiCollab.docx
Install MiCollab

LAN Deployment + MiVoice Border Gateway Web Proxy (Network


Edge)
Industry Standard Server or MiCollab Server Appliance deployed on LAN with separate MiVoice
Border Gateway server (with Web Proxy service) on Network Edge.

Note
Network Edge deployments carry incremental network security risk. Security
best practices suggest that highly secure deployments of applications
designed to operate within the enterprise LAN should be installed behind a
corporate firewall. Please ensure that your planned MiCollab deployment is in
accordance with your customer’s corporate security policies and practices.

3- 9
MiCollab Installation and Maintenance Course

Network Edge Deployment


Host platform deployed on customer’s network edge alongside firewall/broadband router.

 Network Edge deployment requires two Ethernet adaptors:


 One adapter is configured as "Local" for connection to the local network,
 Other adapter is configured as "WAN" for connection to the Internet.
 WAN network adapter has a publicly-routable IP address; accessible to both the Internet
and the internal network.

 Host platform external address must be publicly routable and accessible to both the Internet
and private network.
 Host Platform must NOT reside behind a Network Address Translation (NAT) device.
 Preferred deployment is MiCollab server used in conjunction with the corporate firewall.
MiCollab server is configured as parallel firewall protecting telephony applications.
 Some MiCollab Client and MiCollab Audio, Web and Video Conferencing data must be
routed through Firewall or Router. MiCollab Audio, Web and Video Conferencing web
collaboration client requires a second IP address assigned and configured.

3- 10 03_InstallMiCollab.docx
Install MiCollab

vSphere Deployment
Virtual MiCollab deployed on LAN in Standalone vSphere environment (ESXi Host).

 Firewall configuration and port forwarding must be configured to allow internet access to the
Application Management Center (AMC).
 This configuration does not support MiVoice Border Gateway Teleworker service in MiCollab
with teleworker phones configured in MiCollab.

3- 11
MiCollab Installation and Maintenance Course

vSphere Deployment + MiVoice Border Gateway (Teleworker and


Web Proxy)
Virtual MiCollab deployed on LAN in vSphere environment along with MiVoice Border Gateway
(MiVoice Border Gateway) server in DMZ configuration – with Teleworker and Web Proxy
services.

 Teleworker service is installed on both Virtual MiCollab and MiVoice Border Gateway server.
 Teleworker service installed on Virtual MiCollab is only used to remotely manage the
Teleworker phones configured on the MiVoice Border Gateway server.
 Teleworker service installed on the MiVoice Border Gateway (MiVoice Border Gateway)
server in the DMZ supports remote teleworker sets.

 The Web Proxy service is installed on MiVoice Border Gateway server.

3- 12 03_InstallMiCollab.docx
Install MiCollab

MiCollab Server Installation

A number of requirements must be satisfied before you proceed with the installation:

1. Obtain an Application Record ID from the AMC


 Access the Applications Management Center to register a license for one of the base
software packages and assign to an Application Record.
 A number of uplift and upgrade bundles are also available. Consult the Engineering
Guidelines for additional detail.

2. Acquire a certified host platform and the required software ISO images
 Supported hardware platforms are specified in the Mitel Standard Linux Qualified
Hardware List available on MOL.
 ISO images of Mitel Standard Linux and MiCollab software are available for download
from the Support link at Mitel Online.

3. Acquire a communications platform with the required SW and options installed


 MiCollab supports MiVoice Business or MiVoice Office.
 The base package contains the necessary application interconnect licenses. Uplifts are
available if you have a requirement for additional users.

4. Determined into which supported network topology you will deploy the host platform
 It will be of some benefit to you to make this decision prior to installation. It will help you
complete your site survey.

5. Complete a survey of the customer site to gather network addresses, etc.


 To assist with this task, Chapter 4 of the MiCollab Installation and Maintenance Guide
includes a section entitled "Collect Site Information“.

6. Compile a list of system users and application requirements


 If you complete this step in advance of installation, you will be better prepared if you
intend to deploy MiCollab using the Mitel Integrated Configuration Wizard. To assist with
this task, Chapter 6 of the MiCollab Installation and Maintenance Guide includes a
section entitled "Collect Site Configuration Information“

3- 13
MiCollab Installation and Maintenance Course

Installation Software
All application software is available for download from Mitel Online as individual ISO images.

Mitel Standard Linux 10.1

 Mitel Standard Linux 10.1.x.0

MiCollab 6.0 ISO images

 SAS 6.0.x.0
 MiVoice Border Gateway 8.1.x.0
 MiCollab Client 6.0.3xx.0
 MiCollab Audio, Web and Video Conferencing 5.0.3.x
 NPM 17.0.0.x Disk 1
 NPM 17.0.0.x Disk 2 (SAA and TTS)

For Industry Standard Servers, you install the Mitel Standard Linux software followed by the
MiCollab software. In the case of the MiCollab Server Appliance, Mitel Standard Linux and
MiCollab software are pre-installed.

Downloading Installation Software


As you learned in your Mitel Standard Linux prerequisite training course, software downloads
are available from Mitel Online using a Download Manager.

3- 14 03_InstallMiCollab.docx
Install MiCollab

Creating MiCollab Installation Media


In addition to CD/DVD installation media, MiCollab 6.0 supports a USB flash drive as a storage
device for installation files:

Copy all application ISO images to a single USB flash drive.


This is a straightforward copy operation!! It is not necessary to extract files from the ISO image.

Plug the storage device into the USB port on the MiCollab server when prompted during the
installation.

MiCollab 6.0 automatically scans for a USB flash drive during software installation and checks
for all licensed application files.

Software installation proceeds using the ISO images found on the USB flash drive.
If the USB flash drive does not contain a required ISO image, you will need to insert the
required CD/DVD during installation.

Caution
When installing application software from a USB flash drive, do not connect
the USB flash drive to the MiCollab server until after MSL is installed
completely (including reboot).

If using CD/DVDs to install MiCollab software, you copy the full suite of MiCollab application
software to the server cache. This adds approximately 20 minutes to the installation process.

3- 15
MiCollab Installation and Maintenance Course

Summary - New Installation (Industry Standard Server)


Complete the following tasks to install MiCollab 6.0 software on a supported Industry Standard
Server:

Step Task

1 Gather configuration details from customer site and install server hardware.
2 Purchase and apply required MiCollab licenses to the customer Application Record
ID.
3 Download MSL 10.1 and MiCollab 6.0 application software from Mitel Online and
create installation media.
4 Install and configure MSL Release 10.1.
5 Install MiCollab 6.0 application software:
 Apply Application Record ID at the end of the MSL configuration
 Select the MiCollab software version to install (a list is obtained from the AMC).
 Load the application software.
 Follow the onscreen instructions to complete the installation.
 Reboot the server to finalize the installation of MiCollab 6.0 application software.
6 Configure server and MiCollab application settings

Note
Steps 3 through 5 are specific to Industry Standard Server installations. These
tasks are completed at the factory for MiCollab Server Appliance systems
leaving you only site-specific configuration tasks to complete.

Caution
During configuration of Mitel Standard Linux, do not enable IPv6 protocol
support. IPv6 addressing is not currently supported by MiCollab.

3- 16 03_InstallMiCollab.docx
Install MiCollab

1. Following installation and configuration of Mitel Standard Linux, enter the system Application
Record ID to complete the licensing registration process.

A check is performed with the AMC to determine the MiCollab versions that you can install.

3- 17
MiCollab Installation and Maintenance Course

2. Choose the version you would like to install.

3. Confirm that the application lineup displayed matches the licenses available in the
Application Record ID.

3- 18 03_InstallMiCollab.docx
Install MiCollab

4. Select the type of Communications Platform available at the customer site.

5. Another check is performed with the AMC to determine the applications you can install. Use
the space bar to select required applications.

3- 19
MiCollab Installation and Maintenance Course

6. Select Yes if you are installing from a USB flash drive. Otherwise select No and continue the
installation from CD/DVD media.

Note
This installation example illustrates an installation using a USB flash drive.
CD/DVD installation procedures can be found in the MiCollab Installation and
Maintenance Guide.

7. Insert the USB storage device and select Scan Devices.

The installation program scans for the USB storage device.


3- 20 03_InstallMiCollab.docx
Install MiCollab

8. The installation program informs you of available USB devices. Select Continue.

3- 21
MiCollab Installation and Maintenance Course

The installation program checks the USB storage device for available software.

9. Software available for installation is displayed. Select Continue to begin installation.

3- 22 03_InstallMiCollab.docx
Install MiCollab

The installation program verifies the integrity of all software packages.

Installation continues automatically until complete.

Caution
Do not remove the USB device until prompted. Each application is installed
directly from the USB device. If the device is accidentally removed before
installation is complete, you must restart the installation from the beginning.

3- 23
MiCollab Installation and Maintenance Course

The software installation is complete when you see a message that indicates “Successfully
completed application installation”.

10. Remove the USB storage device when prompted.

3- 24 03_InstallMiCollab.docx
Install MiCollab

11. To finalize software installation, you must reboot this server.

3- 25
MiCollab Installation and Maintenance Course

Deploy MiCollab Virtual Appliance

Overview
The MiCollab virtual appliance (.ova) contains Mitel Standard Linux 10.1, NuPoint Unified
Messaging 7.0, MiCollab Client 6.0 SP3, Audio, Video and Web Conferencing 5.0 SP3, and
MiVoice Border Gateway 8.1, as well as the Operating System Specific Package (OSP) of
VMware Tools.
The MiCollab virtual appliance is deployed into the vSphere environment using the vSphere
Client application. At the time of deployment, a Virtual Machine is created to host the MiCollab
virtual appliance. The virtual appliance sets the configuration for the Virtual Machine.

Following deployment, the MiCollab virtual appliance is displayed in the Inventory panel of the
vSphere Client in a powered-off state. When powered on, you step through the Mitel Standard
Linux console screens to configure the system for the customer environment.

Following activation of MSL, you enter the Application Record ID and system licensing is
downloaded from the Applications Management Center (AMC), similar to an install of MiCollab
on an Industry Standard Server.
You then proceed with database configuration using the Mitel Integrated Configuration Wizard
and Users and Services Provisioning application.

Requirements
Minimum hardware resources are required for a successful deployment of the MiCollab virtual
appliance in virtualized data center environment:

Reference
Consult the Virtual Appliance Deployment Solutions Guide for the virtual
environment requirements.

Minimum software release is required for a successful deployment of the MiCollab virtual
appliance in virtualized data center environment:
VMware vSphere Release 5.5 recommended. Release 5.0 supported.
vCenter is optional and not absolutely required to install and manage the MiCollab virtual
appliance.

Latest the MiCollab virtual appliance virtual appliance (.ova) from Mitel Online. The MiCollab
virtual appliance is ONLY supported if you install from the .ova file. You can NOT install the
MSL and MiCollab software into a VMware virtual appliance and then use a MiCollab virtual
appliance Application Record ID to activate the software.

3- 26 03_InstallMiCollab.docx
Install MiCollab

Internet access to allow licensing from the Applications Management Center (AMC).

A DNS server that is reachable from the platform.

Limitations
The MiCollab virtual appliance must be installed in the vSphere environment using Thick
provisioning. Thin provisioning can cause voice quality issues due to disk sharing.

The MiCollab virtual appliance requires a specific license to operate in a virtual environment.
You must purchase this license and apply it to the Application Record ID or deployment will fail.

VMware vMotion provides live migration of virtual machines from one physical host to another
with zero downtime. While vMotion migration is in progress, the MiCollab virtual appliance users
may experience voice quality degradation.

When you deploy the MiCollab 6.0 virtual appliance, you select a deployment configuration. The
user limits, resource requirements, and system capacities depend on the selected deployment.

Disclaimer
Mitel does NOT provide technical training or certification for VMware® products. Mitel
recommends that authorizedPARTNERs acquire VMware Sales Professional (VSP), VMware
Technical Sales Professional (VTSP), and/or VMware Certified Professional (VCP) training and
certification.

Mitel does not provide support for VMware vSphere, vCenter, or other VMware management
tools, however, Mitel does provide support to assist in the triage of cross-solution issues
involving Mitel and VMware products.

® VMware, vSphere, and vCenter are registered trademarks of VMware Inc.

3- 27
MiCollab Installation and Maintenance Course

Summary - New Deployment of Virtual Appliance


Complete the following tasks to deploy MiCollab 6.0 as a virtual appliance within a VMware
vSphere environment:

Step Task

1 Gather configuration details from customer site.


2 Purchase and apply required the MiCollab virtual appliance software license to the
customer Application Record ID.
3 Download MiCollab 6.0 virtual appliance (.ova) file from Mitel Online.
 If NuPoint Unified Messaging software options are required, download the NP-
UM .iso file from Mitel Online and save to storage media.
4 Deploy MiCollab 6.0 virtual appliance:
 Launch vSphere Client and start the OVF Template Deployment Wizard
 Power on the virtual machine and configure MSL Release 10.1
 Apply Application Record ID and reboot
 Install MiCollab software options, if required
5 Reboot the virtual machine to finalize the deployment of MiCollab 6.0 virtual
appliance and optional software.
6 Configure MiCollab application settings.

1. Start the OVF Template Deployment Wizard (File > Deploy OVF Template…)

2. Specify the source location for the MiCollab virtual appliance.

3- 28 03_InstallMiCollab.docx
Install MiCollab

3. OVF Template Details dialog provides information about the contents of template. Click
Next.

3- 29
MiCollab Installation and Maintenance Course

4. Accept the End User License Agreement in order to proceed. Click Next.

5. Enter a name for the virtual machine and click Next.

3- 30 03_InstallMiCollab.docx
Install MiCollab

6. Select the required deployment configuration and click Next.

7. Select the Thick provisioned Lazy Zeroed format option and click Next.

3- 31
MiCollab Installation and Maintenance Course

8. Specify the desired network mapping options and click Next.

9. Verify the deployment options and click Finish to start the deployment.

3- 32 03_InstallMiCollab.docx
Install MiCollab

10. Monitor the progress of the deployment.

11. Close the Deployment Completed Successfully dialog when deployment is complete.

3- 33
MiCollab Installation and Maintenance Course

MiCollab virtual appliance is displayed in the Inventory panel of the vSphere Client in a
powered-off state.

Step Task

1 Right-click the entry for the new virtual machine and select Open Console.
2 Power on the virtual machine. The Mitel Standard Linux boot screen appears.
3 Configure Mitel Standard Linux:
 Enter and confirm a password for the Administrator account.
 Enter and activate host settings.
 Apply Application Record ID.
 Install MiCollab software options, if required.
4 Reboot the virtual machine to finalize the deployment of MiCollab virtual appliance
and optional software.
5 Proceed with configuration of MiCollab users and services

3- 34 03_InstallMiCollab.docx
System Configuration

Objectives
4
When you finish this module, you will be able to:
 Designate a Local Administrator
 Configure Application Resources on the communications platform
 Configure Application Setting on the MiCollab platform
MiCollab Installation and Maintenance Course

Introduction

Local Administrator
As the system installer and administrator, you have the authority to provide a designate with
limited access to the Users and Services application.
This designate could be an individual who is responsible for day-to-day administration activities
at the customer site.
The “local-admin” account is created during installation of the MiCollab software. You administer
this account from the ‘System users’ panel in the Server Manager.
You must reset the account password in order to enable system access, as the account is
locked by default. You can disable access from the same interface using the Lock account link.

The ‘local-admin’ gains access to Users and Services by entering the fully qualified domain
name or IP address of the MiCollab platform in a web browser.
After clicking the ‘Server Manager’ link, the login page appears. After a successful login, a
limited navigation panel containing links to Users and Services and the Licensing Information
form appears.
The local-admin has full access to the ‘Users and Services’ application with the exception of the
‘Network Element’ tab.

4- 2 04_SystemConfig.docx
System Configuration

Configure Communications Platform Resources and Application


Settings
The first task is to configure the resources on the customer’s communications platform to
support MiCollab application features. The second configuration task is to program application
settings on the MiCollab platform.

You are installing with MiVoice Business…


Configuring MiVoice Business to support MiCollab application features is simplified by the use
of the Mitel Integrated Configuration Wizard. The wizard configures the necessary settings for
both MiVoice Business and MiCollab.
Alternatively, use the MiVoice Business System Administration Tool to manually program
required platform options, and the Create Network Element form in the MiCollab Users and
Services application to define the settings for the MiVoice Business element required by the
MiCollab software.

You are installing with MiVoice Office…


You must configure settings manually on the MiVoice Office platform prior to integration with
MiCollab as the Mitel Integrated Configuration Wizard does not support the MiVoice Office.
You must provision users and their phones in the Users and Services application to align with
the items you define in the MiVoice Office configuration database.
You can use the MiVoice Office Bulk User Export feature to export existing user information
(extension, description, username, and MAC address) from DB Programming into a .csv file to
import into MiCollab.

4- 3
MiCollab Installation and Maintenance Course

Launch Mitel Integrated Configuration Wizard

About Mitel Integrated Configuration Wizard


When connected to the MiVoice Business platform, initial provisioning is simplified with the use
of the Mitel Integrated Configuration Wizard.
The Wizard is a Mitel software application installed on a Windows PC that simplifies initial
system setup for MiCollab, and optionally MiVoice Business.
Automatically configure settings for the MiVoice Business platform, NuPoint Unified Messaging,
Speech Auto Attendant, MBG (Teleworker), and Audio, Web and Video Conferencing.
Supports SIP, PRI, BRI, T1/D4, and analog (non-dial-in) trunks only with same answer point.
Apply the system configuration directly at the conclusion of the wizard or save the configuration
to a file and apply at a future date.

While MiCollab supports a variety of system configurations, use of the Mitel Integrated
Configuration Wizard is recommended for new installations in environments with single MiVoice
Business platforms only.

Note
MiCollab is compatible with multiple MiVoice Business releases. Consult the
Software Compatibility Matrix in the Mitel Integrated Configuration Wizard
Online Help (also available at Mitel OnLine) to identify the correct version of
Mitel Integrated Configuration Wizard software for your MiVoice Business and
MiCollab platforms.

Before You Begin


Before you launch the Configuration Wizard, ensure the following conditions are satisfied:

 All necessary option boards are installed in the MiVoice Business platform. The system
configuration created with the wizard must match the installed hardware.

 MiCollab is fully configured, running, and connected to the network with all required
applications installed and licenses purchased and enabled.

 Secure Shell Access is enabled in the MiCollab server console with these options:
 Allow access only from local networks
 Allow Administrators command line access over secure shell
 Allow secure shell access using standard passwords

 IP address of the MiVoice Business platform and the MiCollab server are known.

4- 4 04_SystemConfig.docx
System Configuration

Summary - Configuration Wizard


Complete the following tasks to configure Communications Platform Resources and Application
Settings with the Mitel Integrated Configuration Wizard:

Step Task
Verify MiCollab server and MiVoice Business platform are connected to the network and
1
accessible from the administrator PC.
2 Install Mitel Integrated Configuration Wizard software on administrator PC.
3 Launch the Mitel Integrated Configuration Wizard.
4 Enter required MiCollab server and MiVoice Business configuration parameters.
5 Save and deploy the configuration.

Requirements
Review the detail on the Requirements window.

4- 5
MiCollab Installation and Maintenance Course

Start a Configuration
Accept the default to Create a new configuration.

System Parameters
Enter information for MiVoice Business and MiCollab platforms.

4- 6 04_SystemConfig.docx
System Configuration

If MiVoice Business system information is already configured, clear the Configure MiVoice
Business System Data checkbox. The Wizard will still provide configuration for applications
installed on MiCollab.

MiVoice Business – Licenses and System Options


Select the desired method for assigning licenses to the controller and enter the appropriate
MiVoice Business platform configuration options (Country/Region is required).

4- 7
MiCollab Installation and Maintenance Course

MiVoice Business – Local Area Network Connection


Enter LAN connection information for the MiVoice Business platform.

MiVoice Business – System Settings


Select a suitable time zone and choose one of the methods to set the date and time for the
MiVoice Business platform.

4- 8 04_SystemConfig.docx
System Configuration

Applications
Specify the MiVoice Business network configuration and select the required application
services.

In the series of screens that follow, you are prompted to enter additional configuration
parameters specific to MiVoice Business, including DHCP server options, controller modules,
trunks, etc.
Refer to your MiVoice Business I&M training for details about configuring these parameters.

4- 9
MiCollab Installation and Maintenance Course

Application Resources and Options


Enter resources and options to support NuPoint Unified Messaging, Dynamic Extension, and
Speech Auto Attendant or accept the default parameters.

Enter resources and options to support Teleworker and Audio, Web and Video Conferencing
services.

4- 10 04_SystemConfig.docx
System Configuration

Automatically Generate Users and Services


Click Next to skip to the next screen. You will use the MiCollab Users and Services application
to add user details.

4- 11
MiCollab Installation and Maintenance Course

MiVoice Business Groups


(Optional) Use this page to create any required MiVoice Business groups (hunt group, page
group, pickup group, etc.)

MiVoice Business Advanced Configuration


(Optional) You can import a .csv file to extend the initial configuration.

4- 12 04_SystemConfig.docx
System Configuration

Summary of Configuration Information


Review the configuration on the summary page.

You are advised to save the configuration at this point. You could decide to apply this
configuration file at some point in the future.

4- 13
MiCollab Installation and Maintenance Course

Save and Configure


Select Save As...
Specify a file name and location and click Save.

4- 14 04_SystemConfig.docx
System Configuration

Configure MiVoice Business


Enter the administrator credentials for the MiVoice Business controller and click Next.

You are advised to change Login and Password at this stage of deployment.

4- 15
MiCollab Installation and Maintenance Course

Configure MiCollab
Enter the administrator credentials for MiCollab and click Configure.

4- 16 04_SystemConfig.docx
System Configuration

Progress Status
A Progress Status window displays the progress of the configuration updates.

4- 17
MiCollab Installation and Maintenance Course

Results
The Results window appears. Ensure there are no unsuccessful operations and click Finish.

4- 18 04_SystemConfig.docx
System Configuration

Configure Communications Platform Resources

Configure MiVoice Business Resources

MiCollab Client
Program MiCollab Client softphone

 Select App Server Port or 5020 IP as device type

Enable MiTAI/TAPI Computer Integration option

Configure MiCollab Client softphone Class of Service options

 Group Presence Control: Yes


 Group Presence Third Party Control: Yes
 HCI/CTI/TAPI Call Control Allowed: Yes
 HCI/CTI/TAPI Monitor Allowed: Yes
 Voice Mail Softkey Allowed: No

Add PRG devices > Personal Ring Group Assignment form

 You may also need to define a DN as the prime member of the PRG using the Multiline
IP Set Configuration form.

Audio, Web and Video Conferencing


Configure SIP Device Capabilities as follows:

 Enable Replace System based with Device based In-Call Features


 Set Session Timer value to 0

Program Class of Service

 Enable Suppress Simulated CCM after ISDN Progress

Add Generic SIP Phone device for each Audio, Web and Video Conferencing extension.

Create a Voice Hunt Group and add Audio, Web and Video Conferencing extensions as
members.

 Assign COS from previous step.

4- 19
MiCollab Installation and Maintenance Course

Create Extended Hunt Group (Optional)


Note: Only necessary when customer requires more than 64 Audio, Web and Video
Conferencing extensions
Enable Extended Hunt Group in License and Option Selection

NuPoint Unified Messaging


Enable system software license options

 Networking Option
 MiTAI/TAPI Computer Integration

Program System Options

 Registration Access Code


 Set Replacement Access Code

Program Feature Access Codes

 Message Waiting Activate


 Message Waiting Deactivate

Enable Class of Service Options

 Voicemail / Record-A-Call ports


 HCI/CTI/TAPI Call Control Allowed
 HCI/CTI/TAPI Monitor Allowed
 Public Network Access via DPNSS
 COV/ONS/E&M Voice Mail Port

Speech Auto Attendant ports

 Calling Party Name Substitution


 Dialed Night Service
 Display Dialed Digits during Outgoing Calls
 Public Network Access via DPNSS

Add Feature ports:

 Voicemail only Device Type: 5020


 Record-A-Call Device Type: 5240
 Speech Auto Attendant Device Type: 5020

4- 20 04_SystemConfig.docx
System Configuration

Create Voice Mail Hunt Group

 Hunt Group Mode: Circular


 Hunt Group Type: Voicemail
 Add Voicemail only ports as members

Create Record-A-Call Hunt Group

 Hunt Group Mode: Circular


 Hunt Group Type: Recorder
 Add Record-A-Call ports as members

Create Speech AA Hunt Group

 Hunt Group Mode: Circular


 Hunt Group Type: Voice
 Add Speech AA ports as members

Create HCI Reroute Hunt Group

 Hunt Group Mode: Circular


 Hunt Group Type: HCIReroute

Program Call Rerouting Assignment for HCI Reroute

 Call Rerouting Always Alternative Assignment form>


 Choose unused Always Alternative Number

 Call Rerouting Always Alternative Number Assignment form>


 Change each Always Originating Device value to Reroute
 Enter Voicemail Hunt Group pilot number in Change Directory Number to Reroute
field

 Call Rerouting Assignment form>


 Select entry for the HCI Reroute number and click Change
 Change Call Rerouting Day, Call Rerouting Night1, Call Rerouting Night2 to Always
Alternative Number selected above

4- 21
MiCollab Installation and Maintenance Course

Configure MiVoice Office Resources

MiCollab Client
Enable system software license options:

 Dynamic Extension Express


 System OAI 3rd Party Call Control
 System OAI Events

Create OfficeLink Assistant

 System – Devices and Feature Codes – Assistants

Add desk phone extension

 System – Devices and Feature Codes – Phones – Extension


 System – Devices and Feature Codes – Phones – Description

Define Audio Frames/IP Packet = 2 (Softphone only)

 System – IP-Related Information – Call Configuration.

Enable system OAI Level 2

 System – Sockets

Configure the following for each user:

 First Name and Last Name


 Main Extension
 Enable Dynamic Extension Express
 Add Associated Extensions

Audio, Web and Video Conferencing


Add 86xx IP device for each Audio, Web and Video Conferencing conferencing extension.

 For each extension, set the MAC address to FF:FF:FF:FX:XX:XX, FF:FF:FF:FF:XX:XX,


or FF:FF:FF:FF:FX:XX where X represents the digits of the extension number

Create a Call Configuration for Audio, Web and Video Conferencing conferencing extensions.

 Specify RFC 2833 for DTMF Encoding Setting.


 (UK only) Assign G 7.11 Mu-Law to Speech Encoding Setting.

4- 22 04_SystemConfig.docx
System Configuration

Configure Phone Feature Codes for Audio, Web and Video Conferencing conferencing
extensions.

 Disable Handsfree On/Off


 Enable Ring Intercom Always On/Off

Create a Hunt Group and add Audio, Web and Video Conferencing conferencing extensions as
members.

Enable System OAI Level 2

NuPoint Unified Messaging


Ensure Basic Voice Mail (BVM) is disabled

Create SIP Peer for NuPoint UM

 System >Devices and Feature Codes >SIP Peers >SIP Voice Mails
 Right-click to create SIP Voice Mail

Configure SIP Voice Mail

 IP address of MiCollab platform


 Fully Qualified Domain Name
 Required number of Voice Mail ports

Create SIP Voice Mail Extension

 Enter Pilot Number for voice mail line group

Create Associated Mailboxes

 52xx/53xx for phone type

4- 23
MiCollab Installation and Maintenance Course

Program Application Settings

Co-located MiCollab Client

Create the Enterprise

 Configure basic information about the company to create an Enterprise

Add Feature Profiles

 Assign licensed features to users within the Enterprise

Add PBX Nodes

 Program the communications platform providing call control and application features to
the Enterprise

Optional Programming

 Add Collaboration Server(s)


 Configure a server to provide collaboration features to the Enterprise

 Configure Automatic Call Distribution


 Create ACD groups, account codes, and busy reasons if the Enterprise uses ACD

 Program Peer Server(s)


 Configure a peer server to increase product scalability

 Add Federation Server(s)


 Program a federation server to provide instant messaging and presence features to the
Enterprise

Audio, Web and Video Conferencing

Program System Options

 Define global conferencing options

Define Port Reservation Settings

 Enable port reservations to manage port usage for conferences

Configure Web Conferencing Settings

 Program configuration settings for web conferences

4- 24 04_SystemConfig.docx
System Configuration

Program LDAP Configuration

 Specify LDAP authentication parameters

Configure Music-On-Hold Settings

 Enable/disable music-on-hold and specify the music file to play during hold events

Select Voice Prompts

 Specify Audio, Web and Video Conferencing voice prompt language (default is
determined by Application Suite Language setting)

Configure SIP Server

 Program SIP Server configuration for associated communications platform

NuPoint Unified Messaging


Add Line Groups

Speech Auto Attendant

 Configure Speech Auto Attendant User Data Source


 If Speech Auto Attendant is installed, select MiCollab as the User Data Source

MiVoice Border Gateway


To provide the highest level of security for MiCollab applications, you install MiCollab with
Teleworker service on the LAN with a MiVoice Border Gateway server with Teleworker service
in the Demilitarized Zone (DMZ).
Remote Teleworker users connect to MiCollab through the MiVoice Border Gateway server.

When installed in this manner, you select the MiVoice Border Gateway link in the MiCollab
navigation panel and then select the Clustering tab in order to create a MiVoice Border Gateway
cluster with the MiCollab system and the MiVoice Border Gateway server as the only members
of the cluster.

Conditions

 The MiVoice Border Gateway server must be installed in “DMZ” mode, operational and
routable to the MiCollab server.
 MiCollab is limited to a cluster size of one MiVoice Border Gateway server.
 The Teleworker service must be installed on both the MiCollab server and the MiVoice
Border Gateway server. The version of the MiVoice Border Gateway blade on MiCollab
should match the version on the MiVoice Border Gateway server.

4- 25
MiCollab Installation and Maintenance Course

The MiCollab and MiVoice Border Gateway nodes must reside in separate zones. You create a
"LAN" zone for the MiCollab node and the MiVoice Border Gateway node remains in the
"Default" zone.
Open port 6809 in the firewall to allow the MiCollab system to communicate remotely with
MiVoice Border Gateway.
Add local networks to the MiCollab server as required to allow communication between
MiCollab and MiVoice Border Gateway.

1. Click MiVoice Border Gateway under Applications in the navigation panel.

2. Click the Clustering tab.

3. Click Create

4. Enter MiVoice Border Gateway server IP address in IP Address of peer node field.

5. Select 0 from the Cluster weight of current node drop-down list.

4- 26 04_SystemConfig.docx
System Configuration

6. Click Save.

Within the Node Information table, you will notice the MiVoice Border Gateway server is not yet
part of the cluster.

7. Access server manager on the MiVoice Border Gateway server.

8. Click MiVoice Border Gateway under Applications in the navigation panel.

9. Click the Clustering tab.

10. Click Join.

4- 27
MiCollab Installation and Maintenance Course

11. Enter MiCollab server IP address in IP Address of peer node field.

12. Click Save.

The initial screen indicates that the MiCollab is currently not connected.
After several seconds, refresh your browser and the Cluster status field identifies the MiVoice
Border Gateway server as the slave node.

4- 28 04_SystemConfig.docx
System Configuration

Access server manager on the MiCollab server. Click MiVoice Border Gateway under
Applications in the navigation panel.

13. Click the Clustering tab.

4- 29
MiCollab Installation and Maintenance Course

14. The Cluster status field identifies the MiCollab server as the Master node.

15. Provision the required Teleworker services from the MiCollab server.

4- 30 04_SystemConfig.docx
Provision Users and Services

Objectives
5
When you finish this module, you will be able to:
 Add users to the MiCollab platform
 Provision users with application services
MiCollab Installation and Maintenance Course

Import User Data from a Data File

The Bulk User Provisioning tab of the Users and Services application allows you to add user
entries to the database in bulk from a .csv (comma separated values) or LDAP Data
Interchange Format (LDIF) file. You can also add single users directly to the tool.

You can download a .csv sample file from the Tools menu of the Bulk User Provisioning tab.

Here is a data file created from the downloaded sample file. It is mandatory that the first three
columns contain a value, other columns are optional.

5- 2 05_ProvisionUsersServices.docx
Provision Users and Services

Select Import from File from the Tools menu on the Bulk User Provisioning tab.

Select the file format type from the File Import dialog and browse to the data file location.

5- 3
MiCollab Installation and Maintenance Course

Click Import on the File Import dialog. User data is imported and displayed in the Bulk User
Provisioning detained queue.

Select the entries that you want to save to the database. Click the box in the table header to
select all entries.

5- 4 05_ProvisionUsersServices.docx
Provision Users and Services

Click Save to begin the data file import. The Operation Progress window displays the progress
of the import operation.

Select the Users tab to verify that the import process completed successfully.

5- 5
MiCollab Installation and Maintenance Course

An error message is displayed if any errors occur during the file import process.

5- 6 05_ProvisionUsersServices.docx
Provision Users and Services

Import User Data from Directory Server

At customer sites running Microsoft Active Directory, adding MiCollab system users and
services is simplified with Integrated Directory Service (IDS).

LDAP Synchronization
MiCollab IDS allows you to populate the MiCollab user database with the entries from the
Directory Server. Following initial configuration, you can manage user and service updates from
the Directory Server.
User and service data is synchronized between the Active Directory server and MiCollab IDS
using the Lightweight Directory Access Protocol (LDAP), minimizing the requirement to maintain
two data sources. Synchronization occurs in one direction, from the Active Directory server to
MiCollab IDS. Role-based user templates support the configuration of phone and application
services on MiCollab.
MiCollab IDS uses a LDAP Admin user account in Active Directory for synchronization
purposes. This account need only have the privileges required to read the appropriate user
search base in the domain.

LDAP Authentication
Enable LDAP Authentication to allow MiCollab IDS users to use their Directory Server
credentials (domain name and password) to log into the following MiCollab end user interfaces:

 MiCollab End User Portal, Audio, Web and Video Conferencing Client, MiCollab Clients –
desktop, web portal, mobile

5- 7
MiCollab Installation and Maintenance Course

LDAP Synchronization
Set up and manage LDAP Synchronization and Authentication using the following form:

See the following for details about each field on this form.

Field (Default) Description

Primary directory server Enter the name of the directory server for the IDS
connection.

Secondary directory server Enter the name of a backup directory server for the IDS
connection. The secondary must be a replica of the primary.

Enable synchronization Check to allow synchronization with the directory server.


(Disabled)

Enable authentication (Disabled) Check to enable LDAP authentication of end users.

Domain Specify the unique domain name used by the directory


server.

Directory server type (Active Active Directory is currently the only supported Directory
Directory) Server type.

5- 8 05_ProvisionUsersServices.docx
Provision Users and Services

Distinguished name Enter the distinguished name for the synchronization


account authorized to access the directory server.

Password Enter the user password for the synchronization account


authorized to access the directory server.

LDAP port (389) Enter the LDAP port number on the directory server. The
default value, 389, is the standard LDAP port.

Global catalogue port This option reduces the number of fields that you can map
to the MiCollab user records. When a Global catalogue port
is specified, only the following user fields are available for
synchronization: - telephoneNumber (Prime DN),
ObjectGUID (User ID), samAccountName (Login),
distinguished name (Domain), mail (Email), sn (Last Name),
givenName (First Name).

Connection method (TLS) Select the security method used to connect to the directory
server - Unsecured, TLS, or SSL.

Default query string Enter the default query string used for filtering LDAP
(Objectclass=user) searches.

Search scope (Sub-tree) Determines the set of directory server data that is applied to
MiCollab database during a synchronization event - Sub-
tree, Object, or One level.

Query page size (400) Enter the maximum page size of the LDAP search (100 to
1000 records per page permitted).

Chase LDAP referrals (Disabled) If the directory server does not hold the target requested by
an LDAP search, it will return a referral message that
redirects the MiCollab client to another directory server.

Search context Enter the distinguished name of the default location used to
search objects on the directory server.

Re-initialize on next cycle Forces a full synchronization on the next scheduled sync
(Disabled) event.

Defer all operations (Enabled) Use this option if you want to preview the synchronization
updates in the detained updates queue.

Schedule (Daily at midnight) Schedule synchronizations to occur regularly on a pre-


defined time interval.

5- 9
MiCollab Installation and Maintenance Course

Attribute Mappings
MiCollab IDS uses the directory server attributes listed on the right side of the table below to
map directory server data fields to the MiCollab Users and Services data fields listed on the left
side.

You can modify the settings if the directory server is not using the specified default attributes.

5- 10 05_ProvisionUsersServices.docx
Provision Users and Services

Prior to enabling MiCollab IDS, you need to create a user account in Active Directory with read
privileges to the user search base that holds users for MiCollab.

In this example, the user search base is an Organizational Unit (OU) called People in the
example.com domain. The Active Directory server host name is vCenter.
This view from the Active Directory Delegation of Control Wizard displays some of the dialog
boxes for delegating read control of the People user search base to an LDAP admin account
called IDSadmin:

5- 11
MiCollab Installation and Maintenance Course

Add Connection
Select Integrated Directory Service from the Configuration menu in Server Manager.

You can only create one MiCollab connection per directory service domain. Multiple connections
from MiCollab systems to the same directory service domain are not supported.

5- 12 05_ProvisionUsersServices.docx
Provision Users and Services

Click Add Connection.

Enter values in the necessary fields and click Save.

At a minimum, you must provide values for Primary directory server, Enable synchronization,
User name, and Password. Fields are described on the next pages.
5- 13
MiCollab Installation and Maintenance Course

Click Sync under the Actions menu and monitor the status of the sync operation.

Managing the Detained Queue (Updating Users Directory)


As Defer all Operations is enabled by default for all new MiCollab IDS connections, automatic
processing of updates obtained from the synchronization process is disabled.
You manage the detained queue using the Save and Delete buttons and the options found
under the Tools menu.

5- 14 05_ProvisionUsersServices.docx
Provision Users and Services

1. Verify the correct entries are listed in the detained queue.

2. Select the records that you want applied to the database and click Save.

3. Monitor the status of the save operation.

4. Select Users under Users and Services to confirm the records are added to the MiCollab
system directory.

5. In the MiVoice Business System Administration Tool, select User and Services
Configuration under the Users and Devices menu to confirm the records are added (by
Single Point Provisioning) to the MiVoice Business system.

Troubleshooting
LDAP admin account parameters not set properly.

 You need to enter the correct distinguished name for the LDAP admin account.

LDAP Authentication requires SSL/TLS on port 636 (Active Directory default).

 If AD is not using the default SSL port, LDAP synchronization will fail.

IDS must not be enabled on any of the MiVoice Business platform(s) that are managed by
MiCollab.

IDS must not be enabled for NP-UM SAA, MiCollab Client, or Audio, Web and Video
Conferencing applications.

5- 15
MiCollab Installation and Maintenance Course

Tutorial – Provision Users and Services – Manual


Configuration

This tutorial illustrates the manual process to provision a new system with support for the
following services: NuPoint Unified Messaging, MiCollab Client, Audio, Web and Video
Conferencing, and Teleworker.
Call control and application features are provided by MiVoice Business.

The requirements satisfied in this example are as follows:

 Create New Department – Executive


 Create New Location – Telfer
 Create Network Element - Clark
 Create New Users
 Provision MiCollab application services

Create Departments
Click the Departments tab on the Users and Services page and click Add.

Enter a Name, Phone Number, and Description and click Save.

5- 16 05_ProvisionUsersServices.docx
Provision Users and Services

With Single Point Provisioning enabled, the department is added to the MiVoice Business
Department Assignment form when you add the user.
The department also appears in the Telephone Directory Assignment form.

Create Locations
Click the Locations tab on the Users and Services page and click Add.

Enter a Name and Description and click Save.

With Single Point Provisioning enabled, the location is added to the MiVoice Business Location
Assignment form.
The location also appears in the Telephone Directory Assignment form.

5- 17
MiCollab Installation and Maintenance Course

Create User Templates


About Role-based User Templates
Role-based User Templates contain pre-configured user and service information that you assign
to individuals or a group of users when you create your customer database.

A User role can reference only one template (for example, the Technician above can have only
one template assigned to him at any given time). The Technician template, however, can be
assigned to Users with other roles (for example, a Tech Support worker might also have the
Technician template assigned).
Roles are created automatically when you add a User template. To add a user to MiCollab,
select a role that will assign the corresponding common configuration data contained in the
associated user template.

5- 18 05_ProvisionUsersServices.docx
Provision Users and Services

The figure below illustrates the type of information you can include in a user template.

Identify user roles within the organization (users with common phone and application service
needs; e.g. contact center agent group) and then create user templates with the required user
and service information.

A template can include a Primary Phone, a Secondary Phone, and Other Phone. By default, the
first phone that you add to a user template is designated as the prime phone.

5- 19
MiCollab Installation and Maintenance Course

The relationships within a user template are illustrated below.

MiCollab systems (non-UCC licensed) include a Basic User template and Basic User role as
defaults:

You can create custom templates by clicking Add on the User Templates tab. Modify the fields
in the blank template to create a custom template.

Use the Basic User default role to add a user with a single full service phone including the basic
(free of charge) MiCollab Client.

5- 20 05_ProvisionUsersServices.docx
Provision Users and Services

Default UCC Roles and Templates


Following installation of Mitel Standard Linux, you enter the customer Application Record ID
(ARID) to register MiCollab with the Applications Management Center (AMC).
When a customer Application Record contains UCC license bundles, installation creates a
number of default User Roles and User Templates based on the UCC license bundles
purchased by the customer.

You can edit each of these templates to customize it for your site, or you can create your own
custom template. To edit a template, click the template name, change the appropriate fields,
and then save the template.

5- 21
MiCollab Installation and Maintenance Course

To create a custom template:


Click the User Templates tab on the Users and Services page and click Add.

Complete the fields on the Create User Template form and click Save.

5- 22 05_ProvisionUsersServices.docx
Provision Users and Services

Create Role
You can use the Create Role form in the Users and Services administration interface to create
custom user roles and then assign user templates to them:

Applying User Roles


Apply user roles and the associated template to user entries using any of the following methods:

Quick Add: allows you to create a new user using a role. The assigned role automatically
applies the associated template data to the user entry.

Import Users from Data File: import a .csv or LDIF file of user entries and specify user roles for
the entries. The role designation references a template that automatically applies common data
during the import process. You also have the ability to auto-fill a selection of user entries in the
bulk user provisioning tool with roles, directory entries, and e-mail addresses.

Import Users from Directory Server: When a directory server is integrated with MiCollab, you
can map a directory service attribute to a MiCollab role. When a user is provisioned in the
directory service and synchronized with the MiCollab database, the template data that is
associated with the specified role is applied to the user entry created on MiCollab.

5- 23
MiCollab Installation and Maintenance Course

Create Network Element


Click the Network Element tab on the Users and Services page and click Add.

Complete the fields on the Create Network Element form and click Save.

The new Network Element appears on the Network Element tab.

5- 24 05_ProvisionUsersServices.docx
Provision Users and Services

Create New User


Click the Users tab on the Users and Services page and click Add. Use the Quick Add button to
add the user to the system using a template with pre-configured settings.

Enter information in the Create New User form to identify the user and define credentials for
system access and click Save.

With Single Point Provisioning enabled, the user is added to the MiVoice Business User
Configuration form.

5- 25
MiCollab Installation and Maintenance Course

Personal Info
The Display Name field is composed of the “Last Name, First Name”. If “First Name” is not
configured, the field displays the “Last Name”. If “Last Name” is not configured, the field displays
the “First Name”. If neither is configured, the field is blank.
You can assign any of the available languages as the Prompt Language for the individual user.
For example, while the system default may be set to English (United States), you can assign
Latin American Spanish to the account of a Spanish-speaking individual.
When that user accesses NuPoint Unified Messaging using the telephone user interface, the
prompts are presented in Latin American Spanish.
This change does not affect Audio, Web and Video Conferencing which continues to present
prompts in the system default language.
IDS Manageable is enabled by default. If a directory server is not integrated with MiCollab, this
option has no effect. If an IDS server is integrated, updates to some fields in the directory
service record are applied to the MiCollab database during the next synchronization.
Note: Not all user service data is IDS manageable. See Integrated Directory Services in the
MiCollab Server Manager online help for details.

Authentication Section
The system generates a default Login ID using the user’s last name and the first letter of their
first name.There are password strength rules that force the user to change the password when
accessing the end user portal for the first time. You can enter a token password with a minimum
of 4 letters on the Create New User form.
The TUI Passcode field allows you to define the universal passcode for the telephone user
interface of certain voice applications, such as a NuPoint Unified Messaging voice mailbox and
is also used as the Hot Desk User Login PIN (see Hot Desking User below).
You can use the Generate Password and Generate Passcode controls to create a password
and passcode for the user automatically.

5- 26 05_ProvisionUsersServices.docx
Provision Users and Services

Add New Phone


This section demonstrates how to add a phone to a user’s account. Information that you enter
on this page is shared by all installed applications. You must define a phone device prior to
assigning services for the user.

Click the Phones tab on the Edit User page and click Add New Phone.

Complete the appropriate fields on the New Phone form as discussed on the following pages.

5- 27
MiCollab Installation and Maintenance Course

Phone Category offers four choices: Office, Mobile, Home, or Other. This is an optional field.

When Add to Directory is selected, users can display information for the phone by using the
Search function in the End User Portal.

Phone Types include Mitel 3300 ICP Phone, Other PBX Phone (for 5000 CP device) and
External Phone (for PSTN device). A selection is required in this field.

The Network Element list contains all MiVoice Business platforms defined in the Network
Element form. A selection is required in this field.

The Device Type list contains all supported devices. A selection is required in this field.

Service Level

Multi-Device: assigns the phone with only basic telephony functionality until it is added as a
member of a Multi-Device User Group (MDUG). The DN does not use a MiVoice Business IP
User License. However, the group requires a Multi-Device User license which one device can
use at a time in order to receive full telephony service. See also Configure Groups.
Full: assigns the phone with full telephony functionality. This service level allows the phone to
be added to Personal Ring Groups (PRGs) only. See also Configure Groups.

5- 28 05_ProvisionUsersServices.docx
Provision Users and Services

Number of the phone is a required entry.

MAC Address is a mandatory field for Teleworker phones.

SIP Device Capabilities defaults to pre-set levels when Device Type is set to Generic SIP
Device or UC Endpoint. You can change these levels as required.

Call Coverage Service Number assigns a level of Hot Desk PIN security that corresponds to
values programmed in the Call Coverage Service form on the MiVoice Business system.

Hot Desking is a MiVoice Business feature that allows a number of users to share one or more
IP phones.
The system associates the user’s settings with the IP phone. Once a user logs in, their hot desk
user Directory Number and key programming are associated with that IP phone.
The Hot Desking User check box appears on the New Phone form to support this feature.
When the checkbox is selected, the MAC Address input box is disabled.

The Mitel Integrated Configuration Wizard supports commissioning of this device type for new
installations. Hot Desk devices are assigned Class of Service 10. The following MiVoice
Business settings apply:

 Hot Desk Remote Logout Enabled = Yes


 Hot Desk Login Accept = Yes

5- 29
MiCollab Installation and Maintenance Course

External Hot Desk User


The MiVoice Business External Hot Desk User (EHDU) feature provides the ability to use an
external device as a Hot Desk phone.
The MiVoice Business system associates the external Directory Number with a Hot Desk
Directory Number. A user can log into the external device and receive any calls that ring the Hot
Desk Directory Number.

Three items need to be programmed on the Phones form to support EHDU:

 “External Hot Desk License” is enabled (requires Hot Desking User to be selected).
 “Hot Desk User External Dialing Prefix” contains the ARS digit(s) required to dial the
external number for the EHDU device.
 “Hot Desk User External Number” contains the Directory Number of the EHDU device.

5- 30 05_ProvisionUsersServices.docx
Provision Users and Services

Classes of Service
Two Classes of Service support the External Hot Desk User feature:

 Hot Desk External User – Answer Confirmation: specifies whether or not a user must press
a DTMF key to answer incoming calls on the EDHU device.
 Hot Desk External User – Permanent Login: specifies whether or not the EDHU stays
logged in permanently.

MiCollab uses the default value (Yes) for each setting. There is no option to alter this setting in
the Users and Service application.

Feature Access Codes


Two Feature Access Codes support the EHDU feature:

 Hot Desk User External Number – Store: allows the user to change the Hot Desk User
External Number from the TUI.
 User PIN – Store: allows the user to change the PIN for the EDHU feature.

There is the potential for certain settings between MiCollab and MiVoice Business to fall out of
sync. If a user changes either the EHDU External Number or PIN using a FAC, then the setting
in Users and Services will differ from that set in MiVoice Business.

ACD Agent
A Hot Desk ACD agent can log into any hot desk enabled set or into any ACD enabled set. Hot
desk ACD agents require an Agent ID and a User PIN to log in.
When a hot desk ACD agent logs in, MiVoice Business software associates the user's personal
phone settings, such as directory number, COS/COR settings, language display, and key
assignment programming with the set.
A check box appears on the Phones form to support Hot Desk ACD agents. “ACD Agent”
reflects the User Type found in the User Configuration form of the System Administration Tool.

The following constraints occur with the selection of the ACD Agent checkbox:

 “Hot Desk Login Accept” check box is enabled and cannot be modified.
 “External Hot Desk License” check box is disabled.
 “Hot Desk User External Dialing Prefix” field is disabled.
 “Hot Desk User External Number” field is disabled.

5- 31
MiCollab Installation and Maintenance Course

Add New Phone – Quick Reference


To add a User Desk Phone:
Select Office Phone from the Phone Category drop-down list, Mitel 3300 ICP Phone from the
Phone Type drop-down, the appropriate model from the Device Type drop-down, and enter the
user's extension number in the Number field.

To add a phone for the Teleworker service:


Select Other Phone from the Phone Category drop-down list, Mitel 3300 ICP Phone from the
Phone Type drop-down, the appropriate model from the Device Type drop-down, and enter the
Teleworker extension number and MAC address.

To add a Mobile phone:


Select Mobile Phone from the Phone Category drop-down list, External Phone from the Phone
Type drop-down, and enter the number.

5- 32 05_ProvisionUsersServices.docx
Provision Users and Services

Add New Mailbox


This section demonstrates how to add messaging information using the New Mailbox form.
The New Mailbox form allows you to configure basic messaging features for a user.

To configure advanced features, use the NuPoint Web Console application.

On the Edit User page, click the NuPoint Unified Messaging tab and click Add New Mailbox.

5- 33
MiCollab Installation and Maintenance Course

Alternatively, click Assign Existing Mailbox… to associate a pre-defined mailbox with the user.
This action will update the NuPoint database to reflect the ownership change.

Complete the fields on the New Mailbox form and click Save.

The Mailbox Number that you enter must be unique in the NuPoint database. To create a
mailbox with the same number as the user’s extension, accept the default Use Extension
Number for Mailbox.

The Feature Class of Service (Feature COS) controls mailbox user privileges and outside caller
functions for the mailbox. The default Feature COS (14) contains the necessary options for the
basic NuPoint messaging features which are part of MiCollab.

The Limits Class of Service (Limits COS) imposes limits on mailboxes such as the maximum
time that a message can be stored in a mailbox and the maximum number of messages that
can accumulate in a mailbox.

Message Waiting #1 and #2 control the type of data signals used to illuminate and extinguish
the message waiting lamp on a user’s extension.

Select the Standard Unified Messaging check box to enable Standard UM for a user's mailbox.
The check box is disabled if the Primary Email Address is not configured on the User tab. The
FCOS assigned to the mailbox must have the Standard UM feature enabled in order to proceed
without errors.

The Advanced Unified Messaging check box is automatically enabled if the mailbox has the
Advanced UM FCOS assigned and email credentials configured.

When the new mailbox is added, the associated extension is updated with the selected COS
values and call forward programming is assigned to the voicemail hunt group.

Add MiCollab Client Service


This section demonstrates how to configure settings for the MiCollab Client service for a user.

Click the MiCollab Client tab.

5- 34 05_ProvisionUsersServices.docx
Provision Users and Services

Complete the fields on the MiCollab Client form and click Save.

The Feature Profile defines the group of licensed MiCollab Client features that are assigned to a
user. If the Feature Profile does not include a desk phone or softphone license, then the
MiCollab Client service is not supported.

Select the Desk phone extension that you want to assign with MiCollab Client service from the
list of the phones currently programmed on the ‘Phones’ tab for this user. You can only assign
one of the user's desk phones with MiCollab Client service.

Select the Softphone extension that you want to assign with MiCollab Client service. You can
only assign one of the user's softphones with MiCollab Client service.

Add Audio, Web and Video Conferencing Service


This section demonstrates how to enable the Audio, Web and Video Conferencing service for a
user. The New Audio, Web and Video Conferencing Service form allows you to assign the
Audio, Web and Video Conferencing service to the user's profile.

Click the Audio, Web and Video Conferencing tab on the Edit User page and click Add Service.
Alternatively, click Assign Existing Service… to associate a pre-defined Audio, Web and Video
Conferencing service with the user.

Enter or select a Registered Phone and click Save.

5- 35
MiCollab Installation and Maintenance Course

The Audio, Web and Video Conferencing Service page contains two fields for a Registered
Phone.

In the first field, you can supply a phone number or leave it blank. If you leave the field blank,
the Audio, Web and Video Conferencing service is still created. The number for the Registered
Phone can be supplied afterwards.
The second field provides a drop-down list of the phones currently programmed on the ‘Phones’
tab for this user. When a phone is selected from this drop-down, the number is copied into the
Registered Phone field.

When you assign the Audio, Web and Video Conferencing service to a user, attributes of the
Audio, Web and Video Conferencing service are defaulted.
The defaults chosen for new Audio, Web and Video Conferencing services are configured on
the ‘Default User Settings’ page located under Provisioning when you access the Audio, Web
and Video Conferencing application from within Server Manager.
You would normally set user defaults before assigning any Audio, Web and Video Conferencing
services.

5- 36 05_ProvisionUsersServices.docx
Provision Users and Services

Add New Teleworker


This section demonstrates how to enable the Teleworker service for a user. The New
Teleworker form allows you to assign the Teleworker service to the user's profile.

Click the Teleworker tab on the Edit User page and click Add New Teleworker.
Alternatively, click Assign Existing Teleworker… to associate a pre-configured Teleworker
extension with the user.

Select the Phone for Teleworker service and set the Status to Enabled and click Save.

The Teleworker service form contains two drop-down lists: Phone and Status.
Select a previously configured phone from the Phone drop-down menu.
You must assign a phone that is supported by the Teleworker service; otherwise, you will
receive an error indicating there are no compatible phones to assign when you attempt to add
the Teleworker service.

The Status field provides options to enable or disable the Teleworker service.

5- 37
MiCollab Installation and Maintenance Course

Welcome Email

Introduction
The Welcome E-mail provides the user with communication settings information, such as login
ID, password, pass code, primary e-mail address, phone type and number and service
information.

A Welcome Email is sent automatically to subscribers under the following conditions:

 You create a new user (and include an email address) using any of the supported user
creation tools, such as Mitel Integrated Configuration Wizard or Users and Services
Provisioning (Add, Quick Add, Import).
 By default, the Welcome E-mail contains the user’s login ID, password and a link to the
My Unified Communications portal.

 You modify a user’s password or passcode and that user has an email address defined.
 By default, the Welcome E-mail contains the user Login ID and new password (if
password modified) or passcode only (if passcode modified).

 You select the checkbox next to a user name in USP and click Send Service Info E-mail.
 The content of this email is subject to the configuration settings selected for the
Welcome E-mail. Login details are excluded.

You can send the Welcome E-mail with a default or custom greeting message. With the
exception of the custom greeting, the information can be sent in two languages.

You configure parameters on the Welcome E-mail tab of the MiCollab Settings configuration
page.

Click Save to save the configuration and deliver the welcome email message.

5- 38 05_ProvisionUsersServices.docx
Provision Users and Services

Send Welcome E-mail


The feature is Enabled or Disabled by selecting the appropriate radio button. Enabled is
selected by default.

Enter Sender E-Mail Address


To include an email address in the From header of the Welcome E-mail, enter the address in
this field. Mitel recommends the entry of a routable, but unmonitored email address (e.g.
donotreply@example.com).

Append Do Not Reply Closing Message


You enable or disable the Do Not Reply Closing Message by selecting the Enabled or Disabled
radio button. Enabled is selected by default, which automatically appends the following
message to the email:
NOTE: This is an automatic e-mail notification. Please do not reply to the sending address.
Replies to the sending address will not be read by anyone.

5- 39
MiCollab Installation and Maintenance Course

Use Default Greeting Message or Custom Message


You enable a greeting message by selecting the Default or Custom radio button. The Default
setting automatically adds the following greeting to the body of the email:
“This e-mail lists your MiCollab settings”.

When you select Custom, you can enter a maximum of 2000 characters in the text box.

Specify the information you want to include in the email by selecting the appropriate check box.
Login ID and Password check boxes are enabled by default.

User
Login ID, Password, and TUI Passcode.

Phone
Phone Number and Set Registration PIN code.

Speech Auto Attendant


Access number for the Speech Auto Attendant application. Requires entry on Network Element
form.

NuPoint Unified Messaging


Voice Mailbox Number and auto attendant number.

Teleworker
Installation password to configure Teleworker device.

Audio, Web and Video Conferencing


URL to access the Audio, Web and Video Conferencing public portal.

Select First Language of Welcome E-mail


Select the primary language for the email message.

Select Second Language of Welcome E-mail


Select another language that will follow the first in the email message. If a second language is
selected, only the Default Greeting Message is translated into the selected language.

Test E-mail Address


Enter a valid email address (or addresses) into this field to preview the content of the Welcome
E-mail.

5- 40 05_ProvisionUsersServices.docx
Provision Users and Services

Service Info E-mail


To resend an email containing service information, select the check box next to the user
name(s) and click Send Service Info E-mail.

5- 41
MiCollab Client Integrated
Mode 6
Objectives
When you finish this module, you will be able to:
 Understand MiCollab Client Integrated Mode
 Activate Integrated Mode with MiCollab Client Integration Wizard
MiCollab Installation and Maintenance Course

Introduction

Configuring MiCollab to support MiCollab Client application features requires you to make a
choice between Co-located Mode and Integrated Mode:

Co-located
MiCollab Users and Services data and MiCollab Client data are contained in separate,
independent databases.

 MiCollab system default that supports sites with either MiVoice Business or MiVoice Office
platforms.
 You must use the MiCollab Client Service administration interface to provision MiCollab
Client services.
 Single-point provisioning of MiCollab Client services is not supported.

Integrated
MiCollab Users and Services data and MiCollab Client data are synchronized to function as a
single database.

 Launch the MiCollab Client Integration Wizard to put a MiCollab system into integrated
mode.
 You can provision MiCollab Client services from the MiCollab Users and Services
application interface.
 Supports single-point provisioning of MiCollab Client services on the MiVoice Business
platform.

Integrated Mode
MiCollab supports Integrated Mode for MiCollab Client allowing you to configure and manage
MiCollab Client services with the Users and Services application.
Integrated Mode supports single point provisioning of MiCollab Client services on MiVoice
Business platforms.

Restrictions
DO NOT activate MiCollab Client Integrated Mode if the customer site requires any of the
following:

 MiCollab with MiVoice Office


 Customers with MiVoice Office integration must remain in Co-located Mode with
MiCollab and MiCollab Client user data remaining separate.

 Active Directory/LDAP Synchronizer configured as the synchronization source for MiCollab


Client

 Multiple MiCollab Client Enterprises

6- 2 06_IntegratedMode.docx
MiCollab Client Integrated Mode

 MiCollab Client Voice Mail Server not local to MiCollab


 Integrated Mode requires the MiCollab Client voice mail server field to be populated with
the MiCollab IP address.

 Additional MiCollab Client languages required


 Chinese (Simplified and Traditional), Italian, Portuguese (Brazil), and Spanish
(European) are not supported on MiCollab.

 Multiple Audio, Web and Video Conferencing collaboration servers

6- 3
MiCollab Installation and Maintenance Course

MiCollab Client Integration Wizard

You must use the MiCollab Client Integration Wizard to activate Integrated Mode as MiCollab
initializes in Co-located Mode by default. Co-located Mode maintains separate data stores for
MiCollab and MiCollab Client user data.

The Integration Wizard is designed to merge user accounts in a wide variety of customer
environments:

 For an existing MiCollab system with co-located installation of MiCollab Client, the wizard
will detect and merge MiCollab and MiCollab Client user data during the integration
operation.

 If you have an existing MiCollab Client installation, you can use the wizard to import and
merge MiCollab Client user data with MiCollab Users and Services.

 You can use the wizard to populate user data on a new installation of MiCollab simply by
synchronizing with an existing MiVoice Business database.

A link to launch the MiCollab Client Integration Wizard appears in a banner at the top of the
Server Manager until you either launch the wizard or cancel the reminder.

During the integration process, the wizard performs the following:


1. Identifies any configuration issues that prevent MiCollab Client data integration.

2. Defines Local Audio, Web and Video Conferencing Server as the collaboration server (if
Audio, Web and Video Conferencing is installed).

3. Creates a new Enterprise or updates an existing Enterprise

4. Adds Network Elements to Users and Services and PBX Nodes to UC Server Configuration.

5. Merges User Accounts

6. Sends Welcome Email to User Accounts

The wizard prompts you to retrieve information from an existing PBX Node (MiCollab Client PBX
Sync).
During this synchronization process, the wizard applies the licenses and features that are
defined for the default feature profile to all MiCollab Client accounts that are added.

6- 4 06_IntegratedMode.docx
MiCollab Client Integrated Mode

We recommend that you select the Default Feature Profile before you run the wizard. The
Default Feature Profile does not contain any licensed features, and therefore you cannot
accidentally run out of licenses when the accounts are created during synchronization.

If you do not select the Default Feature Profile, ensure that the customer Application Record
contains sufficient licenses for the accounts that will be created.

Resolving Integration Conflicts


If you encounter conflicts during integration, the wizard provides information to help you resolve
the issue.
ISelecting the Click here for help link at the bottom of the window launches a context-sensitive
help file pointing you to corrective actions.
In addition, chapter 7 of the MiCollab Installation and Maintenance Guide includes a section on
Resolving MiCollab client Integration Errors.

6- 5
MiCollab Installation and Maintenance Course

Tutorial– Synchronize MiVoice Business Data


This tutorial illustrates how to use the Integration Wizard to extract user data from an existing
MiVoice Business platform and use it to populate MiCollab user accounts.

Pre-Integration Tasks
You must perform some initial configuration tasks prior to running the Integration Wizard:

Access the MiCollab Client Service administration interface and Configure MiCollab Client
Service.

Select the Enterprise tab and Create Enterprise.

6- 6 06_IntegratedMode.docx
MiCollab Client Integrated Mode

Configure an Enterprise with the following information.

Click the PBX Nodes tab and Add Node.

Add configuration settings from the existing MiVoice Business platform.

6- 7
MiCollab Installation and Maintenance Course

Welcome
Review the information on the Welcome screen.

Verify Configuration
The wizard detects the Enterprise that you created.

Click Next to continue with the integration process if no conflicts are reported.

6- 8 06_IntegratedMode.docx
MiCollab Client Integrated Mode

Verify Database
The wizard detects the existing PBX Node and prompts you to synchronize user data.

Click Sync to begin the synchronization process.

6- 9
MiCollab Installation and Maintenance Course

Configuring System
The status of the operation is presented.

Configuring System - Completed


Confirmation of the operation is presented.

6- 10 06_IntegratedMode.docx
MiCollab Client Integrated Mode

Summary
The Summary window presents information about the integration process.

Click Detailed Summary to review the final configuration steps then click Finish.

6- 11
System Maintenance

Objectives
7
When you finish this module, you will be able to:
 Backup system data
 Upgrade MiCollab
 Migrate MiCollab server database to Virtual MiCollab
 Migrate MiCollab Client server database to MiCollab
MiCollab Installation and Maintenance Course

System Backup

MiCollab supports several methods to back up system data (including MSL configuration data,
application configuration data, user settings, messages, and greetings):

1. The server manager provides options to back up to a local workstation and


configure/schedule backups to a network file server.

2. The server console provides options to back up to a USB device or network file server, to
verify backup files, and to restore backups on demand.

3. For deployments of MiCollab virtual appliance, you can use the methods listed above to
obtain a database backup. In addition, you can use VMware tools to obtain a backup of the
.ova file.

Reference
Consult Performing Backups in Chapter 9 of the MiCollab Installation and
Maintenance Guide for additional details regarding MiCollab backup and
restore procedures.

Note
Snapshots are not supported for Virtual MiCollab (regardless of whether the
virtual appliance is powered on or off). System performance is degraded if
snapshots are present on the platform.

Note
"VMware Data Recovery" and "vStorage APIs for Data Protection” are
optional VMware backup and recovery tools supported by Virtual MiCollab

Conditions

 To ensure that MiCollab has consistent Network Element (call server) information, use the
backup methods listed above. Restoring backups created from inside the individual
applications may cause incorrect Network Element data to be presented to the MiCollab
server.

 You may use different filenames for backup files, but the file extension must be .tgz. (Note:
All backup files of systems prior to MSL Release 9.0 will be titled "smeserver.tgz“).

7- 2 07_SystemMaintenance.docx
System Maintenance

 To restore the data, you must transfer the backup file to a storage medium (USB device or
network share).

 If MiCollab is deployed in LAN only mode with the Teleworker service running remotely on
an MiVoice Border Gateway server in the DMZ, you should back up both the MiCollab
server database and the MiVoice Border Gateway server database at the same time.

Server Manager – Backup to Desktop


Use this method to save your system database to a file on your desktop computer or
maintenance PC.

Backup to desktop saves all system data to a single, large compressed file and is therefore
limited by the maximum file size supported by the client operating system.

Server Manager – Backup to Network


Schedule backups to a network share by [1] entering the configuration details for the backup
server, [2] setting the desired schedule parameters and clicking Save. The backup is performed
automatically according to the defined schedule.

7- 3
MiCollab Installation and Maintenance Course

Server Console – Perform Backup


You can choose the Perform Backup option in the server console to back up to USB or
network file server.

 The backup file size limit is set by the destination file system: 4 GB for FAT32, 2 TB for
NTFS, and 16 GB to 16 TB for ext3 (depending on file system block size). The current MSL
ext3 block size is 4096 bytes which allows file sizes of 2 TB.

Server Console – Restore from Backup


You can choose the Restore from Backup option in the server console to restore from a USB
device or network file server.

 WARNING: ALL current data (including application data) will be overwritten and replaced
with the data contained in the backup file.

7- 4 07_SystemMaintenance.docx
System Maintenance

System Restore – Constraints


 Do not attempt to restore a database taken from a LAN mode configuration to a Network
Edge configuration.

 Do not attempt to restore a database taken from a Network Edge configuration to a LAN
mode configuration.

 Do not attempt to restore a database taken from an individual application (for example, a
NuPoint Unified Messaging database) within MiCollab to either a MiCollab Server system or
a Virtual MiCollab deployment.

 You cannot restore a database from a MiCollab Server deployed in Network Gateway mode
to a Virtual MiCollab deployment in LAN mode.

 You cannot restore a database from a MiCollab Server that includes the CSM or MBD
applications to a Virtual MiCollab deployment (does not support CSM or MBD applications).

 You cannot restore a MiCollab Server database backup to a Virtual MiCollab Release 2.1
deployment. The Restore operation is not available in MiCollab Release 2.1.

7- 5
MiCollab Installation and Maintenance Course

 You cannot restore a Virtual MiCollab .OVA file exported from a newer vSphere platform to
an older vSphere platform (e.g. you cannot restore a file exported from vSphere 5.0 to a
vSphere 4.1 platform).

 You can only restore a MiCollab Release 2.0 or later database backup to Virtual MiCollab
3.0 or later deployments.

VMware vSphere Client – Export OVF Template


The VMware vSphere Client allows you to export an OVF template from an existing Virtual
MiCollab virtual appliance. In the event of database corruption, you can deploy the OVF
template file (.ova) to restore the virtual appliance.

7- 6 07_SystemMaintenance.docx
System Maintenance

Upgrading to Release 6.0

Supported Upgrade
Follow when… Task Summary
Path
Major Release Server software minimum Fresh install of MSL 10.1 software from
Upgrade: MAS 4.0 MAS 4.0 SP2 installation media, restore from 4.0 SP2
SP2 or later to or later backup, then update MiCollab
MiCollab 6.0 application software from AMC.
Major Release Migrating MAS 4.0 SP2 server Convert MAS server to MAS 4.0 SP2
Upgrade: MAS 4.0 to MiCollab 6.0 virtual virtual appliance then upgrade to the
SP2 or later to the appliance MiCollab 6.0 virtual appliance.
MiCollab 6.0 virtual
appliance
Major Release MAS virtual appliance Deploy the MiCollab virtual appliance
Upgrade: MAS 4.0 minimum 4.0 SP2 6.0 .ova then restore MAS 4.0 SP2 or
SP2 virtual appliance later virtual appliance backup
or later to the (Preferred method)
MiCollab virtual
appliance 6.0
Service Pack Software minimum MiCollab Perform upgrade from the Install
Upgrade: MiCollab 6.0 Applications panel in server manager.
6.0 to MiCollab 6.0
SPx

Caution
You must obtain and apply the appropriate upgrade license to the customer
Application Record ID before upgrading to MiCollab 6.0, even when the
system has active Software Assurance coverage.

Conditions
 MiCollab systems must first be upgraded to a minimum of MAS 4.0 SP2 before you can
upgrade your customer to MiCollab 6.0.

 Customers with active Software Assurance can upgrade from MAS 2.2 to MAS 3.0 SP1 free
of charge but you MUST apply one of the available MAS 2.x to 3.0/4.0 upgrade part
numbers (54005447 or 54005449) to the Application Record ID first.

 Minimum server requirements or virtual machine minimum resource requirements must be


met to support MiCollab Client. Server hardware must have a minimum of 6 GB of RAM.

7- 7
MiCollab Installation and Maintenance Course

Major Release Upgrade


Upgrade from MAS 4.0 SP2 (minimum)

Perform the following tasks to upgrade from MAS 4.0 SP2 or later on Server Appliance or
Industry Standard Server:

Step Task
1 Download MSL 10.1 and MiCollab 6.0 .iso files
2 Backup existing server configuration
3 Reboot system
4 Reinstall System to complete a fresh install of MSL 10.1
5 Restore from Backup to apply the server configuration from backup
6 Install MiCollab application software from server console
7 Provision new fields on the Network Element form in Users and Services with
appropriate settings
8 Synchronize MiCollab Client and Audio, Web and Video Conferencing Server and
Client software versions.
9 Perform a backup of the newly upgraded system

Reference
Consult “Upgrade MAS 4.0 SP2 or later to MiCollab 6.0 using Fresh Install” in
your Release 6.0 Installation and Maintenance Guide for a complete list of
upgrade procedures.

Note
Unified Communicator Mobile is not supported in MiCollab Release 6.0.
During an upgrade to MiCollab Release 6.0, UC Mobile programming is
automatically removed from the MiCollab database.

If your customer site previously used UC Mobile clients, we recommended


that you manually delete the associated programming, such as desktop
monitors, from the MiVoice Business platform following the upgrade.

Note
Once the system has been upgraded to MiCollab 6.0, backup the system
database. Restoring a backup from an earlier release is supported only during
the initial upgrade process.

7- 8 07_SystemMaintenance.docx
System Maintenance

Upgrade from Virtual MAS 4.0 SP2 (minimum)

Perform the following tasks to upgrade from a MAS 4.0 SP2 or later Virtual Appliance:

Step Task
1 Download MiCollab 6.0 ova file and NuPoint Unified Messaging feature options and
SAA-TTS .iso files (if necessary – see note)
2 Backup existing configuration
3 Deploy the MiCollab 6.0 ova file on host
4 Shut down the running virtual appliance and start the newly deployed system
5 Restore configuration from backup file
6 (optional) Install NuPoint Unified Messaging software
7 Provision new fields on the Network Element form in Users and Services with
appropriate settings

8 Synchronize MiCollab Client and Audio, Web and Video Conferencing Server and
Client software versions
9 Perform a backup of the newly upgraded system

Reference
Consult “Upgrade from vMAS 4.0 SP2 or later to vMiCollab 6.0” in your
Release 6.0 Installation and Maintenance Guide for a complete list of upgrade
procedures.

Note
If the backup file includes NP-UM feature options and SAA-TTS data, you
must use Install MiCollab Software in the server console to reinstall these
application features separately. Otherwise, you will see a warning banner in
server manager indicating that these software applications are not currently
installed.

7- 9
MiCollab Installation and Maintenance Course

Service Pack Upgrade


To upgrade from MiCollab 6.0 (to any Service Pack release):

Upgrade Software
1. Login to MiCollab server manager.

2. Access Install Applications panel.

3. Install Service Pack Software from Install Applications panel.

1. Click the Install Applications tab.


 The list of licensed applications for the currently installed version of MiCollab
appears.

2. Use the plus and minus signs (+ and -) to display information for the version of MiCollab
you wish to modify.
 Under the Update column, a green check mark displays for each currently installed
application/service that can be upgraded with new software.

7- 10 07_SystemMaintenance.docx
System Maintenance

3. Click Install to upgrade the applications/services that have green check marks.
 The licensed software is downloaded from the AMC. Software downloads are
queued and installed sequentially.
 If required, you will be prompted to insert any optional software CD/DVDs.

4. Click Clear this report when installation is complete.

Reference
Consult “Install and Upgrade Applications” in your Release 6.0 MiCollab
Server Manager help file for a complete list of upgrade procedures using
Install Applications.

7- 11
MiCollab Installation and Maintenance Course

Database Migration

Migrate MiCollab Server Database to Virtual MiCollab


The MiCollab to Virtual MiCollab conversion part number (54005389) enables existing MiCollab
physical server customers to migrate to Virtual MiCollab.

Used in conjunction with the MSL-based restore facility, a MiCollab 2.x server database can be
migrated to Virtual MiCollab. The “Restore from backup” feature in the server console is fully
supported by Virtual MiCollab, allowing you to restore a MiCollab server database following a
system reboot.

Following are constraints related to the migration of a MiCollab server to a Virtual MiCollab
system:

 The Application Record ID must include PN 54005389.

 You cannot restore a backup from a MiCollab server in server/gateway mode to a MiCollab
virtual machine in server-only mode. Server configuration mode must be the same.

 Migrations from standalone versions of applications (such as standalone Mobile Extension


or standalone Teleworker) to Virtual MiCollab are not supported.

 Migrations from MiCollab server with Customer Service Manager (CSM) or Mitel Business
Dashboard installed to Virtual MiCollab are not supported.

 Any application data programmed in the MiCollab virtual machine database is overwritten by
the MiCollab server backup data during the restore operation.

 It is not possible to restore a system with fewer applications than are contained in the
original backup.

 DO NOT ATTEMPT TO RESTORE INDIVIDUAL APPLICATION-SPECIFIC BACKUPS


FROM AN EXISTING MiCollab SERVER TO A VIRTUAL MiCollab SYSTEM.

7- 12 07_SystemMaintenance.docx
System Maintenance

Summary – Migrate MiCollab Server Database to Virtual MiCollab


Complete the following tasks to migrate from MiCollab Server to Virtual MiCollab:

The order of tasks listed below assumes Virtual MiCollab is to be deployed onto new hardware.

Step Task

1 Purchase and apply the required Virtual MiCollab conversion part number
(54005389) to the existing MiCollab Server Application Record ID.
2 Perform a backup of the existing MiCollab server database to a network share or
USB device.
3 Deploy the Virtual MiCollab software into the VMware environment. DO NOT power
on the virtual machine.
4 Perform a shutdown of the MiCollab server.
5 Power on the virtual machine, accept the MSL end user agreement, and restore the
MiCollab Server database to the Virtual MiCollab system when prompted.
6 If necessary, select 2. Configure this server in the server console to change the IP
address setting.
7 Install any additional software applications, reboot the MiCollab virtual machine, and
test system operation.

Migrate MiCollab Client Database to MiCollab


Customers with MiCollab Client and MiCollab deployed separately either on physical servers or
virtual machines can consolidate MiCollab and MiCollab Client onto a single server or single
virtual machine. Licenses from the MiCollab Client Application Record are transferred to the
MiCollab Application Record.

Customers wishing to consolidate MiCollab Client and MiCollab on a single server or virtual
machine can migrate from MiCollab Client to MiCollab only. You cannot migrate data from a
MiCollab deployment to a MiCollab Client system.

The AMC provides two part numbers to enable existing MiCollab Client customers to migrate to
MiCollab.

 PN 54005444: Add-on to MiCollab Client for MiCollab Server

 PN 54005445: Add-on to MiCollab Client for MiCollab Virtual Appliance

The Add-on to MiCollab Client part number is required to update the Application Record ID from
MiCollab Client to MiCollab (with MiCollab Client).

7- 13
MiCollab Installation and Maintenance Course

Following are the conditions and constraints related to the migration of MiCollab Client to
MiCollab:

 Customers must have active Software Assurance coverage.

 MiCollab Client migration does not support UCC licensing. Migrated users consume a-la-
carte licenses.

 The backup file used during migration must be from MiCollab Client version 4.x or later.

 When you import MiCollab Client data, any existing MiCollab Client data on the MiCollab
system is overwritten.

 MiCollab server hardware must have a minimum of 6 GB of RAM to support MiCollab Client.

 Migration from MiCollab Client Server Appliance to MiCollab with MiCollab Client is not
supported.

Task Summary – Migrate MiCollab Client Database to MiCollab


Complete the following tasks to migrate from MiCollab Client to MiCollab:

The order of tasks listed below assumes MiCollab is to be installed onto existing MiCollab Client
Server hardware.

Step Task

1 Purchase and apply the required “Add-on to MiCollab Client” part number to the
existing MiCollab Client Server Application Record ID.
2 Perform a backup of the existing MiCollab Client database to a network share or
USB device.
3 Insert MSL CD and reboot the MiCollab Client server.
4 Install and configure MSL.
5 Install MiCollab (including MiCollab Client).
6 Access MiCollab Server Manager and launch Unified Communications Server
administration interface.
7 Use the Import Mitel UC Server Data option to import MiCollab Client user
configuration.

7- 14 07_SystemMaintenance.docx

You might also like